893
1039
# checkout in a subdirectory. This can be avoided by not adding
894
1040
# it. mbp 20070306
1042
@needs_tree_write_lock
896
1043
def extract(self, file_id, format=None):
897
1044
"""Extract a subtree from this tree.
899
1046
A new branch will be created, relative to the path for this tree.
901
raise NotImplementedError(self.extract)
1050
segments = osutils.splitpath(path)
1051
transport = self.branch.bzrdir.root_transport
1052
for name in segments:
1053
transport = transport.clone(name)
1054
transport.ensure_base()
1057
sub_path = self.id2path(file_id)
1058
branch_transport = mkdirs(sub_path)
1060
format = self.bzrdir.cloning_metadir()
1061
branch_transport.ensure_base()
1062
branch_bzrdir = format.initialize_on_transport(branch_transport)
1064
repo = branch_bzrdir.find_repository()
1065
except errors.NoRepositoryPresent:
1066
repo = branch_bzrdir.create_repository()
1067
if not repo.supports_rich_root():
1068
raise errors.RootNotRich()
1069
new_branch = branch_bzrdir.create_branch()
1070
new_branch.pull(self.branch)
1071
for parent_id in self.get_parent_ids():
1072
new_branch.fetch(self.branch, parent_id)
1073
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1074
if tree_transport.base != branch_transport.base:
1075
tree_bzrdir = format.initialize_on_transport(tree_transport)
1076
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1078
tree_bzrdir = branch_bzrdir
1079
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1080
wt.set_parent_ids(self.get_parent_ids())
1081
my_inv = self.inventory
1082
child_inv = Inventory(root_id=None)
1083
new_root = my_inv[file_id]
1084
my_inv.remove_recursive_id(file_id)
1085
new_root.parent_id = None
1086
child_inv.add(new_root)
1087
self._write_inventory(my_inv)
1088
wt._write_inventory(child_inv)
1091
def _serialize(self, inventory, out_file):
1092
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1095
def _deserialize(selt, in_file):
1096
return xml5.serializer_v5.read_inventory(in_file)
903
1098
def flush(self):
904
"""Write the in memory meta data to disk."""
905
raise NotImplementedError(self.flush)
1099
"""Write the in memory inventory to disk."""
1100
# TODO: Maybe this should only write on dirty ?
1101
if self._control_files._lock_mode != 'w':
1102
raise errors.NotWriteLocked(self)
1104
self._serialize(self._inventory, sio)
1106
self._transport.put_file('inventory', sio,
1107
mode=self.bzrdir._get_file_mode())
1108
self._inventory_is_modified = False
907
1110
def _kind(self, relpath):
908
1111
return osutils.file_kind(self.abspath(relpath))
910
def list_files(self, include_root=False, from_dir=None, recursive=True):
911
"""List all files as (path, class, kind, id, entry).
1113
def list_files(self, include_root=False):
1114
"""Recursively list all files as (path, class, kind, id, entry).
913
1116
Lists, but does not descend into unversioned directories.
914
1118
This does not include files that have been deleted in this
915
tree. Skips the control directory.
917
:param include_root: if True, return an entry for the root
918
:param from_dir: start from this directory or None for the root
919
:param recursive: whether to recurse into subdirectories or not
1121
Skips the control directory.
921
raise NotImplementedError(self.list_files)
923
def move(self, from_paths, to_dir=None, after=False):
1123
# list_files is an iterator, so @needs_read_lock doesn't work properly
1124
# with it. So callers should be careful to always read_lock the tree.
1125
if not self.is_locked():
1126
raise errors.ObjectNotLocked(self)
1128
inv = self.inventory
1129
if include_root is True:
1130
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1131
# Convert these into local objects to save lookup times
1132
pathjoin = osutils.pathjoin
1133
file_kind = self._kind
1135
# transport.base ends in a slash, we want the piece
1136
# between the last two slashes
1137
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1139
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1141
# directory file_id, relative path, absolute path, reverse sorted children
1142
children = os.listdir(self.basedir)
1144
# jam 20060527 The kernel sized tree seems equivalent whether we
1145
# use a deque and popleft to keep them sorted, or if we use a plain
1146
# list and just reverse() them.
1147
children = collections.deque(children)
1148
stack = [(inv.root.file_id, u'', self.basedir, children)]
1150
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1153
f = children.popleft()
1154
## TODO: If we find a subdirectory with its own .bzr
1155
## directory, then that is a separate tree and we
1156
## should exclude it.
1158
# the bzrdir for this tree
1159
if transport_base_dir == f:
1162
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1163
# and 'f' doesn't begin with one, we can do a string op, rather
1164
# than the checks of pathjoin(), all relative paths will have an extra slash
1166
fp = from_dir_relpath + '/' + f
1169
fap = from_dir_abspath + '/' + f
1171
f_ie = inv.get_child(from_dir_id, f)
1174
elif self.is_ignored(fp[1:]):
1177
# we may not have found this file, because of a unicode issue
1178
f_norm, can_access = osutils.normalized_filename(f)
1179
if f == f_norm or not can_access:
1180
# No change, so treat this file normally
1183
# this file can be accessed by a normalized path
1184
# check again if it is versioned
1185
# these lines are repeated here for performance
1187
fp = from_dir_relpath + '/' + f
1188
fap = from_dir_abspath + '/' + f
1189
f_ie = inv.get_child(from_dir_id, f)
1192
elif self.is_ignored(fp[1:]):
1199
# make a last minute entry
1201
yield fp[1:], c, fk, f_ie.file_id, f_ie
1204
yield fp[1:], c, fk, None, fk_entries[fk]()
1206
yield fp[1:], c, fk, None, TreeEntry()
1209
if fk != 'directory':
1212
# But do this child first
1213
new_children = os.listdir(fap)
1215
new_children = collections.deque(new_children)
1216
stack.append((f_ie.file_id, fp, fap, new_children))
1217
# Break out of inner loop,
1218
# so that we start outer loop with child
1221
# if we finished all children, pop it off the stack
1224
@needs_tree_write_lock
1225
def move(self, from_paths, to_dir=None, after=False, **kwargs):
924
1226
"""Rename files.
926
to_dir must be known to the working tree.
1228
to_dir must exist in the inventory.
928
1230
If to_dir exists and is a directory, the files are moved into
929
1231
it, keeping their old names.
1805
2545
return ShelfManager(self, self._transport)
1808
class InventoryWorkingTree(WorkingTree,
1809
bzrlib.mutabletree.MutableInventoryTree):
1810
"""Base class for working trees that are inventory-oriented.
1812
The inventory is held in the `Branch` working-inventory, and the
1813
files are in a directory on disk.
1815
It is possible for a `WorkingTree` to have a filename which is
1816
not listed in the Inventory and vice versa.
2548
class WorkingTree2(WorkingTree):
2549
"""This is the Format 2 working tree.
2551
This was the first weave based working tree.
2552
- uses os locks for locking.
2553
- uses the branch last-revision.
1819
def __init__(self, basedir='.',
1820
branch=DEPRECATED_PARAMETER,
1822
_control_files=None,
1826
"""Construct a InventoryWorkingTree instance. This is not a public API.
1828
:param branch: A branch to override probing for the branch.
1830
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1831
branch=branch, _control_files=_control_files, _internal=_internal,
1832
_format=_format, _bzrdir=_bzrdir)
1834
if _inventory is None:
1835
# This will be acquired on lock_read() or lock_write()
1836
self._inventory_is_modified = False
1837
self._inventory = None
1839
# the caller of __init__ has provided an inventory,
1840
# we assume they know what they are doing - as its only
1841
# the Format factory and creation methods that are
1842
# permitted to do this.
1843
self._set_inventory(_inventory, dirty=False)
1845
def _set_inventory(self, inv, dirty):
1846
"""Set the internal cached inventory.
1848
:param inv: The inventory to set.
1849
:param dirty: A boolean indicating whether the inventory is the same
1850
logical inventory as whats on disk. If True the inventory is not
1851
the same and should be written to disk or data will be lost, if
1852
False then the inventory is the same as that on disk and any
1853
serialisation would be unneeded overhead.
1855
self._inventory = inv
1856
self._inventory_is_modified = dirty
1858
def _serialize(self, inventory, out_file):
1859
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1862
def _deserialize(selt, in_file):
1863
return xml5.serializer_v5.read_inventory(in_file)
1865
@needs_tree_write_lock
1866
def _write_inventory(self, inv):
1867
"""Write inventory as the current inventory."""
1868
self._set_inventory(inv, dirty=True)
1871
# XXX: This method should be deprecated in favour of taking in a proper
1872
# new Inventory object.
1873
@needs_tree_write_lock
1874
def set_inventory(self, new_inventory_list):
1875
from bzrlib.inventory import (Inventory,
1879
inv = Inventory(self.get_root_id())
1880
for path, file_id, parent, kind in new_inventory_list:
1881
name = os.path.basename(path)
1884
# fixme, there should be a factory function inv,add_??
1885
if kind == 'directory':
1886
inv.add(InventoryDirectory(file_id, name, parent))
1887
elif kind == 'file':
1888
inv.add(InventoryFile(file_id, name, parent))
1889
elif kind == 'symlink':
1890
inv.add(InventoryLink(file_id, name, parent))
1892
raise errors.BzrError("unknown kind %r" % kind)
1893
self._write_inventory(inv)
1895
def _write_basis_inventory(self, xml):
1896
"""Write the basis inventory XML to the basis-inventory file"""
1897
path = self._basis_inventory_name()
1899
self._transport.put_file(path, sio,
1900
mode=self.bzrdir._get_file_mode())
1902
def _reset_data(self):
1903
"""Reset transient data that cannot be revalidated."""
1904
self._inventory_is_modified = False
1905
f = self._transport.get('inventory')
1907
result = self._deserialize(f)
2556
def __init__(self, *args, **kwargs):
2557
super(WorkingTree2, self).__init__(*args, **kwargs)
2558
# WorkingTree2 has more of a constraint that self._inventory must
2559
# exist. Because this is an older format, we don't mind the overhead
2560
# caused by the extra computation here.
2562
# Newer WorkingTree's should only have self._inventory set when they
2564
if self._inventory is None:
2565
self.read_working_inventory()
2567
def lock_tree_write(self):
2568
"""See WorkingTree.lock_tree_write().
2570
In Format2 WorkingTrees we have a single lock for the branch and tree
2571
so lock_tree_write() degrades to lock_write().
2573
self.branch.lock_write()
2575
return self._control_files.lock_write()
2577
self.branch.unlock()
2581
# do non-implementation specific cleanup
2584
# we share control files:
2585
if self._control_files._lock_count == 3:
2586
# _inventory_is_modified is always False during a read lock.
2587
if self._inventory_is_modified:
2589
self._write_hashcache_if_dirty()
2591
# reverse order of locking.
2593
return self._control_files.unlock()
1910
self._set_inventory(result, dirty=False)
1912
def _set_root_id(self, file_id):
1913
"""Set the root id for this tree, in a format specific manner.
1915
:param file_id: The file id to assign to the root. It must not be
1916
present in the current inventory or an error will occur. It must
1917
not be None, but rather a valid file id.
1919
inv = self._inventory
1920
orig_root_id = inv.root.file_id
1921
# TODO: it might be nice to exit early if there was nothing
1922
# to do, saving us from trigger a sync on unlock.
1923
self._inventory_is_modified = True
1924
# we preserve the root inventory entry object, but
1925
# unlinkit from the byid index
1926
del inv._byid[inv.root.file_id]
1927
inv.root.file_id = file_id
1928
# and link it into the index with the new changed id.
1929
inv._byid[inv.root.file_id] = inv.root
1930
# and finally update all children to reference the new id.
1931
# XXX: this should be safe to just look at the root.children
1932
# list, not the WHOLE INVENTORY.
1935
if entry.parent_id == orig_root_id:
1936
entry.parent_id = inv.root.file_id
1938
def all_file_ids(self):
1939
"""See Tree.iter_all_file_ids"""
1940
return set(self.inventory)
1942
@needs_tree_write_lock
1943
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1944
"""See MutableTree.set_parent_trees."""
1945
parent_ids = [rev for (rev, tree) in parents_list]
1946
for revision_id in parent_ids:
1947
_mod_revision.check_not_reserved_id(revision_id)
1949
self._check_parents_for_ghosts(parent_ids,
1950
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1952
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1954
if len(parent_ids) == 0:
1955
leftmost_parent_id = _mod_revision.NULL_REVISION
1956
leftmost_parent_tree = None
2595
self.branch.unlock()
2598
class WorkingTree3(WorkingTree):
2599
"""This is the Format 3 working tree.
2601
This differs from the base WorkingTree by:
2602
- having its own file lock
2603
- having its own last-revision property.
2605
This is new in bzr 0.8
2609
def _last_revision(self):
2610
"""See Mutable.last_revision."""
2612
return self._transport.get_bytes('last-revision')
2613
except errors.NoSuchFile:
2614
return _mod_revision.NULL_REVISION
2616
def _change_last_revision(self, revision_id):
2617
"""See WorkingTree._change_last_revision."""
2618
if revision_id is None or revision_id == NULL_REVISION:
2620
self._transport.delete('last-revision')
2621
except errors.NoSuchFile:
1958
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1960
if self._change_last_revision(leftmost_parent_id):
1961
if leftmost_parent_tree is None:
1962
# If we don't have a tree, fall back to reading the
1963
# parent tree from the repository.
1964
self._cache_basis_inventory(leftmost_parent_id)
1966
inv = leftmost_parent_tree.inventory
1967
xml = self._create_basis_xml_from_inventory(
1968
leftmost_parent_id, inv)
1969
self._write_basis_inventory(xml)
1970
self._set_merges_from_parent_ids(parent_ids)
1972
def _cache_basis_inventory(self, new_revision):
1973
"""Cache new_revision as the basis inventory."""
1974
# TODO: this should allow the ready-to-use inventory to be passed in,
1975
# as commit already has that ready-to-use [while the format is the
1978
# this double handles the inventory - unpack and repack -
1979
# but is easier to understand. We can/should put a conditional
1980
# in here based on whether the inventory is in the latest format
1981
# - perhaps we should repack all inventories on a repository
1983
# the fast path is to copy the raw xml from the repository. If the
1984
# xml contains 'revision_id="', then we assume the right
1985
# revision_id is set. We must check for this full string, because a
1986
# root node id can legitimately look like 'revision_id' but cannot
1988
xml = self.branch.repository._get_inventory_xml(new_revision)
1989
firstline = xml.split('\n', 1)[0]
1990
if (not 'revision_id="' in firstline or
1991
'format="7"' not in firstline):
1992
inv = self.branch.repository._serializer.read_inventory_from_string(
1994
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1995
self._write_basis_inventory(xml)
1996
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1999
def _basis_inventory_name(self):
2000
return 'basis-inventory-cache'
2002
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2003
"""Create the text that will be saved in basis-inventory"""
2004
inventory.revision_id = revision_id
2005
return xml7.serializer_v7.write_inventory_to_string(inventory)
2625
self._transport.put_bytes('last-revision', revision_id,
2626
mode=self.bzrdir._get_file_mode())
2007
2629
@needs_tree_write_lock
2008
2630
def set_conflicts(self, conflicts):
2028
2650
raise errors.ConflictFormatError()
2029
2651
except StopIteration:
2030
2652
raise errors.ConflictFormatError()
2031
reader = _mod_rio.RioReader(confile)
2032
return _mod_conflicts.ConflictList.from_stanzas(reader)
2653
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2034
2655
confile.close()
2036
def read_basis_inventory(self):
2037
"""Read the cached basis inventory."""
2038
path = self._basis_inventory_name()
2039
return self._transport.get_bytes(path)
2042
def read_working_inventory(self):
2043
"""Read the working inventory.
2045
:raises errors.InventoryModified: read_working_inventory will fail
2046
when the current in memory inventory has been modified.
2048
# conceptually this should be an implementation detail of the tree.
2049
# XXX: Deprecate this.
2050
# ElementTree does its own conversion from UTF-8, so open in
2052
if self._inventory_is_modified:
2053
raise errors.InventoryModified(self)
2054
f = self._transport.get('inventory')
2056
result = self._deserialize(f)
2059
self._set_inventory(result, dirty=False)
2063
def get_root_id(self):
2064
"""Return the id of this trees root"""
2065
return self._inventory.root.file_id
2067
def has_id(self, file_id):
2068
# files that have been deleted are excluded
2069
inv = self.inventory
2070
if not inv.has_id(file_id):
2072
path = inv.id2path(file_id)
2073
return osutils.lexists(self.abspath(path))
2075
def has_or_had_id(self, file_id):
2076
if file_id == self.inventory.root.file_id:
2078
return self.inventory.has_id(file_id)
2080
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2082
"""Iterate through file_ids for this tree.
2084
file_ids are in a WorkingTree if they are in the working inventory
2085
and the working file exists.
2087
inv = self._inventory
2088
for path, ie in inv.iter_entries():
2089
if osutils.lexists(self.abspath(path)):
2092
@needs_tree_write_lock
2093
def set_last_revision(self, new_revision):
2094
"""Change the last revision in the working tree."""
2095
if self._change_last_revision(new_revision):
2096
self._cache_basis_inventory(new_revision)
2098
def _get_check_refs(self):
2099
"""Return the references needed to perform a check of this tree.
2101
The default implementation returns no refs, and is only suitable for
2102
trees that have no local caching and can commit on ghosts at any time.
2104
:seealso: bzrlib.check for details about check_refs.
2109
def _check(self, references):
2110
"""Check the tree for consistency.
2112
:param references: A dict with keys matching the items returned by
2113
self._get_check_refs(), and values from looking those keys up in
2116
tree_basis = self.basis_tree()
2117
tree_basis.lock_read()
2119
repo_basis = references[('trees', self.last_revision())]
2120
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2121
raise errors.BzrCheckError(
2122
"Mismatched basis inventory content.")
2128
def check_state(self):
2129
"""Check that the working state is/isn't valid."""
2130
check_refs = self._get_check_refs()
2132
for ref in check_refs:
2135
refs[ref] = self.branch.repository.revision_tree(value)
2138
@needs_tree_write_lock
2139
def reset_state(self, revision_ids=None):
2140
"""Reset the state of the working tree.
2142
This does a hard-reset to a last-known-good state. This is a way to
2143
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2145
if revision_ids is None:
2146
revision_ids = self.get_parent_ids()
2147
if not revision_ids:
2148
rt = self.branch.repository.revision_tree(
2149
_mod_revision.NULL_REVISION)
2151
rt = self.branch.repository.revision_tree(revision_ids[0])
2152
self._write_inventory(rt.inventory)
2153
self.set_parent_ids(revision_ids)
2156
"""Write the in memory inventory to disk."""
2157
# TODO: Maybe this should only write on dirty ?
2158
if self._control_files._lock_mode != 'w':
2159
raise errors.NotWriteLocked(self)
2161
self._serialize(self._inventory, sio)
2163
self._transport.put_file('inventory', sio,
2164
mode=self.bzrdir._get_file_mode())
2165
self._inventory_is_modified = False
2168
def get_file_sha1(self, file_id, path=None, stat_value=None):
2170
path = self._inventory.id2path(file_id)
2171
return self._hashcache.get_sha1(path, stat_value)
2173
def get_file_mtime(self, file_id, path=None):
2174
"""See Tree.get_file_mtime."""
2176
path = self.inventory.id2path(file_id)
2177
return os.lstat(self.abspath(path)).st_mtime
2179
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2180
file_id = self.path2id(path)
2182
# For unversioned files on win32, we just assume they are not
2185
return self._inventory[file_id].executable
2187
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2188
mode = stat_result.st_mode
2189
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2191
if not supports_executable():
2192
def is_executable(self, file_id, path=None):
2193
return self._inventory[file_id].executable
2195
_is_executable_from_path_and_stat = \
2196
_is_executable_from_path_and_stat_from_basis
2198
def is_executable(self, file_id, path=None):
2200
path = self.id2path(file_id)
2201
mode = os.lstat(self.abspath(path)).st_mode
2202
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2204
_is_executable_from_path_and_stat = \
2205
_is_executable_from_path_and_stat_from_stat
2207
@needs_tree_write_lock
2208
def _add(self, files, ids, kinds):
2209
"""See MutableTree._add."""
2210
# TODO: Re-adding a file that is removed in the working copy
2211
# should probably put it back with the previous ID.
2212
# the read and write working inventory should not occur in this
2213
# function - they should be part of lock_write and unlock.
2214
inv = self.inventory
2215
for f, file_id, kind in zip(files, ids, kinds):
2217
inv.add_path(f, kind=kind)
2219
inv.add_path(f, kind=kind, file_id=file_id)
2220
self._inventory_is_modified = True
2222
def revision_tree(self, revision_id):
2223
"""See WorkingTree.revision_id."""
2224
if revision_id == self.last_revision():
2226
xml = self.read_basis_inventory()
2227
except errors.NoSuchFile:
2231
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2232
# dont use the repository revision_tree api because we want
2233
# to supply the inventory.
2234
if inv.revision_id == revision_id:
2235
return revisiontree.InventoryRevisionTree(
2236
self.branch.repository, inv, revision_id)
2237
except errors.BadInventoryFormat:
2239
# raise if there was no inventory, or if we read the wrong inventory.
2240
raise errors.NoSuchRevisionInTree(self, revision_id)
2243
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2244
"""See Tree.annotate_iter
2246
This implementation will use the basis tree implementation if possible.
2247
Lines not in the basis are attributed to CURRENT_REVISION
2249
If there are pending merges, lines added by those merges will be
2250
incorrectly attributed to CURRENT_REVISION (but after committing, the
2251
attribution will be correct).
2253
maybe_file_parent_keys = []
2254
for parent_id in self.get_parent_ids():
2256
parent_tree = self.revision_tree(parent_id)
2257
except errors.NoSuchRevisionInTree:
2258
parent_tree = self.branch.repository.revision_tree(parent_id)
2259
parent_tree.lock_read()
2261
if not parent_tree.has_id(file_id):
2263
ie = parent_tree.inventory[file_id]
2264
if ie.kind != 'file':
2265
# Note: this is slightly unnecessary, because symlinks and
2266
# directories have a "text" which is the empty text, and we
2267
# know that won't mess up annotations. But it seems cleaner
2269
parent_text_key = (file_id, ie.revision)
2270
if parent_text_key not in maybe_file_parent_keys:
2271
maybe_file_parent_keys.append(parent_text_key)
2273
parent_tree.unlock()
2274
graph = _mod_graph.Graph(self.branch.repository.texts)
2275
heads = graph.heads(maybe_file_parent_keys)
2276
file_parent_keys = []
2277
for key in maybe_file_parent_keys:
2279
file_parent_keys.append(key)
2281
# Now we have the parents of this content
2282
annotator = self.branch.repository.texts.get_annotator()
2283
text = self.get_file_text(file_id)
2284
this_key =(file_id, default_revision)
2285
annotator.add_special_text(this_key, file_parent_keys, text)
2286
annotations = [(key[-1], line)
2287
for key, line in annotator.annotate_flat(this_key)]
2291
def merge_modified(self):
2292
"""Return a dictionary of files modified by a merge.
2294
The list is initialized by WorkingTree.set_merge_modified, which is
2295
typically called after we make some automatic updates to the tree
2298
This returns a map of file_id->sha1, containing only files which are
2299
still in the working inventory and have that text hash.
2302
hashfile = self._transport.get('merge-hashes')
2303
except errors.NoSuchFile:
2308
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2309
raise errors.MergeModifiedFormatError()
2310
except StopIteration:
2311
raise errors.MergeModifiedFormatError()
2312
for s in _mod_rio.RioReader(hashfile):
2313
# RioReader reads in Unicode, so convert file_ids back to utf8
2314
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2315
if not self.inventory.has_id(file_id):
2317
text_hash = s.get("hash")
2318
if text_hash == self.get_file_sha1(file_id):
2319
merge_hashes[file_id] = text_hash
2325
def subsume(self, other_tree):
2326
def add_children(inventory, entry):
2327
for child_entry in entry.children.values():
2328
inventory._byid[child_entry.file_id] = child_entry
2329
if child_entry.kind == 'directory':
2330
add_children(inventory, child_entry)
2331
if other_tree.get_root_id() == self.get_root_id():
2332
raise errors.BadSubsumeSource(self, other_tree,
2333
'Trees have the same root')
2335
other_tree_path = self.relpath(other_tree.basedir)
2336
except errors.PathNotChild:
2337
raise errors.BadSubsumeSource(self, other_tree,
2338
'Tree is not contained by the other')
2339
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2340
if new_root_parent is None:
2341
raise errors.BadSubsumeSource(self, other_tree,
2342
'Parent directory is not versioned.')
2343
# We need to ensure that the result of a fetch will have a
2344
# versionedfile for the other_tree root, and only fetching into
2345
# RepositoryKnit2 guarantees that.
2346
if not self.branch.repository.supports_rich_root():
2347
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2348
other_tree.lock_tree_write()
2350
new_parents = other_tree.get_parent_ids()
2351
other_root = other_tree.inventory.root
2352
other_root.parent_id = new_root_parent
2353
other_root.name = osutils.basename(other_tree_path)
2354
self.inventory.add(other_root)
2355
add_children(self.inventory, other_root)
2356
self._write_inventory(self.inventory)
2357
# normally we don't want to fetch whole repositories, but i think
2358
# here we really do want to consolidate the whole thing.
2359
for parent_id in other_tree.get_parent_ids():
2360
self.branch.fetch(other_tree.branch, parent_id)
2361
self.add_parent_tree_id(parent_id)
2364
other_tree.bzrdir.retire_bzrdir()
2366
@needs_tree_write_lock
2367
def extract(self, file_id, format=None):
2368
"""Extract a subtree from this tree.
2370
A new branch will be created, relative to the path for this tree.
2374
segments = osutils.splitpath(path)
2375
transport = self.branch.bzrdir.root_transport
2376
for name in segments:
2377
transport = transport.clone(name)
2378
transport.ensure_base()
2381
sub_path = self.id2path(file_id)
2382
branch_transport = mkdirs(sub_path)
2384
format = self.bzrdir.cloning_metadir()
2385
branch_transport.ensure_base()
2386
branch_bzrdir = format.initialize_on_transport(branch_transport)
2388
repo = branch_bzrdir.find_repository()
2389
except errors.NoRepositoryPresent:
2390
repo = branch_bzrdir.create_repository()
2391
if not repo.supports_rich_root():
2392
raise errors.RootNotRich()
2393
new_branch = branch_bzrdir.create_branch()
2394
new_branch.pull(self.branch)
2395
for parent_id in self.get_parent_ids():
2396
new_branch.fetch(self.branch, parent_id)
2397
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2398
if tree_transport.base != branch_transport.base:
2399
tree_bzrdir = format.initialize_on_transport(tree_transport)
2400
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2401
target_branch=new_branch)
2403
tree_bzrdir = branch_bzrdir
2404
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2405
wt.set_parent_ids(self.get_parent_ids())
2406
my_inv = self.inventory
2407
child_inv = inventory.Inventory(root_id=None)
2408
new_root = my_inv[file_id]
2409
my_inv.remove_recursive_id(file_id)
2410
new_root.parent_id = None
2411
child_inv.add(new_root)
2412
self._write_inventory(my_inv)
2413
wt._write_inventory(child_inv)
2416
def list_files(self, include_root=False, from_dir=None, recursive=True):
2417
"""List all files as (path, class, kind, id, entry).
2419
Lists, but does not descend into unversioned directories.
2420
This does not include files that have been deleted in this
2421
tree. Skips the control directory.
2423
:param include_root: if True, return an entry for the root
2424
:param from_dir: start from this directory or None for the root
2425
:param recursive: whether to recurse into subdirectories or not
2427
# list_files is an iterator, so @needs_read_lock doesn't work properly
2428
# with it. So callers should be careful to always read_lock the tree.
2429
if not self.is_locked():
2430
raise errors.ObjectNotLocked(self)
2432
inv = self.inventory
2433
if from_dir is None and include_root is True:
2434
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2435
# Convert these into local objects to save lookup times
2436
pathjoin = osutils.pathjoin
2437
file_kind = self._kind
2439
# transport.base ends in a slash, we want the piece
2440
# between the last two slashes
2441
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2443
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2445
# directory file_id, relative path, absolute path, reverse sorted children
2446
if from_dir is not None:
2447
from_dir_id = inv.path2id(from_dir)
2448
if from_dir_id is None:
2449
# Directory not versioned
2451
from_dir_abspath = pathjoin(self.basedir, from_dir)
2453
from_dir_id = inv.root.file_id
2454
from_dir_abspath = self.basedir
2455
children = os.listdir(from_dir_abspath)
2457
# jam 20060527 The kernel sized tree seems equivalent whether we
2458
# use a deque and popleft to keep them sorted, or if we use a plain
2459
# list and just reverse() them.
2460
children = collections.deque(children)
2461
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2463
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2466
f = children.popleft()
2467
## TODO: If we find a subdirectory with its own .bzr
2468
## directory, then that is a separate tree and we
2469
## should exclude it.
2471
# the bzrdir for this tree
2472
if transport_base_dir == f:
2475
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2476
# and 'f' doesn't begin with one, we can do a string op, rather
2477
# than the checks of pathjoin(), all relative paths will have an extra slash
2479
fp = from_dir_relpath + '/' + f
2482
fap = from_dir_abspath + '/' + f
2484
dir_ie = inv[from_dir_id]
2485
if dir_ie.kind == 'directory':
2486
f_ie = dir_ie.children.get(f)
2491
elif self.is_ignored(fp[1:]):
2494
# we may not have found this file, because of a unicode
2495
# issue, or because the directory was actually a symlink.
2496
f_norm, can_access = osutils.normalized_filename(f)
2497
if f == f_norm or not can_access:
2498
# No change, so treat this file normally
2501
# this file can be accessed by a normalized path
2502
# check again if it is versioned
2503
# these lines are repeated here for performance
2505
fp = from_dir_relpath + '/' + f
2506
fap = from_dir_abspath + '/' + f
2507
f_ie = inv.get_child(from_dir_id, f)
2510
elif self.is_ignored(fp[1:]):
2517
# make a last minute entry
2519
yield fp[1:], c, fk, f_ie.file_id, f_ie
2522
yield fp[1:], c, fk, None, fk_entries[fk]()
2524
yield fp[1:], c, fk, None, TreeEntry()
2527
if fk != 'directory':
2530
# But do this child first if recursing down
2532
new_children = os.listdir(fap)
2534
new_children = collections.deque(new_children)
2535
stack.append((f_ie.file_id, fp, fap, new_children))
2536
# Break out of inner loop,
2537
# so that we start outer loop with child
2540
# if we finished all children, pop it off the stack
2543
@needs_tree_write_lock
2544
def move(self, from_paths, to_dir=None, after=False):
2547
to_dir must exist in the inventory.
2549
If to_dir exists and is a directory, the files are moved into
2550
it, keeping their old names.
2552
Note that to_dir is only the last component of the new name;
2553
this doesn't change the directory.
2555
For each entry in from_paths the move mode will be determined
2558
The first mode moves the file in the filesystem and updates the
2559
inventory. The second mode only updates the inventory without
2560
touching the file on the filesystem.
2562
move uses the second mode if 'after == True' and the target is
2563
either not versioned or newly added, and present in the working tree.
2565
move uses the second mode if 'after == False' and the source is
2566
versioned but no longer in the working tree, and the target is not
2567
versioned but present in the working tree.
2569
move uses the first mode if 'after == False' and the source is
2570
versioned and present in the working tree, and the target is not
2571
versioned and not present in the working tree.
2573
Everything else results in an error.
2575
This returns a list of (from_path, to_path) pairs for each
2576
entry that is moved.
2581
# check for deprecated use of signature
2583
raise TypeError('You must supply a target directory')
2584
# check destination directory
2585
if isinstance(from_paths, basestring):
2587
inv = self.inventory
2588
to_abs = self.abspath(to_dir)
2589
if not isdir(to_abs):
2590
raise errors.BzrMoveFailedError('',to_dir,
2591
errors.NotADirectory(to_abs))
2592
if not self.has_filename(to_dir):
2593
raise errors.BzrMoveFailedError('',to_dir,
2594
errors.NotInWorkingDirectory(to_dir))
2595
to_dir_id = inv.path2id(to_dir)
2596
if to_dir_id is None:
2597
raise errors.BzrMoveFailedError('',to_dir,
2598
errors.NotVersionedError(path=to_dir))
2600
to_dir_ie = inv[to_dir_id]
2601
if to_dir_ie.kind != 'directory':
2602
raise errors.BzrMoveFailedError('',to_dir,
2603
errors.NotADirectory(to_abs))
2605
# create rename entries and tuples
2606
for from_rel in from_paths:
2607
from_tail = splitpath(from_rel)[-1]
2608
from_id = inv.path2id(from_rel)
2610
raise errors.BzrMoveFailedError(from_rel,to_dir,
2611
errors.NotVersionedError(path=from_rel))
2613
from_entry = inv[from_id]
2614
from_parent_id = from_entry.parent_id
2615
to_rel = pathjoin(to_dir, from_tail)
2616
rename_entry = InventoryWorkingTree._RenameEntry(
2619
from_tail=from_tail,
2620
from_parent_id=from_parent_id,
2621
to_rel=to_rel, to_tail=from_tail,
2622
to_parent_id=to_dir_id)
2623
rename_entries.append(rename_entry)
2624
rename_tuples.append((from_rel, to_rel))
2626
# determine which move mode to use. checks also for movability
2627
rename_entries = self._determine_mv_mode(rename_entries, after)
2629
original_modified = self._inventory_is_modified
2632
self._inventory_is_modified = True
2633
self._move(rename_entries)
2635
# restore the inventory on error
2636
self._inventory_is_modified = original_modified
2638
self._write_inventory(inv)
2639
return rename_tuples
2641
@needs_tree_write_lock
2642
def rename_one(self, from_rel, to_rel, after=False):
2645
This can change the directory or the filename or both.
2647
rename_one has several 'modes' to work. First, it can rename a physical
2648
file and change the file_id. That is the normal mode. Second, it can
2649
only change the file_id without touching any physical file.
2651
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2652
versioned but present in the working tree.
2654
rename_one uses the second mode if 'after == False' and 'from_rel' is
2655
versioned but no longer in the working tree, and 'to_rel' is not
2656
versioned but present in the working tree.
2658
rename_one uses the first mode if 'after == False' and 'from_rel' is
2659
versioned and present in the working tree, and 'to_rel' is not
2660
versioned and not present in the working tree.
2662
Everything else results in an error.
2664
inv = self.inventory
2667
# create rename entries and tuples
2668
from_tail = splitpath(from_rel)[-1]
2669
from_id = inv.path2id(from_rel)
2671
# if file is missing in the inventory maybe it's in the basis_tree
2672
basis_tree = self.branch.basis_tree()
2673
from_id = basis_tree.path2id(from_rel)
2675
raise errors.BzrRenameFailedError(from_rel,to_rel,
2676
errors.NotVersionedError(path=from_rel))
2677
# put entry back in the inventory so we can rename it
2678
from_entry = basis_tree.inventory[from_id].copy()
2681
from_entry = inv[from_id]
2682
from_parent_id = from_entry.parent_id
2683
to_dir, to_tail = os.path.split(to_rel)
2684
to_dir_id = inv.path2id(to_dir)
2685
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2687
from_tail=from_tail,
2688
from_parent_id=from_parent_id,
2689
to_rel=to_rel, to_tail=to_tail,
2690
to_parent_id=to_dir_id)
2691
rename_entries.append(rename_entry)
2693
# determine which move mode to use. checks also for movability
2694
rename_entries = self._determine_mv_mode(rename_entries, after)
2696
# check if the target changed directory and if the target directory is
2698
if to_dir_id is None:
2699
raise errors.BzrMoveFailedError(from_rel,to_rel,
2700
errors.NotVersionedError(path=to_dir))
2702
# all checks done. now we can continue with our actual work
2703
mutter('rename_one:\n'
2708
' to_dir_id {%s}\n',
2709
from_id, from_rel, to_rel, to_dir, to_dir_id)
2711
self._move(rename_entries)
2712
self._write_inventory(inv)
2714
class _RenameEntry(object):
2715
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2716
to_rel, to_tail, to_parent_id, only_change_inv=False,
2718
self.from_rel = from_rel
2719
self.from_id = from_id
2720
self.from_tail = from_tail
2721
self.from_parent_id = from_parent_id
2722
self.to_rel = to_rel
2723
self.to_tail = to_tail
2724
self.to_parent_id = to_parent_id
2725
self.change_id = change_id
2726
self.only_change_inv = only_change_inv
2728
def _determine_mv_mode(self, rename_entries, after=False):
2729
"""Determines for each from-to pair if both inventory and working tree
2730
or only the inventory has to be changed.
2732
Also does basic plausability tests.
2734
inv = self.inventory
2736
for rename_entry in rename_entries:
2737
# store to local variables for easier reference
2738
from_rel = rename_entry.from_rel
2739
from_id = rename_entry.from_id
2740
to_rel = rename_entry.to_rel
2741
to_id = inv.path2id(to_rel)
2742
only_change_inv = False
2745
# check the inventory for source and destination
2747
raise errors.BzrMoveFailedError(from_rel,to_rel,
2748
errors.NotVersionedError(path=from_rel))
2749
if to_id is not None:
2751
# allow it with --after but only if dest is newly added
2753
basis = self.basis_tree()
2756
if not basis.has_id(to_id):
2757
rename_entry.change_id = True
2762
raise errors.BzrMoveFailedError(from_rel,to_rel,
2763
errors.AlreadyVersionedError(path=to_rel))
2765
# try to determine the mode for rename (only change inv or change
2766
# inv and file system)
2768
if not self.has_filename(to_rel):
2769
raise errors.BzrMoveFailedError(from_id,to_rel,
2770
errors.NoSuchFile(path=to_rel,
2771
extra="New file has not been created yet"))
2772
only_change_inv = True
2773
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2774
only_change_inv = True
2775
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2776
only_change_inv = False
2777
elif (not self.case_sensitive
2778
and from_rel.lower() == to_rel.lower()
2779
and self.has_filename(from_rel)):
2780
only_change_inv = False
2782
# something is wrong, so lets determine what exactly
2783
if not self.has_filename(from_rel) and \
2784
not self.has_filename(to_rel):
2785
raise errors.BzrRenameFailedError(from_rel,to_rel,
2786
errors.PathsDoNotExist(paths=(str(from_rel),
2789
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2790
rename_entry.only_change_inv = only_change_inv
2791
return rename_entries
2793
def _move(self, rename_entries):
2794
"""Moves a list of files.
2796
Depending on the value of the flag 'only_change_inv', the
2797
file will be moved on the file system or not.
2799
inv = self.inventory
2802
for entry in rename_entries:
2804
self._move_entry(entry)
2806
self._rollback_move(moved)
2810
def _rollback_move(self, moved):
2811
"""Try to rollback a previous move in case of an filesystem error."""
2812
inv = self.inventory
2815
self._move_entry(WorkingTree._RenameEntry(
2816
entry.to_rel, entry.from_id,
2817
entry.to_tail, entry.to_parent_id, entry.from_rel,
2818
entry.from_tail, entry.from_parent_id,
2819
entry.only_change_inv))
2820
except errors.BzrMoveFailedError, e:
2821
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2822
" The working tree is in an inconsistent state."
2823
" Please consider doing a 'bzr revert'."
2824
" Error message is: %s" % e)
2826
def _move_entry(self, entry):
2827
inv = self.inventory
2828
from_rel_abs = self.abspath(entry.from_rel)
2829
to_rel_abs = self.abspath(entry.to_rel)
2830
if from_rel_abs == to_rel_abs:
2831
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2832
"Source and target are identical.")
2834
if not entry.only_change_inv:
2836
osutils.rename(from_rel_abs, to_rel_abs)
2838
raise errors.BzrMoveFailedError(entry.from_rel,
2841
to_id = inv.path2id(entry.to_rel)
2842
inv.remove_recursive_id(to_id)
2843
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2845
@needs_tree_write_lock
2846
def unversion(self, file_ids):
2847
"""Remove the file ids in file_ids from the current versioned set.
2849
When a file_id is unversioned, all of its children are automatically
2852
:param file_ids: The file ids to stop versioning.
2853
:raises: NoSuchId if any fileid is not currently versioned.
2855
for file_id in file_ids:
2856
if not self._inventory.has_id(file_id):
2857
raise errors.NoSuchId(self, file_id)
2858
for file_id in file_ids:
2859
if self._inventory.has_id(file_id):
2860
self._inventory.remove_recursive_id(file_id)
2862
# in the future this should just set a dirty bit to wait for the
2863
# final unlock. However, until all methods of workingtree start
2864
# with the current in -memory inventory rather than triggering
2865
# a read, it is more complex - we need to teach read_inventory
2866
# to know when to read, and when to not read first... and possibly
2867
# to save first when the in memory one may be corrupted.
2868
# so for now, we just only write it if it is indeed dirty.
2870
self._write_inventory(self._inventory)
2872
def stored_kind(self, file_id):
2873
"""See Tree.stored_kind"""
2874
return self.inventory[file_id].kind
2877
"""Yield all unversioned files in this WorkingTree.
2879
If there are any unversioned directories then only the directory is
2880
returned, not all its children. But if there are unversioned files
2881
under a versioned subdirectory, they are returned.
2883
Currently returned depth-first, sorted by name within directories.
2884
This is the same order used by 'osutils.walkdirs'.
2886
## TODO: Work from given directory downwards
2887
for path, dir_entry in self.inventory.directories():
2888
# mutter("search for unknowns in %r", path)
2889
dirabs = self.abspath(path)
2890
if not isdir(dirabs):
2891
# e.g. directory deleted
2895
for subf in os.listdir(dirabs):
2896
if self.bzrdir.is_control_filename(subf):
2898
if subf not in dir_entry.children:
2901
can_access) = osutils.normalized_filename(subf)
2902
except UnicodeDecodeError:
2903
path_os_enc = path.encode(osutils._fs_enc)
2904
relpath = path_os_enc + '/' + subf
2905
raise errors.BadFilenameEncoding(relpath,
2907
if subf_norm != subf and can_access:
2908
if subf_norm not in dir_entry.children:
2909
fl.append(subf_norm)
2915
subp = pathjoin(path, subf)
2918
def _walkdirs(self, prefix=""):
2919
"""Walk the directories of this tree.
2921
:param prefix: is used as the directrory to start with.
2922
:returns: a generator which yields items in the form::
2924
((curren_directory_path, fileid),
2925
[(file1_path, file1_name, file1_kind, None, file1_id,
2928
_directory = 'directory'
2929
# get the root in the inventory
2930
inv = self.inventory
2931
top_id = inv.path2id(prefix)
2935
pending = [(prefix, '', _directory, None, top_id, None)]
2938
currentdir = pending.pop()
2939
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2940
top_id = currentdir[4]
2942
relroot = currentdir[0] + '/'
2945
# FIXME: stash the node in pending
2947
if entry.kind == 'directory':
2948
for name, child in entry.sorted_children():
2949
dirblock.append((relroot + name, name, child.kind, None,
2950
child.file_id, child.kind
2952
yield (currentdir[0], entry.file_id), dirblock
2953
# push the user specified dirs from dirblock
2954
for dir in reversed(dirblock):
2955
if dir[2] == _directory:
2959
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2960
"""Registry for working tree formats."""
2962
def __init__(self, other_registry=None):
2963
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2964
self._default_format = None
2965
self._default_format_key = None
2967
def get_default(self):
2968
"""Return the current default format."""
2969
if (self._default_format_key is not None and
2970
self._default_format is None):
2971
self._default_format = self.get(self._default_format_key)
2972
return self._default_format
2974
def set_default(self, format):
2975
"""Set the default format."""
2976
self._default_format = format
2977
self._default_format_key = None
2979
def set_default_key(self, format_string):
2980
"""Set the default format by its format string."""
2981
self._default_format_key = format_string
2982
self._default_format = None
2985
format_registry = WorkingTreeFormatRegistry()
2988
class WorkingTreeFormat(controldir.ControlComponentFormat):
2658
# do non-implementation specific cleanup
2660
if self._control_files._lock_count == 1:
2661
# _inventory_is_modified is always False during a read lock.
2662
if self._inventory_is_modified:
2664
self._write_hashcache_if_dirty()
2665
# reverse order of locking.
2667
return self._control_files.unlock()
2669
self.branch.unlock()
2672
def get_conflicted_stem(path):
2673
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2674
if path.endswith(suffix):
2675
return path[:-len(suffix)]
2678
class WorkingTreeFormat(object):
2989
2679
"""An encapsulation of the initialization and open routines for a format.
2991
2681
Formats provide three things:
3094
@symbol_versioning.deprecated_method(
3095
symbol_versioning.deprecated_in((2, 4, 0)))
3096
2756
def register_format(klass, format):
3097
format_registry.register(format)
3100
@symbol_versioning.deprecated_method(
3101
symbol_versioning.deprecated_in((2, 4, 0)))
3102
def register_extra_format(klass, format):
3103
format_registry.register_extra(format)
3106
@symbol_versioning.deprecated_method(
3107
symbol_versioning.deprecated_in((2, 4, 0)))
3108
def unregister_extra_format(klass, format):
3109
format_registry.unregister_extra(format)
3112
@symbol_versioning.deprecated_method(
3113
symbol_versioning.deprecated_in((2, 4, 0)))
3114
def get_formats(klass):
3115
return format_registry._get_all()
3118
@symbol_versioning.deprecated_method(
3119
symbol_versioning.deprecated_in((2, 4, 0)))
2757
klass._formats[format.get_format_string()] = format
3120
2760
def set_default_format(klass, format):
3121
format_registry.set_default(format)
2761
klass._default_format = format
3124
@symbol_versioning.deprecated_method(
3125
symbol_versioning.deprecated_in((2, 4, 0)))
3126
2764
def unregister_format(klass, format):
3127
format_registry.remove(format)
3130
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3131
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3132
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3133
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3134
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3135
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3136
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3137
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3138
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
2765
del klass._formats[format.get_format_string()]
2768
class WorkingTreeFormat2(WorkingTreeFormat):
2769
"""The second working tree format.
2771
This format modified the hash cache from the format 1 hash cache.
2774
upgrade_recommended = True
2776
def get_format_description(self):
2777
"""See WorkingTreeFormat.get_format_description()."""
2778
return "Working tree format 2"
2780
def _stub_initialize_on_transport(self, transport, file_mode):
2781
"""Workaround: create control files for a remote working tree.
2783
This ensures that it can later be updated and dealt with locally,
2784
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2785
no working tree. (See bug #43064).
2789
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2791
transport.put_file('inventory', sio, file_mode)
2792
transport.put_bytes('pending-merges', '', file_mode)
2794
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2795
accelerator_tree=None, hardlink=False):
2796
"""See WorkingTreeFormat.initialize()."""
2797
if not isinstance(a_bzrdir.transport, LocalTransport):
2798
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2799
if from_branch is not None:
2800
branch = from_branch
2802
branch = a_bzrdir.open_branch()
2803
if revision_id is None:
2804
revision_id = _mod_revision.ensure_null(branch.last_revision())
2807
branch.generate_revision_history(revision_id)
2811
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2817
basis_tree = branch.repository.revision_tree(revision_id)
2818
if basis_tree.inventory.root is not None:
2819
wt.set_root_id(basis_tree.get_root_id())
2820
# set the parent list and cache the basis tree.
2821
if _mod_revision.is_null(revision_id):
2824
parent_trees = [(revision_id, basis_tree)]
2825
wt.set_parent_trees(parent_trees)
2826
transform.build_tree(basis_tree, wt)
2830
super(WorkingTreeFormat2, self).__init__()
2831
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2833
def open(self, a_bzrdir, _found=False):
2834
"""Return the WorkingTree object for a_bzrdir
2836
_found is a private parameter, do not use it. It is used to indicate
2837
if format probing has already been done.
2840
# we are being called directly and must probe.
2841
raise NotImplementedError
2842
if not isinstance(a_bzrdir.transport, LocalTransport):
2843
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2844
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2850
class WorkingTreeFormat3(WorkingTreeFormat):
2851
"""The second working tree format updated to record a format marker.
2854
- exists within a metadir controlling .bzr
2855
- includes an explicit version marker for the workingtree control
2856
files, separate from the BzrDir format
2857
- modifies the hash cache format
2859
- uses a LockDir to guard access for writes.
2862
upgrade_recommended = True
2864
def get_format_string(self):
2865
"""See WorkingTreeFormat.get_format_string()."""
2866
return "Bazaar-NG Working Tree format 3"
2868
def get_format_description(self):
2869
"""See WorkingTreeFormat.get_format_description()."""
2870
return "Working tree format 3"
2872
_lock_file_name = 'lock'
2873
_lock_class = LockDir
2875
_tree_class = WorkingTree3
2877
def __get_matchingbzrdir(self):
2878
return bzrdir.BzrDirMetaFormat1()
2880
_matchingbzrdir = property(__get_matchingbzrdir)
2882
def _open_control_files(self, a_bzrdir):
2883
transport = a_bzrdir.get_workingtree_transport(None)
2884
return LockableFiles(transport, self._lock_file_name,
2887
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2888
accelerator_tree=None, hardlink=False):
2889
"""See WorkingTreeFormat.initialize().
2891
:param revision_id: if supplied, create a working tree at a different
2892
revision than the branch is at.
2893
:param accelerator_tree: A tree which can be used for retrieving file
2894
contents more quickly than the revision tree, i.e. a workingtree.
2895
The revision tree will be used for cases where accelerator_tree's
2896
content is different.
2897
:param hardlink: If true, hard-link files from accelerator_tree,
2900
if not isinstance(a_bzrdir.transport, LocalTransport):
2901
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2902
transport = a_bzrdir.get_workingtree_transport(self)
2903
control_files = self._open_control_files(a_bzrdir)
2904
control_files.create_lock()
2905
control_files.lock_write()
2906
transport.put_bytes('format', self.get_format_string(),
2907
mode=a_bzrdir._get_file_mode())
2908
if from_branch is not None:
2909
branch = from_branch
2911
branch = a_bzrdir.open_branch()
2912
if revision_id is None:
2913
revision_id = _mod_revision.ensure_null(branch.last_revision())
2914
# WorkingTree3 can handle an inventory which has a unique root id.
2915
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2916
# those trees. And because there isn't a format bump inbetween, we
2917
# are maintaining compatibility with older clients.
2918
# inv = Inventory(root_id=gen_root_id())
2919
inv = self._initial_inventory()
2920
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2926
_control_files=control_files)
2927
wt.lock_tree_write()
2929
basis_tree = branch.repository.revision_tree(revision_id)
2930
# only set an explicit root id if there is one to set.
2931
if basis_tree.inventory.root is not None:
2932
wt.set_root_id(basis_tree.get_root_id())
2933
if revision_id == NULL_REVISION:
2934
wt.set_parent_trees([])
2936
wt.set_parent_trees([(revision_id, basis_tree)])
2937
transform.build_tree(basis_tree, wt)
2939
# Unlock in this order so that the unlock-triggers-flush in
2940
# WorkingTree is given a chance to fire.
2941
control_files.unlock()
2945
def _initial_inventory(self):
2949
super(WorkingTreeFormat3, self).__init__()
2951
def open(self, a_bzrdir, _found=False):
2952
"""Return the WorkingTree object for a_bzrdir
2954
_found is a private parameter, do not use it. It is used to indicate
2955
if format probing has already been done.
2958
# we are being called directly and must probe.
2959
raise NotImplementedError
2960
if not isinstance(a_bzrdir.transport, LocalTransport):
2961
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2962
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2965
def _open(self, a_bzrdir, control_files):
2966
"""Open the tree itself.
2968
:param a_bzrdir: the dir for the tree.
2969
:param control_files: the control files for the tree.
2971
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2975
_control_files=control_files)
2978
return self.get_format_string()
2981
__default_format = WorkingTreeFormat4()
2982
WorkingTreeFormat.register_format(__default_format)
2983
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2984
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2985
WorkingTreeFormat.set_default_format(__default_format)
2986
# formats which have no format string are not discoverable
2987
# and not independently creatable, so are not registered.
2988
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
