216
264
self.version_file(old_root_file_id, old_root)
217
265
self.unversion_file(self._new_root)
219
def fixup_new_roots(self):
220
"""Reinterpret requests to change the root directory
222
Instead of creating a root directory, or moving an existing directory,
223
all the attributes and children of the new root are applied to the
224
existing root directory.
226
This means that the old root trans-id becomes obsolete, so it is
227
recommended only to invoke this after the root trans-id has become
231
new_roots = [k for k, v in self._new_parent.iteritems() if v is
233
if len(new_roots) < 1:
234
if self.final_kind(self.root) is None:
235
self.cancel_deletion(self.root)
236
if self.final_file_id(self.root) is None:
237
self.version_file(self.tree_file_id(self.root),
240
if len(new_roots) != 1:
241
raise ValueError('A tree cannot have two roots!')
242
if self._new_root is None:
243
self._new_root = new_roots[0]
245
old_new_root = new_roots[0]
246
# TODO: What to do if a old_new_root is present, but self._new_root is
247
# not listed as being removed? This code explicitly unversions
248
# the old root and versions it with the new file_id. Though that
249
# seems like an incomplete delta
251
# unversion the new root's directory.
252
file_id = self.final_file_id(old_new_root)
253
if old_new_root in self._new_id:
254
self.cancel_versioning(old_new_root)
256
self.unversion_file(old_new_root)
257
# if, at this stage, root still has an old file_id, zap it so we can
258
# stick a new one in.
259
if (self.tree_file_id(self._new_root) is not None and
260
self._new_root not in self._removed_id):
261
self.unversion_file(self._new_root)
262
if file_id is not None:
263
self.version_file(file_id, self._new_root)
265
# Now move children of new root into old root directory.
266
# Ensure all children are registered with the transaction, but don't
267
# use directly-- some tree children have new parents
268
list(self.iter_tree_children(old_new_root))
269
# Move all children of new root into old root directory.
270
for child in self.by_parent().get(old_new_root, []):
271
self.adjust_path(self.final_name(child), self._new_root, child)
273
# Ensure old_new_root has no directory.
274
if old_new_root in self._new_contents:
275
self.cancel_creation(old_new_root)
277
self.delete_contents(old_new_root)
279
# prevent deletion of root directory.
280
if self._new_root in self._removed_contents:
281
self.cancel_deletion(self._new_root)
283
# destroy path info for old_new_root.
284
del self._new_parent[old_new_root]
285
del self._new_name[old_new_root]
287
267
def trans_id_tree_file_id(self, inventory_id):
288
268
"""Determine the transaction id of a working tree file.
333
332
return ROOT_PARENT
334
333
return self.trans_id_tree_path(os.path.dirname(path))
335
def create_file(self, contents, trans_id, mode_id=None):
336
"""Schedule creation of a new file.
340
Contents is an iterator of strings, all of which will be written
341
to the target destination.
343
New file takes the permissions of any existing file with that id,
344
unless mode_id is specified.
346
name = self._limbo_name(trans_id)
350
unique_add(self._new_contents, trans_id, 'file')
352
# Clean up the file, it never got registered so
353
# TreeTransform.finalize() won't clean it up.
358
f.writelines(contents)
361
self._set_mode(trans_id, mode_id, S_ISREG)
363
def _set_mode(self, trans_id, mode_id, typefunc):
364
"""Set the mode of new file contents.
365
The mode_id is the existing file to get the mode from (often the same
366
as trans_id). The operation is only performed if there's a mode match
367
according to typefunc.
372
old_path = self._tree_id_paths[mode_id]
376
mode = os.stat(self._tree.abspath(old_path)).st_mode
378
if e.errno in (errno.ENOENT, errno.ENOTDIR):
379
# Either old_path doesn't exist, or the parent of the
380
# target is not a directory (but will be one eventually)
381
# Either way, we know it doesn't exist *right now*
382
# See also bug #248448
387
os.chmod(self._limbo_name(trans_id), mode)
389
def create_hardlink(self, path, trans_id):
390
"""Schedule creation of a hard link"""
391
name = self._limbo_name(trans_id)
395
if e.errno != errno.EPERM:
397
raise errors.HardLinkNotSupported(path)
399
unique_add(self._new_contents, trans_id, 'file')
401
# Clean up the file, it never got registered so
402
# TreeTransform.finalize() won't clean it up.
406
def create_directory(self, trans_id):
407
"""Schedule creation of a new directory.
409
See also new_directory.
411
os.mkdir(self._limbo_name(trans_id))
412
unique_add(self._new_contents, trans_id, 'directory')
414
def create_symlink(self, target, trans_id):
415
"""Schedule creation of a new symbolic link.
417
target is a bytestring.
418
See also new_symlink.
421
os.symlink(target, self._limbo_name(trans_id))
422
unique_add(self._new_contents, trans_id, 'symlink')
425
path = FinalPaths(self).get_path(trans_id)
428
raise UnableCreateSymlink(path=path)
430
def cancel_creation(self, trans_id):
431
"""Cancel the creation of new file contents."""
432
del self._new_contents[trans_id]
433
children = self._limbo_children.get(trans_id)
434
# if this is a limbo directory with children, move them before removing
436
if children is not None:
437
self._rename_in_limbo(children)
438
del self._limbo_children[trans_id]
439
del self._limbo_children_names[trans_id]
440
delete_any(self._limbo_name(trans_id))
336
442
def delete_contents(self, trans_id):
337
443
"""Schedule the contents of a path entry for deletion"""
338
kind = self.tree_kind(trans_id)
340
self._removed_contents.add(trans_id)
444
self.tree_kind(trans_id)
445
self._removed_contents.add(trans_id)
342
447
def cancel_deletion(self, trans_id):
343
448
"""Cancel a scheduled deletion"""
400
505
return sorted(FinalPaths(self).get_paths(new_ids))
402
507
def _inventory_altered(self):
403
"""Determine which trans_ids need new Inventory entries.
405
An new entry is needed when anything that would be reflected by an
406
inventory entry changes, including file name, file_id, parent file_id,
407
file kind, and the execute bit.
409
Some care is taken to return entries with real changes, not cases
410
where the value is deleted and then restored to its original value,
411
but some actually unchanged values may be returned.
413
:returns: A list of (path, trans_id) for all items requiring an
414
inventory change. Ordered by path.
417
# Find entries whose file_ids are new (or changed).
418
new_file_id = set(t for t in self._new_id
419
if self._new_id[t] != self.tree_file_id(t))
420
for id_set in [self._new_name, self._new_parent, new_file_id,
508
"""Get the trans_ids and paths of files needing new inv entries."""
510
for id_set in [self._new_name, self._new_parent, self._new_id,
421
511
self._new_executability]:
422
changed_ids.update(id_set)
423
# removing implies a kind change
512
new_ids.update(id_set)
424
513
changed_kind = set(self._removed_contents)
426
514
changed_kind.intersection_update(self._new_contents)
427
# Ignore entries that are already known to have changed.
428
changed_kind.difference_update(changed_ids)
429
# to keep only the truly changed ones
430
changed_kind = (t for t in changed_kind
431
if self.tree_kind(t) != self.final_kind(t))
432
# all kind changes will alter the inventory
433
changed_ids.update(changed_kind)
434
# To find entries with changed parent_ids, find parents which existed,
435
# but changed file_id.
436
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
437
# Now add all their children to the set.
438
for parent_trans_id in new_file_id:
439
changed_ids.update(self.iter_tree_children(parent_trans_id))
440
return sorted(FinalPaths(self).get_paths(changed_ids))
515
changed_kind.difference_update(new_ids)
516
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
518
new_ids.update(changed_kind)
519
return sorted(FinalPaths(self).get_paths(new_ids))
521
def tree_kind(self, trans_id):
522
"""Determine the file kind in the working tree.
524
Raises NoSuchFile if the file does not exist
526
path = self._tree_id_paths.get(trans_id)
528
raise NoSuchFile(None)
530
return file_kind(self._tree.abspath(path))
532
if e.errno != errno.ENOENT:
535
raise NoSuchFile(path)
442
537
def final_kind(self, trans_id):
443
538
"""Determine the final file kind, after any changes applied.
445
:return: None if the file does not exist/has no contents. (It is
446
conceivable that a path would be created without the corresponding
447
contents insertion command)
540
Raises NoSuchFile if the file does not exist/has no contents.
541
(It is conceivable that a path would be created without the
542
corresponding contents insertion command)
449
544
if trans_id in self._new_contents:
450
545
return self._new_contents[trans_id]
451
546
elif trans_id in self._removed_contents:
547
raise NoSuchFile(None)
454
549
return self.tree_kind(trans_id)
579
667
# ensure that all children are registered with the transaction
580
668
list(self.iter_tree_children(parent_id))
582
@deprecated_method(deprecated_in((2, 3, 0)))
670
def iter_tree_children(self, parent_id):
671
"""Iterate through the entry's tree children, if any"""
673
path = self._tree_id_paths[parent_id]
677
children = os.listdir(self._tree.abspath(path))
679
if not (osutils._is_error_enotdir(e)
680
or e.errno in (errno.ENOENT, errno.ESRCH)):
684
for child in children:
685
childpath = joinpath(path, child)
686
if self._tree.is_control_filename(childpath):
688
yield self.trans_id_tree_path(childpath)
583
690
def has_named_child(self, by_parent, parent_id, name):
584
return self._has_named_child(
585
name, parent_id, known_children=by_parent.get(parent_id, []))
587
def _has_named_child(self, name, parent_id, known_children):
588
"""Does a parent already have a name child.
590
:param name: The searched for name.
592
:param parent_id: The parent for which the check is made.
594
:param known_children: The already known children. This should have
595
been recently obtained from `self.by_parent.get(parent_id)`
596
(or will be if None is passed).
598
if known_children is None:
599
known_children = self.by_parent().get(parent_id, [])
600
for child in known_children:
692
children = by_parent[parent_id]
695
for child in children:
601
696
if self.final_name(child) == name:
603
parent_path = self._tree_id_paths.get(parent_id, None)
604
if parent_path is None:
605
# No parent... no children
699
path = self._tree_id_paths[parent_id]
607
child_path = joinpath(parent_path, name)
608
child_id = self._tree_path_ids.get(child_path, None)
702
childpath = joinpath(path, name)
703
child_id = self._tree_path_ids.get(childpath)
609
704
if child_id is None:
610
# Not known by the tree transform yet, check the filesystem
611
return osutils.lexists(self._tree.abspath(child_path))
705
return lexists(self._tree.abspath(childpath))
613
raise AssertionError('child_id is missing: %s, %s, %s'
614
% (name, parent_id, child_id))
616
def _available_backup_name(self, name, target_id):
617
"""Find an available backup name.
619
:param name: The basename of the file.
621
:param target_id: The directory trans_id where the backup should
624
known_children = self.by_parent().get(target_id, [])
625
return osutils.available_backup_name(
627
lambda base: self._has_named_child(
628
base, target_id, known_children))
707
if self.final_parent(child_id) != parent_id:
709
if child_id in self._removed_contents:
710
# XXX What about dangling file-ids?
630
715
def _parent_loops(self):
631
716
"""No entry should be its own ancestor"""
747
837
def _parent_type_conflicts(self, by_parent):
748
"""Children must have a directory parent"""
838
"""parents must have directory 'contents'."""
750
840
for parent_id, children in by_parent.iteritems():
751
841
if parent_id is ROOT_PARENT:
754
for child_id in children:
755
if self.final_kind(child_id) is not None:
843
if not self._any_contents(children):
760
# There is at least a child, so we need an existing directory to
762
kind = self.final_kind(parent_id)
845
for child in children:
847
self.final_kind(child)
851
kind = self.final_kind(parent_id)
764
# The directory will be deleted
765
855
conflicts.append(('missing parent', parent_id))
766
856
elif kind != "directory":
767
# Meh, we need a *directory* to put something in it
768
857
conflicts.append(('non-directory parent', parent_id))
860
def _any_contents(self, trans_ids):
861
"""Return true if any of the trans_ids, will have contents."""
862
for trans_id in trans_ids:
864
kind = self.final_kind(trans_id)
870
def _limbo_name(self, trans_id):
871
"""Generate the limbo name of a file"""
872
limbo_name = self._limbo_files.get(trans_id)
873
if limbo_name is not None:
875
parent = self._new_parent.get(trans_id)
876
# if the parent directory is already in limbo (e.g. when building a
877
# tree), choose a limbo name inside the parent, to reduce further
879
use_direct_path = False
880
if self._new_contents.get(parent) == 'directory':
881
filename = self._new_name.get(trans_id)
882
if filename is not None:
883
if parent not in self._limbo_children:
884
self._limbo_children[parent] = set()
885
self._limbo_children_names[parent] = {}
886
use_direct_path = True
887
# the direct path can only be used if no other file has
888
# already taken this pathname, i.e. if the name is unused, or
889
# if it is already associated with this trans_id.
890
elif self._case_sensitive_target:
891
if (self._limbo_children_names[parent].get(filename)
892
in (trans_id, None)):
893
use_direct_path = True
895
for l_filename, l_trans_id in\
896
self._limbo_children_names[parent].iteritems():
897
if l_trans_id == trans_id:
899
if l_filename.lower() == filename.lower():
902
use_direct_path = True
905
limbo_name = pathjoin(self._limbo_files[parent], filename)
906
self._limbo_children[parent].add(trans_id)
907
self._limbo_children_names[parent][filename] = trans_id
909
limbo_name = pathjoin(self._limbodir, trans_id)
910
self._needs_rename.add(trans_id)
911
self._limbo_files[trans_id] = limbo_name
771
914
def _set_executability(self, path, trans_id):
772
915
"""Set the executability of versioned files """
773
916
if supports_executable():
1018
1122
def get_preview_tree(self):
1019
1123
"""Return a tree representing the result of the transform.
1021
The tree is a snapshot, and altering the TreeTransform will invalidate
1125
This tree only supports the subset of Tree functionality required
1126
by show_diff_trees. It must only be compared to tt._tree.
1024
1128
return _PreviewTree(self)
1026
def commit(self, branch, message, merge_parents=None, strict=False,
1027
timestamp=None, timezone=None, committer=None, authors=None,
1028
revprops=None, revision_id=None):
1029
"""Commit the result of this TreeTransform to a branch.
1031
:param branch: The branch to commit to.
1032
:param message: The message to attach to the commit.
1033
:param merge_parents: Additional parent revision-ids specified by
1035
:param strict: If True, abort the commit if there are unversioned
1037
:param timestamp: if not None, seconds-since-epoch for the time and
1038
date. (May be a float.)
1039
:param timezone: Optional timezone for timestamp, as an offset in
1041
:param committer: Optional committer in email-id format.
1042
(e.g. "J Random Hacker <jrandom@example.com>")
1043
:param authors: Optional list of authors in email-id format.
1044
:param revprops: Optional dictionary of revision properties.
1045
:param revision_id: Optional revision id. (Specifying a revision-id
1046
may reduce performance for some non-native formats.)
1047
:return: The revision_id of the revision committed.
1049
self._check_malformed()
1051
unversioned = set(self._new_contents).difference(set(self._new_id))
1052
for trans_id in unversioned:
1053
if self.final_file_id(trans_id) is None:
1054
raise errors.StrictCommitFailed()
1056
revno, last_rev_id = branch.last_revision_info()
1057
if last_rev_id == _mod_revision.NULL_REVISION:
1058
if merge_parents is not None:
1059
raise ValueError('Cannot supply merge parents for first'
1063
parent_ids = [last_rev_id]
1064
if merge_parents is not None:
1065
parent_ids.extend(merge_parents)
1066
if self._tree.get_revision_id() != last_rev_id:
1067
raise ValueError('TreeTransform not based on branch basis: %s' %
1068
self._tree.get_revision_id())
1069
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1070
builder = branch.get_commit_builder(parent_ids,
1071
timestamp=timestamp,
1073
committer=committer,
1075
revision_id=revision_id)
1076
preview = self.get_preview_tree()
1077
list(builder.record_iter_changes(preview, last_rev_id,
1078
self.iter_changes()))
1079
builder.finish_inventory()
1080
revision_id = builder.commit(message)
1081
branch.set_last_revision_info(revno + 1, revision_id)
1084
1130
def _text_parent(self, trans_id):
1085
1131
file_id = self.tree_file_id(trans_id)
1177
1227
self.create_symlink(content.decode('utf-8'), trans_id)
1180
class DiskTreeTransform(TreeTransformBase):
1181
"""Tree transform storing its contents on disk."""
1183
def __init__(self, tree, limbodir, pb=None,
1184
case_sensitive=True):
1186
:param tree: The tree that will be transformed, but not necessarily
1188
:param limbodir: A directory where new files can be stored until
1189
they are installed in their proper places
1191
:param case_sensitive: If True, the target of the transform is
1192
case sensitive, not just case preserving.
1194
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1195
self._limbodir = limbodir
1196
self._deletiondir = None
1197
# A mapping of transform ids to their limbo filename
1198
self._limbo_files = {}
1199
self._possibly_stale_limbo_files = set()
1200
# A mapping of transform ids to a set of the transform ids of children
1201
# that their limbo directory has
1202
self._limbo_children = {}
1203
# Map transform ids to maps of child filename to child transform id
1204
self._limbo_children_names = {}
1205
# List of transform ids that need to be renamed from limbo into place
1206
self._needs_rename = set()
1207
self._creation_mtime = None
1210
"""Release the working tree lock, if held, clean up limbo dir.
1212
This is required if apply has not been invoked, but can be invoked
1215
if self._tree is None:
1218
limbo_paths = self._limbo_files.values() + list(
1219
self._possibly_stale_limbo_files)
1220
limbo_paths = sorted(limbo_paths, reverse=True)
1221
for path in limbo_paths:
1225
if e.errno != errno.ENOENT:
1227
# XXX: warn? perhaps we just got interrupted at an
1228
# inconvenient moment, but perhaps files are disappearing
1231
delete_any(self._limbodir)
1233
# We don't especially care *why* the dir is immortal.
1234
raise ImmortalLimbo(self._limbodir)
1236
if self._deletiondir is not None:
1237
delete_any(self._deletiondir)
1239
raise errors.ImmortalPendingDeletion(self._deletiondir)
1241
TreeTransformBase.finalize(self)
1243
def _limbo_name(self, trans_id):
1244
"""Generate the limbo name of a file"""
1245
limbo_name = self._limbo_files.get(trans_id)
1246
if limbo_name is None:
1247
limbo_name = self._generate_limbo_path(trans_id)
1248
self._limbo_files[trans_id] = limbo_name
1251
def _generate_limbo_path(self, trans_id):
1252
"""Generate a limbo path using the trans_id as the relative path.
1254
This is suitable as a fallback, and when the transform should not be
1255
sensitive to the path encoding of the limbo directory.
1257
self._needs_rename.add(trans_id)
1258
return pathjoin(self._limbodir, trans_id)
1260
def adjust_path(self, name, parent, trans_id):
1261
previous_parent = self._new_parent.get(trans_id)
1262
previous_name = self._new_name.get(trans_id)
1263
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1264
if (trans_id in self._limbo_files and
1265
trans_id not in self._needs_rename):
1266
self._rename_in_limbo([trans_id])
1267
if previous_parent != parent:
1268
self._limbo_children[previous_parent].remove(trans_id)
1269
if previous_parent != parent or previous_name != name:
1270
del self._limbo_children_names[previous_parent][previous_name]
1272
def _rename_in_limbo(self, trans_ids):
1273
"""Fix limbo names so that the right final path is produced.
1275
This means we outsmarted ourselves-- we tried to avoid renaming
1276
these files later by creating them with their final names in their
1277
final parents. But now the previous name or parent is no longer
1278
suitable, so we have to rename them.
1280
Even for trans_ids that have no new contents, we must remove their
1281
entries from _limbo_files, because they are now stale.
1283
for trans_id in trans_ids:
1284
old_path = self._limbo_files[trans_id]
1285
self._possibly_stale_limbo_files.add(old_path)
1286
del self._limbo_files[trans_id]
1287
if trans_id not in self._new_contents:
1289
new_path = self._limbo_name(trans_id)
1290
os.rename(old_path, new_path)
1291
self._possibly_stale_limbo_files.remove(old_path)
1292
for descendant in self._limbo_descendants(trans_id):
1293
desc_path = self._limbo_files[descendant]
1294
desc_path = new_path + desc_path[len(old_path):]
1295
self._limbo_files[descendant] = desc_path
1297
def _limbo_descendants(self, trans_id):
1298
"""Return the set of trans_ids whose limbo paths descend from this."""
1299
descendants = set(self._limbo_children.get(trans_id, []))
1300
for descendant in list(descendants):
1301
descendants.update(self._limbo_descendants(descendant))
1304
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1305
"""Schedule creation of a new file.
1309
:param contents: an iterator of strings, all of which will be written
1310
to the target destination.
1311
:param trans_id: TreeTransform handle
1312
:param mode_id: If not None, force the mode of the target file to match
1313
the mode of the object referenced by mode_id.
1314
Otherwise, we will try to preserve mode bits of an existing file.
1315
:param sha1: If the sha1 of this content is already known, pass it in.
1316
We can use it to prevent future sha1 computations.
1318
name = self._limbo_name(trans_id)
1319
f = open(name, 'wb')
1321
unique_add(self._new_contents, trans_id, 'file')
1322
f.writelines(contents)
1325
self._set_mtime(name)
1326
self._set_mode(trans_id, mode_id, S_ISREG)
1327
# It is unfortunate we have to use lstat instead of fstat, but we just
1328
# used utime and chmod on the file, so we need the accurate final
1330
if sha1 is not None:
1331
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1333
def _read_file_chunks(self, trans_id):
1334
cur_file = open(self._limbo_name(trans_id), 'rb')
1336
return cur_file.readlines()
1340
def _read_symlink_target(self, trans_id):
1341
return os.readlink(self._limbo_name(trans_id))
1343
def _set_mtime(self, path):
1344
"""All files that are created get the same mtime.
1346
This time is set by the first object to be created.
1348
if self._creation_mtime is None:
1349
self._creation_mtime = time.time()
1350
os.utime(path, (self._creation_mtime, self._creation_mtime))
1352
def create_hardlink(self, path, trans_id):
1353
"""Schedule creation of a hard link"""
1354
name = self._limbo_name(trans_id)
1358
if e.errno != errno.EPERM:
1360
raise errors.HardLinkNotSupported(path)
1362
unique_add(self._new_contents, trans_id, 'file')
1364
# Clean up the file, it never got registered so
1365
# TreeTransform.finalize() won't clean it up.
1369
def create_directory(self, trans_id):
1370
"""Schedule creation of a new directory.
1372
See also new_directory.
1374
os.mkdir(self._limbo_name(trans_id))
1375
unique_add(self._new_contents, trans_id, 'directory')
1377
def create_symlink(self, target, trans_id):
1378
"""Schedule creation of a new symbolic link.
1380
target is a bytestring.
1381
See also new_symlink.
1384
os.symlink(target, self._limbo_name(trans_id))
1385
unique_add(self._new_contents, trans_id, 'symlink')
1388
path = FinalPaths(self).get_path(trans_id)
1391
raise UnableCreateSymlink(path=path)
1393
def cancel_creation(self, trans_id):
1394
"""Cancel the creation of new file contents."""
1395
del self._new_contents[trans_id]
1396
if trans_id in self._observed_sha1s:
1397
del self._observed_sha1s[trans_id]
1398
children = self._limbo_children.get(trans_id)
1399
# if this is a limbo directory with children, move them before removing
1401
if children is not None:
1402
self._rename_in_limbo(children)
1403
del self._limbo_children[trans_id]
1404
del self._limbo_children_names[trans_id]
1405
delete_any(self._limbo_name(trans_id))
1407
def new_orphan(self, trans_id, parent_id):
1408
# FIXME: There is no tree config, so we use the branch one (it's weird
1409
# to define it this way as orphaning can only occur in a working tree,
1410
# but that's all we have (for now). It will find the option in
1411
# locations.conf or bazaar.conf though) -- vila 20100916
1412
conf = self._tree.branch.get_config()
1413
conf_var_name = 'bzr.transform.orphan_policy'
1414
orphan_policy = conf.get_user_option(conf_var_name)
1415
default_policy = orphaning_registry.default_key
1416
if orphan_policy is None:
1417
orphan_policy = default_policy
1418
if orphan_policy not in orphaning_registry:
1419
trace.warning('%s (from %s) is not a known policy, defaulting '
1420
'to %s' % (orphan_policy, conf_var_name, default_policy))
1421
orphan_policy = default_policy
1422
handle_orphan = orphaning_registry.get(orphan_policy)
1423
handle_orphan(self, trans_id, parent_id)
1426
class OrphaningError(errors.BzrError):
1428
# Only bugs could lead to such exception being seen by the user
1429
internal_error = True
1430
_fmt = "Error while orphaning %s in %s directory"
1432
def __init__(self, orphan, parent):
1433
errors.BzrError.__init__(self)
1434
self.orphan = orphan
1435
self.parent = parent
1438
class OrphaningForbidden(OrphaningError):
1440
_fmt = "Policy: %s doesn't allow creating orphans."
1442
def __init__(self, policy):
1443
errors.BzrError.__init__(self)
1444
self.policy = policy
1447
def move_orphan(tt, orphan_id, parent_id):
1448
"""See TreeTransformBase.new_orphan.
1450
This creates a new orphan in the `bzr-orphans` dir at the root of the
1453
:param tt: The TreeTransform orphaning `trans_id`.
1455
:param orphan_id: The trans id that should be orphaned.
1457
:param parent_id: The orphan parent trans id.
1459
# Add the orphan dir if it doesn't exist
1460
orphan_dir_basename = 'bzr-orphans'
1461
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1462
if tt.final_kind(od_id) is None:
1463
tt.create_directory(od_id)
1464
parent_path = tt._tree_id_paths[parent_id]
1465
# Find a name that doesn't exist yet in the orphan dir
1466
actual_name = tt.final_name(orphan_id)
1467
new_name = tt._available_backup_name(actual_name, od_id)
1468
tt.adjust_path(new_name, od_id, orphan_id)
1469
trace.warning('%s has been orphaned in %s'
1470
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1473
def refuse_orphan(tt, orphan_id, parent_id):
1474
"""See TreeTransformBase.new_orphan.
1476
This refuses to create orphan, letting the caller handle the conflict.
1478
raise OrphaningForbidden('never')
1481
orphaning_registry = registry.Registry()
1482
orphaning_registry.register(
1483
'conflict', refuse_orphan,
1484
'Leave orphans in place and create a conflict on the directory.')
1485
orphaning_registry.register(
1486
'move', move_orphan,
1487
'Move orphans into the bzr-orphans directory.')
1488
orphaning_registry._set_default_key('conflict')
1491
class TreeTransform(DiskTreeTransform):
1230
class TreeTransform(TreeTransformBase):
1492
1231
"""Represent a tree transformation.
1494
1233
This object is designed to support incremental generation of the transform,
1583
# Cache of realpath results, to speed up canonical_path
1584
self._realpaths = {}
1585
# Cache of relpath results, to speed up canonical_path
1587
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1322
TreeTransformBase.__init__(self, tree, limbodir, pb,
1588
1323
tree.case_sensitive)
1589
1324
self._deletiondir = deletiondir
1591
def canonical_path(self, path):
1592
"""Get the canonical tree-relative path"""
1593
# don't follow final symlinks
1594
abs = self._tree.abspath(path)
1595
if abs in self._relpaths:
1596
return self._relpaths[abs]
1597
dirname, basename = os.path.split(abs)
1598
if dirname not in self._realpaths:
1599
self._realpaths[dirname] = os.path.realpath(dirname)
1600
dirname = self._realpaths[dirname]
1601
abs = pathjoin(dirname, basename)
1602
if dirname in self._relpaths:
1603
relpath = pathjoin(self._relpaths[dirname], basename)
1604
relpath = relpath.rstrip('/\\')
1606
relpath = self._tree.relpath(abs)
1607
self._relpaths[abs] = relpath
1610
def tree_kind(self, trans_id):
1611
"""Determine the file kind in the working tree.
1613
:returns: The file kind or None if the file does not exist
1615
path = self._tree_id_paths.get(trans_id)
1619
return file_kind(self._tree.abspath(path))
1620
except errors.NoSuchFile:
1623
def _set_mode(self, trans_id, mode_id, typefunc):
1624
"""Set the mode of new file contents.
1625
The mode_id is the existing file to get the mode from (often the same
1626
as trans_id). The operation is only performed if there's a mode match
1627
according to typefunc.
1632
old_path = self._tree_id_paths[mode_id]
1636
mode = os.stat(self._tree.abspath(old_path)).st_mode
1638
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1639
# Either old_path doesn't exist, or the parent of the
1640
# target is not a directory (but will be one eventually)
1641
# Either way, we know it doesn't exist *right now*
1642
# See also bug #248448
1647
os.chmod(self._limbo_name(trans_id), mode)
1649
def iter_tree_children(self, parent_id):
1650
"""Iterate through the entry's tree children, if any"""
1652
path = self._tree_id_paths[parent_id]
1656
children = os.listdir(self._tree.abspath(path))
1658
if not (osutils._is_error_enotdir(e)
1659
or e.errno in (errno.ENOENT, errno.ESRCH)):
1663
for child in children:
1664
childpath = joinpath(path, child)
1665
if self._tree.is_control_filename(childpath):
1667
yield self.trans_id_tree_path(childpath)
1669
def _generate_limbo_path(self, trans_id):
1670
"""Generate a limbo path using the final path if possible.
1672
This optimizes the performance of applying the tree transform by
1673
avoiding renames. These renames can be avoided only when the parent
1674
directory is already scheduled for creation.
1676
If the final path cannot be used, falls back to using the trans_id as
1679
parent = self._new_parent.get(trans_id)
1680
# if the parent directory is already in limbo (e.g. when building a
1681
# tree), choose a limbo name inside the parent, to reduce further
1683
use_direct_path = False
1684
if self._new_contents.get(parent) == 'directory':
1685
filename = self._new_name.get(trans_id)
1686
if filename is not None:
1687
if parent not in self._limbo_children:
1688
self._limbo_children[parent] = set()
1689
self._limbo_children_names[parent] = {}
1690
use_direct_path = True
1691
# the direct path can only be used if no other file has
1692
# already taken this pathname, i.e. if the name is unused, or
1693
# if it is already associated with this trans_id.
1694
elif self._case_sensitive_target:
1695
if (self._limbo_children_names[parent].get(filename)
1696
in (trans_id, None)):
1697
use_direct_path = True
1699
for l_filename, l_trans_id in\
1700
self._limbo_children_names[parent].iteritems():
1701
if l_trans_id == trans_id:
1703
if l_filename.lower() == filename.lower():
1706
use_direct_path = True
1708
if not use_direct_path:
1709
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1711
limbo_name = pathjoin(self._limbo_files[parent], filename)
1712
self._limbo_children[parent].add(trans_id)
1713
self._limbo_children_names[parent][filename] = trans_id
1717
1326
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1718
1327
"""Apply all changes to the inventory and filesystem.
1878
1487
if trans_id in self._needs_rename:
1880
1489
mover.rename(self._limbo_name(trans_id), full_path)
1881
except errors.TransformRenameFailed, e:
1882
1491
# We may be renaming a dangling inventory id
1883
1492
if e.errno != errno.ENOENT:
1886
1495
self.rename_count += 1
1887
# TODO: if trans_id in self._observed_sha1s, we should
1888
# re-stat the final target, since ctime will be
1889
# updated by the change.
1890
1496
if (trans_id in self._new_contents or
1891
1497
self.path_changed(trans_id)):
1892
1498
if trans_id in self._new_contents:
1893
1499
modified_paths.append(full_path)
1894
1500
if trans_id in self._new_executability:
1895
1501
self._set_executability(path, trans_id)
1896
if trans_id in self._observed_sha1s:
1897
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1898
st = osutils.lstat(full_path)
1899
self._observed_sha1s[trans_id] = (o_sha1, st)
1901
1503
child_pb.finished()
1902
for path, trans_id in new_paths:
1903
# new_paths includes stuff like workingtree conflicts. Only the
1904
# stuff in new_contents actually comes from limbo.
1905
if trans_id in self._limbo_files:
1906
del self._limbo_files[trans_id]
1907
1504
self._new_contents.clear()
1908
1505
return modified_paths
1910
def _apply_observed_sha1s(self):
1911
"""After we have finished renaming everything, update observed sha1s
1913
This has to be done after self._tree.apply_inventory_delta, otherwise
1914
it doesn't know anything about the files we are updating. Also, we want
1915
to do this as late as possible, so that most entries end up cached.
1917
# TODO: this doesn't update the stat information for directories. So
1918
# the first 'bzr status' will still need to rewrite
1919
# .bzr/checkout/dirstate. However, we at least don't need to
1920
# re-read all of the files.
1921
# TODO: If the operation took a while, we could do a time.sleep(3) here
1922
# to allow the clock to tick over and ensure we won't have any
1923
# problems. (we could observe start time, and finish time, and if
1924
# it is less than eg 10% overhead, add a sleep call.)
1925
paths = FinalPaths(self)
1926
for trans_id, observed in self._observed_sha1s.iteritems():
1927
path = paths.get_path(trans_id)
1928
# We could get the file_id, but dirstate prefers to use the path
1929
# anyway, and it is 'cheaper' to determine.
1930
# file_id = self._new_id[trans_id]
1931
self._tree._observed_sha1(None, path, observed)
1934
class TransformPreview(DiskTreeTransform):
1508
class TransformPreview(TreeTransformBase):
1935
1509
"""A TreeTransform for generating preview trees.
1937
1511
Unlike TreeTransform, this version works when the input tree is a
2192
1754
ordered_ids = self._list_files_by_dir()
2193
1755
for entry, trans_id in self._make_inv_entries(ordered_ids,
2194
specific_file_ids, yield_parents=yield_parents):
2195
yield unicode(self._final_paths.get_path(trans_id)), entry
2197
def _iter_entries_for_dir(self, dir_path):
2198
"""Return path, entry for items in a directory without recursing down."""
2199
dir_file_id = self.path2id(dir_path)
2201
for file_id in self.iter_children(dir_file_id):
2202
trans_id = self._transform.trans_id_file_id(file_id)
2203
ordered_ids.append((trans_id, file_id))
2204
for entry, trans_id in self._make_inv_entries(ordered_ids):
2205
yield unicode(self._final_paths.get_path(trans_id)), entry
2207
def list_files(self, include_root=False, from_dir=None, recursive=True):
2208
"""See WorkingTree.list_files."""
1757
yield unicode(self._final_paths.get_path(trans_id)), entry
1759
def list_files(self, include_root=False):
1760
"""See Tree.list_files."""
2209
1761
# XXX This should behave like WorkingTree.list_files, but is really
2210
1762
# more like RevisionTree.list_files.
2214
prefix = from_dir + '/'
2215
entries = self.iter_entries_by_dir()
2216
for path, entry in entries:
2217
if entry.name == '' and not include_root:
2220
if not path.startswith(prefix):
2222
path = path[len(prefix):]
2223
yield path, 'V', entry.kind, entry.file_id, entry
2225
if from_dir is None and include_root is True:
2226
root_entry = inventory.make_entry('directory', '',
2227
ROOT_PARENT, self.get_root_id())
2228
yield '', 'V', 'directory', root_entry.file_id, root_entry
2229
entries = self._iter_entries_for_dir(from_dir or '')
2230
for path, entry in entries:
2231
yield path, 'V', entry.kind, entry.file_id, entry
1763
for path, entry in self.iter_entries_by_dir():
1764
if entry.name == '' and not include_root:
1766
yield path, 'V', entry.kind, entry.file_id, entry
2233
1768
def kind(self, file_id):
2234
1769
trans_id = self._transform.trans_id_file_id(file_id)
2945
2433
if basis_tree is None:
2946
2434
basis_tree = working_tree.basis_tree()
2947
2435
basis_tree.lock_read()
2948
if basis_tree.has_id(file_id):
2436
if file_id in basis_tree:
2949
2437
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2950
2438
keep_content = True
2951
elif target_kind is None and not target_versioned:
2439
elif kind[1] is None and not versioned[1]:
2952
2440
keep_content = True
2953
if wt_kind is not None:
2441
if kind[0] is not None:
2954
2442
if not keep_content:
2955
2443
tt.delete_contents(trans_id)
2956
elif target_kind is not None:
2957
parent_trans_id = tt.trans_id_file_id(wt_parent)
2958
backup_name = tt._available_backup_name(
2959
wt_name, parent_trans_id)
2444
elif kind[1] is not None:
2445
parent_trans_id = tt.trans_id_file_id(parent[0])
2446
by_parent = tt.by_parent()
2447
backup_name = _get_backup_name(name[0], by_parent,
2448
parent_trans_id, tt)
2960
2449
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2961
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2962
if wt_versioned and target_versioned:
2450
new_trans_id = tt.create_path(name[0], parent_trans_id)
2451
if versioned == (True, True):
2963
2452
tt.unversion_file(trans_id)
2964
2453
tt.version_file(file_id, new_trans_id)
2965
2454
# New contents should have the same unix perms as old
2967
2456
mode_id = trans_id
2968
2457
trans_id = new_trans_id
2969
if target_kind in ('directory', 'tree-reference'):
2458
if kind[1] in ('directory', 'tree-reference'):
2970
2459
tt.create_directory(trans_id)
2971
if target_kind == 'tree-reference':
2460
if kind[1] == 'tree-reference':
2972
2461
revision = target_tree.get_reference_revision(file_id,
2974
2463
tt.set_tree_reference(revision, trans_id)
2975
elif target_kind == 'symlink':
2464
elif kind[1] == 'symlink':
2976
2465
tt.create_symlink(target_tree.get_symlink_target(file_id),
2978
elif target_kind == 'file':
2467
elif kind[1] == 'file':
2979
2468
deferred_files.append((file_id, (trans_id, mode_id)))
2980
2469
if basis_tree is None:
2981
2470
basis_tree = working_tree.basis_tree()
2982
2471
basis_tree.lock_read()
2983
2472
new_sha1 = target_tree.get_file_sha1(file_id)
2984
if (basis_tree.has_id(file_id) and
2985
new_sha1 == basis_tree.get_file_sha1(file_id)):
2473
if (file_id in basis_tree and new_sha1 ==
2474
basis_tree.get_file_sha1(file_id)):
2986
2475
if file_id in merge_modified:
2987
2476
del merge_modified[file_id]
2989
2478
merge_modified[file_id] = new_sha1
2991
2480
# preserve the execute bit when backing up
2992
if keep_content and wt_executable == target_executable:
2993
tt.set_executability(target_executable, trans_id)
2994
elif target_kind is not None:
2995
raise AssertionError(target_kind)
2996
if not wt_versioned and target_versioned:
2481
if keep_content and executable[0] == executable[1]:
2482
tt.set_executability(executable[1], trans_id)
2483
elif kind[1] is not None:
2484
raise AssertionError(kind[1])
2485
if versioned == (False, True):
2997
2486
tt.version_file(file_id, trans_id)
2998
if wt_versioned and not target_versioned:
2487
if versioned == (True, False):
2999
2488
tt.unversion_file(trans_id)
3000
if (target_name is not None and
3001
(wt_name != target_name or wt_parent != target_parent)):
3002
if target_name == '' and target_parent is None:
2489
if (name[1] is not None and
2490
(name[0] != name[1] or parent[0] != parent[1])):
2491
if name[1] == '' and parent[1] is None:
3003
2492
parent_trans = ROOT_PARENT
3005
parent_trans = tt.trans_id_file_id(target_parent)
3006
if wt_parent is None and wt_versioned:
3007
tt.adjust_root_path(target_name, parent_trans)
3009
tt.adjust_path(target_name, parent_trans, trans_id)
3010
if wt_executable != target_executable and target_kind == "file":
3011
tt.set_executability(target_executable, trans_id)
3012
if working_tree.supports_content_filtering():
3013
for index, ((trans_id, mode_id), bytes) in enumerate(
3014
target_tree.iter_files_bytes(deferred_files)):
3015
file_id = deferred_files[index][0]
3016
# We're reverting a tree to the target tree so using the
3017
# target tree to find the file path seems the best choice
3018
# here IMO - Ian C 27/Oct/2009
3019
filter_tree_path = target_tree.id2path(file_id)
3020
filters = working_tree._content_filter_stack(filter_tree_path)
3021
bytes = filtered_output_bytes(bytes, filters,
3022
ContentFilterContext(filter_tree_path, working_tree))
3023
tt.create_file(bytes, trans_id, mode_id)
3025
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3027
tt.create_file(bytes, trans_id, mode_id)
3028
tt.fixup_new_roots()
2494
parent_trans = tt.trans_id_file_id(parent[1])
2495
tt.adjust_path(name[1], parent_trans, trans_id)
2496
if executable[0] != executable[1] and kind[1] == "file":
2497
tt.set_executability(executable[1], trans_id)
2498
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2500
tt.create_file(bytes, trans_id, mode_id)
3030
2502
if basis_tree is not None:
3031
2503
basis_tree.unlock()
3032
2504
return merge_modified
3035
def resolve_conflicts(tt, pb=None, pass_func=None):
2507
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3036
2508
"""Make many conflict-resolution attempts, but die if they fail"""
3037
2509
if pass_func is None:
3038
2510
pass_func = conflict_pass
3039
2511
new_conflicts = set()
3040
pb = ui.ui_factory.nested_progress_bar()
3042
2513
for n in range(10):
3043
2514
pb.update('Resolution pass', n+1, 10)
added
removed
bzrlib/transform.py
