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)
33
from bzrlib.inventory import InventoryEntry
34
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
36
from bzrlib.progress import DummyProgress, ProgressPhase
37
from bzrlib.symbol_versioning import deprecated_function, zero_fifteen
38
from bzrlib.trace import mutter, warning
39
from bzrlib import tree
41
import bzrlib.urlutils as urlutils
44
ROOT_PARENT = "root-parent"
47
def unique_add(map, key, value):
49
raise DuplicateKey(key=key)
53
class _TransformResults(object):
54
def __init__(self, modified_paths):
56
self.modified_paths = modified_paths
59
class TreeTransform(object):
60
"""Represent a tree transformation.
62
This object is designed to support incremental generation of the transform,
65
It is easy to produce malformed transforms, but they are generally
66
harmless. Attempting to apply a malformed transform will cause an
67
exception to be raised before any modifications are made to the tree.
69
Many kinds of malformed transforms can be corrected with the
70
resolve_conflicts function. The remaining ones indicate programming error,
71
such as trying to create a file with no path.
73
Two sets of file creation methods are supplied. Convenience methods are:
78
These are composed of the low-level methods:
80
* create_file or create_directory or create_symlink
84
def __init__(self, tree, pb=DummyProgress()):
85
"""Note: a tree_write lock is taken on the tree.
87
Use TreeTransform.finalize() to release the lock
91
self._tree.lock_tree_write()
93
control_files = self._tree._control_files
94
self._limbodir = urlutils.local_path_from_url(
95
control_files.controlfilename('limbo'))
97
os.mkdir(self._limbodir)
99
if e.errno == errno.EEXIST:
100
raise ExistingLimbo(self._limbodir)
107
self._new_parent = {}
108
self._new_contents = {}
109
self._removed_contents = set()
110
self._new_executability = {}
111
self._new_reference_revision = {}
113
self._non_present_ids = {}
115
self._removed_id = set()
116
self._tree_path_ids = {}
117
self._tree_id_paths = {}
119
# Cache of realpath results, to speed up canonical_path
121
# Cache of relpath results, to speed up canonical_path
122
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
126
def __get_root(self):
127
return self._new_root
129
root = property(__get_root)
132
"""Release the working tree lock, if held, clean up limbo dir."""
133
if self._tree is None:
136
for trans_id, kind in self._new_contents.iteritems():
137
path = self._limbo_name(trans_id)
138
if kind == "directory":
143
os.rmdir(self._limbodir)
145
# We don't especially care *why* the dir is immortal.
146
raise ImmortalLimbo(self._limbodir)
151
def _assign_id(self):
152
"""Produce a new tranform id"""
153
new_id = "new-%s" % self._id_number
157
def create_path(self, name, parent):
158
"""Assign a transaction id to a new path"""
159
trans_id = self._assign_id()
160
unique_add(self._new_name, trans_id, name)
161
unique_add(self._new_parent, trans_id, parent)
164
def adjust_path(self, name, parent, trans_id):
165
"""Change the path that is assigned to a transaction id."""
166
if trans_id == self._new_root:
168
self._new_name[trans_id] = name
169
self._new_parent[trans_id] = parent
171
def adjust_root_path(self, name, parent):
172
"""Emulate moving the root by moving all children, instead.
174
We do this by undoing the association of root's transaction id with the
175
current tree. This allows us to create a new directory with that
176
transaction id. We unversion the root directory and version the
177
physically new directory, and hope someone versions the tree root
180
old_root = self._new_root
181
old_root_file_id = self.final_file_id(old_root)
182
# force moving all children of root
183
for child_id in self.iter_tree_children(old_root):
184
if child_id != parent:
185
self.adjust_path(self.final_name(child_id),
186
self.final_parent(child_id), child_id)
187
file_id = self.final_file_id(child_id)
188
if file_id is not None:
189
self.unversion_file(child_id)
190
self.version_file(file_id, child_id)
192
# the physical root needs a new transaction id
193
self._tree_path_ids.pop("")
194
self._tree_id_paths.pop(old_root)
195
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
196
if parent == old_root:
197
parent = self._new_root
198
self.adjust_path(name, parent, old_root)
199
self.create_directory(old_root)
200
self.version_file(old_root_file_id, old_root)
201
self.unversion_file(self._new_root)
203
def trans_id_tree_file_id(self, inventory_id):
204
"""Determine the transaction id of a working tree file.
206
This reflects only files that already exist, not ones that will be
207
added by transactions.
209
path = self._tree.inventory.id2path(inventory_id)
210
return self.trans_id_tree_path(path)
212
def trans_id_file_id(self, file_id):
213
"""Determine or set the transaction id associated with a file ID.
214
A new id is only created for file_ids that were never present. If
215
a transaction has been unversioned, it is deliberately still returned.
216
(this will likely lead to an unversioned parent conflict.)
218
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
219
return self._r_new_id[file_id]
220
elif file_id in self._tree.inventory:
221
return self.trans_id_tree_file_id(file_id)
222
elif file_id in self._non_present_ids:
223
return self._non_present_ids[file_id]
225
trans_id = self._assign_id()
226
self._non_present_ids[file_id] = trans_id
229
def canonical_path(self, path):
230
"""Get the canonical tree-relative path"""
231
# don't follow final symlinks
232
abs = self._tree.abspath(path)
233
if abs in self._relpaths:
234
return self._relpaths[abs]
235
dirname, basename = os.path.split(abs)
236
if dirname not in self._realpaths:
237
self._realpaths[dirname] = os.path.realpath(dirname)
238
dirname = self._realpaths[dirname]
239
abs = pathjoin(dirname, basename)
240
if dirname in self._relpaths:
241
relpath = pathjoin(self._relpaths[dirname], basename)
242
relpath = relpath.rstrip('/\\')
244
relpath = self._tree.relpath(abs)
245
self._relpaths[abs] = relpath
248
def trans_id_tree_path(self, path):
249
"""Determine (and maybe set) the transaction ID for a tree path."""
250
path = self.canonical_path(path)
251
if path not in self._tree_path_ids:
252
self._tree_path_ids[path] = self._assign_id()
253
self._tree_id_paths[self._tree_path_ids[path]] = path
254
return self._tree_path_ids[path]
256
def get_tree_parent(self, trans_id):
257
"""Determine id of the parent in the tree."""
258
path = self._tree_id_paths[trans_id]
261
return self.trans_id_tree_path(os.path.dirname(path))
263
def create_file(self, contents, trans_id, mode_id=None):
264
"""Schedule creation of a new file.
268
Contents is an iterator of strings, all of which will be written
269
to the target destination.
271
New file takes the permissions of any existing file with that id,
272
unless mode_id is specified.
274
name = self._limbo_name(trans_id)
278
unique_add(self._new_contents, trans_id, 'file')
280
# Clean up the file, it never got registered so
281
# TreeTransform.finalize() won't clean it up.
286
f.writelines(contents)
289
self._set_mode(trans_id, mode_id, S_ISREG)
291
def _set_mode(self, trans_id, mode_id, typefunc):
292
"""Set the mode of new file contents.
293
The mode_id is the existing file to get the mode from (often the same
294
as trans_id). The operation is only performed if there's a mode match
295
according to typefunc.
300
old_path = self._tree_id_paths[mode_id]
304
mode = os.stat(self._tree.abspath(old_path)).st_mode
306
if e.errno == errno.ENOENT:
311
os.chmod(self._limbo_name(trans_id), mode)
313
def create_directory(self, trans_id):
314
"""Schedule creation of a new directory.
316
See also new_directory.
318
os.mkdir(self._limbo_name(trans_id))
319
unique_add(self._new_contents, trans_id, 'directory')
321
def create_symlink(self, target, trans_id):
322
"""Schedule creation of a new symbolic link.
324
target is a bytestring.
325
See also new_symlink.
327
os.symlink(target, self._limbo_name(trans_id))
328
unique_add(self._new_contents, trans_id, 'symlink')
330
def cancel_creation(self, trans_id):
331
"""Cancel the creation of new file contents."""
332
del self._new_contents[trans_id]
333
delete_any(self._limbo_name(trans_id))
335
def delete_contents(self, trans_id):
336
"""Schedule the contents of a path entry for deletion"""
337
self.tree_kind(trans_id)
338
self._removed_contents.add(trans_id)
340
def cancel_deletion(self, trans_id):
341
"""Cancel a scheduled deletion"""
342
self._removed_contents.remove(trans_id)
344
def unversion_file(self, trans_id):
345
"""Schedule a path entry to become unversioned"""
346
self._removed_id.add(trans_id)
348
def delete_versioned(self, trans_id):
349
"""Delete and unversion a versioned file"""
350
self.delete_contents(trans_id)
351
self.unversion_file(trans_id)
353
def set_executability(self, executability, trans_id):
354
"""Schedule setting of the 'execute' bit
355
To unschedule, set to None
357
if executability is None:
358
del self._new_executability[trans_id]
360
unique_add(self._new_executability, trans_id, executability)
362
def set_tree_reference(self, revision_id, trans_id):
363
"""Set the reference associated with a directory"""
364
unique_add(self._new_reference_revision, trans_id, revision_id)
366
def version_file(self, file_id, trans_id):
367
"""Schedule a file to become versioned."""
368
assert file_id is not None
369
unique_add(self._new_id, trans_id, file_id)
370
unique_add(self._r_new_id, file_id, trans_id)
372
def cancel_versioning(self, trans_id):
373
"""Undo a previous versioning of a file"""
374
file_id = self._new_id[trans_id]
375
del self._new_id[trans_id]
376
del self._r_new_id[file_id]
379
"""Determine the paths of all new and changed files"""
381
fp = FinalPaths(self)
382
for id_set in (self._new_name, self._new_parent, self._new_contents,
383
self._new_id, self._new_executability):
384
new_ids.update(id_set)
385
new_paths = [(fp.get_path(t), t) for t in new_ids]
389
def tree_kind(self, trans_id):
390
"""Determine the file kind in the working tree.
392
Raises NoSuchFile if the file does not exist
394
path = self._tree_id_paths.get(trans_id)
396
raise NoSuchFile(None)
398
return file_kind(self._tree.abspath(path))
400
if e.errno != errno.ENOENT:
403
raise NoSuchFile(path)
405
def final_kind(self, trans_id):
406
"""Determine the final file kind, after any changes applied.
408
Raises NoSuchFile if the file does not exist/has no contents.
409
(It is conceivable that a path would be created without the
410
corresponding contents insertion command)
412
if trans_id in self._new_contents:
413
return self._new_contents[trans_id]
414
elif trans_id in self._removed_contents:
415
raise NoSuchFile(None)
417
return self.tree_kind(trans_id)
419
def tree_file_id(self, trans_id):
420
"""Determine the file id associated with the trans_id in the tree"""
422
path = self._tree_id_paths[trans_id]
424
# the file is a new, unversioned file, or invalid trans_id
426
# the file is old; the old id is still valid
427
if self._new_root == trans_id:
428
return self._tree.inventory.root.file_id
429
return self._tree.inventory.path2id(path)
431
def final_file_id(self, trans_id):
432
"""Determine the file id after any changes are applied, or None.
434
None indicates that the file will not be versioned after changes are
438
# there is a new id for this file
439
assert self._new_id[trans_id] is not None
440
return self._new_id[trans_id]
442
if trans_id in self._removed_id:
444
return self.tree_file_id(trans_id)
446
def inactive_file_id(self, trans_id):
447
"""Return the inactive file_id associated with a transaction id.
448
That is, the one in the tree or in non_present_ids.
449
The file_id may actually be active, too.
451
file_id = self.tree_file_id(trans_id)
452
if file_id is not None:
454
for key, value in self._non_present_ids.iteritems():
455
if value == trans_id:
458
def final_parent(self, trans_id):
459
"""Determine the parent file_id, after any changes are applied.
461
ROOT_PARENT is returned for the tree root.
464
return self._new_parent[trans_id]
466
return self.get_tree_parent(trans_id)
468
def final_name(self, trans_id):
469
"""Determine the final filename, after all changes are applied."""
471
return self._new_name[trans_id]
474
return os.path.basename(self._tree_id_paths[trans_id])
476
raise NoFinalPath(trans_id, self)
479
"""Return a map of parent: children for known parents.
481
Only new paths and parents of tree files with assigned ids are used.
484
items = list(self._new_parent.iteritems())
485
items.extend((t, self.final_parent(t)) for t in
486
self._tree_id_paths.keys())
487
for trans_id, parent_id in items:
488
if parent_id not in by_parent:
489
by_parent[parent_id] = set()
490
by_parent[parent_id].add(trans_id)
493
def path_changed(self, trans_id):
494
"""Return True if a trans_id's path has changed."""
495
return (trans_id in self._new_name) or (trans_id in self._new_parent)
497
def new_contents(self, trans_id):
498
return (trans_id in self._new_contents)
500
def find_conflicts(self):
501
"""Find any violations of inventory or filesystem invariants"""
502
if self.__done is True:
503
raise ReusingTransform()
505
# ensure all children of all existent parents are known
506
# all children of non-existent parents are known, by definition.
507
self._add_tree_children()
508
by_parent = self.by_parent()
509
conflicts.extend(self._unversioned_parents(by_parent))
510
conflicts.extend(self._parent_loops())
511
conflicts.extend(self._duplicate_entries(by_parent))
512
conflicts.extend(self._duplicate_ids())
513
conflicts.extend(self._parent_type_conflicts(by_parent))
514
conflicts.extend(self._improper_versioning())
515
conflicts.extend(self._executability_conflicts())
516
conflicts.extend(self._overwrite_conflicts())
519
def _add_tree_children(self):
520
"""Add all the children of all active parents to the known paths.
522
Active parents are those which gain children, and those which are
523
removed. This is a necessary first step in detecting conflicts.
525
parents = self.by_parent().keys()
526
parents.extend([t for t in self._removed_contents if
527
self.tree_kind(t) == 'directory'])
528
for trans_id in self._removed_id:
529
file_id = self.tree_file_id(trans_id)
530
if self._tree.inventory[file_id].kind == 'directory':
531
parents.append(trans_id)
533
for parent_id in parents:
534
# ensure that all children are registered with the transaction
535
list(self.iter_tree_children(parent_id))
537
def iter_tree_children(self, parent_id):
538
"""Iterate through the entry's tree children, if any"""
540
path = self._tree_id_paths[parent_id]
544
children = os.listdir(self._tree.abspath(path))
546
if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
550
for child in children:
551
childpath = joinpath(path, child)
552
if self._tree.is_control_filename(childpath):
554
yield self.trans_id_tree_path(childpath)
556
def has_named_child(self, by_parent, parent_id, name):
558
children = by_parent[parent_id]
561
for child in children:
562
if self.final_name(child) == name:
565
path = self._tree_id_paths[parent_id]
568
childpath = joinpath(path, name)
569
child_id = self._tree_path_ids.get(childpath)
571
return lexists(self._tree.abspath(childpath))
573
if self.final_parent(child_id) != parent_id:
575
if child_id in self._removed_contents:
576
# XXX What about dangling file-ids?
581
def _parent_loops(self):
582
"""No entry should be its own ancestor"""
584
for trans_id in self._new_parent:
587
while parent_id is not ROOT_PARENT:
590
parent_id = self.final_parent(parent_id)
593
if parent_id == trans_id:
594
conflicts.append(('parent loop', trans_id))
595
if parent_id in seen:
599
def _unversioned_parents(self, by_parent):
600
"""If parent directories are versioned, children must be versioned."""
602
for parent_id, children in by_parent.iteritems():
603
if parent_id is ROOT_PARENT:
605
if self.final_file_id(parent_id) is not None:
607
for child_id in children:
608
if self.final_file_id(child_id) is not None:
609
conflicts.append(('unversioned parent', parent_id))
613
def _improper_versioning(self):
614
"""Cannot version a file with no contents, or a bad type.
616
However, existing entries with no contents are okay.
619
for trans_id in self._new_id.iterkeys():
621
kind = self.final_kind(trans_id)
623
conflicts.append(('versioning no contents', trans_id))
625
if not InventoryEntry.versionable_kind(kind):
626
conflicts.append(('versioning bad kind', trans_id, kind))
629
def _executability_conflicts(self):
630
"""Check for bad executability changes.
632
Only versioned files may have their executability set, because
633
1. only versioned entries can have executability under windows
634
2. only files can be executable. (The execute bit on a directory
635
does not indicate searchability)
638
for trans_id in self._new_executability:
639
if self.final_file_id(trans_id) is None:
640
conflicts.append(('unversioned executability', trans_id))
643
non_file = self.final_kind(trans_id) != "file"
647
conflicts.append(('non-file executability', trans_id))
650
def _overwrite_conflicts(self):
651
"""Check for overwrites (not permitted on Win32)"""
653
for trans_id in self._new_contents:
655
self.tree_kind(trans_id)
658
if trans_id not in self._removed_contents:
659
conflicts.append(('overwrite', trans_id,
660
self.final_name(trans_id)))
663
def _duplicate_entries(self, by_parent):
664
"""No directory may have two entries with the same name."""
666
for children in by_parent.itervalues():
667
name_ids = [(self.final_name(t), t) for t in children]
671
for name, trans_id in name_ids:
673
kind = self.final_kind(trans_id)
676
file_id = self.final_file_id(trans_id)
677
if kind is None and file_id is None:
679
if name == last_name:
680
conflicts.append(('duplicate', last_trans_id, trans_id,
683
last_trans_id = trans_id
686
def _duplicate_ids(self):
687
"""Each inventory id may only be used once"""
689
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
691
active_tree_ids = set((f for f in self._tree.inventory if
692
f not in removed_tree_ids))
693
for trans_id, file_id in self._new_id.iteritems():
694
if file_id in active_tree_ids:
695
old_trans_id = self.trans_id_tree_file_id(file_id)
696
conflicts.append(('duplicate id', old_trans_id, trans_id))
699
def _parent_type_conflicts(self, by_parent):
700
"""parents must have directory 'contents'."""
702
for parent_id, children in by_parent.iteritems():
703
if parent_id is ROOT_PARENT:
705
if not self._any_contents(children):
707
for child in children:
709
self.final_kind(child)
713
kind = self.final_kind(parent_id)
717
conflicts.append(('missing parent', parent_id))
718
elif kind != "directory":
719
conflicts.append(('non-directory parent', parent_id))
722
def _any_contents(self, trans_ids):
723
"""Return true if any of the trans_ids, will have contents."""
724
for trans_id in trans_ids:
726
kind = self.final_kind(trans_id)
733
"""Apply all changes to the inventory and filesystem.
735
If filesystem or inventory conflicts are present, MalformedTransform
738
conflicts = self.find_conflicts()
739
if len(conflicts) != 0:
740
raise MalformedTransform(conflicts=conflicts)
742
inv = self._tree.inventory
743
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
745
child_pb.update('Apply phase', 0, 2)
746
self._apply_removals(inv, limbo_inv)
747
child_pb.update('Apply phase', 1, 2)
748
modified_paths = self._apply_insertions(inv, limbo_inv)
751
self._tree._write_inventory(inv)
754
return _TransformResults(modified_paths)
756
def _limbo_name(self, trans_id):
757
"""Generate the limbo name of a file"""
758
return pathjoin(self._limbodir, trans_id)
760
def _apply_removals(self, inv, limbo_inv):
761
"""Perform tree operations that remove directory/inventory names.
763
That is, delete files that are to be deleted, and put any files that
764
need renaming into limbo. This must be done in strict child-to-parent
767
tree_paths = list(self._tree_path_ids.iteritems())
768
tree_paths.sort(reverse=True)
769
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
771
for num, data in enumerate(tree_paths):
772
path, trans_id = data
773
child_pb.update('removing file', num, len(tree_paths))
774
full_path = self._tree.abspath(path)
775
if trans_id in self._removed_contents:
776
delete_any(full_path)
777
elif trans_id in self._new_name or trans_id in \
780
os.rename(full_path, self._limbo_name(trans_id))
782
if e.errno != errno.ENOENT:
784
if trans_id in self._removed_id:
785
if trans_id == self._new_root:
786
file_id = self._tree.inventory.root.file_id
788
file_id = self.tree_file_id(trans_id)
790
elif trans_id in self._new_name or trans_id in self._new_parent:
791
file_id = self.tree_file_id(trans_id)
792
if file_id is not None:
793
limbo_inv[trans_id] = inv[file_id]
794
inv.remove_recursive_id(file_id)
798
def _apply_insertions(self, inv, limbo_inv):
799
"""Perform tree operations that insert directory/inventory names.
801
That is, create any files that need to be created, and restore from
802
limbo any files that needed renaming. This must be done in strict
803
parent-to-child order.
805
new_paths = self.new_paths()
807
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
809
for num, (path, trans_id) in enumerate(new_paths):
810
child_pb.update('adding file', num, len(new_paths))
812
kind = self._new_contents[trans_id]
814
kind = contents = None
815
if trans_id in self._new_contents or \
816
self.path_changed(trans_id):
817
full_path = self._tree.abspath(path)
819
os.rename(self._limbo_name(trans_id), full_path)
821
# We may be renaming a dangling inventory id
822
if e.errno != errno.ENOENT:
824
if trans_id in self._new_contents:
825
modified_paths.append(full_path)
826
del self._new_contents[trans_id]
828
if trans_id in self._new_id:
830
kind = file_kind(self._tree.abspath(path))
831
if trans_id in self._new_reference_revision:
832
entry = inventory.TreeReference(self._new_id[trans_id],
833
self._new_name[trans_id],
834
self.final_file_id(self._new_parent[trans_id]),
835
None, self._new_reference_revision[trans_id])
838
inv.add_path(path, kind, self._new_id[trans_id])
839
elif trans_id in self._new_name or trans_id in\
841
entry = limbo_inv.get(trans_id)
842
if entry is not None:
843
entry.name = self.final_name(trans_id)
844
parent_path = os.path.dirname(path)
846
self._tree.inventory.path2id(parent_path)
849
# requires files and inventory entries to be in place
850
if trans_id in self._new_executability:
851
self._set_executability(path, inv, trans_id)
854
return modified_paths
856
def _set_executability(self, path, inv, trans_id):
857
"""Set the executability of versioned files """
858
file_id = inv.path2id(path)
859
new_executability = self._new_executability[trans_id]
860
inv[file_id].executable = new_executability
861
if supports_executable():
862
abspath = self._tree.abspath(path)
863
current_mode = os.stat(abspath).st_mode
864
if new_executability:
867
to_mode = current_mode | (0100 & ~umask)
868
# Enable x-bit for others only if they can read it.
869
if current_mode & 0004:
870
to_mode |= 0001 & ~umask
871
if current_mode & 0040:
872
to_mode |= 0010 & ~umask
874
to_mode = current_mode & ~0111
875
os.chmod(abspath, to_mode)
877
def _new_entry(self, name, parent_id, file_id):
878
"""Helper function to create a new filesystem entry."""
879
trans_id = self.create_path(name, parent_id)
880
if file_id is not None:
881
self.version_file(file_id, trans_id)
884
def new_file(self, name, parent_id, contents, file_id=None,
886
"""Convenience method to create files.
888
name is the name of the file to create.
889
parent_id is the transaction id of the parent directory of the file.
890
contents is an iterator of bytestrings, which will be used to produce
892
:param file_id: The inventory ID of the file, if it is to be versioned.
893
:param executable: Only valid when a file_id has been supplied.
895
trans_id = self._new_entry(name, parent_id, file_id)
896
# TODO: rather than scheduling a set_executable call,
897
# have create_file create the file with the right mode.
898
self.create_file(contents, trans_id)
899
if executable is not None:
900
self.set_executability(executable, trans_id)
903
def new_directory(self, name, parent_id, file_id=None):
904
"""Convenience method to create directories.
906
name is the name of the directory to create.
907
parent_id is the transaction id of the parent directory of the
909
file_id is the inventory ID of the directory, if it is to be versioned.
911
trans_id = self._new_entry(name, parent_id, file_id)
912
self.create_directory(trans_id)
915
def new_symlink(self, name, parent_id, target, file_id=None):
916
"""Convenience method to create symbolic link.
918
name is the name of the symlink to create.
919
parent_id is the transaction id of the parent directory of the symlink.
920
target is a bytestring of the target of the symlink.
921
file_id is the inventory ID of the file, if it is to be versioned.
923
trans_id = self._new_entry(name, parent_id, file_id)
924
self.create_symlink(target, trans_id)
927
def _affected_ids(self):
928
"""Return the set of transform ids affected by the transform"""
929
trans_ids = set(self._removed_id)
930
trans_ids.update(self._new_id.keys())
931
trans_ids.update(self._removed_contents)
932
trans_ids.update(self._new_contents.keys())
933
trans_ids.update(self._new_executability.keys())
934
trans_ids.update(self._new_name.keys())
935
trans_ids.update(self._new_parent.keys())
938
def _get_file_id_maps(self):
939
"""Return mapping of file_ids to trans_ids in the to and from states"""
940
trans_ids = self._affected_ids()
943
# Build up two dicts: trans_ids associated with file ids in the
944
# FROM state, vs the TO state.
945
for trans_id in trans_ids:
946
from_file_id = self.tree_file_id(trans_id)
947
if from_file_id is not None:
948
from_trans_ids[from_file_id] = trans_id
949
to_file_id = self.final_file_id(trans_id)
950
if to_file_id is not None:
951
to_trans_ids[to_file_id] = trans_id
952
return from_trans_ids, to_trans_ids
954
def _from_file_data(self, from_trans_id, from_versioned, file_id):
955
"""Get data about a file in the from (tree) state
957
Return a (name, parent, kind, executable) tuple
959
from_path = self._tree_id_paths.get(from_trans_id)
961
# get data from working tree if versioned
962
from_entry = self._tree.inventory[file_id]
963
from_name = from_entry.name
964
from_parent = from_entry.parent_id
967
if from_path is None:
968
# File does not exist in FROM state
972
# File exists, but is not versioned. Have to use path-
974
from_name = os.path.basename(from_path)
975
tree_parent = self.get_tree_parent(from_trans_id)
976
from_parent = self.tree_file_id(tree_parent)
977
if from_path is not None:
978
from_kind, from_executable, from_stats = \
979
self._tree._comparison_data(from_entry, from_path)
982
from_executable = False
983
return from_name, from_parent, from_kind, from_executable
985
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
986
"""Get data about a file in the to (target) state
988
Return a (name, parent, kind, executable) tuple
990
to_name = self.final_name(to_trans_id)
992
to_kind = self.final_kind(to_trans_id)
995
to_parent = self.final_file_id(self.final_parent(to_trans_id))
996
if to_trans_id in self._new_executability:
997
to_executable = self._new_executability[to_trans_id]
998
elif to_trans_id == from_trans_id:
999
to_executable = from_executable
1001
to_executable = False
1002
return to_name, to_parent, to_kind, to_executable
1004
def _iter_changes(self):
1005
"""Produce output in the same format as Tree._iter_changes.
1007
Will produce nonsensical results if invoked while inventory/filesystem
1008
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1010
This reads the Transform, but only reproduces changes involving a
1011
file_id. Files that are not versioned in either of the FROM or TO
1012
states are not reflected.
1014
final_paths = FinalPaths(self)
1015
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1017
# Now iterate through all active file_ids
1018
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1020
from_trans_id = from_trans_ids.get(file_id)
1021
# find file ids, and determine versioning state
1022
if from_trans_id is None:
1023
from_versioned = False
1024
from_trans_id = to_trans_ids[file_id]
1026
from_versioned = True
1027
to_trans_id = to_trans_ids.get(file_id)
1028
if to_trans_id is None:
1029
to_versioned = False
1030
to_trans_id = from_trans_id
1034
from_name, from_parent, from_kind, from_executable = \
1035
self._from_file_data(from_trans_id, from_versioned, file_id)
1037
to_name, to_parent, to_kind, to_executable = \
1038
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1040
if not from_versioned:
1043
from_path = self._tree_id_paths.get(from_trans_id)
1044
if not to_versioned:
1047
to_path = final_paths.get_path(to_trans_id)
1048
if from_kind != to_kind:
1050
elif to_kind in ('file', 'symlink') and (
1051
to_trans_id != from_trans_id or
1052
to_trans_id in self._new_contents):
1054
if (not modified and from_versioned == to_versioned and
1055
from_parent==to_parent and from_name == to_name and
1056
from_executable == to_executable):
1058
results.append((file_id, (from_path, to_path), modified,
1059
(from_versioned, to_versioned),
1060
(from_parent, to_parent),
1061
(from_name, to_name),
1062
(from_kind, to_kind),
1063
(from_executable, to_executable)))
1064
return iter(sorted(results, key=lambda x:x[1]))
1067
def joinpath(parent, child):
1068
"""Join tree-relative paths, handling the tree root specially"""
1069
if parent is None or parent == "":
1072
return pathjoin(parent, child)
1075
class FinalPaths(object):
1076
"""Make path calculation cheap by memoizing paths.
1078
The underlying tree must not be manipulated between calls, or else
1079
the results will likely be incorrect.
1081
def __init__(self, transform):
1082
object.__init__(self)
1083
self._known_paths = {}
1084
self.transform = transform
1086
def _determine_path(self, trans_id):
1087
if trans_id == self.transform.root:
1089
name = self.transform.final_name(trans_id)
1090
parent_id = self.transform.final_parent(trans_id)
1091
if parent_id == self.transform.root:
1094
return pathjoin(self.get_path(parent_id), name)
1096
def get_path(self, trans_id):
1097
"""Find the final path associated with a trans_id"""
1098
if trans_id not in self._known_paths:
1099
self._known_paths[trans_id] = self._determine_path(trans_id)
1100
return self._known_paths[trans_id]
1102
def topology_sorted_ids(tree):
1103
"""Determine the topological order of the ids in a tree"""
1104
file_ids = list(tree)
1105
file_ids.sort(key=tree.id2path)
1109
def build_tree(tree, wt):
1110
"""Create working tree for a branch, using a TreeTransform.
1112
This function should be used on empty trees, having a tree root at most.
1113
(see merge and revert functionality for working with existing trees)
1115
Existing files are handled like so:
1117
- Existing bzrdirs take precedence over creating new items. They are
1118
created as '%s.diverted' % name.
1119
- Otherwise, if the content on disk matches the content we are building,
1120
it is silently replaced.
1121
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1123
wt.lock_tree_write()
1127
return _build_tree(tree, wt)
1133
def _build_tree(tree, wt):
1134
"""See build_tree."""
1135
if len(wt.inventory) > 1: # more than just a root
1136
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1138
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1139
pp = ProgressPhase("Build phase", 2, top_pb)
1140
if tree.inventory.root is not None:
1141
# this is kindof a hack: we should be altering the root
1142
# as partof the regular tree shape diff logic.
1143
# the conditional test hereis to avoid doing an
1144
# expensive operation (flush) every time the root id
1145
# is set within the tree, nor setting the root and thus
1146
# marking the tree as dirty, because we use two different
1147
# idioms here: tree interfaces and inventory interfaces.
1148
if wt.path2id('') != tree.inventory.root.file_id:
1149
wt.set_root_id(tree.inventory.root.file_id)
1151
tt = TreeTransform(wt)
1155
file_trans_id[wt.get_root_id()] = \
1156
tt.trans_id_tree_file_id(wt.get_root_id())
1157
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1159
for num, (tree_path, entry) in \
1160
enumerate(tree.inventory.iter_entries_by_dir()):
1161
pb.update("Building tree", num, len(tree.inventory))
1162
if entry.parent_id is None:
1165
file_id = entry.file_id
1166
target_path = wt.abspath(tree_path)
1168
kind = file_kind(target_path)
1172
if kind == "directory":
1174
bzrdir.BzrDir.open(target_path)
1175
except errors.NotBranchError:
1179
if (file_id not in divert and
1180
_content_match(tree, entry, file_id, kind,
1182
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1183
if kind == 'directory':
1185
if entry.parent_id not in file_trans_id:
1186
raise AssertionError(
1187
'entry %s parent id %r is not in file_trans_id %r'
1188
% (entry, entry.parent_id, file_trans_id))
1189
parent_id = file_trans_id[entry.parent_id]
1190
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1193
new_trans_id = file_trans_id[file_id]
1194
old_parent = tt.trans_id_tree_path(tree_path)
1195
_reparent_children(tt, old_parent, new_trans_id)
1199
divert_trans = set(file_trans_id[f] for f in divert)
1200
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1201
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1202
conflicts = cook_conflicts(raw_conflicts, tt)
1203
for conflict in conflicts:
1206
wt.add_conflicts(conflicts)
1207
except errors.UnsupportedOperation:
1215
def _reparent_children(tt, old_parent, new_parent):
1216
for child in tt.iter_tree_children(old_parent):
1217
tt.adjust_path(tt.final_name(child), new_parent, child)
1220
def _content_match(tree, entry, file_id, kind, target_path):
1221
if entry.kind != kind:
1223
if entry.kind == "directory":
1225
if entry.kind == "file":
1226
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1228
elif entry.kind == "symlink":
1229
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1234
def resolve_checkout(tt, conflicts, divert):
1235
new_conflicts = set()
1236
for c_type, conflict in ((c[0], c) for c in conflicts):
1237
# Anything but a 'duplicate' would indicate programmer error
1238
assert c_type == 'duplicate', c_type
1239
# Now figure out which is new and which is old
1240
if tt.new_contents(conflict[1]):
1241
new_file = conflict[1]
1242
old_file = conflict[2]
1244
new_file = conflict[2]
1245
old_file = conflict[1]
1247
# We should only get here if the conflict wasn't completely
1249
final_parent = tt.final_parent(old_file)
1250
if new_file in divert:
1251
new_name = tt.final_name(old_file)+'.diverted'
1252
tt.adjust_path(new_name, final_parent, new_file)
1253
new_conflicts.add((c_type, 'Diverted to',
1254
new_file, old_file))
1256
new_name = tt.final_name(old_file)+'.moved'
1257
tt.adjust_path(new_name, final_parent, old_file)
1258
new_conflicts.add((c_type, 'Moved existing file to',
1259
old_file, new_file))
1260
return new_conflicts
1263
def new_by_entry(tt, entry, parent_id, tree):
1264
"""Create a new file according to its inventory entry"""
1268
contents = tree.get_file(entry.file_id).readlines()
1269
executable = tree.is_executable(entry.file_id)
1270
return tt.new_file(name, parent_id, contents, entry.file_id,
1272
elif kind in ('directory', 'tree-reference'):
1273
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1274
if kind == 'tree-reference':
1275
tt.set_tree_reference(entry.reference_revision, trans_id)
1277
elif kind == 'symlink':
1278
target = tree.get_symlink_target(entry.file_id)
1279
return tt.new_symlink(name, parent_id, target, entry.file_id)
1281
raise errors.BadFileKindError(name, kind)
1283
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1284
"""Create new file contents according to an inventory entry."""
1285
if entry.kind == "file":
1287
lines = tree.get_file(entry.file_id).readlines()
1288
tt.create_file(lines, trans_id, mode_id=mode_id)
1289
elif entry.kind == "symlink":
1290
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1291
elif entry.kind == "directory":
1292
tt.create_directory(trans_id)
1294
def create_entry_executability(tt, entry, trans_id):
1295
"""Set the executability of a trans_id according to an inventory entry"""
1296
if entry.kind == "file":
1297
tt.set_executability(entry.executable, trans_id)
1300
@deprecated_function(zero_fifteen)
1301
def find_interesting(working_tree, target_tree, filenames):
1302
"""Find the ids corresponding to specified filenames.
1304
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1306
working_tree.lock_read()
1308
target_tree.lock_read()
1310
return working_tree.paths2ids(filenames, [target_tree])
1312
target_tree.unlock()
1314
working_tree.unlock()
1317
def change_entry(tt, file_id, working_tree, target_tree,
1318
trans_id_file_id, backups, trans_id, by_parent):
1319
"""Replace a file_id's contents with those from a target tree."""
1320
e_trans_id = trans_id_file_id(file_id)
1321
entry = target_tree.inventory[file_id]
1322
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1325
mode_id = e_trans_id
1328
tt.delete_contents(e_trans_id)
1330
parent_trans_id = trans_id_file_id(entry.parent_id)
1331
backup_name = get_backup_name(entry, by_parent,
1332
parent_trans_id, tt)
1333
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1334
tt.unversion_file(e_trans_id)
1335
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1336
tt.version_file(file_id, e_trans_id)
1337
trans_id[file_id] = e_trans_id
1338
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1339
create_entry_executability(tt, entry, e_trans_id)
1342
tt.set_executability(entry.executable, e_trans_id)
1343
if tt.final_name(e_trans_id) != entry.name:
1346
parent_id = tt.final_parent(e_trans_id)
1347
parent_file_id = tt.final_file_id(parent_id)
1348
if parent_file_id != entry.parent_id:
1353
parent_trans_id = trans_id_file_id(entry.parent_id)
1354
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1357
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1358
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1361
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1362
"""Produce a backup-style name that appears to be available"""
1366
yield "%s.~%d~" % (name, counter)
1368
for new_name in name_gen():
1369
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1373
def _entry_changes(file_id, entry, working_tree):
1374
"""Determine in which ways the inventory entry has changed.
1376
Returns booleans: has_contents, content_mod, meta_mod
1377
has_contents means there are currently contents, but they differ
1378
contents_mod means contents need to be modified
1379
meta_mod means the metadata needs to be modified
1381
cur_entry = working_tree.inventory[file_id]
1383
working_kind = working_tree.kind(file_id)
1386
has_contents = False
1389
if has_contents is True:
1390
if entry.kind != working_kind:
1391
contents_mod, meta_mod = True, False
1393
cur_entry._read_tree_state(working_tree.id2path(file_id),
1395
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1396
cur_entry._forget_tree_state()
1397
return has_contents, contents_mod, meta_mod
1400
def revert(working_tree, target_tree, filenames, backups=False,
1401
pb=DummyProgress(), change_reporter=None):
1402
"""Revert a working tree's contents to those of a target tree."""
1403
target_tree.lock_read()
1404
tt = TreeTransform(working_tree, pb)
1406
pp = ProgressPhase("Revert phase", 3, pb)
1408
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1410
_alter_files(working_tree, target_tree, tt, child_pb,
1415
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1417
raw_conflicts = resolve_conflicts(tt, child_pb)
1420
conflicts = cook_conflicts(raw_conflicts, tt)
1422
change_reporter = delta._ChangeReporter(
1423
unversioned_filter=working_tree.is_ignored)
1424
delta.report_changes(tt._iter_changes(), change_reporter)
1425
for conflict in conflicts:
1429
working_tree.set_merge_modified({})
1431
target_tree.unlock()
1437
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1439
merge_modified = working_tree.merge_modified()
1440
change_list = target_tree._iter_changes(working_tree,
1441
specific_files=specific_files, pb=pb)
1442
if target_tree.inventory.root is None:
1448
for id_num, (file_id, path, changed_content, versioned, parent, name,
1449
kind, executable) in enumerate(change_list):
1450
if skip_root and file_id[0] is not None and parent[0] is None:
1452
trans_id = tt.trans_id_file_id(file_id)
1455
keep_content = False
1456
if kind[0] == 'file' and (backups or kind[1] is None):
1457
wt_sha1 = working_tree.get_file_sha1(file_id)
1458
if merge_modified.get(file_id) != wt_sha1:
1459
# acquire the basis tree lazyily to prevent the expense
1460
# of accessing it when its not needed ? (Guessing, RBC,
1462
if basis_tree is None:
1463
basis_tree = working_tree.basis_tree()
1464
basis_tree.lock_read()
1465
if file_id in basis_tree:
1466
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1468
elif kind[1] is None and not versioned[1]:
1470
if kind[0] is not None:
1471
if not keep_content:
1472
tt.delete_contents(trans_id)
1473
elif kind[1] is not None:
1474
parent_trans_id = tt.trans_id_file_id(parent[0])
1475
by_parent = tt.by_parent()
1476
backup_name = _get_backup_name(name[0], by_parent,
1477
parent_trans_id, tt)
1478
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1479
new_trans_id = tt.create_path(name[0], parent_trans_id)
1480
if versioned == (True, True):
1481
tt.unversion_file(trans_id)
1482
tt.version_file(file_id, new_trans_id)
1483
# New contents should have the same unix perms as old
1486
trans_id = new_trans_id
1487
if kind[1] == 'directory':
1488
tt.create_directory(trans_id)
1489
elif kind[1] == 'symlink':
1490
tt.create_symlink(target_tree.get_symlink_target(file_id),
1492
elif kind[1] == 'file':
1493
tt.create_file(target_tree.get_file_lines(file_id),
1495
# preserve the execute bit when backing up
1496
if keep_content and executable[0] == executable[1]:
1497
tt.set_executability(executable[1], trans_id)
1499
assert kind[1] is None
1500
if versioned == (False, True):
1501
tt.version_file(file_id, trans_id)
1502
if versioned == (True, False):
1503
tt.unversion_file(trans_id)
1504
if (name[1] is not None and
1505
(name[0] != name[1] or parent[0] != parent[1])):
1507
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1508
if executable[0] != executable[1] and kind[1] == "file":
1509
tt.set_executability(executable[1], trans_id)
1511
if basis_tree is not None:
1515
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1516
"""Make many conflict-resolution attempts, but die if they fail"""
1517
if pass_func is None:
1518
pass_func = conflict_pass
1519
new_conflicts = set()
1522
pb.update('Resolution pass', n+1, 10)
1523
conflicts = tt.find_conflicts()
1524
if len(conflicts) == 0:
1525
return new_conflicts
1526
new_conflicts.update(pass_func(tt, conflicts))
1527
raise MalformedTransform(conflicts=conflicts)
1532
def conflict_pass(tt, conflicts):
1533
"""Resolve some classes of conflicts."""
1534
new_conflicts = set()
1535
for c_type, conflict in ((c[0], c) for c in conflicts):
1536
if c_type == 'duplicate id':
1537
tt.unversion_file(conflict[1])
1538
new_conflicts.add((c_type, 'Unversioned existing file',
1539
conflict[1], conflict[2], ))
1540
elif c_type == 'duplicate':
1541
# files that were renamed take precedence
1542
new_name = tt.final_name(conflict[1])+'.moved'
1543
final_parent = tt.final_parent(conflict[1])
1544
if tt.path_changed(conflict[1]):
1545
tt.adjust_path(new_name, final_parent, conflict[2])
1546
new_conflicts.add((c_type, 'Moved existing file to',
1547
conflict[2], conflict[1]))
1549
tt.adjust_path(new_name, final_parent, conflict[1])
1550
new_conflicts.add((c_type, 'Moved existing file to',
1551
conflict[1], conflict[2]))
1552
elif c_type == 'parent loop':
1553
# break the loop by undoing one of the ops that caused the loop
1555
while not tt.path_changed(cur):
1556
cur = tt.final_parent(cur)
1557
new_conflicts.add((c_type, 'Cancelled move', cur,
1558
tt.final_parent(cur),))
1559
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1561
elif c_type == 'missing parent':
1562
trans_id = conflict[1]
1564
tt.cancel_deletion(trans_id)
1565
new_conflicts.add(('deleting parent', 'Not deleting',
1568
tt.create_directory(trans_id)
1569
new_conflicts.add((c_type, 'Created directory', trans_id))
1570
elif c_type == 'unversioned parent':
1571
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1572
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
1573
return new_conflicts
1576
def cook_conflicts(raw_conflicts, tt):
1577
"""Generate a list of cooked conflicts, sorted by file path"""
1578
from bzrlib.conflicts import Conflict
1579
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1580
return sorted(conflict_iter, key=Conflict.sort_key)
1583
def iter_cook_conflicts(raw_conflicts, tt):
1584
from bzrlib.conflicts import Conflict
1586
for conflict in raw_conflicts:
1587
c_type = conflict[0]
1588
action = conflict[1]
1589
modified_path = fp.get_path(conflict[2])
1590
modified_id = tt.final_file_id(conflict[2])
1591
if len(conflict) == 3:
1592
yield Conflict.factory(c_type, action=action, path=modified_path,
1593
file_id=modified_id)
1596
conflicting_path = fp.get_path(conflict[3])
1597
conflicting_id = tt.final_file_id(conflict[3])
1598
yield Conflict.factory(c_type, action=action, path=modified_path,
1599
file_id=modified_id,
1600
conflict_path=conflicting_path,
1601
conflict_file_id=conflicting_id)
added
removed
bzrlib/transform.py
