395
529
def find_conflicts(self):
396
530
"""Find any violations of inventory or filesystem invariants"""
397
raise NotImplementedError(self.find_conflicts)
531
if self._done is True:
532
raise ReusingTransform()
534
# ensure all children of all existent parents are known
535
# all children of non-existent parents are known, by definition.
536
self._add_tree_children()
537
by_parent = self.by_parent()
538
conflicts.extend(self._unversioned_parents(by_parent))
539
conflicts.extend(self._parent_loops())
540
conflicts.extend(self._duplicate_entries(by_parent))
541
conflicts.extend(self._duplicate_ids())
542
conflicts.extend(self._parent_type_conflicts(by_parent))
543
conflicts.extend(self._improper_versioning())
544
conflicts.extend(self._executability_conflicts())
545
conflicts.extend(self._overwrite_conflicts())
548
def _check_malformed(self):
549
conflicts = self.find_conflicts()
550
if len(conflicts) != 0:
551
raise MalformedTransform(conflicts=conflicts)
553
def _add_tree_children(self):
554
"""Add all the children of all active parents to the known paths.
556
Active parents are those which gain children, and those which are
557
removed. This is a necessary first step in detecting conflicts.
559
parents = list(self.by_parent())
560
parents.extend([t for t in self._removed_contents if
561
self.tree_kind(t) == 'directory'])
562
for trans_id in self._removed_id:
563
path = self.tree_path(trans_id)
565
if self._tree.stored_kind(path) == 'directory':
566
parents.append(trans_id)
567
elif self.tree_kind(trans_id) == 'directory':
568
parents.append(trans_id)
570
for parent_id in parents:
571
# ensure that all children are registered with the transaction
572
list(self.iter_tree_children(parent_id))
574
def _has_named_child(self, name, parent_id, known_children):
575
"""Does a parent already have a name child.
577
:param name: The searched for name.
579
:param parent_id: The parent for which the check is made.
581
:param known_children: The already known children. This should have
582
been recently obtained from `self.by_parent.get(parent_id)`
583
(or will be if None is passed).
585
if known_children is None:
586
known_children = self.by_parent().get(parent_id, [])
587
for child in known_children:
588
if self.final_name(child) == name:
590
parent_path = self._tree_id_paths.get(parent_id, None)
591
if parent_path is None:
592
# No parent... no children
594
child_path = joinpath(parent_path, name)
595
child_id = self._tree_path_ids.get(child_path, None)
597
# Not known by the tree transform yet, check the filesystem
598
return osutils.lexists(self._tree.abspath(child_path))
600
raise AssertionError('child_id is missing: %s, %s, %s'
601
% (name, parent_id, child_id))
603
def _available_backup_name(self, name, target_id):
604
"""Find an available backup name.
606
:param name: The basename of the file.
608
:param target_id: The directory trans_id where the backup should
611
known_children = self.by_parent().get(target_id, [])
612
return osutils.available_backup_name(
614
lambda base: self._has_named_child(
615
base, target_id, known_children))
617
def _parent_loops(self):
618
"""No entry should be its own ancestor"""
620
for trans_id in self._new_parent:
623
while parent_id != ROOT_PARENT:
626
parent_id = self.final_parent(parent_id)
629
if parent_id == trans_id:
630
conflicts.append(('parent loop', trans_id))
631
if parent_id in seen:
635
def _unversioned_parents(self, by_parent):
636
"""If parent directories are versioned, children must be versioned."""
638
for parent_id, children in viewitems(by_parent):
639
if parent_id == ROOT_PARENT:
641
if self.final_file_id(parent_id) is not None:
643
for child_id in children:
644
if self.final_file_id(child_id) is not None:
645
conflicts.append(('unversioned parent', parent_id))
649
def _improper_versioning(self):
650
"""Cannot version a file with no contents, or a bad type.
652
However, existing entries with no contents are okay.
655
for trans_id in self._new_id:
656
kind = self.final_kind(trans_id)
657
if kind == 'symlink' and not self._tree.supports_symlinks():
658
# Ignore symlinks as they are not supported on this platform
661
conflicts.append(('versioning no contents', trans_id))
663
if not self._tree.versionable_kind(kind):
664
conflicts.append(('versioning bad kind', trans_id, kind))
667
def _executability_conflicts(self):
668
"""Check for bad executability changes.
670
Only versioned files may have their executability set, because
671
1. only versioned entries can have executability under windows
672
2. only files can be executable. (The execute bit on a directory
673
does not indicate searchability)
676
for trans_id in self._new_executability:
677
if self.final_file_id(trans_id) is None:
678
conflicts.append(('unversioned executability', trans_id))
680
if self.final_kind(trans_id) != "file":
681
conflicts.append(('non-file executability', trans_id))
684
def _overwrite_conflicts(self):
685
"""Check for overwrites (not permitted on Win32)"""
687
for trans_id in self._new_contents:
688
if self.tree_kind(trans_id) is None:
690
if trans_id not in self._removed_contents:
691
conflicts.append(('overwrite', trans_id,
692
self.final_name(trans_id)))
695
def _duplicate_entries(self, by_parent):
696
"""No directory may have two entries with the same name."""
698
if (self._new_name, self._new_parent) == ({}, {}):
700
for children in viewvalues(by_parent):
702
for child_tid in children:
703
name = self.final_name(child_tid)
705
# Keep children only if they still exist in the end
706
if not self._case_sensitive_target:
708
name_ids.append((name, child_tid))
712
for name, trans_id in name_ids:
713
kind = self.final_kind(trans_id)
714
file_id = self.final_file_id(trans_id)
715
if kind is None and file_id is None:
717
if name == last_name:
718
conflicts.append(('duplicate', last_trans_id, trans_id,
721
last_trans_id = trans_id
724
def _duplicate_ids(self):
725
"""Each inventory id may only be used once"""
728
all_ids = self._tree.all_file_ids()
729
except errors.UnsupportedOperation:
730
# it's okay for non-file-id trees to raise UnsupportedOperation.
732
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
734
active_tree_ids = all_ids.difference(removed_tree_ids)
735
for trans_id, file_id in viewitems(self._new_id):
736
if file_id in active_tree_ids:
737
path = self._tree.id2path(file_id)
738
old_trans_id = self.trans_id_tree_path(path)
739
conflicts.append(('duplicate id', old_trans_id, trans_id))
742
def _parent_type_conflicts(self, by_parent):
743
"""Children must have a directory parent"""
745
for parent_id, children in viewitems(by_parent):
746
if parent_id == ROOT_PARENT:
749
for child_id in children:
750
if self.final_kind(child_id) is not None:
755
# There is at least a child, so we need an existing directory to
757
kind = self.final_kind(parent_id)
759
# The directory will be deleted
760
conflicts.append(('missing parent', parent_id))
761
elif kind != "directory":
762
# Meh, we need a *directory* to put something in it
763
conflicts.append(('non-directory parent', parent_id))
766
def _set_executability(self, path, trans_id):
767
"""Set the executability of versioned files """
768
if self._tree._supports_executable():
769
new_executability = self._new_executability[trans_id]
770
abspath = self._tree.abspath(path)
771
current_mode = os.stat(abspath).st_mode
772
if new_executability:
775
to_mode = current_mode | (0o100 & ~umask)
776
# Enable x-bit for others only if they can read it.
777
if current_mode & 0o004:
778
to_mode |= 0o001 & ~umask
779
if current_mode & 0o040:
780
to_mode |= 0o010 & ~umask
782
to_mode = current_mode & ~0o111
783
osutils.chmod_if_possible(abspath, to_mode)
785
def _new_entry(self, name, parent_id, file_id):
786
"""Helper function to create a new filesystem entry."""
787
trans_id = self.create_path(name, parent_id)
788
if file_id is not None:
789
self.version_file(file_id, trans_id)
399
792
def new_file(self, name, parent_id, contents, file_id=None,
400
793
executable=None, sha1=None):
525
1242
raise NotImplementedError(self.cancel_creation)
1245
class DiskTreeTransform(TreeTransformBase):
1246
"""Tree transform storing its contents on disk."""
1248
def __init__(self, tree, limbodir, pb=None, case_sensitive=True):
1250
:param tree: The tree that will be transformed, but not necessarily
1252
:param limbodir: A directory where new files can be stored until
1253
they are installed in their proper places
1255
:param case_sensitive: If True, the target of the transform is
1256
case sensitive, not just case preserving.
1258
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1259
self._limbodir = limbodir
1260
self._deletiondir = None
1261
# A mapping of transform ids to their limbo filename
1262
self._limbo_files = {}
1263
self._possibly_stale_limbo_files = set()
1264
# A mapping of transform ids to a set of the transform ids of children
1265
# that their limbo directory has
1266
self._limbo_children = {}
1267
# Map transform ids to maps of child filename to child transform id
1268
self._limbo_children_names = {}
1269
# List of transform ids that need to be renamed from limbo into place
1270
self._needs_rename = set()
1271
self._creation_mtime = None
1272
self._create_symlinks = osutils.supports_symlinks(self._limbodir)
1275
"""Release the working tree lock, if held, clean up limbo dir.
1277
This is required if apply has not been invoked, but can be invoked
1280
if self._tree is None:
1283
limbo_paths = list(viewvalues(self._limbo_files))
1284
limbo_paths.extend(self._possibly_stale_limbo_files)
1285
limbo_paths.sort(reverse=True)
1286
for path in limbo_paths:
1289
except OSError as e:
1290
if e.errno != errno.ENOENT:
1292
# XXX: warn? perhaps we just got interrupted at an
1293
# inconvenient moment, but perhaps files are disappearing
1296
delete_any(self._limbodir)
1298
# We don't especially care *why* the dir is immortal.
1299
raise ImmortalLimbo(self._limbodir)
1301
if self._deletiondir is not None:
1302
delete_any(self._deletiondir)
1304
raise errors.ImmortalPendingDeletion(self._deletiondir)
1306
TreeTransformBase.finalize(self)
1308
def _limbo_supports_executable(self):
1309
"""Check if the limbo path supports the executable bit."""
1310
return osutils.supports_executable(self._limbodir)
1312
def _limbo_name(self, trans_id):
1313
"""Generate the limbo name of a file"""
1314
limbo_name = self._limbo_files.get(trans_id)
1315
if limbo_name is None:
1316
limbo_name = self._generate_limbo_path(trans_id)
1317
self._limbo_files[trans_id] = limbo_name
1320
def _generate_limbo_path(self, trans_id):
1321
"""Generate a limbo path using the trans_id as the relative path.
1323
This is suitable as a fallback, and when the transform should not be
1324
sensitive to the path encoding of the limbo directory.
1326
self._needs_rename.add(trans_id)
1327
return pathjoin(self._limbodir, trans_id)
1329
def adjust_path(self, name, parent, trans_id):
1330
previous_parent = self._new_parent.get(trans_id)
1331
previous_name = self._new_name.get(trans_id)
1332
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1333
if (trans_id in self._limbo_files
1334
and trans_id not in self._needs_rename):
1335
self._rename_in_limbo([trans_id])
1336
if previous_parent != parent:
1337
self._limbo_children[previous_parent].remove(trans_id)
1338
if previous_parent != parent or previous_name != name:
1339
del self._limbo_children_names[previous_parent][previous_name]
1341
def _rename_in_limbo(self, trans_ids):
1342
"""Fix limbo names so that the right final path is produced.
1344
This means we outsmarted ourselves-- we tried to avoid renaming
1345
these files later by creating them with their final names in their
1346
final parents. But now the previous name or parent is no longer
1347
suitable, so we have to rename them.
1349
Even for trans_ids that have no new contents, we must remove their
1350
entries from _limbo_files, because they are now stale.
1352
for trans_id in trans_ids:
1353
old_path = self._limbo_files[trans_id]
1354
self._possibly_stale_limbo_files.add(old_path)
1355
del self._limbo_files[trans_id]
1356
if trans_id not in self._new_contents:
1358
new_path = self._limbo_name(trans_id)
1359
os.rename(old_path, new_path)
1360
self._possibly_stale_limbo_files.remove(old_path)
1361
for descendant in self._limbo_descendants(trans_id):
1362
desc_path = self._limbo_files[descendant]
1363
desc_path = new_path + desc_path[len(old_path):]
1364
self._limbo_files[descendant] = desc_path
1366
def _limbo_descendants(self, trans_id):
1367
"""Return the set of trans_ids whose limbo paths descend from this."""
1368
descendants = set(self._limbo_children.get(trans_id, []))
1369
for descendant in list(descendants):
1370
descendants.update(self._limbo_descendants(descendant))
1373
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1374
"""Schedule creation of a new file.
1378
:param contents: an iterator of strings, all of which will be written
1379
to the target destination.
1380
:param trans_id: TreeTransform handle
1381
:param mode_id: If not None, force the mode of the target file to match
1382
the mode of the object referenced by mode_id.
1383
Otherwise, we will try to preserve mode bits of an existing file.
1384
:param sha1: If the sha1 of this content is already known, pass it in.
1385
We can use it to prevent future sha1 computations.
1387
name = self._limbo_name(trans_id)
1388
with open(name, 'wb') as f:
1389
unique_add(self._new_contents, trans_id, 'file')
1390
f.writelines(contents)
1391
self._set_mtime(name)
1392
self._set_mode(trans_id, mode_id, S_ISREG)
1393
# It is unfortunate we have to use lstat instead of fstat, but we just
1394
# used utime and chmod on the file, so we need the accurate final
1396
if sha1 is not None:
1397
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1399
def _read_symlink_target(self, trans_id):
1400
return os.readlink(self._limbo_name(trans_id))
1402
def _set_mtime(self, path):
1403
"""All files that are created get the same mtime.
1405
This time is set by the first object to be created.
1407
if self._creation_mtime is None:
1408
self._creation_mtime = time.time()
1409
os.utime(path, (self._creation_mtime, self._creation_mtime))
1411
def create_hardlink(self, path, trans_id):
1412
"""Schedule creation of a hard link"""
1413
name = self._limbo_name(trans_id)
1416
except OSError as e:
1417
if e.errno != errno.EPERM:
1419
raise errors.HardLinkNotSupported(path)
1421
unique_add(self._new_contents, trans_id, 'file')
1422
except BaseException:
1423
# Clean up the file, it never got registered so
1424
# TreeTransform.finalize() won't clean it up.
1428
def create_directory(self, trans_id):
1429
"""Schedule creation of a new directory.
1431
See also new_directory.
1433
os.mkdir(self._limbo_name(trans_id))
1434
unique_add(self._new_contents, trans_id, 'directory')
1436
def create_symlink(self, target, trans_id):
1437
"""Schedule creation of a new symbolic link.
1439
target is a bytestring.
1440
See also new_symlink.
1442
if self._create_symlinks:
1443
os.symlink(target, self._limbo_name(trans_id))
1446
path = FinalPaths(self).get_path(trans_id)
1450
'Unable to create symlink "%s" on this filesystem.' % (path,))
1451
# We add symlink to _new_contents even if they are unsupported
1452
# and not created. These entries are subsequently used to avoid
1453
# conflicts on platforms that don't support symlink
1454
unique_add(self._new_contents, trans_id, 'symlink')
1456
def cancel_creation(self, trans_id):
1457
"""Cancel the creation of new file contents."""
1458
del self._new_contents[trans_id]
1459
if trans_id in self._observed_sha1s:
1460
del self._observed_sha1s[trans_id]
1461
children = self._limbo_children.get(trans_id)
1462
# if this is a limbo directory with children, move them before removing
1464
if children is not None:
1465
self._rename_in_limbo(children)
1466
del self._limbo_children[trans_id]
1467
del self._limbo_children_names[trans_id]
1468
delete_any(self._limbo_name(trans_id))
1470
def new_orphan(self, trans_id, parent_id):
1471
conf = self._tree.get_config_stack()
1472
handle_orphan = conf.get('transform.orphan_policy')
1473
handle_orphan(self, trans_id, parent_id)
528
1476
class OrphaningError(errors.BzrError):
530
1478
# Only bugs could lead to such exception being seen by the user
596
1544
invalid='warning')
1547
class TreeTransform(DiskTreeTransform):
1548
"""Represent a tree transformation.
1550
This object is designed to support incremental generation of the transform,
1553
However, it gives optimum performance when parent directories are created
1554
before their contents. The transform is then able to put child files
1555
directly in their parent directory, avoiding later renames.
1557
It is easy to produce malformed transforms, but they are generally
1558
harmless. Attempting to apply a malformed transform will cause an
1559
exception to be raised before any modifications are made to the tree.
1561
Many kinds of malformed transforms can be corrected with the
1562
resolve_conflicts function. The remaining ones indicate programming error,
1563
such as trying to create a file with no path.
1565
Two sets of file creation methods are supplied. Convenience methods are:
1570
These are composed of the low-level methods:
1572
* create_file or create_directory or create_symlink
1576
Transform/Transaction ids
1577
-------------------------
1578
trans_ids are temporary ids assigned to all files involved in a transform.
1579
It's possible, even common, that not all files in the Tree have trans_ids.
1581
trans_ids are used because filenames and file_ids are not good enough
1582
identifiers; filenames change, and not all files have file_ids. File-ids
1583
are also associated with trans-ids, so that moving a file moves its
1586
trans_ids are only valid for the TreeTransform that generated them.
1590
Limbo is a temporary directory use to hold new versions of files.
1591
Files are added to limbo by create_file, create_directory, create_symlink,
1592
and their convenience variants (new_*). Files may be removed from limbo
1593
using cancel_creation. Files are renamed from limbo into their final
1594
location as part of TreeTransform.apply
1596
Limbo must be cleaned up, by either calling TreeTransform.apply or
1597
calling TreeTransform.finalize.
1599
Files are placed into limbo inside their parent directories, where
1600
possible. This reduces subsequent renames, and makes operations involving
1601
lots of files faster. This optimization is only possible if the parent
1602
directory is created *before* creating any of its children, so avoid
1603
creating children before parents, where possible.
1607
This temporary directory is used by _FileMover for storing files that are
1608
about to be deleted. In case of rollback, the files will be restored.
1609
FileMover does not delete files until it is sure that a rollback will not
1613
def __init__(self, tree, pb=None):
1614
"""Note: a tree_write lock is taken on the tree.
1616
Use TreeTransform.finalize() to release the lock (can be omitted if
1617
TreeTransform.apply() called).
1619
tree.lock_tree_write()
1621
limbodir = urlutils.local_path_from_url(
1622
tree._transport.abspath('limbo'))
1623
osutils.ensure_empty_directory_exists(
1625
errors.ExistingLimbo)
1626
deletiondir = urlutils.local_path_from_url(
1627
tree._transport.abspath('pending-deletion'))
1628
osutils.ensure_empty_directory_exists(
1630
errors.ExistingPendingDeletion)
1631
except BaseException:
1635
# Cache of realpath results, to speed up canonical_path
1636
self._realpaths = {}
1637
# Cache of relpath results, to speed up canonical_path
1639
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1640
tree.case_sensitive)
1641
self._deletiondir = deletiondir
1643
def canonical_path(self, path):
1644
"""Get the canonical tree-relative path"""
1645
# don't follow final symlinks
1646
abs = self._tree.abspath(path)
1647
if abs in self._relpaths:
1648
return self._relpaths[abs]
1649
dirname, basename = os.path.split(abs)
1650
if dirname not in self._realpaths:
1651
self._realpaths[dirname] = os.path.realpath(dirname)
1652
dirname = self._realpaths[dirname]
1653
abs = pathjoin(dirname, basename)
1654
if dirname in self._relpaths:
1655
relpath = pathjoin(self._relpaths[dirname], basename)
1656
relpath = relpath.rstrip('/\\')
1658
relpath = self._tree.relpath(abs)
1659
self._relpaths[abs] = relpath
1662
def tree_kind(self, trans_id):
1663
"""Determine the file kind in the working tree.
1665
:returns: The file kind or None if the file does not exist
1667
path = self._tree_id_paths.get(trans_id)
1671
return file_kind(self._tree.abspath(path))
1672
except errors.NoSuchFile:
1675
def _set_mode(self, trans_id, mode_id, typefunc):
1676
"""Set the mode of new file contents.
1677
The mode_id is the existing file to get the mode from (often the same
1678
as trans_id). The operation is only performed if there's a mode match
1679
according to typefunc.
1684
old_path = self._tree_id_paths[mode_id]
1688
mode = os.stat(self._tree.abspath(old_path)).st_mode
1689
except OSError as e:
1690
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1691
# Either old_path doesn't exist, or the parent of the
1692
# target is not a directory (but will be one eventually)
1693
# Either way, we know it doesn't exist *right now*
1694
# See also bug #248448
1699
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1701
def iter_tree_children(self, parent_id):
1702
"""Iterate through the entry's tree children, if any"""
1704
path = self._tree_id_paths[parent_id]
1708
children = os.listdir(self._tree.abspath(path))
1709
except OSError as e:
1710
if not (osutils._is_error_enotdir(e) or
1711
e.errno in (errno.ENOENT, errno.ESRCH)):
1715
for child in children:
1716
childpath = joinpath(path, child)
1717
if self._tree.is_control_filename(childpath):
1719
yield self.trans_id_tree_path(childpath)
1721
def _generate_limbo_path(self, trans_id):
1722
"""Generate a limbo path using the final path if possible.
1724
This optimizes the performance of applying the tree transform by
1725
avoiding renames. These renames can be avoided only when the parent
1726
directory is already scheduled for creation.
1728
If the final path cannot be used, falls back to using the trans_id as
1731
parent = self._new_parent.get(trans_id)
1732
# if the parent directory is already in limbo (e.g. when building a
1733
# tree), choose a limbo name inside the parent, to reduce further
1735
use_direct_path = False
1736
if self._new_contents.get(parent) == 'directory':
1737
filename = self._new_name.get(trans_id)
1738
if filename is not None:
1739
if parent not in self._limbo_children:
1740
self._limbo_children[parent] = set()
1741
self._limbo_children_names[parent] = {}
1742
use_direct_path = True
1743
# the direct path can only be used if no other file has
1744
# already taken this pathname, i.e. if the name is unused, or
1745
# if it is already associated with this trans_id.
1746
elif self._case_sensitive_target:
1747
if (self._limbo_children_names[parent].get(filename)
1748
in (trans_id, None)):
1749
use_direct_path = True
1751
for l_filename, l_trans_id in viewitems(
1752
self._limbo_children_names[parent]):
1753
if l_trans_id == trans_id:
1755
if l_filename.lower() == filename.lower():
1758
use_direct_path = True
1760
if not use_direct_path:
1761
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1763
limbo_name = pathjoin(self._limbo_files[parent], filename)
1764
self._limbo_children[parent].add(trans_id)
1765
self._limbo_children_names[parent][filename] = trans_id
1768
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1769
"""Apply all changes to the inventory and filesystem.
1771
If filesystem or inventory conflicts are present, MalformedTransform
1774
If apply succeeds, finalize is not necessary.
1776
:param no_conflicts: if True, the caller guarantees there are no
1777
conflicts, so no check is made.
1778
:param precomputed_delta: An inventory delta to use instead of
1780
:param _mover: Supply an alternate FileMover, for testing
1782
for hook in MutableTree.hooks['pre_transform']:
1783
hook(self._tree, self)
1784
if not no_conflicts:
1785
self._check_malformed()
1786
with ui.ui_factory.nested_progress_bar() as child_pb:
1787
if precomputed_delta is None:
1788
child_pb.update(gettext('Apply phase'), 0, 2)
1789
inventory_delta = self._generate_inventory_delta()
1792
inventory_delta = precomputed_delta
1795
mover = _FileMover()
1799
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1800
self._apply_removals(mover)
1801
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1802
modified_paths = self._apply_insertions(mover)
1803
except BaseException:
1807
mover.apply_deletions()
1808
if self.final_file_id(self.root) is None:
1809
inventory_delta = [e for e in inventory_delta if e[0] != '']
1810
self._tree.apply_inventory_delta(inventory_delta)
1811
self._apply_observed_sha1s()
1814
return _TransformResults(modified_paths, self.rename_count)
1816
def _generate_inventory_delta(self):
1817
"""Generate an inventory delta for the current transform."""
1818
inventory_delta = []
1819
new_paths = self._inventory_altered()
1820
total_entries = len(new_paths) + len(self._removed_id)
1821
with ui.ui_factory.nested_progress_bar() as child_pb:
1822
for num, trans_id in enumerate(self._removed_id):
1824
child_pb.update(gettext('removing file'),
1826
if trans_id == self._new_root:
1827
file_id = self._tree.path2id('')
1829
file_id = self.tree_file_id(trans_id)
1830
# File-id isn't really being deleted, just moved
1831
if file_id in self._r_new_id:
1833
path = self._tree_id_paths[trans_id]
1834
inventory_delta.append((path, None, file_id, None))
1835
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1837
for num, (path, trans_id) in enumerate(new_paths):
1839
child_pb.update(gettext('adding file'),
1840
num + len(self._removed_id), total_entries)
1841
file_id = new_path_file_ids[trans_id]
1844
kind = self.final_kind(trans_id)
1846
kind = self._tree.stored_kind(self._tree.id2path(file_id))
1847
parent_trans_id = self.final_parent(trans_id)
1848
parent_file_id = new_path_file_ids.get(parent_trans_id)
1849
if parent_file_id is None:
1850
parent_file_id = self.final_file_id(parent_trans_id)
1851
if trans_id in self._new_reference_revision:
1852
new_entry = inventory.TreeReference(
1854
self._new_name[trans_id],
1855
self.final_file_id(self._new_parent[trans_id]),
1856
None, self._new_reference_revision[trans_id])
1858
new_entry = inventory.make_entry(kind,
1859
self.final_name(trans_id),
1860
parent_file_id, file_id)
1862
old_path = self._tree.id2path(new_entry.file_id)
1863
except errors.NoSuchId:
1865
new_executability = self._new_executability.get(trans_id)
1866
if new_executability is not None:
1867
new_entry.executable = new_executability
1868
inventory_delta.append(
1869
(old_path, path, new_entry.file_id, new_entry))
1870
return inventory_delta
1872
def _apply_removals(self, mover):
1873
"""Perform tree operations that remove directory/inventory names.
1875
That is, delete files that are to be deleted, and put any files that
1876
need renaming into limbo. This must be done in strict child-to-parent
1879
If inventory_delta is None, no inventory delta generation is performed.
1881
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1882
with ui.ui_factory.nested_progress_bar() as child_pb:
1883
for num, (path, trans_id) in enumerate(tree_paths):
1884
# do not attempt to move root into a subdirectory of itself.
1887
child_pb.update(gettext('removing file'), num, len(tree_paths))
1888
full_path = self._tree.abspath(path)
1889
if trans_id in self._removed_contents:
1890
delete_path = os.path.join(self._deletiondir, trans_id)
1891
mover.pre_delete(full_path, delete_path)
1892
elif (trans_id in self._new_name or
1893
trans_id in self._new_parent):
1895
mover.rename(full_path, self._limbo_name(trans_id))
1896
except errors.TransformRenameFailed as e:
1897
if e.errno != errno.ENOENT:
1900
self.rename_count += 1
1902
def _apply_insertions(self, mover):
1903
"""Perform tree operations that insert directory/inventory names.
1905
That is, create any files that need to be created, and restore from
1906
limbo any files that needed renaming. This must be done in strict
1907
parent-to-child order.
1909
If inventory_delta is None, no inventory delta is calculated, and
1910
no list of modified paths is returned.
1912
new_paths = self.new_paths(filesystem_only=True)
1914
with ui.ui_factory.nested_progress_bar() as child_pb:
1915
for num, (path, trans_id) in enumerate(new_paths):
1917
child_pb.update(gettext('adding file'),
1918
num, len(new_paths))
1919
full_path = self._tree.abspath(path)
1920
if trans_id in self._needs_rename:
1922
mover.rename(self._limbo_name(trans_id), full_path)
1923
except errors.TransformRenameFailed as e:
1924
# We may be renaming a dangling inventory id
1925
if e.errno != errno.ENOENT:
1928
self.rename_count += 1
1929
# TODO: if trans_id in self._observed_sha1s, we should
1930
# re-stat the final target, since ctime will be
1931
# updated by the change.
1932
if (trans_id in self._new_contents
1933
or self.path_changed(trans_id)):
1934
if trans_id in self._new_contents:
1935
modified_paths.append(full_path)
1936
if trans_id in self._new_executability:
1937
self._set_executability(path, trans_id)
1938
if trans_id in self._observed_sha1s:
1939
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1940
st = osutils.lstat(full_path)
1941
self._observed_sha1s[trans_id] = (o_sha1, st)
1942
for path, trans_id in new_paths:
1943
# new_paths includes stuff like workingtree conflicts. Only the
1944
# stuff in new_contents actually comes from limbo.
1945
if trans_id in self._limbo_files:
1946
del self._limbo_files[trans_id]
1947
self._new_contents.clear()
1948
return modified_paths
1950
def _apply_observed_sha1s(self):
1951
"""After we have finished renaming everything, update observed sha1s
1953
This has to be done after self._tree.apply_inventory_delta, otherwise
1954
it doesn't know anything about the files we are updating. Also, we want
1955
to do this as late as possible, so that most entries end up cached.
1957
# TODO: this doesn't update the stat information for directories. So
1958
# the first 'bzr status' will still need to rewrite
1959
# .bzr/checkout/dirstate. However, we at least don't need to
1960
# re-read all of the files.
1961
# TODO: If the operation took a while, we could do a time.sleep(3) here
1962
# to allow the clock to tick over and ensure we won't have any
1963
# problems. (we could observe start time, and finish time, and if
1964
# it is less than eg 10% overhead, add a sleep call.)
1965
paths = FinalPaths(self)
1966
for trans_id, observed in viewitems(self._observed_sha1s):
1967
path = paths.get_path(trans_id)
1968
self._tree._observed_sha1(path, observed)
1971
class TransformPreview(DiskTreeTransform):
1972
"""A TreeTransform for generating preview trees.
1974
Unlike TreeTransform, this version works when the input tree is a
1975
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1976
unversioned files in the input tree.
1979
def __init__(self, tree, pb=None, case_sensitive=True):
1981
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1982
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1984
def canonical_path(self, path):
1987
def tree_kind(self, trans_id):
1988
path = self._tree_id_paths.get(trans_id)
1991
kind = self._tree.path_content_summary(path)[0]
1992
if kind == 'missing':
1996
def _set_mode(self, trans_id, mode_id, typefunc):
1997
"""Set the mode of new file contents.
1998
The mode_id is the existing file to get the mode from (often the same
1999
as trans_id). The operation is only performed if there's a mode match
2000
according to typefunc.
2002
# is it ok to ignore this? probably
2005
def iter_tree_children(self, parent_id):
2006
"""Iterate through the entry's tree children, if any"""
2008
path = self._tree_id_paths[parent_id]
2012
entry = next(self._tree.iter_entries_by_dir(
2013
specific_files=[path]))[1]
2014
except StopIteration:
2016
children = getattr(entry, 'children', {})
2017
for child in children:
2018
childpath = joinpath(path, child)
2019
yield self.trans_id_tree_path(childpath)
2021
def new_orphan(self, trans_id, parent_id):
2022
raise NotImplementedError(self.new_orphan)
2025
class _PreviewTree(inventorytree.InventoryTree):
2026
"""Partial implementation of Tree to support show_diff_trees"""
2028
def __init__(self, transform):
2029
self._transform = transform
2030
self._final_paths = FinalPaths(transform)
2031
self.__by_parent = None
2032
self._parent_ids = []
2033
self._all_children_cache = {}
2034
self._path2trans_id_cache = {}
2035
self._final_name_cache = {}
2036
self._iter_changes_cache = dict((c.file_id, c) for c in
2037
self._transform.iter_changes())
2039
def supports_tree_reference(self):
2040
# TODO(jelmer): Support tree references in _PreviewTree.
2041
# return self._transform._tree.supports_tree_reference()
2044
def _content_change(self, file_id):
2045
"""Return True if the content of this file changed"""
2046
changes = self._iter_changes_cache.get(file_id)
2047
return (changes is not None and changes.changed_content)
2049
def _get_repository(self):
2050
repo = getattr(self._transform._tree, '_repository', None)
2052
repo = self._transform._tree.branch.repository
2055
def _iter_parent_trees(self):
2056
for revision_id in self.get_parent_ids():
2058
yield self.revision_tree(revision_id)
2059
except errors.NoSuchRevisionInTree:
2060
yield self._get_repository().revision_tree(revision_id)
2062
def _get_file_revision(self, path, file_id, vf, tree_revision):
2064
(file_id, t.get_file_revision(t.id2path(file_id)))
2065
for t in self._iter_parent_trees()]
2066
vf.add_lines((file_id, tree_revision), parent_keys,
2067
self.get_file_lines(path))
2068
repo = self._get_repository()
2069
base_vf = repo.texts
2070
if base_vf not in vf.fallback_versionedfiles:
2071
vf.fallback_versionedfiles.append(base_vf)
2072
return tree_revision
2074
def _stat_limbo_file(self, trans_id):
2075
name = self._transform._limbo_name(trans_id)
2076
return os.lstat(name)
2079
def _by_parent(self):
2080
if self.__by_parent is None:
2081
self.__by_parent = self._transform.by_parent()
2082
return self.__by_parent
2084
def _comparison_data(self, entry, path):
2085
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2086
if kind == 'missing':
2090
file_id = self._transform.final_file_id(self._path2trans_id(path))
2091
executable = self.is_executable(path)
2092
return kind, executable, None
2094
def is_locked(self):
2097
def lock_read(self):
2098
# Perhaps in theory, this should lock the TreeTransform?
2099
return lock.LogicalLockResult(self.unlock)
2105
def root_inventory(self):
2106
"""This Tree does not use inventory as its backing data."""
2107
raise NotImplementedError(_PreviewTree.root_inventory)
2109
def all_file_ids(self):
2110
tree_ids = set(self._transform._tree.all_file_ids())
2111
tree_ids.difference_update(self._transform.tree_file_id(t)
2112
for t in self._transform._removed_id)
2113
tree_ids.update(viewvalues(self._transform._new_id))
2116
def all_versioned_paths(self):
2117
tree_paths = set(self._transform._tree.all_versioned_paths())
2119
tree_paths.difference_update(
2120
self._transform.trans_id_tree_path(t)
2121
for t in self._transform._removed_id)
2124
self._final_paths._determine_path(t)
2125
for t in self._transform._new_id)
2129
def _path2trans_id(self, path):
2130
# We must not use None here, because that is a valid value to store.
2131
trans_id = self._path2trans_id_cache.get(path, object)
2132
if trans_id is not object:
2134
segments = splitpath(path)
2135
cur_parent = self._transform.root
2136
for cur_segment in segments:
2137
for child in self._all_children(cur_parent):
2138
final_name = self._final_name_cache.get(child)
2139
if final_name is None:
2140
final_name = self._transform.final_name(child)
2141
self._final_name_cache[child] = final_name
2142
if final_name == cur_segment:
2146
self._path2trans_id_cache[path] = None
2148
self._path2trans_id_cache[path] = cur_parent
2151
def path2id(self, path):
2152
if isinstance(path, list):
2155
path = osutils.pathjoin(*path)
2156
return self._transform.final_file_id(self._path2trans_id(path))
2158
def id2path(self, file_id, recurse='down'):
2159
trans_id = self._transform.trans_id_file_id(file_id)
2161
return self._final_paths._determine_path(trans_id)
2163
raise errors.NoSuchId(self, file_id)
2165
def _all_children(self, trans_id):
2166
children = self._all_children_cache.get(trans_id)
2167
if children is not None:
2169
children = set(self._transform.iter_tree_children(trans_id))
2170
# children in the _new_parent set are provided by _by_parent.
2171
children.difference_update(self._transform._new_parent)
2172
children.update(self._by_parent.get(trans_id, []))
2173
self._all_children_cache[trans_id] = children
2177
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2178
in self._transform._tree.extras())
2179
possible_extras.update(self._transform._new_contents)
2180
possible_extras.update(self._transform._removed_id)
2181
for trans_id in possible_extras:
2182
if self._transform.final_file_id(trans_id) is None:
2183
yield self._final_paths._determine_path(trans_id)
2185
def _make_inv_entries(self, ordered_entries, specific_files=None):
2186
for trans_id, parent_file_id in ordered_entries:
2187
file_id = self._transform.final_file_id(trans_id)
2190
if (specific_files is not None
2191
and self._final_paths.get_path(trans_id) not in specific_files):
2193
kind = self._transform.final_kind(trans_id)
2195
kind = self._transform._tree.stored_kind(
2196
self._transform._tree.id2path(file_id))
2197
new_entry = inventory.make_entry(
2199
self._transform.final_name(trans_id),
2200
parent_file_id, file_id)
2201
yield new_entry, trans_id
2203
def _list_files_by_dir(self):
2204
todo = [ROOT_PARENT]
2206
while len(todo) > 0:
2208
parent_file_id = self._transform.final_file_id(parent)
2209
children = list(self._all_children(parent))
2210
paths = dict(zip(children, self._final_paths.get_paths(children)))
2211
children.sort(key=paths.get)
2212
todo.extend(reversed(children))
2213
for trans_id in children:
2214
ordered_ids.append((trans_id, parent_file_id))
2217
def iter_child_entries(self, path):
2218
trans_id = self._path2trans_id(path)
2219
if trans_id is None:
2220
raise errors.NoSuchFile(path)
2221
todo = [(child_trans_id, trans_id) for child_trans_id in
2222
self._all_children(trans_id)]
2223
for entry, trans_id in self._make_inv_entries(todo):
2226
def iter_entries_by_dir(self, specific_files=None, recurse_nested=False):
2228
raise NotImplementedError(
2229
'follow tree references not yet supported')
2231
# This may not be a maximally efficient implementation, but it is
2232
# reasonably straightforward. An implementation that grafts the
2233
# TreeTransform changes onto the tree's iter_entries_by_dir results
2234
# might be more efficient, but requires tricky inferences about stack
2236
ordered_ids = self._list_files_by_dir()
2237
for entry, trans_id in self._make_inv_entries(ordered_ids,
2239
yield self._final_paths.get_path(trans_id), entry
2241
def _iter_entries_for_dir(self, dir_path):
2242
"""Return path, entry for items in a directory without recursing down."""
2244
dir_trans_id = self._path2trans_id(dir_path)
2245
dir_id = self._transform.final_file_id(dir_trans_id)
2246
for child_trans_id in self._all_children(dir_trans_id):
2247
ordered_ids.append((child_trans_id, dir_id))
2249
for entry, trans_id in self._make_inv_entries(ordered_ids):
2250
path_entries.append((self._final_paths.get_path(trans_id), entry))
2254
def list_files(self, include_root=False, from_dir=None, recursive=True,
2255
recurse_nested=False):
2256
"""See WorkingTree.list_files."""
2258
raise NotImplementedError(
2259
'follow tree references not yet supported')
2261
# XXX This should behave like WorkingTree.list_files, but is really
2262
# more like RevisionTree.list_files.
2268
prefix = from_dir + '/'
2269
entries = self.iter_entries_by_dir()
2270
for path, entry in entries:
2271
if entry.name == '' and not include_root:
2274
if not path.startswith(prefix):
2276
path = path[len(prefix):]
2277
yield path, 'V', entry.kind, entry
2279
if from_dir is None and include_root is True:
2280
root_entry = inventory.make_entry(
2281
'directory', '', ROOT_PARENT, self.path2id(''))
2282
yield '', 'V', 'directory', root_entry
2283
entries = self._iter_entries_for_dir(from_dir or '')
2284
for path, entry in entries:
2285
yield path, 'V', entry.kind, entry
2287
def kind(self, path):
2288
trans_id = self._path2trans_id(path)
2289
if trans_id is None:
2290
raise errors.NoSuchFile(path)
2291
return self._transform.final_kind(trans_id)
2293
def stored_kind(self, path):
2294
trans_id = self._path2trans_id(path)
2295
if trans_id is None:
2296
raise errors.NoSuchFile(path)
2298
return self._transform._new_contents[trans_id]
2300
return self._transform._tree.stored_kind(path)
2302
def get_file_mtime(self, path):
2303
"""See Tree.get_file_mtime"""
2304
file_id = self.path2id(path)
2306
raise errors.NoSuchFile(path)
2307
if not self._content_change(file_id):
2308
return self._transform._tree.get_file_mtime(
2309
self._transform._tree.id2path(file_id))
2310
trans_id = self._path2trans_id(path)
2311
return self._stat_limbo_file(trans_id).st_mtime
2313
def get_file_size(self, path):
2314
"""See Tree.get_file_size"""
2315
trans_id = self._path2trans_id(path)
2316
if trans_id is None:
2317
raise errors.NoSuchFile(path)
2318
kind = self._transform.final_kind(trans_id)
2321
if trans_id in self._transform._new_contents:
2322
return self._stat_limbo_file(trans_id).st_size
2323
if self.kind(path) == 'file':
2324
return self._transform._tree.get_file_size(path)
2328
def get_file_verifier(self, path, stat_value=None):
2329
trans_id = self._path2trans_id(path)
2330
if trans_id is None:
2331
raise errors.NoSuchFile(path)
2332
kind = self._transform._new_contents.get(trans_id)
2334
return self._transform._tree.get_file_verifier(path)
2336
with self.get_file(path) as fileobj:
2337
return ("SHA1", sha_file(fileobj))
2339
def get_file_sha1(self, path, stat_value=None):
2340
trans_id = self._path2trans_id(path)
2341
if trans_id is None:
2342
raise errors.NoSuchFile(path)
2343
kind = self._transform._new_contents.get(trans_id)
2345
return self._transform._tree.get_file_sha1(path)
2347
with self.get_file(path) as fileobj:
2348
return sha_file(fileobj)
2350
def get_reference_revision(self, path):
2351
trans_id = self._path2trans_id(path)
2352
if trans_id is None:
2353
raise errors.NoSuchFile(path)
2354
reference_revision = self._transform._new_reference_revision.get(trans_id)
2355
if reference_revision is None:
2356
return self._transform._tree.get_reference_revision(path)
2357
return reference_revision
2359
def is_executable(self, path):
2360
trans_id = self._path2trans_id(path)
2361
if trans_id is None:
2364
return self._transform._new_executability[trans_id]
2367
return self._transform._tree.is_executable(path)
2368
except OSError as e:
2369
if e.errno == errno.ENOENT:
2372
except errors.NoSuchFile:
2375
def has_filename(self, path):
2376
trans_id = self._path2trans_id(path)
2377
if trans_id in self._transform._new_contents:
2379
elif trans_id in self._transform._removed_contents:
2382
return self._transform._tree.has_filename(path)
2384
def path_content_summary(self, path):
2385
trans_id = self._path2trans_id(path)
2386
tt = self._transform
2387
tree_path = tt._tree_id_paths.get(trans_id)
2388
kind = tt._new_contents.get(trans_id)
2390
if tree_path is None or trans_id in tt._removed_contents:
2391
return 'missing', None, None, None
2392
summary = tt._tree.path_content_summary(tree_path)
2393
kind, size, executable, link_or_sha1 = summary
2396
limbo_name = tt._limbo_name(trans_id)
2397
if trans_id in tt._new_reference_revision:
2398
kind = 'tree-reference'
2400
statval = os.lstat(limbo_name)
2401
size = statval.st_size
2402
if not tt._limbo_supports_executable():
2405
executable = statval.st_mode & S_IEXEC
2409
if kind == 'symlink':
2410
link_or_sha1 = os.readlink(limbo_name)
2411
if not isinstance(link_or_sha1, text_type):
2412
link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2413
executable = tt._new_executability.get(trans_id, executable)
2414
return kind, size, executable, link_or_sha1
2416
def iter_changes(self, from_tree, include_unchanged=False,
2417
specific_files=None, pb=None, extra_trees=None,
2418
require_versioned=True, want_unversioned=False):
2419
"""See InterTree.iter_changes.
2421
This has a fast path that is only used when the from_tree matches
2422
the transform tree, and no fancy options are supplied.
2424
if (from_tree is not self._transform._tree or include_unchanged
2425
or specific_files or want_unversioned):
2426
return tree.InterTree(from_tree, self).iter_changes(
2427
include_unchanged=include_unchanged,
2428
specific_files=specific_files,
2430
extra_trees=extra_trees,
2431
require_versioned=require_versioned,
2432
want_unversioned=want_unversioned)
2433
if want_unversioned:
2434
raise ValueError('want_unversioned is not supported')
2435
return self._transform.iter_changes()
2437
def get_file(self, path):
2438
"""See Tree.get_file"""
2439
file_id = self.path2id(path)
2440
if not self._content_change(file_id):
2441
return self._transform._tree.get_file(path)
2442
trans_id = self._path2trans_id(path)
2443
name = self._transform._limbo_name(trans_id)
2444
return open(name, 'rb')
2446
def get_file_with_stat(self, path):
2447
return self.get_file(path), None
2449
def annotate_iter(self, path,
2450
default_revision=_mod_revision.CURRENT_REVISION):
2451
file_id = self.path2id(path)
2452
changes = self._iter_changes_cache.get(file_id)
2456
changed_content, versioned, kind = (
2457
changes.changed_content, changes.versioned, changes.kind)
2460
get_old = (kind[0] == 'file' and versioned[0])
2462
old_annotation = self._transform._tree.annotate_iter(
2463
path, default_revision=default_revision)
2467
return old_annotation
2468
if not changed_content:
2469
return old_annotation
2470
# TODO: This is doing something similar to what WT.annotate_iter is
2471
# doing, however it fails slightly because it doesn't know what
2472
# the *other* revision_id is, so it doesn't know how to give the
2473
# other as the origin for some lines, they all get
2474
# 'default_revision'
2475
# It would be nice to be able to use the new Annotator based
2476
# approach, as well.
2477
return annotate.reannotate([old_annotation],
2478
self.get_file(path).readlines(),
2481
def get_symlink_target(self, path):
2482
"""See Tree.get_symlink_target"""
2483
file_id = self.path2id(path)
2484
if not self._content_change(file_id):
2485
return self._transform._tree.get_symlink_target(path)
2486
trans_id = self._path2trans_id(path)
2487
name = self._transform._limbo_name(trans_id)
2488
return osutils.readlink(name)
2490
def walkdirs(self, prefix=''):
2491
pending = [self._transform.root]
2492
while len(pending) > 0:
2493
parent_id = pending.pop()
2496
prefix = prefix.rstrip('/')
2497
parent_path = self._final_paths.get_path(parent_id)
2498
parent_file_id = self._transform.final_file_id(parent_id)
2499
for child_id in self._all_children(parent_id):
2500
path_from_root = self._final_paths.get_path(child_id)
2501
basename = self._transform.final_name(child_id)
2502
file_id = self._transform.final_file_id(child_id)
2503
kind = self._transform.final_kind(child_id)
2504
if kind is not None:
2505
versioned_kind = kind
2508
versioned_kind = self._transform._tree.stored_kind(
2509
self._transform._tree.id2path(file_id))
2510
if versioned_kind == 'directory':
2511
subdirs.append(child_id)
2512
children.append((path_from_root, basename, kind, None,
2513
file_id, versioned_kind))
2515
if parent_path.startswith(prefix):
2516
yield (parent_path, parent_file_id), children
2517
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2520
def get_parent_ids(self):
2521
return self._parent_ids
2523
def set_parent_ids(self, parent_ids):
2524
self._parent_ids = parent_ids
2526
def get_revision_tree(self, revision_id):
2527
return self._transform._tree.get_revision_tree(revision_id)
599
2530
def joinpath(parent, child):
600
2531
"""Join tree-relative paths, handling the tree root specially"""
601
2532
if parent is None or parent == "":
added
removed
breezy/transform.py
