1
# Copyright (C) 2006 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.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
22
ReusingTransform, NotVersionedError, CantMoveRoot,
23
ExistingLimbo, ImmortalLimbo)
24
from bzrlib.inventory import InventoryEntry
25
from bzrlib.osutils import file_kind, supports_executable, pathjoin
26
from bzrlib.progress import DummyProgress, ProgressPhase
27
from bzrlib.trace import mutter, warning
31
ROOT_PARENT = "root-parent"
34
def unique_add(map, key, value):
36
raise DuplicateKey(key=key)
40
class _TransformResults(object):
41
def __init__(self, modified_paths):
43
self.modified_paths = modified_paths
46
class TreeTransform(object):
47
"""Represent a tree transformation.
49
This object is designed to support incremental generation of the transform,
52
It is easy to produce malformed transforms, but they are generally
53
harmless. Attempting to apply a malformed transform will cause an
54
exception to be raised before any modifications are made to the tree.
56
Many kinds of malformed transforms can be corrected with the
57
resolve_conflicts function. The remaining ones indicate programming error,
58
such as trying to create a file with no path.
60
Two sets of file creation methods are supplied. Convenience methods are:
65
These are composed of the low-level methods:
67
* create_file or create_directory or create_symlink
71
def __init__(self, tree, pb=DummyProgress()):
72
"""Note: a write lock is taken on the tree.
74
Use TreeTransform.finalize() to release the lock
78
self._tree.lock_write()
80
control_files = self._tree._control_files
81
self._limbodir = control_files.controlfilename('limbo')
83
os.mkdir(self._limbodir)
85
if e.errno == errno.EEXIST:
86
raise ExistingLimbo(self._limbodir)
94
self._new_contents = {}
95
self._removed_contents = set()
96
self._new_executability = {}
98
self._non_present_ids = {}
100
self._removed_id = set()
101
self._tree_path_ids = {}
102
self._tree_id_paths = {}
103
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
107
def __get_root(self):
108
return self._new_root
110
root = property(__get_root)
113
"""Release the working tree lock, if held, clean up limbo dir."""
114
if self._tree is None:
117
for trans_id, kind in self._new_contents.iteritems():
118
path = self._limbo_name(trans_id)
119
if kind == "directory":
124
os.rmdir(self._limbodir)
126
# We don't especially care *why* the dir is immortal.
127
raise ImmortalLimbo(self._limbodir)
132
def _assign_id(self):
133
"""Produce a new tranform id"""
134
new_id = "new-%s" % self._id_number
138
def create_path(self, name, parent):
139
"""Assign a transaction id to a new path"""
140
trans_id = self._assign_id()
141
unique_add(self._new_name, trans_id, name)
142
unique_add(self._new_parent, trans_id, parent)
145
def adjust_path(self, name, parent, trans_id):
146
"""Change the path that is assigned to a transaction id."""
147
if trans_id == self._new_root:
149
self._new_name[trans_id] = name
150
self._new_parent[trans_id] = parent
152
def adjust_root_path(self, name, parent):
153
"""Emulate moving the root by moving all children, instead.
155
We do this by undoing the association of root's transaction id with the
156
current tree. This allows us to create a new directory with that
157
transaction id. We unversion the root directory and version the
158
physically new directory, and hope someone versions the tree root
161
old_root = self._new_root
162
old_root_file_id = self.final_file_id(old_root)
163
# force moving all children of root
164
for child_id in self.iter_tree_children(old_root):
165
if child_id != parent:
166
self.adjust_path(self.final_name(child_id),
167
self.final_parent(child_id), child_id)
168
file_id = self.final_file_id(child_id)
169
if file_id is not None:
170
self.unversion_file(child_id)
171
self.version_file(file_id, child_id)
173
# the physical root needs a new transaction id
174
self._tree_path_ids.pop("")
175
self._tree_id_paths.pop(old_root)
176
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
177
if parent == old_root:
178
parent = self._new_root
179
self.adjust_path(name, parent, old_root)
180
self.create_directory(old_root)
181
self.version_file(old_root_file_id, old_root)
182
self.unversion_file(self._new_root)
184
def trans_id_tree_file_id(self, inventory_id):
185
"""Determine the transaction id of a working tree file.
187
This reflects only files that already exist, not ones that will be
188
added by transactions.
190
path = self._tree.inventory.id2path(inventory_id)
191
return self.trans_id_tree_path(path)
193
def trans_id_file_id(self, file_id):
194
"""Determine or set the transaction id associated with a file ID.
195
A new id is only created for file_ids that were never present. If
196
a transaction has been unversioned, it is deliberately still returned.
197
(this will likely lead to an unversioned parent conflict.)
199
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
200
return self._r_new_id[file_id]
201
elif file_id in self._tree.inventory:
202
return self.trans_id_tree_file_id(file_id)
203
elif file_id in self._non_present_ids:
204
return self._non_present_ids[file_id]
206
trans_id = self._assign_id()
207
self._non_present_ids[file_id] = trans_id
210
def canonical_path(self, path):
211
"""Get the canonical tree-relative path"""
212
# don't follow final symlinks
213
dirname, basename = os.path.split(self._tree.abspath(path))
214
dirname = os.path.realpath(dirname)
215
return self._tree.relpath(pathjoin(dirname, basename))
217
def trans_id_tree_path(self, path):
218
"""Determine (and maybe set) the transaction ID for a tree path."""
219
path = self.canonical_path(path)
220
if path not in self._tree_path_ids:
221
self._tree_path_ids[path] = self._assign_id()
222
self._tree_id_paths[self._tree_path_ids[path]] = path
223
return self._tree_path_ids[path]
225
def get_tree_parent(self, trans_id):
226
"""Determine id of the parent in the tree."""
227
path = self._tree_id_paths[trans_id]
230
return self.trans_id_tree_path(os.path.dirname(path))
232
def create_file(self, contents, trans_id, mode_id=None):
233
"""Schedule creation of a new file.
237
Contents is an iterator of strings, all of which will be written
238
to the target destination.
240
New file takes the permissions of any existing file with that id,
241
unless mode_id is specified.
243
f = file(self._limbo_name(trans_id), 'wb')
244
unique_add(self._new_contents, trans_id, 'file')
245
for segment in contents:
248
self._set_mode(trans_id, mode_id, S_ISREG)
250
def _set_mode(self, trans_id, mode_id, typefunc):
251
"""Set the mode of new file contents.
252
The mode_id is the existing file to get the mode from (often the same
253
as trans_id). The operation is only performed if there's a mode match
254
according to typefunc.
259
old_path = self._tree_id_paths[mode_id]
263
mode = os.stat(old_path).st_mode
265
if e.errno == errno.ENOENT:
270
os.chmod(self._limbo_name(trans_id), mode)
272
def create_directory(self, trans_id):
273
"""Schedule creation of a new directory.
275
See also new_directory.
277
os.mkdir(self._limbo_name(trans_id))
278
unique_add(self._new_contents, trans_id, 'directory')
280
def create_symlink(self, target, trans_id):
281
"""Schedule creation of a new symbolic link.
283
target is a bytestring.
284
See also new_symlink.
286
os.symlink(target, self._limbo_name(trans_id))
287
unique_add(self._new_contents, trans_id, 'symlink')
290
def delete_any(full_path):
291
"""Delete a file or directory."""
295
# We may be renaming a dangling inventory id
296
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
300
def cancel_creation(self, trans_id):
301
"""Cancel the creation of new file contents."""
302
del self._new_contents[trans_id]
303
self.delete_any(self._limbo_name(trans_id))
305
def delete_contents(self, trans_id):
306
"""Schedule the contents of a path entry for deletion"""
307
self.tree_kind(trans_id)
308
self._removed_contents.add(trans_id)
310
def cancel_deletion(self, trans_id):
311
"""Cancel a scheduled deletion"""
312
self._removed_contents.remove(trans_id)
314
def unversion_file(self, trans_id):
315
"""Schedule a path entry to become unversioned"""
316
self._removed_id.add(trans_id)
318
def delete_versioned(self, trans_id):
319
"""Delete and unversion a versioned file"""
320
self.delete_contents(trans_id)
321
self.unversion_file(trans_id)
323
def set_executability(self, executability, trans_id):
324
"""Schedule setting of the 'execute' bit
325
To unschedule, set to None
327
if executability is None:
328
del self._new_executability[trans_id]
330
unique_add(self._new_executability, trans_id, executability)
332
def version_file(self, file_id, trans_id):
333
"""Schedule a file to become versioned."""
334
assert file_id is not None
335
unique_add(self._new_id, trans_id, file_id)
336
unique_add(self._r_new_id, file_id, trans_id)
338
def cancel_versioning(self, trans_id):
339
"""Undo a previous versioning of a file"""
340
file_id = self._new_id[trans_id]
341
del self._new_id[trans_id]
342
del self._r_new_id[file_id]
345
"""Determine the paths of all new and changed files"""
347
fp = FinalPaths(self)
348
for id_set in (self._new_name, self._new_parent, self._new_contents,
349
self._new_id, self._new_executability):
350
new_ids.update(id_set)
351
new_paths = [(fp.get_path(t), t) for t in new_ids]
355
def tree_kind(self, trans_id):
356
"""Determine the file kind in the working tree.
358
Raises NoSuchFile if the file does not exist
360
path = self._tree_id_paths.get(trans_id)
362
raise NoSuchFile(None)
364
return file_kind(self._tree.abspath(path))
366
if e.errno != errno.ENOENT:
369
raise NoSuchFile(path)
371
def final_kind(self, trans_id):
372
"""Determine the final file kind, after any changes applied.
374
Raises NoSuchFile if the file does not exist/has no contents.
375
(It is conceivable that a path would be created without the
376
corresponding contents insertion command)
378
if trans_id in self._new_contents:
379
return self._new_contents[trans_id]
380
elif trans_id in self._removed_contents:
381
raise NoSuchFile(None)
383
return self.tree_kind(trans_id)
385
def tree_file_id(self, trans_id):
386
"""Determine the file id associated with the trans_id in the tree"""
388
path = self._tree_id_paths[trans_id]
390
# the file is a new, unversioned file, or invalid trans_id
392
# the file is old; the old id is still valid
393
if self._new_root == trans_id:
394
return self._tree.inventory.root.file_id
395
return self._tree.inventory.path2id(path)
397
def final_file_id(self, trans_id):
398
"""Determine the file id after any changes are applied, or None.
400
None indicates that the file will not be versioned after changes are
404
# there is a new id for this file
405
assert self._new_id[trans_id] is not None
406
return self._new_id[trans_id]
408
if trans_id in self._removed_id:
410
return self.tree_file_id(trans_id)
412
def inactive_file_id(self, trans_id):
413
"""Return the inactive file_id associated with a transaction id.
414
That is, the one in the tree or in non_present_ids.
415
The file_id may actually be active, too.
417
file_id = self.tree_file_id(trans_id)
418
if file_id is not None:
420
for key, value in self._non_present_ids.iteritems():
421
if value == trans_id:
424
def final_parent(self, trans_id):
425
"""Determine the parent file_id, after any changes are applied.
427
ROOT_PARENT is returned for the tree root.
430
return self._new_parent[trans_id]
432
return self.get_tree_parent(trans_id)
434
def final_name(self, trans_id):
435
"""Determine the final filename, after all changes are applied."""
437
return self._new_name[trans_id]
439
return os.path.basename(self._tree_id_paths[trans_id])
441
def _by_parent(self):
442
"""Return a map of parent: children for known parents.
444
Only new paths and parents of tree files with assigned ids are used.
447
items = list(self._new_parent.iteritems())
448
items.extend((t, self.final_parent(t)) for t in
449
self._tree_id_paths.keys())
450
for trans_id, parent_id in items:
451
if parent_id not in by_parent:
452
by_parent[parent_id] = set()
453
by_parent[parent_id].add(trans_id)
456
def path_changed(self, trans_id):
457
"""Return True if a trans_id's path has changed."""
458
return trans_id in self._new_name or trans_id in self._new_parent
460
def find_conflicts(self):
461
"""Find any violations of inventory or filesystem invariants"""
462
if self.__done is True:
463
raise ReusingTransform()
465
# ensure all children of all existent parents are known
466
# all children of non-existent parents are known, by definition.
467
self._add_tree_children()
468
by_parent = self._by_parent()
469
conflicts.extend(self._unversioned_parents(by_parent))
470
conflicts.extend(self._parent_loops())
471
conflicts.extend(self._duplicate_entries(by_parent))
472
conflicts.extend(self._duplicate_ids())
473
conflicts.extend(self._parent_type_conflicts(by_parent))
474
conflicts.extend(self._improper_versioning())
475
conflicts.extend(self._executability_conflicts())
476
conflicts.extend(self._overwrite_conflicts())
479
def _add_tree_children(self):
480
"""Add all the children of all active parents to the known paths.
482
Active parents are those which gain children, and those which are
483
removed. This is a necessary first step in detecting conflicts.
485
parents = self._by_parent().keys()
486
parents.extend([t for t in self._removed_contents if
487
self.tree_kind(t) == 'directory'])
488
for trans_id in self._removed_id:
489
file_id = self.tree_file_id(trans_id)
490
if self._tree.inventory[file_id].kind in ('directory',
492
parents.append(trans_id)
494
for parent_id in parents:
495
# ensure that all children are registered with the transaction
496
list(self.iter_tree_children(parent_id))
498
def iter_tree_children(self, parent_id):
499
"""Iterate through the entry's tree children, if any"""
501
path = self._tree_id_paths[parent_id]
505
children = os.listdir(self._tree.abspath(path))
507
if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
511
for child in children:
512
childpath = joinpath(path, child)
513
if self._tree.is_control_filename(childpath):
515
yield self.trans_id_tree_path(childpath)
517
def _parent_loops(self):
518
"""No entry should be its own ancestor"""
520
for trans_id in self._new_parent:
523
while parent_id is not ROOT_PARENT:
525
parent_id = self.final_parent(parent_id)
526
if parent_id == trans_id:
527
conflicts.append(('parent loop', trans_id))
528
if parent_id in seen:
532
def _unversioned_parents(self, by_parent):
533
"""If parent directories are versioned, children must be versioned."""
535
for parent_id, children in by_parent.iteritems():
536
if parent_id is ROOT_PARENT:
538
if self.final_file_id(parent_id) is not None:
540
for child_id in children:
541
if self.final_file_id(child_id) is not None:
542
conflicts.append(('unversioned parent', parent_id))
546
def _improper_versioning(self):
547
"""Cannot version a file with no contents, or a bad type.
549
However, existing entries with no contents are okay.
552
for trans_id in self._new_id.iterkeys():
554
kind = self.final_kind(trans_id)
556
conflicts.append(('versioning no contents', trans_id))
558
if not InventoryEntry.versionable_kind(kind):
559
conflicts.append(('versioning bad kind', trans_id, kind))
562
def _executability_conflicts(self):
563
"""Check for bad executability changes.
565
Only versioned files may have their executability set, because
566
1. only versioned entries can have executability under windows
567
2. only files can be executable. (The execute bit on a directory
568
does not indicate searchability)
571
for trans_id in self._new_executability:
572
if self.final_file_id(trans_id) is None:
573
conflicts.append(('unversioned executability', trans_id))
576
non_file = self.final_kind(trans_id) != "file"
580
conflicts.append(('non-file executability', trans_id))
583
def _overwrite_conflicts(self):
584
"""Check for overwrites (not permitted on Win32)"""
586
for trans_id in self._new_contents:
588
self.tree_kind(trans_id)
591
if trans_id not in self._removed_contents:
592
conflicts.append(('overwrite', trans_id,
593
self.final_name(trans_id)))
596
def _duplicate_entries(self, by_parent):
597
"""No directory may have two entries with the same name."""
599
for children in by_parent.itervalues():
600
name_ids = [(self.final_name(t), t) for t in children]
604
for name, trans_id in name_ids:
605
if name == last_name:
606
conflicts.append(('duplicate', last_trans_id, trans_id,
609
last_trans_id = trans_id
612
def _duplicate_ids(self):
613
"""Each inventory id may only be used once"""
615
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
617
active_tree_ids = set((f for f in self._tree.inventory if
618
f not in removed_tree_ids))
619
for trans_id, file_id in self._new_id.iteritems():
620
if file_id in active_tree_ids:
621
old_trans_id = self.trans_id_tree_file_id(file_id)
622
conflicts.append(('duplicate id', old_trans_id, trans_id))
625
def _parent_type_conflicts(self, by_parent):
626
"""parents must have directory 'contents'."""
628
for parent_id, children in by_parent.iteritems():
629
if parent_id is ROOT_PARENT:
631
if not self._any_contents(children):
633
for child in children:
635
self.final_kind(child)
639
kind = self.final_kind(parent_id)
643
conflicts.append(('missing parent', parent_id))
644
elif kind != "directory":
645
conflicts.append(('non-directory parent', parent_id))
648
def _any_contents(self, trans_ids):
649
"""Return true if any of the trans_ids, will have contents."""
650
for trans_id in trans_ids:
652
kind = self.final_kind(trans_id)
659
"""Apply all changes to the inventory and filesystem.
661
If filesystem or inventory conflicts are present, MalformedTransform
664
conflicts = self.find_conflicts()
665
if len(conflicts) != 0:
666
raise MalformedTransform(conflicts=conflicts)
668
inv = self._tree.inventory
669
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
671
child_pb.update('Apply phase', 0, 2)
672
self._apply_removals(inv, limbo_inv)
673
child_pb.update('Apply phase', 1, 2)
674
modified_paths = self._apply_insertions(inv, limbo_inv)
677
self._tree._write_inventory(inv)
680
return _TransformResults(modified_paths)
682
def _limbo_name(self, trans_id):
683
"""Generate the limbo name of a file"""
684
return pathjoin(self._limbodir, trans_id)
686
def _apply_removals(self, inv, limbo_inv):
687
"""Perform tree operations that remove directory/inventory names.
689
That is, delete files that are to be deleted, and put any files that
690
need renaming into limbo. This must be done in strict child-to-parent
693
tree_paths = list(self._tree_path_ids.iteritems())
694
tree_paths.sort(reverse=True)
695
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
697
for num, data in enumerate(tree_paths):
698
path, trans_id = data
699
child_pb.update('removing file', num, len(tree_paths))
700
full_path = self._tree.abspath(path)
701
if trans_id in self._removed_contents:
702
self.delete_any(full_path)
703
elif trans_id in self._new_name or trans_id in \
706
os.rename(full_path, self._limbo_name(trans_id))
708
if e.errno != errno.ENOENT:
710
if trans_id in self._removed_id:
711
if trans_id == self._new_root:
712
file_id = self._tree.inventory.root.file_id
714
file_id = self.tree_file_id(trans_id)
716
elif trans_id in self._new_name or trans_id in self._new_parent:
717
file_id = self.tree_file_id(trans_id)
718
if file_id is not None:
719
limbo_inv[trans_id] = inv[file_id]
724
def _apply_insertions(self, inv, limbo_inv):
725
"""Perform tree operations that insert directory/inventory names.
727
That is, create any files that need to be created, and restore from
728
limbo any files that needed renaming. This must be done in strict
729
parent-to-child order.
731
new_paths = self.new_paths()
733
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
735
for num, (path, trans_id) in enumerate(new_paths):
736
child_pb.update('adding file', num, len(new_paths))
738
kind = self._new_contents[trans_id]
740
kind = contents = None
741
if trans_id in self._new_contents or \
742
self.path_changed(trans_id):
743
full_path = self._tree.abspath(path)
745
os.rename(self._limbo_name(trans_id), full_path)
747
# We may be renaming a dangling inventory id
748
if e.errno != errno.ENOENT:
750
if trans_id in self._new_contents:
751
modified_paths.append(full_path)
752
del self._new_contents[trans_id]
754
if trans_id in self._new_id:
756
kind = file_kind(self._tree.abspath(path))
757
inv.add_path(path, kind, self._new_id[trans_id])
758
elif trans_id in self._new_name or trans_id in\
760
entry = limbo_inv.get(trans_id)
761
if entry is not None:
762
entry.name = self.final_name(trans_id)
763
parent_path = os.path.dirname(path)
765
self._tree.inventory.path2id(parent_path)
768
# requires files and inventory entries to be in place
769
if trans_id in self._new_executability:
770
self._set_executability(path, inv, trans_id)
773
return modified_paths
775
def _set_executability(self, path, inv, trans_id):
776
"""Set the executability of versioned files """
777
file_id = inv.path2id(path)
778
new_executability = self._new_executability[trans_id]
779
inv[file_id].executable = new_executability
780
if supports_executable():
781
abspath = self._tree.abspath(path)
782
current_mode = os.stat(abspath).st_mode
783
if new_executability:
786
to_mode = current_mode | (0100 & ~umask)
787
# Enable x-bit for others only if they can read it.
788
if current_mode & 0004:
789
to_mode |= 0001 & ~umask
790
if current_mode & 0040:
791
to_mode |= 0010 & ~umask
793
to_mode = current_mode & ~0111
794
os.chmod(abspath, to_mode)
796
def _new_entry(self, name, parent_id, file_id):
797
"""Helper function to create a new filesystem entry."""
798
trans_id = self.create_path(name, parent_id)
799
if file_id is not None:
800
self.version_file(file_id, trans_id)
803
def new_file(self, name, parent_id, contents, file_id=None,
805
"""Convenience method to create files.
807
name is the name of the file to create.
808
parent_id is the transaction id of the parent directory of the file.
809
contents is an iterator of bytestrings, which will be used to produce
811
file_id is the inventory ID of the file, if it is to be versioned.
813
trans_id = self._new_entry(name, parent_id, file_id)
814
self.create_file(contents, trans_id)
815
if executable is not None:
816
self.set_executability(executable, trans_id)
819
def new_directory(self, name, parent_id, file_id=None):
820
"""Convenience method to create directories.
822
name is the name of the directory to create.
823
parent_id is the transaction id of the parent directory of the
825
file_id is the inventory ID of the directory, if it is to be versioned.
827
trans_id = self._new_entry(name, parent_id, file_id)
828
self.create_directory(trans_id)
831
def new_symlink(self, name, parent_id, target, file_id=None):
832
"""Convenience method to create symbolic link.
834
name is the name of the symlink to create.
835
parent_id is the transaction id of the parent directory of the symlink.
836
target is a bytestring of the target of the symlink.
837
file_id is the inventory ID of the file, if it is to be versioned.
839
trans_id = self._new_entry(name, parent_id, file_id)
840
self.create_symlink(target, trans_id)
843
def joinpath(parent, child):
844
"""Join tree-relative paths, handling the tree root specially"""
845
if parent is None or parent == "":
848
return pathjoin(parent, child)
851
class FinalPaths(object):
852
"""Make path calculation cheap by memoizing paths.
854
The underlying tree must not be manipulated between calls, or else
855
the results will likely be incorrect.
857
def __init__(self, transform):
858
object.__init__(self)
859
self._known_paths = {}
860
self.transform = transform
862
def _determine_path(self, trans_id):
863
if trans_id == self.transform.root:
865
name = self.transform.final_name(trans_id)
866
parent_id = self.transform.final_parent(trans_id)
867
if parent_id == self.transform.root:
870
return pathjoin(self.get_path(parent_id), name)
872
def get_path(self, trans_id):
873
"""Find the final path associated with a trans_id"""
874
if trans_id not in self._known_paths:
875
self._known_paths[trans_id] = self._determine_path(trans_id)
876
return self._known_paths[trans_id]
878
def topology_sorted_ids(tree):
879
"""Determine the topological order of the ids in a tree"""
880
file_ids = list(tree)
881
file_ids.sort(key=tree.id2path)
884
def build_tree(tree, wt):
885
"""Create working tree for a branch, using a Transaction."""
887
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
888
pp = ProgressPhase("Build phase", 2, top_pb)
889
tt = TreeTransform(wt)
892
file_trans_id[wt.get_root_id()] = tt.trans_id_tree_file_id(wt.get_root_id())
893
file_ids = topology_sorted_ids(tree)
894
pb = bzrlib.ui.ui_factory.nested_progress_bar()
896
for num, file_id in enumerate(file_ids):
897
pb.update("Building tree", num, len(file_ids))
898
entry = tree.inventory[file_id]
899
if entry.parent_id is None:
901
if entry.parent_id not in file_trans_id:
902
raise repr(entry.parent_id)
903
parent_id = file_trans_id[entry.parent_id]
904
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
914
def new_by_entry(tt, entry, parent_id, tree):
915
"""Create a new file according to its inventory entry"""
919
contents = tree.get_file(entry.file_id).readlines()
920
executable = tree.is_executable(entry.file_id)
921
return tt.new_file(name, parent_id, contents, entry.file_id,
923
elif kind == 'directory':
924
return tt.new_directory(name, parent_id, entry.file_id)
925
elif kind == 'symlink':
926
target = tree.get_symlink_target(entry.file_id)
927
return tt.new_symlink(name, parent_id, target, entry.file_id)
929
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
930
"""Create new file contents according to an inventory entry."""
931
if entry.kind == "file":
933
lines = tree.get_file(entry.file_id).readlines()
934
tt.create_file(lines, trans_id, mode_id=mode_id)
935
elif entry.kind == "symlink":
936
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
937
elif entry.kind == "directory":
938
tt.create_directory(trans_id)
940
def create_entry_executability(tt, entry, trans_id):
941
"""Set the executability of a trans_id according to an inventory entry"""
942
if entry.kind == "file":
943
tt.set_executability(entry.executable, trans_id)
946
def find_interesting(working_tree, target_tree, filenames):
947
"""Find the ids corresponding to specified filenames."""
949
interesting_ids = None
951
interesting_ids = set()
952
for tree_path in filenames:
953
for tree in (working_tree, target_tree):
955
file_id = tree.inventory.path2id(tree_path)
956
if file_id is not None:
957
interesting_ids.add(file_id)
960
raise NotVersionedError(path=tree_path)
961
return interesting_ids
964
def change_entry(tt, file_id, working_tree, target_tree,
965
trans_id_file_id, backups, trans_id):
966
"""Replace a file_id's contents with those from a target tree."""
967
e_trans_id = trans_id_file_id(file_id)
968
entry = target_tree.inventory[file_id]
969
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
975
tt.delete_contents(e_trans_id)
977
parent_trans_id = trans_id_file_id(entry.parent_id)
978
tt.adjust_path(entry.name+"~", parent_trans_id, e_trans_id)
979
tt.unversion_file(e_trans_id)
980
e_trans_id = tt.create_path(entry.name, parent_trans_id)
981
tt.version_file(file_id, e_trans_id)
982
trans_id[file_id] = e_trans_id
983
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
984
create_entry_executability(tt, entry, e_trans_id)
987
tt.set_executability(entry.executable, e_trans_id)
988
if tt.final_name(e_trans_id) != entry.name:
991
parent_id = tt.final_parent(e_trans_id)
992
parent_file_id = tt.final_file_id(parent_id)
993
if parent_file_id != entry.parent_id:
998
parent_trans_id = trans_id_file_id(entry.parent_id)
999
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1002
def _entry_changes(file_id, entry, working_tree):
1003
"""Determine in which ways the inventory entry has changed.
1005
Returns booleans: has_contents, content_mod, meta_mod
1006
has_contents means there are currently contents, but they differ
1007
contents_mod means contents need to be modified
1008
meta_mod means the metadata needs to be modified
1010
cur_entry = working_tree.inventory[file_id]
1012
working_kind = working_tree.kind(file_id)
1015
if e.errno != errno.ENOENT:
1017
has_contents = False
1020
if has_contents is True:
1021
real_e_kind = entry.kind
1022
if real_e_kind == 'root_directory':
1023
real_e_kind = 'directory'
1024
if real_e_kind != working_kind:
1025
contents_mod, meta_mod = True, False
1027
cur_entry._read_tree_state(working_tree.id2path(file_id),
1029
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1030
cur_entry._forget_tree_state()
1031
return has_contents, contents_mod, meta_mod
1034
def revert(working_tree, target_tree, filenames, backups=False,
1035
pb=DummyProgress()):
1036
"""Revert a working tree's contents to those of a target tree."""
1037
interesting_ids = find_interesting(working_tree, target_tree, filenames)
1038
def interesting(file_id):
1039
return interesting_ids is None or file_id in interesting_ids
1041
tt = TreeTransform(working_tree, pb)
1043
merge_modified = working_tree.merge_modified()
1045
def trans_id_file_id(file_id):
1047
return trans_id[file_id]
1049
return tt.trans_id_tree_file_id(file_id)
1051
pp = ProgressPhase("Revert phase", 4, pb)
1053
sorted_interesting = [i for i in topology_sorted_ids(target_tree) if
1055
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1057
for id_num, file_id in enumerate(sorted_interesting):
1058
child_pb.update("Reverting file", id_num+1,
1059
len(sorted_interesting))
1060
if file_id not in working_tree.inventory:
1061
entry = target_tree.inventory[file_id]
1062
parent_id = trans_id_file_id(entry.parent_id)
1063
e_trans_id = new_by_entry(tt, entry, parent_id, target_tree)
1064
trans_id[file_id] = e_trans_id
1066
backup_this = backups
1067
if file_id in merge_modified:
1069
del merge_modified[file_id]
1070
change_entry(tt, file_id, working_tree, target_tree,
1071
trans_id_file_id, backup_this, trans_id)
1075
wt_interesting = [i for i in working_tree.inventory if interesting(i)]
1076
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1078
for id_num, file_id in enumerate(wt_interesting):
1079
child_pb.update("New file check", id_num+1,
1080
len(sorted_interesting))
1081
if file_id not in target_tree:
1082
trans_id = tt.trans_id_tree_file_id(file_id)
1083
tt.unversion_file(trans_id)
1084
if file_id in merge_modified:
1085
tt.delete_contents(trans_id)
1086
del merge_modified[file_id]
1090
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1092
raw_conflicts = resolve_conflicts(tt, child_pb)
1095
for line in conflicts_strings(cook_conflicts(raw_conflicts, tt)):
1099
working_tree.set_merge_modified({})
1105
def resolve_conflicts(tt, pb=DummyProgress()):
1106
"""Make many conflict-resolution attempts, but die if they fail"""
1107
new_conflicts = set()
1110
pb.update('Resolution pass', n+1, 10)
1111
conflicts = tt.find_conflicts()
1112
if len(conflicts) == 0:
1113
return new_conflicts
1114
new_conflicts.update(conflict_pass(tt, conflicts))
1115
raise MalformedTransform(conflicts=conflicts)
1120
def conflict_pass(tt, conflicts):
1121
"""Resolve some classes of conflicts."""
1122
new_conflicts = set()
1123
for c_type, conflict in ((c[0], c) for c in conflicts):
1124
if c_type == 'duplicate id':
1125
tt.unversion_file(conflict[1])
1126
new_conflicts.add((c_type, 'Unversioned existing file',
1127
conflict[1], conflict[2], ))
1128
elif c_type == 'duplicate':
1129
# files that were renamed take precedence
1130
new_name = tt.final_name(conflict[1])+'.moved'
1131
final_parent = tt.final_parent(conflict[1])
1132
if tt.path_changed(conflict[1]):
1133
tt.adjust_path(new_name, final_parent, conflict[2])
1134
new_conflicts.add((c_type, 'Moved existing file to',
1135
conflict[2], conflict[1]))
1137
tt.adjust_path(new_name, final_parent, conflict[1])
1138
new_conflicts.add((c_type, 'Moved existing file to',
1139
conflict[1], conflict[2]))
1140
elif c_type == 'parent loop':
1141
# break the loop by undoing one of the ops that caused the loop
1143
while not tt.path_changed(cur):
1144
cur = tt.final_parent(cur)
1145
new_conflicts.add((c_type, 'Cancelled move', cur,
1146
tt.final_parent(cur),))
1147
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1149
elif c_type == 'missing parent':
1150
trans_id = conflict[1]
1152
tt.cancel_deletion(trans_id)
1153
new_conflicts.add((c_type, 'Not deleting', trans_id))
1155
tt.create_directory(trans_id)
1156
new_conflicts.add((c_type, 'Created directory.', trans_id))
1157
elif c_type == 'unversioned parent':
1158
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1159
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
1160
return new_conflicts
1162
def cook_conflicts(raw_conflicts, tt):
1163
"""Generate a list of cooked conflicts, sorted by file path"""
1165
if conflict[2] is not None:
1166
return conflict[2], conflict[0]
1167
elif len(conflict) == 6:
1168
return conflict[4], conflict[0]
1170
return None, conflict[0]
1172
return sorted(list(iter_cook_conflicts(raw_conflicts, tt)), key=key)
1174
def iter_cook_conflicts(raw_conflicts, tt):
1175
cooked_conflicts = []
1177
for conflict in raw_conflicts:
1178
c_type = conflict[0]
1179
action = conflict[1]
1180
modified_path = fp.get_path(conflict[2])
1181
modified_id = tt.final_file_id(conflict[2])
1182
if len(conflict) == 3:
1183
yield c_type, action, modified_path, modified_id
1185
conflicting_path = fp.get_path(conflict[3])
1186
conflicting_id = tt.final_file_id(conflict[3])
1187
yield (c_type, action, modified_path, modified_id,
1188
conflicting_path, conflicting_id)
1191
def conflicts_strings(conflicts):
1192
"""Generate strings for the provided conflicts"""
1193
for conflict in conflicts:
1194
conflict_type = conflict[0]
1195
if conflict_type == 'text conflict':
1196
yield 'Text conflict in %s' % conflict[2]
1197
elif conflict_type == 'contents conflict':
1198
yield 'Contents conflict in %s' % conflict[2]
1199
elif conflict_type == 'path conflict':
1200
yield 'Path conflict: %s / %s' % conflict[2:]
1201
elif conflict_type == 'duplicate id':
1202
vals = (conflict[4], conflict[1], conflict[2])
1203
yield 'Conflict adding id to %s. %s %s.' % vals
1204
elif conflict_type == 'duplicate':
1205
vals = (conflict[4], conflict[1], conflict[2])
1206
yield 'Conflict adding file %s. %s %s.' % vals
1207
elif conflict_type == 'parent loop':
1208
vals = (conflict[4], conflict[2], conflict[1])
1209
yield 'Conflict moving %s into %s. %s.' % vals
1210
elif conflict_type == 'unversioned parent':
1211
vals = (conflict[2], conflict[1])
1212
yield 'Conflict adding versioned files to %s. %s.' % vals
1213
elif conflict_type == 'missing parent':
1214
vals = (conflict[2], conflict[1])
1215
yield 'Conflict adding files to %s. %s.' % vals
added
removed
bzrlib/transform.py
