873
832
self.add(path, file_id, 'directory')
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))
835
def get_symlink_target(self, file_id, path=None):
837
abspath = self.abspath(path)
839
abspath = self.id2abspath(file_id)
840
target = osutils.readlink(abspath)
881
843
def subsume(self, other_tree):
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
844
raise NotImplementedError(self.subsume)
846
def _setup_directory_is_tree_reference(self):
847
if self._branch.repository._format.supports_tree_reference:
848
self._directory_is_tree_reference = \
849
self._directory_may_be_tree_reference
851
self._directory_is_tree_reference = \
852
self._directory_is_never_tree_reference
854
def _directory_is_never_tree_reference(self, relpath):
857
def _directory_may_be_tree_reference(self, relpath):
858
# as a special case, if a directory contains control files then
859
# it's a tree reference, except that the root of the tree is not
860
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
861
# TODO: We could ask all the control formats whether they
862
# recognize this directory, but at the moment there's no cheap api
863
# to do that. Since we probably can only nest bzr checkouts and
864
# they always use this name it's ok for now. -- mbp 20060306
866
# FIXME: There is an unhandled case here of a subdirectory
867
# containing .bzr but not a branch; that will probably blow up
868
# when you try to commit it. It might happen if there is a
869
# checkout in a subdirectory. This can be avoided by not adding
923
872
def extract(self, file_id, format=None):
924
873
"""Extract a subtree from this tree.
926
875
A new branch will be created, relative to the path for this tree.
930
segments = osutils.splitpath(path)
931
transport = self.branch.bzrdir.root_transport
932
for name in segments:
933
transport = transport.clone(name)
934
transport.ensure_base()
937
sub_path = self.id2path(file_id)
938
branch_transport = mkdirs(sub_path)
940
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
941
branch_transport.ensure_base()
942
branch_bzrdir = format.initialize_on_transport(branch_transport)
944
repo = branch_bzrdir.find_repository()
945
except errors.NoRepositoryPresent:
946
repo = branch_bzrdir.create_repository()
947
assert repo.supports_rich_root()
949
if not repo.supports_rich_root():
950
raise errors.RootNotRich()
951
new_branch = branch_bzrdir.create_branch()
952
new_branch.pull(self.branch)
953
for parent_id in self.get_parent_ids():
954
new_branch.fetch(self.branch, parent_id)
955
tree_transport = self.bzrdir.root_transport.clone(sub_path)
956
if tree_transport.base != branch_transport.base:
957
tree_bzrdir = format.initialize_on_transport(tree_transport)
958
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
960
tree_bzrdir = branch_bzrdir
961
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
962
wt.set_parent_ids(self.get_parent_ids())
963
my_inv = self.inventory
964
child_inv = Inventory(root_id=None)
965
new_root = my_inv[file_id]
966
my_inv.remove_recursive_id(file_id)
967
new_root.parent_id = None
968
child_inv.add(new_root)
969
self._write_inventory(my_inv)
970
wt._write_inventory(child_inv)
973
def _serialize(self, inventory, out_file):
974
xml5.serializer_v5.write_inventory(self._inventory, out_file)
976
def _deserialize(selt, in_file):
977
return xml5.serializer_v5.read_inventory(in_file)
877
raise NotImplementedError(self.extract)
980
"""Write the in memory inventory to disk."""
981
# TODO: Maybe this should only write on dirty ?
982
if self._control_files._lock_mode != 'w':
983
raise errors.NotWriteLocked(self)
985
self._serialize(self._inventory, sio)
987
self._control_files.put('inventory', sio)
988
self._inventory_is_modified = False
880
"""Write the in memory meta data to disk."""
881
raise NotImplementedError(self.flush)
990
883
def _kind(self, relpath):
991
884
return osutils.file_kind(self.abspath(relpath))
993
def list_files(self, include_root=False):
994
"""Recursively list all files as (path, class, kind, id, entry).
886
def list_files(self, include_root=False, from_dir=None, recursive=True):
887
"""List all files as (path, class, kind, id, entry).
996
889
Lists, but does not descend into unversioned directories.
998
890
This does not include files that have been deleted in this
891
tree. Skips the control directory.
1001
Skips the control directory.
893
:param include_root: if True, return an entry for the root
894
:param from_dir: start from this directory or None for the root
895
:param recursive: whether to recurse into subdirectories or not
1003
# list_files is an iterator, so @needs_read_lock doesn't work properly
1004
# with it. So callers should be careful to always read_lock the tree.
1005
if not self.is_locked():
1006
raise errors.ObjectNotLocked(self)
1008
inv = self.inventory
1009
if include_root is True:
1010
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1011
# Convert these into local objects to save lookup times
1012
pathjoin = osutils.pathjoin
1013
file_kind = self._kind
1015
# transport.base ends in a slash, we want the piece
1016
# between the last two slashes
1017
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1019
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1021
# directory file_id, relative path, absolute path, reverse sorted children
1022
children = os.listdir(self.basedir)
1024
# jam 20060527 The kernel sized tree seems equivalent whether we
1025
# use a deque and popleft to keep them sorted, or if we use a plain
1026
# list and just reverse() them.
1027
children = collections.deque(children)
1028
stack = [(inv.root.file_id, u'', self.basedir, children)]
1030
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1033
f = children.popleft()
1034
## TODO: If we find a subdirectory with its own .bzr
1035
## directory, then that is a separate tree and we
1036
## should exclude it.
1038
# the bzrdir for this tree
1039
if transport_base_dir == f:
1042
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1043
# and 'f' doesn't begin with one, we can do a string op, rather
1044
# than the checks of pathjoin(), all relative paths will have an extra slash
1046
fp = from_dir_relpath + '/' + f
1049
fap = from_dir_abspath + '/' + f
1051
f_ie = inv.get_child(from_dir_id, f)
1054
elif self.is_ignored(fp[1:]):
1057
# we may not have found this file, because of a unicode issue
1058
f_norm, can_access = osutils.normalized_filename(f)
1059
if f == f_norm or not can_access:
1060
# No change, so treat this file normally
1063
# this file can be accessed by a normalized path
1064
# check again if it is versioned
1065
# these lines are repeated here for performance
1067
fp = from_dir_relpath + '/' + f
1068
fap = from_dir_abspath + '/' + f
1069
f_ie = inv.get_child(from_dir_id, f)
1072
elif self.is_ignored(fp[1:]):
1079
# make a last minute entry
1081
yield fp[1:], c, fk, f_ie.file_id, f_ie
1084
yield fp[1:], c, fk, None, fk_entries[fk]()
1086
yield fp[1:], c, fk, None, TreeEntry()
1089
if fk != 'directory':
1092
# But do this child first
1093
new_children = os.listdir(fap)
1095
new_children = collections.deque(new_children)
1096
stack.append((f_ie.file_id, fp, fap, new_children))
1097
# Break out of inner loop,
1098
# so that we start outer loop with child
1101
# if we finished all children, pop it off the stack
1104
@needs_tree_write_lock
1105
def move(self, from_paths, to_dir=None, after=False, **kwargs):
897
raise NotImplementedError(self.list_files)
899
def move(self, from_paths, to_dir=None, after=False):
1106
900
"""Rename files.
1108
to_dir must exist in the inventory.
902
to_dir must be known to the working tree.
1110
904
If to_dir exists and is a directory, the files are moved into
1111
it, keeping their old names.
905
it, keeping their old names.
1113
907
Note that to_dir is only the last component of the new name;
1114
908
this doesn't change the directory.
1618
1149
@needs_read_lock
1619
1150
def _last_revision(self):
1620
1151
"""helper for get_parent_ids."""
1621
return self.branch.last_revision()
1152
return _mod_revision.ensure_null(self.branch.last_revision())
1623
1154
def is_locked(self):
1624
return self._control_files.is_locked()
1626
def _must_be_locked(self):
1627
if not self.is_locked():
1628
raise errors.ObjectNotLocked(self)
1155
"""Check if this tree is locked."""
1156
raise NotImplementedError(self.is_locked)
1630
1158
def lock_read(self):
1631
"""See Branch.lock_read, and WorkingTree.unlock."""
1632
if not self.is_locked():
1634
self.branch.lock_read()
1636
return self._control_files.lock_read()
1638
self.branch.unlock()
1159
"""Lock the tree for reading.
1161
This also locks the branch, and can be unlocked via self.unlock().
1163
:return: A bzrlib.lock.LogicalLockResult.
1165
raise NotImplementedError(self.lock_read)
1641
1167
def lock_tree_write(self):
1642
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1643
if not self.is_locked():
1645
self.branch.lock_read()
1647
return self._control_files.lock_write()
1649
self.branch.unlock()
1168
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1170
:return: A bzrlib.lock.LogicalLockResult.
1172
raise NotImplementedError(self.lock_tree_write)
1652
1174
def lock_write(self):
1653
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1654
if not self.is_locked():
1656
self.branch.lock_write()
1658
return self._control_files.lock_write()
1660
self.branch.unlock()
1175
"""See MutableTree.lock_write, and WorkingTree.unlock.
1177
:return: A bzrlib.lock.LogicalLockResult.
1179
raise NotImplementedError(self.lock_write)
1663
1181
def get_physical_lock_status(self):
1664
return self._control_files.get_physical_lock_status()
1666
def _basis_inventory_name(self):
1667
return 'basis-inventory-cache'
1669
def _reset_data(self):
1670
"""Reset transient data that cannot be revalidated."""
1671
self._inventory_is_modified = False
1672
result = self._deserialize(self._control_files.get('inventory'))
1673
self._set_inventory(result, dirty=False)
1675
@needs_tree_write_lock
1182
raise NotImplementedError(self.get_physical_lock_status)
1676
1184
def set_last_revision(self, new_revision):
1677
1185
"""Change the last revision in the working tree."""
1678
new_revision = osutils.safe_revision_id(new_revision)
1679
if self._change_last_revision(new_revision):
1680
self._cache_basis_inventory(new_revision)
1186
raise NotImplementedError(self.set_last_revision)
1682
1188
def _change_last_revision(self, new_revision):
1683
1189
"""Template method part of set_last_revision to perform the change.
1685
1191
This is used to allow WorkingTree3 instances to not affect branch
1686
1192
when their last revision is set.
1688
if new_revision is None:
1689
self.branch.set_revision_history([])
1194
if _mod_revision.is_null(new_revision):
1195
self.branch.set_last_revision_info(0, new_revision)
1197
_mod_revision.check_not_reserved_id(new_revision)
1692
1199
self.branch.generate_revision_history(new_revision)
1693
1200
except errors.NoSuchRevision:
1694
1201
# not present in the repo - dont try to set it deeper than the tip
1695
self.branch.set_revision_history([new_revision])
1202
self.branch._set_revision_history([new_revision])
1698
def _write_basis_inventory(self, xml):
1699
"""Write the basis inventory XML to the basis-inventory file"""
1700
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1701
path = self._basis_inventory_name()
1703
self._control_files.put(path, sio)
1705
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1706
"""Create the text that will be saved in basis-inventory"""
1707
# TODO: jam 20070209 This should be redundant, as the revision_id
1708
# as all callers should have already converted the revision_id to
1710
inventory.revision_id = osutils.safe_revision_id(revision_id)
1711
return xml7.serializer_v7.write_inventory_to_string(inventory)
1713
def _cache_basis_inventory(self, new_revision):
1714
"""Cache new_revision as the basis inventory."""
1715
# TODO: this should allow the ready-to-use inventory to be passed in,
1716
# as commit already has that ready-to-use [while the format is the
1719
# this double handles the inventory - unpack and repack -
1720
# but is easier to understand. We can/should put a conditional
1721
# in here based on whether the inventory is in the latest format
1722
# - perhaps we should repack all inventories on a repository
1724
# the fast path is to copy the raw xml from the repository. If the
1725
# xml contains 'revision_id="', then we assume the right
1726
# revision_id is set. We must check for this full string, because a
1727
# root node id can legitimately look like 'revision_id' but cannot
1729
xml = self.branch.repository.get_inventory_xml(new_revision)
1730
firstline = xml.split('\n', 1)[0]
1731
if (not 'revision_id="' in firstline or
1732
'format="7"' not in firstline):
1733
inv = self.branch.repository.deserialise_inventory(
1735
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1736
self._write_basis_inventory(xml)
1737
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1740
def read_basis_inventory(self):
1741
"""Read the cached basis inventory."""
1742
path = self._basis_inventory_name()
1743
return self._control_files.get(path).read()
1746
def read_working_inventory(self):
1747
"""Read the working inventory.
1749
:raises errors.InventoryModified: read_working_inventory will fail
1750
when the current in memory inventory has been modified.
1752
# conceptually this should be an implementation detail of the tree.
1753
# XXX: Deprecate this.
1754
# ElementTree does its own conversion from UTF-8, so open in
1756
if self._inventory_is_modified:
1757
raise errors.InventoryModified(self)
1758
result = self._deserialize(self._control_files.get('inventory'))
1759
self._set_inventory(result, dirty=False)
1762
1205
@needs_tree_write_lock
1763
1206
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1765
"""Remove nominated files from the working inventor.
1208
"""Remove nominated files from the working tree metadata.
1767
1210
:files: File paths relative to the basedir.
1768
1211
:keep_files: If true, the files will also be kept.
1769
1212
:force: Delete files and directories, even if they are changed and
1770
1213
even if the directories are not empty.
1772
## TODO: Normalize names
1774
1215
if isinstance(files, basestring):
1775
1216
files = [files]
1780
unknown_files_in_directory=set()
1220
all_files = set() # specified and nested files
1221
unknown_nested_files=set()
1223
to_file = sys.stdout
1225
files_to_backup = []
1782
1227
def recurse_directory_to_add_files(directory):
1783
# recurse directory and add all files
1228
# Recurse directory and add all files
1784
1229
# so we can check if they have changed.
1785
for parent_info, file_infos in\
1786
osutils.walkdirs(self.abspath(directory),
1788
for relpath, basename, kind, lstat, abspath in file_infos:
1790
if self.path2id(relpath): #is it versioned?
1791
new_files.add(relpath)
1793
unknown_files_in_directory.add(
1794
(relpath, None, kind))
1230
for parent_info, file_infos in self.walkdirs(directory):
1231
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1232
# Is it versioned or ignored?
1233
if self.path2id(relpath):
1234
# Add nested content for deletion.
1235
all_files.add(relpath)
1237
# Files which are not versioned
1238
# should be treated as unknown.
1239
files_to_backup.append(relpath)
1796
1241
for filename in files:
1797
1242
# Get file name into canonical form.
1798
1243
abspath = self.abspath(filename)
1799
1244
filename = self.relpath(abspath)
1800
1245
if len(filename) > 0:
1801
new_files.add(filename)
1802
if osutils.isdir(abspath):
1803
recurse_directory_to_add_files(filename)
1804
files = [f for f in new_files]
1246
all_files.add(filename)
1247
recurse_directory_to_add_files(filename)
1249
files = list(all_files)
1252
return # nothing to do
1806
1254
# Sort needed to first handle directory content before the directory
1807
1255
files.sort(reverse=True)
1257
# Bail out if we are going to delete files we shouldn't
1808
1258
if not keep_files and not force:
1809
tree_delta = self.changes_from(self.basis_tree(),
1810
specific_files=files)
1811
for unknown_file in unknown_files_in_directory:
1812
tree_delta.unversioned.extend((unknown_file,))
1813
if bool(tree_delta.modified
1815
or tree_delta.renamed
1816
or tree_delta.kind_changed
1817
or tree_delta.unversioned):
1818
raise errors.BzrRemoveChangedFilesError(tree_delta)
1820
# do this before any modifications
1259
for (file_id, path, content_change, versioned, parent_id, name,
1260
kind, executable) in self.iter_changes(self.basis_tree(),
1261
include_unchanged=True, require_versioned=False,
1262
want_unversioned=True, specific_files=files):
1263
if versioned[0] == False:
1264
# The record is unknown or newly added
1265
files_to_backup.append(path[1])
1266
elif (content_change and (kind[1] is not None) and
1267
osutils.is_inside_any(files, path[1])):
1268
# Versioned and changed, but not deleted, and still
1269
# in one of the dirs to be deleted.
1270
files_to_backup.append(path[1])
1272
def backup(file_to_backup):
1273
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1274
osutils.rename(abs_path, self.abspath(backup_name))
1275
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1278
# Build inv_delta and delete files where applicable,
1279
# do this before any modifications to meta data.
1821
1280
for f in files:
1822
1281
fid = self.path2id(f)
1825
message="%s is not versioned." % (f,)
1284
message = "%s is not versioned." % (f,)
1828
1287
# having removed it, it must be either ignored or unknown
2344
class WorkingTree2(WorkingTree):
2345
"""This is the Format 2 working tree.
2347
This was the first weave based working tree.
2348
- uses os locks for locking.
2349
- uses the branch last-revision.
1716
def check_state(self):
1717
"""Check that the working state is/isn't valid."""
1718
raise NotImplementedError(self.check_state)
1720
def reset_state(self, revision_ids=None):
1721
"""Reset the state of the working tree.
1723
This does a hard-reset to a last-known-good state. This is a way to
1724
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1726
raise NotImplementedError(self.reset_state)
1728
def _get_rules_searcher(self, default_searcher):
1729
"""See Tree._get_rules_searcher."""
1730
if self._rules_searcher is None:
1731
self._rules_searcher = super(WorkingTree,
1732
self)._get_rules_searcher(default_searcher)
1733
return self._rules_searcher
1735
def get_shelf_manager(self):
1736
"""Return the ShelfManager for this WorkingTree."""
1737
from bzrlib.shelf import ShelfManager
1738
return ShelfManager(self, self._transport)
1741
class InventoryWorkingTree(WorkingTree,
1742
bzrlib.mutabletree.MutableInventoryTree):
1743
"""Base class for working trees that are inventory-oriented.
1745
The inventory is held in the `Branch` working-inventory, and the
1746
files are in a directory on disk.
1748
It is possible for a `WorkingTree` to have a filename which is
1749
not listed in the Inventory and vice versa.
2352
def __init__(self, *args, **kwargs):
2353
super(WorkingTree2, self).__init__(*args, **kwargs)
2354
# WorkingTree2 has more of a constraint that self._inventory must
2355
# exist. Because this is an older format, we don't mind the overhead
2356
# caused by the extra computation here.
2358
# Newer WorkingTree's should only have self._inventory set when they
2360
if self._inventory is None:
2361
self.read_working_inventory()
1752
def __init__(self, basedir='.',
1753
branch=DEPRECATED_PARAMETER,
1755
_control_files=None,
1759
"""Construct a InventoryWorkingTree instance. This is not a public API.
1761
:param branch: A branch to override probing for the branch.
1763
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1764
branch=branch, _transport=_control_files._transport,
1765
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1767
self._control_files = _control_files
1768
self._detect_case_handling()
1770
if _inventory is None:
1771
# This will be acquired on lock_read() or lock_write()
1772
self._inventory_is_modified = False
1773
self._inventory = None
1775
# the caller of __init__ has provided an inventory,
1776
# we assume they know what they are doing - as its only
1777
# the Format factory and creation methods that are
1778
# permitted to do this.
1779
self._set_inventory(_inventory, dirty=False)
1781
def _set_inventory(self, inv, dirty):
1782
"""Set the internal cached inventory.
1784
:param inv: The inventory to set.
1785
:param dirty: A boolean indicating whether the inventory is the same
1786
logical inventory as whats on disk. If True the inventory is not
1787
the same and should be written to disk or data will be lost, if
1788
False then the inventory is the same as that on disk and any
1789
serialisation would be unneeded overhead.
1791
self._inventory = inv
1792
self._inventory_is_modified = dirty
1794
def _detect_case_handling(self):
1795
wt_trans = self.bzrdir.get_workingtree_transport(None)
1797
wt_trans.stat(self._format.case_sensitive_filename)
1798
except errors.NoSuchFile:
1799
self.case_sensitive = True
1801
self.case_sensitive = False
1803
self._setup_directory_is_tree_reference()
1805
def _serialize(self, inventory, out_file):
1806
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1809
def _deserialize(selt, in_file):
1810
return xml5.serializer_v5.read_inventory(in_file)
1812
def break_lock(self):
1813
"""Break a lock if one is present from another instance.
1815
Uses the ui factory to ask for confirmation if the lock may be from
1818
This will probe the repository for its lock as well.
1820
self._control_files.break_lock()
1821
self.branch.break_lock()
1823
def is_locked(self):
1824
return self._control_files.is_locked()
1826
def _must_be_locked(self):
1827
if not self.is_locked():
1828
raise errors.ObjectNotLocked(self)
1830
def lock_read(self):
1831
"""Lock the tree for reading.
1833
This also locks the branch, and can be unlocked via self.unlock().
1835
:return: A bzrlib.lock.LogicalLockResult.
1837
if not self.is_locked():
1839
self.branch.lock_read()
1841
self._control_files.lock_read()
1842
return LogicalLockResult(self.unlock)
1844
self.branch.unlock()
2363
1847
def lock_tree_write(self):
2364
"""See WorkingTree.lock_tree_write().
2366
In Format2 WorkingTrees we have a single lock for the branch and tree
2367
so lock_tree_write() degrades to lock_write().
1848
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1850
:return: A bzrlib.lock.LogicalLockResult.
1852
if not self.is_locked():
1854
self.branch.lock_read()
1856
self._control_files.lock_write()
1857
return LogicalLockResult(self.unlock)
1859
self.branch.unlock()
1862
def lock_write(self):
1863
"""See MutableTree.lock_write, and WorkingTree.unlock.
1865
:return: A bzrlib.lock.LogicalLockResult.
1867
if not self.is_locked():
2369
1869
self.branch.lock_write()
2371
return self._control_files.lock_write()
1871
self._control_files.lock_write()
1872
return LogicalLockResult(self.unlock)
2373
1874
self.branch.unlock()
2377
# we share control files:
2378
if self._control_files._lock_count == 3:
2379
# _inventory_is_modified is always False during a read lock.
2380
if self._inventory_is_modified:
2382
self._write_hashcache_if_dirty()
2384
# reverse order of locking.
1877
def get_physical_lock_status(self):
1878
return self._control_files.get_physical_lock_status()
1880
@needs_tree_write_lock
1881
def _write_inventory(self, inv):
1882
"""Write inventory as the current inventory."""
1883
self._set_inventory(inv, dirty=True)
1886
# XXX: This method should be deprecated in favour of taking in a proper
1887
# new Inventory object.
1888
@needs_tree_write_lock
1889
def set_inventory(self, new_inventory_list):
1890
from bzrlib.inventory import (Inventory,
1894
inv = Inventory(self.get_root_id())
1895
for path, file_id, parent, kind in new_inventory_list:
1896
name = os.path.basename(path)
1899
# fixme, there should be a factory function inv,add_??
1900
if kind == 'directory':
1901
inv.add(InventoryDirectory(file_id, name, parent))
1902
elif kind == 'file':
1903
inv.add(InventoryFile(file_id, name, parent))
1904
elif kind == 'symlink':
1905
inv.add(InventoryLink(file_id, name, parent))
1907
raise errors.BzrError("unknown kind %r" % kind)
1908
self._write_inventory(inv)
1910
def _write_basis_inventory(self, xml):
1911
"""Write the basis inventory XML to the basis-inventory file"""
1912
path = self._basis_inventory_name()
1914
self._transport.put_file(path, sio,
1915
mode=self.bzrdir._get_file_mode())
1917
def _reset_data(self):
1918
"""Reset transient data that cannot be revalidated."""
1919
self._inventory_is_modified = False
1920
f = self._transport.get('inventory')
2386
return self._control_files.unlock()
1922
result = self._deserialize(f)
2388
self.branch.unlock()
2391
class WorkingTree3(WorkingTree):
2392
"""This is the Format 3 working tree.
2394
This differs from the base WorkingTree by:
2395
- having its own file lock
2396
- having its own last-revision property.
2398
This is new in bzr 0.8
2402
def _last_revision(self):
2403
"""See Mutable.last_revision."""
1925
self._set_inventory(result, dirty=False)
1927
def _set_root_id(self, file_id):
1928
"""Set the root id for this tree, in a format specific manner.
1930
:param file_id: The file id to assign to the root. It must not be
1931
present in the current inventory or an error will occur. It must
1932
not be None, but rather a valid file id.
1934
inv = self._inventory
1935
orig_root_id = inv.root.file_id
1936
# TODO: it might be nice to exit early if there was nothing
1937
# to do, saving us from trigger a sync on unlock.
1938
self._inventory_is_modified = True
1939
# we preserve the root inventory entry object, but
1940
# unlinkit from the byid index
1941
del inv._byid[inv.root.file_id]
1942
inv.root.file_id = file_id
1943
# and link it into the index with the new changed id.
1944
inv._byid[inv.root.file_id] = inv.root
1945
# and finally update all children to reference the new id.
1946
# XXX: this should be safe to just look at the root.children
1947
# list, not the WHOLE INVENTORY.
1950
if entry.parent_id == orig_root_id:
1951
entry.parent_id = inv.root.file_id
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.root_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
2405
return osutils.safe_revision_id(
2406
self._control_files.get('last-revision').read())
2407
except errors.NoSuchFile:
2410
def _change_last_revision(self, revision_id):
2411
"""See WorkingTree._change_last_revision."""
2412
if revision_id is None or revision_id == NULL_REVISION:
2414
self._control_files._transport.delete('last-revision')
2415
except errors.NoSuchFile:
2419
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)
2422
2018
@needs_tree_write_lock
2423
2019
def set_conflicts(self, conflicts):
2424
self._put_rio('conflicts', conflicts.to_stanzas(),
2020
self._put_rio('conflicts', conflicts.to_stanzas(),
2425
2021
CONFLICT_HEADER_1)
2427
2023
@needs_tree_write_lock
2434
2030
@needs_read_lock
2435
2031
def conflicts(self):
2437
confile = self._control_files.get('conflicts')
2033
confile = self._transport.get('conflicts')
2438
2034
except errors.NoSuchFile:
2439
2035
return _mod_conflicts.ConflictList()
2441
if confile.next() != CONFLICT_HEADER_1 + '\n':
2038
if confile.next() != CONFLICT_HEADER_1 + '\n':
2039
raise errors.ConflictFormatError()
2040
except StopIteration:
2442
2041
raise errors.ConflictFormatError()
2443
except StopIteration:
2444
raise errors.ConflictFormatError()
2445
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2448
if self._control_files._lock_count == 1:
2449
# _inventory_is_modified is always False during a read lock.
2450
if self._inventory_is_modified:
2452
self._write_hashcache_if_dirty()
2453
# 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')
2455
return self._control_files.unlock()
2067
result = self._deserialize(f)
2457
self.branch.unlock()
2460
def get_conflicted_stem(path):
2461
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2462
if path.endswith(suffix):
2463
return path[:-len(suffix)]
2466
@deprecated_function(zero_eight)
2467
def is_control_file(filename):
2468
"""See WorkingTree.is_control_filename(filename)."""
2469
## FIXME: better check
2470
filename = normpath(filename)
2471
while filename != '':
2472
head, tail = os.path.split(filename)
2473
## 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, inv_file_id = self._unpack_file_id(file_id)
2081
if not inv.has_id(inv_file_id):
2083
path = inv.id2path(inv_file_id)
2084
return osutils.lexists(self.abspath(path))
2086
def has_or_had_id(self, file_id):
2087
if file_id == self.get_root_id():
2476
if filename == head:
2482
class WorkingTreeFormat(object):
2089
inv, inv_file_id = self._unpack_file_id(file_id)
2090
return inv.has_id(inv_file_id)
2092
def all_file_ids(self):
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.
2099
for path, ie in self.iter_entries_by_dir():
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.root_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.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
inv, file_id = self._path2inv_file_id(path)
2192
# For unversioned files on win32, we just assume they are not
2195
return inv[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
inv, inv_file_id = self._unpack_file_id(file_id)
2204
return inv[inv_file_id].executable
2207
path = self.id2path(file_id)
2208
mode = os.lstat(self.abspath(path)).st_mode
2209
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2211
def _is_executable_from_path_and_stat(self, path, stat_result):
2212
if not self._supports_executable():
2213
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2215
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2217
@needs_tree_write_lock
2218
def _add(self, files, ids, kinds):
2219
"""See MutableTree._add."""
2220
# TODO: Re-adding a file that is removed in the working copy
2221
# should probably put it back with the previous ID.
2222
# the read and write working inventory should not occur in this
2223
# function - they should be part of lock_write and unlock.
2224
# FIXME: nested trees
2225
inv = self.root_inventory
2226
for f, file_id, kind in zip(files, ids, kinds):
2228
inv.add_path(f, kind=kind)
2230
inv.add_path(f, kind=kind, file_id=file_id)
2231
self._inventory_is_modified = True
2233
def revision_tree(self, revision_id):
2234
"""See WorkingTree.revision_id."""
2235
if revision_id == self.last_revision():
2237
xml = self.read_basis_inventory()
2238
except errors.NoSuchFile:
2242
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2243
# dont use the repository revision_tree api because we want
2244
# to supply the inventory.
2245
if inv.revision_id == revision_id:
2246
return revisiontree.InventoryRevisionTree(
2247
self.branch.repository, inv, revision_id)
2248
except errors.BadInventoryFormat:
2250
# raise if there was no inventory, or if we read the wrong inventory.
2251
raise errors.NoSuchRevisionInTree(self, revision_id)
2254
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2255
"""See Tree.annotate_iter
2257
This implementation will use the basis tree implementation if possible.
2258
Lines not in the basis are attributed to CURRENT_REVISION
2260
If there are pending merges, lines added by those merges will be
2261
incorrectly attributed to CURRENT_REVISION (but after committing, the
2262
attribution will be correct).
2264
maybe_file_parent_keys = []
2265
for parent_id in self.get_parent_ids():
2267
parent_tree = self.revision_tree(parent_id)
2268
except errors.NoSuchRevisionInTree:
2269
parent_tree = self.branch.repository.revision_tree(parent_id)
2270
parent_tree.lock_read()
2273
kind = parent_tree.kind(file_id)
2274
except errors.NoSuchId:
2277
# Note: this is slightly unnecessary, because symlinks and
2278
# directories have a "text" which is the empty text, and we
2279
# know that won't mess up annotations. But it seems cleaner
2282
file_id, parent_tree.get_file_revision(file_id))
2283
if parent_text_key not in maybe_file_parent_keys:
2284
maybe_file_parent_keys.append(parent_text_key)
2286
parent_tree.unlock()
2287
graph = _mod_graph.Graph(self.branch.repository.texts)
2288
heads = graph.heads(maybe_file_parent_keys)
2289
file_parent_keys = []
2290
for key in maybe_file_parent_keys:
2292
file_parent_keys.append(key)
2294
# Now we have the parents of this content
2295
annotator = self.branch.repository.texts.get_annotator()
2296
text = self.get_file_text(file_id)
2297
this_key =(file_id, default_revision)
2298
annotator.add_special_text(this_key, file_parent_keys, text)
2299
annotations = [(key[-1], line)
2300
for key, line in annotator.annotate_flat(this_key)]
2303
def _put_rio(self, filename, stanzas, header):
2304
self._must_be_locked()
2305
my_file = _mod_rio.rio_file(stanzas, header)
2306
self._transport.put_file(filename, my_file,
2307
mode=self.bzrdir._get_file_mode())
2309
@needs_tree_write_lock
2310
def set_merge_modified(self, modified_hashes):
2312
for file_id, hash in modified_hashes.iteritems():
2313
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2315
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2318
def merge_modified(self):
2319
"""Return a dictionary of files modified by a merge.
2321
The list is initialized by WorkingTree.set_merge_modified, which is
2322
typically called after we make some automatic updates to the tree
2325
This returns a map of file_id->sha1, containing only files which are
2326
still in the working inventory and have that text hash.
2329
hashfile = self._transport.get('merge-hashes')
2330
except errors.NoSuchFile:
2335
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2336
raise errors.MergeModifiedFormatError()
2337
except StopIteration:
2338
raise errors.MergeModifiedFormatError()
2339
for s in _mod_rio.RioReader(hashfile):
2340
# RioReader reads in Unicode, so convert file_ids back to utf8
2341
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2342
if not self.has_id(file_id):
2344
text_hash = s.get("hash")
2345
if text_hash == self.get_file_sha1(file_id):
2346
merge_hashes[file_id] = text_hash
2352
def subsume(self, other_tree):
2353
def add_children(inventory, entry):
2354
for child_entry in entry.children.values():
2355
inventory._byid[child_entry.file_id] = child_entry
2356
if child_entry.kind == 'directory':
2357
add_children(inventory, child_entry)
2358
if other_tree.get_root_id() == self.get_root_id():
2359
raise errors.BadSubsumeSource(self, other_tree,
2360
'Trees have the same root')
2362
other_tree_path = self.relpath(other_tree.basedir)
2363
except errors.PathNotChild:
2364
raise errors.BadSubsumeSource(self, other_tree,
2365
'Tree is not contained by the other')
2366
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2367
if new_root_parent is None:
2368
raise errors.BadSubsumeSource(self, other_tree,
2369
'Parent directory is not versioned.')
2370
# We need to ensure that the result of a fetch will have a
2371
# versionedfile for the other_tree root, and only fetching into
2372
# RepositoryKnit2 guarantees that.
2373
if not self.branch.repository.supports_rich_root():
2374
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2375
other_tree.lock_tree_write()
2377
new_parents = other_tree.get_parent_ids()
2378
other_root = other_tree.root_inventory.root
2379
other_root.parent_id = new_root_parent
2380
other_root.name = osutils.basename(other_tree_path)
2381
self.root_inventory.add(other_root)
2382
add_children(self.root_inventory, other_root)
2383
self._write_inventory(self.root_inventory)
2384
# normally we don't want to fetch whole repositories, but i think
2385
# here we really do want to consolidate the whole thing.
2386
for parent_id in other_tree.get_parent_ids():
2387
self.branch.fetch(other_tree.branch, parent_id)
2388
self.add_parent_tree_id(parent_id)
2391
other_tree.bzrdir.retire_bzrdir()
2393
@needs_tree_write_lock
2394
def extract(self, file_id, format=None):
2395
"""Extract a subtree from this tree.
2397
A new branch will be created, relative to the path for this tree.
2401
segments = osutils.splitpath(path)
2402
transport = self.branch.bzrdir.root_transport
2403
for name in segments:
2404
transport = transport.clone(name)
2405
transport.ensure_base()
2408
sub_path = self.id2path(file_id)
2409
branch_transport = mkdirs(sub_path)
2411
format = self.bzrdir.cloning_metadir()
2412
branch_transport.ensure_base()
2413
branch_bzrdir = format.initialize_on_transport(branch_transport)
2415
repo = branch_bzrdir.find_repository()
2416
except errors.NoRepositoryPresent:
2417
repo = branch_bzrdir.create_repository()
2418
if not repo.supports_rich_root():
2419
raise errors.RootNotRich()
2420
new_branch = branch_bzrdir.create_branch()
2421
new_branch.pull(self.branch)
2422
for parent_id in self.get_parent_ids():
2423
new_branch.fetch(self.branch, parent_id)
2424
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2425
if tree_transport.base != branch_transport.base:
2426
tree_bzrdir = format.initialize_on_transport(tree_transport)
2427
tree_bzrdir.set_branch_reference(new_branch)
2429
tree_bzrdir = branch_bzrdir
2430
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2431
wt.set_parent_ids(self.get_parent_ids())
2432
# FIXME: Support nested trees
2433
my_inv = self.root_inventory
2434
child_inv = inventory.Inventory(root_id=None)
2435
new_root = my_inv[file_id]
2436
my_inv.remove_recursive_id(file_id)
2437
new_root.parent_id = None
2438
child_inv.add(new_root)
2439
self._write_inventory(my_inv)
2440
wt._write_inventory(child_inv)
2443
def list_files(self, include_root=False, from_dir=None, recursive=True):
2444
"""List all files as (path, class, kind, id, entry).
2446
Lists, but does not descend into unversioned directories.
2447
This does not include files that have been deleted in this
2448
tree. Skips the control directory.
2450
:param include_root: if True, return an entry for the root
2451
:param from_dir: start from this directory or None for the root
2452
:param recursive: whether to recurse into subdirectories or not
2454
# list_files is an iterator, so @needs_read_lock doesn't work properly
2455
# with it. So callers should be careful to always read_lock the tree.
2456
if not self.is_locked():
2457
raise errors.ObjectNotLocked(self)
2459
if from_dir is None and include_root is True:
2460
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2461
# Convert these into local objects to save lookup times
2462
pathjoin = osutils.pathjoin
2463
file_kind = self._kind
2465
# transport.base ends in a slash, we want the piece
2466
# between the last two slashes
2467
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2469
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2471
# directory file_id, relative path, absolute path, reverse sorted children
2472
if from_dir is not None:
2473
inv, from_dir_id = self._path2inv_file_id(from_dir)
2474
if from_dir_id is None:
2475
# Directory not versioned
2477
from_dir_abspath = pathjoin(self.basedir, from_dir)
2479
inv = self.root_inventory
2480
from_dir_id = inv.root.file_id
2481
from_dir_abspath = self.basedir
2482
children = os.listdir(from_dir_abspath)
2484
# jam 20060527 The kernel sized tree seems equivalent whether we
2485
# use a deque and popleft to keep them sorted, or if we use a plain
2486
# list and just reverse() them.
2487
children = collections.deque(children)
2488
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2490
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2493
f = children.popleft()
2494
## TODO: If we find a subdirectory with its own .bzr
2495
## directory, then that is a separate tree and we
2496
## should exclude it.
2498
# the bzrdir for this tree
2499
if transport_base_dir == f:
2502
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2503
# and 'f' doesn't begin with one, we can do a string op, rather
2504
# than the checks of pathjoin(), all relative paths will have an extra slash
2506
fp = from_dir_relpath + '/' + f
2509
fap = from_dir_abspath + '/' + f
2511
dir_ie = inv[from_dir_id]
2512
if dir_ie.kind == 'directory':
2513
f_ie = dir_ie.children.get(f)
2518
elif self.is_ignored(fp[1:]):
2521
# we may not have found this file, because of a unicode
2522
# issue, or because the directory was actually a symlink.
2523
f_norm, can_access = osutils.normalized_filename(f)
2524
if f == f_norm or not can_access:
2525
# No change, so treat this file normally
2528
# this file can be accessed by a normalized path
2529
# check again if it is versioned
2530
# these lines are repeated here for performance
2532
fp = from_dir_relpath + '/' + f
2533
fap = from_dir_abspath + '/' + f
2534
f_ie = inv.get_child(from_dir_id, f)
2537
elif self.is_ignored(fp[1:]):
2544
# make a last minute entry
2546
yield fp[1:], c, fk, f_ie.file_id, f_ie
2549
yield fp[1:], c, fk, None, fk_entries[fk]()
2551
yield fp[1:], c, fk, None, TreeEntry()
2554
if fk != 'directory':
2557
# But do this child first if recursing down
2559
new_children = os.listdir(fap)
2561
new_children = collections.deque(new_children)
2562
stack.append((f_ie.file_id, fp, fap, new_children))
2563
# Break out of inner loop,
2564
# so that we start outer loop with child
2567
# if we finished all children, pop it off the stack
2570
@needs_tree_write_lock
2571
def move(self, from_paths, to_dir=None, after=False):
2574
to_dir must exist in the inventory.
2576
If to_dir exists and is a directory, the files are moved into
2577
it, keeping their old names.
2579
Note that to_dir is only the last component of the new name;
2580
this doesn't change the directory.
2582
For each entry in from_paths the move mode will be determined
2585
The first mode moves the file in the filesystem and updates the
2586
inventory. The second mode only updates the inventory without
2587
touching the file on the filesystem.
2589
move uses the second mode if 'after == True' and the target is
2590
either not versioned or newly added, and present in the working tree.
2592
move uses the second mode if 'after == False' and the source is
2593
versioned but no longer in the working tree, and the target is not
2594
versioned but present in the working tree.
2596
move uses the first mode if 'after == False' and the source is
2597
versioned and present in the working tree, and the target is not
2598
versioned and not present in the working tree.
2600
Everything else results in an error.
2602
This returns a list of (from_path, to_path) pairs for each
2603
entry that is moved.
2608
invs_to_write = set()
2610
# check for deprecated use of signature
2612
raise TypeError('You must supply a target directory')
2613
# check destination directory
2614
if isinstance(from_paths, basestring):
2616
to_abs = self.abspath(to_dir)
2617
if not isdir(to_abs):
2618
raise errors.BzrMoveFailedError('',to_dir,
2619
errors.NotADirectory(to_abs))
2620
if not self.has_filename(to_dir):
2621
raise errors.BzrMoveFailedError('',to_dir,
2622
errors.NotInWorkingDirectory(to_dir))
2623
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2624
if to_dir_id is None:
2625
raise errors.BzrMoveFailedError('',to_dir,
2626
errors.NotVersionedError(path=to_dir))
2628
to_dir_ie = to_inv[to_dir_id]
2629
if to_dir_ie.kind != 'directory':
2630
raise errors.BzrMoveFailedError('',to_dir,
2631
errors.NotADirectory(to_abs))
2633
# create rename entries and tuples
2634
for from_rel in from_paths:
2635
from_tail = splitpath(from_rel)[-1]
2636
from_inv, from_id = self._path2inv_file_id(from_rel)
2638
raise errors.BzrMoveFailedError(from_rel,to_dir,
2639
errors.NotVersionedError(path=from_rel))
2641
from_entry = from_inv[from_id]
2642
from_parent_id = from_entry.parent_id
2643
to_rel = pathjoin(to_dir, from_tail)
2644
rename_entry = InventoryWorkingTree._RenameEntry(
2647
from_tail=from_tail,
2648
from_parent_id=from_parent_id,
2649
to_rel=to_rel, to_tail=from_tail,
2650
to_parent_id=to_dir_id)
2651
rename_entries.append(rename_entry)
2652
rename_tuples.append((from_rel, to_rel))
2654
# determine which move mode to use. checks also for movability
2655
rename_entries = self._determine_mv_mode(rename_entries, after)
2657
original_modified = self._inventory_is_modified
2660
self._inventory_is_modified = True
2661
self._move(rename_entries)
2663
# restore the inventory on error
2664
self._inventory_is_modified = original_modified
2666
#FIXME: Should potentially also write the from_invs
2667
self._write_inventory(to_inv)
2668
return rename_tuples
2670
@needs_tree_write_lock
2671
def rename_one(self, from_rel, to_rel, after=False):
2674
This can change the directory or the filename or both.
2676
rename_one has several 'modes' to work. First, it can rename a physical
2677
file and change the file_id. That is the normal mode. Second, it can
2678
only change the file_id without touching any physical file.
2680
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2681
versioned but present in the working tree.
2683
rename_one uses the second mode if 'after == False' and 'from_rel' is
2684
versioned but no longer in the working tree, and 'to_rel' is not
2685
versioned but present in the working tree.
2687
rename_one uses the first mode if 'after == False' and 'from_rel' is
2688
versioned and present in the working tree, and 'to_rel' is not
2689
versioned and not present in the working tree.
2691
Everything else results in an error.
2695
# create rename entries and tuples
2696
from_tail = splitpath(from_rel)[-1]
2697
from_inv, from_id = self._path2inv_file_id(from_rel)
2699
# if file is missing in the inventory maybe it's in the basis_tree
2700
basis_tree = self.branch.basis_tree()
2701
from_id = basis_tree.path2id(from_rel)
2703
raise errors.BzrRenameFailedError(from_rel,to_rel,
2704
errors.NotVersionedError(path=from_rel))
2705
# put entry back in the inventory so we can rename it
2706
from_entry = basis_tree.root_inventory[from_id].copy()
2707
from_inv.add(from_entry)
2709
from_inv, from_inv_id = self._unpack_file_id(from_id)
2710
from_entry = from_inv[from_inv_id]
2711
from_parent_id = from_entry.parent_id
2712
to_dir, to_tail = os.path.split(to_rel)
2713
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2714
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2716
from_tail=from_tail,
2717
from_parent_id=from_parent_id,
2718
to_rel=to_rel, to_tail=to_tail,
2719
to_parent_id=to_dir_id)
2720
rename_entries.append(rename_entry)
2722
# determine which move mode to use. checks also for movability
2723
rename_entries = self._determine_mv_mode(rename_entries, after)
2725
# check if the target changed directory and if the target directory is
2727
if to_dir_id is None:
2728
raise errors.BzrMoveFailedError(from_rel,to_rel,
2729
errors.NotVersionedError(path=to_dir))
2731
# all checks done. now we can continue with our actual work
2732
mutter('rename_one:\n'
2737
' to_dir_id {%s}\n',
2738
from_id, from_rel, to_rel, to_dir, to_dir_id)
2740
self._move(rename_entries)
2741
self._write_inventory(to_inv)
2743
class _RenameEntry(object):
2744
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2745
to_rel, to_tail, to_parent_id, only_change_inv=False,
2747
self.from_rel = from_rel
2748
self.from_id = from_id
2749
self.from_tail = from_tail
2750
self.from_parent_id = from_parent_id
2751
self.to_rel = to_rel
2752
self.to_tail = to_tail
2753
self.to_parent_id = to_parent_id
2754
self.change_id = change_id
2755
self.only_change_inv = only_change_inv
2757
def _determine_mv_mode(self, rename_entries, after=False):
2758
"""Determines for each from-to pair if both inventory and working tree
2759
or only the inventory has to be changed.
2761
Also does basic plausability tests.
2763
# FIXME: Handling of nested trees
2764
inv = self.root_inventory
2766
for rename_entry in rename_entries:
2767
# store to local variables for easier reference
2768
from_rel = rename_entry.from_rel
2769
from_id = rename_entry.from_id
2770
to_rel = rename_entry.to_rel
2771
to_id = inv.path2id(to_rel)
2772
only_change_inv = False
2775
# check the inventory for source and destination
2777
raise errors.BzrMoveFailedError(from_rel,to_rel,
2778
errors.NotVersionedError(path=from_rel))
2779
if to_id is not None:
2781
# allow it with --after but only if dest is newly added
2783
basis = self.basis_tree()
2786
if not basis.has_id(to_id):
2787
rename_entry.change_id = True
2792
raise errors.BzrMoveFailedError(from_rel,to_rel,
2793
errors.AlreadyVersionedError(path=to_rel))
2795
# try to determine the mode for rename (only change inv or change
2796
# inv and file system)
2798
if not self.has_filename(to_rel):
2799
raise errors.BzrMoveFailedError(from_id,to_rel,
2800
errors.NoSuchFile(path=to_rel,
2801
extra="New file has not been created yet"))
2802
only_change_inv = True
2803
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2804
only_change_inv = True
2805
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2806
only_change_inv = False
2807
elif (not self.case_sensitive
2808
and from_rel.lower() == to_rel.lower()
2809
and self.has_filename(from_rel)):
2810
only_change_inv = False
2812
# something is wrong, so lets determine what exactly
2813
if not self.has_filename(from_rel) and \
2814
not self.has_filename(to_rel):
2815
raise errors.BzrRenameFailedError(from_rel, to_rel,
2816
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2818
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2819
rename_entry.only_change_inv = only_change_inv
2820
return rename_entries
2822
def _move(self, rename_entries):
2823
"""Moves a list of files.
2825
Depending on the value of the flag 'only_change_inv', the
2826
file will be moved on the file system or not.
2830
for entry in rename_entries:
2832
self._move_entry(entry)
2834
self._rollback_move(moved)
2838
def _rollback_move(self, moved):
2839
"""Try to rollback a previous move in case of an filesystem error."""
2842
self._move_entry(WorkingTree._RenameEntry(
2843
entry.to_rel, entry.from_id,
2844
entry.to_tail, entry.to_parent_id, entry.from_rel,
2845
entry.from_tail, entry.from_parent_id,
2846
entry.only_change_inv))
2847
except errors.BzrMoveFailedError, e:
2848
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2849
" The working tree is in an inconsistent state."
2850
" Please consider doing a 'bzr revert'."
2851
" Error message is: %s" % e)
2853
def _move_entry(self, entry):
2854
inv = self.root_inventory
2855
from_rel_abs = self.abspath(entry.from_rel)
2856
to_rel_abs = self.abspath(entry.to_rel)
2857
if from_rel_abs == to_rel_abs:
2858
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2859
"Source and target are identical.")
2861
if not entry.only_change_inv:
2863
osutils.rename(from_rel_abs, to_rel_abs)
2865
raise errors.BzrMoveFailedError(entry.from_rel,
2868
to_id = inv.path2id(entry.to_rel)
2869
inv.remove_recursive_id(to_id)
2870
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2872
@needs_tree_write_lock
2873
def unversion(self, file_ids):
2874
"""Remove the file ids in file_ids from the current versioned set.
2876
When a file_id is unversioned, all of its children are automatically
2879
:param file_ids: The file ids to stop versioning.
2880
:raises: NoSuchId if any fileid is not currently versioned.
2882
for file_id in file_ids:
2883
if not self._inventory.has_id(file_id):
2884
raise errors.NoSuchId(self, file_id)
2885
for file_id in file_ids:
2886
if self._inventory.has_id(file_id):
2887
self._inventory.remove_recursive_id(file_id)
2889
# in the future this should just set a dirty bit to wait for the
2890
# final unlock. However, until all methods of workingtree start
2891
# with the current in -memory inventory rather than triggering
2892
# a read, it is more complex - we need to teach read_inventory
2893
# to know when to read, and when to not read first... and possibly
2894
# to save first when the in memory one may be corrupted.
2895
# so for now, we just only write it if it is indeed dirty.
2897
self._write_inventory(self._inventory)
2899
def stored_kind(self, file_id):
2900
"""See Tree.stored_kind"""
2901
inv, inv_file_id = self._unpack_file_id(file_id)
2902
return inv[inv_file_id].kind
2905
"""Yield all unversioned files in this WorkingTree.
2907
If there are any unversioned directories then only the directory is
2908
returned, not all its children. But if there are unversioned files
2909
under a versioned subdirectory, they are returned.
2911
Currently returned depth-first, sorted by name within directories.
2912
This is the same order used by 'osutils.walkdirs'.
2914
## TODO: Work from given directory downwards
2915
for path, dir_entry in self.iter_entries_by_dir():
2916
if dir_entry.kind != 'directory':
2918
# mutter("search for unknowns in %r", path)
2919
dirabs = self.abspath(path)
2920
if not isdir(dirabs):
2921
# e.g. directory deleted
2925
for subf in os.listdir(dirabs):
2926
if self.bzrdir.is_control_filename(subf):
2928
if subf not in dir_entry.children:
2931
can_access) = osutils.normalized_filename(subf)
2932
except UnicodeDecodeError:
2933
path_os_enc = path.encode(osutils._fs_enc)
2934
relpath = path_os_enc + '/' + subf
2935
raise errors.BadFilenameEncoding(relpath,
2937
if subf_norm != subf and can_access:
2938
if subf_norm not in dir_entry.children:
2939
fl.append(subf_norm)
2945
subp = pathjoin(path, subf)
2948
def _walkdirs(self, prefix=""):
2949
"""Walk the directories of this tree.
2951
:param prefix: is used as the directrory to start with.
2952
:returns: a generator which yields items in the form::
2954
((curren_directory_path, fileid),
2955
[(file1_path, file1_name, file1_kind, None, file1_id,
2958
_directory = 'directory'
2959
# get the root in the inventory
2960
inv, top_id = self._path2inv_file_id(prefix)
2964
pending = [(prefix, '', _directory, None, top_id, None)]
2967
currentdir = pending.pop()
2968
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2969
top_id = currentdir[4]
2971
relroot = currentdir[0] + '/'
2974
# FIXME: stash the node in pending
2976
if entry.kind == 'directory':
2977
for name, child in entry.sorted_children():
2978
dirblock.append((relroot + name, name, child.kind, None,
2979
child.file_id, child.kind
2981
yield (currentdir[0], entry.file_id), dirblock
2982
# push the user specified dirs from dirblock
2983
for dir in reversed(dirblock):
2984
if dir[2] == _directory:
2988
def update_feature_flags(self, updated_flags):
2989
"""Update the feature flags for this branch.
2991
:param updated_flags: Dictionary mapping feature names to necessities
2992
A necessity can be None to indicate the feature should be removed
2994
self._format._update_feature_flags(updated_flags)
2995
self.control_transport.put_bytes('format', self._format.as_string())
2998
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2999
"""Registry for working tree formats."""
3001
def __init__(self, other_registry=None):
3002
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
3003
self._default_format = None
3004
self._default_format_key = None
3006
def get_default(self):
3007
"""Return the current default format."""
3008
if (self._default_format_key is not None and
3009
self._default_format is None):
3010
self._default_format = self.get(self._default_format_key)
3011
return self._default_format
3013
def set_default(self, format):
3014
"""Set the default format."""
3015
self._default_format = format
3016
self._default_format_key = None
3018
def set_default_key(self, format_string):
3019
"""Set the default format by its format string."""
3020
self._default_format_key = format_string
3021
self._default_format = None
3024
format_registry = WorkingTreeFormatRegistry()
3027
class WorkingTreeFormat(controldir.ControlComponentFormat):
2483
3028
"""An encapsulation of the initialization and open routines for a format.
2485
3030
Formats provide three things:
2542
3086
"""Is this format supported?
2544
3088
Supported formats can be initialized and opened.
2545
Unsupported formats may not support initialization or committing or
3089
Unsupported formats may not support initialization or committing or
2546
3090
some other features depending on the reason for not being supported.
2551
def register_format(klass, format):
2552
klass._formats[format.get_format_string()] = format
2555
def set_default_format(klass, format):
2556
klass._default_format = format
2559
def unregister_format(klass, format):
2560
assert klass._formats[format.get_format_string()] is format
2561
del klass._formats[format.get_format_string()]
2564
class WorkingTreeFormat2(WorkingTreeFormat):
2565
"""The second working tree format.
2567
This format modified the hash cache from the format 1 hash cache.
2570
upgrade_recommended = True
2572
def get_format_description(self):
2573
"""See WorkingTreeFormat.get_format_description()."""
2574
return "Working tree format 2"
2576
def stub_initialize_remote(self, control_files):
2577
"""As a special workaround create critical control files for a remote working tree
2579
This ensures that it can later be updated and dealt with locally,
2580
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2581
no working tree. (See bug #43064).
2585
xml5.serializer_v5.write_inventory(inv, sio)
2587
control_files.put('inventory', sio)
2589
control_files.put_bytes('pending-merges', '')
2592
def initialize(self, a_bzrdir, revision_id=None):
2593
"""See WorkingTreeFormat.initialize()."""
2594
if not isinstance(a_bzrdir.transport, LocalTransport):
2595
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2596
branch = a_bzrdir.open_branch()
2597
if revision_id is not None:
2598
revision_id = osutils.safe_revision_id(revision_id)
2601
revision_history = branch.revision_history()
2603
position = revision_history.index(revision_id)
2605
raise errors.NoSuchRevision(branch, revision_id)
2606
branch.set_revision_history(revision_history[:position + 1])
2609
revision = branch.last_revision()
2611
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2617
basis_tree = branch.repository.revision_tree(revision)
2618
if basis_tree.inventory.root is not None:
2619
wt.set_root_id(basis_tree.inventory.root.file_id)
2620
# set the parent list and cache the basis tree.
2621
wt.set_parent_trees([(revision, basis_tree)])
2622
transform.build_tree(basis_tree, wt)
2626
super(WorkingTreeFormat2, self).__init__()
2627
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2629
def open(self, a_bzrdir, _found=False):
2630
"""Return the WorkingTree object for a_bzrdir
2632
_found is a private parameter, do not use it. It is used to indicate
2633
if format probing has already been done.
2636
# we are being called directly and must probe.
2637
raise NotImplementedError
2638
if not isinstance(a_bzrdir.transport, LocalTransport):
2639
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2640
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2646
class WorkingTreeFormat3(WorkingTreeFormat):
2647
"""The second working tree format updated to record a format marker.
2650
- exists within a metadir controlling .bzr
2651
- includes an explicit version marker for the workingtree control
2652
files, separate from the BzrDir format
2653
- modifies the hash cache format
2655
- uses a LockDir to guard access for writes.
2658
upgrade_recommended = True
2660
def get_format_string(self):
2661
"""See WorkingTreeFormat.get_format_string()."""
2662
return "Bazaar-NG Working Tree format 3"
2664
def get_format_description(self):
2665
"""See WorkingTreeFormat.get_format_description()."""
2666
return "Working tree format 3"
2668
_lock_file_name = 'lock'
2669
_lock_class = LockDir
2671
_tree_class = WorkingTree3
2673
def __get_matchingbzrdir(self):
2674
return bzrdir.BzrDirMetaFormat1()
2676
_matchingbzrdir = property(__get_matchingbzrdir)
2678
def _open_control_files(self, a_bzrdir):
2679
transport = a_bzrdir.get_workingtree_transport(None)
2680
return LockableFiles(transport, self._lock_file_name,
2683
def initialize(self, a_bzrdir, revision_id=None):
2684
"""See WorkingTreeFormat.initialize().
2686
revision_id allows creating a working tree at a different
2687
revision than the branch is at.
2689
if not isinstance(a_bzrdir.transport, LocalTransport):
2690
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2691
transport = a_bzrdir.get_workingtree_transport(self)
2692
control_files = self._open_control_files(a_bzrdir)
2693
control_files.create_lock()
2694
control_files.lock_write()
2695
control_files.put_utf8('format', self.get_format_string())
2696
branch = a_bzrdir.open_branch()
2697
if revision_id is None:
2698
revision_id = branch.last_revision()
2700
revision_id = osutils.safe_revision_id(revision_id)
2701
# WorkingTree3 can handle an inventory which has a unique root id.
2702
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2703
# those trees. And because there isn't a format bump inbetween, we
2704
# are maintaining compatibility with older clients.
2705
# inv = Inventory(root_id=gen_root_id())
2706
inv = self._initial_inventory()
2707
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2713
_control_files=control_files)
2714
wt.lock_tree_write()
2716
basis_tree = branch.repository.revision_tree(revision_id)
2717
# only set an explicit root id if there is one to set.
2718
if basis_tree.inventory.root is not None:
2719
wt.set_root_id(basis_tree.inventory.root.file_id)
2720
if revision_id == NULL_REVISION:
2721
wt.set_parent_trees([])
2723
wt.set_parent_trees([(revision_id, basis_tree)])
2724
transform.build_tree(basis_tree, wt)
2726
# Unlock in this order so that the unlock-triggers-flush in
2727
# WorkingTree is given a chance to fire.
2728
control_files.unlock()
2732
def _initial_inventory(self):
2736
super(WorkingTreeFormat3, self).__init__()
2738
def open(self, a_bzrdir, _found=False):
2739
"""Return the WorkingTree object for a_bzrdir
2741
_found is a private parameter, do not use it. It is used to indicate
2742
if format probing has already been done.
2745
# we are being called directly and must probe.
2746
raise NotImplementedError
2747
if not isinstance(a_bzrdir.transport, LocalTransport):
2748
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2749
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2752
def _open(self, a_bzrdir, control_files):
2753
"""Open the tree itself.
2755
:param a_bzrdir: the dir for the tree.
2756
:param control_files: the control files for the tree.
2758
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2762
_control_files=control_files)
2765
return self.get_format_string()
2768
__default_format = WorkingTreeFormat4()
2769
WorkingTreeFormat.register_format(__default_format)
2770
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2771
WorkingTreeFormat.set_default_format(__default_format)
2772
# formats which have no format string are not discoverable
2773
# and not independently creatable, so are not registered.
2774
_legacy_formats = [WorkingTreeFormat2(),
3094
def supports_content_filtering(self):
3095
"""True if this format supports content filtering."""
3098
def supports_views(self):
3099
"""True if this format supports stored views."""
3102
def get_controldir_for_branch(self):
3103
"""Get the control directory format for creating branches.
3105
This is to support testing of working tree formats that can not exist
3106
in the same control directory as a branch.
3108
return self._matchingbzrdir
3111
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3112
"""Base class for working trees that live in bzr meta directories."""
3115
WorkingTreeFormat.__init__(self)
3116
bzrdir.BzrFormat.__init__(self)
3119
def find_format_string(klass, controldir):
3120
"""Return format name for the working tree object in controldir."""
3122
transport = controldir.get_workingtree_transport(None)
3123
return transport.get_bytes("format")
3124
except errors.NoSuchFile:
3125
raise errors.NoWorkingTree(base=transport.base)
3128
def find_format(klass, controldir):
3129
"""Return the format for the working tree object in controldir."""
3130
format_string = klass.find_format_string(controldir)
3131
return klass._find_format(format_registry, 'working tree',
3134
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3136
WorkingTreeFormat.check_support_status(self,
3137
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3139
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3140
recommend_upgrade=recommend_upgrade, basedir=basedir)
3142
def get_controldir_for_branch(self):
3143
"""Get the control directory format for creating branches.
3145
This is to support testing of working tree formats that can not exist
3146
in the same control directory as a branch.
3148
return self._matchingbzrdir
3151
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3152
"""Base class for working trees that live in bzr meta directories."""
3155
WorkingTreeFormat.__init__(self)
3156
bzrdir.BzrFormat.__init__(self)
3159
def find_format_string(klass, controldir):
3160
"""Return format name for the working tree object in controldir."""
3162
transport = controldir.get_workingtree_transport(None)
3163
return transport.get_bytes("format")
3164
except errors.NoSuchFile:
3165
raise errors.NoWorkingTree(base=transport.base)
3168
def find_format(klass, controldir):
3169
"""Return the format for the working tree object in controldir."""
3170
format_string = klass.find_format_string(controldir)
3171
return klass._find_format(format_registry, 'working tree',
3174
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3176
WorkingTreeFormat.check_support_status(self,
3177
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3179
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3180
recommend_upgrade=recommend_upgrade, basedir=basedir)
3183
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3184
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3185
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3186
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3187
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3188
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3189
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3190
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3191
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")