838
873
self.add(path, file_id, 'directory')
841
def get_symlink_target(self, file_id, path=None):
843
abspath = self.abspath(path)
845
abspath = self.id2abspath(file_id)
846
target = osutils.readlink(abspath)
876
def get_symlink_target(self, file_id):
877
file_id = osutils.safe_file_id(file_id)
878
return os.readlink(self.id2abspath(file_id))
849
881
def subsume(self, other_tree):
850
raise NotImplementedError(self.subsume)
852
def _setup_directory_is_tree_reference(self):
853
if self._branch.repository._format.supports_tree_reference:
854
self._directory_is_tree_reference = \
855
self._directory_may_be_tree_reference
857
self._directory_is_tree_reference = \
858
self._directory_is_never_tree_reference
860
def _directory_is_never_tree_reference(self, relpath):
863
def _directory_may_be_tree_reference(self, relpath):
864
# as a special case, if a directory contains control files then
865
# it's a tree reference, except that the root of the tree is not
866
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
867
# TODO: We could ask all the control formats whether they
868
# recognize this directory, but at the moment there's no cheap api
869
# to do that. Since we probably can only nest bzr checkouts and
870
# they always use this name it's ok for now. -- mbp 20060306
872
# FIXME: There is an unhandled case here of a subdirectory
873
# containing .bzr but not a branch; that will probably blow up
874
# when you try to commit it. It might happen if there is a
875
# checkout in a subdirectory. This can be avoided by not adding
882
def add_children(inventory, entry):
883
for child_entry in entry.children.values():
884
inventory._byid[child_entry.file_id] = child_entry
885
if child_entry.kind == 'directory':
886
add_children(inventory, child_entry)
887
if other_tree.get_root_id() == self.get_root_id():
888
raise errors.BadSubsumeSource(self, other_tree,
889
'Trees have the same root')
891
other_tree_path = self.relpath(other_tree.basedir)
892
except errors.PathNotChild:
893
raise errors.BadSubsumeSource(self, other_tree,
894
'Tree is not contained by the other')
895
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
896
if new_root_parent is None:
897
raise errors.BadSubsumeSource(self, other_tree,
898
'Parent directory is not versioned.')
899
# We need to ensure that the result of a fetch will have a
900
# versionedfile for the other_tree root, and only fetching into
901
# RepositoryKnit2 guarantees that.
902
if not self.branch.repository.supports_rich_root():
903
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
904
other_tree.lock_tree_write()
906
new_parents = other_tree.get_parent_ids()
907
other_root = other_tree.inventory.root
908
other_root.parent_id = new_root_parent
909
other_root.name = osutils.basename(other_tree_path)
910
self.inventory.add(other_root)
911
add_children(self.inventory, other_root)
912
self._write_inventory(self.inventory)
913
# normally we don't want to fetch whole repositories, but i think
914
# here we really do want to consolidate the whole thing.
915
for parent_id in other_tree.get_parent_ids():
916
self.branch.fetch(other_tree.branch, parent_id)
917
self.add_parent_tree_id(parent_id)
920
other_tree.bzrdir.retire_bzrdir()
922
@needs_tree_write_lock
878
923
def extract(self, file_id, format=None):
879
924
"""Extract a subtree from this tree.
881
926
A new branch will be created, relative to the path for this tree.
883
raise NotImplementedError(self.extract)
930
segments = osutils.splitpath(path)
931
transport = self.branch.bzrdir.root_transport
932
for name in segments:
933
transport = transport.clone(name)
936
except errors.FileExists:
940
sub_path = self.id2path(file_id)
941
branch_transport = mkdirs(sub_path)
943
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
945
branch_transport.mkdir('.')
946
except errors.FileExists:
948
branch_bzrdir = format.initialize_on_transport(branch_transport)
950
repo = branch_bzrdir.find_repository()
951
except errors.NoRepositoryPresent:
952
repo = branch_bzrdir.create_repository()
953
assert repo.supports_rich_root()
955
if not repo.supports_rich_root():
956
raise errors.RootNotRich()
957
new_branch = branch_bzrdir.create_branch()
958
new_branch.pull(self.branch)
959
for parent_id in self.get_parent_ids():
960
new_branch.fetch(self.branch, parent_id)
961
tree_transport = self.bzrdir.root_transport.clone(sub_path)
962
if tree_transport.base != branch_transport.base:
963
tree_bzrdir = format.initialize_on_transport(tree_transport)
964
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
966
tree_bzrdir = branch_bzrdir
967
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
968
wt.set_parent_ids(self.get_parent_ids())
969
my_inv = self.inventory
970
child_inv = Inventory(root_id=None)
971
new_root = my_inv[file_id]
972
my_inv.remove_recursive_id(file_id)
973
new_root.parent_id = None
974
child_inv.add(new_root)
975
self._write_inventory(my_inv)
976
wt._write_inventory(child_inv)
979
def _serialize(self, inventory, out_file):
980
xml5.serializer_v5.write_inventory(self._inventory, out_file)
982
def _deserialize(selt, in_file):
983
return xml5.serializer_v5.read_inventory(in_file)
886
"""Write the in memory meta data to disk."""
887
raise NotImplementedError(self.flush)
986
"""Write the in memory inventory to disk."""
987
# TODO: Maybe this should only write on dirty ?
988
if self._control_files._lock_mode != 'w':
989
raise errors.NotWriteLocked(self)
991
self._serialize(self._inventory, sio)
993
self._control_files.put('inventory', sio)
994
self._inventory_is_modified = False
889
996
def _kind(self, relpath):
890
997
return osutils.file_kind(self.abspath(relpath))
892
def list_files(self, include_root=False, from_dir=None, recursive=True):
893
"""List all files as (path, class, kind, id, entry).
999
def list_files(self, include_root=False):
1000
"""Recursively list all files as (path, class, kind, id, entry).
895
1002
Lists, but does not descend into unversioned directories.
896
1004
This does not include files that have been deleted in this
897
tree. Skips the control directory.
899
:param include_root: if True, return an entry for the root
900
:param from_dir: start from this directory or None for the root
901
:param recursive: whether to recurse into subdirectories or not
1007
Skips the control directory.
903
raise NotImplementedError(self.list_files)
905
def move(self, from_paths, to_dir=None, after=False):
1009
# list_files is an iterator, so @needs_read_lock doesn't work properly
1010
# with it. So callers should be careful to always read_lock the tree.
1011
if not self.is_locked():
1012
raise errors.ObjectNotLocked(self)
1014
inv = self.inventory
1015
if include_root is True:
1016
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1017
# Convert these into local objects to save lookup times
1018
pathjoin = osutils.pathjoin
1019
file_kind = self._kind
1021
# transport.base ends in a slash, we want the piece
1022
# between the last two slashes
1023
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1025
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1027
# directory file_id, relative path, absolute path, reverse sorted children
1028
children = os.listdir(self.basedir)
1030
# jam 20060527 The kernel sized tree seems equivalent whether we
1031
# use a deque and popleft to keep them sorted, or if we use a plain
1032
# list and just reverse() them.
1033
children = collections.deque(children)
1034
stack = [(inv.root.file_id, u'', self.basedir, children)]
1036
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1039
f = children.popleft()
1040
## TODO: If we find a subdirectory with its own .bzr
1041
## directory, then that is a separate tree and we
1042
## should exclude it.
1044
# the bzrdir for this tree
1045
if transport_base_dir == f:
1048
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1049
# and 'f' doesn't begin with one, we can do a string op, rather
1050
# than the checks of pathjoin(), all relative paths will have an extra slash
1052
fp = from_dir_relpath + '/' + f
1055
fap = from_dir_abspath + '/' + f
1057
f_ie = inv.get_child(from_dir_id, f)
1060
elif self.is_ignored(fp[1:]):
1063
# we may not have found this file, because of a unicode issue
1064
f_norm, can_access = osutils.normalized_filename(f)
1065
if f == f_norm or not can_access:
1066
# No change, so treat this file normally
1069
# this file can be accessed by a normalized path
1070
# check again if it is versioned
1071
# these lines are repeated here for performance
1073
fp = from_dir_relpath + '/' + f
1074
fap = from_dir_abspath + '/' + f
1075
f_ie = inv.get_child(from_dir_id, f)
1078
elif self.is_ignored(fp[1:]):
1085
# make a last minute entry
1087
yield fp[1:], c, fk, f_ie.file_id, f_ie
1090
yield fp[1:], c, fk, None, fk_entries[fk]()
1092
yield fp[1:], c, fk, None, TreeEntry()
1095
if fk != 'directory':
1098
# But do this child first
1099
new_children = os.listdir(fap)
1101
new_children = collections.deque(new_children)
1102
stack.append((f_ie.file_id, fp, fap, new_children))
1103
# Break out of inner loop,
1104
# so that we start outer loop with child
1107
# if we finished all children, pop it off the stack
1110
@needs_tree_write_lock
1111
def move(self, from_paths, to_dir=None, after=False, **kwargs):
906
1112
"""Rename files.
908
to_dir must be known to the working tree.
1114
to_dir must exist in the inventory.
910
1116
If to_dir exists and is a directory, the files are moved into
911
it, keeping their old names.
1117
it, keeping their old names.
913
1119
Note that to_dir is only the last component of the new name;
914
1120
this doesn't change the directory.
1155
1624
@needs_read_lock
1156
1625
def _last_revision(self):
1157
1626
"""helper for get_parent_ids."""
1158
return _mod_revision.ensure_null(self.branch.last_revision())
1627
return self.branch.last_revision()
1160
1629
def is_locked(self):
1161
"""Check if this tree is locked."""
1162
raise NotImplementedError(self.is_locked)
1630
return self._control_files.is_locked()
1632
def _must_be_locked(self):
1633
if not self.is_locked():
1634
raise errors.ObjectNotLocked(self)
1164
1636
def lock_read(self):
1165
"""Lock the tree for reading.
1167
This also locks the branch, and can be unlocked via self.unlock().
1169
:return: A bzrlib.lock.LogicalLockResult.
1171
raise NotImplementedError(self.lock_read)
1637
"""See Branch.lock_read, and WorkingTree.unlock."""
1638
if not self.is_locked():
1640
self.branch.lock_read()
1642
return self._control_files.lock_read()
1644
self.branch.unlock()
1173
1647
def lock_tree_write(self):
1174
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1176
:return: A bzrlib.lock.LogicalLockResult.
1178
raise NotImplementedError(self.lock_tree_write)
1648
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1649
if not self.is_locked():
1651
self.branch.lock_read()
1653
return self._control_files.lock_write()
1655
self.branch.unlock()
1180
1658
def lock_write(self):
1181
"""See MutableTree.lock_write, and WorkingTree.unlock.
1183
:return: A bzrlib.lock.LogicalLockResult.
1185
raise NotImplementedError(self.lock_write)
1659
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1660
if not self.is_locked():
1662
self.branch.lock_write()
1664
return self._control_files.lock_write()
1666
self.branch.unlock()
1187
1669
def get_physical_lock_status(self):
1188
raise NotImplementedError(self.get_physical_lock_status)
1670
return self._control_files.get_physical_lock_status()
1672
def _basis_inventory_name(self):
1673
return 'basis-inventory-cache'
1675
def _reset_data(self):
1676
"""Reset transient data that cannot be revalidated."""
1677
self._inventory_is_modified = False
1678
result = self._deserialize(self._control_files.get('inventory'))
1679
self._set_inventory(result, dirty=False)
1681
@needs_tree_write_lock
1190
1682
def set_last_revision(self, new_revision):
1191
1683
"""Change the last revision in the working tree."""
1192
raise NotImplementedError(self.set_last_revision)
1684
new_revision = osutils.safe_revision_id(new_revision)
1685
if self._change_last_revision(new_revision):
1686
self._cache_basis_inventory(new_revision)
1194
1688
def _change_last_revision(self, new_revision):
1195
1689
"""Template method part of set_last_revision to perform the change.
1197
1691
This is used to allow WorkingTree3 instances to not affect branch
1198
1692
when their last revision is set.
1200
if _mod_revision.is_null(new_revision):
1201
self.branch.set_last_revision_info(0, new_revision)
1694
if new_revision is None:
1695
self.branch.set_revision_history([])
1203
_mod_revision.check_not_reserved_id(new_revision)
1205
1698
self.branch.generate_revision_history(new_revision)
1206
1699
except errors.NoSuchRevision:
1207
1700
# not present in the repo - dont try to set it deeper than the tip
1208
self.branch._set_revision_history([new_revision])
1701
self.branch.set_revision_history([new_revision])
1704
def _write_basis_inventory(self, xml):
1705
"""Write the basis inventory XML to the basis-inventory file"""
1706
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1707
path = self._basis_inventory_name()
1709
self._control_files.put(path, sio)
1711
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1712
"""Create the text that will be saved in basis-inventory"""
1713
# TODO: jam 20070209 This should be redundant, as the revision_id
1714
# as all callers should have already converted the revision_id to
1716
inventory.revision_id = osutils.safe_revision_id(revision_id)
1717
return xml7.serializer_v7.write_inventory_to_string(inventory)
1719
def _cache_basis_inventory(self, new_revision):
1720
"""Cache new_revision as the basis inventory."""
1721
# TODO: this should allow the ready-to-use inventory to be passed in,
1722
# as commit already has that ready-to-use [while the format is the
1725
# this double handles the inventory - unpack and repack -
1726
# but is easier to understand. We can/should put a conditional
1727
# in here based on whether the inventory is in the latest format
1728
# - perhaps we should repack all inventories on a repository
1730
# the fast path is to copy the raw xml from the repository. If the
1731
# xml contains 'revision_id="', then we assume the right
1732
# revision_id is set. We must check for this full string, because a
1733
# root node id can legitimately look like 'revision_id' but cannot
1735
xml = self.branch.repository.get_inventory_xml(new_revision)
1736
firstline = xml.split('\n', 1)[0]
1737
if (not 'revision_id="' in firstline or
1738
'format="7"' not in firstline):
1739
inv = self.branch.repository.deserialise_inventory(
1741
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1742
self._write_basis_inventory(xml)
1743
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1746
def read_basis_inventory(self):
1747
"""Read the cached basis inventory."""
1748
path = self._basis_inventory_name()
1749
return self._control_files.get(path).read()
1752
def read_working_inventory(self):
1753
"""Read the working inventory.
1755
:raises errors.InventoryModified: read_working_inventory will fail
1756
when the current in memory inventory has been modified.
1758
# conceptually this should be an implementation detail of the tree.
1759
# XXX: Deprecate this.
1760
# ElementTree does its own conversion from UTF-8, so open in
1762
if self._inventory_is_modified:
1763
raise errors.InventoryModified(self)
1764
result = self._deserialize(self._control_files.get('inventory'))
1765
self._set_inventory(result, dirty=False)
1211
1768
@needs_tree_write_lock
1212
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1214
"""Remove nominated files from the working tree metadata.
1216
:files: File paths relative to the basedir.
1217
:keep_files: If true, the files will also be kept.
1218
:force: Delete files and directories, even if they are changed and
1219
even if the directories are not empty.
1769
def remove(self, files, verbose=False, to_file=None):
1770
"""Remove nominated files from the working inventory..
1772
This does not remove their text. This does not run on XXX on what? RBC
1774
TODO: Refuse to remove modified files unless --force is given?
1776
TODO: Do something useful with directories.
1778
TODO: Should this remove the text or not? Tough call; not
1779
removing may be useful and the user can just use use rm, and
1780
is the opposite of add. Removing it is consistent with most
1781
other tools. Maybe an option.
1783
## TODO: Normalize names
1784
## TODO: Remove nested loops; better scalability
1221
1785
if isinstance(files, basestring):
1222
1786
files = [files]
1226
all_files = set() # specified and nested files
1227
unknown_nested_files=set()
1229
to_file = sys.stdout
1231
files_to_backup = []
1233
def recurse_directory_to_add_files(directory):
1234
# Recurse directory and add all files
1235
# so we can check if they have changed.
1236
for parent_info, file_infos in self.walkdirs(directory):
1237
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1238
# Is it versioned or ignored?
1239
if self.path2id(relpath):
1240
# Add nested content for deletion.
1241
all_files.add(relpath)
1243
# Files which are not versioned
1244
# should be treated as unknown.
1245
files_to_backup.append(relpath)
1247
for filename in files:
1248
# Get file name into canonical form.
1249
abspath = self.abspath(filename)
1250
filename = self.relpath(abspath)
1251
if len(filename) > 0:
1252
all_files.add(filename)
1253
recurse_directory_to_add_files(filename)
1255
files = list(all_files)
1258
return # nothing to do
1260
# Sort needed to first handle directory content before the directory
1261
files.sort(reverse=True)
1263
# Bail out if we are going to delete files we shouldn't
1264
if not keep_files and not force:
1265
for (file_id, path, content_change, versioned, parent_id, name,
1266
kind, executable) in self.iter_changes(self.basis_tree(),
1267
include_unchanged=True, require_versioned=False,
1268
want_unversioned=True, specific_files=files):
1269
if versioned[0] == False:
1270
# The record is unknown or newly added
1271
files_to_backup.append(path[1])
1272
elif (content_change and (kind[1] is not None) and
1273
osutils.is_inside_any(files, path[1])):
1274
# Versioned and changed, but not deleted, and still
1275
# in one of the dirs to be deleted.
1276
files_to_backup.append(path[1])
1278
def backup(file_to_backup):
1279
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1280
osutils.rename(abs_path, self.abspath(backup_name))
1281
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1284
# Build inv_delta and delete files where applicable,
1285
# do this before any modifications to meta data.
1788
inv = self.inventory
1790
# do this before any modifications
1286
1791
for f in files:
1287
fid = self.path2id(f)
1792
fid = inv.path2id(f)
1290
message = "%s is not versioned." % (f,)
1794
note("%s is not versioned."%f)
1293
# having removed it, it must be either ignored or unknown
1797
# having remove it, it must be either ignored or unknown
1294
1798
if self.is_ignored(f):
1295
1799
new_status = 'I'
1297
1801
new_status = '?'
1298
# XXX: Really should be a more abstract reporter interface
1299
kind_ch = osutils.kind_marker(self.kind(fid))
1300
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1302
inv_delta.append((f, None, fid, None))
1303
message = "removed %s" % (f,)
1306
abs_path = self.abspath(f)
1307
if osutils.lexists(abs_path):
1308
if (osutils.isdir(abs_path) and
1309
len(os.listdir(abs_path)) > 0):
1311
osutils.rmtree(abs_path)
1312
message = "deleted %s" % (f,)
1316
if f in files_to_backup:
1319
osutils.delete_any(abs_path)
1320
message = "deleted %s" % (f,)
1321
elif message is not None:
1322
# Only care if we haven't done anything yet.
1323
message = "%s does not exist." % (f,)
1325
# Print only one message (if any) per file.
1326
if message is not None:
1328
self.apply_inventory_delta(inv_delta)
1802
textui.show_status(new_status, inv[fid].kind, f,
1806
self._write_inventory(inv)
1330
1808
@needs_tree_write_lock
1331
def revert(self, filenames=None, old_tree=None, backups=True,
1332
pb=None, report_changes=False):
1809
def revert(self, filenames, old_tree=None, backups=True,
1810
pb=DummyProgress(), report_changes=False):
1333
1811
from bzrlib.conflicts import resolve
1334
1812
if old_tree is None:
1335
basis_tree = self.basis_tree()
1336
basis_tree.lock_read()
1337
old_tree = basis_tree
1813
old_tree = self.basis_tree()
1814
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1816
if not len(filenames):
1817
self.set_parent_ids(self.get_parent_ids()[:1])
1341
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1343
if filenames is None and len(self.get_parent_ids()) > 1:
1345
last_revision = self.last_revision()
1346
if last_revision != _mod_revision.NULL_REVISION:
1347
if basis_tree is None:
1348
basis_tree = self.basis_tree()
1349
basis_tree.lock_read()
1350
parent_trees.append((last_revision, basis_tree))
1351
self.set_parent_trees(parent_trees)
1354
resolve(self, filenames, ignore_misses=True, recursive=True)
1356
if basis_tree is not None:
1820
resolve(self, filenames, ignore_misses=True)
1358
1821
return conflicts
1361
def store_uncommitted(self):
1362
"""Store uncommitted changes from the tree in the branch."""
1363
target_tree = self.basis_tree()
1364
shelf_creator = shelf.ShelfCreator(self, target_tree)
1366
if not shelf_creator.shelve_all():
1368
self.branch.store_uncommitted(shelf_creator)
1369
shelf_creator.transform()
1371
shelf_creator.finalize()
1372
note('Uncommitted changes stored in branch "%s".', self.branch.nick)
1375
def restore_uncommitted(self):
1376
"""Restore uncommitted changes from the branch into the tree."""
1377
unshelver = self.branch.get_unshelver(self)
1378
if unshelver is None:
1381
merger = unshelver.make_merger()
1382
merger.ignore_zero = True
1384
self.branch.store_uncommitted(None)
1386
unshelver.finalize()
1388
1823
def revision_tree(self, revision_id):
1389
1824
"""See Tree.revision_tree.
1391
1826
WorkingTree can supply revision_trees for the basis revision only
1392
1827
because there is only one cached inventory in the bzr directory.
1394
raise NotImplementedError(self.revision_tree)
1829
if revision_id == self.last_revision():
1831
xml = self.read_basis_inventory()
1832
except errors.NoSuchFile:
1836
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1837
# dont use the repository revision_tree api because we want
1838
# to supply the inventory.
1839
if inv.revision_id == revision_id:
1840
return revisiontree.RevisionTree(self.branch.repository,
1842
except errors.BadInventoryFormat:
1844
# raise if there was no inventory, or if we read the wrong inventory.
1845
raise errors.NoSuchRevisionInTree(self, revision_id)
1847
# XXX: This method should be deprecated in favour of taking in a proper
1848
# new Inventory object.
1849
@needs_tree_write_lock
1850
def set_inventory(self, new_inventory_list):
1851
from bzrlib.inventory import (Inventory,
1856
inv = Inventory(self.get_root_id())
1857
for path, file_id, parent, kind in new_inventory_list:
1858
name = os.path.basename(path)
1861
# fixme, there should be a factory function inv,add_??
1862
if kind == 'directory':
1863
inv.add(InventoryDirectory(file_id, name, parent))
1864
elif kind == 'file':
1865
inv.add(InventoryFile(file_id, name, parent))
1866
elif kind == 'symlink':
1867
inv.add(InventoryLink(file_id, name, parent))
1869
raise errors.BzrError("unknown kind %r" % kind)
1870
self._write_inventory(inv)
1396
1872
@needs_tree_write_lock
1397
1873
def set_root_id(self, file_id):
1398
1874
"""Set the root id for this tree."""
1400
1876
if file_id is None:
1402
'WorkingTree.set_root_id with fileid=None')
1403
file_id = osutils.safe_file_id(file_id)
1877
symbol_versioning.warn(symbol_versioning.zero_twelve
1878
% 'WorkingTree.set_root_id with fileid=None',
1883
file_id = osutils.safe_file_id(file_id)
1404
1884
self._set_root_id(file_id)
1406
1886
def _set_root_id(self, file_id):
1407
1887
"""Set the root id for this tree, in a format specific manner.
1409
:param file_id: The file id to assign to the root. It must not be
1889
:param file_id: The file id to assign to the root. It must not be
1410
1890
present in the current inventory or an error will occur. It must
1411
1891
not be None, but rather a valid file id.
1413
raise NotImplementedError(self._set_root_id)
1893
inv = self._inventory
1894
orig_root_id = inv.root.file_id
1895
# TODO: it might be nice to exit early if there was nothing
1896
# to do, saving us from trigger a sync on unlock.
1897
self._inventory_is_modified = True
1898
# we preserve the root inventory entry object, but
1899
# unlinkit from the byid index
1900
del inv._byid[inv.root.file_id]
1901
inv.root.file_id = file_id
1902
# and link it into the index with the new changed id.
1903
inv._byid[inv.root.file_id] = inv.root
1904
# and finally update all children to reference the new id.
1905
# XXX: this should be safe to just look at the root.children
1906
# list, not the WHOLE INVENTORY.
1909
if entry.parent_id == orig_root_id:
1910
entry.parent_id = inv.root.file_id
1415
1912
def unlock(self):
1416
1913
"""See Branch.unlock.
1418
1915
WorkingTree locking just uses the Branch locking facilities.
1419
1916
This is current because all working trees have an embedded branch
1420
1917
within them. IF in the future, we were to make branch data shareable
1421
between multiple working trees, i.e. via shared storage, then we
1918
between multiple working trees, i.e. via shared storage, then we
1422
1919
would probably want to lock both the local tree, and the branch.
1424
1921
raise NotImplementedError(self.unlock)
1428
def update(self, change_reporter=None, possible_transports=None,
1429
revision=None, old_tip=_marker, show_base=False):
1430
1924
"""Update a working tree along its branch.
1432
1926
This will update the branch if its bound too, which means we have
1736
2267
self.set_conflicts(un_resolved)
1737
2268
return un_resolved, resolved
1739
def _validate(self):
1740
"""Validate internal structures.
1742
This is meant mostly for the test suite. To give it a chance to detect
1743
corruption after actions have occurred. The default implementation is a
1746
:return: None. An exception should be raised if there is an error.
1750
def check_state(self):
1751
"""Check that the working state is/isn't valid."""
1752
raise NotImplementedError(self.check_state)
1754
def reset_state(self, revision_ids=None):
1755
"""Reset the state of the working tree.
1757
This does a hard-reset to a last-known-good state. This is a way to
1758
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1760
raise NotImplementedError(self.reset_state)
1762
def _get_rules_searcher(self, default_searcher):
1763
"""See Tree._get_rules_searcher."""
1764
if self._rules_searcher is None:
1765
self._rules_searcher = super(WorkingTree,
1766
self)._get_rules_searcher(default_searcher)
1767
return self._rules_searcher
1769
def get_shelf_manager(self):
1770
"""Return the ShelfManager for this WorkingTree."""
1771
from bzrlib.shelf import ShelfManager
1772
return ShelfManager(self, self._transport)
1775
class InventoryWorkingTree(WorkingTree,
1776
bzrlib.mutabletree.MutableInventoryTree):
1777
"""Base class for working trees that are inventory-oriented.
1779
The inventory is held in the `Branch` working-inventory, and the
1780
files are in a directory on disk.
1782
It is possible for a `WorkingTree` to have a filename which is
1783
not listed in the Inventory and vice versa.
2271
class WorkingTree2(WorkingTree):
2272
"""This is the Format 2 working tree.
2274
This was the first weave based working tree.
2275
- uses os locks for locking.
2276
- uses the branch last-revision.
1786
def __init__(self, basedir='.',
1787
branch=DEPRECATED_PARAMETER,
1789
_control_files=None,
1793
"""Construct a InventoryWorkingTree instance. This is not a public API.
1795
:param branch: A branch to override probing for the branch.
1797
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1798
branch=branch, _transport=_control_files._transport,
1799
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1801
self._control_files = _control_files
1802
self._detect_case_handling()
1804
if _inventory is None:
1805
# This will be acquired on lock_read() or lock_write()
1806
self._inventory_is_modified = False
1807
self._inventory = None
1809
# the caller of __init__ has provided an inventory,
1810
# we assume they know what they are doing - as its only
1811
# the Format factory and creation methods that are
1812
# permitted to do this.
1813
self._set_inventory(_inventory, dirty=False)
1815
def _set_inventory(self, inv, dirty):
1816
"""Set the internal cached inventory.
1818
:param inv: The inventory to set.
1819
:param dirty: A boolean indicating whether the inventory is the same
1820
logical inventory as whats on disk. If True the inventory is not
1821
the same and should be written to disk or data will be lost, if
1822
False then the inventory is the same as that on disk and any
1823
serialisation would be unneeded overhead.
1825
self._inventory = inv
1826
self._inventory_is_modified = dirty
1828
def _detect_case_handling(self):
1829
wt_trans = self.bzrdir.get_workingtree_transport(None)
1831
wt_trans.stat(self._format.case_sensitive_filename)
1832
except errors.NoSuchFile:
1833
self.case_sensitive = True
1835
self.case_sensitive = False
1837
self._setup_directory_is_tree_reference()
1839
def _serialize(self, inventory, out_file):
1840
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1843
def _deserialize(selt, in_file):
1844
return xml5.serializer_v5.read_inventory(in_file)
1846
def break_lock(self):
1847
"""Break a lock if one is present from another instance.
1849
Uses the ui factory to ask for confirmation if the lock may be from
1852
This will probe the repository for its lock as well.
1854
self._control_files.break_lock()
1855
self.branch.break_lock()
1857
def is_locked(self):
1858
return self._control_files.is_locked()
1860
def _must_be_locked(self):
1861
if not self.is_locked():
1862
raise errors.ObjectNotLocked(self)
1864
def lock_read(self):
1865
"""Lock the tree for reading.
1867
This also locks the branch, and can be unlocked via self.unlock().
1869
:return: A bzrlib.lock.LogicalLockResult.
1871
if not self.is_locked():
1873
self.branch.lock_read()
1875
self._control_files.lock_read()
1876
return LogicalLockResult(self.unlock)
1878
self.branch.unlock()
2279
def __init__(self, *args, **kwargs):
2280
super(WorkingTree2, self).__init__(*args, **kwargs)
2281
# WorkingTree2 has more of a constraint that self._inventory must
2282
# exist. Because this is an older format, we don't mind the overhead
2283
# caused by the extra computation here.
2285
# Newer WorkingTree's should only have self._inventory set when they
2287
if self._inventory is None:
2288
self.read_working_inventory()
1881
2290
def lock_tree_write(self):
1882
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1884
:return: A bzrlib.lock.LogicalLockResult.
1886
if not self.is_locked():
1888
self.branch.lock_read()
1890
self._control_files.lock_write()
1891
return LogicalLockResult(self.unlock)
1893
self.branch.unlock()
1896
def lock_write(self):
1897
"""See MutableTree.lock_write, and WorkingTree.unlock.
1899
:return: A bzrlib.lock.LogicalLockResult.
1901
if not self.is_locked():
2291
"""See WorkingTree.lock_tree_write().
2293
In Format2 WorkingTrees we have a single lock for the branch and tree
2294
so lock_tree_write() degrades to lock_write().
1903
2296
self.branch.lock_write()
1905
self._control_files.lock_write()
1906
return LogicalLockResult(self.unlock)
2298
return self._control_files.lock_write()
1908
2300
self.branch.unlock()
1911
def get_physical_lock_status(self):
1912
return self._control_files.get_physical_lock_status()
1914
@needs_tree_write_lock
1915
def _write_inventory(self, inv):
1916
"""Write inventory as the current inventory."""
1917
self._set_inventory(inv, dirty=True)
1920
# XXX: This method should be deprecated in favour of taking in a proper
1921
# new Inventory object.
1922
@needs_tree_write_lock
1923
def set_inventory(self, new_inventory_list):
1924
from bzrlib.inventory import (Inventory,
1928
inv = Inventory(self.get_root_id())
1929
for path, file_id, parent, kind in new_inventory_list:
1930
name = os.path.basename(path)
1933
# fixme, there should be a factory function inv,add_??
1934
if kind == 'directory':
1935
inv.add(InventoryDirectory(file_id, name, parent))
1936
elif kind == 'file':
1937
inv.add(InventoryFile(file_id, name, parent))
1938
elif kind == 'symlink':
1939
inv.add(InventoryLink(file_id, name, parent))
1941
raise errors.BzrError("unknown kind %r" % kind)
1942
self._write_inventory(inv)
1944
def _write_basis_inventory(self, xml):
1945
"""Write the basis inventory XML to the basis-inventory file"""
1946
path = self._basis_inventory_name()
1948
self._transport.put_file(path, sio,
1949
mode=self.bzrdir._get_file_mode())
1951
def _reset_data(self):
1952
"""Reset transient data that cannot be revalidated."""
1953
self._inventory_is_modified = False
1954
f = self._transport.get('inventory')
2304
# we share control files:
2305
if self._control_files._lock_count == 3:
2306
# _inventory_is_modified is always False during a read lock.
2307
if self._inventory_is_modified:
2309
self._write_hashcache_if_dirty()
2311
# reverse order of locking.
1956
result = self._deserialize(f)
2313
return self._control_files.unlock()
1959
self._set_inventory(result, dirty=False)
1961
def _set_root_id(self, file_id):
1962
"""Set the root id for this tree, in a format specific manner.
1964
:param file_id: The file id to assign to the root. It must not be
1965
present in the current inventory or an error will occur. It must
1966
not be None, but rather a valid file id.
1968
inv = self._inventory
1969
orig_root_id = inv.root.file_id
1970
# TODO: it might be nice to exit early if there was nothing
1971
# to do, saving us from trigger a sync on unlock.
1972
self._inventory_is_modified = True
1973
# we preserve the root inventory entry object, but
1974
# unlinkit from the byid index
1975
del inv._byid[inv.root.file_id]
1976
inv.root.file_id = file_id
1977
# and link it into the index with the new changed id.
1978
inv._byid[inv.root.file_id] = inv.root
1979
# and finally update all children to reference the new id.
1980
# XXX: this should be safe to just look at the root.children
1981
# list, not the WHOLE INVENTORY.
1984
if entry.parent_id == orig_root_id:
1985
entry.parent_id = inv.root.file_id
1987
@needs_tree_write_lock
1988
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1989
"""See MutableTree.set_parent_trees."""
1990
parent_ids = [rev for (rev, tree) in parents_list]
1991
for revision_id in parent_ids:
1992
_mod_revision.check_not_reserved_id(revision_id)
1994
self._check_parents_for_ghosts(parent_ids,
1995
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1997
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1999
if len(parent_ids) == 0:
2000
leftmost_parent_id = _mod_revision.NULL_REVISION
2001
leftmost_parent_tree = None
2315
self.branch.unlock()
2318
class WorkingTree3(WorkingTree):
2319
"""This is the Format 3 working tree.
2321
This differs from the base WorkingTree by:
2322
- having its own file lock
2323
- having its own last-revision property.
2325
This is new in bzr 0.8
2329
def _last_revision(self):
2330
"""See Mutable.last_revision."""
2332
return osutils.safe_revision_id(
2333
self._control_files.get('last-revision').read())
2334
except errors.NoSuchFile:
2337
def _change_last_revision(self, revision_id):
2338
"""See WorkingTree._change_last_revision."""
2339
if revision_id is None or revision_id == NULL_REVISION:
2341
self._control_files._transport.delete('last-revision')
2342
except errors.NoSuchFile:
2003
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
2005
if self._change_last_revision(leftmost_parent_id):
2006
if leftmost_parent_tree is None:
2007
# If we don't have a tree, fall back to reading the
2008
# parent tree from the repository.
2009
self._cache_basis_inventory(leftmost_parent_id)
2011
inv = leftmost_parent_tree.root_inventory
2012
xml = self._create_basis_xml_from_inventory(
2013
leftmost_parent_id, inv)
2014
self._write_basis_inventory(xml)
2015
self._set_merges_from_parent_ids(parent_ids)
2017
def _cache_basis_inventory(self, new_revision):
2018
"""Cache new_revision as the basis inventory."""
2019
# TODO: this should allow the ready-to-use inventory to be passed in,
2020
# as commit already has that ready-to-use [while the format is the
2023
# this double handles the inventory - unpack and repack -
2024
# but is easier to understand. We can/should put a conditional
2025
# in here based on whether the inventory is in the latest format
2026
# - perhaps we should repack all inventories on a repository
2028
# the fast path is to copy the raw xml from the repository. If the
2029
# xml contains 'revision_id="', then we assume the right
2030
# revision_id is set. We must check for this full string, because a
2031
# root node id can legitimately look like 'revision_id' but cannot
2033
xml = self.branch.repository._get_inventory_xml(new_revision)
2034
firstline = xml.split('\n', 1)[0]
2035
if (not 'revision_id="' in firstline or
2036
'format="7"' not in firstline):
2037
inv = self.branch.repository._serializer.read_inventory_from_string(
2039
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2040
self._write_basis_inventory(xml)
2041
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2044
def _basis_inventory_name(self):
2045
return 'basis-inventory-cache'
2047
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2048
"""Create the text that will be saved in basis-inventory"""
2049
inventory.revision_id = revision_id
2050
return xml7.serializer_v7.write_inventory_to_string(inventory)
2346
self._control_files.put_bytes('last-revision', revision_id)
2052
2349
@needs_tree_write_lock
2053
2350
def set_conflicts(self, conflicts):
2054
self._put_rio('conflicts', conflicts.to_stanzas(),
2351
self._put_rio('conflicts', conflicts.to_stanzas(),
2055
2352
CONFLICT_HEADER_1)
2057
2354
@needs_tree_write_lock
2064
2361
@needs_read_lock
2065
2362
def conflicts(self):
2067
confile = self._transport.get('conflicts')
2364
confile = self._control_files.get('conflicts')
2068
2365
except errors.NoSuchFile:
2069
2366
return _mod_conflicts.ConflictList()
2072
if confile.next() != CONFLICT_HEADER_1 + '\n':
2073
raise errors.ConflictFormatError()
2074
except StopIteration:
2368
if confile.next() != CONFLICT_HEADER_1 + '\n':
2075
2369
raise errors.ConflictFormatError()
2076
reader = _mod_rio.RioReader(confile)
2077
return _mod_conflicts.ConflictList.from_stanzas(reader)
2081
def read_basis_inventory(self):
2082
"""Read the cached basis inventory."""
2083
path = self._basis_inventory_name()
2084
return self._transport.get_bytes(path)
2087
def read_working_inventory(self):
2088
"""Read the working inventory.
2090
:raises errors.InventoryModified: read_working_inventory will fail
2091
when the current in memory inventory has been modified.
2093
# conceptually this should be an implementation detail of the tree.
2094
# XXX: Deprecate this.
2095
# ElementTree does its own conversion from UTF-8, so open in
2097
if self._inventory_is_modified:
2098
raise errors.InventoryModified(self)
2099
f = self._transport.get('inventory')
2370
except StopIteration:
2371
raise errors.ConflictFormatError()
2372
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2375
if self._control_files._lock_count == 1:
2376
# _inventory_is_modified is always False during a read lock.
2377
if self._inventory_is_modified:
2379
self._write_hashcache_if_dirty()
2380
# reverse order of locking.
2101
result = self._deserialize(f)
2382
return self._control_files.unlock()
2104
self._set_inventory(result, dirty=False)
2108
def get_root_id(self):
2109
"""Return the id of this trees root"""
2110
return self._inventory.root.file_id
2112
def has_id(self, file_id):
2113
# files that have been deleted are excluded
2114
inv, inv_file_id = self._unpack_file_id(file_id)
2115
if not inv.has_id(inv_file_id):
2117
path = inv.id2path(inv_file_id)
2118
return osutils.lexists(self.abspath(path))
2120
def has_or_had_id(self, file_id):
2121
if file_id == self.get_root_id():
2384
self.branch.unlock()
2387
def get_conflicted_stem(path):
2388
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2389
if path.endswith(suffix):
2390
return path[:-len(suffix)]
2393
@deprecated_function(zero_eight)
2394
def is_control_file(filename):
2395
"""See WorkingTree.is_control_filename(filename)."""
2396
## FIXME: better check
2397
filename = normpath(filename)
2398
while filename != '':
2399
head, tail = os.path.split(filename)
2400
## mutter('check %r for control file' % ((head, tail),))
2123
inv, inv_file_id = self._unpack_file_id(file_id)
2124
return inv.has_id(inv_file_id)
2126
def all_file_ids(self):
2127
"""Iterate through file_ids for this tree.
2129
file_ids are in a WorkingTree if they are in the working inventory
2130
and the working file exists.
2133
for path, ie in self.iter_entries_by_dir():
2137
@needs_tree_write_lock
2138
def set_last_revision(self, new_revision):
2139
"""Change the last revision in the working tree."""
2140
if self._change_last_revision(new_revision):
2141
self._cache_basis_inventory(new_revision)
2143
def _get_check_refs(self):
2144
"""Return the references needed to perform a check of this tree.
2146
The default implementation returns no refs, and is only suitable for
2147
trees that have no local caching and can commit on ghosts at any time.
2149
:seealso: bzrlib.check for details about check_refs.
2154
def _check(self, references):
2155
"""Check the tree for consistency.
2157
:param references: A dict with keys matching the items returned by
2158
self._get_check_refs(), and values from looking those keys up in
2161
tree_basis = self.basis_tree()
2162
tree_basis.lock_read()
2164
repo_basis = references[('trees', self.last_revision())]
2165
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2166
raise errors.BzrCheckError(
2167
"Mismatched basis inventory content.")
2173
def check_state(self):
2174
"""Check that the working state is/isn't valid."""
2175
check_refs = self._get_check_refs()
2177
for ref in check_refs:
2180
refs[ref] = self.branch.repository.revision_tree(value)
2183
@needs_tree_write_lock
2184
def reset_state(self, revision_ids=None):
2185
"""Reset the state of the working tree.
2187
This does a hard-reset to a last-known-good state. This is a way to
2188
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2190
if revision_ids is None:
2191
revision_ids = self.get_parent_ids()
2192
if not revision_ids:
2193
rt = self.branch.repository.revision_tree(
2194
_mod_revision.NULL_REVISION)
2196
rt = self.branch.repository.revision_tree(revision_ids[0])
2197
self._write_inventory(rt.root_inventory)
2198
self.set_parent_ids(revision_ids)
2201
"""Write the in memory inventory to disk."""
2202
# TODO: Maybe this should only write on dirty ?
2203
if self._control_files._lock_mode != 'w':
2204
raise errors.NotWriteLocked(self)
2206
self._serialize(self._inventory, sio)
2208
self._transport.put_file('inventory', sio,
2209
mode=self.bzrdir._get_file_mode())
2210
self._inventory_is_modified = False
2212
def get_file_mtime(self, file_id, path=None):
2213
"""See Tree.get_file_mtime."""
2215
path = self.id2path(file_id)
2217
return os.lstat(self.abspath(path)).st_mtime
2219
if e.errno == errno.ENOENT:
2220
raise errors.FileTimestampUnavailable(path)
2223
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2224
inv, file_id = self._path2inv_file_id(path)
2226
# For unversioned files on win32, we just assume they are not
2229
return inv[file_id].executable
2231
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2232
mode = stat_result.st_mode
2233
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2235
def is_executable(self, file_id, path=None):
2236
if not self._supports_executable():
2237
inv, inv_file_id = self._unpack_file_id(file_id)
2238
return inv[inv_file_id].executable
2241
path = self.id2path(file_id)
2242
mode = os.lstat(self.abspath(path)).st_mode
2243
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2245
def _is_executable_from_path_and_stat(self, path, stat_result):
2246
if not self._supports_executable():
2247
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2249
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2251
@needs_tree_write_lock
2252
def _add(self, files, ids, kinds):
2253
"""See MutableTree._add."""
2254
# TODO: Re-adding a file that is removed in the working copy
2255
# should probably put it back with the previous ID.
2256
# the read and write working inventory should not occur in this
2257
# function - they should be part of lock_write and unlock.
2258
# FIXME: nested trees
2259
inv = self.root_inventory
2260
for f, file_id, kind in zip(files, ids, kinds):
2262
inv.add_path(f, kind=kind)
2264
inv.add_path(f, kind=kind, file_id=file_id)
2265
self._inventory_is_modified = True
2267
def revision_tree(self, revision_id):
2268
"""See WorkingTree.revision_id."""
2269
if revision_id == self.last_revision():
2271
xml = self.read_basis_inventory()
2272
except errors.NoSuchFile:
2276
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2277
# dont use the repository revision_tree api because we want
2278
# to supply the inventory.
2279
if inv.revision_id == revision_id:
2280
return revisiontree.InventoryRevisionTree(
2281
self.branch.repository, inv, revision_id)
2282
except errors.BadInventoryFormat:
2284
# raise if there was no inventory, or if we read the wrong inventory.
2285
raise errors.NoSuchRevisionInTree(self, revision_id)
2288
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2289
"""See Tree.annotate_iter
2291
This implementation will use the basis tree implementation if possible.
2292
Lines not in the basis are attributed to CURRENT_REVISION
2294
If there are pending merges, lines added by those merges will be
2295
incorrectly attributed to CURRENT_REVISION (but after committing, the
2296
attribution will be correct).
2298
maybe_file_parent_keys = []
2299
for parent_id in self.get_parent_ids():
2301
parent_tree = self.revision_tree(parent_id)
2302
except errors.NoSuchRevisionInTree:
2303
parent_tree = self.branch.repository.revision_tree(parent_id)
2304
parent_tree.lock_read()
2307
kind = parent_tree.kind(file_id)
2308
except errors.NoSuchId:
2311
# Note: this is slightly unnecessary, because symlinks and
2312
# directories have a "text" which is the empty text, and we
2313
# know that won't mess up annotations. But it seems cleaner
2316
file_id, parent_tree.get_file_revision(file_id))
2317
if parent_text_key not in maybe_file_parent_keys:
2318
maybe_file_parent_keys.append(parent_text_key)
2320
parent_tree.unlock()
2321
graph = _mod_graph.Graph(self.branch.repository.texts)
2322
heads = graph.heads(maybe_file_parent_keys)
2323
file_parent_keys = []
2324
for key in maybe_file_parent_keys:
2326
file_parent_keys.append(key)
2328
# Now we have the parents of this content
2329
annotator = self.branch.repository.texts.get_annotator()
2330
text = self.get_file_text(file_id)
2331
this_key =(file_id, default_revision)
2332
annotator.add_special_text(this_key, file_parent_keys, text)
2333
annotations = [(key[-1], line)
2334
for key, line in annotator.annotate_flat(this_key)]
2337
def _put_rio(self, filename, stanzas, header):
2338
self._must_be_locked()
2339
my_file = _mod_rio.rio_file(stanzas, header)
2340
self._transport.put_file(filename, my_file,
2341
mode=self.bzrdir._get_file_mode())
2343
@needs_tree_write_lock
2344
def set_merge_modified(self, modified_hashes):
2346
for file_id, hash in modified_hashes.iteritems():
2347
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2349
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2352
def merge_modified(self):
2353
"""Return a dictionary of files modified by a merge.
2355
The list is initialized by WorkingTree.set_merge_modified, which is
2356
typically called after we make some automatic updates to the tree
2359
This returns a map of file_id->sha1, containing only files which are
2360
still in the working inventory and have that text hash.
2363
hashfile = self._transport.get('merge-hashes')
2364
except errors.NoSuchFile:
2369
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2370
raise errors.MergeModifiedFormatError()
2371
except StopIteration:
2372
raise errors.MergeModifiedFormatError()
2373
for s in _mod_rio.RioReader(hashfile):
2374
# RioReader reads in Unicode, so convert file_ids back to utf8
2375
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2376
if not self.has_id(file_id):
2378
text_hash = s.get("hash")
2379
if text_hash == self.get_file_sha1(file_id):
2380
merge_hashes[file_id] = text_hash
2386
def subsume(self, other_tree):
2387
def add_children(inventory, entry):
2388
for child_entry in entry.children.values():
2389
inventory._byid[child_entry.file_id] = child_entry
2390
if child_entry.kind == 'directory':
2391
add_children(inventory, child_entry)
2392
if other_tree.get_root_id() == self.get_root_id():
2393
raise errors.BadSubsumeSource(self, other_tree,
2394
'Trees have the same root')
2396
other_tree_path = self.relpath(other_tree.basedir)
2397
except errors.PathNotChild:
2398
raise errors.BadSubsumeSource(self, other_tree,
2399
'Tree is not contained by the other')
2400
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2401
if new_root_parent is None:
2402
raise errors.BadSubsumeSource(self, other_tree,
2403
'Parent directory is not versioned.')
2404
# We need to ensure that the result of a fetch will have a
2405
# versionedfile for the other_tree root, and only fetching into
2406
# RepositoryKnit2 guarantees that.
2407
if not self.branch.repository.supports_rich_root():
2408
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2409
other_tree.lock_tree_write()
2411
new_parents = other_tree.get_parent_ids()
2412
other_root = other_tree.root_inventory.root
2413
other_root.parent_id = new_root_parent
2414
other_root.name = osutils.basename(other_tree_path)
2415
self.root_inventory.add(other_root)
2416
add_children(self.root_inventory, other_root)
2417
self._write_inventory(self.root_inventory)
2418
# normally we don't want to fetch whole repositories, but i think
2419
# here we really do want to consolidate the whole thing.
2420
for parent_id in other_tree.get_parent_ids():
2421
self.branch.fetch(other_tree.branch, parent_id)
2422
self.add_parent_tree_id(parent_id)
2425
other_tree.bzrdir.retire_bzrdir()
2427
@needs_tree_write_lock
2428
def extract(self, file_id, format=None):
2429
"""Extract a subtree from this tree.
2431
A new branch will be created, relative to the path for this tree.
2435
segments = osutils.splitpath(path)
2436
transport = self.branch.bzrdir.root_transport
2437
for name in segments:
2438
transport = transport.clone(name)
2439
transport.ensure_base()
2442
sub_path = self.id2path(file_id)
2443
branch_transport = mkdirs(sub_path)
2445
format = self.bzrdir.cloning_metadir()
2446
branch_transport.ensure_base()
2447
branch_bzrdir = format.initialize_on_transport(branch_transport)
2449
repo = branch_bzrdir.find_repository()
2450
except errors.NoRepositoryPresent:
2451
repo = branch_bzrdir.create_repository()
2452
if not repo.supports_rich_root():
2453
raise errors.RootNotRich()
2454
new_branch = branch_bzrdir.create_branch()
2455
new_branch.pull(self.branch)
2456
for parent_id in self.get_parent_ids():
2457
new_branch.fetch(self.branch, parent_id)
2458
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2459
if tree_transport.base != branch_transport.base:
2460
tree_bzrdir = format.initialize_on_transport(tree_transport)
2461
tree_bzrdir.set_branch_reference(new_branch)
2463
tree_bzrdir = branch_bzrdir
2464
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2465
wt.set_parent_ids(self.get_parent_ids())
2466
# FIXME: Support nested trees
2467
my_inv = self.root_inventory
2468
child_inv = inventory.Inventory(root_id=None)
2469
new_root = my_inv[file_id]
2470
my_inv.remove_recursive_id(file_id)
2471
new_root.parent_id = None
2472
child_inv.add(new_root)
2473
self._write_inventory(my_inv)
2474
wt._write_inventory(child_inv)
2477
def list_files(self, include_root=False, from_dir=None, recursive=True):
2478
"""List all files as (path, class, kind, id, entry).
2480
Lists, but does not descend into unversioned directories.
2481
This does not include files that have been deleted in this
2482
tree. Skips the control directory.
2484
:param include_root: if True, return an entry for the root
2485
:param from_dir: start from this directory or None for the root
2486
:param recursive: whether to recurse into subdirectories or not
2488
# list_files is an iterator, so @needs_read_lock doesn't work properly
2489
# with it. So callers should be careful to always read_lock the tree.
2490
if not self.is_locked():
2491
raise errors.ObjectNotLocked(self)
2493
if from_dir is None and include_root is True:
2494
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2495
# Convert these into local objects to save lookup times
2496
pathjoin = osutils.pathjoin
2497
file_kind = self._kind
2499
# transport.base ends in a slash, we want the piece
2500
# between the last two slashes
2501
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2503
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2505
# directory file_id, relative path, absolute path, reverse sorted children
2506
if from_dir is not None:
2507
inv, from_dir_id = self._path2inv_file_id(from_dir)
2508
if from_dir_id is None:
2509
# Directory not versioned
2511
from_dir_abspath = pathjoin(self.basedir, from_dir)
2513
inv = self.root_inventory
2514
from_dir_id = inv.root.file_id
2515
from_dir_abspath = self.basedir
2516
children = os.listdir(from_dir_abspath)
2518
# jam 20060527 The kernel sized tree seems equivalent whether we
2519
# use a deque and popleft to keep them sorted, or if we use a plain
2520
# list and just reverse() them.
2521
children = collections.deque(children)
2522
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2524
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2527
f = children.popleft()
2528
## TODO: If we find a subdirectory with its own .bzr
2529
## directory, then that is a separate tree and we
2530
## should exclude it.
2532
# the bzrdir for this tree
2533
if transport_base_dir == f:
2536
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2537
# and 'f' doesn't begin with one, we can do a string op, rather
2538
# than the checks of pathjoin(), all relative paths will have an extra slash
2540
fp = from_dir_relpath + '/' + f
2543
fap = from_dir_abspath + '/' + f
2545
dir_ie = inv[from_dir_id]
2546
if dir_ie.kind == 'directory':
2547
f_ie = dir_ie.children.get(f)
2552
elif self.is_ignored(fp[1:]):
2555
# we may not have found this file, because of a unicode
2556
# issue, or because the directory was actually a symlink.
2557
f_norm, can_access = osutils.normalized_filename(f)
2558
if f == f_norm or not can_access:
2559
# No change, so treat this file normally
2562
# this file can be accessed by a normalized path
2563
# check again if it is versioned
2564
# these lines are repeated here for performance
2566
fp = from_dir_relpath + '/' + f
2567
fap = from_dir_abspath + '/' + f
2568
f_ie = inv.get_child(from_dir_id, f)
2571
elif self.is_ignored(fp[1:]):
2578
# make a last minute entry
2580
yield fp[1:], c, fk, f_ie.file_id, f_ie
2583
yield fp[1:], c, fk, None, fk_entries[fk]()
2585
yield fp[1:], c, fk, None, TreeEntry()
2588
if fk != 'directory':
2591
# But do this child first if recursing down
2593
new_children = os.listdir(fap)
2595
new_children = collections.deque(new_children)
2596
stack.append((f_ie.file_id, fp, fap, new_children))
2597
# Break out of inner loop,
2598
# so that we start outer loop with child
2601
# if we finished all children, pop it off the stack
2604
@needs_tree_write_lock
2605
def move(self, from_paths, to_dir=None, after=False):
2608
to_dir must exist in the inventory.
2610
If to_dir exists and is a directory, the files are moved into
2611
it, keeping their old names.
2613
Note that to_dir is only the last component of the new name;
2614
this doesn't change the directory.
2616
For each entry in from_paths the move mode will be determined
2619
The first mode moves the file in the filesystem and updates the
2620
inventory. The second mode only updates the inventory without
2621
touching the file on the filesystem.
2623
move uses the second mode if 'after == True' and the target is
2624
either not versioned or newly added, and present in the working tree.
2626
move uses the second mode if 'after == False' and the source is
2627
versioned but no longer in the working tree, and the target is not
2628
versioned but present in the working tree.
2630
move uses the first mode if 'after == False' and the source is
2631
versioned and present in the working tree, and the target is not
2632
versioned and not present in the working tree.
2634
Everything else results in an error.
2636
This returns a list of (from_path, to_path) pairs for each
2637
entry that is moved.
2642
invs_to_write = set()
2644
# check for deprecated use of signature
2646
raise TypeError('You must supply a target directory')
2647
# check destination directory
2648
if isinstance(from_paths, basestring):
2650
to_abs = self.abspath(to_dir)
2651
if not isdir(to_abs):
2652
raise errors.BzrMoveFailedError('',to_dir,
2653
errors.NotADirectory(to_abs))
2654
if not self.has_filename(to_dir):
2655
raise errors.BzrMoveFailedError('',to_dir,
2656
errors.NotInWorkingDirectory(to_dir))
2657
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2658
if to_dir_id is None:
2659
raise errors.BzrMoveFailedError('',to_dir,
2660
errors.NotVersionedError(path=to_dir))
2662
to_dir_ie = to_inv[to_dir_id]
2663
if to_dir_ie.kind != 'directory':
2664
raise errors.BzrMoveFailedError('',to_dir,
2665
errors.NotADirectory(to_abs))
2667
# create rename entries and tuples
2668
for from_rel in from_paths:
2669
from_tail = splitpath(from_rel)[-1]
2670
from_inv, from_id = self._path2inv_file_id(from_rel)
2672
raise errors.BzrMoveFailedError(from_rel,to_dir,
2673
errors.NotVersionedError(path=from_rel))
2675
from_entry = from_inv[from_id]
2676
from_parent_id = from_entry.parent_id
2677
to_rel = pathjoin(to_dir, from_tail)
2678
rename_entry = InventoryWorkingTree._RenameEntry(
2681
from_tail=from_tail,
2682
from_parent_id=from_parent_id,
2683
to_rel=to_rel, to_tail=from_tail,
2684
to_parent_id=to_dir_id)
2685
rename_entries.append(rename_entry)
2686
rename_tuples.append((from_rel, to_rel))
2688
# determine which move mode to use. checks also for movability
2689
rename_entries = self._determine_mv_mode(rename_entries, after)
2691
original_modified = self._inventory_is_modified
2694
self._inventory_is_modified = True
2695
self._move(rename_entries)
2697
# restore the inventory on error
2698
self._inventory_is_modified = original_modified
2700
#FIXME: Should potentially also write the from_invs
2701
self._write_inventory(to_inv)
2702
return rename_tuples
2704
@needs_tree_write_lock
2705
def rename_one(self, from_rel, to_rel, after=False):
2708
This can change the directory or the filename or both.
2710
rename_one has several 'modes' to work. First, it can rename a physical
2711
file and change the file_id. That is the normal mode. Second, it can
2712
only change the file_id without touching any physical file.
2714
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2715
versioned but present in the working tree.
2717
rename_one uses the second mode if 'after == False' and 'from_rel' is
2718
versioned but no longer in the working tree, and 'to_rel' is not
2719
versioned but present in the working tree.
2721
rename_one uses the first mode if 'after == False' and 'from_rel' is
2722
versioned and present in the working tree, and 'to_rel' is not
2723
versioned and not present in the working tree.
2725
Everything else results in an error.
2729
# create rename entries and tuples
2730
from_tail = splitpath(from_rel)[-1]
2731
from_inv, from_id = self._path2inv_file_id(from_rel)
2733
# if file is missing in the inventory maybe it's in the basis_tree
2734
basis_tree = self.branch.basis_tree()
2735
from_id = basis_tree.path2id(from_rel)
2737
raise errors.BzrRenameFailedError(from_rel,to_rel,
2738
errors.NotVersionedError(path=from_rel))
2739
# put entry back in the inventory so we can rename it
2740
from_entry = basis_tree.root_inventory[from_id].copy()
2741
from_inv.add(from_entry)
2743
from_inv, from_inv_id = self._unpack_file_id(from_id)
2744
from_entry = from_inv[from_inv_id]
2745
from_parent_id = from_entry.parent_id
2746
to_dir, to_tail = os.path.split(to_rel)
2747
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2748
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2750
from_tail=from_tail,
2751
from_parent_id=from_parent_id,
2752
to_rel=to_rel, to_tail=to_tail,
2753
to_parent_id=to_dir_id)
2754
rename_entries.append(rename_entry)
2756
# determine which move mode to use. checks also for movability
2757
rename_entries = self._determine_mv_mode(rename_entries, after)
2759
# check if the target changed directory and if the target directory is
2761
if to_dir_id is None:
2762
raise errors.BzrMoveFailedError(from_rel,to_rel,
2763
errors.NotVersionedError(path=to_dir))
2765
# all checks done. now we can continue with our actual work
2766
mutter('rename_one:\n'
2771
' to_dir_id {%s}\n',
2772
from_id, from_rel, to_rel, to_dir, to_dir_id)
2774
self._move(rename_entries)
2775
self._write_inventory(to_inv)
2777
class _RenameEntry(object):
2778
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2779
to_rel, to_tail, to_parent_id, only_change_inv=False,
2781
self.from_rel = from_rel
2782
self.from_id = from_id
2783
self.from_tail = from_tail
2784
self.from_parent_id = from_parent_id
2785
self.to_rel = to_rel
2786
self.to_tail = to_tail
2787
self.to_parent_id = to_parent_id
2788
self.change_id = change_id
2789
self.only_change_inv = only_change_inv
2791
def _determine_mv_mode(self, rename_entries, after=False):
2792
"""Determines for each from-to pair if both inventory and working tree
2793
or only the inventory has to be changed.
2795
Also does basic plausability tests.
2797
# FIXME: Handling of nested trees
2798
inv = self.root_inventory
2800
for rename_entry in rename_entries:
2801
# store to local variables for easier reference
2802
from_rel = rename_entry.from_rel
2803
from_id = rename_entry.from_id
2804
to_rel = rename_entry.to_rel
2805
to_id = inv.path2id(to_rel)
2806
only_change_inv = False
2809
# check the inventory for source and destination
2811
raise errors.BzrMoveFailedError(from_rel,to_rel,
2812
errors.NotVersionedError(path=from_rel))
2813
if to_id is not None:
2815
# allow it with --after but only if dest is newly added
2817
basis = self.basis_tree()
2820
if not basis.has_id(to_id):
2821
rename_entry.change_id = True
2826
raise errors.BzrMoveFailedError(from_rel,to_rel,
2827
errors.AlreadyVersionedError(path=to_rel))
2829
# try to determine the mode for rename (only change inv or change
2830
# inv and file system)
2832
if not self.has_filename(to_rel):
2833
raise errors.BzrMoveFailedError(from_id,to_rel,
2834
errors.NoSuchFile(path=to_rel,
2835
extra="New file has not been created yet"))
2836
only_change_inv = True
2837
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2838
only_change_inv = True
2839
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2840
only_change_inv = False
2841
elif (not self.case_sensitive
2842
and from_rel.lower() == to_rel.lower()
2843
and self.has_filename(from_rel)):
2844
only_change_inv = False
2846
# something is wrong, so lets determine what exactly
2847
if not self.has_filename(from_rel) and \
2848
not self.has_filename(to_rel):
2849
raise errors.BzrRenameFailedError(from_rel, to_rel,
2850
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2852
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2853
rename_entry.only_change_inv = only_change_inv
2854
return rename_entries
2856
def _move(self, rename_entries):
2857
"""Moves a list of files.
2859
Depending on the value of the flag 'only_change_inv', the
2860
file will be moved on the file system or not.
2864
for entry in rename_entries:
2866
self._move_entry(entry)
2868
self._rollback_move(moved)
2872
def _rollback_move(self, moved):
2873
"""Try to rollback a previous move in case of an filesystem error."""
2876
self._move_entry(WorkingTree._RenameEntry(
2877
entry.to_rel, entry.from_id,
2878
entry.to_tail, entry.to_parent_id, entry.from_rel,
2879
entry.from_tail, entry.from_parent_id,
2880
entry.only_change_inv))
2881
except errors.BzrMoveFailedError, e:
2882
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2883
" The working tree is in an inconsistent state."
2884
" Please consider doing a 'bzr revert'."
2885
" Error message is: %s" % e)
2887
def _move_entry(self, entry):
2888
inv = self.root_inventory
2889
from_rel_abs = self.abspath(entry.from_rel)
2890
to_rel_abs = self.abspath(entry.to_rel)
2891
if from_rel_abs == to_rel_abs:
2892
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2893
"Source and target are identical.")
2895
if not entry.only_change_inv:
2897
osutils.rename(from_rel_abs, to_rel_abs)
2899
raise errors.BzrMoveFailedError(entry.from_rel,
2902
to_id = inv.path2id(entry.to_rel)
2903
inv.remove_recursive_id(to_id)
2904
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2906
@needs_tree_write_lock
2907
def unversion(self, file_ids):
2908
"""Remove the file ids in file_ids from the current versioned set.
2910
When a file_id is unversioned, all of its children are automatically
2913
:param file_ids: The file ids to stop versioning.
2914
:raises: NoSuchId if any fileid is not currently versioned.
2916
for file_id in file_ids:
2917
if not self._inventory.has_id(file_id):
2918
raise errors.NoSuchId(self, file_id)
2919
for file_id in file_ids:
2920
if self._inventory.has_id(file_id):
2921
self._inventory.remove_recursive_id(file_id)
2923
# in the future this should just set a dirty bit to wait for the
2924
# final unlock. However, until all methods of workingtree start
2925
# with the current in -memory inventory rather than triggering
2926
# a read, it is more complex - we need to teach read_inventory
2927
# to know when to read, and when to not read first... and possibly
2928
# to save first when the in memory one may be corrupted.
2929
# so for now, we just only write it if it is indeed dirty.
2931
self._write_inventory(self._inventory)
2933
def stored_kind(self, file_id):
2934
"""See Tree.stored_kind"""
2935
inv, inv_file_id = self._unpack_file_id(file_id)
2936
return inv[inv_file_id].kind
2939
"""Yield all unversioned files in this WorkingTree.
2941
If there are any unversioned directories then only the directory is
2942
returned, not all its children. But if there are unversioned files
2943
under a versioned subdirectory, they are returned.
2945
Currently returned depth-first, sorted by name within directories.
2946
This is the same order used by 'osutils.walkdirs'.
2948
## TODO: Work from given directory downwards
2949
for path, dir_entry in self.iter_entries_by_dir():
2950
if dir_entry.kind != 'directory':
2952
# mutter("search for unknowns in %r", path)
2953
dirabs = self.abspath(path)
2954
if not isdir(dirabs):
2955
# e.g. directory deleted
2959
for subf in os.listdir(dirabs):
2960
if self.bzrdir.is_control_filename(subf):
2962
if subf not in dir_entry.children:
2965
can_access) = osutils.normalized_filename(subf)
2966
except UnicodeDecodeError:
2967
path_os_enc = path.encode(osutils._fs_enc)
2968
relpath = path_os_enc + '/' + subf
2969
raise errors.BadFilenameEncoding(relpath,
2971
if subf_norm != subf and can_access:
2972
if subf_norm not in dir_entry.children:
2973
fl.append(subf_norm)
2979
subp = pathjoin(path, subf)
2982
def _walkdirs(self, prefix=""):
2983
"""Walk the directories of this tree.
2985
:param prefix: is used as the directrory to start with.
2986
:returns: a generator which yields items in the form::
2988
((curren_directory_path, fileid),
2989
[(file1_path, file1_name, file1_kind, None, file1_id,
2992
_directory = 'directory'
2993
# get the root in the inventory
2994
inv, top_id = self._path2inv_file_id(prefix)
2998
pending = [(prefix, '', _directory, None, top_id, None)]
3001
currentdir = pending.pop()
3002
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
3003
top_id = currentdir[4]
3005
relroot = currentdir[0] + '/'
3008
# FIXME: stash the node in pending
3010
if entry.kind == 'directory':
3011
for name, child in entry.sorted_children():
3012
dirblock.append((relroot + name, name, child.kind, None,
3013
child.file_id, child.kind
3015
yield (currentdir[0], entry.file_id), dirblock
3016
# push the user specified dirs from dirblock
3017
for dir in reversed(dirblock):
3018
if dir[2] == _directory:
3022
def update_feature_flags(self, updated_flags):
3023
"""Update the feature flags for this branch.
3025
:param updated_flags: Dictionary mapping feature names to necessities
3026
A necessity can be None to indicate the feature should be removed
3028
self._format._update_feature_flags(updated_flags)
3029
self.control_transport.put_bytes('format', self._format.as_string())
3032
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
3033
"""Registry for working tree formats."""
3035
def __init__(self, other_registry=None):
3036
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
3037
self._default_format = None
3038
self._default_format_key = None
3040
def get_default(self):
3041
"""Return the current default format."""
3042
if (self._default_format_key is not None and
3043
self._default_format is None):
3044
self._default_format = self.get(self._default_format_key)
3045
return self._default_format
3047
def set_default(self, format):
3048
"""Set the default format."""
3049
self._default_format = format
3050
self._default_format_key = None
3052
def set_default_key(self, format_string):
3053
"""Set the default format by its format string."""
3054
self._default_format_key = format_string
3055
self._default_format = None
3058
format_registry = WorkingTreeFormatRegistry()
3061
class WorkingTreeFormat(controldir.ControlComponentFormat):
2403
if filename == head:
2409
class WorkingTreeFormat(object):
3062
2410
"""An encapsulation of the initialization and open routines for a format.
3064
2412
Formats provide three things:
3120
2467
"""Is this format supported?
3122
2469
Supported formats can be initialized and opened.
3123
Unsupported formats may not support initialization or committing or
2470
Unsupported formats may not support initialization or committing or
3124
2471
some other features depending on the reason for not being supported.
3128
def supports_content_filtering(self):
3129
"""True if this format supports content filtering."""
3132
def supports_views(self):
3133
"""True if this format supports stored views."""
3136
def get_controldir_for_branch(self):
3137
"""Get the control directory format for creating branches.
3139
This is to support testing of working tree formats that can not exist
3140
in the same control directory as a branch.
3142
return self._matchingbzrdir
3145
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3146
"""Base class for working trees that live in bzr meta directories."""
3149
WorkingTreeFormat.__init__(self)
3150
bzrdir.BzrFormat.__init__(self)
3153
def find_format_string(klass, controldir):
3154
"""Return format name for the working tree object in controldir."""
3156
transport = controldir.get_workingtree_transport(None)
3157
return transport.get_bytes("format")
3158
except errors.NoSuchFile:
3159
raise errors.NoWorkingTree(base=transport.base)
3162
def find_format(klass, controldir):
3163
"""Return the format for the working tree object in controldir."""
3164
format_string = klass.find_format_string(controldir)
3165
return klass._find_format(format_registry, 'working tree',
3168
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3170
WorkingTreeFormat.check_support_status(self,
3171
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3173
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3174
recommend_upgrade=recommend_upgrade, basedir=basedir)
3176
def get_controldir_for_branch(self):
3177
"""Get the control directory format for creating branches.
3179
This is to support testing of working tree formats that can not exist
3180
in the same control directory as a branch.
3182
return self._matchingbzrdir
3185
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3186
"""Base class for working trees that live in bzr meta directories."""
3189
WorkingTreeFormat.__init__(self)
3190
bzrdir.BzrFormat.__init__(self)
3193
def find_format_string(klass, controldir):
3194
"""Return format name for the working tree object in controldir."""
3196
transport = controldir.get_workingtree_transport(None)
3197
return transport.get_bytes("format")
3198
except errors.NoSuchFile:
3199
raise errors.NoWorkingTree(base=transport.base)
3202
def find_format(klass, controldir):
3203
"""Return the format for the working tree object in controldir."""
3204
format_string = klass.find_format_string(controldir)
3205
return klass._find_format(format_registry, 'working tree',
3208
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3210
WorkingTreeFormat.check_support_status(self,
3211
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3213
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3214
recommend_upgrade=recommend_upgrade, basedir=basedir)
3217
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3218
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3219
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3220
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3221
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3222
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3223
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3224
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3225
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
2476
def register_format(klass, format):
2477
klass._formats[format.get_format_string()] = format
2480
def set_default_format(klass, format):
2481
klass._default_format = format
2484
def unregister_format(klass, format):
2485
assert klass._formats[format.get_format_string()] is format
2486
del klass._formats[format.get_format_string()]
2490
class WorkingTreeFormat2(WorkingTreeFormat):
2491
"""The second working tree format.
2493
This format modified the hash cache from the format 1 hash cache.
2496
def get_format_description(self):
2497
"""See WorkingTreeFormat.get_format_description()."""
2498
return "Working tree format 2"
2500
def stub_initialize_remote(self, control_files):
2501
"""As a special workaround create critical control files for a remote working tree
2503
This ensures that it can later be updated and dealt with locally,
2504
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2505
no working tree. (See bug #43064).
2509
xml5.serializer_v5.write_inventory(inv, sio)
2511
control_files.put('inventory', sio)
2513
control_files.put_bytes('pending-merges', '')
2516
def initialize(self, a_bzrdir, revision_id=None):
2517
"""See WorkingTreeFormat.initialize()."""
2518
if not isinstance(a_bzrdir.transport, LocalTransport):
2519
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2520
branch = a_bzrdir.open_branch()
2521
if revision_id is not None:
2522
revision_id = osutils.safe_revision_id(revision_id)
2525
revision_history = branch.revision_history()
2527
position = revision_history.index(revision_id)
2529
raise errors.NoSuchRevision(branch, revision_id)
2530
branch.set_revision_history(revision_history[:position + 1])
2533
revision = branch.last_revision()
2535
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2541
basis_tree = branch.repository.revision_tree(revision)
2542
if basis_tree.inventory.root is not None:
2543
wt.set_root_id(basis_tree.inventory.root.file_id)
2544
# set the parent list and cache the basis tree.
2545
wt.set_parent_trees([(revision, basis_tree)])
2546
transform.build_tree(basis_tree, wt)
2550
super(WorkingTreeFormat2, self).__init__()
2551
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2553
def open(self, a_bzrdir, _found=False):
2554
"""Return the WorkingTree object for a_bzrdir
2556
_found is a private parameter, do not use it. It is used to indicate
2557
if format probing has already been done.
2560
# we are being called directly and must probe.
2561
raise NotImplementedError
2562
if not isinstance(a_bzrdir.transport, LocalTransport):
2563
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2564
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2570
class WorkingTreeFormat3(WorkingTreeFormat):
2571
"""The second working tree format updated to record a format marker.
2574
- exists within a metadir controlling .bzr
2575
- includes an explicit version marker for the workingtree control
2576
files, separate from the BzrDir format
2577
- modifies the hash cache format
2579
- uses a LockDir to guard access for writes.
2582
def get_format_string(self):
2583
"""See WorkingTreeFormat.get_format_string()."""
2584
return "Bazaar-NG Working Tree format 3"
2586
def get_format_description(self):
2587
"""See WorkingTreeFormat.get_format_description()."""
2588
return "Working tree format 3"
2590
_lock_file_name = 'lock'
2591
_lock_class = LockDir
2593
_tree_class = WorkingTree3
2595
def __get_matchingbzrdir(self):
2596
return bzrdir.BzrDirMetaFormat1()
2598
_matchingbzrdir = property(__get_matchingbzrdir)
2600
def _open_control_files(self, a_bzrdir):
2601
transport = a_bzrdir.get_workingtree_transport(None)
2602
return LockableFiles(transport, self._lock_file_name,
2605
def initialize(self, a_bzrdir, revision_id=None):
2606
"""See WorkingTreeFormat.initialize().
2608
revision_id allows creating a working tree at a different
2609
revision than the branch is at.
2611
if not isinstance(a_bzrdir.transport, LocalTransport):
2612
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2613
transport = a_bzrdir.get_workingtree_transport(self)
2614
control_files = self._open_control_files(a_bzrdir)
2615
control_files.create_lock()
2616
control_files.lock_write()
2617
control_files.put_utf8('format', self.get_format_string())
2618
branch = a_bzrdir.open_branch()
2619
if revision_id is None:
2620
revision_id = branch.last_revision()
2622
revision_id = osutils.safe_revision_id(revision_id)
2623
# WorkingTree3 can handle an inventory which has a unique root id.
2624
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2625
# those trees. And because there isn't a format bump inbetween, we
2626
# are maintaining compatibility with older clients.
2627
# inv = Inventory(root_id=gen_root_id())
2628
inv = self._initial_inventory()
2629
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2635
_control_files=control_files)
2636
wt.lock_tree_write()
2638
basis_tree = branch.repository.revision_tree(revision_id)
2639
# only set an explicit root id if there is one to set.
2640
if basis_tree.inventory.root is not None:
2641
wt.set_root_id(basis_tree.inventory.root.file_id)
2642
if revision_id == NULL_REVISION:
2643
wt.set_parent_trees([])
2645
wt.set_parent_trees([(revision_id, basis_tree)])
2646
transform.build_tree(basis_tree, wt)
2648
# Unlock in this order so that the unlock-triggers-flush in
2649
# WorkingTree is given a chance to fire.
2650
control_files.unlock()
2654
def _initial_inventory(self):
2658
super(WorkingTreeFormat3, self).__init__()
2660
def open(self, a_bzrdir, _found=False):
2661
"""Return the WorkingTree object for a_bzrdir
2663
_found is a private parameter, do not use it. It is used to indicate
2664
if format probing has already been done.
2667
# we are being called directly and must probe.
2668
raise NotImplementedError
2669
if not isinstance(a_bzrdir.transport, LocalTransport):
2670
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2671
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2673
def _open(self, a_bzrdir, control_files):
2674
"""Open the tree itself.
2676
:param a_bzrdir: the dir for the tree.
2677
:param control_files: the control files for the tree.
2679
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2683
_control_files=control_files)
2686
return self.get_format_string()
2689
__default_format = WorkingTreeFormat4()
2690
WorkingTreeFormat.register_format(__default_format)
2691
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2692
WorkingTreeFormat.set_default_format(__default_format)
2693
# formats which have no format string are not discoverable
2694
# and not independently creatable, so are not registered.
2695
_legacy_formats = [WorkingTreeFormat2(),
2699
class WorkingTreeTestProviderAdapter(object):
2700
"""A tool to generate a suite testing multiple workingtree formats at once.
2702
This is done by copying the test once for each transport and injecting
2703
the transport_server, transport_readonly_server, and workingtree_format
2704
classes into each copy. Each copy is also given a new id() to make it
2708
def __init__(self, transport_server, transport_readonly_server, formats):
2709
self._transport_server = transport_server
2710
self._transport_readonly_server = transport_readonly_server
2711
self._formats = formats
2713
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2714
"""Clone test for adaption."""
2715
new_test = deepcopy(test)
2716
new_test.transport_server = self._transport_server
2717
new_test.transport_readonly_server = self._transport_readonly_server
2718
new_test.bzrdir_format = bzrdir_format
2719
new_test.workingtree_format = workingtree_format
2720
def make_new_test_id():
2721
new_id = "%s(%s)" % (test.id(), variation)
2722
return lambda: new_id
2723
new_test.id = make_new_test_id()
2726
def adapt(self, test):
2727
from bzrlib.tests import TestSuite
2728
result = TestSuite()
2729
for workingtree_format, bzrdir_format in self._formats:
2730
new_test = self._clone_test(
2733
workingtree_format, workingtree_format.__class__.__name__)
2734
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
