1034
865
# checkout in a subdirectory. This can be avoided by not adding
1035
866
# it. mbp 20070306
1037
@needs_tree_write_lock
1038
868
def extract(self, file_id, format=None):
1039
869
"""Extract a subtree from this tree.
1041
871
A new branch will be created, relative to the path for this tree.
1045
segments = osutils.splitpath(path)
1046
transport = self.branch.bzrdir.root_transport
1047
for name in segments:
1048
transport = transport.clone(name)
1049
transport.ensure_base()
1052
sub_path = self.id2path(file_id)
1053
branch_transport = mkdirs(sub_path)
1055
format = self.bzrdir.cloning_metadir()
1056
branch_transport.ensure_base()
1057
branch_bzrdir = format.initialize_on_transport(branch_transport)
1059
repo = branch_bzrdir.find_repository()
1060
except errors.NoRepositoryPresent:
1061
repo = branch_bzrdir.create_repository()
1062
if not repo.supports_rich_root():
1063
raise errors.RootNotRich()
1064
new_branch = branch_bzrdir.create_branch()
1065
new_branch.pull(self.branch)
1066
for parent_id in self.get_parent_ids():
1067
new_branch.fetch(self.branch, parent_id)
1068
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1069
if tree_transport.base != branch_transport.base:
1070
tree_bzrdir = format.initialize_on_transport(tree_transport)
1071
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1073
tree_bzrdir = branch_bzrdir
1074
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1075
wt.set_parent_ids(self.get_parent_ids())
1076
my_inv = self.inventory
1077
child_inv = Inventory(root_id=None)
1078
new_root = my_inv[file_id]
1079
my_inv.remove_recursive_id(file_id)
1080
new_root.parent_id = None
1081
child_inv.add(new_root)
1082
self._write_inventory(my_inv)
1083
wt._write_inventory(child_inv)
1086
def _serialize(self, inventory, out_file):
1087
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1090
def _deserialize(selt, in_file):
1091
return xml5.serializer_v5.read_inventory(in_file)
873
raise NotImplementedError(self.extract)
1093
875
def flush(self):
1094
"""Write the in memory inventory to disk."""
1095
# TODO: Maybe this should only write on dirty ?
1096
if self._control_files._lock_mode != 'w':
1097
raise errors.NotWriteLocked(self)
1099
self._serialize(self._inventory, sio)
1101
self._control_files.put('inventory', sio)
1102
self._inventory_is_modified = False
876
"""Write the in memory meta data to disk."""
877
raise NotImplementedError(self.flush)
1104
879
def _kind(self, relpath):
1105
880
return osutils.file_kind(self.abspath(relpath))
1107
def list_files(self, include_root=False):
1108
"""Recursively list all files as (path, class, kind, id, entry).
882
def list_files(self, include_root=False, from_dir=None, recursive=True):
883
"""List all files as (path, class, kind, id, entry).
1110
885
Lists, but does not descend into unversioned directories.
1112
886
This does not include files that have been deleted in this
887
tree. Skips the control directory.
1115
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
1117
# list_files is an iterator, so @needs_read_lock doesn't work properly
1118
# with it. So callers should be careful to always read_lock the tree.
1119
if not self.is_locked():
1120
raise errors.ObjectNotLocked(self)
1122
inv = self.inventory
1123
if include_root is True:
1124
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1125
# Convert these into local objects to save lookup times
1126
pathjoin = osutils.pathjoin
1127
file_kind = self._kind
1129
# transport.base ends in a slash, we want the piece
1130
# between the last two slashes
1131
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1133
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1135
# directory file_id, relative path, absolute path, reverse sorted children
1136
children = os.listdir(self.basedir)
1138
# jam 20060527 The kernel sized tree seems equivalent whether we
1139
# use a deque and popleft to keep them sorted, or if we use a plain
1140
# list and just reverse() them.
1141
children = collections.deque(children)
1142
stack = [(inv.root.file_id, u'', self.basedir, children)]
1144
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1147
f = children.popleft()
1148
## TODO: If we find a subdirectory with its own .bzr
1149
## directory, then that is a separate tree and we
1150
## should exclude it.
1152
# the bzrdir for this tree
1153
if transport_base_dir == f:
1156
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1157
# and 'f' doesn't begin with one, we can do a string op, rather
1158
# than the checks of pathjoin(), all relative paths will have an extra slash
1160
fp = from_dir_relpath + '/' + f
1163
fap = from_dir_abspath + '/' + f
1165
f_ie = inv.get_child(from_dir_id, f)
1168
elif self.is_ignored(fp[1:]):
1171
# we may not have found this file, because of a unicode issue
1172
f_norm, can_access = osutils.normalized_filename(f)
1173
if f == f_norm or not can_access:
1174
# No change, so treat this file normally
1177
# this file can be accessed by a normalized path
1178
# check again if it is versioned
1179
# these lines are repeated here for performance
1181
fp = from_dir_relpath + '/' + f
1182
fap = from_dir_abspath + '/' + f
1183
f_ie = inv.get_child(from_dir_id, f)
1186
elif self.is_ignored(fp[1:]):
1193
# make a last minute entry
1195
yield fp[1:], c, fk, f_ie.file_id, f_ie
1198
yield fp[1:], c, fk, None, fk_entries[fk]()
1200
yield fp[1:], c, fk, None, TreeEntry()
1203
if fk != 'directory':
1206
# But do this child first
1207
new_children = os.listdir(fap)
1209
new_children = collections.deque(new_children)
1210
stack.append((f_ie.file_id, fp, fap, new_children))
1211
# Break out of inner loop,
1212
# so that we start outer loop with child
1215
# if we finished all children, pop it off the stack
1218
@needs_tree_write_lock
1219
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):
1220
896
"""Rename files.
1222
to_dir must exist in the inventory.
898
to_dir must be known to the working tree.
1224
900
If to_dir exists and is a directory, the files are moved into
1225
it, keeping their old names.
901
it, keeping their old names.
1227
903
Note that to_dir is only the last component of the new name;
1228
904
this doesn't change the directory.
2513
class WorkingTree2(WorkingTree):
2514
"""This is the Format 2 working tree.
2516
This was the first weave based working tree.
2517
- uses os locks for locking.
2518
- uses the branch last-revision.
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.
2521
def __init__(self, *args, **kwargs):
2522
super(WorkingTree2, self).__init__(*args, **kwargs)
2523
# WorkingTree2 has more of a constraint that self._inventory must
2524
# exist. Because this is an older format, we don't mind the overhead
2525
# caused by the extra computation here.
2527
# Newer WorkingTree's should only have self._inventory set when they
2529
if self._inventory is None:
2530
self.read_working_inventory()
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()
2532
1843
def lock_tree_write(self):
2533
"""See WorkingTree.lock_tree_write().
2535
In Format2 WorkingTrees we have a single lock for the branch and tree
2536
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():
2538
1865
self.branch.lock_write()
2540
return self._control_files.lock_write()
1867
self._control_files.lock_write()
1868
return LogicalLockResult(self.unlock)
2542
1870
self.branch.unlock()
2546
# do non-implementation specific cleanup
2549
# we share control files:
2550
if self._control_files._lock_count == 3:
2551
# _inventory_is_modified is always False during a read lock.
2552
if self._inventory_is_modified:
2554
self._write_hashcache_if_dirty()
2556
# 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')
2558
return self._control_files.unlock()
1918
result = self._deserialize(f)
2560
self.branch.unlock()
2563
class WorkingTree3(WorkingTree):
2564
"""This is the Format 3 working tree.
2566
This differs from the base WorkingTree by:
2567
- having its own file lock
2568
- having its own last-revision property.
2570
This is new in bzr 0.8
2574
def _last_revision(self):
2575
"""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
2577
return self._control_files.get('last-revision').read()
2578
except errors.NoSuchFile:
2579
return _mod_revision.NULL_REVISION
2581
def _change_last_revision(self, revision_id):
2582
"""See WorkingTree._change_last_revision."""
2583
if revision_id is None or revision_id == NULL_REVISION:
2585
self._control_files._transport.delete('last-revision')
2586
except errors.NoSuchFile:
2590
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)
2593
2018
@needs_tree_write_lock
2594
2019
def set_conflicts(self, conflicts):
2595
self._put_rio('conflicts', conflicts.to_stanzas(),
2020
self._put_rio('conflicts', conflicts.to_stanzas(),
2596
2021
CONFLICT_HEADER_1)
2598
2023
@needs_tree_write_lock
2605
2030
@needs_read_lock
2606
2031
def conflicts(self):
2608
confile = self._control_files.get('conflicts')
2033
confile = self._transport.get('conflicts')
2609
2034
except errors.NoSuchFile:
2610
2035
return _mod_conflicts.ConflictList()
2612
if confile.next() != CONFLICT_HEADER_1 + '\n':
2038
if confile.next() != CONFLICT_HEADER_1 + '\n':
2039
raise errors.ConflictFormatError()
2040
except StopIteration:
2613
2041
raise errors.ConflictFormatError()
2614
except StopIteration:
2615
raise errors.ConflictFormatError()
2616
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2619
# do non-implementation specific cleanup
2621
if self._control_files._lock_count == 1:
2622
# _inventory_is_modified is always False during a read lock.
2623
if self._inventory_is_modified:
2625
self._write_hashcache_if_dirty()
2626
# 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')
2628
return self._control_files.unlock()
2067
result = self._deserialize(f)
2630
self.branch.unlock()
2633
def get_conflicted_stem(path):
2634
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2635
if path.endswith(suffix):
2636
return path[:-len(suffix)]
2639
@deprecated_function(zero_eight)
2640
def is_control_file(filename):
2641
"""See WorkingTree.is_control_filename(filename)."""
2642
## FIXME: better check
2643
filename = normpath(filename)
2644
while filename != '':
2645
head, tail = os.path.split(filename)
2646
## 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:
2649
if filename == head:
2655
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
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2424
target_branch=new_branch)
2426
tree_bzrdir = branch_bzrdir
2427
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2428
wt.set_parent_ids(self.get_parent_ids())
2429
my_inv = self.inventory
2430
child_inv = inventory.Inventory(root_id=None)
2431
new_root = my_inv[file_id]
2432
my_inv.remove_recursive_id(file_id)
2433
new_root.parent_id = None
2434
child_inv.add(new_root)
2435
self._write_inventory(my_inv)
2436
wt._write_inventory(child_inv)
2439
def list_files(self, include_root=False, from_dir=None, recursive=True):
2440
"""List all files as (path, class, kind, id, entry).
2442
Lists, but does not descend into unversioned directories.
2443
This does not include files that have been deleted in this
2444
tree. Skips the control directory.
2446
:param include_root: if True, return an entry for the root
2447
:param from_dir: start from this directory or None for the root
2448
:param recursive: whether to recurse into subdirectories or not
2450
# list_files is an iterator, so @needs_read_lock doesn't work properly
2451
# with it. So callers should be careful to always read_lock the tree.
2452
if not self.is_locked():
2453
raise errors.ObjectNotLocked(self)
2455
inv = self.inventory
2456
if from_dir is None and include_root is True:
2457
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2458
# Convert these into local objects to save lookup times
2459
pathjoin = osutils.pathjoin
2460
file_kind = self._kind
2462
# transport.base ends in a slash, we want the piece
2463
# between the last two slashes
2464
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2466
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2468
# directory file_id, relative path, absolute path, reverse sorted children
2469
if from_dir is not None:
2470
from_dir_id = inv.path2id(from_dir)
2471
if from_dir_id is None:
2472
# Directory not versioned
2474
from_dir_abspath = pathjoin(self.basedir, from_dir)
2476
from_dir_id = inv.root.file_id
2477
from_dir_abspath = self.basedir
2478
children = os.listdir(from_dir_abspath)
2480
# jam 20060527 The kernel sized tree seems equivalent whether we
2481
# use a deque and popleft to keep them sorted, or if we use a plain
2482
# list and just reverse() them.
2483
children = collections.deque(children)
2484
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2486
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2489
f = children.popleft()
2490
## TODO: If we find a subdirectory with its own .bzr
2491
## directory, then that is a separate tree and we
2492
## should exclude it.
2494
# the bzrdir for this tree
2495
if transport_base_dir == f:
2498
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2499
# and 'f' doesn't begin with one, we can do a string op, rather
2500
# than the checks of pathjoin(), all relative paths will have an extra slash
2502
fp = from_dir_relpath + '/' + f
2505
fap = from_dir_abspath + '/' + f
2507
dir_ie = inv[from_dir_id]
2508
if dir_ie.kind == 'directory':
2509
f_ie = dir_ie.children.get(f)
2514
elif self.is_ignored(fp[1:]):
2517
# we may not have found this file, because of a unicode
2518
# issue, or because the directory was actually a symlink.
2519
f_norm, can_access = osutils.normalized_filename(f)
2520
if f == f_norm or not can_access:
2521
# No change, so treat this file normally
2524
# this file can be accessed by a normalized path
2525
# check again if it is versioned
2526
# these lines are repeated here for performance
2528
fp = from_dir_relpath + '/' + f
2529
fap = from_dir_abspath + '/' + f
2530
f_ie = inv.get_child(from_dir_id, f)
2533
elif self.is_ignored(fp[1:]):
2540
# make a last minute entry
2542
yield fp[1:], c, fk, f_ie.file_id, f_ie
2545
yield fp[1:], c, fk, None, fk_entries[fk]()
2547
yield fp[1:], c, fk, None, TreeEntry()
2550
if fk != 'directory':
2553
# But do this child first if recursing down
2555
new_children = os.listdir(fap)
2557
new_children = collections.deque(new_children)
2558
stack.append((f_ie.file_id, fp, fap, new_children))
2559
# Break out of inner loop,
2560
# so that we start outer loop with child
2563
# if we finished all children, pop it off the stack
2566
@needs_tree_write_lock
2567
def move(self, from_paths, to_dir=None, after=False):
2570
to_dir must exist in the inventory.
2572
If to_dir exists and is a directory, the files are moved into
2573
it, keeping their old names.
2575
Note that to_dir is only the last component of the new name;
2576
this doesn't change the directory.
2578
For each entry in from_paths the move mode will be determined
2581
The first mode moves the file in the filesystem and updates the
2582
inventory. The second mode only updates the inventory without
2583
touching the file on the filesystem.
2585
move uses the second mode if 'after == True' and the target is
2586
either not versioned or newly added, and present in the working tree.
2588
move uses the second mode if 'after == False' and the source is
2589
versioned but no longer in the working tree, and the target is not
2590
versioned but present in the working tree.
2592
move uses the first mode if 'after == False' and the source is
2593
versioned and present in the working tree, and the target is not
2594
versioned and not present in the working tree.
2596
Everything else results in an error.
2598
This returns a list of (from_path, to_path) pairs for each
2599
entry that is moved.
2604
# check for deprecated use of signature
2606
raise TypeError('You must supply a target directory')
2607
# check destination directory
2608
if isinstance(from_paths, basestring):
2610
inv = self.inventory
2611
to_abs = self.abspath(to_dir)
2612
if not isdir(to_abs):
2613
raise errors.BzrMoveFailedError('',to_dir,
2614
errors.NotADirectory(to_abs))
2615
if not self.has_filename(to_dir):
2616
raise errors.BzrMoveFailedError('',to_dir,
2617
errors.NotInWorkingDirectory(to_dir))
2618
to_dir_id = inv.path2id(to_dir)
2619
if to_dir_id is None:
2620
raise errors.BzrMoveFailedError('',to_dir,
2621
errors.NotVersionedError(path=to_dir))
2623
to_dir_ie = inv[to_dir_id]
2624
if to_dir_ie.kind != 'directory':
2625
raise errors.BzrMoveFailedError('',to_dir,
2626
errors.NotADirectory(to_abs))
2628
# create rename entries and tuples
2629
for from_rel in from_paths:
2630
from_tail = splitpath(from_rel)[-1]
2631
from_id = inv.path2id(from_rel)
2633
raise errors.BzrMoveFailedError(from_rel,to_dir,
2634
errors.NotVersionedError(path=from_rel))
2636
from_entry = inv[from_id]
2637
from_parent_id = from_entry.parent_id
2638
to_rel = pathjoin(to_dir, from_tail)
2639
rename_entry = InventoryWorkingTree._RenameEntry(
2642
from_tail=from_tail,
2643
from_parent_id=from_parent_id,
2644
to_rel=to_rel, to_tail=from_tail,
2645
to_parent_id=to_dir_id)
2646
rename_entries.append(rename_entry)
2647
rename_tuples.append((from_rel, to_rel))
2649
# determine which move mode to use. checks also for movability
2650
rename_entries = self._determine_mv_mode(rename_entries, after)
2652
original_modified = self._inventory_is_modified
2655
self._inventory_is_modified = True
2656
self._move(rename_entries)
2658
# restore the inventory on error
2659
self._inventory_is_modified = original_modified
2661
self._write_inventory(inv)
2662
return rename_tuples
2664
@needs_tree_write_lock
2665
def rename_one(self, from_rel, to_rel, after=False):
2668
This can change the directory or the filename or both.
2670
rename_one has several 'modes' to work. First, it can rename a physical
2671
file and change the file_id. That is the normal mode. Second, it can
2672
only change the file_id without touching any physical file.
2674
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2675
versioned but present in the working tree.
2677
rename_one uses the second mode if 'after == False' and 'from_rel' is
2678
versioned but no longer in the working tree, and 'to_rel' is not
2679
versioned but present in the working tree.
2681
rename_one uses the first mode if 'after == False' and 'from_rel' is
2682
versioned and present in the working tree, and 'to_rel' is not
2683
versioned and not present in the working tree.
2685
Everything else results in an error.
2687
inv = self.inventory
2690
# create rename entries and tuples
2691
from_tail = splitpath(from_rel)[-1]
2692
from_id = inv.path2id(from_rel)
2694
# if file is missing in the inventory maybe it's in the basis_tree
2695
basis_tree = self.branch.basis_tree()
2696
from_id = basis_tree.path2id(from_rel)
2698
raise errors.BzrRenameFailedError(from_rel,to_rel,
2699
errors.NotVersionedError(path=from_rel))
2700
# put entry back in the inventory so we can rename it
2701
from_entry = basis_tree.inventory[from_id].copy()
2704
from_entry = inv[from_id]
2705
from_parent_id = from_entry.parent_id
2706
to_dir, to_tail = os.path.split(to_rel)
2707
to_dir_id = inv.path2id(to_dir)
2708
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2710
from_tail=from_tail,
2711
from_parent_id=from_parent_id,
2712
to_rel=to_rel, to_tail=to_tail,
2713
to_parent_id=to_dir_id)
2714
rename_entries.append(rename_entry)
2716
# determine which move mode to use. checks also for movability
2717
rename_entries = self._determine_mv_mode(rename_entries, after)
2719
# check if the target changed directory and if the target directory is
2721
if to_dir_id is None:
2722
raise errors.BzrMoveFailedError(from_rel,to_rel,
2723
errors.NotVersionedError(path=to_dir))
2725
# all checks done. now we can continue with our actual work
2726
mutter('rename_one:\n'
2731
' to_dir_id {%s}\n',
2732
from_id, from_rel, to_rel, to_dir, to_dir_id)
2734
self._move(rename_entries)
2735
self._write_inventory(inv)
2737
class _RenameEntry(object):
2738
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2739
to_rel, to_tail, to_parent_id, only_change_inv=False,
2741
self.from_rel = from_rel
2742
self.from_id = from_id
2743
self.from_tail = from_tail
2744
self.from_parent_id = from_parent_id
2745
self.to_rel = to_rel
2746
self.to_tail = to_tail
2747
self.to_parent_id = to_parent_id
2748
self.change_id = change_id
2749
self.only_change_inv = only_change_inv
2751
def _determine_mv_mode(self, rename_entries, after=False):
2752
"""Determines for each from-to pair if both inventory and working tree
2753
or only the inventory has to be changed.
2755
Also does basic plausability tests.
2757
inv = self.inventory
2759
for rename_entry in rename_entries:
2760
# store to local variables for easier reference
2761
from_rel = rename_entry.from_rel
2762
from_id = rename_entry.from_id
2763
to_rel = rename_entry.to_rel
2764
to_id = inv.path2id(to_rel)
2765
only_change_inv = False
2768
# check the inventory for source and destination
2770
raise errors.BzrMoveFailedError(from_rel,to_rel,
2771
errors.NotVersionedError(path=from_rel))
2772
if to_id is not None:
2774
# allow it with --after but only if dest is newly added
2776
basis = self.basis_tree()
2779
if not basis.has_id(to_id):
2780
rename_entry.change_id = True
2785
raise errors.BzrMoveFailedError(from_rel,to_rel,
2786
errors.AlreadyVersionedError(path=to_rel))
2788
# try to determine the mode for rename (only change inv or change
2789
# inv and file system)
2791
if not self.has_filename(to_rel):
2792
raise errors.BzrMoveFailedError(from_id,to_rel,
2793
errors.NoSuchFile(path=to_rel,
2794
extra="New file has not been created yet"))
2795
only_change_inv = True
2796
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2797
only_change_inv = True
2798
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2799
only_change_inv = False
2800
elif (not self.case_sensitive
2801
and from_rel.lower() == to_rel.lower()
2802
and self.has_filename(from_rel)):
2803
only_change_inv = False
2805
# something is wrong, so lets determine what exactly
2806
if not self.has_filename(from_rel) and \
2807
not self.has_filename(to_rel):
2808
raise errors.BzrRenameFailedError(from_rel, to_rel,
2809
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2811
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2812
rename_entry.only_change_inv = only_change_inv
2813
return rename_entries
2815
def _move(self, rename_entries):
2816
"""Moves a list of files.
2818
Depending on the value of the flag 'only_change_inv', the
2819
file will be moved on the file system or not.
2821
inv = self.inventory
2824
for entry in rename_entries:
2826
self._move_entry(entry)
2828
self._rollback_move(moved)
2832
def _rollback_move(self, moved):
2833
"""Try to rollback a previous move in case of an filesystem error."""
2834
inv = self.inventory
2837
self._move_entry(WorkingTree._RenameEntry(
2838
entry.to_rel, entry.from_id,
2839
entry.to_tail, entry.to_parent_id, entry.from_rel,
2840
entry.from_tail, entry.from_parent_id,
2841
entry.only_change_inv))
2842
except errors.BzrMoveFailedError, e:
2843
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2844
" The working tree is in an inconsistent state."
2845
" Please consider doing a 'bzr revert'."
2846
" Error message is: %s" % e)
2848
def _move_entry(self, entry):
2849
inv = self.inventory
2850
from_rel_abs = self.abspath(entry.from_rel)
2851
to_rel_abs = self.abspath(entry.to_rel)
2852
if from_rel_abs == to_rel_abs:
2853
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2854
"Source and target are identical.")
2856
if not entry.only_change_inv:
2858
osutils.rename(from_rel_abs, to_rel_abs)
2860
raise errors.BzrMoveFailedError(entry.from_rel,
2863
to_id = inv.path2id(entry.to_rel)
2864
inv.remove_recursive_id(to_id)
2865
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2867
@needs_tree_write_lock
2868
def unversion(self, file_ids):
2869
"""Remove the file ids in file_ids from the current versioned set.
2871
When a file_id is unversioned, all of its children are automatically
2874
:param file_ids: The file ids to stop versioning.
2875
:raises: NoSuchId if any fileid is not currently versioned.
2877
for file_id in file_ids:
2878
if not self._inventory.has_id(file_id):
2879
raise errors.NoSuchId(self, file_id)
2880
for file_id in file_ids:
2881
if self._inventory.has_id(file_id):
2882
self._inventory.remove_recursive_id(file_id)
2884
# in the future this should just set a dirty bit to wait for the
2885
# final unlock. However, until all methods of workingtree start
2886
# with the current in -memory inventory rather than triggering
2887
# a read, it is more complex - we need to teach read_inventory
2888
# to know when to read, and when to not read first... and possibly
2889
# to save first when the in memory one may be corrupted.
2890
# so for now, we just only write it if it is indeed dirty.
2892
self._write_inventory(self._inventory)
2894
def stored_kind(self, file_id):
2895
"""See Tree.stored_kind"""
2896
return self.inventory[file_id].kind
2899
"""Yield all unversioned files in this WorkingTree.
2901
If there are any unversioned directories then only the directory is
2902
returned, not all its children. But if there are unversioned files
2903
under a versioned subdirectory, they are returned.
2905
Currently returned depth-first, sorted by name within directories.
2906
This is the same order used by 'osutils.walkdirs'.
2908
## TODO: Work from given directory downwards
2909
for path, dir_entry in self.inventory.directories():
2910
# mutter("search for unknowns in %r", path)
2911
dirabs = self.abspath(path)
2912
if not isdir(dirabs):
2913
# e.g. directory deleted
2917
for subf in os.listdir(dirabs):
2918
if self.bzrdir.is_control_filename(subf):
2920
if subf not in dir_entry.children:
2923
can_access) = osutils.normalized_filename(subf)
2924
except UnicodeDecodeError:
2925
path_os_enc = path.encode(osutils._fs_enc)
2926
relpath = path_os_enc + '/' + subf
2927
raise errors.BadFilenameEncoding(relpath,
2929
if subf_norm != subf and can_access:
2930
if subf_norm not in dir_entry.children:
2931
fl.append(subf_norm)
2937
subp = pathjoin(path, subf)
2940
def _walkdirs(self, prefix=""):
2941
"""Walk the directories of this tree.
2943
:param prefix: is used as the directrory to start with.
2944
:returns: a generator which yields items in the form::
2946
((curren_directory_path, fileid),
2947
[(file1_path, file1_name, file1_kind, None, file1_id,
2950
_directory = 'directory'
2951
# get the root in the inventory
2952
inv = self.inventory
2953
top_id = inv.path2id(prefix)
2957
pending = [(prefix, '', _directory, None, top_id, None)]
2960
currentdir = pending.pop()
2961
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2962
top_id = currentdir[4]
2964
relroot = currentdir[0] + '/'
2967
# FIXME: stash the node in pending
2969
if entry.kind == 'directory':
2970
for name, child in entry.sorted_children():
2971
dirblock.append((relroot + name, name, child.kind, None,
2972
child.file_id, child.kind
2974
yield (currentdir[0], entry.file_id), dirblock
2975
# push the user specified dirs from dirblock
2976
for dir in reversed(dirblock):
2977
if dir[2] == _directory:
2981
def update_feature_flags(self, updated_flags):
2982
"""Update the feature flags for this branch.
2984
:param updated_flags: Dictionary mapping feature names to necessities
2985
A necessity can be None to indicate the feature should be removed
2987
self._format._update_feature_flags(updated_flags)
2988
self.control_transport.put_bytes('format', self._format.as_string())
2991
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2992
"""Registry for working tree formats."""
2994
def __init__(self, other_registry=None):
2995
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2996
self._default_format = None
2997
self._default_format_key = None
2999
def get_default(self):
3000
"""Return the current default format."""
3001
if (self._default_format_key is not None and
3002
self._default_format is None):
3003
self._default_format = self.get(self._default_format_key)
3004
return self._default_format
3006
def set_default(self, format):
3007
"""Set the default format."""
3008
self._default_format = format
3009
self._default_format_key = None
3011
def set_default_key(self, format_string):
3012
"""Set the default format by its format string."""
3013
self._default_format_key = format_string
3014
self._default_format = None
3017
format_registry = WorkingTreeFormatRegistry()
3020
class WorkingTreeFormat(controldir.ControlComponentFormat):
2656
3021
"""An encapsulation of the initialization and open routines for a format.
2658
3023
Formats provide three things:
2715
3086
"""Is this format supported?
2717
3088
Supported formats can be initialized and opened.
2718
Unsupported formats may not support initialization or committing or
3089
Unsupported formats may not support initialization or committing or
2719
3090
some other features depending on the reason for not being supported.
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."""
3103
@symbol_versioning.deprecated_method(
3104
symbol_versioning.deprecated_in((2, 4, 0)))
2724
3105
def register_format(klass, format):
2725
klass._formats[format.get_format_string()] = format
3106
format_registry.register(format)
3109
@symbol_versioning.deprecated_method(
3110
symbol_versioning.deprecated_in((2, 4, 0)))
3111
def register_extra_format(klass, format):
3112
format_registry.register_extra(format)
3115
@symbol_versioning.deprecated_method(
3116
symbol_versioning.deprecated_in((2, 4, 0)))
3117
def unregister_extra_format(klass, format):
3118
format_registry.unregister_extra(format)
3121
@symbol_versioning.deprecated_method(
3122
symbol_versioning.deprecated_in((2, 4, 0)))
3123
def get_formats(klass):
3124
return format_registry._get_all()
3127
@symbol_versioning.deprecated_method(
3128
symbol_versioning.deprecated_in((2, 4, 0)))
2728
3129
def set_default_format(klass, format):
2729
klass._default_format = format
3130
format_registry.set_default(format)
3133
@symbol_versioning.deprecated_method(
3134
symbol_versioning.deprecated_in((2, 4, 0)))
2732
3135
def unregister_format(klass, format):
2733
assert klass._formats[format.get_format_string()] is format
2734
del klass._formats[format.get_format_string()]
2737
class WorkingTreeFormat2(WorkingTreeFormat):
2738
"""The second working tree format.
2740
This format modified the hash cache from the format 1 hash cache.
2743
upgrade_recommended = True
2745
def get_format_description(self):
2746
"""See WorkingTreeFormat.get_format_description()."""
2747
return "Working tree format 2"
2749
def stub_initialize_remote(self, control_files):
2750
"""As a special workaround create critical control files for a remote working tree
2752
This ensures that it can later be updated and dealt with locally,
2753
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2754
no working tree. (See bug #43064).
2758
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2760
control_files.put('inventory', sio)
2762
control_files.put_bytes('pending-merges', '')
2765
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2766
accelerator_tree=None):
2767
"""See WorkingTreeFormat.initialize()."""
2768
if not isinstance(a_bzrdir.transport, LocalTransport):
2769
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2770
if from_branch is not None:
2771
branch = from_branch
2773
branch = a_bzrdir.open_branch()
2774
if revision_id is None:
2775
revision_id = _mod_revision.ensure_null(branch.last_revision())
2778
branch.generate_revision_history(revision_id)
2782
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2788
basis_tree = branch.repository.revision_tree(revision_id)
2789
if basis_tree.inventory.root is not None:
2790
wt.set_root_id(basis_tree.get_root_id())
2791
# set the parent list and cache the basis tree.
2792
if _mod_revision.is_null(revision_id):
2795
parent_trees = [(revision_id, basis_tree)]
2796
wt.set_parent_trees(parent_trees)
2797
transform.build_tree(basis_tree, wt)
2801
super(WorkingTreeFormat2, self).__init__()
2802
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2804
def open(self, a_bzrdir, _found=False):
2805
"""Return the WorkingTree object for a_bzrdir
2807
_found is a private parameter, do not use it. It is used to indicate
2808
if format probing has already been done.
2811
# we are being called directly and must probe.
2812
raise NotImplementedError
2813
if not isinstance(a_bzrdir.transport, LocalTransport):
2814
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2815
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2821
class WorkingTreeFormat3(WorkingTreeFormat):
2822
"""The second working tree format updated to record a format marker.
2825
- exists within a metadir controlling .bzr
2826
- includes an explicit version marker for the workingtree control
2827
files, separate from the BzrDir format
2828
- modifies the hash cache format
2830
- uses a LockDir to guard access for writes.
2833
upgrade_recommended = True
2835
def get_format_string(self):
2836
"""See WorkingTreeFormat.get_format_string()."""
2837
return "Bazaar-NG Working Tree format 3"
2839
def get_format_description(self):
2840
"""See WorkingTreeFormat.get_format_description()."""
2841
return "Working tree format 3"
2843
_lock_file_name = 'lock'
2844
_lock_class = LockDir
2846
_tree_class = WorkingTree3
2848
def __get_matchingbzrdir(self):
2849
return bzrdir.BzrDirMetaFormat1()
2851
_matchingbzrdir = property(__get_matchingbzrdir)
2853
def _open_control_files(self, a_bzrdir):
2854
transport = a_bzrdir.get_workingtree_transport(None)
2855
return LockableFiles(transport, self._lock_file_name,
2858
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2859
accelerator_tree=None):
2860
"""See WorkingTreeFormat.initialize().
2862
:param revision_id: if supplied, create a working tree at a different
2863
revision than the branch is at.
2864
:param accelerator_tree: A tree which can be used for retrieving file
2865
contents more quickly than the revision tree, i.e. a workingtree.
2866
The revision tree will be used for cases where accelerator_tree's
2867
content is different.
2869
if not isinstance(a_bzrdir.transport, LocalTransport):
2870
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2871
transport = a_bzrdir.get_workingtree_transport(self)
2872
control_files = self._open_control_files(a_bzrdir)
2873
control_files.create_lock()
2874
control_files.lock_write()
2875
control_files.put_utf8('format', self.get_format_string())
2876
if from_branch is not None:
2877
branch = from_branch
2879
branch = a_bzrdir.open_branch()
2880
if revision_id is None:
2881
revision_id = _mod_revision.ensure_null(branch.last_revision())
2882
# WorkingTree3 can handle an inventory which has a unique root id.
2883
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2884
# those trees. And because there isn't a format bump inbetween, we
2885
# are maintaining compatibility with older clients.
2886
# inv = Inventory(root_id=gen_root_id())
2887
inv = self._initial_inventory()
2888
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2894
_control_files=control_files)
2895
wt.lock_tree_write()
2897
basis_tree = branch.repository.revision_tree(revision_id)
2898
# only set an explicit root id if there is one to set.
2899
if basis_tree.inventory.root is not None:
2900
wt.set_root_id(basis_tree.get_root_id())
2901
if revision_id == NULL_REVISION:
2902
wt.set_parent_trees([])
2904
wt.set_parent_trees([(revision_id, basis_tree)])
2905
transform.build_tree(basis_tree, wt)
2907
# Unlock in this order so that the unlock-triggers-flush in
2908
# WorkingTree is given a chance to fire.
2909
control_files.unlock()
2913
def _initial_inventory(self):
2917
super(WorkingTreeFormat3, self).__init__()
2919
def open(self, a_bzrdir, _found=False):
2920
"""Return the WorkingTree object for a_bzrdir
2922
_found is a private parameter, do not use it. It is used to indicate
2923
if format probing has already been done.
2926
# we are being called directly and must probe.
2927
raise NotImplementedError
2928
if not isinstance(a_bzrdir.transport, LocalTransport):
2929
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2930
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2933
def _open(self, a_bzrdir, control_files):
2934
"""Open the tree itself.
2936
:param a_bzrdir: the dir for the tree.
2937
:param control_files: the control files for the tree.
2939
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2943
_control_files=control_files)
2946
return self.get_format_string()
2949
__default_format = WorkingTreeFormat4()
2950
WorkingTreeFormat.register_format(__default_format)
2951
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2952
WorkingTreeFormat.set_default_format(__default_format)
2953
# formats which have no format string are not discoverable
2954
# and not independently creatable, so are not registered.
2955
_legacy_formats = [WorkingTreeFormat2(),
3136
format_registry.remove(format)
3138
def get_controldir_for_branch(self):
3139
"""Get the control directory format for creating branches.
3141
This is to support testing of working tree formats that can not exist
3142
in the same control directory as a branch.
3144
return self._matchingbzrdir
3147
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3148
"""Base class for working trees that live in bzr meta directories."""
3151
WorkingTreeFormat.__init__(self)
3152
bzrdir.BzrFormat.__init__(self)
3155
def find_format_string(klass, controldir):
3156
"""Return format name for the working tree object in controldir."""
3158
transport = controldir.get_workingtree_transport(None)
3159
return transport.get_bytes("format")
3160
except errors.NoSuchFile:
3161
raise errors.NoWorkingTree(base=transport.base)
3164
def find_format(klass, controldir):
3165
"""Return the format for the working tree object in controldir."""
3166
format_string = klass.find_format_string(controldir)
3167
return klass._find_format(format_registry, 'working tree',
3170
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3172
WorkingTreeFormat.check_support_status(self,
3173
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3175
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3176
recommend_upgrade=recommend_upgrade, basedir=basedir)
3179
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3180
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3181
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3182
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3183
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3184
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3185
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3186
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3187
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
