893
828
self.add(path, file_id, 'directory')
896
def get_symlink_target(self, file_id):
897
file_id = osutils.safe_file_id(file_id)
898
return os.readlink(self.id2abspath(file_id))
831
def get_symlink_target(self, file_id, path=None):
833
abspath = self.abspath(path)
835
abspath = self.id2abspath(file_id)
836
target = osutils.readlink(abspath)
901
839
def subsume(self, other_tree):
902
def add_children(inventory, entry):
903
for child_entry in entry.children.values():
904
inventory._byid[child_entry.file_id] = child_entry
905
if child_entry.kind == 'directory':
906
add_children(inventory, child_entry)
907
if other_tree.get_root_id() == self.get_root_id():
908
raise errors.BadSubsumeSource(self, other_tree,
909
'Trees have the same root')
911
other_tree_path = self.relpath(other_tree.basedir)
912
except errors.PathNotChild:
913
raise errors.BadSubsumeSource(self, other_tree,
914
'Tree is not contained by the other')
915
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
916
if new_root_parent is None:
917
raise errors.BadSubsumeSource(self, other_tree,
918
'Parent directory is not versioned.')
919
# We need to ensure that the result of a fetch will have a
920
# versionedfile for the other_tree root, and only fetching into
921
# RepositoryKnit2 guarantees that.
922
if not self.branch.repository.supports_rich_root():
923
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
924
other_tree.lock_tree_write()
926
new_parents = other_tree.get_parent_ids()
927
other_root = other_tree.inventory.root
928
other_root.parent_id = new_root_parent
929
other_root.name = osutils.basename(other_tree_path)
930
self.inventory.add(other_root)
931
add_children(self.inventory, other_root)
932
self._write_inventory(self.inventory)
933
# normally we don't want to fetch whole repositories, but i think
934
# here we really do want to consolidate the whole thing.
935
for parent_id in other_tree.get_parent_ids():
936
self.branch.fetch(other_tree.branch, parent_id)
937
self.add_parent_tree_id(parent_id)
940
other_tree.bzrdir.retire_bzrdir()
942
@needs_tree_write_lock
840
raise NotImplementedError(self.subsume)
842
def _setup_directory_is_tree_reference(self):
843
if self._branch.repository._format.supports_tree_reference:
844
self._directory_is_tree_reference = \
845
self._directory_may_be_tree_reference
847
self._directory_is_tree_reference = \
848
self._directory_is_never_tree_reference
850
def _directory_is_never_tree_reference(self, relpath):
853
def _directory_may_be_tree_reference(self, relpath):
854
# as a special case, if a directory contains control files then
855
# it's a tree reference, except that the root of the tree is not
856
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
857
# TODO: We could ask all the control formats whether they
858
# recognize this directory, but at the moment there's no cheap api
859
# to do that. Since we probably can only nest bzr checkouts and
860
# they always use this name it's ok for now. -- mbp 20060306
862
# FIXME: There is an unhandled case here of a subdirectory
863
# containing .bzr but not a branch; that will probably blow up
864
# when you try to commit it. It might happen if there is a
865
# checkout in a subdirectory. This can be avoided by not adding
943
868
def extract(self, file_id, format=None):
944
869
"""Extract a subtree from this tree.
946
871
A new branch will be created, relative to the path for this tree.
949
segments = osutils.splitpath(path)
950
transport = self.branch.bzrdir.root_transport
951
for name in segments:
952
transport = transport.clone(name)
955
except errors.FileExists:
959
sub_path = self.id2path(file_id)
960
branch_transport = mkdirs(sub_path)
962
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
964
branch_transport.mkdir('.')
965
except errors.FileExists:
967
branch_bzrdir = format.initialize_on_transport(branch_transport)
969
repo = branch_bzrdir.find_repository()
970
except errors.NoRepositoryPresent:
971
repo = branch_bzrdir.create_repository()
972
assert repo.supports_rich_root()
974
if not repo.supports_rich_root():
975
raise errors.RootNotRich()
976
new_branch = branch_bzrdir.create_branch()
977
new_branch.pull(self.branch)
978
for parent_id in self.get_parent_ids():
979
new_branch.fetch(self.branch, parent_id)
980
tree_transport = self.bzrdir.root_transport.clone(sub_path)
981
if tree_transport.base != branch_transport.base:
982
tree_bzrdir = format.initialize_on_transport(tree_transport)
983
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
985
tree_bzrdir = branch_bzrdir
986
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
987
wt.set_parent_ids(self.get_parent_ids())
988
my_inv = self.inventory
989
child_inv = Inventory(root_id=None)
990
new_root = my_inv[file_id]
991
my_inv.remove_recursive_id(file_id)
992
new_root.parent_id = None
993
child_inv.add(new_root)
994
self._write_inventory(my_inv)
995
wt._write_inventory(child_inv)
998
def _serialize(self, inventory, out_file):
999
xml5.serializer_v5.write_inventory(self._inventory, out_file)
1001
def _deserialize(selt, in_file):
1002
return xml5.serializer_v5.read_inventory(in_file)
873
raise NotImplementedError(self.extract)
1004
875
def flush(self):
1005
"""Write the in memory inventory to disk."""
1006
# TODO: Maybe this should only write on dirty ?
1007
if self._control_files._lock_mode != 'w':
1008
raise errors.NotWriteLocked(self)
1010
self._serialize(self._inventory, sio)
1012
self._control_files.put('inventory', sio)
1013
self._inventory_is_modified = False
1015
def list_files(self, include_root=False):
1016
"""Recursively list all files as (path, class, kind, id, entry).
876
"""Write the in memory meta data to disk."""
877
raise NotImplementedError(self.flush)
879
def _kind(self, relpath):
880
return osutils.file_kind(self.abspath(relpath))
882
def list_files(self, include_root=False, from_dir=None, recursive=True):
883
"""List all files as (path, class, kind, id, entry).
1018
885
Lists, but does not descend into unversioned directories.
1020
886
This does not include files that have been deleted in this
887
tree. Skips the control directory.
1023
Skips the control directory.
889
:param include_root: if True, return an entry for the root
890
:param from_dir: start from this directory or None for the root
891
:param recursive: whether to recurse into subdirectories or not
1025
# list_files is an iterator, so @needs_read_lock doesn't work properly
1026
# with it. So callers should be careful to always read_lock the tree.
1027
if not self.is_locked():
1028
raise errors.ObjectNotLocked(self)
1030
inv = self.inventory
1031
if include_root is True:
1032
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1033
# Convert these into local objects to save lookup times
1034
pathjoin = osutils.pathjoin
1035
file_kind = osutils.file_kind
1037
# transport.base ends in a slash, we want the piece
1038
# between the last two slashes
1039
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1041
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1043
# directory file_id, relative path, absolute path, reverse sorted children
1044
children = os.listdir(self.basedir)
1046
# jam 20060527 The kernel sized tree seems equivalent whether we
1047
# use a deque and popleft to keep them sorted, or if we use a plain
1048
# list and just reverse() them.
1049
children = collections.deque(children)
1050
stack = [(inv.root.file_id, u'', self.basedir, children)]
1052
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1055
f = children.popleft()
1056
## TODO: If we find a subdirectory with its own .bzr
1057
## directory, then that is a separate tree and we
1058
## should exclude it.
1060
# the bzrdir for this tree
1061
if transport_base_dir == f:
1064
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1065
# and 'f' doesn't begin with one, we can do a string op, rather
1066
# than the checks of pathjoin(), all relative paths will have an extra slash
1068
fp = from_dir_relpath + '/' + f
1071
fap = from_dir_abspath + '/' + f
1073
f_ie = inv.get_child(from_dir_id, f)
1076
elif self.is_ignored(fp[1:]):
1079
# we may not have found this file, because of a unicode issue
1080
f_norm, can_access = osutils.normalized_filename(f)
1081
if f == f_norm or not can_access:
1082
# No change, so treat this file normally
1085
# this file can be accessed by a normalized path
1086
# check again if it is versioned
1087
# these lines are repeated here for performance
1089
fp = from_dir_relpath + '/' + f
1090
fap = from_dir_abspath + '/' + f
1091
f_ie = inv.get_child(from_dir_id, f)
1094
elif self.is_ignored(fp[1:]):
1103
raise errors.BzrCheckError(
1104
"file %r entered as kind %r id %r, now of kind %r"
1105
% (fap, f_ie.kind, f_ie.file_id, fk))
1107
# make a last minute entry
1109
yield fp[1:], c, fk, f_ie.file_id, f_ie
1112
yield fp[1:], c, fk, None, fk_entries[fk]()
1114
yield fp[1:], c, fk, None, TreeEntry()
1117
if fk != 'directory':
1120
# But do this child first
1121
new_children = os.listdir(fap)
1123
new_children = collections.deque(new_children)
1124
stack.append((f_ie.file_id, fp, fap, new_children))
1125
# Break out of inner loop,
1126
# so that we start outer loop with child
1129
# if we finished all children, pop it off the stack
1132
@needs_tree_write_lock
1133
def move(self, from_paths, to_dir=None, after=False, **kwargs):
893
raise NotImplementedError(self.list_files)
895
def move(self, from_paths, to_dir=None, after=False):
1134
896
"""Rename files.
1136
to_dir must exist in the inventory.
898
to_dir must be known to the working tree.
1138
900
If to_dir exists and is a directory, the files are moved into
1139
it, keeping their old names.
901
it, keeping their old names.
1141
903
Note that to_dir is only the last component of the new name;
1142
904
this doesn't change the directory.
1646
1145
@needs_read_lock
1647
1146
def _last_revision(self):
1648
1147
"""helper for get_parent_ids."""
1649
return self.branch.last_revision()
1148
return _mod_revision.ensure_null(self.branch.last_revision())
1651
1150
def is_locked(self):
1652
return self._control_files.is_locked()
1654
def _must_be_locked(self):
1655
if not self.is_locked():
1656
raise errors.ObjectNotLocked(self)
1151
"""Check if this tree is locked."""
1152
raise NotImplementedError(self.is_locked)
1658
1154
def lock_read(self):
1659
"""See Branch.lock_read, and WorkingTree.unlock."""
1660
if not self.is_locked():
1662
self.branch.lock_read()
1664
return self._control_files.lock_read()
1666
self.branch.unlock()
1155
"""Lock the tree for reading.
1157
This also locks the branch, and can be unlocked via self.unlock().
1159
:return: A bzrlib.lock.LogicalLockResult.
1161
raise NotImplementedError(self.lock_read)
1669
1163
def lock_tree_write(self):
1670
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1671
if not self.is_locked():
1673
self.branch.lock_read()
1675
return self._control_files.lock_write()
1677
self.branch.unlock()
1164
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1166
:return: A bzrlib.lock.LogicalLockResult.
1168
raise NotImplementedError(self.lock_tree_write)
1680
1170
def lock_write(self):
1681
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1682
if not self.is_locked():
1684
self.branch.lock_write()
1686
return self._control_files.lock_write()
1688
self.branch.unlock()
1171
"""See MutableTree.lock_write, and WorkingTree.unlock.
1173
:return: A bzrlib.lock.LogicalLockResult.
1175
raise NotImplementedError(self.lock_write)
1691
1177
def get_physical_lock_status(self):
1692
return self._control_files.get_physical_lock_status()
1694
def _basis_inventory_name(self):
1695
return 'basis-inventory-cache'
1697
def _reset_data(self):
1698
"""Reset transient data that cannot be revalidated."""
1699
self._inventory_is_modified = False
1700
result = self._deserialize(self._control_files.get('inventory'))
1701
self._set_inventory(result, dirty=False)
1703
@needs_tree_write_lock
1178
raise NotImplementedError(self.get_physical_lock_status)
1704
1180
def set_last_revision(self, new_revision):
1705
1181
"""Change the last revision in the working tree."""
1706
new_revision = osutils.safe_revision_id(new_revision)
1707
if self._change_last_revision(new_revision):
1708
self._cache_basis_inventory(new_revision)
1182
raise NotImplementedError(self.set_last_revision)
1710
1184
def _change_last_revision(self, new_revision):
1711
1185
"""Template method part of set_last_revision to perform the change.
1713
1187
This is used to allow WorkingTree3 instances to not affect branch
1714
1188
when their last revision is set.
1716
if new_revision is None:
1717
self.branch.set_revision_history([])
1190
if _mod_revision.is_null(new_revision):
1191
self.branch.set_last_revision_info(0, new_revision)
1193
_mod_revision.check_not_reserved_id(new_revision)
1720
1195
self.branch.generate_revision_history(new_revision)
1721
1196
except errors.NoSuchRevision:
1722
1197
# not present in the repo - dont try to set it deeper than the tip
1723
self.branch.set_revision_history([new_revision])
1198
self.branch._set_revision_history([new_revision])
1726
def _write_basis_inventory(self, xml):
1727
"""Write the basis inventory XML to the basis-inventory file"""
1728
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1729
path = self._basis_inventory_name()
1731
self._control_files.put(path, sio)
1733
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1734
"""Create the text that will be saved in basis-inventory"""
1735
# TODO: jam 20070209 This should be redundant, as the revision_id
1736
# as all callers should have already converted the revision_id to
1738
inventory.revision_id = osutils.safe_revision_id(revision_id)
1739
return xml7.serializer_v7.write_inventory_to_string(inventory)
1741
def _cache_basis_inventory(self, new_revision):
1742
"""Cache new_revision as the basis inventory."""
1743
# TODO: this should allow the ready-to-use inventory to be passed in,
1744
# as commit already has that ready-to-use [while the format is the
1747
# this double handles the inventory - unpack and repack -
1748
# but is easier to understand. We can/should put a conditional
1749
# in here based on whether the inventory is in the latest format
1750
# - perhaps we should repack all inventories on a repository
1752
# the fast path is to copy the raw xml from the repository. If the
1753
# xml contains 'revision_id="', then we assume the right
1754
# revision_id is set. We must check for this full string, because a
1755
# root node id can legitimately look like 'revision_id' but cannot
1757
xml = self.branch.repository.get_inventory_xml(new_revision)
1758
firstline = xml.split('\n', 1)[0]
1759
if (not 'revision_id="' in firstline or
1760
'format="7"' not in firstline):
1761
inv = self.branch.repository.deserialise_inventory(
1763
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1764
self._write_basis_inventory(xml)
1765
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1768
def read_basis_inventory(self):
1769
"""Read the cached basis inventory."""
1770
path = self._basis_inventory_name()
1771
return self._control_files.get(path).read()
1774
def read_working_inventory(self):
1775
"""Read the working inventory.
1777
:raises errors.InventoryModified: read_working_inventory will fail
1778
when the current in memory inventory has been modified.
1780
# conceptually this should be an implementation detail of the tree.
1781
# XXX: Deprecate this.
1782
# ElementTree does its own conversion from UTF-8, so open in
1784
if self._inventory_is_modified:
1785
raise errors.InventoryModified(self)
1786
result = self._deserialize(self._control_files.get('inventory'))
1787
self._set_inventory(result, dirty=False)
1790
1201
@needs_tree_write_lock
1791
def remove(self, files, verbose=False, to_file=None):
1792
"""Remove nominated files from the working inventory..
1794
This does not remove their text. This does not run on XXX on what? RBC
1796
TODO: Refuse to remove modified files unless --force is given?
1798
TODO: Do something useful with directories.
1800
TODO: Should this remove the text or not? Tough call; not
1801
removing may be useful and the user can just use use rm, and
1802
is the opposite of add. Removing it is consistent with most
1803
other tools. Maybe an option.
1202
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1204
"""Remove nominated files from the working tree metadata.
1206
:files: File paths relative to the basedir.
1207
:keep_files: If true, the files will also be kept.
1208
:force: Delete files and directories, even if they are changed and
1209
even if the directories are not empty.
1805
## TODO: Normalize names
1806
## TODO: Remove nested loops; better scalability
1807
1211
if isinstance(files, basestring):
1808
1212
files = [files]
1810
inv = self.inventory
1812
# do this before any modifications
1216
all_files = set() # specified and nested files
1217
unknown_nested_files=set()
1219
to_file = sys.stdout
1221
files_to_backup = []
1223
def recurse_directory_to_add_files(directory):
1224
# Recurse directory and add all files
1225
# so we can check if they have changed.
1226
for parent_info, file_infos in self.walkdirs(directory):
1227
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1228
# Is it versioned or ignored?
1229
if self.path2id(relpath):
1230
# Add nested content for deletion.
1231
all_files.add(relpath)
1233
# Files which are not versioned
1234
# should be treated as unknown.
1235
files_to_backup.append(relpath)
1237
for filename in files:
1238
# Get file name into canonical form.
1239
abspath = self.abspath(filename)
1240
filename = self.relpath(abspath)
1241
if len(filename) > 0:
1242
all_files.add(filename)
1243
recurse_directory_to_add_files(filename)
1245
files = list(all_files)
1248
return # nothing to do
1250
# Sort needed to first handle directory content before the directory
1251
files.sort(reverse=True)
1253
# Bail out if we are going to delete files we shouldn't
1254
if not keep_files and not force:
1255
for (file_id, path, content_change, versioned, parent_id, name,
1256
kind, executable) in self.iter_changes(self.basis_tree(),
1257
include_unchanged=True, require_versioned=False,
1258
want_unversioned=True, specific_files=files):
1259
if versioned[0] == False:
1260
# The record is unknown or newly added
1261
files_to_backup.append(path[1])
1262
elif (content_change and (kind[1] is not None) and
1263
osutils.is_inside_any(files, path[1])):
1264
# Versioned and changed, but not deleted, and still
1265
# in one of the dirs to be deleted.
1266
files_to_backup.append(path[1])
1268
def backup(file_to_backup):
1269
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1270
osutils.rename(abs_path, self.abspath(backup_name))
1271
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1274
# Build inv_delta and delete files where applicable,
1275
# do this before any modifications to meta data.
1813
1276
for f in files:
1814
fid = inv.path2id(f)
1277
fid = self.path2id(f)
1816
note("%s is not versioned."%f)
1280
message = "%s is not versioned." % (f,)
1819
# having remove it, it must be either ignored or unknown
1283
# having removed it, it must be either ignored or unknown
1820
1284
if self.is_ignored(f):
1821
1285
new_status = 'I'
1823
1287
new_status = '?'
1824
textui.show_status(new_status, inv[fid].kind, f,
1828
self._write_inventory(inv)
1288
# XXX: Really should be a more abstract reporter interface
1289
kind_ch = osutils.kind_marker(self.kind(fid))
1290
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1292
inv_delta.append((f, None, fid, None))
1293
message = "removed %s" % (f,)
1296
abs_path = self.abspath(f)
1297
if osutils.lexists(abs_path):
1298
if (osutils.isdir(abs_path) and
1299
len(os.listdir(abs_path)) > 0):
1301
osutils.rmtree(abs_path)
1302
message = "deleted %s" % (f,)
1306
if f in files_to_backup:
1309
osutils.delete_any(abs_path)
1310
message = "deleted %s" % (f,)
1311
elif message is not None:
1312
# Only care if we haven't done anything yet.
1313
message = "%s does not exist." % (f,)
1315
# Print only one message (if any) per file.
1316
if message is not None:
1318
self.apply_inventory_delta(inv_delta)
1830
1320
@needs_tree_write_lock
1831
def revert(self, filenames, old_tree=None, backups=True,
1832
pb=DummyProgress(), report_changes=False):
1321
def revert(self, filenames=None, old_tree=None, backups=True,
1322
pb=None, report_changes=False):
1833
1323
from bzrlib.conflicts import resolve
1834
1324
if old_tree is None:
1835
old_tree = self.basis_tree()
1836
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1838
if not len(filenames):
1839
self.set_parent_ids(self.get_parent_ids()[:1])
1325
basis_tree = self.basis_tree()
1326
basis_tree.lock_read()
1327
old_tree = basis_tree
1842
resolve(self, filenames, ignore_misses=True)
1331
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1333
if filenames is None and len(self.get_parent_ids()) > 1:
1335
last_revision = self.last_revision()
1336
if last_revision != _mod_revision.NULL_REVISION:
1337
if basis_tree is None:
1338
basis_tree = self.basis_tree()
1339
basis_tree.lock_read()
1340
parent_trees.append((last_revision, basis_tree))
1341
self.set_parent_trees(parent_trees)
1344
resolve(self, filenames, ignore_misses=True, recursive=True)
1346
if basis_tree is not None:
1843
1348
return conflicts
1845
1350
def revision_tree(self, revision_id):
2289
1698
self.set_conflicts(un_resolved)
2290
1699
return un_resolved, resolved
2293
class WorkingTree2(WorkingTree):
2294
"""This is the Format 2 working tree.
2296
This was the first weave based working tree.
2297
- uses os locks for locking.
2298
- uses the branch last-revision.
1701
def _validate(self):
1702
"""Validate internal structures.
1704
This is meant mostly for the test suite. To give it a chance to detect
1705
corruption after actions have occurred. The default implementation is a
1708
:return: None. An exception should be raised if there is an error.
1712
def check_state(self):
1713
"""Check that the working state is/isn't valid."""
1714
raise NotImplementedError(self.check_state)
1716
def reset_state(self, revision_ids=None):
1717
"""Reset the state of the working tree.
1719
This does a hard-reset to a last-known-good state. This is a way to
1720
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1722
raise NotImplementedError(self.reset_state)
1724
def _get_rules_searcher(self, default_searcher):
1725
"""See Tree._get_rules_searcher."""
1726
if self._rules_searcher is None:
1727
self._rules_searcher = super(WorkingTree,
1728
self)._get_rules_searcher(default_searcher)
1729
return self._rules_searcher
1731
def get_shelf_manager(self):
1732
"""Return the ShelfManager for this WorkingTree."""
1733
from bzrlib.shelf import ShelfManager
1734
return ShelfManager(self, self._transport)
1737
class InventoryWorkingTree(WorkingTree,
1738
bzrlib.mutabletree.MutableInventoryTree):
1739
"""Base class for working trees that are inventory-oriented.
1741
The inventory is held in the `Branch` working-inventory, and the
1742
files are in a directory on disk.
1744
It is possible for a `WorkingTree` to have a filename which is
1745
not listed in the Inventory and vice versa.
1748
def __init__(self, basedir='.',
1749
branch=DEPRECATED_PARAMETER,
1751
_control_files=None,
1755
"""Construct a InventoryWorkingTree instance. This is not a public API.
1757
:param branch: A branch to override probing for the branch.
1759
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1760
branch=branch, _transport=_control_files._transport,
1761
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1763
self._control_files = _control_files
1764
self._detect_case_handling()
1766
if _inventory is None:
1767
# This will be acquired on lock_read() or lock_write()
1768
self._inventory_is_modified = False
1769
self._inventory = None
1771
# the caller of __init__ has provided an inventory,
1772
# we assume they know what they are doing - as its only
1773
# the Format factory and creation methods that are
1774
# permitted to do this.
1775
self._set_inventory(_inventory, dirty=False)
1777
def _set_inventory(self, inv, dirty):
1778
"""Set the internal cached inventory.
1780
:param inv: The inventory to set.
1781
:param dirty: A boolean indicating whether the inventory is the same
1782
logical inventory as whats on disk. If True the inventory is not
1783
the same and should be written to disk or data will be lost, if
1784
False then the inventory is the same as that on disk and any
1785
serialisation would be unneeded overhead.
1787
self._inventory = inv
1788
self._inventory_is_modified = dirty
1790
def _detect_case_handling(self):
1791
wt_trans = self.bzrdir.get_workingtree_transport(None)
1793
wt_trans.stat(self._format.case_sensitive_filename)
1794
except errors.NoSuchFile:
1795
self.case_sensitive = True
1797
self.case_sensitive = False
1799
self._setup_directory_is_tree_reference()
1801
def _serialize(self, inventory, out_file):
1802
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1805
def _deserialize(selt, in_file):
1806
return xml5.serializer_v5.read_inventory(in_file)
1808
def break_lock(self):
1809
"""Break a lock if one is present from another instance.
1811
Uses the ui factory to ask for confirmation if the lock may be from
1814
This will probe the repository for its lock as well.
1816
self._control_files.break_lock()
1817
self.branch.break_lock()
1819
def is_locked(self):
1820
return self._control_files.is_locked()
1822
def _must_be_locked(self):
1823
if not self.is_locked():
1824
raise errors.ObjectNotLocked(self)
1826
def lock_read(self):
1827
"""Lock the tree for reading.
1829
This also locks the branch, and can be unlocked via self.unlock().
1831
:return: A bzrlib.lock.LogicalLockResult.
1833
if not self.is_locked():
1835
self.branch.lock_read()
1837
self._control_files.lock_read()
1838
return LogicalLockResult(self.unlock)
1840
self.branch.unlock()
2301
1843
def lock_tree_write(self):
2302
"""See WorkingTree.lock_tree_write().
2304
In Format2 WorkingTrees we have a single lock for the branch and tree
2305
so lock_tree_write() degrades to lock_write().
1844
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1846
:return: A bzrlib.lock.LogicalLockResult.
1848
if not self.is_locked():
1850
self.branch.lock_read()
1852
self._control_files.lock_write()
1853
return LogicalLockResult(self.unlock)
1855
self.branch.unlock()
1858
def lock_write(self):
1859
"""See MutableTree.lock_write, and WorkingTree.unlock.
1861
:return: A bzrlib.lock.LogicalLockResult.
1863
if not self.is_locked():
2307
1865
self.branch.lock_write()
2309
return self._control_files.lock_write()
1867
self._control_files.lock_write()
1868
return LogicalLockResult(self.unlock)
2311
1870
self.branch.unlock()
2315
# we share control files:
2316
if self._control_files._lock_count == 3:
2317
# _inventory_is_modified is always False during a read lock.
2318
if self._inventory_is_modified:
2320
self._write_hashcache_if_dirty()
2322
# reverse order of locking.
1873
def get_physical_lock_status(self):
1874
return self._control_files.get_physical_lock_status()
1876
@needs_tree_write_lock
1877
def _write_inventory(self, inv):
1878
"""Write inventory as the current inventory."""
1879
self._set_inventory(inv, dirty=True)
1882
# XXX: This method should be deprecated in favour of taking in a proper
1883
# new Inventory object.
1884
@needs_tree_write_lock
1885
def set_inventory(self, new_inventory_list):
1886
from bzrlib.inventory import (Inventory,
1890
inv = Inventory(self.get_root_id())
1891
for path, file_id, parent, kind in new_inventory_list:
1892
name = os.path.basename(path)
1895
# fixme, there should be a factory function inv,add_??
1896
if kind == 'directory':
1897
inv.add(InventoryDirectory(file_id, name, parent))
1898
elif kind == 'file':
1899
inv.add(InventoryFile(file_id, name, parent))
1900
elif kind == 'symlink':
1901
inv.add(InventoryLink(file_id, name, parent))
1903
raise errors.BzrError("unknown kind %r" % kind)
1904
self._write_inventory(inv)
1906
def _write_basis_inventory(self, xml):
1907
"""Write the basis inventory XML to the basis-inventory file"""
1908
path = self._basis_inventory_name()
1910
self._transport.put_file(path, sio,
1911
mode=self.bzrdir._get_file_mode())
1913
def _reset_data(self):
1914
"""Reset transient data that cannot be revalidated."""
1915
self._inventory_is_modified = False
1916
f = self._transport.get('inventory')
2324
return self._control_files.unlock()
1918
result = self._deserialize(f)
2326
self.branch.unlock()
2329
class WorkingTree3(WorkingTree):
2330
"""This is the Format 3 working tree.
2332
This differs from the base WorkingTree by:
2333
- having its own file lock
2334
- having its own last-revision property.
2336
This is new in bzr 0.8
2340
def _last_revision(self):
2341
"""See Mutable.last_revision."""
1921
self._set_inventory(result, dirty=False)
1923
def _set_root_id(self, file_id):
1924
"""Set the root id for this tree, in a format specific manner.
1926
:param file_id: The file id to assign to the root. It must not be
1927
present in the current inventory or an error will occur. It must
1928
not be None, but rather a valid file id.
1930
inv = self._inventory
1931
orig_root_id = inv.root.file_id
1932
# TODO: it might be nice to exit early if there was nothing
1933
# to do, saving us from trigger a sync on unlock.
1934
self._inventory_is_modified = True
1935
# we preserve the root inventory entry object, but
1936
# unlinkit from the byid index
1937
del inv._byid[inv.root.file_id]
1938
inv.root.file_id = file_id
1939
# and link it into the index with the new changed id.
1940
inv._byid[inv.root.file_id] = inv.root
1941
# and finally update all children to reference the new id.
1942
# XXX: this should be safe to just look at the root.children
1943
# list, not the WHOLE INVENTORY.
1946
if entry.parent_id == orig_root_id:
1947
entry.parent_id = inv.root.file_id
1949
def all_file_ids(self):
1950
"""See Tree.iter_all_file_ids"""
1951
return set(self.inventory)
1953
@needs_tree_write_lock
1954
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1955
"""See MutableTree.set_parent_trees."""
1956
parent_ids = [rev for (rev, tree) in parents_list]
1957
for revision_id in parent_ids:
1958
_mod_revision.check_not_reserved_id(revision_id)
1960
self._check_parents_for_ghosts(parent_ids,
1961
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1963
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1965
if len(parent_ids) == 0:
1966
leftmost_parent_id = _mod_revision.NULL_REVISION
1967
leftmost_parent_tree = None
1969
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1971
if self._change_last_revision(leftmost_parent_id):
1972
if leftmost_parent_tree is None:
1973
# If we don't have a tree, fall back to reading the
1974
# parent tree from the repository.
1975
self._cache_basis_inventory(leftmost_parent_id)
1977
inv = leftmost_parent_tree.inventory
1978
xml = self._create_basis_xml_from_inventory(
1979
leftmost_parent_id, inv)
1980
self._write_basis_inventory(xml)
1981
self._set_merges_from_parent_ids(parent_ids)
1983
def _cache_basis_inventory(self, new_revision):
1984
"""Cache new_revision as the basis inventory."""
1985
# TODO: this should allow the ready-to-use inventory to be passed in,
1986
# as commit already has that ready-to-use [while the format is the
2343
return osutils.safe_revision_id(
2344
self._control_files.get('last-revision').read())
2345
except errors.NoSuchFile:
2348
def _change_last_revision(self, revision_id):
2349
"""See WorkingTree._change_last_revision."""
2350
if revision_id is None or revision_id == NULL_REVISION:
2352
self._control_files._transport.delete('last-revision')
2353
except errors.NoSuchFile:
2357
self._control_files.put_bytes('last-revision', revision_id)
1989
# this double handles the inventory - unpack and repack -
1990
# but is easier to understand. We can/should put a conditional
1991
# in here based on whether the inventory is in the latest format
1992
# - perhaps we should repack all inventories on a repository
1994
# the fast path is to copy the raw xml from the repository. If the
1995
# xml contains 'revision_id="', then we assume the right
1996
# revision_id is set. We must check for this full string, because a
1997
# root node id can legitimately look like 'revision_id' but cannot
1999
xml = self.branch.repository._get_inventory_xml(new_revision)
2000
firstline = xml.split('\n', 1)[0]
2001
if (not 'revision_id="' in firstline or
2002
'format="7"' not in firstline):
2003
inv = self.branch.repository._serializer.read_inventory_from_string(
2005
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2006
self._write_basis_inventory(xml)
2007
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2010
def _basis_inventory_name(self):
2011
return 'basis-inventory-cache'
2013
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2014
"""Create the text that will be saved in basis-inventory"""
2015
inventory.revision_id = revision_id
2016
return xml7.serializer_v7.write_inventory_to_string(inventory)
2360
2018
@needs_tree_write_lock
2361
2019
def set_conflicts(self, conflicts):
2362
self._put_rio('conflicts', conflicts.to_stanzas(),
2020
self._put_rio('conflicts', conflicts.to_stanzas(),
2363
2021
CONFLICT_HEADER_1)
2365
2023
@needs_tree_write_lock
2372
2030
@needs_read_lock
2373
2031
def conflicts(self):
2375
confile = self._control_files.get('conflicts')
2033
confile = self._transport.get('conflicts')
2376
2034
except errors.NoSuchFile:
2377
2035
return _mod_conflicts.ConflictList()
2379
if confile.next() != CONFLICT_HEADER_1 + '\n':
2038
if confile.next() != CONFLICT_HEADER_1 + '\n':
2039
raise errors.ConflictFormatError()
2040
except StopIteration:
2380
2041
raise errors.ConflictFormatError()
2381
except StopIteration:
2382
raise errors.ConflictFormatError()
2383
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2386
if self._control_files._lock_count == 1:
2387
# _inventory_is_modified is always False during a read lock.
2388
if self._inventory_is_modified:
2390
self._write_hashcache_if_dirty()
2391
# reverse order of locking.
2042
reader = _mod_rio.RioReader(confile)
2043
return _mod_conflicts.ConflictList.from_stanzas(reader)
2047
def read_basis_inventory(self):
2048
"""Read the cached basis inventory."""
2049
path = self._basis_inventory_name()
2050
return self._transport.get_bytes(path)
2053
def read_working_inventory(self):
2054
"""Read the working inventory.
2056
:raises errors.InventoryModified: read_working_inventory will fail
2057
when the current in memory inventory has been modified.
2059
# conceptually this should be an implementation detail of the tree.
2060
# XXX: Deprecate this.
2061
# ElementTree does its own conversion from UTF-8, so open in
2063
if self._inventory_is_modified:
2064
raise errors.InventoryModified(self)
2065
f = self._transport.get('inventory')
2393
return self._control_files.unlock()
2067
result = self._deserialize(f)
2395
self.branch.unlock()
2398
def get_conflicted_stem(path):
2399
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2400
if path.endswith(suffix):
2401
return path[:-len(suffix)]
2404
@deprecated_function(zero_eight)
2405
def is_control_file(filename):
2406
"""See WorkingTree.is_control_filename(filename)."""
2407
## FIXME: better check
2408
filename = normpath(filename)
2409
while filename != '':
2410
head, tail = os.path.split(filename)
2411
## mutter('check %r for control file' % ((head, tail),))
2070
self._set_inventory(result, dirty=False)
2074
def get_root_id(self):
2075
"""Return the id of this trees root"""
2076
return self._inventory.root.file_id
2078
def has_id(self, file_id):
2079
# files that have been deleted are excluded
2080
inv = self.inventory
2081
if not inv.has_id(file_id):
2083
path = inv.id2path(file_id)
2084
return osutils.lexists(self.abspath(path))
2086
def has_or_had_id(self, file_id):
2087
if file_id == self.inventory.root.file_id:
2414
if filename == head:
2420
class WorkingTreeFormat(object):
2089
return self.inventory.has_id(file_id)
2091
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2093
"""Iterate through file_ids for this tree.
2095
file_ids are in a WorkingTree if they are in the working inventory
2096
and the working file exists.
2098
inv = self._inventory
2099
for path, ie in inv.iter_entries():
2100
if osutils.lexists(self.abspath(path)):
2103
@needs_tree_write_lock
2104
def set_last_revision(self, new_revision):
2105
"""Change the last revision in the working tree."""
2106
if self._change_last_revision(new_revision):
2107
self._cache_basis_inventory(new_revision)
2109
def _get_check_refs(self):
2110
"""Return the references needed to perform a check of this tree.
2112
The default implementation returns no refs, and is only suitable for
2113
trees that have no local caching and can commit on ghosts at any time.
2115
:seealso: bzrlib.check for details about check_refs.
2120
def _check(self, references):
2121
"""Check the tree for consistency.
2123
:param references: A dict with keys matching the items returned by
2124
self._get_check_refs(), and values from looking those keys up in
2127
tree_basis = self.basis_tree()
2128
tree_basis.lock_read()
2130
repo_basis = references[('trees', self.last_revision())]
2131
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2132
raise errors.BzrCheckError(
2133
"Mismatched basis inventory content.")
2139
def check_state(self):
2140
"""Check that the working state is/isn't valid."""
2141
check_refs = self._get_check_refs()
2143
for ref in check_refs:
2146
refs[ref] = self.branch.repository.revision_tree(value)
2149
@needs_tree_write_lock
2150
def reset_state(self, revision_ids=None):
2151
"""Reset the state of the working tree.
2153
This does a hard-reset to a last-known-good state. This is a way to
2154
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2156
if revision_ids is None:
2157
revision_ids = self.get_parent_ids()
2158
if not revision_ids:
2159
rt = self.branch.repository.revision_tree(
2160
_mod_revision.NULL_REVISION)
2162
rt = self.branch.repository.revision_tree(revision_ids[0])
2163
self._write_inventory(rt.inventory)
2164
self.set_parent_ids(revision_ids)
2167
"""Write the in memory inventory to disk."""
2168
# TODO: Maybe this should only write on dirty ?
2169
if self._control_files._lock_mode != 'w':
2170
raise errors.NotWriteLocked(self)
2172
self._serialize(self._inventory, sio)
2174
self._transport.put_file('inventory', sio,
2175
mode=self.bzrdir._get_file_mode())
2176
self._inventory_is_modified = False
2178
def get_file_mtime(self, file_id, path=None):
2179
"""See Tree.get_file_mtime."""
2181
path = self.inventory.id2path(file_id)
2183
return os.lstat(self.abspath(path)).st_mtime
2185
if e.errno == errno.ENOENT:
2186
raise errors.FileTimestampUnavailable(path)
2189
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2190
file_id = self.path2id(path)
2192
# For unversioned files on win32, we just assume they are not
2195
return self._inventory[file_id].executable
2197
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2198
mode = stat_result.st_mode
2199
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2201
def is_executable(self, file_id, path=None):
2202
if not self._supports_executable():
2203
return self._inventory[file_id].executable
2206
path = self.id2path(file_id)
2207
mode = os.lstat(self.abspath(path)).st_mode
2208
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2210
def _is_executable_from_path_and_stat(self, path, stat_result):
2211
if not self._supports_executable():
2212
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2214
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2216
@needs_tree_write_lock
2217
def _add(self, files, ids, kinds):
2218
"""See MutableTree._add."""
2219
# TODO: Re-adding a file that is removed in the working copy
2220
# should probably put it back with the previous ID.
2221
# the read and write working inventory should not occur in this
2222
# function - they should be part of lock_write and unlock.
2223
inv = self.inventory
2224
for f, file_id, kind in zip(files, ids, kinds):
2226
inv.add_path(f, kind=kind)
2228
inv.add_path(f, kind=kind, file_id=file_id)
2229
self._inventory_is_modified = True
2231
def revision_tree(self, revision_id):
2232
"""See WorkingTree.revision_id."""
2233
if revision_id == self.last_revision():
2235
xml = self.read_basis_inventory()
2236
except errors.NoSuchFile:
2240
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2241
# dont use the repository revision_tree api because we want
2242
# to supply the inventory.
2243
if inv.revision_id == revision_id:
2244
return revisiontree.InventoryRevisionTree(
2245
self.branch.repository, inv, revision_id)
2246
except errors.BadInventoryFormat:
2248
# raise if there was no inventory, or if we read the wrong inventory.
2249
raise errors.NoSuchRevisionInTree(self, revision_id)
2252
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2253
"""See Tree.annotate_iter
2255
This implementation will use the basis tree implementation if possible.
2256
Lines not in the basis are attributed to CURRENT_REVISION
2258
If there are pending merges, lines added by those merges will be
2259
incorrectly attributed to CURRENT_REVISION (but after committing, the
2260
attribution will be correct).
2262
maybe_file_parent_keys = []
2263
for parent_id in self.get_parent_ids():
2265
parent_tree = self.revision_tree(parent_id)
2266
except errors.NoSuchRevisionInTree:
2267
parent_tree = self.branch.repository.revision_tree(parent_id)
2268
parent_tree.lock_read()
2270
if not parent_tree.has_id(file_id):
2272
ie = parent_tree.inventory[file_id]
2273
if ie.kind != 'file':
2274
# Note: this is slightly unnecessary, because symlinks and
2275
# directories have a "text" which is the empty text, and we
2276
# know that won't mess up annotations. But it seems cleaner
2278
parent_text_key = (file_id, ie.revision)
2279
if parent_text_key not in maybe_file_parent_keys:
2280
maybe_file_parent_keys.append(parent_text_key)
2282
parent_tree.unlock()
2283
graph = _mod_graph.Graph(self.branch.repository.texts)
2284
heads = graph.heads(maybe_file_parent_keys)
2285
file_parent_keys = []
2286
for key in maybe_file_parent_keys:
2288
file_parent_keys.append(key)
2290
# Now we have the parents of this content
2291
annotator = self.branch.repository.texts.get_annotator()
2292
text = self.get_file_text(file_id)
2293
this_key =(file_id, default_revision)
2294
annotator.add_special_text(this_key, file_parent_keys, text)
2295
annotations = [(key[-1], line)
2296
for key, line in annotator.annotate_flat(this_key)]
2299
def _put_rio(self, filename, stanzas, header):
2300
self._must_be_locked()
2301
my_file = _mod_rio.rio_file(stanzas, header)
2302
self._transport.put_file(filename, my_file,
2303
mode=self.bzrdir._get_file_mode())
2305
@needs_tree_write_lock
2306
def set_merge_modified(self, modified_hashes):
2308
for file_id, hash in modified_hashes.iteritems():
2309
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2311
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2314
def merge_modified(self):
2315
"""Return a dictionary of files modified by a merge.
2317
The list is initialized by WorkingTree.set_merge_modified, which is
2318
typically called after we make some automatic updates to the tree
2321
This returns a map of file_id->sha1, containing only files which are
2322
still in the working inventory and have that text hash.
2325
hashfile = self._transport.get('merge-hashes')
2326
except errors.NoSuchFile:
2331
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2332
raise errors.MergeModifiedFormatError()
2333
except StopIteration:
2334
raise errors.MergeModifiedFormatError()
2335
for s in _mod_rio.RioReader(hashfile):
2336
# RioReader reads in Unicode, so convert file_ids back to utf8
2337
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2338
if not self.inventory.has_id(file_id):
2340
text_hash = s.get("hash")
2341
if text_hash == self.get_file_sha1(file_id):
2342
merge_hashes[file_id] = text_hash
2348
def subsume(self, other_tree):
2349
def add_children(inventory, entry):
2350
for child_entry in entry.children.values():
2351
inventory._byid[child_entry.file_id] = child_entry
2352
if child_entry.kind == 'directory':
2353
add_children(inventory, child_entry)
2354
if other_tree.get_root_id() == self.get_root_id():
2355
raise errors.BadSubsumeSource(self, other_tree,
2356
'Trees have the same root')
2358
other_tree_path = self.relpath(other_tree.basedir)
2359
except errors.PathNotChild:
2360
raise errors.BadSubsumeSource(self, other_tree,
2361
'Tree is not contained by the other')
2362
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2363
if new_root_parent is None:
2364
raise errors.BadSubsumeSource(self, other_tree,
2365
'Parent directory is not versioned.')
2366
# We need to ensure that the result of a fetch will have a
2367
# versionedfile for the other_tree root, and only fetching into
2368
# RepositoryKnit2 guarantees that.
2369
if not self.branch.repository.supports_rich_root():
2370
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2371
other_tree.lock_tree_write()
2373
new_parents = other_tree.get_parent_ids()
2374
other_root = other_tree.inventory.root
2375
other_root.parent_id = new_root_parent
2376
other_root.name = osutils.basename(other_tree_path)
2377
self.inventory.add(other_root)
2378
add_children(self.inventory, other_root)
2379
self._write_inventory(self.inventory)
2380
# normally we don't want to fetch whole repositories, but i think
2381
# here we really do want to consolidate the whole thing.
2382
for parent_id in other_tree.get_parent_ids():
2383
self.branch.fetch(other_tree.branch, parent_id)
2384
self.add_parent_tree_id(parent_id)
2387
other_tree.bzrdir.retire_bzrdir()
2389
@needs_tree_write_lock
2390
def extract(self, file_id, format=None):
2391
"""Extract a subtree from this tree.
2393
A new branch will be created, relative to the path for this tree.
2397
segments = osutils.splitpath(path)
2398
transport = self.branch.bzrdir.root_transport
2399
for name in segments:
2400
transport = transport.clone(name)
2401
transport.ensure_base()
2404
sub_path = self.id2path(file_id)
2405
branch_transport = mkdirs(sub_path)
2407
format = self.bzrdir.cloning_metadir()
2408
branch_transport.ensure_base()
2409
branch_bzrdir = format.initialize_on_transport(branch_transport)
2411
repo = branch_bzrdir.find_repository()
2412
except errors.NoRepositoryPresent:
2413
repo = branch_bzrdir.create_repository()
2414
if not repo.supports_rich_root():
2415
raise errors.RootNotRich()
2416
new_branch = branch_bzrdir.create_branch()
2417
new_branch.pull(self.branch)
2418
for parent_id in self.get_parent_ids():
2419
new_branch.fetch(self.branch, parent_id)
2420
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2421
if tree_transport.base != branch_transport.base:
2422
tree_bzrdir = format.initialize_on_transport(tree_transport)
2423
tree_bzrdir.set_branch_reference(new_branch)
2425
tree_bzrdir = branch_bzrdir
2426
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2427
wt.set_parent_ids(self.get_parent_ids())
2428
my_inv = self.inventory
2429
child_inv = inventory.Inventory(root_id=None)
2430
new_root = my_inv[file_id]
2431
my_inv.remove_recursive_id(file_id)
2432
new_root.parent_id = None
2433
child_inv.add(new_root)
2434
self._write_inventory(my_inv)
2435
wt._write_inventory(child_inv)
2438
def list_files(self, include_root=False, from_dir=None, recursive=True):
2439
"""List all files as (path, class, kind, id, entry).
2441
Lists, but does not descend into unversioned directories.
2442
This does not include files that have been deleted in this
2443
tree. Skips the control directory.
2445
:param include_root: if True, return an entry for the root
2446
:param from_dir: start from this directory or None for the root
2447
:param recursive: whether to recurse into subdirectories or not
2449
# list_files is an iterator, so @needs_read_lock doesn't work properly
2450
# with it. So callers should be careful to always read_lock the tree.
2451
if not self.is_locked():
2452
raise errors.ObjectNotLocked(self)
2454
inv = self.inventory
2455
if from_dir is None and include_root is True:
2456
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2457
# Convert these into local objects to save lookup times
2458
pathjoin = osutils.pathjoin
2459
file_kind = self._kind
2461
# transport.base ends in a slash, we want the piece
2462
# between the last two slashes
2463
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2465
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2467
# directory file_id, relative path, absolute path, reverse sorted children
2468
if from_dir is not None:
2469
from_dir_id = inv.path2id(from_dir)
2470
if from_dir_id is None:
2471
# Directory not versioned
2473
from_dir_abspath = pathjoin(self.basedir, from_dir)
2475
from_dir_id = inv.root.file_id
2476
from_dir_abspath = self.basedir
2477
children = os.listdir(from_dir_abspath)
2479
# jam 20060527 The kernel sized tree seems equivalent whether we
2480
# use a deque and popleft to keep them sorted, or if we use a plain
2481
# list and just reverse() them.
2482
children = collections.deque(children)
2483
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2485
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2488
f = children.popleft()
2489
## TODO: If we find a subdirectory with its own .bzr
2490
## directory, then that is a separate tree and we
2491
## should exclude it.
2493
# the bzrdir for this tree
2494
if transport_base_dir == f:
2497
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2498
# and 'f' doesn't begin with one, we can do a string op, rather
2499
# than the checks of pathjoin(), all relative paths will have an extra slash
2501
fp = from_dir_relpath + '/' + f
2504
fap = from_dir_abspath + '/' + f
2506
dir_ie = inv[from_dir_id]
2507
if dir_ie.kind == 'directory':
2508
f_ie = dir_ie.children.get(f)
2513
elif self.is_ignored(fp[1:]):
2516
# we may not have found this file, because of a unicode
2517
# issue, or because the directory was actually a symlink.
2518
f_norm, can_access = osutils.normalized_filename(f)
2519
if f == f_norm or not can_access:
2520
# No change, so treat this file normally
2523
# this file can be accessed by a normalized path
2524
# check again if it is versioned
2525
# these lines are repeated here for performance
2527
fp = from_dir_relpath + '/' + f
2528
fap = from_dir_abspath + '/' + f
2529
f_ie = inv.get_child(from_dir_id, f)
2532
elif self.is_ignored(fp[1:]):
2539
# make a last minute entry
2541
yield fp[1:], c, fk, f_ie.file_id, f_ie
2544
yield fp[1:], c, fk, None, fk_entries[fk]()
2546
yield fp[1:], c, fk, None, TreeEntry()
2549
if fk != 'directory':
2552
# But do this child first if recursing down
2554
new_children = os.listdir(fap)
2556
new_children = collections.deque(new_children)
2557
stack.append((f_ie.file_id, fp, fap, new_children))
2558
# Break out of inner loop,
2559
# so that we start outer loop with child
2562
# if we finished all children, pop it off the stack
2565
@needs_tree_write_lock
2566
def move(self, from_paths, to_dir=None, after=False):
2569
to_dir must exist in the inventory.
2571
If to_dir exists and is a directory, the files are moved into
2572
it, keeping their old names.
2574
Note that to_dir is only the last component of the new name;
2575
this doesn't change the directory.
2577
For each entry in from_paths the move mode will be determined
2580
The first mode moves the file in the filesystem and updates the
2581
inventory. The second mode only updates the inventory without
2582
touching the file on the filesystem.
2584
move uses the second mode if 'after == True' and the target is
2585
either not versioned or newly added, and present in the working tree.
2587
move uses the second mode if 'after == False' and the source is
2588
versioned but no longer in the working tree, and the target is not
2589
versioned but present in the working tree.
2591
move uses the first mode if 'after == False' and the source is
2592
versioned and present in the working tree, and the target is not
2593
versioned and not present in the working tree.
2595
Everything else results in an error.
2597
This returns a list of (from_path, to_path) pairs for each
2598
entry that is moved.
2603
# check for deprecated use of signature
2605
raise TypeError('You must supply a target directory')
2606
# check destination directory
2607
if isinstance(from_paths, basestring):
2609
inv = self.inventory
2610
to_abs = self.abspath(to_dir)
2611
if not isdir(to_abs):
2612
raise errors.BzrMoveFailedError('',to_dir,
2613
errors.NotADirectory(to_abs))
2614
if not self.has_filename(to_dir):
2615
raise errors.BzrMoveFailedError('',to_dir,
2616
errors.NotInWorkingDirectory(to_dir))
2617
to_dir_id = inv.path2id(to_dir)
2618
if to_dir_id is None:
2619
raise errors.BzrMoveFailedError('',to_dir,
2620
errors.NotVersionedError(path=to_dir))
2622
to_dir_ie = inv[to_dir_id]
2623
if to_dir_ie.kind != 'directory':
2624
raise errors.BzrMoveFailedError('',to_dir,
2625
errors.NotADirectory(to_abs))
2627
# create rename entries and tuples
2628
for from_rel in from_paths:
2629
from_tail = splitpath(from_rel)[-1]
2630
from_id = inv.path2id(from_rel)
2632
raise errors.BzrMoveFailedError(from_rel,to_dir,
2633
errors.NotVersionedError(path=from_rel))
2635
from_entry = inv[from_id]
2636
from_parent_id = from_entry.parent_id
2637
to_rel = pathjoin(to_dir, from_tail)
2638
rename_entry = InventoryWorkingTree._RenameEntry(
2641
from_tail=from_tail,
2642
from_parent_id=from_parent_id,
2643
to_rel=to_rel, to_tail=from_tail,
2644
to_parent_id=to_dir_id)
2645
rename_entries.append(rename_entry)
2646
rename_tuples.append((from_rel, to_rel))
2648
# determine which move mode to use. checks also for movability
2649
rename_entries = self._determine_mv_mode(rename_entries, after)
2651
original_modified = self._inventory_is_modified
2654
self._inventory_is_modified = True
2655
self._move(rename_entries)
2657
# restore the inventory on error
2658
self._inventory_is_modified = original_modified
2660
self._write_inventory(inv)
2661
return rename_tuples
2663
@needs_tree_write_lock
2664
def rename_one(self, from_rel, to_rel, after=False):
2667
This can change the directory or the filename or both.
2669
rename_one has several 'modes' to work. First, it can rename a physical
2670
file and change the file_id. That is the normal mode. Second, it can
2671
only change the file_id without touching any physical file.
2673
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2674
versioned but present in the working tree.
2676
rename_one uses the second mode if 'after == False' and 'from_rel' is
2677
versioned but no longer in the working tree, and 'to_rel' is not
2678
versioned but present in the working tree.
2680
rename_one uses the first mode if 'after == False' and 'from_rel' is
2681
versioned and present in the working tree, and 'to_rel' is not
2682
versioned and not present in the working tree.
2684
Everything else results in an error.
2686
inv = self.inventory
2689
# create rename entries and tuples
2690
from_tail = splitpath(from_rel)[-1]
2691
from_id = inv.path2id(from_rel)
2693
# if file is missing in the inventory maybe it's in the basis_tree
2694
basis_tree = self.branch.basis_tree()
2695
from_id = basis_tree.path2id(from_rel)
2697
raise errors.BzrRenameFailedError(from_rel,to_rel,
2698
errors.NotVersionedError(path=from_rel))
2699
# put entry back in the inventory so we can rename it
2700
from_entry = basis_tree.inventory[from_id].copy()
2703
from_entry = inv[from_id]
2704
from_parent_id = from_entry.parent_id
2705
to_dir, to_tail = os.path.split(to_rel)
2706
to_dir_id = inv.path2id(to_dir)
2707
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2709
from_tail=from_tail,
2710
from_parent_id=from_parent_id,
2711
to_rel=to_rel, to_tail=to_tail,
2712
to_parent_id=to_dir_id)
2713
rename_entries.append(rename_entry)
2715
# determine which move mode to use. checks also for movability
2716
rename_entries = self._determine_mv_mode(rename_entries, after)
2718
# check if the target changed directory and if the target directory is
2720
if to_dir_id is None:
2721
raise errors.BzrMoveFailedError(from_rel,to_rel,
2722
errors.NotVersionedError(path=to_dir))
2724
# all checks done. now we can continue with our actual work
2725
mutter('rename_one:\n'
2730
' to_dir_id {%s}\n',
2731
from_id, from_rel, to_rel, to_dir, to_dir_id)
2733
self._move(rename_entries)
2734
self._write_inventory(inv)
2736
class _RenameEntry(object):
2737
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2738
to_rel, to_tail, to_parent_id, only_change_inv=False,
2740
self.from_rel = from_rel
2741
self.from_id = from_id
2742
self.from_tail = from_tail
2743
self.from_parent_id = from_parent_id
2744
self.to_rel = to_rel
2745
self.to_tail = to_tail
2746
self.to_parent_id = to_parent_id
2747
self.change_id = change_id
2748
self.only_change_inv = only_change_inv
2750
def _determine_mv_mode(self, rename_entries, after=False):
2751
"""Determines for each from-to pair if both inventory and working tree
2752
or only the inventory has to be changed.
2754
Also does basic plausability tests.
2756
inv = self.inventory
2758
for rename_entry in rename_entries:
2759
# store to local variables for easier reference
2760
from_rel = rename_entry.from_rel
2761
from_id = rename_entry.from_id
2762
to_rel = rename_entry.to_rel
2763
to_id = inv.path2id(to_rel)
2764
only_change_inv = False
2767
# check the inventory for source and destination
2769
raise errors.BzrMoveFailedError(from_rel,to_rel,
2770
errors.NotVersionedError(path=from_rel))
2771
if to_id is not None:
2773
# allow it with --after but only if dest is newly added
2775
basis = self.basis_tree()
2778
if not basis.has_id(to_id):
2779
rename_entry.change_id = True
2784
raise errors.BzrMoveFailedError(from_rel,to_rel,
2785
errors.AlreadyVersionedError(path=to_rel))
2787
# try to determine the mode for rename (only change inv or change
2788
# inv and file system)
2790
if not self.has_filename(to_rel):
2791
raise errors.BzrMoveFailedError(from_id,to_rel,
2792
errors.NoSuchFile(path=to_rel,
2793
extra="New file has not been created yet"))
2794
only_change_inv = True
2795
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2796
only_change_inv = True
2797
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2798
only_change_inv = False
2799
elif (not self.case_sensitive
2800
and from_rel.lower() == to_rel.lower()
2801
and self.has_filename(from_rel)):
2802
only_change_inv = False
2804
# something is wrong, so lets determine what exactly
2805
if not self.has_filename(from_rel) and \
2806
not self.has_filename(to_rel):
2807
raise errors.BzrRenameFailedError(from_rel, to_rel,
2808
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2810
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2811
rename_entry.only_change_inv = only_change_inv
2812
return rename_entries
2814
def _move(self, rename_entries):
2815
"""Moves a list of files.
2817
Depending on the value of the flag 'only_change_inv', the
2818
file will be moved on the file system or not.
2820
inv = self.inventory
2823
for entry in rename_entries:
2825
self._move_entry(entry)
2827
self._rollback_move(moved)
2831
def _rollback_move(self, moved):
2832
"""Try to rollback a previous move in case of an filesystem error."""
2833
inv = self.inventory
2836
self._move_entry(WorkingTree._RenameEntry(
2837
entry.to_rel, entry.from_id,
2838
entry.to_tail, entry.to_parent_id, entry.from_rel,
2839
entry.from_tail, entry.from_parent_id,
2840
entry.only_change_inv))
2841
except errors.BzrMoveFailedError, e:
2842
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2843
" The working tree is in an inconsistent state."
2844
" Please consider doing a 'bzr revert'."
2845
" Error message is: %s" % e)
2847
def _move_entry(self, entry):
2848
inv = self.inventory
2849
from_rel_abs = self.abspath(entry.from_rel)
2850
to_rel_abs = self.abspath(entry.to_rel)
2851
if from_rel_abs == to_rel_abs:
2852
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2853
"Source and target are identical.")
2855
if not entry.only_change_inv:
2857
osutils.rename(from_rel_abs, to_rel_abs)
2859
raise errors.BzrMoveFailedError(entry.from_rel,
2862
to_id = inv.path2id(entry.to_rel)
2863
inv.remove_recursive_id(to_id)
2864
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2866
@needs_tree_write_lock
2867
def unversion(self, file_ids):
2868
"""Remove the file ids in file_ids from the current versioned set.
2870
When a file_id is unversioned, all of its children are automatically
2873
:param file_ids: The file ids to stop versioning.
2874
:raises: NoSuchId if any fileid is not currently versioned.
2876
for file_id in file_ids:
2877
if not self._inventory.has_id(file_id):
2878
raise errors.NoSuchId(self, file_id)
2879
for file_id in file_ids:
2880
if self._inventory.has_id(file_id):
2881
self._inventory.remove_recursive_id(file_id)
2883
# in the future this should just set a dirty bit to wait for the
2884
# final unlock. However, until all methods of workingtree start
2885
# with the current in -memory inventory rather than triggering
2886
# a read, it is more complex - we need to teach read_inventory
2887
# to know when to read, and when to not read first... and possibly
2888
# to save first when the in memory one may be corrupted.
2889
# so for now, we just only write it if it is indeed dirty.
2891
self._write_inventory(self._inventory)
2893
def stored_kind(self, file_id):
2894
"""See Tree.stored_kind"""
2895
return self.inventory[file_id].kind
2898
"""Yield all unversioned files in this WorkingTree.
2900
If there are any unversioned directories then only the directory is
2901
returned, not all its children. But if there are unversioned files
2902
under a versioned subdirectory, they are returned.
2904
Currently returned depth-first, sorted by name within directories.
2905
This is the same order used by 'osutils.walkdirs'.
2907
## TODO: Work from given directory downwards
2908
for path, dir_entry in self.inventory.directories():
2909
# mutter("search for unknowns in %r", path)
2910
dirabs = self.abspath(path)
2911
if not isdir(dirabs):
2912
# e.g. directory deleted
2916
for subf in os.listdir(dirabs):
2917
if self.bzrdir.is_control_filename(subf):
2919
if subf not in dir_entry.children:
2922
can_access) = osutils.normalized_filename(subf)
2923
except UnicodeDecodeError:
2924
path_os_enc = path.encode(osutils._fs_enc)
2925
relpath = path_os_enc + '/' + subf
2926
raise errors.BadFilenameEncoding(relpath,
2928
if subf_norm != subf and can_access:
2929
if subf_norm not in dir_entry.children:
2930
fl.append(subf_norm)
2936
subp = pathjoin(path, subf)
2939
def _walkdirs(self, prefix=""):
2940
"""Walk the directories of this tree.
2942
:param prefix: is used as the directrory to start with.
2943
:returns: a generator which yields items in the form::
2945
((curren_directory_path, fileid),
2946
[(file1_path, file1_name, file1_kind, None, file1_id,
2949
_directory = 'directory'
2950
# get the root in the inventory
2951
inv = self.inventory
2952
top_id = inv.path2id(prefix)
2956
pending = [(prefix, '', _directory, None, top_id, None)]
2959
currentdir = pending.pop()
2960
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2961
top_id = currentdir[4]
2963
relroot = currentdir[0] + '/'
2966
# FIXME: stash the node in pending
2968
if entry.kind == 'directory':
2969
for name, child in entry.sorted_children():
2970
dirblock.append((relroot + name, name, child.kind, None,
2971
child.file_id, child.kind
2973
yield (currentdir[0], entry.file_id), dirblock
2974
# push the user specified dirs from dirblock
2975
for dir in reversed(dirblock):
2976
if dir[2] == _directory:
2980
def update_feature_flags(self, updated_flags):
2981
"""Update the feature flags for this branch.
2983
:param updated_flags: Dictionary mapping feature names to necessities
2984
A necessity can be None to indicate the feature should be removed
2986
self._format._update_feature_flags(updated_flags)
2987
self.control_transport.put_bytes('format', self._format.as_string())
2990
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2991
"""Registry for working tree formats."""
2993
def __init__(self, other_registry=None):
2994
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2995
self._default_format = None
2996
self._default_format_key = None
2998
def get_default(self):
2999
"""Return the current default format."""
3000
if (self._default_format_key is not None and
3001
self._default_format is None):
3002
self._default_format = self.get(self._default_format_key)
3003
return self._default_format
3005
def set_default(self, format):
3006
"""Set the default format."""
3007
self._default_format = format
3008
self._default_format_key = None
3010
def set_default_key(self, format_string):
3011
"""Set the default format by its format string."""
3012
self._default_format_key = format_string
3013
self._default_format = None
3016
format_registry = WorkingTreeFormatRegistry()
3019
class WorkingTreeFormat(controldir.ControlComponentFormat):
2421
3020
"""An encapsulation of the initialization and open routines for a format.
2423
3022
Formats provide three things:
2478
3085
"""Is this format supported?
2480
3087
Supported formats can be initialized and opened.
2481
Unsupported formats may not support initialization or committing or
3088
Unsupported formats may not support initialization or committing or
2482
3089
some other features depending on the reason for not being supported.
3093
def supports_content_filtering(self):
3094
"""True if this format supports content filtering."""
3097
def supports_views(self):
3098
"""True if this format supports stored views."""
3102
@symbol_versioning.deprecated_method(
3103
symbol_versioning.deprecated_in((2, 4, 0)))
2487
3104
def register_format(klass, format):
2488
klass._formats[format.get_format_string()] = format
3105
format_registry.register(format)
3108
@symbol_versioning.deprecated_method(
3109
symbol_versioning.deprecated_in((2, 4, 0)))
3110
def register_extra_format(klass, format):
3111
format_registry.register_extra(format)
3114
@symbol_versioning.deprecated_method(
3115
symbol_versioning.deprecated_in((2, 4, 0)))
3116
def unregister_extra_format(klass, format):
3117
format_registry.unregister_extra(format)
3120
@symbol_versioning.deprecated_method(
3121
symbol_versioning.deprecated_in((2, 4, 0)))
3122
def get_formats(klass):
3123
return format_registry._get_all()
3126
@symbol_versioning.deprecated_method(
3127
symbol_versioning.deprecated_in((2, 4, 0)))
2491
3128
def set_default_format(klass, format):
2492
klass._default_format = format
3129
format_registry.set_default(format)
3132
@symbol_versioning.deprecated_method(
3133
symbol_versioning.deprecated_in((2, 4, 0)))
2495
3134
def unregister_format(klass, format):
2496
assert klass._formats[format.get_format_string()] is format
2497
del klass._formats[format.get_format_string()]
2501
class WorkingTreeFormat2(WorkingTreeFormat):
2502
"""The second working tree format.
2504
This format modified the hash cache from the format 1 hash cache.
2507
def get_format_description(self):
2508
"""See WorkingTreeFormat.get_format_description()."""
2509
return "Working tree format 2"
2511
def stub_initialize_remote(self, control_files):
2512
"""As a special workaround create critical control files for a remote working tree
2514
This ensures that it can later be updated and dealt with locally,
2515
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2516
no working tree. (See bug #43064).
3135
format_registry.remove(format)
3137
def get_controldir_for_branch(self):
3138
"""Get the control directory format for creating branches.
3140
This is to support testing of working tree formats that can not exist
3141
in the same control directory as a branch.
2520
xml5.serializer_v5.write_inventory(inv, sio)
2522
control_files.put('inventory', sio)
2524
control_files.put_bytes('pending-merges', '')
2527
def initialize(self, a_bzrdir, revision_id=None):
2528
"""See WorkingTreeFormat.initialize()."""
2529
if not isinstance(a_bzrdir.transport, LocalTransport):
2530
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2531
branch = a_bzrdir.open_branch()
2532
if revision_id is not None:
2533
revision_id = osutils.safe_revision_id(revision_id)
2536
revision_history = branch.revision_history()
2538
position = revision_history.index(revision_id)
2540
raise errors.NoSuchRevision(branch, revision_id)
2541
branch.set_revision_history(revision_history[:position + 1])
2544
revision = branch.last_revision()
2546
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2552
basis_tree = branch.repository.revision_tree(revision)
2553
if basis_tree.inventory.root is not None:
2554
wt.set_root_id(basis_tree.inventory.root.file_id)
2555
# set the parent list and cache the basis tree.
2556
wt.set_parent_trees([(revision, basis_tree)])
2557
transform.build_tree(basis_tree, wt)
3143
return self._matchingbzrdir
3146
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3147
"""Base class for working trees that live in bzr meta directories."""
2560
3149
def __init__(self):
2561
super(WorkingTreeFormat2, self).__init__()
2562
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2564
def open(self, a_bzrdir, _found=False):
2565
"""Return the WorkingTree object for a_bzrdir
2567
_found is a private parameter, do not use it. It is used to indicate
2568
if format probing has already been done.
2571
# we are being called directly and must probe.
2572
raise NotImplementedError
2573
if not isinstance(a_bzrdir.transport, LocalTransport):
2574
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2575
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2581
class WorkingTreeFormat3(WorkingTreeFormat):
2582
"""The second working tree format updated to record a format marker.
2585
- exists within a metadir controlling .bzr
2586
- includes an explicit version marker for the workingtree control
2587
files, separate from the BzrDir format
2588
- modifies the hash cache format
2590
- uses a LockDir to guard access for writes.
2593
def get_format_string(self):
2594
"""See WorkingTreeFormat.get_format_string()."""
2595
return "Bazaar-NG Working Tree format 3"
2597
def get_format_description(self):
2598
"""See WorkingTreeFormat.get_format_description()."""
2599
return "Working tree format 3"
2601
_lock_file_name = 'lock'
2602
_lock_class = LockDir
2604
_tree_class = WorkingTree3
2606
def __get_matchingbzrdir(self):
2607
return bzrdir.BzrDirMetaFormat1()
2609
_matchingbzrdir = property(__get_matchingbzrdir)
2611
def _open_control_files(self, a_bzrdir):
2612
transport = a_bzrdir.get_workingtree_transport(None)
2613
return LockableFiles(transport, self._lock_file_name,
2616
def initialize(self, a_bzrdir, revision_id=None):
2617
"""See WorkingTreeFormat.initialize().
2619
revision_id allows creating a working tree at a different
2620
revision than the branch is at.
2622
if not isinstance(a_bzrdir.transport, LocalTransport):
2623
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2624
transport = a_bzrdir.get_workingtree_transport(self)
2625
control_files = self._open_control_files(a_bzrdir)
2626
control_files.create_lock()
2627
control_files.lock_write()
2628
control_files.put_utf8('format', self.get_format_string())
2629
branch = a_bzrdir.open_branch()
2630
if revision_id is None:
2631
revision_id = branch.last_revision()
2633
revision_id = osutils.safe_revision_id(revision_id)
2634
# WorkingTree3 can handle an inventory which has a unique root id.
2635
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2636
# those trees. And because there isn't a format bump inbetween, we
2637
# are maintaining compatibility with older clients.
2638
# inv = Inventory(root_id=gen_root_id())
2639
inv = self._initial_inventory()
2640
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2646
_control_files=control_files)
2647
wt.lock_tree_write()
3150
WorkingTreeFormat.__init__(self)
3151
bzrdir.BzrFormat.__init__(self)
3154
def find_format_string(klass, controldir):
3155
"""Return format name for the working tree object in controldir."""
2649
basis_tree = branch.repository.revision_tree(revision_id)
2650
# only set an explicit root id if there is one to set.
2651
if basis_tree.inventory.root is not None:
2652
wt.set_root_id(basis_tree.inventory.root.file_id)
2653
if revision_id == NULL_REVISION:
2654
wt.set_parent_trees([])
2656
wt.set_parent_trees([(revision_id, basis_tree)])
2657
transform.build_tree(basis_tree, wt)
2659
# Unlock in this order so that the unlock-triggers-flush in
2660
# WorkingTree is given a chance to fire.
2661
control_files.unlock()
2665
def _initial_inventory(self):
2669
super(WorkingTreeFormat3, self).__init__()
2671
def open(self, a_bzrdir, _found=False):
2672
"""Return the WorkingTree object for a_bzrdir
2674
_found is a private parameter, do not use it. It is used to indicate
2675
if format probing has already been done.
2678
# we are being called directly and must probe.
2679
raise NotImplementedError
2680
if not isinstance(a_bzrdir.transport, LocalTransport):
2681
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2682
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2684
def _open(self, a_bzrdir, control_files):
2685
"""Open the tree itself.
2687
:param a_bzrdir: the dir for the tree.
2688
:param control_files: the control files for the tree.
2690
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2694
_control_files=control_files)
2697
return self.get_format_string()
2700
__default_format = WorkingTreeFormat4()
2701
WorkingTreeFormat.register_format(__default_format)
2702
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2703
WorkingTreeFormat.set_default_format(__default_format)
2704
# formats which have no format string are not discoverable
2705
# and not independently creatable, so are not registered.
2706
_legacy_formats = [WorkingTreeFormat2(),
2710
class WorkingTreeTestProviderAdapter(object):
2711
"""A tool to generate a suite testing multiple workingtree formats at once.
2713
This is done by copying the test once for each transport and injecting
2714
the transport_server, transport_readonly_server, and workingtree_format
2715
classes into each copy. Each copy is also given a new id() to make it
2719
def __init__(self, transport_server, transport_readonly_server, formats):
2720
self._transport_server = transport_server
2721
self._transport_readonly_server = transport_readonly_server
2722
self._formats = formats
2724
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2725
"""Clone test for adaption."""
2726
new_test = deepcopy(test)
2727
new_test.transport_server = self._transport_server
2728
new_test.transport_readonly_server = self._transport_readonly_server
2729
new_test.bzrdir_format = bzrdir_format
2730
new_test.workingtree_format = workingtree_format
2731
def make_new_test_id():
2732
new_id = "%s(%s)" % (test.id(), variation)
2733
return lambda: new_id
2734
new_test.id = make_new_test_id()
2737
def adapt(self, test):
2738
from bzrlib.tests import TestSuite
2739
result = TestSuite()
2740
for workingtree_format, bzrdir_format in self._formats:
2741
new_test = self._clone_test(
2744
workingtree_format, workingtree_format.__class__.__name__)
2745
result.addTest(new_test)
3157
transport = controldir.get_workingtree_transport(None)
3158
return transport.get_bytes("format")
3159
except errors.NoSuchFile:
3160
raise errors.NoWorkingTree(base=transport.base)
3163
def find_format(klass, controldir):
3164
"""Return the format for the working tree object in controldir."""
3165
format_string = klass.find_format_string(controldir)
3166
return klass._find_format(format_registry, 'working tree',
3169
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3171
WorkingTreeFormat.check_support_status(self,
3172
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3174
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3175
recommend_upgrade=recommend_upgrade, basedir=basedir)
3178
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3179
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3180
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3181
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3182
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3183
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3184
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3185
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3186
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
