1004
889
# checkout in a subdirectory. This can be avoided by not adding
1005
890
# it. mbp 20070306
1007
@needs_tree_write_lock
1008
892
def extract(self, file_id, format=None):
1009
893
"""Extract a subtree from this tree.
1011
895
A new branch will be created, relative to the path for this tree.
1015
segments = osutils.splitpath(path)
1016
transport = self.branch.bzrdir.root_transport
1017
for name in segments:
1018
transport = transport.clone(name)
1019
transport.ensure_base()
1022
sub_path = self.id2path(file_id)
1023
branch_transport = mkdirs(sub_path)
1025
format = self.bzrdir.cloning_metadir()
1026
branch_transport.ensure_base()
1027
branch_bzrdir = format.initialize_on_transport(branch_transport)
1029
repo = branch_bzrdir.find_repository()
1030
except errors.NoRepositoryPresent:
1031
repo = branch_bzrdir.create_repository()
1032
if not repo.supports_rich_root():
1033
raise errors.RootNotRich()
1034
new_branch = branch_bzrdir.create_branch()
1035
new_branch.pull(self.branch)
1036
for parent_id in self.get_parent_ids():
1037
new_branch.fetch(self.branch, parent_id)
1038
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1039
if tree_transport.base != branch_transport.base:
1040
tree_bzrdir = format.initialize_on_transport(tree_transport)
1041
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1043
tree_bzrdir = branch_bzrdir
1044
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1045
wt.set_parent_ids(self.get_parent_ids())
1046
my_inv = self.inventory
1047
child_inv = Inventory(root_id=None)
1048
new_root = my_inv[file_id]
1049
my_inv.remove_recursive_id(file_id)
1050
new_root.parent_id = None
1051
child_inv.add(new_root)
1052
self._write_inventory(my_inv)
1053
wt._write_inventory(child_inv)
1056
def _serialize(self, inventory, out_file):
1057
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1060
def _deserialize(selt, in_file):
1061
return xml5.serializer_v5.read_inventory(in_file)
897
raise NotImplementedError(self.extract)
1063
899
def flush(self):
1064
"""Write the in memory inventory to disk."""
1065
# TODO: Maybe this should only write on dirty ?
1066
if self._control_files._lock_mode != 'w':
1067
raise errors.NotWriteLocked(self)
1069
self._serialize(self._inventory, sio)
1071
self._transport.put_file('inventory', sio,
1072
mode=self._control_files._file_mode)
1073
self._inventory_is_modified = False
900
"""Write the in memory meta data to disk."""
901
raise NotImplementedError(self.flush)
1075
903
def _kind(self, relpath):
1076
904
return osutils.file_kind(self.abspath(relpath))
1078
def list_files(self, include_root=False):
1079
"""Recursively list all files as (path, class, kind, id, entry).
906
def list_files(self, include_root=False, from_dir=None, recursive=True):
907
"""List all files as (path, class, kind, id, entry).
1081
909
Lists, but does not descend into unversioned directories.
1083
910
This does not include files that have been deleted in this
911
tree. Skips the control directory.
1086
Skips the control directory.
913
:param include_root: if True, return an entry for the root
914
:param from_dir: start from this directory or None for the root
915
:param recursive: whether to recurse into subdirectories or not
1088
# list_files is an iterator, so @needs_read_lock doesn't work properly
1089
# with it. So callers should be careful to always read_lock the tree.
1090
if not self.is_locked():
1091
raise errors.ObjectNotLocked(self)
1093
inv = self.inventory
1094
if include_root is True:
1095
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1096
# Convert these into local objects to save lookup times
1097
pathjoin = osutils.pathjoin
1098
file_kind = self._kind
1100
# transport.base ends in a slash, we want the piece
1101
# between the last two slashes
1102
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1104
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1106
# directory file_id, relative path, absolute path, reverse sorted children
1107
children = os.listdir(self.basedir)
1109
# jam 20060527 The kernel sized tree seems equivalent whether we
1110
# use a deque and popleft to keep them sorted, or if we use a plain
1111
# list and just reverse() them.
1112
children = collections.deque(children)
1113
stack = [(inv.root.file_id, u'', self.basedir, children)]
1115
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1118
f = children.popleft()
1119
## TODO: If we find a subdirectory with its own .bzr
1120
## directory, then that is a separate tree and we
1121
## should exclude it.
1123
# the bzrdir for this tree
1124
if transport_base_dir == f:
1127
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1128
# and 'f' doesn't begin with one, we can do a string op, rather
1129
# than the checks of pathjoin(), all relative paths will have an extra slash
1131
fp = from_dir_relpath + '/' + f
1134
fap = from_dir_abspath + '/' + f
1136
f_ie = inv.get_child(from_dir_id, f)
1139
elif self.is_ignored(fp[1:]):
1142
# we may not have found this file, because of a unicode issue
1143
f_norm, can_access = osutils.normalized_filename(f)
1144
if f == f_norm or not can_access:
1145
# No change, so treat this file normally
1148
# this file can be accessed by a normalized path
1149
# check again if it is versioned
1150
# these lines are repeated here for performance
1152
fp = from_dir_relpath + '/' + f
1153
fap = from_dir_abspath + '/' + f
1154
f_ie = inv.get_child(from_dir_id, f)
1157
elif self.is_ignored(fp[1:]):
1164
# make a last minute entry
1166
yield fp[1:], c, fk, f_ie.file_id, f_ie
1169
yield fp[1:], c, fk, None, fk_entries[fk]()
1171
yield fp[1:], c, fk, None, TreeEntry()
1174
if fk != 'directory':
1177
# But do this child first
1178
new_children = os.listdir(fap)
1180
new_children = collections.deque(new_children)
1181
stack.append((f_ie.file_id, fp, fap, new_children))
1182
# Break out of inner loop,
1183
# so that we start outer loop with child
1186
# if we finished all children, pop it off the stack
1189
@needs_tree_write_lock
1190
def move(self, from_paths, to_dir=None, after=False, **kwargs):
917
raise NotImplementedError(self.list_files)
919
def move(self, from_paths, to_dir=None, after=False):
1191
920
"""Rename files.
1193
to_dir must exist in the inventory.
922
to_dir must be known to the working tree.
1195
924
If to_dir exists and is a directory, the files are moved into
1196
it, keeping their old names.
925
it, keeping their old names.
1198
927
Note that to_dir is only the last component of the new name;
1199
928
this doesn't change the directory.
2504
1795
self)._get_rules_searcher(default_searcher)
2505
1796
return self._rules_searcher
2508
class WorkingTree2(WorkingTree):
2509
"""This is the Format 2 working tree.
2511
This was the first weave based working tree.
2512
- uses os locks for locking.
2513
- uses the branch last-revision.
1798
def get_shelf_manager(self):
1799
"""Return the ShelfManager for this WorkingTree."""
1800
from bzrlib.shelf import ShelfManager
1801
return ShelfManager(self, self._transport)
1804
class InventoryWorkingTree(WorkingTree,
1805
bzrlib.mutabletree.MutableInventoryTree):
1806
"""Base class for working trees that are inventory-oriented.
1808
The inventory is held in the `Branch` working-inventory, and the
1809
files are in a directory on disk.
1811
It is possible for a `WorkingTree` to have a filename which is
1812
not listed in the Inventory and vice versa.
2516
def __init__(self, *args, **kwargs):
2517
super(WorkingTree2, self).__init__(*args, **kwargs)
2518
# WorkingTree2 has more of a constraint that self._inventory must
2519
# exist. Because this is an older format, we don't mind the overhead
2520
# caused by the extra computation here.
2522
# Newer WorkingTree's should only have self._inventory set when they
2524
if self._inventory is None:
2525
self.read_working_inventory()
2527
def lock_tree_write(self):
2528
"""See WorkingTree.lock_tree_write().
2530
In Format2 WorkingTrees we have a single lock for the branch and tree
2531
so lock_tree_write() degrades to lock_write().
2533
self.branch.lock_write()
2535
return self._control_files.lock_write()
2537
self.branch.unlock()
2541
# do non-implementation specific cleanup
2544
# we share control files:
2545
if self._control_files._lock_count == 3:
2546
# _inventory_is_modified is always False during a read lock.
2547
if self._inventory_is_modified:
2549
self._write_hashcache_if_dirty()
2551
# reverse order of locking.
2553
return self._control_files.unlock()
1815
def __init__(self, basedir='.',
1816
branch=DEPRECATED_PARAMETER,
1818
_control_files=None,
1822
"""Construct a InventoryWorkingTree instance. This is not a public API.
1824
:param branch: A branch to override probing for the branch.
1826
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1827
branch=branch, _control_files=_control_files, _internal=_internal,
1828
_format=_format, _bzrdir=_bzrdir)
1830
if _inventory is None:
1831
# This will be acquired on lock_read() or lock_write()
1832
self._inventory_is_modified = False
1833
self._inventory = None
1835
# the caller of __init__ has provided an inventory,
1836
# we assume they know what they are doing - as its only
1837
# the Format factory and creation methods that are
1838
# permitted to do this.
1839
self._set_inventory(_inventory, dirty=False)
1841
def _set_inventory(self, inv, dirty):
1842
"""Set the internal cached inventory.
1844
:param inv: The inventory to set.
1845
:param dirty: A boolean indicating whether the inventory is the same
1846
logical inventory as whats on disk. If True the inventory is not
1847
the same and should be written to disk or data will be lost, if
1848
False then the inventory is the same as that on disk and any
1849
serialisation would be unneeded overhead.
1851
self._inventory = inv
1852
self._inventory_is_modified = dirty
1854
def _serialize(self, inventory, out_file):
1855
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1858
def _deserialize(selt, in_file):
1859
return xml5.serializer_v5.read_inventory(in_file)
1861
@needs_tree_write_lock
1862
def _write_inventory(self, inv):
1863
"""Write inventory as the current inventory."""
1864
self._set_inventory(inv, dirty=True)
1867
# XXX: This method should be deprecated in favour of taking in a proper
1868
# new Inventory object.
1869
@needs_tree_write_lock
1870
def set_inventory(self, new_inventory_list):
1871
from bzrlib.inventory import (Inventory,
1875
inv = Inventory(self.get_root_id())
1876
for path, file_id, parent, kind in new_inventory_list:
1877
name = os.path.basename(path)
1880
# fixme, there should be a factory function inv,add_??
1881
if kind == 'directory':
1882
inv.add(InventoryDirectory(file_id, name, parent))
1883
elif kind == 'file':
1884
inv.add(InventoryFile(file_id, name, parent))
1885
elif kind == 'symlink':
1886
inv.add(InventoryLink(file_id, name, parent))
1888
raise errors.BzrError("unknown kind %r" % kind)
1889
self._write_inventory(inv)
1891
def _write_basis_inventory(self, xml):
1892
"""Write the basis inventory XML to the basis-inventory file"""
1893
path = self._basis_inventory_name()
1895
self._transport.put_file(path, sio,
1896
mode=self.bzrdir._get_file_mode())
1898
def _reset_data(self):
1899
"""Reset transient data that cannot be revalidated."""
1900
self._inventory_is_modified = False
1901
f = self._transport.get('inventory')
1903
result = self._deserialize(f)
2555
self.branch.unlock()
2558
class WorkingTree3(WorkingTree):
2559
"""This is the Format 3 working tree.
2561
This differs from the base WorkingTree by:
2562
- having its own file lock
2563
- having its own last-revision property.
2565
This is new in bzr 0.8
2569
def _last_revision(self):
2570
"""See Mutable.last_revision."""
1906
self._set_inventory(result, dirty=False)
1908
def _set_root_id(self, file_id):
1909
"""Set the root id for this tree, in a format specific manner.
1911
:param file_id: The file id to assign to the root. It must not be
1912
present in the current inventory or an error will occur. It must
1913
not be None, but rather a valid file id.
1915
inv = self._inventory
1916
orig_root_id = inv.root.file_id
1917
# TODO: it might be nice to exit early if there was nothing
1918
# to do, saving us from trigger a sync on unlock.
1919
self._inventory_is_modified = True
1920
# we preserve the root inventory entry object, but
1921
# unlinkit from the byid index
1922
del inv._byid[inv.root.file_id]
1923
inv.root.file_id = file_id
1924
# and link it into the index with the new changed id.
1925
inv._byid[inv.root.file_id] = inv.root
1926
# and finally update all children to reference the new id.
1927
# XXX: this should be safe to just look at the root.children
1928
# list, not the WHOLE INVENTORY.
1931
if entry.parent_id == orig_root_id:
1932
entry.parent_id = inv.root.file_id
1934
def all_file_ids(self):
1935
"""See Tree.iter_all_file_ids"""
1936
return set(self.inventory)
1938
@needs_tree_write_lock
1939
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1940
"""See MutableTree.set_parent_trees."""
1941
parent_ids = [rev for (rev, tree) in parents_list]
1942
for revision_id in parent_ids:
1943
_mod_revision.check_not_reserved_id(revision_id)
1945
self._check_parents_for_ghosts(parent_ids,
1946
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1948
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1950
if len(parent_ids) == 0:
1951
leftmost_parent_id = _mod_revision.NULL_REVISION
1952
leftmost_parent_tree = None
1954
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1956
if self._change_last_revision(leftmost_parent_id):
1957
if leftmost_parent_tree is None:
1958
# If we don't have a tree, fall back to reading the
1959
# parent tree from the repository.
1960
self._cache_basis_inventory(leftmost_parent_id)
1962
inv = leftmost_parent_tree.inventory
1963
xml = self._create_basis_xml_from_inventory(
1964
leftmost_parent_id, inv)
1965
self._write_basis_inventory(xml)
1966
self._set_merges_from_parent_ids(parent_ids)
1968
def _cache_basis_inventory(self, new_revision):
1969
"""Cache new_revision as the basis inventory."""
1970
# TODO: this should allow the ready-to-use inventory to be passed in,
1971
# as commit already has that ready-to-use [while the format is the
2572
return self._transport.get_bytes('last-revision')
2573
except errors.NoSuchFile:
2574
return _mod_revision.NULL_REVISION
2576
def _change_last_revision(self, revision_id):
2577
"""See WorkingTree._change_last_revision."""
2578
if revision_id is None or revision_id == NULL_REVISION:
2580
self._transport.delete('last-revision')
2581
except errors.NoSuchFile:
2585
self._transport.put_bytes('last-revision', revision_id,
2586
mode=self._control_files._file_mode)
1974
# this double handles the inventory - unpack and repack -
1975
# but is easier to understand. We can/should put a conditional
1976
# in here based on whether the inventory is in the latest format
1977
# - perhaps we should repack all inventories on a repository
1979
# the fast path is to copy the raw xml from the repository. If the
1980
# xml contains 'revision_id="', then we assume the right
1981
# revision_id is set. We must check for this full string, because a
1982
# root node id can legitimately look like 'revision_id' but cannot
1984
xml = self.branch.repository._get_inventory_xml(new_revision)
1985
firstline = xml.split('\n', 1)[0]
1986
if (not 'revision_id="' in firstline or
1987
'format="7"' not in firstline):
1988
inv = self.branch.repository._serializer.read_inventory_from_string(
1990
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1991
self._write_basis_inventory(xml)
1992
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1995
def _basis_inventory_name(self):
1996
return 'basis-inventory-cache'
1998
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1999
"""Create the text that will be saved in basis-inventory"""
2000
inventory.revision_id = revision_id
2001
return xml7.serializer_v7.write_inventory_to_string(inventory)
2589
2003
@needs_tree_write_lock
2590
2004
def set_conflicts(self, conflicts):
2591
self._put_rio('conflicts', conflicts.to_stanzas(),
2005
self._put_rio('conflicts', conflicts.to_stanzas(),
2592
2006
CONFLICT_HEADER_1)
2594
2008
@needs_tree_write_lock
2610
2024
raise errors.ConflictFormatError()
2611
2025
except StopIteration:
2612
2026
raise errors.ConflictFormatError()
2613
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2027
reader = _mod_rio.RioReader(confile)
2028
return _mod_conflicts.ConflictList.from_stanzas(reader)
2615
2030
confile.close()
2618
# do non-implementation specific cleanup
2620
if self._control_files._lock_count == 1:
2621
# _inventory_is_modified is always False during a read lock.
2622
if self._inventory_is_modified:
2624
self._write_hashcache_if_dirty()
2625
# reverse order of locking.
2627
return self._control_files.unlock()
2629
self.branch.unlock()
2632
def get_conflicted_stem(path):
2633
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2634
if path.endswith(suffix):
2635
return path[:-len(suffix)]
2638
class WorkingTreeFormat(object):
2032
def read_basis_inventory(self):
2033
"""Read the cached basis inventory."""
2034
path = self._basis_inventory_name()
2035
return self._transport.get_bytes(path)
2038
def read_working_inventory(self):
2039
"""Read the working inventory.
2041
:raises errors.InventoryModified: read_working_inventory will fail
2042
when the current in memory inventory has been modified.
2044
# conceptually this should be an implementation detail of the tree.
2045
# XXX: Deprecate this.
2046
# ElementTree does its own conversion from UTF-8, so open in
2048
if self._inventory_is_modified:
2049
raise errors.InventoryModified(self)
2050
f = self._transport.get('inventory')
2052
result = self._deserialize(f)
2055
self._set_inventory(result, dirty=False)
2059
def get_root_id(self):
2060
"""Return the id of this trees root"""
2061
return self._inventory.root.file_id
2063
def has_id(self, file_id):
2064
# files that have been deleted are excluded
2065
inv = self.inventory
2066
if not inv.has_id(file_id):
2068
path = inv.id2path(file_id)
2069
return osutils.lexists(self.abspath(path))
2071
def has_or_had_id(self, file_id):
2072
if file_id == self.inventory.root.file_id:
2074
return self.inventory.has_id(file_id)
2076
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2078
"""Iterate through file_ids for this tree.
2080
file_ids are in a WorkingTree if they are in the working inventory
2081
and the working file exists.
2083
inv = self._inventory
2084
for path, ie in inv.iter_entries():
2085
if osutils.lexists(self.abspath(path)):
2088
@needs_tree_write_lock
2089
def set_last_revision(self, new_revision):
2090
"""Change the last revision in the working tree."""
2091
if self._change_last_revision(new_revision):
2092
self._cache_basis_inventory(new_revision)
2094
def _get_check_refs(self):
2095
"""Return the references needed to perform a check of this tree.
2097
The default implementation returns no refs, and is only suitable for
2098
trees that have no local caching and can commit on ghosts at any time.
2100
:seealso: bzrlib.check for details about check_refs.
2105
def _check(self, references):
2106
"""Check the tree for consistency.
2108
:param references: A dict with keys matching the items returned by
2109
self._get_check_refs(), and values from looking those keys up in
2112
tree_basis = self.basis_tree()
2113
tree_basis.lock_read()
2115
repo_basis = references[('trees', self.last_revision())]
2116
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2117
raise errors.BzrCheckError(
2118
"Mismatched basis inventory content.")
2124
def check_state(self):
2125
"""Check that the working state is/isn't valid."""
2126
check_refs = self._get_check_refs()
2128
for ref in check_refs:
2131
refs[ref] = self.branch.repository.revision_tree(value)
2134
@needs_tree_write_lock
2135
def reset_state(self, revision_ids=None):
2136
"""Reset the state of the working tree.
2138
This does a hard-reset to a last-known-good state. This is a way to
2139
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2141
if revision_ids is None:
2142
revision_ids = self.get_parent_ids()
2143
if not revision_ids:
2144
rt = self.branch.repository.revision_tree(
2145
_mod_revision.NULL_REVISION)
2147
rt = self.branch.repository.revision_tree(revision_ids[0])
2148
self._write_inventory(rt.inventory)
2149
self.set_parent_ids(revision_ids)
2152
"""Write the in memory inventory to disk."""
2153
# TODO: Maybe this should only write on dirty ?
2154
if self._control_files._lock_mode != 'w':
2155
raise errors.NotWriteLocked(self)
2157
self._serialize(self._inventory, sio)
2159
self._transport.put_file('inventory', sio,
2160
mode=self.bzrdir._get_file_mode())
2161
self._inventory_is_modified = False
2164
def get_file_sha1(self, file_id, path=None, stat_value=None):
2166
path = self._inventory.id2path(file_id)
2167
return self._hashcache.get_sha1(path, stat_value)
2169
def get_file_mtime(self, file_id, path=None):
2170
"""See Tree.get_file_mtime."""
2172
path = self.inventory.id2path(file_id)
2173
return os.lstat(self.abspath(path)).st_mtime
2175
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2176
file_id = self.path2id(path)
2178
# For unversioned files on win32, we just assume they are not
2181
return self._inventory[file_id].executable
2183
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2184
mode = stat_result.st_mode
2185
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2187
if not supports_executable():
2188
def is_executable(self, file_id, path=None):
2189
return self._inventory[file_id].executable
2191
_is_executable_from_path_and_stat = \
2192
_is_executable_from_path_and_stat_from_basis
2194
def is_executable(self, file_id, path=None):
2196
path = self.id2path(file_id)
2197
mode = os.lstat(self.abspath(path)).st_mode
2198
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2200
_is_executable_from_path_and_stat = \
2201
_is_executable_from_path_and_stat_from_stat
2203
@needs_tree_write_lock
2204
def _add(self, files, ids, kinds):
2205
"""See MutableTree._add."""
2206
# TODO: Re-adding a file that is removed in the working copy
2207
# should probably put it back with the previous ID.
2208
# the read and write working inventory should not occur in this
2209
# function - they should be part of lock_write and unlock.
2210
inv = self.inventory
2211
for f, file_id, kind in zip(files, ids, kinds):
2213
inv.add_path(f, kind=kind)
2215
inv.add_path(f, kind=kind, file_id=file_id)
2216
self._inventory_is_modified = True
2218
def revision_tree(self, revision_id):
2219
"""See WorkingTree.revision_id."""
2220
if revision_id == self.last_revision():
2222
xml = self.read_basis_inventory()
2223
except errors.NoSuchFile:
2227
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2228
# dont use the repository revision_tree api because we want
2229
# to supply the inventory.
2230
if inv.revision_id == revision_id:
2231
return revisiontree.InventoryRevisionTree(
2232
self.branch.repository, inv, revision_id)
2233
except errors.BadInventoryFormat:
2235
# raise if there was no inventory, or if we read the wrong inventory.
2236
raise errors.NoSuchRevisionInTree(self, revision_id)
2239
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2240
"""See Tree.annotate_iter
2242
This implementation will use the basis tree implementation if possible.
2243
Lines not in the basis are attributed to CURRENT_REVISION
2245
If there are pending merges, lines added by those merges will be
2246
incorrectly attributed to CURRENT_REVISION (but after committing, the
2247
attribution will be correct).
2249
maybe_file_parent_keys = []
2250
for parent_id in self.get_parent_ids():
2252
parent_tree = self.revision_tree(parent_id)
2253
except errors.NoSuchRevisionInTree:
2254
parent_tree = self.branch.repository.revision_tree(parent_id)
2255
parent_tree.lock_read()
2257
if not parent_tree.has_id(file_id):
2259
ie = parent_tree.inventory[file_id]
2260
if ie.kind != 'file':
2261
# Note: this is slightly unnecessary, because symlinks and
2262
# directories have a "text" which is the empty text, and we
2263
# know that won't mess up annotations. But it seems cleaner
2265
parent_text_key = (file_id, ie.revision)
2266
if parent_text_key not in maybe_file_parent_keys:
2267
maybe_file_parent_keys.append(parent_text_key)
2269
parent_tree.unlock()
2270
graph = _mod_graph.Graph(self.branch.repository.texts)
2271
heads = graph.heads(maybe_file_parent_keys)
2272
file_parent_keys = []
2273
for key in maybe_file_parent_keys:
2275
file_parent_keys.append(key)
2277
# Now we have the parents of this content
2278
annotator = self.branch.repository.texts.get_annotator()
2279
text = self.get_file_text(file_id)
2280
this_key =(file_id, default_revision)
2281
annotator.add_special_text(this_key, file_parent_keys, text)
2282
annotations = [(key[-1], line)
2283
for key, line in annotator.annotate_flat(this_key)]
2287
def merge_modified(self):
2288
"""Return a dictionary of files modified by a merge.
2290
The list is initialized by WorkingTree.set_merge_modified, which is
2291
typically called after we make some automatic updates to the tree
2294
This returns a map of file_id->sha1, containing only files which are
2295
still in the working inventory and have that text hash.
2298
hashfile = self._transport.get('merge-hashes')
2299
except errors.NoSuchFile:
2304
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2305
raise errors.MergeModifiedFormatError()
2306
except StopIteration:
2307
raise errors.MergeModifiedFormatError()
2308
for s in _mod_rio.RioReader(hashfile):
2309
# RioReader reads in Unicode, so convert file_ids back to utf8
2310
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2311
if not self.inventory.has_id(file_id):
2313
text_hash = s.get("hash")
2314
if text_hash == self.get_file_sha1(file_id):
2315
merge_hashes[file_id] = text_hash
2321
def subsume(self, other_tree):
2322
def add_children(inventory, entry):
2323
for child_entry in entry.children.values():
2324
inventory._byid[child_entry.file_id] = child_entry
2325
if child_entry.kind == 'directory':
2326
add_children(inventory, child_entry)
2327
if other_tree.get_root_id() == self.get_root_id():
2328
raise errors.BadSubsumeSource(self, other_tree,
2329
'Trees have the same root')
2331
other_tree_path = self.relpath(other_tree.basedir)
2332
except errors.PathNotChild:
2333
raise errors.BadSubsumeSource(self, other_tree,
2334
'Tree is not contained by the other')
2335
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2336
if new_root_parent is None:
2337
raise errors.BadSubsumeSource(self, other_tree,
2338
'Parent directory is not versioned.')
2339
# We need to ensure that the result of a fetch will have a
2340
# versionedfile for the other_tree root, and only fetching into
2341
# RepositoryKnit2 guarantees that.
2342
if not self.branch.repository.supports_rich_root():
2343
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2344
other_tree.lock_tree_write()
2346
new_parents = other_tree.get_parent_ids()
2347
other_root = other_tree.inventory.root
2348
other_root.parent_id = new_root_parent
2349
other_root.name = osutils.basename(other_tree_path)
2350
self.inventory.add(other_root)
2351
add_children(self.inventory, other_root)
2352
self._write_inventory(self.inventory)
2353
# normally we don't want to fetch whole repositories, but i think
2354
# here we really do want to consolidate the whole thing.
2355
for parent_id in other_tree.get_parent_ids():
2356
self.branch.fetch(other_tree.branch, parent_id)
2357
self.add_parent_tree_id(parent_id)
2360
other_tree.bzrdir.retire_bzrdir()
2362
@needs_tree_write_lock
2363
def extract(self, file_id, format=None):
2364
"""Extract a subtree from this tree.
2366
A new branch will be created, relative to the path for this tree.
2370
segments = osutils.splitpath(path)
2371
transport = self.branch.bzrdir.root_transport
2372
for name in segments:
2373
transport = transport.clone(name)
2374
transport.ensure_base()
2377
sub_path = self.id2path(file_id)
2378
branch_transport = mkdirs(sub_path)
2380
format = self.bzrdir.cloning_metadir()
2381
branch_transport.ensure_base()
2382
branch_bzrdir = format.initialize_on_transport(branch_transport)
2384
repo = branch_bzrdir.find_repository()
2385
except errors.NoRepositoryPresent:
2386
repo = branch_bzrdir.create_repository()
2387
if not repo.supports_rich_root():
2388
raise errors.RootNotRich()
2389
new_branch = branch_bzrdir.create_branch()
2390
new_branch.pull(self.branch)
2391
for parent_id in self.get_parent_ids():
2392
new_branch.fetch(self.branch, parent_id)
2393
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2394
if tree_transport.base != branch_transport.base:
2395
tree_bzrdir = format.initialize_on_transport(tree_transport)
2396
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2397
target_branch=new_branch)
2399
tree_bzrdir = branch_bzrdir
2400
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2401
wt.set_parent_ids(self.get_parent_ids())
2402
my_inv = self.inventory
2403
child_inv = inventory.Inventory(root_id=None)
2404
new_root = my_inv[file_id]
2405
my_inv.remove_recursive_id(file_id)
2406
new_root.parent_id = None
2407
child_inv.add(new_root)
2408
self._write_inventory(my_inv)
2409
wt._write_inventory(child_inv)
2412
def list_files(self, include_root=False, from_dir=None, recursive=True):
2413
"""List all files as (path, class, kind, id, entry).
2415
Lists, but does not descend into unversioned directories.
2416
This does not include files that have been deleted in this
2417
tree. Skips the control directory.
2419
:param include_root: if True, return an entry for the root
2420
:param from_dir: start from this directory or None for the root
2421
:param recursive: whether to recurse into subdirectories or not
2423
# list_files is an iterator, so @needs_read_lock doesn't work properly
2424
# with it. So callers should be careful to always read_lock the tree.
2425
if not self.is_locked():
2426
raise errors.ObjectNotLocked(self)
2428
inv = self.inventory
2429
if from_dir is None and include_root is True:
2430
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2431
# Convert these into local objects to save lookup times
2432
pathjoin = osutils.pathjoin
2433
file_kind = self._kind
2435
# transport.base ends in a slash, we want the piece
2436
# between the last two slashes
2437
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2439
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2441
# directory file_id, relative path, absolute path, reverse sorted children
2442
if from_dir is not None:
2443
from_dir_id = inv.path2id(from_dir)
2444
if from_dir_id is None:
2445
# Directory not versioned
2447
from_dir_abspath = pathjoin(self.basedir, from_dir)
2449
from_dir_id = inv.root.file_id
2450
from_dir_abspath = self.basedir
2451
children = os.listdir(from_dir_abspath)
2453
# jam 20060527 The kernel sized tree seems equivalent whether we
2454
# use a deque and popleft to keep them sorted, or if we use a plain
2455
# list and just reverse() them.
2456
children = collections.deque(children)
2457
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2459
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2462
f = children.popleft()
2463
## TODO: If we find a subdirectory with its own .bzr
2464
## directory, then that is a separate tree and we
2465
## should exclude it.
2467
# the bzrdir for this tree
2468
if transport_base_dir == f:
2471
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2472
# and 'f' doesn't begin with one, we can do a string op, rather
2473
# than the checks of pathjoin(), all relative paths will have an extra slash
2475
fp = from_dir_relpath + '/' + f
2478
fap = from_dir_abspath + '/' + f
2480
dir_ie = inv[from_dir_id]
2481
if dir_ie.kind == 'directory':
2482
f_ie = dir_ie.children.get(f)
2487
elif self.is_ignored(fp[1:]):
2490
# we may not have found this file, because of a unicode
2491
# issue, or because the directory was actually a symlink.
2492
f_norm, can_access = osutils.normalized_filename(f)
2493
if f == f_norm or not can_access:
2494
# No change, so treat this file normally
2497
# this file can be accessed by a normalized path
2498
# check again if it is versioned
2499
# these lines are repeated here for performance
2501
fp = from_dir_relpath + '/' + f
2502
fap = from_dir_abspath + '/' + f
2503
f_ie = inv.get_child(from_dir_id, f)
2506
elif self.is_ignored(fp[1:]):
2513
# make a last minute entry
2515
yield fp[1:], c, fk, f_ie.file_id, f_ie
2518
yield fp[1:], c, fk, None, fk_entries[fk]()
2520
yield fp[1:], c, fk, None, TreeEntry()
2523
if fk != 'directory':
2526
# But do this child first if recursing down
2528
new_children = os.listdir(fap)
2530
new_children = collections.deque(new_children)
2531
stack.append((f_ie.file_id, fp, fap, new_children))
2532
# Break out of inner loop,
2533
# so that we start outer loop with child
2536
# if we finished all children, pop it off the stack
2539
@needs_tree_write_lock
2540
def move(self, from_paths, to_dir=None, after=False):
2543
to_dir must exist in the inventory.
2545
If to_dir exists and is a directory, the files are moved into
2546
it, keeping their old names.
2548
Note that to_dir is only the last component of the new name;
2549
this doesn't change the directory.
2551
For each entry in from_paths the move mode will be determined
2554
The first mode moves the file in the filesystem and updates the
2555
inventory. The second mode only updates the inventory without
2556
touching the file on the filesystem.
2558
move uses the second mode if 'after == True' and the target is
2559
either not versioned or newly added, and present in the working tree.
2561
move uses the second mode if 'after == False' and the source is
2562
versioned but no longer in the working tree, and the target is not
2563
versioned but present in the working tree.
2565
move uses the first mode if 'after == False' and the source is
2566
versioned and present in the working tree, and the target is not
2567
versioned and not present in the working tree.
2569
Everything else results in an error.
2571
This returns a list of (from_path, to_path) pairs for each
2572
entry that is moved.
2577
# check for deprecated use of signature
2579
raise TypeError('You must supply a target directory')
2580
# check destination directory
2581
if isinstance(from_paths, basestring):
2583
inv = self.inventory
2584
to_abs = self.abspath(to_dir)
2585
if not isdir(to_abs):
2586
raise errors.BzrMoveFailedError('',to_dir,
2587
errors.NotADirectory(to_abs))
2588
if not self.has_filename(to_dir):
2589
raise errors.BzrMoveFailedError('',to_dir,
2590
errors.NotInWorkingDirectory(to_dir))
2591
to_dir_id = inv.path2id(to_dir)
2592
if to_dir_id is None:
2593
raise errors.BzrMoveFailedError('',to_dir,
2594
errors.NotVersionedError(path=to_dir))
2596
to_dir_ie = inv[to_dir_id]
2597
if to_dir_ie.kind != 'directory':
2598
raise errors.BzrMoveFailedError('',to_dir,
2599
errors.NotADirectory(to_abs))
2601
# create rename entries and tuples
2602
for from_rel in from_paths:
2603
from_tail = splitpath(from_rel)[-1]
2604
from_id = inv.path2id(from_rel)
2606
raise errors.BzrMoveFailedError(from_rel,to_dir,
2607
errors.NotVersionedError(path=from_rel))
2609
from_entry = inv[from_id]
2610
from_parent_id = from_entry.parent_id
2611
to_rel = pathjoin(to_dir, from_tail)
2612
rename_entry = InventoryWorkingTree._RenameEntry(
2615
from_tail=from_tail,
2616
from_parent_id=from_parent_id,
2617
to_rel=to_rel, to_tail=from_tail,
2618
to_parent_id=to_dir_id)
2619
rename_entries.append(rename_entry)
2620
rename_tuples.append((from_rel, to_rel))
2622
# determine which move mode to use. checks also for movability
2623
rename_entries = self._determine_mv_mode(rename_entries, after)
2625
original_modified = self._inventory_is_modified
2628
self._inventory_is_modified = True
2629
self._move(rename_entries)
2631
# restore the inventory on error
2632
self._inventory_is_modified = original_modified
2634
self._write_inventory(inv)
2635
return rename_tuples
2637
@needs_tree_write_lock
2638
def rename_one(self, from_rel, to_rel, after=False):
2641
This can change the directory or the filename or both.
2643
rename_one has several 'modes' to work. First, it can rename a physical
2644
file and change the file_id. That is the normal mode. Second, it can
2645
only change the file_id without touching any physical file.
2647
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2648
versioned but present in the working tree.
2650
rename_one uses the second mode if 'after == False' and 'from_rel' is
2651
versioned but no longer in the working tree, and 'to_rel' is not
2652
versioned but present in the working tree.
2654
rename_one uses the first mode if 'after == False' and 'from_rel' is
2655
versioned and present in the working tree, and 'to_rel' is not
2656
versioned and not present in the working tree.
2658
Everything else results in an error.
2660
inv = self.inventory
2663
# create rename entries and tuples
2664
from_tail = splitpath(from_rel)[-1]
2665
from_id = inv.path2id(from_rel)
2667
# if file is missing in the inventory maybe it's in the basis_tree
2668
basis_tree = self.branch.basis_tree()
2669
from_id = basis_tree.path2id(from_rel)
2671
raise errors.BzrRenameFailedError(from_rel,to_rel,
2672
errors.NotVersionedError(path=from_rel))
2673
# put entry back in the inventory so we can rename it
2674
from_entry = basis_tree.inventory[from_id].copy()
2677
from_entry = inv[from_id]
2678
from_parent_id = from_entry.parent_id
2679
to_dir, to_tail = os.path.split(to_rel)
2680
to_dir_id = inv.path2id(to_dir)
2681
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2683
from_tail=from_tail,
2684
from_parent_id=from_parent_id,
2685
to_rel=to_rel, to_tail=to_tail,
2686
to_parent_id=to_dir_id)
2687
rename_entries.append(rename_entry)
2689
# determine which move mode to use. checks also for movability
2690
rename_entries = self._determine_mv_mode(rename_entries, after)
2692
# check if the target changed directory and if the target directory is
2694
if to_dir_id is None:
2695
raise errors.BzrMoveFailedError(from_rel,to_rel,
2696
errors.NotVersionedError(path=to_dir))
2698
# all checks done. now we can continue with our actual work
2699
mutter('rename_one:\n'
2704
' to_dir_id {%s}\n',
2705
from_id, from_rel, to_rel, to_dir, to_dir_id)
2707
self._move(rename_entries)
2708
self._write_inventory(inv)
2710
class _RenameEntry(object):
2711
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2712
to_rel, to_tail, to_parent_id, only_change_inv=False,
2714
self.from_rel = from_rel
2715
self.from_id = from_id
2716
self.from_tail = from_tail
2717
self.from_parent_id = from_parent_id
2718
self.to_rel = to_rel
2719
self.to_tail = to_tail
2720
self.to_parent_id = to_parent_id
2721
self.change_id = change_id
2722
self.only_change_inv = only_change_inv
2724
def _determine_mv_mode(self, rename_entries, after=False):
2725
"""Determines for each from-to pair if both inventory and working tree
2726
or only the inventory has to be changed.
2728
Also does basic plausability tests.
2730
inv = self.inventory
2732
for rename_entry in rename_entries:
2733
# store to local variables for easier reference
2734
from_rel = rename_entry.from_rel
2735
from_id = rename_entry.from_id
2736
to_rel = rename_entry.to_rel
2737
to_id = inv.path2id(to_rel)
2738
only_change_inv = False
2741
# check the inventory for source and destination
2743
raise errors.BzrMoveFailedError(from_rel,to_rel,
2744
errors.NotVersionedError(path=from_rel))
2745
if to_id is not None:
2747
# allow it with --after but only if dest is newly added
2749
basis = self.basis_tree()
2752
if not basis.has_id(to_id):
2753
rename_entry.change_id = True
2758
raise errors.BzrMoveFailedError(from_rel,to_rel,
2759
errors.AlreadyVersionedError(path=to_rel))
2761
# try to determine the mode for rename (only change inv or change
2762
# inv and file system)
2764
if not self.has_filename(to_rel):
2765
raise errors.BzrMoveFailedError(from_id,to_rel,
2766
errors.NoSuchFile(path=to_rel,
2767
extra="New file has not been created yet"))
2768
only_change_inv = True
2769
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2770
only_change_inv = True
2771
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2772
only_change_inv = False
2773
elif (not self.case_sensitive
2774
and from_rel.lower() == to_rel.lower()
2775
and self.has_filename(from_rel)):
2776
only_change_inv = False
2778
# something is wrong, so lets determine what exactly
2779
if not self.has_filename(from_rel) and \
2780
not self.has_filename(to_rel):
2781
raise errors.BzrRenameFailedError(from_rel,to_rel,
2782
errors.PathsDoNotExist(paths=(str(from_rel),
2785
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2786
rename_entry.only_change_inv = only_change_inv
2787
return rename_entries
2789
def _move(self, rename_entries):
2790
"""Moves a list of files.
2792
Depending on the value of the flag 'only_change_inv', the
2793
file will be moved on the file system or not.
2795
inv = self.inventory
2798
for entry in rename_entries:
2800
self._move_entry(entry)
2802
self._rollback_move(moved)
2806
def _rollback_move(self, moved):
2807
"""Try to rollback a previous move in case of an filesystem error."""
2808
inv = self.inventory
2811
self._move_entry(WorkingTree._RenameEntry(
2812
entry.to_rel, entry.from_id,
2813
entry.to_tail, entry.to_parent_id, entry.from_rel,
2814
entry.from_tail, entry.from_parent_id,
2815
entry.only_change_inv))
2816
except errors.BzrMoveFailedError, e:
2817
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2818
" The working tree is in an inconsistent state."
2819
" Please consider doing a 'bzr revert'."
2820
" Error message is: %s" % e)
2822
def _move_entry(self, entry):
2823
inv = self.inventory
2824
from_rel_abs = self.abspath(entry.from_rel)
2825
to_rel_abs = self.abspath(entry.to_rel)
2826
if from_rel_abs == to_rel_abs:
2827
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2828
"Source and target are identical.")
2830
if not entry.only_change_inv:
2832
osutils.rename(from_rel_abs, to_rel_abs)
2834
raise errors.BzrMoveFailedError(entry.from_rel,
2837
to_id = inv.path2id(entry.to_rel)
2838
inv.remove_recursive_id(to_id)
2839
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2841
@needs_tree_write_lock
2842
def unversion(self, file_ids):
2843
"""Remove the file ids in file_ids from the current versioned set.
2845
When a file_id is unversioned, all of its children are automatically
2848
:param file_ids: The file ids to stop versioning.
2849
:raises: NoSuchId if any fileid is not currently versioned.
2851
for file_id in file_ids:
2852
if not self._inventory.has_id(file_id):
2853
raise errors.NoSuchId(self, file_id)
2854
for file_id in file_ids:
2855
if self._inventory.has_id(file_id):
2856
self._inventory.remove_recursive_id(file_id)
2858
# in the future this should just set a dirty bit to wait for the
2859
# final unlock. However, until all methods of workingtree start
2860
# with the current in -memory inventory rather than triggering
2861
# a read, it is more complex - we need to teach read_inventory
2862
# to know when to read, and when to not read first... and possibly
2863
# to save first when the in memory one may be corrupted.
2864
# so for now, we just only write it if it is indeed dirty.
2866
self._write_inventory(self._inventory)
2868
def stored_kind(self, file_id):
2869
"""See Tree.stored_kind"""
2870
return self.inventory[file_id].kind
2873
"""Yield all unversioned files in this WorkingTree.
2875
If there are any unversioned directories then only the directory is
2876
returned, not all its children. But if there are unversioned files
2877
under a versioned subdirectory, they are returned.
2879
Currently returned depth-first, sorted by name within directories.
2880
This is the same order used by 'osutils.walkdirs'.
2882
## TODO: Work from given directory downwards
2883
for path, dir_entry in self.inventory.directories():
2884
# mutter("search for unknowns in %r", path)
2885
dirabs = self.abspath(path)
2886
if not isdir(dirabs):
2887
# e.g. directory deleted
2891
for subf in os.listdir(dirabs):
2892
if self.bzrdir.is_control_filename(subf):
2894
if subf not in dir_entry.children:
2897
can_access) = osutils.normalized_filename(subf)
2898
except UnicodeDecodeError:
2899
path_os_enc = path.encode(osutils._fs_enc)
2900
relpath = path_os_enc + '/' + subf
2901
raise errors.BadFilenameEncoding(relpath,
2903
if subf_norm != subf and can_access:
2904
if subf_norm not in dir_entry.children:
2905
fl.append(subf_norm)
2911
subp = pathjoin(path, subf)
2914
def _walkdirs(self, prefix=""):
2915
"""Walk the directories of this tree.
2917
:param prefix: is used as the directrory to start with.
2918
:returns: a generator which yields items in the form::
2920
((curren_directory_path, fileid),
2921
[(file1_path, file1_name, file1_kind, None, file1_id,
2924
_directory = 'directory'
2925
# get the root in the inventory
2926
inv = self.inventory
2927
top_id = inv.path2id(prefix)
2931
pending = [(prefix, '', _directory, None, top_id, None)]
2934
currentdir = pending.pop()
2935
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2936
top_id = currentdir[4]
2938
relroot = currentdir[0] + '/'
2941
# FIXME: stash the node in pending
2943
if entry.kind == 'directory':
2944
for name, child in entry.sorted_children():
2945
dirblock.append((relroot + name, name, child.kind, None,
2946
child.file_id, child.kind
2948
yield (currentdir[0], entry.file_id), dirblock
2949
# push the user specified dirs from dirblock
2950
for dir in reversed(dirblock):
2951
if dir[2] == _directory:
2955
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2956
"""Registry for working tree formats."""
2958
def __init__(self, other_registry=None):
2959
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2960
self._default_format = None
2961
self._default_format_key = None
2963
def get_default(self):
2964
"""Return the current default format."""
2965
if (self._default_format_key is not None and
2966
self._default_format is None):
2967
self._default_format = self.get(self._default_format_key)
2968
return self._default_format
2970
def set_default(self, format):
2971
"""Set the default format."""
2972
self._default_format = format
2973
self._default_format_key = None
2975
def set_default_key(self, format_string):
2976
"""Set the default format by its format string."""
2977
self._default_format_key = format_string
2978
self._default_format = None
2981
format_registry = WorkingTreeFormatRegistry()
2984
class WorkingTreeFormat(controldir.ControlComponentFormat):
2639
2985
"""An encapsulation of the initialization and open routines for a format.
2641
2987
Formats provide three things:
2699
3073
"""Is this format supported?
2701
3075
Supported formats can be initialized and opened.
2702
Unsupported formats may not support initialization or committing or
3076
Unsupported formats may not support initialization or committing or
2703
3077
some other features depending on the reason for not being supported.
3081
def supports_content_filtering(self):
3082
"""True if this format supports content filtering."""
3085
def supports_views(self):
3086
"""True if this format supports stored views."""
3090
@symbol_versioning.deprecated_method(
3091
symbol_versioning.deprecated_in((2, 4, 0)))
2708
3092
def register_format(klass, format):
2709
klass._formats[format.get_format_string()] = format
3093
format_registry.register(format)
3096
@symbol_versioning.deprecated_method(
3097
symbol_versioning.deprecated_in((2, 4, 0)))
3098
def register_extra_format(klass, format):
3099
format_registry.register_extra(format)
3102
@symbol_versioning.deprecated_method(
3103
symbol_versioning.deprecated_in((2, 4, 0)))
3104
def unregister_extra_format(klass, format):
3105
format_registry.unregister_extra(format)
3108
@symbol_versioning.deprecated_method(
3109
symbol_versioning.deprecated_in((2, 4, 0)))
3110
def get_formats(klass):
3111
return format_registry._get_all()
3114
@symbol_versioning.deprecated_method(
3115
symbol_versioning.deprecated_in((2, 4, 0)))
2712
3116
def set_default_format(klass, format):
2713
klass._default_format = format
3117
format_registry.set_default(format)
3120
@symbol_versioning.deprecated_method(
3121
symbol_versioning.deprecated_in((2, 4, 0)))
2716
3122
def unregister_format(klass, format):
2717
del klass._formats[format.get_format_string()]
2720
class WorkingTreeFormat2(WorkingTreeFormat):
2721
"""The second working tree format.
2723
This format modified the hash cache from the format 1 hash cache.
2726
upgrade_recommended = True
2728
def get_format_description(self):
2729
"""See WorkingTreeFormat.get_format_description()."""
2730
return "Working tree format 2"
2732
def _stub_initialize_on_transport(self, transport, file_mode):
2733
"""Workaround: create control files for a remote working tree.
2735
This ensures that it can later be updated and dealt with locally,
2736
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2737
no working tree. (See bug #43064).
2741
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2743
transport.put_file('inventory', sio, file_mode)
2744
transport.put_bytes('pending-merges', '', file_mode)
2746
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2747
accelerator_tree=None, hardlink=False):
2748
"""See WorkingTreeFormat.initialize()."""
2749
if not isinstance(a_bzrdir.transport, LocalTransport):
2750
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2751
if from_branch is not None:
2752
branch = from_branch
2754
branch = a_bzrdir.open_branch()
2755
if revision_id is None:
2756
revision_id = _mod_revision.ensure_null(branch.last_revision())
2759
branch.generate_revision_history(revision_id)
2763
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2769
basis_tree = branch.repository.revision_tree(revision_id)
2770
if basis_tree.inventory.root is not None:
2771
wt.set_root_id(basis_tree.get_root_id())
2772
# set the parent list and cache the basis tree.
2773
if _mod_revision.is_null(revision_id):
2776
parent_trees = [(revision_id, basis_tree)]
2777
wt.set_parent_trees(parent_trees)
2778
transform.build_tree(basis_tree, wt)
2782
super(WorkingTreeFormat2, self).__init__()
2783
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2785
def open(self, a_bzrdir, _found=False):
2786
"""Return the WorkingTree object for a_bzrdir
2788
_found is a private parameter, do not use it. It is used to indicate
2789
if format probing has already been done.
2792
# we are being called directly and must probe.
2793
raise NotImplementedError
2794
if not isinstance(a_bzrdir.transport, LocalTransport):
2795
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2796
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2802
class WorkingTreeFormat3(WorkingTreeFormat):
2803
"""The second working tree format updated to record a format marker.
2806
- exists within a metadir controlling .bzr
2807
- includes an explicit version marker for the workingtree control
2808
files, separate from the BzrDir format
2809
- modifies the hash cache format
2811
- uses a LockDir to guard access for writes.
2814
upgrade_recommended = True
2816
def get_format_string(self):
2817
"""See WorkingTreeFormat.get_format_string()."""
2818
return "Bazaar-NG Working Tree format 3"
2820
def get_format_description(self):
2821
"""See WorkingTreeFormat.get_format_description()."""
2822
return "Working tree format 3"
2824
_lock_file_name = 'lock'
2825
_lock_class = LockDir
2827
_tree_class = WorkingTree3
2829
def __get_matchingbzrdir(self):
2830
return bzrdir.BzrDirMetaFormat1()
2832
_matchingbzrdir = property(__get_matchingbzrdir)
2834
def _open_control_files(self, a_bzrdir):
2835
transport = a_bzrdir.get_workingtree_transport(None)
2836
return LockableFiles(transport, self._lock_file_name,
2839
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2840
accelerator_tree=None, hardlink=False):
2841
"""See WorkingTreeFormat.initialize().
2843
:param revision_id: if supplied, create a working tree at a different
2844
revision than the branch is at.
2845
:param accelerator_tree: A tree which can be used for retrieving file
2846
contents more quickly than the revision tree, i.e. a workingtree.
2847
The revision tree will be used for cases where accelerator_tree's
2848
content is different.
2849
:param hardlink: If true, hard-link files from accelerator_tree,
2852
if not isinstance(a_bzrdir.transport, LocalTransport):
2853
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2854
transport = a_bzrdir.get_workingtree_transport(self)
2855
control_files = self._open_control_files(a_bzrdir)
2856
control_files.create_lock()
2857
control_files.lock_write()
2858
transport.put_bytes('format', self.get_format_string(),
2859
mode=control_files._file_mode)
2860
if from_branch is not None:
2861
branch = from_branch
2863
branch = a_bzrdir.open_branch()
2864
if revision_id is None:
2865
revision_id = _mod_revision.ensure_null(branch.last_revision())
2866
# WorkingTree3 can handle an inventory which has a unique root id.
2867
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2868
# those trees. And because there isn't a format bump inbetween, we
2869
# are maintaining compatibility with older clients.
2870
# inv = Inventory(root_id=gen_root_id())
2871
inv = self._initial_inventory()
2872
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2878
_control_files=control_files)
2879
wt.lock_tree_write()
2881
basis_tree = branch.repository.revision_tree(revision_id)
2882
# only set an explicit root id if there is one to set.
2883
if basis_tree.inventory.root is not None:
2884
wt.set_root_id(basis_tree.get_root_id())
2885
if revision_id == NULL_REVISION:
2886
wt.set_parent_trees([])
2888
wt.set_parent_trees([(revision_id, basis_tree)])
2889
transform.build_tree(basis_tree, wt)
2891
# Unlock in this order so that the unlock-triggers-flush in
2892
# WorkingTree is given a chance to fire.
2893
control_files.unlock()
2897
def _initial_inventory(self):
2901
super(WorkingTreeFormat3, self).__init__()
2903
def open(self, a_bzrdir, _found=False):
2904
"""Return the WorkingTree object for a_bzrdir
2906
_found is a private parameter, do not use it. It is used to indicate
2907
if format probing has already been done.
2910
# we are being called directly and must probe.
2911
raise NotImplementedError
2912
if not isinstance(a_bzrdir.transport, LocalTransport):
2913
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2914
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2917
def _open(self, a_bzrdir, control_files):
2918
"""Open the tree itself.
2920
:param a_bzrdir: the dir for the tree.
2921
:param control_files: the control files for the tree.
2923
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2927
_control_files=control_files)
2930
return self.get_format_string()
2933
__default_format = WorkingTreeFormat4()
2934
WorkingTreeFormat.register_format(__default_format)
2935
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2936
WorkingTreeFormat.set_default_format(__default_format)
2937
# formats which have no format string are not discoverable
2938
# and not independently creatable, so are not registered.
2939
_legacy_formats = [WorkingTreeFormat2(),
3123
format_registry.remove(format)
3126
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3127
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3128
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3129
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3130
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3131
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3132
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3133
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3134
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
