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 import bzrdir, errors
22
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
23
ReusingTransform, NotVersionedError, CantMoveRoot,
24
ExistingLimbo, ImmortalLimbo, NoFinalPath)
25
from bzrlib.inventory import InventoryEntry
26
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
28
from bzrlib.progress import DummyProgress, ProgressPhase
29
from bzrlib.trace import mutter, warning
30
from bzrlib import tree
32
import bzrlib.urlutils as urlutils
35
ROOT_PARENT = "root-parent"
38
def unique_add(map, key, value):
40
raise DuplicateKey(key=key)
44
class _TransformResults(object):
45
def __init__(self, modified_paths):
47
self.modified_paths = modified_paths
50
class TreeTransform(object):
51
"""Represent a tree transformation.
53
This object is designed to support incremental generation of the transform,
56
It is easy to produce malformed transforms, but they are generally
57
harmless. Attempting to apply a malformed transform will cause an
58
exception to be raised before any modifications are made to the tree.
60
Many kinds of malformed transforms can be corrected with the
61
resolve_conflicts function. The remaining ones indicate programming error,
62
such as trying to create a file with no path.
64
Two sets of file creation methods are supplied. Convenience methods are:
69
These are composed of the low-level methods:
71
* create_file or create_directory or create_symlink
75
def __init__(self, tree, pb=DummyProgress()):
76
"""Note: a tree_write lock is taken on the tree.
78
Use TreeTransform.finalize() to release the lock
82
self._tree.lock_tree_write()
84
control_files = self._tree._control_files
85
self._limbodir = urlutils.local_path_from_url(
86
control_files.controlfilename('limbo'))
88
os.mkdir(self._limbodir)
90
if e.errno == errno.EEXIST:
91
raise ExistingLimbo(self._limbodir)
99
self._new_contents = {}
100
self._removed_contents = set()
101
self._new_executability = {}
103
self._non_present_ids = {}
105
self._removed_id = set()
106
self._tree_path_ids = {}
107
self._tree_id_paths = {}
109
# Cache of realpath results, to speed up canonical_path
111
# Cache of relpath results, to speed up canonical_path
112
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
116
def __get_root(self):
117
return self._new_root
119
root = property(__get_root)
122
"""Release the working tree lock, if held, clean up limbo dir."""
123
if self._tree is None:
126
for trans_id, kind in self._new_contents.iteritems():
127
path = self._limbo_name(trans_id)
128
if kind == "directory":
133
os.rmdir(self._limbodir)
135
# We don't especially care *why* the dir is immortal.
136
raise ImmortalLimbo(self._limbodir)
141
def _assign_id(self):
142
"""Produce a new tranform id"""
143
new_id = "new-%s" % self._id_number
147
def create_path(self, name, parent):
148
"""Assign a transaction id to a new path"""
149
trans_id = self._assign_id()
150
unique_add(self._new_name, trans_id, name)
151
unique_add(self._new_parent, trans_id, parent)
154
def adjust_path(self, name, parent, trans_id):
155
"""Change the path that is assigned to a transaction id."""
156
if trans_id == self._new_root:
158
self._new_name[trans_id] = name
159
self._new_parent[trans_id] = parent
161
def adjust_root_path(self, name, parent):
162
"""Emulate moving the root by moving all children, instead.
164
We do this by undoing the association of root's transaction id with the
165
current tree. This allows us to create a new directory with that
166
transaction id. We unversion the root directory and version the
167
physically new directory, and hope someone versions the tree root
170
old_root = self._new_root
171
old_root_file_id = self.final_file_id(old_root)
172
# force moving all children of root
173
for child_id in self.iter_tree_children(old_root):
174
if child_id != parent:
175
self.adjust_path(self.final_name(child_id),
176
self.final_parent(child_id), child_id)
177
file_id = self.final_file_id(child_id)
178
if file_id is not None:
179
self.unversion_file(child_id)
180
self.version_file(file_id, child_id)
182
# the physical root needs a new transaction id
183
self._tree_path_ids.pop("")
184
self._tree_id_paths.pop(old_root)
185
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
186
if parent == old_root:
187
parent = self._new_root
188
self.adjust_path(name, parent, old_root)
189
self.create_directory(old_root)
190
self.version_file(old_root_file_id, old_root)
191
self.unversion_file(self._new_root)
193
def trans_id_tree_file_id(self, inventory_id):
194
"""Determine the transaction id of a working tree file.
196
This reflects only files that already exist, not ones that will be
197
added by transactions.
199
path = self._tree.inventory.id2path(inventory_id)
200
return self.trans_id_tree_path(path)
202
def trans_id_file_id(self, file_id):
203
"""Determine or set the transaction id associated with a file ID.
204
A new id is only created for file_ids that were never present. If
205
a transaction has been unversioned, it is deliberately still returned.
206
(this will likely lead to an unversioned parent conflict.)
208
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
209
return self._r_new_id[file_id]
210
elif file_id in self._tree.inventory:
211
return self.trans_id_tree_file_id(file_id)
212
elif file_id in self._non_present_ids:
213
return self._non_present_ids[file_id]
215
trans_id = self._assign_id()
216
self._non_present_ids[file_id] = trans_id
219
def canonical_path(self, path):
220
"""Get the canonical tree-relative path"""
221
# don't follow final symlinks
222
abs = self._tree.abspath(path)
223
if abs in self._relpaths:
224
return self._relpaths[abs]
225
dirname, basename = os.path.split(abs)
226
if dirname not in self._realpaths:
227
self._realpaths[dirname] = os.path.realpath(dirname)
228
dirname = self._realpaths[dirname]
229
abs = pathjoin(dirname, basename)
230
if dirname in self._relpaths:
231
relpath = pathjoin(self._relpaths[dirname], basename)
232
relpath = relpath.rstrip('/\\')
234
relpath = self._tree.relpath(abs)
235
self._relpaths[abs] = relpath
238
def trans_id_tree_path(self, path):
239
"""Determine (and maybe set) the transaction ID for a tree path."""
240
path = self.canonical_path(path)
241
if path not in self._tree_path_ids:
242
self._tree_path_ids[path] = self._assign_id()
243
self._tree_id_paths[self._tree_path_ids[path]] = path
244
return self._tree_path_ids[path]
246
def get_tree_parent(self, trans_id):
247
"""Determine id of the parent in the tree."""
248
path = self._tree_id_paths[trans_id]
251
return self.trans_id_tree_path(os.path.dirname(path))
253
def create_file(self, contents, trans_id, mode_id=None):
254
"""Schedule creation of a new file.
258
Contents is an iterator of strings, all of which will be written
259
to the target destination.
261
New file takes the permissions of any existing file with that id,
262
unless mode_id is specified.
264
name = self._limbo_name(trans_id)
268
unique_add(self._new_contents, trans_id, 'file')
270
# Clean up the file, it never got registered so
271
# TreeTransform.finalize() won't clean it up.
276
f.writelines(contents)
279
self._set_mode(trans_id, mode_id, S_ISREG)
281
def _set_mode(self, trans_id, mode_id, typefunc):
282
"""Set the mode of new file contents.
283
The mode_id is the existing file to get the mode from (often the same
284
as trans_id). The operation is only performed if there's a mode match
285
according to typefunc.
290
old_path = self._tree_id_paths[mode_id]
294
mode = os.stat(self._tree.abspath(old_path)).st_mode
296
if e.errno == errno.ENOENT:
301
os.chmod(self._limbo_name(trans_id), mode)
303
def create_directory(self, trans_id):
304
"""Schedule creation of a new directory.
306
See also new_directory.
308
os.mkdir(self._limbo_name(trans_id))
309
unique_add(self._new_contents, trans_id, 'directory')
311
def create_symlink(self, target, trans_id):
312
"""Schedule creation of a new symbolic link.
314
target is a bytestring.
315
See also new_symlink.
317
os.symlink(target, self._limbo_name(trans_id))
318
unique_add(self._new_contents, trans_id, 'symlink')
320
def cancel_creation(self, trans_id):
321
"""Cancel the creation of new file contents."""
322
del self._new_contents[trans_id]
323
delete_any(self._limbo_name(trans_id))
325
def delete_contents(self, trans_id):
326
"""Schedule the contents of a path entry for deletion"""
327
self.tree_kind(trans_id)
328
self._removed_contents.add(trans_id)
330
def cancel_deletion(self, trans_id):
331
"""Cancel a scheduled deletion"""
332
self._removed_contents.remove(trans_id)
334
def unversion_file(self, trans_id):
335
"""Schedule a path entry to become unversioned"""
336
self._removed_id.add(trans_id)
338
def delete_versioned(self, trans_id):
339
"""Delete and unversion a versioned file"""
340
self.delete_contents(trans_id)
341
self.unversion_file(trans_id)
343
def set_executability(self, executability, trans_id):
344
"""Schedule setting of the 'execute' bit
345
To unschedule, set to None
347
if executability is None:
348
del self._new_executability[trans_id]
350
unique_add(self._new_executability, trans_id, executability)
352
def version_file(self, file_id, trans_id):
353
"""Schedule a file to become versioned."""
354
assert file_id is not None
355
unique_add(self._new_id, trans_id, file_id)
356
unique_add(self._r_new_id, file_id, trans_id)
358
def cancel_versioning(self, trans_id):
359
"""Undo a previous versioning of a file"""
360
file_id = self._new_id[trans_id]
361
del self._new_id[trans_id]
362
del self._r_new_id[file_id]
365
"""Determine the paths of all new and changed files"""
367
fp = FinalPaths(self)
368
for id_set in (self._new_name, self._new_parent, self._new_contents,
369
self._new_id, self._new_executability):
370
new_ids.update(id_set)
371
new_paths = [(fp.get_path(t), t) for t in new_ids]
375
def tree_kind(self, trans_id):
376
"""Determine the file kind in the working tree.
378
Raises NoSuchFile if the file does not exist
380
path = self._tree_id_paths.get(trans_id)
382
raise NoSuchFile(None)
384
return file_kind(self._tree.abspath(path))
386
if e.errno != errno.ENOENT:
389
raise NoSuchFile(path)
391
def final_kind(self, trans_id):
392
"""Determine the final file kind, after any changes applied.
394
Raises NoSuchFile if the file does not exist/has no contents.
395
(It is conceivable that a path would be created without the
396
corresponding contents insertion command)
398
if trans_id in self._new_contents:
399
return self._new_contents[trans_id]
400
elif trans_id in self._removed_contents:
401
raise NoSuchFile(None)
403
return self.tree_kind(trans_id)
405
def tree_file_id(self, trans_id):
406
"""Determine the file id associated with the trans_id in the tree"""
408
path = self._tree_id_paths[trans_id]
410
# the file is a new, unversioned file, or invalid trans_id
412
# the file is old; the old id is still valid
413
if self._new_root == trans_id:
414
return self._tree.inventory.root.file_id
415
return self._tree.inventory.path2id(path)
417
def final_file_id(self, trans_id):
418
"""Determine the file id after any changes are applied, or None.
420
None indicates that the file will not be versioned after changes are
424
# there is a new id for this file
425
assert self._new_id[trans_id] is not None
426
return self._new_id[trans_id]
428
if trans_id in self._removed_id:
430
return self.tree_file_id(trans_id)
432
def inactive_file_id(self, trans_id):
433
"""Return the inactive file_id associated with a transaction id.
434
That is, the one in the tree or in non_present_ids.
435
The file_id may actually be active, too.
437
file_id = self.tree_file_id(trans_id)
438
if file_id is not None:
440
for key, value in self._non_present_ids.iteritems():
441
if value == trans_id:
444
def final_parent(self, trans_id):
445
"""Determine the parent file_id, after any changes are applied.
447
ROOT_PARENT is returned for the tree root.
450
return self._new_parent[trans_id]
452
return self.get_tree_parent(trans_id)
454
def final_name(self, trans_id):
455
"""Determine the final filename, after all changes are applied."""
457
return self._new_name[trans_id]
460
return os.path.basename(self._tree_id_paths[trans_id])
462
raise NoFinalPath(trans_id, self)
465
"""Return a map of parent: children for known parents.
467
Only new paths and parents of tree files with assigned ids are used.
470
items = list(self._new_parent.iteritems())
471
items.extend((t, self.final_parent(t)) for t in
472
self._tree_id_paths.keys())
473
for trans_id, parent_id in items:
474
if parent_id not in by_parent:
475
by_parent[parent_id] = set()
476
by_parent[parent_id].add(trans_id)
479
def path_changed(self, trans_id):
480
"""Return True if a trans_id's path has changed."""
481
return (trans_id in self._new_name) or (trans_id in self._new_parent)
483
def new_contents(self, trans_id):
484
return (trans_id in self._new_contents)
486
def find_conflicts(self):
487
"""Find any violations of inventory or filesystem invariants"""
488
if self.__done is True:
489
raise ReusingTransform()
491
# ensure all children of all existent parents are known
492
# all children of non-existent parents are known, by definition.
493
self._add_tree_children()
494
by_parent = self.by_parent()
495
conflicts.extend(self._unversioned_parents(by_parent))
496
conflicts.extend(self._parent_loops())
497
conflicts.extend(self._duplicate_entries(by_parent))
498
conflicts.extend(self._duplicate_ids())
499
conflicts.extend(self._parent_type_conflicts(by_parent))
500
conflicts.extend(self._improper_versioning())
501
conflicts.extend(self._executability_conflicts())
502
conflicts.extend(self._overwrite_conflicts())
505
def _add_tree_children(self):
506
"""Add all the children of all active parents to the known paths.
508
Active parents are those which gain children, and those which are
509
removed. This is a necessary first step in detecting conflicts.
511
parents = self.by_parent().keys()
512
parents.extend([t for t in self._removed_contents if
513
self.tree_kind(t) == 'directory'])
514
for trans_id in self._removed_id:
515
file_id = self.tree_file_id(trans_id)
516
if self._tree.inventory[file_id].kind == 'directory':
517
parents.append(trans_id)
519
for parent_id in parents:
520
# ensure that all children are registered with the transaction
521
list(self.iter_tree_children(parent_id))
523
def iter_tree_children(self, parent_id):
524
"""Iterate through the entry's tree children, if any"""
526
path = self._tree_id_paths[parent_id]
530
children = os.listdir(self._tree.abspath(path))
532
if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
536
for child in children:
537
childpath = joinpath(path, child)
538
if self._tree.is_control_filename(childpath):
540
yield self.trans_id_tree_path(childpath)
542
def has_named_child(self, by_parent, parent_id, name):
544
children = by_parent[parent_id]
547
for child in children:
548
if self.final_name(child) == name:
551
path = self._tree_id_paths[parent_id]
554
childpath = joinpath(path, name)
555
child_id = self._tree_path_ids.get(childpath)
557
return lexists(self._tree.abspath(childpath))
559
if self.final_parent(child_id) != parent_id:
561
if child_id in self._removed_contents:
562
# XXX What about dangling file-ids?
567
def _parent_loops(self):
568
"""No entry should be its own ancestor"""
570
for trans_id in self._new_parent:
573
while parent_id is not ROOT_PARENT:
576
parent_id = self.final_parent(parent_id)
579
if parent_id == trans_id:
580
conflicts.append(('parent loop', trans_id))
581
if parent_id in seen:
585
def _unversioned_parents(self, by_parent):
586
"""If parent directories are versioned, children must be versioned."""
588
for parent_id, children in by_parent.iteritems():
589
if parent_id is ROOT_PARENT:
591
if self.final_file_id(parent_id) is not None:
593
for child_id in children:
594
if self.final_file_id(child_id) is not None:
595
conflicts.append(('unversioned parent', parent_id))
599
def _improper_versioning(self):
600
"""Cannot version a file with no contents, or a bad type.
602
However, existing entries with no contents are okay.
605
for trans_id in self._new_id.iterkeys():
607
kind = self.final_kind(trans_id)
609
conflicts.append(('versioning no contents', trans_id))
611
if not InventoryEntry.versionable_kind(kind):
612
conflicts.append(('versioning bad kind', trans_id, kind))
615
def _executability_conflicts(self):
616
"""Check for bad executability changes.
618
Only versioned files may have their executability set, because
619
1. only versioned entries can have executability under windows
620
2. only files can be executable. (The execute bit on a directory
621
does not indicate searchability)
624
for trans_id in self._new_executability:
625
if self.final_file_id(trans_id) is None:
626
conflicts.append(('unversioned executability', trans_id))
629
non_file = self.final_kind(trans_id) != "file"
633
conflicts.append(('non-file executability', trans_id))
636
def _overwrite_conflicts(self):
637
"""Check for overwrites (not permitted on Win32)"""
639
for trans_id in self._new_contents:
641
self.tree_kind(trans_id)
644
if trans_id not in self._removed_contents:
645
conflicts.append(('overwrite', trans_id,
646
self.final_name(trans_id)))
649
def _duplicate_entries(self, by_parent):
650
"""No directory may have two entries with the same name."""
652
for children in by_parent.itervalues():
653
name_ids = [(self.final_name(t), t) for t in children]
657
for name, trans_id in name_ids:
659
kind = self.final_kind(trans_id)
662
file_id = self.final_file_id(trans_id)
663
if kind is None and file_id is None:
665
if name == last_name:
666
conflicts.append(('duplicate', last_trans_id, trans_id,
669
last_trans_id = trans_id
672
def _duplicate_ids(self):
673
"""Each inventory id may only be used once"""
675
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
677
active_tree_ids = set((f for f in self._tree.inventory if
678
f not in removed_tree_ids))
679
for trans_id, file_id in self._new_id.iteritems():
680
if file_id in active_tree_ids:
681
old_trans_id = self.trans_id_tree_file_id(file_id)
682
conflicts.append(('duplicate id', old_trans_id, trans_id))
685
def _parent_type_conflicts(self, by_parent):
686
"""parents must have directory 'contents'."""
688
for parent_id, children in by_parent.iteritems():
689
if parent_id is ROOT_PARENT:
691
if not self._any_contents(children):
693
for child in children:
695
self.final_kind(child)
699
kind = self.final_kind(parent_id)
703
conflicts.append(('missing parent', parent_id))
704
elif kind != "directory":
705
conflicts.append(('non-directory parent', parent_id))
708
def _any_contents(self, trans_ids):
709
"""Return true if any of the trans_ids, will have contents."""
710
for trans_id in trans_ids:
712
kind = self.final_kind(trans_id)
719
"""Apply all changes to the inventory and filesystem.
721
If filesystem or inventory conflicts are present, MalformedTransform
724
conflicts = self.find_conflicts()
725
if len(conflicts) != 0:
726
raise MalformedTransform(conflicts=conflicts)
728
inv = self._tree.inventory
729
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
731
child_pb.update('Apply phase', 0, 2)
732
self._apply_removals(inv, limbo_inv)
733
child_pb.update('Apply phase', 1, 2)
734
modified_paths = self._apply_insertions(inv, limbo_inv)
737
self._tree._write_inventory(inv)
740
return _TransformResults(modified_paths)
742
def _limbo_name(self, trans_id):
743
"""Generate the limbo name of a file"""
744
return pathjoin(self._limbodir, trans_id)
746
def _apply_removals(self, inv, limbo_inv):
747
"""Perform tree operations that remove directory/inventory names.
749
That is, delete files that are to be deleted, and put any files that
750
need renaming into limbo. This must be done in strict child-to-parent
753
tree_paths = list(self._tree_path_ids.iteritems())
754
tree_paths.sort(reverse=True)
755
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
757
for num, data in enumerate(tree_paths):
758
path, trans_id = data
759
child_pb.update('removing file', num, len(tree_paths))
760
full_path = self._tree.abspath(path)
761
if trans_id in self._removed_contents:
762
delete_any(full_path)
763
elif trans_id in self._new_name or trans_id in \
766
os.rename(full_path, self._limbo_name(trans_id))
768
if e.errno != errno.ENOENT:
770
if trans_id in self._removed_id:
771
if trans_id == self._new_root:
772
file_id = self._tree.inventory.root.file_id
774
file_id = self.tree_file_id(trans_id)
776
elif trans_id in self._new_name or trans_id in self._new_parent:
777
file_id = self.tree_file_id(trans_id)
778
if file_id is not None:
779
limbo_inv[trans_id] = inv[file_id]
784
def _apply_insertions(self, inv, limbo_inv):
785
"""Perform tree operations that insert directory/inventory names.
787
That is, create any files that need to be created, and restore from
788
limbo any files that needed renaming. This must be done in strict
789
parent-to-child order.
791
new_paths = self.new_paths()
793
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
795
for num, (path, trans_id) in enumerate(new_paths):
796
child_pb.update('adding file', num, len(new_paths))
798
kind = self._new_contents[trans_id]
800
kind = contents = None
801
if trans_id in self._new_contents or \
802
self.path_changed(trans_id):
803
full_path = self._tree.abspath(path)
805
os.rename(self._limbo_name(trans_id), full_path)
807
# We may be renaming a dangling inventory id
808
if e.errno != errno.ENOENT:
810
if trans_id in self._new_contents:
811
modified_paths.append(full_path)
812
del self._new_contents[trans_id]
814
if trans_id in self._new_id:
816
kind = file_kind(self._tree.abspath(path))
817
inv.add_path(path, kind, self._new_id[trans_id])
818
elif trans_id in self._new_name or trans_id in\
820
entry = limbo_inv.get(trans_id)
821
if entry is not None:
822
entry.name = self.final_name(trans_id)
823
parent_path = os.path.dirname(path)
825
self._tree.inventory.path2id(parent_path)
828
# requires files and inventory entries to be in place
829
if trans_id in self._new_executability:
830
self._set_executability(path, inv, trans_id)
833
return modified_paths
835
def _set_executability(self, path, inv, trans_id):
836
"""Set the executability of versioned files """
837
file_id = inv.path2id(path)
838
new_executability = self._new_executability[trans_id]
839
inv[file_id].executable = new_executability
840
if supports_executable():
841
abspath = self._tree.abspath(path)
842
current_mode = os.stat(abspath).st_mode
843
if new_executability:
846
to_mode = current_mode | (0100 & ~umask)
847
# Enable x-bit for others only if they can read it.
848
if current_mode & 0004:
849
to_mode |= 0001 & ~umask
850
if current_mode & 0040:
851
to_mode |= 0010 & ~umask
853
to_mode = current_mode & ~0111
854
os.chmod(abspath, to_mode)
856
def _new_entry(self, name, parent_id, file_id):
857
"""Helper function to create a new filesystem entry."""
858
trans_id = self.create_path(name, parent_id)
859
if file_id is not None:
860
self.version_file(file_id, trans_id)
863
def new_file(self, name, parent_id, contents, file_id=None,
865
"""Convenience method to create files.
867
name is the name of the file to create.
868
parent_id is the transaction id of the parent directory of the file.
869
contents is an iterator of bytestrings, which will be used to produce
871
:param file_id: The inventory ID of the file, if it is to be versioned.
872
:param executable: Only valid when a file_id has been supplied.
874
trans_id = self._new_entry(name, parent_id, file_id)
875
# TODO: rather than scheduling a set_executable call,
876
# have create_file create the file with the right mode.
877
self.create_file(contents, trans_id)
878
if executable is not None:
879
self.set_executability(executable, trans_id)
882
def new_directory(self, name, parent_id, file_id=None):
883
"""Convenience method to create directories.
885
name is the name of the directory to create.
886
parent_id is the transaction id of the parent directory of the
888
file_id is the inventory ID of the directory, if it is to be versioned.
890
trans_id = self._new_entry(name, parent_id, file_id)
891
self.create_directory(trans_id)
894
def new_symlink(self, name, parent_id, target, file_id=None):
895
"""Convenience method to create symbolic link.
897
name is the name of the symlink to create.
898
parent_id is the transaction id of the parent directory of the symlink.
899
target is a bytestring of the target of the symlink.
900
file_id is the inventory ID of the file, if it is to be versioned.
902
trans_id = self._new_entry(name, parent_id, file_id)
903
self.create_symlink(target, trans_id)
906
def joinpath(parent, child):
907
"""Join tree-relative paths, handling the tree root specially"""
908
if parent is None or parent == "":
911
return pathjoin(parent, child)
914
class FinalPaths(object):
915
"""Make path calculation cheap by memoizing paths.
917
The underlying tree must not be manipulated between calls, or else
918
the results will likely be incorrect.
920
def __init__(self, transform):
921
object.__init__(self)
922
self._known_paths = {}
923
self.transform = transform
925
def _determine_path(self, trans_id):
926
if trans_id == self.transform.root:
928
name = self.transform.final_name(trans_id)
929
parent_id = self.transform.final_parent(trans_id)
930
if parent_id == self.transform.root:
933
return pathjoin(self.get_path(parent_id), name)
935
def get_path(self, trans_id):
936
"""Find the final path associated with a trans_id"""
937
if trans_id not in self._known_paths:
938
self._known_paths[trans_id] = self._determine_path(trans_id)
939
return self._known_paths[trans_id]
941
def topology_sorted_ids(tree):
942
"""Determine the topological order of the ids in a tree"""
943
file_ids = list(tree)
944
file_ids.sort(key=tree.id2path)
948
def build_tree(tree, wt):
949
"""Create working tree for a branch, using a TreeTransform.
951
This function should be used on empty trees, having a tree root at most.
952
(see merge and revert functionality for working with existing trees)
954
Existing files are handled like so:
956
- Existing bzrdirs take precedence over creating new items. They are
957
created as '%s.diverted' % name.
958
- Otherwise, if the content on disk matches the content we are building,
959
it is silently replaced.
960
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
962
if len(wt.inventory) > 1: # more than just a root
963
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
965
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
966
pp = ProgressPhase("Build phase", 2, top_pb)
967
if tree.inventory.root is not None:
968
wt.set_root_id(tree.inventory.root.file_id)
969
tt = TreeTransform(wt)
973
file_trans_id[wt.get_root_id()] = \
974
tt.trans_id_tree_file_id(wt.get_root_id())
975
pb = bzrlib.ui.ui_factory.nested_progress_bar()
977
for num, (tree_path, entry) in \
978
enumerate(tree.inventory.iter_entries_by_dir()):
979
pb.update("Building tree", num, len(tree.inventory))
980
if entry.parent_id is None:
983
file_id = entry.file_id
984
target_path = wt.abspath(tree_path)
986
kind = file_kind(target_path)
990
if kind == "directory":
992
bzrdir.BzrDir.open(target_path)
993
except errors.NotBranchError:
997
if (file_id not in divert and
998
_content_match(tree, entry, file_id, kind,
1000
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1001
if kind == 'directory':
1003
if entry.parent_id not in file_trans_id:
1004
raise repr(entry.parent_id)
1005
parent_id = file_trans_id[entry.parent_id]
1006
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1009
new_trans_id = file_trans_id[file_id]
1010
old_parent = tt.trans_id_tree_path(tree_path)
1011
_reparent_children(tt, old_parent, new_trans_id)
1015
divert_trans = set(file_trans_id[f] for f in divert)
1016
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1017
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1018
conflicts = cook_conflicts(raw_conflicts, tt)
1019
for conflict in conflicts:
1022
wt.add_conflicts(conflicts)
1023
except errors.UnsupportedOperation:
1031
def _reparent_children(tt, old_parent, new_parent):
1032
for child in tt.iter_tree_children(old_parent):
1033
tt.adjust_path(tt.final_name(child), new_parent, child)
1036
def _content_match(tree, entry, file_id, kind, target_path):
1037
if entry.kind != kind:
1039
if entry.kind == "directory":
1041
if entry.kind == "file":
1042
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1044
elif entry.kind == "symlink":
1045
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1050
def resolve_checkout(tt, conflicts, divert):
1051
new_conflicts = set()
1052
for c_type, conflict in ((c[0], c) for c in conflicts):
1053
# Anything but a 'duplicate' would indicate programmer error
1054
assert c_type == 'duplicate', c_type
1055
# Now figure out which is new and which is old
1056
if tt.new_contents(conflict[1]):
1057
new_file = conflict[1]
1058
old_file = conflict[2]
1060
new_file = conflict[2]
1061
old_file = conflict[1]
1063
# We should only get here if the conflict wasn't completely
1065
final_parent = tt.final_parent(old_file)
1066
if new_file in divert:
1067
new_name = tt.final_name(old_file)+'.diverted'
1068
tt.adjust_path(new_name, final_parent, new_file)
1069
new_conflicts.add((c_type, 'Diverted to',
1070
new_file, old_file))
1072
new_name = tt.final_name(old_file)+'.moved'
1073
tt.adjust_path(new_name, final_parent, old_file)
1074
new_conflicts.add((c_type, 'Moved existing file to',
1075
old_file, new_file))
1076
return new_conflicts
1079
def new_by_entry(tt, entry, parent_id, tree):
1080
"""Create a new file according to its inventory entry"""
1084
contents = tree.get_file(entry.file_id).readlines()
1085
executable = tree.is_executable(entry.file_id)
1086
return tt.new_file(name, parent_id, contents, entry.file_id,
1088
elif kind == 'directory':
1089
return tt.new_directory(name, parent_id, entry.file_id)
1090
elif kind == 'symlink':
1091
target = tree.get_symlink_target(entry.file_id)
1092
return tt.new_symlink(name, parent_id, target, entry.file_id)
1094
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1095
"""Create new file contents according to an inventory entry."""
1096
if entry.kind == "file":
1098
lines = tree.get_file(entry.file_id).readlines()
1099
tt.create_file(lines, trans_id, mode_id=mode_id)
1100
elif entry.kind == "symlink":
1101
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1102
elif entry.kind == "directory":
1103
tt.create_directory(trans_id)
1105
def create_entry_executability(tt, entry, trans_id):
1106
"""Set the executability of a trans_id according to an inventory entry"""
1107
if entry.kind == "file":
1108
tt.set_executability(entry.executable, trans_id)
1111
def find_interesting(working_tree, target_tree, filenames):
1112
"""Find the ids corresponding to specified filenames."""
1113
trees = (working_tree, target_tree)
1114
return tree.find_ids_across_trees(filenames, trees)
1117
def change_entry(tt, file_id, working_tree, target_tree,
1118
trans_id_file_id, backups, trans_id, by_parent):
1119
"""Replace a file_id's contents with those from a target tree."""
1120
e_trans_id = trans_id_file_id(file_id)
1121
entry = target_tree.inventory[file_id]
1122
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1125
mode_id = e_trans_id
1128
tt.delete_contents(e_trans_id)
1130
parent_trans_id = trans_id_file_id(entry.parent_id)
1131
backup_name = get_backup_name(entry, by_parent,
1132
parent_trans_id, tt)
1133
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1134
tt.unversion_file(e_trans_id)
1135
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1136
tt.version_file(file_id, e_trans_id)
1137
trans_id[file_id] = e_trans_id
1138
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1139
create_entry_executability(tt, entry, e_trans_id)
1142
tt.set_executability(entry.executable, e_trans_id)
1143
if tt.final_name(e_trans_id) != entry.name:
1146
parent_id = tt.final_parent(e_trans_id)
1147
parent_file_id = tt.final_file_id(parent_id)
1148
if parent_file_id != entry.parent_id:
1153
parent_trans_id = trans_id_file_id(entry.parent_id)
1154
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1157
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1158
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1161
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1162
"""Produce a backup-style name that appears to be available"""
1166
yield "%s.~%d~" % (name, counter)
1168
for new_name in name_gen():
1169
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1173
def _entry_changes(file_id, entry, working_tree):
1174
"""Determine in which ways the inventory entry has changed.
1176
Returns booleans: has_contents, content_mod, meta_mod
1177
has_contents means there are currently contents, but they differ
1178
contents_mod means contents need to be modified
1179
meta_mod means the metadata needs to be modified
1181
cur_entry = working_tree.inventory[file_id]
1183
working_kind = working_tree.kind(file_id)
1186
has_contents = False
1189
if has_contents is True:
1190
if entry.kind != working_kind:
1191
contents_mod, meta_mod = True, False
1193
cur_entry._read_tree_state(working_tree.id2path(file_id),
1195
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1196
cur_entry._forget_tree_state()
1197
return has_contents, contents_mod, meta_mod
1200
def revert(working_tree, target_tree, filenames, backups=False,
1201
pb=DummyProgress(), change_reporter=None):
1202
"""Revert a working tree's contents to those of a target tree."""
1203
interesting_ids = find_interesting(working_tree, target_tree, filenames)
1204
tt = TreeTransform(working_tree, pb)
1206
pp = ProgressPhase("Revert phase", 3, pb)
1208
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1210
_alter_files(working_tree, target_tree, tt, child_pb,
1211
interesting_ids, backups, change_reporter)
1215
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1217
raw_conflicts = resolve_conflicts(tt, child_pb)
1220
conflicts = cook_conflicts(raw_conflicts, tt)
1221
for conflict in conflicts:
1225
working_tree.set_merge_modified({})
1232
def _alter_files(working_tree, target_tree, tt, pb, interesting_ids, backups,
1234
from bzrlib import delta
1235
merge_modified = working_tree.merge_modified()
1236
change_list = list(target_tree._iter_changes(working_tree,
1237
specific_file_ids=interesting_ids, pb=pb))
1238
if target_tree.inventory.root is None:
1244
change_reporter = delta.ChangeReporter(working_tree.inventory)
1245
delta.report_changes(change_list, change_reporter)
1246
for id_num, (file_id, path, changed_content, versioned, parent, name, kind,
1247
executable) in enumerate(change_list):
1248
if skip_root and file_id[0] is not None and parent[0] is None:
1250
trans_id = tt.trans_id_file_id(file_id)
1253
keep_content = False
1254
if kind[0] == 'file' and (backups or kind[1] is None):
1255
wt_sha1 = working_tree.get_file_sha1(file_id)
1256
if merge_modified.get(file_id) != wt_sha1:
1257
if basis_tree is None:
1258
basis_tree = working_tree.basis_tree()
1259
if file_id in basis_tree:
1260
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1262
elif kind[1] is None and not versioned[1]:
1264
if kind[0] is not None:
1265
if not keep_content:
1266
tt.delete_contents(trans_id)
1267
elif kind[1] is not None:
1268
parent_trans_id = tt.trans_id_file_id(parent[0])
1269
by_parent = tt.by_parent()
1270
backup_name = _get_backup_name(name[0], by_parent,
1271
parent_trans_id, tt)
1272
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1273
new_trans_id = tt.create_path(name[0], parent_trans_id)
1274
if versioned == (True, True):
1275
tt.unversion_file(trans_id)
1276
tt.version_file(file_id, new_trans_id)
1277
# New contents should have the same unix perms as old
1280
trans_id = new_trans_id
1281
if kind[1] == 'directory':
1282
tt.create_directory(trans_id)
1283
elif kind[1] == 'symlink':
1284
tt.create_symlink(target_tree.get_symlink_target(file_id),
1286
elif kind[1] == 'file':
1287
tt.create_file(target_tree.get_file_lines(file_id),
1289
# preserve the execute bit when backing up
1290
if keep_content and executable[0] == executable[1]:
1291
tt.set_executability(executable[1], trans_id)
1293
assert kind[1] is None
1294
if versioned == (False, True):
1295
tt.version_file(file_id, trans_id)
1296
if versioned == (True, False):
1297
tt.unversion_file(trans_id)
1298
if (name[1] is not None and
1299
(name[0] != name[1] or parent[0] != parent[1])):
1300
tt.adjust_path(name[1], tt.trans_id_file_id(parent[1]), trans_id)
1301
if executable[0] != executable[1] and kind[1] == "file":
1302
tt.set_executability(executable[1], trans_id)
1305
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1306
"""Make many conflict-resolution attempts, but die if they fail"""
1307
if pass_func is None:
1308
pass_func = conflict_pass
1309
new_conflicts = set()
1312
pb.update('Resolution pass', n+1, 10)
1313
conflicts = tt.find_conflicts()
1314
if len(conflicts) == 0:
1315
return new_conflicts
1316
new_conflicts.update(pass_func(tt, conflicts))
1317
raise MalformedTransform(conflicts=conflicts)
1322
def conflict_pass(tt, conflicts):
1323
"""Resolve some classes of conflicts."""
1324
new_conflicts = set()
1325
for c_type, conflict in ((c[0], c) for c in conflicts):
1326
if c_type == 'duplicate id':
1327
tt.unversion_file(conflict[1])
1328
new_conflicts.add((c_type, 'Unversioned existing file',
1329
conflict[1], conflict[2], ))
1330
elif c_type == 'duplicate':
1331
# files that were renamed take precedence
1332
new_name = tt.final_name(conflict[1])+'.moved'
1333
final_parent = tt.final_parent(conflict[1])
1334
if tt.path_changed(conflict[1]):
1335
tt.adjust_path(new_name, final_parent, conflict[2])
1336
new_conflicts.add((c_type, 'Moved existing file to',
1337
conflict[2], conflict[1]))
1339
tt.adjust_path(new_name, final_parent, conflict[1])
1340
new_conflicts.add((c_type, 'Moved existing file to',
1341
conflict[1], conflict[2]))
1342
elif c_type == 'parent loop':
1343
# break the loop by undoing one of the ops that caused the loop
1345
while not tt.path_changed(cur):
1346
cur = tt.final_parent(cur)
1347
new_conflicts.add((c_type, 'Cancelled move', cur,
1348
tt.final_parent(cur),))
1349
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1351
elif c_type == 'missing parent':
1352
trans_id = conflict[1]
1354
tt.cancel_deletion(trans_id)
1355
new_conflicts.add(('deleting parent', 'Not deleting',
1358
tt.create_directory(trans_id)
1359
new_conflicts.add((c_type, 'Created directory', trans_id))
1360
elif c_type == 'unversioned parent':
1361
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1362
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
1363
return new_conflicts
1366
def cook_conflicts(raw_conflicts, tt):
1367
"""Generate a list of cooked conflicts, sorted by file path"""
1368
from bzrlib.conflicts import Conflict
1369
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1370
return sorted(conflict_iter, key=Conflict.sort_key)
1373
def iter_cook_conflicts(raw_conflicts, tt):
1374
from bzrlib.conflicts import Conflict
1376
for conflict in raw_conflicts:
1377
c_type = conflict[0]
1378
action = conflict[1]
1379
modified_path = fp.get_path(conflict[2])
1380
modified_id = tt.final_file_id(conflict[2])
1381
if len(conflict) == 3:
1382
yield Conflict.factory(c_type, action=action, path=modified_path,
1383
file_id=modified_id)
1386
conflicting_path = fp.get_path(conflict[3])
1387
conflicting_id = tt.final_file_id(conflict[3])
1388
yield Conflict.factory(c_type, action=action, path=modified_path,
1389
file_id=modified_id,
1390
conflict_path=conflicting_path,
1391
conflict_file_id=conflicting_id)
added
removed
bzrlib/transform.py
