1
# Copyright (C) 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from stat import S_ISREG
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
30
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
31
ReusingTransform, NotVersionedError, CantMoveRoot,
32
ExistingLimbo, ImmortalLimbo, NoFinalPath,
34
from bzrlib.inventory import InventoryEntry
35
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
36
delete_any, has_symlinks)
37
from bzrlib.progress import DummyProgress, ProgressPhase
38
from bzrlib.symbol_versioning import (
43
from bzrlib.trace import mutter, warning
44
from bzrlib import tree
46
import bzrlib.urlutils as urlutils
49
ROOT_PARENT = "root-parent"
52
def unique_add(map, key, value):
54
raise DuplicateKey(key=key)
58
class _TransformResults(object):
59
def __init__(self, modified_paths, rename_count):
61
self.modified_paths = modified_paths
62
self.rename_count = rename_count
65
class TreeTransform(object):
66
"""Represent a tree transformation.
68
This object is designed to support incremental generation of the transform,
71
However, it gives optimum performance when parent directories are created
72
before their contents. The transform is then able to put child files
73
directly in their parent directory, avoiding later renames.
75
It is easy to produce malformed transforms, but they are generally
76
harmless. Attempting to apply a malformed transform will cause an
77
exception to be raised before any modifications are made to the tree.
79
Many kinds of malformed transforms can be corrected with the
80
resolve_conflicts function. The remaining ones indicate programming error,
81
such as trying to create a file with no path.
83
Two sets of file creation methods are supplied. Convenience methods are:
88
These are composed of the low-level methods:
90
* create_file or create_directory or create_symlink
94
Transform/Transaction ids
95
-------------------------
96
trans_ids are temporary ids assigned to all files involved in a transform.
97
It's possible, even common, that not all files in the Tree have trans_ids.
99
trans_ids are used because filenames and file_ids are not good enough
100
identifiers; filenames change, and not all files have file_ids. File-ids
101
are also associated with trans-ids, so that moving a file moves its
104
trans_ids are only valid for the TreeTransform that generated them.
108
Limbo is a temporary directory use to hold new versions of files.
109
Files are added to limbo by create_file, create_directory, create_symlink,
110
and their convenience variants (new_*). Files may be removed from limbo
111
using cancel_creation. Files are renamed from limbo into their final
112
location as part of TreeTransform.apply
114
Limbo must be cleaned up, by either calling TreeTransform.apply or
115
calling TreeTransform.finalize.
117
Files are placed into limbo inside their parent directories, where
118
possible. This reduces subsequent renames, and makes operations involving
119
lots of files faster. This optimization is only possible if the parent
120
directory is created *before* creating any of its children, so avoid
121
creating children before parents, where possible.
125
This temporary directory is used by _FileMover for storing files that are
126
about to be deleted. In case of rollback, the files will be restored.
127
FileMover does not delete files until it is sure that a rollback will not
130
def __init__(self, tree, pb=DummyProgress()):
131
"""Note: a tree_write lock is taken on the tree.
133
Use TreeTransform.finalize() to release the lock (can be omitted if
134
TreeTransform.apply() called).
136
object.__init__(self)
138
self._tree.lock_tree_write()
140
control_files = self._tree._control_files
141
self._limbodir = urlutils.local_path_from_url(
142
control_files.controlfilename('limbo'))
144
os.mkdir(self._limbodir)
146
if e.errno == errno.EEXIST:
147
raise ExistingLimbo(self._limbodir)
148
self._deletiondir = urlutils.local_path_from_url(
149
control_files.controlfilename('pending-deletion'))
151
os.mkdir(self._deletiondir)
153
if e.errno == errno.EEXIST:
154
raise errors.ExistingPendingDeletion(self._deletiondir)
160
# counter used to generate trans-ids (which are locally unique)
162
# mapping of trans_id -> new basename
164
# mapping of trans_id -> new parent trans_id
165
self._new_parent = {}
166
# mapping of trans_id with new contents -> new file_kind
167
self._new_contents = {}
168
# A mapping of transform ids to their limbo filename
169
self._limbo_files = {}
170
# A mapping of transform ids to a set of the transform ids of children
171
# that their limbo directory has
172
self._limbo_children = {}
173
# Map transform ids to maps of child filename to child transform id
174
self._limbo_children_names = {}
175
# List of transform ids that need to be renamed from limbo into place
176
self._needs_rename = set()
177
# Set of trans_ids whose contents will be removed
178
self._removed_contents = set()
179
# Mapping of trans_id -> new execute-bit value
180
self._new_executability = {}
181
# Mapping of trans_id -> new tree-reference value
182
self._new_reference_revision = {}
183
# Mapping of trans_id -> new file_id
185
# Mapping of old file-id -> trans_id
186
self._non_present_ids = {}
187
# Mapping of new file_id -> trans_id
189
# Set of file_ids that will be removed
190
self._removed_id = set()
191
# Mapping of path in old tree -> trans_id
192
self._tree_path_ids = {}
193
# Mapping trans_id -> path in old tree
194
self._tree_id_paths = {}
195
# Cache of realpath results, to speed up canonical_path
197
# Cache of relpath results, to speed up canonical_path
199
# The trans_id that will be used as the tree root
200
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
201
# Indictor of whether the transform has been applied
205
# A counter of how many files have been renamed
206
self.rename_count = 0
208
def __get_root(self):
209
return self._new_root
211
root = property(__get_root)
214
"""Release the working tree lock, if held, clean up limbo dir.
216
This is required if apply has not been invoked, but can be invoked
219
if self._tree is None:
222
entries = [(self._limbo_name(t), t, k) for t, k in
223
self._new_contents.iteritems()]
224
entries.sort(reverse=True)
225
for path, trans_id, kind in entries:
226
if kind == "directory":
231
os.rmdir(self._limbodir)
233
# We don't especially care *why* the dir is immortal.
234
raise ImmortalLimbo(self._limbodir)
236
os.rmdir(self._deletiondir)
238
raise errors.ImmortalPendingDeletion(self._deletiondir)
243
def _assign_id(self):
244
"""Produce a new tranform id"""
245
new_id = "new-%s" % self._id_number
249
def create_path(self, name, parent):
250
"""Assign a transaction id to a new path"""
251
trans_id = self._assign_id()
252
unique_add(self._new_name, trans_id, name)
253
unique_add(self._new_parent, trans_id, parent)
256
def adjust_path(self, name, parent, trans_id):
257
"""Change the path that is assigned to a transaction id."""
258
if trans_id == self._new_root:
260
previous_parent = self._new_parent.get(trans_id)
261
previous_name = self._new_name.get(trans_id)
262
self._new_name[trans_id] = name
263
self._new_parent[trans_id] = parent
264
if (trans_id in self._limbo_files and
265
trans_id not in self._needs_rename):
266
self._rename_in_limbo([trans_id])
267
self._limbo_children[previous_parent].remove(trans_id)
268
del self._limbo_children_names[previous_parent][previous_name]
270
def _rename_in_limbo(self, trans_ids):
271
"""Fix limbo names so that the right final path is produced.
273
This means we outsmarted ourselves-- we tried to avoid renaming
274
these files later by creating them with their final names in their
275
final parents. But now the previous name or parent is no longer
276
suitable, so we have to rename them.
278
Even for trans_ids that have no new contents, we must remove their
279
entries from _limbo_files, because they are now stale.
281
for trans_id in trans_ids:
282
old_path = self._limbo_files.pop(trans_id)
283
if trans_id not in self._new_contents:
285
new_path = self._limbo_name(trans_id)
286
os.rename(old_path, new_path)
288
def adjust_root_path(self, name, parent):
289
"""Emulate moving the root by moving all children, instead.
291
We do this by undoing the association of root's transaction id with the
292
current tree. This allows us to create a new directory with that
293
transaction id. We unversion the root directory and version the
294
physically new directory, and hope someone versions the tree root
297
old_root = self._new_root
298
old_root_file_id = self.final_file_id(old_root)
299
# force moving all children of root
300
for child_id in self.iter_tree_children(old_root):
301
if child_id != parent:
302
self.adjust_path(self.final_name(child_id),
303
self.final_parent(child_id), child_id)
304
file_id = self.final_file_id(child_id)
305
if file_id is not None:
306
self.unversion_file(child_id)
307
self.version_file(file_id, child_id)
309
# the physical root needs a new transaction id
310
self._tree_path_ids.pop("")
311
self._tree_id_paths.pop(old_root)
312
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
313
if parent == old_root:
314
parent = self._new_root
315
self.adjust_path(name, parent, old_root)
316
self.create_directory(old_root)
317
self.version_file(old_root_file_id, old_root)
318
self.unversion_file(self._new_root)
320
def trans_id_tree_file_id(self, inventory_id):
321
"""Determine the transaction id of a working tree file.
323
This reflects only files that already exist, not ones that will be
324
added by transactions.
326
path = self._tree.inventory.id2path(inventory_id)
327
return self.trans_id_tree_path(path)
329
def trans_id_file_id(self, file_id):
330
"""Determine or set the transaction id associated with a file ID.
331
A new id is only created for file_ids that were never present. If
332
a transaction has been unversioned, it is deliberately still returned.
333
(this will likely lead to an unversioned parent conflict.)
335
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
336
return self._r_new_id[file_id]
337
elif file_id in self._tree.inventory:
338
return self.trans_id_tree_file_id(file_id)
339
elif file_id in self._non_present_ids:
340
return self._non_present_ids[file_id]
342
trans_id = self._assign_id()
343
self._non_present_ids[file_id] = trans_id
346
def canonical_path(self, path):
347
"""Get the canonical tree-relative path"""
348
# don't follow final symlinks
349
abs = self._tree.abspath(path)
350
if abs in self._relpaths:
351
return self._relpaths[abs]
352
dirname, basename = os.path.split(abs)
353
if dirname not in self._realpaths:
354
self._realpaths[dirname] = os.path.realpath(dirname)
355
dirname = self._realpaths[dirname]
356
abs = pathjoin(dirname, basename)
357
if dirname in self._relpaths:
358
relpath = pathjoin(self._relpaths[dirname], basename)
359
relpath = relpath.rstrip('/\\')
361
relpath = self._tree.relpath(abs)
362
self._relpaths[abs] = relpath
365
def trans_id_tree_path(self, path):
366
"""Determine (and maybe set) the transaction ID for a tree path."""
367
path = self.canonical_path(path)
368
if path not in self._tree_path_ids:
369
self._tree_path_ids[path] = self._assign_id()
370
self._tree_id_paths[self._tree_path_ids[path]] = path
371
return self._tree_path_ids[path]
373
def get_tree_parent(self, trans_id):
374
"""Determine id of the parent in the tree."""
375
path = self._tree_id_paths[trans_id]
378
return self.trans_id_tree_path(os.path.dirname(path))
380
def create_file(self, contents, trans_id, mode_id=None):
381
"""Schedule creation of a new file.
385
Contents is an iterator of strings, all of which will be written
386
to the target destination.
388
New file takes the permissions of any existing file with that id,
389
unless mode_id is specified.
391
name = self._limbo_name(trans_id)
395
unique_add(self._new_contents, trans_id, 'file')
397
# Clean up the file, it never got registered so
398
# TreeTransform.finalize() won't clean it up.
403
f.writelines(contents)
406
self._set_mode(trans_id, mode_id, S_ISREG)
408
def _set_mode(self, trans_id, mode_id, typefunc):
409
"""Set the mode of new file contents.
410
The mode_id is the existing file to get the mode from (often the same
411
as trans_id). The operation is only performed if there's a mode match
412
according to typefunc.
417
old_path = self._tree_id_paths[mode_id]
421
mode = os.stat(self._tree.abspath(old_path)).st_mode
423
if e.errno == errno.ENOENT:
428
os.chmod(self._limbo_name(trans_id), mode)
430
def create_directory(self, trans_id):
431
"""Schedule creation of a new directory.
433
See also new_directory.
435
os.mkdir(self._limbo_name(trans_id))
436
unique_add(self._new_contents, trans_id, 'directory')
438
def create_symlink(self, target, trans_id):
439
"""Schedule creation of a new symbolic link.
441
target is a bytestring.
442
See also new_symlink.
445
os.symlink(target, self._limbo_name(trans_id))
446
unique_add(self._new_contents, trans_id, 'symlink')
449
path = FinalPaths(self).get_path(trans_id)
452
raise UnableCreateSymlink(path=path)
454
def cancel_creation(self, trans_id):
455
"""Cancel the creation of new file contents."""
456
del self._new_contents[trans_id]
457
children = self._limbo_children.get(trans_id)
458
# if this is a limbo directory with children, move them before removing
460
if children is not None:
461
self._rename_in_limbo(children)
462
del self._limbo_children[trans_id]
463
del self._limbo_children_names[trans_id]
464
delete_any(self._limbo_name(trans_id))
466
def delete_contents(self, trans_id):
467
"""Schedule the contents of a path entry for deletion"""
468
self.tree_kind(trans_id)
469
self._removed_contents.add(trans_id)
471
def cancel_deletion(self, trans_id):
472
"""Cancel a scheduled deletion"""
473
self._removed_contents.remove(trans_id)
475
def unversion_file(self, trans_id):
476
"""Schedule a path entry to become unversioned"""
477
self._removed_id.add(trans_id)
479
def delete_versioned(self, trans_id):
480
"""Delete and unversion a versioned file"""
481
self.delete_contents(trans_id)
482
self.unversion_file(trans_id)
484
def set_executability(self, executability, trans_id):
485
"""Schedule setting of the 'execute' bit
486
To unschedule, set to None
488
if executability is None:
489
del self._new_executability[trans_id]
491
unique_add(self._new_executability, trans_id, executability)
493
def set_tree_reference(self, revision_id, trans_id):
494
"""Set the reference associated with a directory"""
495
unique_add(self._new_reference_revision, trans_id, revision_id)
497
def version_file(self, file_id, trans_id):
498
"""Schedule a file to become versioned."""
499
assert file_id is not None
500
unique_add(self._new_id, trans_id, file_id)
501
unique_add(self._r_new_id, file_id, trans_id)
503
def cancel_versioning(self, trans_id):
504
"""Undo a previous versioning of a file"""
505
file_id = self._new_id[trans_id]
506
del self._new_id[trans_id]
507
del self._r_new_id[file_id]
510
"""Determine the paths of all new and changed files"""
512
fp = FinalPaths(self)
513
for id_set in (self._new_name, self._new_parent, self._new_contents,
514
self._new_id, self._new_executability):
515
new_ids.update(id_set)
516
new_paths = [(fp.get_path(t), t) for t in new_ids]
520
def tree_kind(self, trans_id):
521
"""Determine the file kind in the working tree.
523
Raises NoSuchFile if the file does not exist
525
path = self._tree_id_paths.get(trans_id)
527
raise NoSuchFile(None)
529
return file_kind(self._tree.abspath(path))
531
if e.errno != errno.ENOENT:
534
raise NoSuchFile(path)
536
def final_kind(self, trans_id):
537
"""Determine the final file kind, after any changes applied.
539
Raises NoSuchFile if the file does not exist/has no contents.
540
(It is conceivable that a path would be created without the
541
corresponding contents insertion command)
543
if trans_id in self._new_contents:
544
return self._new_contents[trans_id]
545
elif trans_id in self._removed_contents:
546
raise NoSuchFile(None)
548
return self.tree_kind(trans_id)
550
def tree_file_id(self, trans_id):
551
"""Determine the file id associated with the trans_id in the tree"""
553
path = self._tree_id_paths[trans_id]
555
# the file is a new, unversioned file, or invalid trans_id
557
# the file is old; the old id is still valid
558
if self._new_root == trans_id:
559
return self._tree.get_root_id()
560
return self._tree.inventory.path2id(path)
562
def final_file_id(self, trans_id):
563
"""Determine the file id after any changes are applied, or None.
565
None indicates that the file will not be versioned after changes are
569
# there is a new id for this file
570
assert self._new_id[trans_id] is not None
571
return self._new_id[trans_id]
573
if trans_id in self._removed_id:
575
return self.tree_file_id(trans_id)
577
def inactive_file_id(self, trans_id):
578
"""Return the inactive file_id associated with a transaction id.
579
That is, the one in the tree or in non_present_ids.
580
The file_id may actually be active, too.
582
file_id = self.tree_file_id(trans_id)
583
if file_id is not None:
585
for key, value in self._non_present_ids.iteritems():
586
if value == trans_id:
589
def final_parent(self, trans_id):
590
"""Determine the parent file_id, after any changes are applied.
592
ROOT_PARENT is returned for the tree root.
595
return self._new_parent[trans_id]
597
return self.get_tree_parent(trans_id)
599
def final_name(self, trans_id):
600
"""Determine the final filename, after all changes are applied."""
602
return self._new_name[trans_id]
605
return os.path.basename(self._tree_id_paths[trans_id])
607
raise NoFinalPath(trans_id, self)
610
"""Return a map of parent: children for known parents.
612
Only new paths and parents of tree files with assigned ids are used.
615
items = list(self._new_parent.iteritems())
616
items.extend((t, self.final_parent(t)) for t in
617
self._tree_id_paths.keys())
618
for trans_id, parent_id in items:
619
if parent_id not in by_parent:
620
by_parent[parent_id] = set()
621
by_parent[parent_id].add(trans_id)
624
def path_changed(self, trans_id):
625
"""Return True if a trans_id's path has changed."""
626
return (trans_id in self._new_name) or (trans_id in self._new_parent)
628
def new_contents(self, trans_id):
629
return (trans_id in self._new_contents)
631
def find_conflicts(self):
632
"""Find any violations of inventory or filesystem invariants"""
633
if self.__done is True:
634
raise ReusingTransform()
636
# ensure all children of all existent parents are known
637
# all children of non-existent parents are known, by definition.
638
self._add_tree_children()
639
by_parent = self.by_parent()
640
conflicts.extend(self._unversioned_parents(by_parent))
641
conflicts.extend(self._parent_loops())
642
conflicts.extend(self._duplicate_entries(by_parent))
643
conflicts.extend(self._duplicate_ids())
644
conflicts.extend(self._parent_type_conflicts(by_parent))
645
conflicts.extend(self._improper_versioning())
646
conflicts.extend(self._executability_conflicts())
647
conflicts.extend(self._overwrite_conflicts())
650
def _add_tree_children(self):
651
"""Add all the children of all active parents to the known paths.
653
Active parents are those which gain children, and those which are
654
removed. This is a necessary first step in detecting conflicts.
656
parents = self.by_parent().keys()
657
parents.extend([t for t in self._removed_contents if
658
self.tree_kind(t) == 'directory'])
659
for trans_id in self._removed_id:
660
file_id = self.tree_file_id(trans_id)
661
if self._tree.inventory[file_id].kind == 'directory':
662
parents.append(trans_id)
664
for parent_id in parents:
665
# ensure that all children are registered with the transaction
666
list(self.iter_tree_children(parent_id))
668
def iter_tree_children(self, parent_id):
669
"""Iterate through the entry's tree children, if any"""
671
path = self._tree_id_paths[parent_id]
675
children = os.listdir(self._tree.abspath(path))
677
if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
681
for child in children:
682
childpath = joinpath(path, child)
683
if self._tree.is_control_filename(childpath):
685
yield self.trans_id_tree_path(childpath)
687
def has_named_child(self, by_parent, parent_id, name):
689
children = by_parent[parent_id]
692
for child in children:
693
if self.final_name(child) == name:
696
path = self._tree_id_paths[parent_id]
699
childpath = joinpath(path, name)
700
child_id = self._tree_path_ids.get(childpath)
702
return lexists(self._tree.abspath(childpath))
704
if self.final_parent(child_id) != parent_id:
706
if child_id in self._removed_contents:
707
# XXX What about dangling file-ids?
712
def _parent_loops(self):
713
"""No entry should be its own ancestor"""
715
for trans_id in self._new_parent:
718
while parent_id is not ROOT_PARENT:
721
parent_id = self.final_parent(parent_id)
724
if parent_id == trans_id:
725
conflicts.append(('parent loop', trans_id))
726
if parent_id in seen:
730
def _unversioned_parents(self, by_parent):
731
"""If parent directories are versioned, children must be versioned."""
733
for parent_id, children in by_parent.iteritems():
734
if parent_id is ROOT_PARENT:
736
if self.final_file_id(parent_id) is not None:
738
for child_id in children:
739
if self.final_file_id(child_id) is not None:
740
conflicts.append(('unversioned parent', parent_id))
744
def _improper_versioning(self):
745
"""Cannot version a file with no contents, or a bad type.
747
However, existing entries with no contents are okay.
750
for trans_id in self._new_id.iterkeys():
752
kind = self.final_kind(trans_id)
754
conflicts.append(('versioning no contents', trans_id))
756
if not InventoryEntry.versionable_kind(kind):
757
conflicts.append(('versioning bad kind', trans_id, kind))
760
def _executability_conflicts(self):
761
"""Check for bad executability changes.
763
Only versioned files may have their executability set, because
764
1. only versioned entries can have executability under windows
765
2. only files can be executable. (The execute bit on a directory
766
does not indicate searchability)
769
for trans_id in self._new_executability:
770
if self.final_file_id(trans_id) is None:
771
conflicts.append(('unversioned executability', trans_id))
774
non_file = self.final_kind(trans_id) != "file"
778
conflicts.append(('non-file executability', trans_id))
781
def _overwrite_conflicts(self):
782
"""Check for overwrites (not permitted on Win32)"""
784
for trans_id in self._new_contents:
786
self.tree_kind(trans_id)
789
if trans_id not in self._removed_contents:
790
conflicts.append(('overwrite', trans_id,
791
self.final_name(trans_id)))
794
def _duplicate_entries(self, by_parent):
795
"""No directory may have two entries with the same name."""
797
if (self._new_name, self._new_parent) == ({}, {}):
799
for children in by_parent.itervalues():
800
name_ids = [(self.final_name(t), t) for t in children]
801
if not self._tree.case_sensitive:
802
name_ids = [(n.lower(), t) for n, t in name_ids]
806
for name, trans_id in name_ids:
808
kind = self.final_kind(trans_id)
811
file_id = self.final_file_id(trans_id)
812
if kind is None and file_id is None:
814
if name == last_name:
815
conflicts.append(('duplicate', last_trans_id, trans_id,
818
last_trans_id = trans_id
821
def _duplicate_ids(self):
822
"""Each inventory id may only be used once"""
824
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
826
active_tree_ids = set((f for f in self._tree.inventory if
827
f not in removed_tree_ids))
828
for trans_id, file_id in self._new_id.iteritems():
829
if file_id in active_tree_ids:
830
old_trans_id = self.trans_id_tree_file_id(file_id)
831
conflicts.append(('duplicate id', old_trans_id, trans_id))
834
def _parent_type_conflicts(self, by_parent):
835
"""parents must have directory 'contents'."""
837
for parent_id, children in by_parent.iteritems():
838
if parent_id is ROOT_PARENT:
840
if not self._any_contents(children):
842
for child in children:
844
self.final_kind(child)
848
kind = self.final_kind(parent_id)
852
conflicts.append(('missing parent', parent_id))
853
elif kind != "directory":
854
conflicts.append(('non-directory parent', parent_id))
857
def _any_contents(self, trans_ids):
858
"""Return true if any of the trans_ids, will have contents."""
859
for trans_id in trans_ids:
861
kind = self.final_kind(trans_id)
867
def apply(self, no_conflicts=False, _mover=None):
868
"""Apply all changes to the inventory and filesystem.
870
If filesystem or inventory conflicts are present, MalformedTransform
873
If apply succeeds, finalize is not necessary.
875
:param no_conflicts: if True, the caller guarantees there are no
876
conflicts, so no check is made.
877
:param _mover: Supply an alternate FileMover, for testing
880
conflicts = self.find_conflicts()
881
if len(conflicts) != 0:
882
raise MalformedTransform(conflicts=conflicts)
883
inv = self._tree.inventory
885
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
892
child_pb.update('Apply phase', 0, 2)
893
self._apply_removals(inv, inventory_delta, mover)
894
child_pb.update('Apply phase', 1, 2)
895
modified_paths = self._apply_insertions(inv, inventory_delta,
901
mover.apply_deletions()
904
self._tree.apply_inventory_delta(inventory_delta)
907
return _TransformResults(modified_paths, self.rename_count)
909
def _limbo_name(self, trans_id):
910
"""Generate the limbo name of a file"""
911
limbo_name = self._limbo_files.get(trans_id)
912
if limbo_name is not None:
914
parent = self._new_parent.get(trans_id)
915
# if the parent directory is already in limbo (e.g. when building a
916
# tree), choose a limbo name inside the parent, to reduce further
918
use_direct_path = False
919
if self._new_contents.get(parent) == 'directory':
920
filename = self._new_name.get(trans_id)
921
if filename is not None:
922
if parent not in self._limbo_children:
923
self._limbo_children[parent] = set()
924
self._limbo_children_names[parent] = {}
925
use_direct_path = True
926
# the direct path can only be used if no other file has
927
# already taken this pathname, i.e. if the name is unused, or
928
# if it is already associated with this trans_id.
929
elif self._tree.case_sensitive:
930
if (self._limbo_children_names[parent].get(filename)
931
in (trans_id, None)):
932
use_direct_path = True
934
for l_filename, l_trans_id in\
935
self._limbo_children_names[parent].iteritems():
936
if l_trans_id == trans_id:
938
if l_filename.lower() == filename.lower():
941
use_direct_path = True
944
limbo_name = pathjoin(self._limbo_files[parent], filename)
945
self._limbo_children[parent].add(trans_id)
946
self._limbo_children_names[parent][filename] = trans_id
948
limbo_name = pathjoin(self._limbodir, trans_id)
949
self._needs_rename.add(trans_id)
950
self._limbo_files[trans_id] = limbo_name
953
def _apply_removals(self, inv, inventory_delta, mover):
954
"""Perform tree operations that remove directory/inventory names.
956
That is, delete files that are to be deleted, and put any files that
957
need renaming into limbo. This must be done in strict child-to-parent
960
tree_paths = list(self._tree_path_ids.iteritems())
961
tree_paths.sort(reverse=True)
962
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
964
for num, data in enumerate(tree_paths):
965
path, trans_id = data
966
child_pb.update('removing file', num, len(tree_paths))
967
full_path = self._tree.abspath(path)
968
if trans_id in self._removed_contents:
969
mover.pre_delete(full_path, os.path.join(self._deletiondir,
971
elif trans_id in self._new_name or trans_id in \
974
mover.rename(full_path, self._limbo_name(trans_id))
976
if e.errno != errno.ENOENT:
979
self.rename_count += 1
980
if trans_id in self._removed_id:
981
if trans_id == self._new_root:
982
file_id = self._tree.get_root_id()
984
file_id = self.tree_file_id(trans_id)
985
assert file_id is not None
986
inventory_delta.append((path, None, file_id, None))
990
def _apply_insertions(self, inv, inventory_delta, mover):
991
"""Perform tree operations that insert directory/inventory names.
993
That is, create any files that need to be created, and restore from
994
limbo any files that needed renaming. This must be done in strict
995
parent-to-child order.
997
new_paths = self.new_paths()
999
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1001
for num, (path, trans_id) in enumerate(new_paths):
1003
child_pb.update('adding file', num, len(new_paths))
1005
kind = self._new_contents[trans_id]
1007
kind = contents = None
1008
if trans_id in self._new_contents or \
1009
self.path_changed(trans_id):
1010
full_path = self._tree.abspath(path)
1011
if trans_id in self._needs_rename:
1013
mover.rename(self._limbo_name(trans_id), full_path)
1015
# We may be renaming a dangling inventory id
1016
if e.errno != errno.ENOENT:
1019
self.rename_count += 1
1020
if trans_id in self._new_contents:
1021
modified_paths.append(full_path)
1022
del self._new_contents[trans_id]
1024
if trans_id in self._new_id:
1026
kind = file_kind(self._tree.abspath(path))
1027
if trans_id in self._new_reference_revision:
1028
new_entry = inventory.TreeReference(
1029
self._new_id[trans_id],
1030
self._new_name[trans_id],
1031
self.final_file_id(self._new_parent[trans_id]),
1032
None, self._new_reference_revision[trans_id])
1034
new_entry = inventory.make_entry(kind,
1035
self.final_name(trans_id),
1036
self.final_file_id(self.final_parent(trans_id)),
1037
self._new_id[trans_id])
1039
if trans_id in self._new_name or trans_id in\
1040
self._new_parent or\
1041
trans_id in self._new_executability:
1042
file_id = self.final_file_id(trans_id)
1043
if file_id is not None:
1044
entry = inv[file_id]
1045
new_entry = entry.copy()
1047
if trans_id in self._new_name or trans_id in\
1049
if new_entry is not None:
1050
new_entry.name = self.final_name(trans_id)
1051
parent = self.final_parent(trans_id)
1052
parent_id = self.final_file_id(parent)
1053
new_entry.parent_id = parent_id
1055
if trans_id in self._new_executability:
1056
self._set_executability(path, new_entry, trans_id)
1057
if new_entry is not None:
1058
if new_entry.file_id in inv:
1059
old_path = inv.id2path(new_entry.file_id)
1062
inventory_delta.append((old_path, path,
1067
return modified_paths
1069
def _set_executability(self, path, entry, trans_id):
1070
"""Set the executability of versioned files """
1071
new_executability = self._new_executability[trans_id]
1072
entry.executable = new_executability
1073
if supports_executable():
1074
abspath = self._tree.abspath(path)
1075
current_mode = os.stat(abspath).st_mode
1076
if new_executability:
1079
to_mode = current_mode | (0100 & ~umask)
1080
# Enable x-bit for others only if they can read it.
1081
if current_mode & 0004:
1082
to_mode |= 0001 & ~umask
1083
if current_mode & 0040:
1084
to_mode |= 0010 & ~umask
1086
to_mode = current_mode & ~0111
1087
os.chmod(abspath, to_mode)
1089
def _new_entry(self, name, parent_id, file_id):
1090
"""Helper function to create a new filesystem entry."""
1091
trans_id = self.create_path(name, parent_id)
1092
if file_id is not None:
1093
self.version_file(file_id, trans_id)
1096
def new_file(self, name, parent_id, contents, file_id=None,
1098
"""Convenience method to create files.
1100
name is the name of the file to create.
1101
parent_id is the transaction id of the parent directory of the file.
1102
contents is an iterator of bytestrings, which will be used to produce
1104
:param file_id: The inventory ID of the file, if it is to be versioned.
1105
:param executable: Only valid when a file_id has been supplied.
1107
trans_id = self._new_entry(name, parent_id, file_id)
1108
# TODO: rather than scheduling a set_executable call,
1109
# have create_file create the file with the right mode.
1110
self.create_file(contents, trans_id)
1111
if executable is not None:
1112
self.set_executability(executable, trans_id)
1115
def new_directory(self, name, parent_id, file_id=None):
1116
"""Convenience method to create directories.
1118
name is the name of the directory to create.
1119
parent_id is the transaction id of the parent directory of the
1121
file_id is the inventory ID of the directory, if it is to be versioned.
1123
trans_id = self._new_entry(name, parent_id, file_id)
1124
self.create_directory(trans_id)
1127
def new_symlink(self, name, parent_id, target, file_id=None):
1128
"""Convenience method to create symbolic link.
1130
name is the name of the symlink to create.
1131
parent_id is the transaction id of the parent directory of the symlink.
1132
target is a bytestring of the target of the symlink.
1133
file_id is the inventory ID of the file, if it is to be versioned.
1135
trans_id = self._new_entry(name, parent_id, file_id)
1136
self.create_symlink(target, trans_id)
1139
def _affected_ids(self):
1140
"""Return the set of transform ids affected by the transform"""
1141
trans_ids = set(self._removed_id)
1142
trans_ids.update(self._new_id.keys())
1143
trans_ids.update(self._removed_contents)
1144
trans_ids.update(self._new_contents.keys())
1145
trans_ids.update(self._new_executability.keys())
1146
trans_ids.update(self._new_name.keys())
1147
trans_ids.update(self._new_parent.keys())
1150
def _get_file_id_maps(self):
1151
"""Return mapping of file_ids to trans_ids in the to and from states"""
1152
trans_ids = self._affected_ids()
1155
# Build up two dicts: trans_ids associated with file ids in the
1156
# FROM state, vs the TO state.
1157
for trans_id in trans_ids:
1158
from_file_id = self.tree_file_id(trans_id)
1159
if from_file_id is not None:
1160
from_trans_ids[from_file_id] = trans_id
1161
to_file_id = self.final_file_id(trans_id)
1162
if to_file_id is not None:
1163
to_trans_ids[to_file_id] = trans_id
1164
return from_trans_ids, to_trans_ids
1166
def _from_file_data(self, from_trans_id, from_versioned, file_id):
1167
"""Get data about a file in the from (tree) state
1169
Return a (name, parent, kind, executable) tuple
1171
from_path = self._tree_id_paths.get(from_trans_id)
1173
# get data from working tree if versioned
1174
from_entry = self._tree.inventory[file_id]
1175
from_name = from_entry.name
1176
from_parent = from_entry.parent_id
1179
if from_path is None:
1180
# File does not exist in FROM state
1184
# File exists, but is not versioned. Have to use path-
1186
from_name = os.path.basename(from_path)
1187
tree_parent = self.get_tree_parent(from_trans_id)
1188
from_parent = self.tree_file_id(tree_parent)
1189
if from_path is not None:
1190
from_kind, from_executable, from_stats = \
1191
self._tree._comparison_data(from_entry, from_path)
1194
from_executable = False
1195
return from_name, from_parent, from_kind, from_executable
1197
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1198
"""Get data about a file in the to (target) state
1200
Return a (name, parent, kind, executable) tuple
1202
to_name = self.final_name(to_trans_id)
1204
to_kind = self.final_kind(to_trans_id)
1207
to_parent = self.final_file_id(self.final_parent(to_trans_id))
1208
if to_trans_id in self._new_executability:
1209
to_executable = self._new_executability[to_trans_id]
1210
elif to_trans_id == from_trans_id:
1211
to_executable = from_executable
1213
to_executable = False
1214
return to_name, to_parent, to_kind, to_executable
1216
def _iter_changes(self):
1217
"""Produce output in the same format as Tree._iter_changes.
1219
Will produce nonsensical results if invoked while inventory/filesystem
1220
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1222
This reads the Transform, but only reproduces changes involving a
1223
file_id. Files that are not versioned in either of the FROM or TO
1224
states are not reflected.
1226
final_paths = FinalPaths(self)
1227
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1229
# Now iterate through all active file_ids
1230
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1232
from_trans_id = from_trans_ids.get(file_id)
1233
# find file ids, and determine versioning state
1234
if from_trans_id is None:
1235
from_versioned = False
1236
from_trans_id = to_trans_ids[file_id]
1238
from_versioned = True
1239
to_trans_id = to_trans_ids.get(file_id)
1240
if to_trans_id is None:
1241
to_versioned = False
1242
to_trans_id = from_trans_id
1246
from_name, from_parent, from_kind, from_executable = \
1247
self._from_file_data(from_trans_id, from_versioned, file_id)
1249
to_name, to_parent, to_kind, to_executable = \
1250
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1252
if not from_versioned:
1255
from_path = self._tree_id_paths.get(from_trans_id)
1256
if not to_versioned:
1259
to_path = final_paths.get_path(to_trans_id)
1260
if from_kind != to_kind:
1262
elif to_kind in ('file', 'symlink') and (
1263
to_trans_id != from_trans_id or
1264
to_trans_id in self._new_contents):
1266
if (not modified and from_versioned == to_versioned and
1267
from_parent==to_parent and from_name == to_name and
1268
from_executable == to_executable):
1270
results.append((file_id, (from_path, to_path), modified,
1271
(from_versioned, to_versioned),
1272
(from_parent, to_parent),
1273
(from_name, to_name),
1274
(from_kind, to_kind),
1275
(from_executable, to_executable)))
1276
return iter(sorted(results, key=lambda x:x[1]))
1279
def joinpath(parent, child):
1280
"""Join tree-relative paths, handling the tree root specially"""
1281
if parent is None or parent == "":
1284
return pathjoin(parent, child)
1287
class FinalPaths(object):
1288
"""Make path calculation cheap by memoizing paths.
1290
The underlying tree must not be manipulated between calls, or else
1291
the results will likely be incorrect.
1293
def __init__(self, transform):
1294
object.__init__(self)
1295
self._known_paths = {}
1296
self.transform = transform
1298
def _determine_path(self, trans_id):
1299
if trans_id == self.transform.root:
1301
name = self.transform.final_name(trans_id)
1302
parent_id = self.transform.final_parent(trans_id)
1303
if parent_id == self.transform.root:
1306
return pathjoin(self.get_path(parent_id), name)
1308
def get_path(self, trans_id):
1309
"""Find the final path associated with a trans_id"""
1310
if trans_id not in self._known_paths:
1311
self._known_paths[trans_id] = self._determine_path(trans_id)
1312
return self._known_paths[trans_id]
1315
def topology_sorted_ids(tree):
1316
"""Determine the topological order of the ids in a tree"""
1317
file_ids = list(tree)
1318
file_ids.sort(key=tree.id2path)
1322
def build_tree(tree, wt):
1323
"""Create working tree for a branch, using a TreeTransform.
1325
This function should be used on empty trees, having a tree root at most.
1326
(see merge and revert functionality for working with existing trees)
1328
Existing files are handled like so:
1330
- Existing bzrdirs take precedence over creating new items. They are
1331
created as '%s.diverted' % name.
1332
- Otherwise, if the content on disk matches the content we are building,
1333
it is silently replaced.
1334
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1336
wt.lock_tree_write()
1340
return _build_tree(tree, wt)
1347
def _build_tree(tree, wt):
1348
"""See build_tree."""
1349
if len(wt.inventory) > 1: # more than just a root
1350
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1352
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1353
pp = ProgressPhase("Build phase", 2, top_pb)
1354
if tree.inventory.root is not None:
1355
# This is kind of a hack: we should be altering the root
1356
# as part of the regular tree shape diff logic.
1357
# The conditional test here is to avoid doing an
1358
# expensive operation (flush) every time the root id
1359
# is set within the tree, nor setting the root and thus
1360
# marking the tree as dirty, because we use two different
1361
# idioms here: tree interfaces and inventory interfaces.
1362
if wt.get_root_id() != tree.get_root_id():
1363
wt.set_root_id(tree.get_root_id())
1365
tt = TreeTransform(wt)
1369
file_trans_id[wt.get_root_id()] = \
1370
tt.trans_id_tree_file_id(wt.get_root_id())
1371
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1373
deferred_contents = []
1374
for num, (tree_path, entry) in \
1375
enumerate(tree.inventory.iter_entries_by_dir()):
1376
pb.update("Building tree", num - len(deferred_contents),
1377
len(tree.inventory))
1378
if entry.parent_id is None:
1381
file_id = entry.file_id
1382
target_path = wt.abspath(tree_path)
1384
kind = file_kind(target_path)
1388
if kind == "directory":
1390
bzrdir.BzrDir.open(target_path)
1391
except errors.NotBranchError:
1395
if (file_id not in divert and
1396
_content_match(tree, entry, file_id, kind,
1398
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1399
if kind == 'directory':
1401
if entry.parent_id not in file_trans_id:
1402
raise AssertionError(
1403
'entry %s parent id %r is not in file_trans_id %r'
1404
% (entry, entry.parent_id, file_trans_id))
1405
parent_id = file_trans_id[entry.parent_id]
1406
if entry.kind == 'file':
1407
# We *almost* replicate new_by_entry, so that we can defer
1408
# getting the file text, and get them all at once.
1409
trans_id = tt.create_path(entry.name, parent_id)
1410
file_trans_id[file_id] = trans_id
1411
tt.version_file(entry.file_id, trans_id)
1412
executable = tree.is_executable(entry.file_id, tree_path)
1413
if executable is not None:
1414
tt.set_executability(executable, trans_id)
1415
deferred_contents.append((entry.file_id, trans_id))
1417
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1420
new_trans_id = file_trans_id[file_id]
1421
old_parent = tt.trans_id_tree_path(tree_path)
1422
_reparent_children(tt, old_parent, new_trans_id)
1423
for num, (trans_id, bytes) in enumerate(
1424
tree.iter_files_bytes(deferred_contents)):
1425
tt.create_file(bytes, trans_id)
1426
pb.update('Adding file contents',
1427
(num + len(tree.inventory) - len(deferred_contents)),
1428
len(tree.inventory))
1432
divert_trans = set(file_trans_id[f] for f in divert)
1433
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1434
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1435
conflicts = cook_conflicts(raw_conflicts, tt)
1436
for conflict in conflicts:
1439
wt.add_conflicts(conflicts)
1440
except errors.UnsupportedOperation:
1449
def _reparent_children(tt, old_parent, new_parent):
1450
for child in tt.iter_tree_children(old_parent):
1451
tt.adjust_path(tt.final_name(child), new_parent, child)
1454
def _content_match(tree, entry, file_id, kind, target_path):
1455
if entry.kind != kind:
1457
if entry.kind == "directory":
1459
if entry.kind == "file":
1460
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1462
elif entry.kind == "symlink":
1463
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1468
def resolve_checkout(tt, conflicts, divert):
1469
new_conflicts = set()
1470
for c_type, conflict in ((c[0], c) for c in conflicts):
1471
# Anything but a 'duplicate' would indicate programmer error
1472
assert c_type == 'duplicate', c_type
1473
# Now figure out which is new and which is old
1474
if tt.new_contents(conflict[1]):
1475
new_file = conflict[1]
1476
old_file = conflict[2]
1478
new_file = conflict[2]
1479
old_file = conflict[1]
1481
# We should only get here if the conflict wasn't completely
1483
final_parent = tt.final_parent(old_file)
1484
if new_file in divert:
1485
new_name = tt.final_name(old_file)+'.diverted'
1486
tt.adjust_path(new_name, final_parent, new_file)
1487
new_conflicts.add((c_type, 'Diverted to',
1488
new_file, old_file))
1490
new_name = tt.final_name(old_file)+'.moved'
1491
tt.adjust_path(new_name, final_parent, old_file)
1492
new_conflicts.add((c_type, 'Moved existing file to',
1493
old_file, new_file))
1494
return new_conflicts
1497
def new_by_entry(tt, entry, parent_id, tree):
1498
"""Create a new file according to its inventory entry"""
1502
contents = tree.get_file(entry.file_id).readlines()
1503
executable = tree.is_executable(entry.file_id)
1504
return tt.new_file(name, parent_id, contents, entry.file_id,
1506
elif kind in ('directory', 'tree-reference'):
1507
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1508
if kind == 'tree-reference':
1509
tt.set_tree_reference(entry.reference_revision, trans_id)
1511
elif kind == 'symlink':
1512
target = tree.get_symlink_target(entry.file_id)
1513
return tt.new_symlink(name, parent_id, target, entry.file_id)
1515
raise errors.BadFileKindError(name, kind)
1518
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1519
"""Create new file contents according to an inventory entry."""
1520
if entry.kind == "file":
1522
lines = tree.get_file(entry.file_id).readlines()
1523
tt.create_file(lines, trans_id, mode_id=mode_id)
1524
elif entry.kind == "symlink":
1525
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1526
elif entry.kind == "directory":
1527
tt.create_directory(trans_id)
1530
def create_entry_executability(tt, entry, trans_id):
1531
"""Set the executability of a trans_id according to an inventory entry"""
1532
if entry.kind == "file":
1533
tt.set_executability(entry.executable, trans_id)
1536
@deprecated_function(zero_fifteen)
1537
def find_interesting(working_tree, target_tree, filenames):
1538
"""Find the ids corresponding to specified filenames.
1540
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1542
working_tree.lock_read()
1544
target_tree.lock_read()
1546
return working_tree.paths2ids(filenames, [target_tree])
1548
target_tree.unlock()
1550
working_tree.unlock()
1553
@deprecated_function(zero_ninety)
1554
def change_entry(tt, file_id, working_tree, target_tree,
1555
trans_id_file_id, backups, trans_id, by_parent):
1556
"""Replace a file_id's contents with those from a target tree."""
1557
if file_id is None and target_tree is None:
1558
# skip the logic altogether in the deprecation test
1560
e_trans_id = trans_id_file_id(file_id)
1561
entry = target_tree.inventory[file_id]
1562
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1565
mode_id = e_trans_id
1568
tt.delete_contents(e_trans_id)
1570
parent_trans_id = trans_id_file_id(entry.parent_id)
1571
backup_name = get_backup_name(entry, by_parent,
1572
parent_trans_id, tt)
1573
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1574
tt.unversion_file(e_trans_id)
1575
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1576
tt.version_file(file_id, e_trans_id)
1577
trans_id[file_id] = e_trans_id
1578
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1579
create_entry_executability(tt, entry, e_trans_id)
1582
tt.set_executability(entry.executable, e_trans_id)
1583
if tt.final_name(e_trans_id) != entry.name:
1586
parent_id = tt.final_parent(e_trans_id)
1587
parent_file_id = tt.final_file_id(parent_id)
1588
if parent_file_id != entry.parent_id:
1593
parent_trans_id = trans_id_file_id(entry.parent_id)
1594
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1597
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1598
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1601
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1602
"""Produce a backup-style name that appears to be available"""
1606
yield "%s.~%d~" % (name, counter)
1608
for new_name in name_gen():
1609
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1613
def _entry_changes(file_id, entry, working_tree):
1614
"""Determine in which ways the inventory entry has changed.
1616
Returns booleans: has_contents, content_mod, meta_mod
1617
has_contents means there are currently contents, but they differ
1618
contents_mod means contents need to be modified
1619
meta_mod means the metadata needs to be modified
1621
cur_entry = working_tree.inventory[file_id]
1623
working_kind = working_tree.kind(file_id)
1626
has_contents = False
1629
if has_contents is True:
1630
if entry.kind != working_kind:
1631
contents_mod, meta_mod = True, False
1633
cur_entry._read_tree_state(working_tree.id2path(file_id),
1635
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1636
cur_entry._forget_tree_state()
1637
return has_contents, contents_mod, meta_mod
1640
def revert(working_tree, target_tree, filenames, backups=False,
1641
pb=DummyProgress(), change_reporter=None):
1642
"""Revert a working tree's contents to those of a target tree."""
1643
target_tree.lock_read()
1644
tt = TreeTransform(working_tree, pb)
1646
pp = ProgressPhase("Revert phase", 3, pb)
1648
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1650
merge_modified = _alter_files(working_tree, target_tree, tt,
1651
child_pb, filenames, backups)
1655
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1657
raw_conflicts = resolve_conflicts(tt, child_pb,
1658
lambda t, c: conflict_pass(t, c, target_tree))
1661
conflicts = cook_conflicts(raw_conflicts, tt)
1663
change_reporter = delta._ChangeReporter(
1664
unversioned_filter=working_tree.is_ignored)
1665
delta.report_changes(tt._iter_changes(), change_reporter)
1666
for conflict in conflicts:
1670
working_tree.set_merge_modified(merge_modified)
1672
target_tree.unlock()
1678
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1680
merge_modified = working_tree.merge_modified()
1681
change_list = target_tree._iter_changes(working_tree,
1682
specific_files=specific_files, pb=pb)
1683
if target_tree.inventory.root is None:
1690
for id_num, (file_id, path, changed_content, versioned, parent, name,
1691
kind, executable) in enumerate(change_list):
1692
if skip_root and file_id[0] is not None and parent[0] is None:
1694
trans_id = tt.trans_id_file_id(file_id)
1697
keep_content = False
1698
if kind[0] == 'file' and (backups or kind[1] is None):
1699
wt_sha1 = working_tree.get_file_sha1(file_id)
1700
if merge_modified.get(file_id) != wt_sha1:
1701
# acquire the basis tree lazily to prevent the
1702
# expense of accessing it when it's not needed ?
1703
# (Guessing, RBC, 200702)
1704
if basis_tree is None:
1705
basis_tree = working_tree.basis_tree()
1706
basis_tree.lock_read()
1707
if file_id in basis_tree:
1708
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1710
elif kind[1] is None and not versioned[1]:
1712
if kind[0] is not None:
1713
if not keep_content:
1714
tt.delete_contents(trans_id)
1715
elif kind[1] is not None:
1716
parent_trans_id = tt.trans_id_file_id(parent[0])
1717
by_parent = tt.by_parent()
1718
backup_name = _get_backup_name(name[0], by_parent,
1719
parent_trans_id, tt)
1720
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1721
new_trans_id = tt.create_path(name[0], parent_trans_id)
1722
if versioned == (True, True):
1723
tt.unversion_file(trans_id)
1724
tt.version_file(file_id, new_trans_id)
1725
# New contents should have the same unix perms as old
1728
trans_id = new_trans_id
1729
if kind[1] == 'directory':
1730
tt.create_directory(trans_id)
1731
elif kind[1] == 'symlink':
1732
tt.create_symlink(target_tree.get_symlink_target(file_id),
1734
elif kind[1] == 'file':
1735
deferred_files.append((file_id, (trans_id, mode_id)))
1736
if basis_tree is None:
1737
basis_tree = working_tree.basis_tree()
1738
basis_tree.lock_read()
1739
new_sha1 = target_tree.get_file_sha1(file_id)
1740
if (file_id in basis_tree and new_sha1 ==
1741
basis_tree.get_file_sha1(file_id)):
1742
if file_id in merge_modified:
1743
del merge_modified[file_id]
1745
merge_modified[file_id] = new_sha1
1747
# preserve the execute bit when backing up
1748
if keep_content and executable[0] == executable[1]:
1749
tt.set_executability(executable[1], trans_id)
1751
assert kind[1] is None
1752
if versioned == (False, True):
1753
tt.version_file(file_id, trans_id)
1754
if versioned == (True, False):
1755
tt.unversion_file(trans_id)
1756
if (name[1] is not None and
1757
(name[0] != name[1] or parent[0] != parent[1])):
1759
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1760
if executable[0] != executable[1] and kind[1] == "file":
1761
tt.set_executability(executable[1], trans_id)
1762
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1764
tt.create_file(bytes, trans_id, mode_id)
1766
if basis_tree is not None:
1768
return merge_modified
1771
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1772
"""Make many conflict-resolution attempts, but die if they fail"""
1773
if pass_func is None:
1774
pass_func = conflict_pass
1775
new_conflicts = set()
1778
pb.update('Resolution pass', n+1, 10)
1779
conflicts = tt.find_conflicts()
1780
if len(conflicts) == 0:
1781
return new_conflicts
1782
new_conflicts.update(pass_func(tt, conflicts))
1783
raise MalformedTransform(conflicts=conflicts)
1788
def conflict_pass(tt, conflicts, path_tree=None):
1789
"""Resolve some classes of conflicts.
1791
:param tt: The transform to resolve conflicts in
1792
:param conflicts: The conflicts to resolve
1793
:param path_tree: A Tree to get supplemental paths from
1795
new_conflicts = set()
1796
for c_type, conflict in ((c[0], c) for c in conflicts):
1797
if c_type == 'duplicate id':
1798
tt.unversion_file(conflict[1])
1799
new_conflicts.add((c_type, 'Unversioned existing file',
1800
conflict[1], conflict[2], ))
1801
elif c_type == 'duplicate':
1802
# files that were renamed take precedence
1803
final_parent = tt.final_parent(conflict[1])
1804
if tt.path_changed(conflict[1]):
1805
existing_file, new_file = conflict[2], conflict[1]
1807
existing_file, new_file = conflict[1], conflict[2]
1808
new_name = tt.final_name(existing_file)+'.moved'
1809
tt.adjust_path(new_name, final_parent, existing_file)
1810
new_conflicts.add((c_type, 'Moved existing file to',
1811
existing_file, new_file))
1812
elif c_type == 'parent loop':
1813
# break the loop by undoing one of the ops that caused the loop
1815
while not tt.path_changed(cur):
1816
cur = tt.final_parent(cur)
1817
new_conflicts.add((c_type, 'Cancelled move', cur,
1818
tt.final_parent(cur),))
1819
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1821
elif c_type == 'missing parent':
1822
trans_id = conflict[1]
1824
tt.cancel_deletion(trans_id)
1825
new_conflicts.add(('deleting parent', 'Not deleting',
1828
tt.create_directory(trans_id)
1829
new_conflicts.add((c_type, 'Created directory', trans_id))
1831
tt.final_name(trans_id)
1833
if path_tree is not None:
1834
file_id = tt.final_file_id(trans_id)
1835
entry = path_tree.inventory[file_id]
1836
parent_trans_id = tt.trans_id_file_id(entry.parent_id)
1837
tt.adjust_path(entry.name, parent_trans_id, trans_id)
1838
elif c_type == 'unversioned parent':
1839
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1840
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
1841
return new_conflicts
1844
def cook_conflicts(raw_conflicts, tt):
1845
"""Generate a list of cooked conflicts, sorted by file path"""
1846
from bzrlib.conflicts import Conflict
1847
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1848
return sorted(conflict_iter, key=Conflict.sort_key)
1851
def iter_cook_conflicts(raw_conflicts, tt):
1852
from bzrlib.conflicts import Conflict
1854
for conflict in raw_conflicts:
1855
c_type = conflict[0]
1856
action = conflict[1]
1857
modified_path = fp.get_path(conflict[2])
1858
modified_id = tt.final_file_id(conflict[2])
1859
if len(conflict) == 3:
1860
yield Conflict.factory(c_type, action=action, path=modified_path,
1861
file_id=modified_id)
1864
conflicting_path = fp.get_path(conflict[3])
1865
conflicting_id = tt.final_file_id(conflict[3])
1866
yield Conflict.factory(c_type, action=action, path=modified_path,
1867
file_id=modified_id,
1868
conflict_path=conflicting_path,
1869
conflict_file_id=conflicting_id)
1872
class _FileMover(object):
1873
"""Moves and deletes files for TreeTransform, tracking operations"""
1876
self.past_renames = []
1877
self.pending_deletions = []
1879
def rename(self, from_, to):
1880
"""Rename a file from one path to another. Functions like os.rename"""
1882
os.rename(from_, to)
1884
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
1885
raise errors.FileExists(to, str(e))
1887
self.past_renames.append((from_, to))
1889
def pre_delete(self, from_, to):
1890
"""Rename a file out of the way and mark it for deletion.
1892
Unlike os.unlink, this works equally well for files and directories.
1893
:param from_: The current file path
1894
:param to: A temporary path for the file
1896
self.rename(from_, to)
1897
self.pending_deletions.append(to)
1900
"""Reverse all renames that have been performed"""
1901
for from_, to in reversed(self.past_renames):
1902
os.rename(to, from_)
1903
# after rollback, don't reuse _FileMover
1905
pending_deletions = None
1907
def apply_deletions(self):
1908
"""Apply all marked deletions"""
1909
for path in self.pending_deletions:
1911
# after apply_deletions, don't reuse _FileMover
1913
pending_deletions = None
added
removed
bzrlib/transform.py
