993
900
# checkout in a subdirectory. This can be avoided by not adding
994
901
# it. mbp 20070306
996
@needs_tree_write_lock
997
903
def extract(self, file_id, format=None):
998
904
"""Extract a subtree from this tree.
1000
906
A new branch will be created, relative to the path for this tree.
1004
segments = osutils.splitpath(path)
1005
transport = self.branch.bzrdir.root_transport
1006
for name in segments:
1007
transport = transport.clone(name)
1008
transport.ensure_base()
1011
sub_path = self.id2path(file_id)
1012
branch_transport = mkdirs(sub_path)
1014
format = self.bzrdir.cloning_metadir()
1015
branch_transport.ensure_base()
1016
branch_bzrdir = format.initialize_on_transport(branch_transport)
1018
repo = branch_bzrdir.find_repository()
1019
except errors.NoRepositoryPresent:
1020
repo = branch_bzrdir.create_repository()
1021
if not repo.supports_rich_root():
1022
raise errors.RootNotRich()
1023
new_branch = branch_bzrdir.create_branch()
1024
new_branch.pull(self.branch)
1025
for parent_id in self.get_parent_ids():
1026
new_branch.fetch(self.branch, parent_id)
1027
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1028
if tree_transport.base != branch_transport.base:
1029
tree_bzrdir = format.initialize_on_transport(tree_transport)
1030
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1032
tree_bzrdir = branch_bzrdir
1033
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1034
wt.set_parent_ids(self.get_parent_ids())
1035
my_inv = self.inventory
1036
child_inv = Inventory(root_id=None)
1037
new_root = my_inv[file_id]
1038
my_inv.remove_recursive_id(file_id)
1039
new_root.parent_id = None
1040
child_inv.add(new_root)
1041
self._write_inventory(my_inv)
1042
wt._write_inventory(child_inv)
1045
def _serialize(self, inventory, out_file):
1046
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1049
def _deserialize(selt, in_file):
1050
return xml5.serializer_v5.read_inventory(in_file)
908
raise NotImplementedError(self.extract)
1052
910
def flush(self):
1053
"""Write the in memory inventory to disk."""
1054
# TODO: Maybe this should only write on dirty ?
1055
if self._control_files._lock_mode != 'w':
1056
raise errors.NotWriteLocked(self)
1058
self._serialize(self._inventory, sio)
1060
self._transport.put_file('inventory', sio,
1061
mode=self._control_files._file_mode)
1062
self._inventory_is_modified = False
911
"""Write the in memory meta data to disk."""
912
raise NotImplementedError(self.flush)
1064
914
def _kind(self, relpath):
1065
915
return osutils.file_kind(self.abspath(relpath))
1067
def list_files(self, include_root=False):
1068
"""Recursively list all files as (path, class, kind, id, entry).
917
def list_files(self, include_root=False, from_dir=None, recursive=True):
918
"""List all files as (path, class, kind, id, entry).
1070
920
Lists, but does not descend into unversioned directories.
1072
921
This does not include files that have been deleted in this
922
tree. Skips the control directory.
1075
Skips the control directory.
924
:param include_root: if True, return an entry for the root
925
:param from_dir: start from this directory or None for the root
926
:param recursive: whether to recurse into subdirectories or not
1077
# list_files is an iterator, so @needs_read_lock doesn't work properly
1078
# with it. So callers should be careful to always read_lock the tree.
1079
if not self.is_locked():
1080
raise errors.ObjectNotLocked(self)
1082
inv = self.inventory
1083
if include_root is True:
1084
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1085
# Convert these into local objects to save lookup times
1086
pathjoin = osutils.pathjoin
1087
file_kind = self._kind
1089
# transport.base ends in a slash, we want the piece
1090
# between the last two slashes
1091
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1093
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1095
# directory file_id, relative path, absolute path, reverse sorted children
1096
children = os.listdir(self.basedir)
1098
# jam 20060527 The kernel sized tree seems equivalent whether we
1099
# use a deque and popleft to keep them sorted, or if we use a plain
1100
# list and just reverse() them.
1101
children = collections.deque(children)
1102
stack = [(inv.root.file_id, u'', self.basedir, children)]
1104
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1107
f = children.popleft()
1108
## TODO: If we find a subdirectory with its own .bzr
1109
## directory, then that is a separate tree and we
1110
## should exclude it.
1112
# the bzrdir for this tree
1113
if transport_base_dir == f:
1116
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1117
# and 'f' doesn't begin with one, we can do a string op, rather
1118
# than the checks of pathjoin(), all relative paths will have an extra slash
1120
fp = from_dir_relpath + '/' + f
1123
fap = from_dir_abspath + '/' + f
1125
f_ie = inv.get_child(from_dir_id, f)
1128
elif self.is_ignored(fp[1:]):
1131
# we may not have found this file, because of a unicode issue
1132
f_norm, can_access = osutils.normalized_filename(f)
1133
if f == f_norm or not can_access:
1134
# No change, so treat this file normally
1137
# this file can be accessed by a normalized path
1138
# check again if it is versioned
1139
# these lines are repeated here for performance
1141
fp = from_dir_relpath + '/' + f
1142
fap = from_dir_abspath + '/' + f
1143
f_ie = inv.get_child(from_dir_id, f)
1146
elif self.is_ignored(fp[1:]):
1153
# make a last minute entry
1155
yield fp[1:], c, fk, f_ie.file_id, f_ie
1158
yield fp[1:], c, fk, None, fk_entries[fk]()
1160
yield fp[1:], c, fk, None, TreeEntry()
1163
if fk != 'directory':
1166
# But do this child first
1167
new_children = os.listdir(fap)
1169
new_children = collections.deque(new_children)
1170
stack.append((f_ie.file_id, fp, fap, new_children))
1171
# Break out of inner loop,
1172
# so that we start outer loop with child
1175
# if we finished all children, pop it off the stack
1178
@needs_tree_write_lock
1179
def move(self, from_paths, to_dir=None, after=False, **kwargs):
928
raise NotImplementedError(self.list_files)
930
def move(self, from_paths, to_dir=None, after=False):
1180
931
"""Rename files.
1182
to_dir must exist in the inventory.
933
to_dir must be known to the working tree.
1184
935
If to_dir exists and is a directory, the files are moved into
1185
it, keeping their old names.
936
it, keeping their old names.
1187
938
Note that to_dir is only the last component of the new name;
1188
939
this doesn't change the directory.
2492
1811
self)._get_rules_searcher(default_searcher)
2493
1812
return self._rules_searcher
2496
class WorkingTree2(WorkingTree):
2497
"""This is the Format 2 working tree.
2499
This was the first weave based working tree.
2500
- uses os locks for locking.
2501
- uses the branch last-revision.
1814
def get_shelf_manager(self):
1815
"""Return the ShelfManager for this WorkingTree."""
1816
from bzrlib.shelf import ShelfManager
1817
return ShelfManager(self, self._transport)
1820
class InventoryWorkingTree(WorkingTree,
1821
bzrlib.mutabletree.MutableInventoryTree):
1822
"""Base class for working trees that are inventory-oriented.
1824
The inventory is held in the `Branch` working-inventory, and the
1825
files are in a directory on disk.
1827
It is possible for a `WorkingTree` to have a filename which is
1828
not listed in the Inventory and vice versa.
2504
def __init__(self, *args, **kwargs):
2505
super(WorkingTree2, self).__init__(*args, **kwargs)
2506
# WorkingTree2 has more of a constraint that self._inventory must
2507
# exist. Because this is an older format, we don't mind the overhead
2508
# caused by the extra computation here.
2510
# Newer WorkingTree's should only have self._inventory set when they
2512
if self._inventory is None:
2513
self.read_working_inventory()
2515
def lock_tree_write(self):
2516
"""See WorkingTree.lock_tree_write().
2518
In Format2 WorkingTrees we have a single lock for the branch and tree
2519
so lock_tree_write() degrades to lock_write().
2521
self.branch.lock_write()
2523
return self._control_files.lock_write()
2525
self.branch.unlock()
2529
# do non-implementation specific cleanup
2532
# we share control files:
2533
if self._control_files._lock_count == 3:
2534
# _inventory_is_modified is always False during a read lock.
2535
if self._inventory_is_modified:
2537
self._write_hashcache_if_dirty()
2539
# reverse order of locking.
2541
return self._control_files.unlock()
1831
def __init__(self, basedir='.',
1832
branch=DEPRECATED_PARAMETER,
1834
_control_files=None,
1838
"""Construct a InventoryWorkingTree instance. This is not a public API.
1840
:param branch: A branch to override probing for the branch.
1842
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1843
branch=branch, _control_files=_control_files, _internal=_internal,
1844
_format=_format, _bzrdir=_bzrdir)
1846
if _inventory is None:
1847
# This will be acquired on lock_read() or lock_write()
1848
self._inventory_is_modified = False
1849
self._inventory = None
1851
# the caller of __init__ has provided an inventory,
1852
# we assume they know what they are doing - as its only
1853
# the Format factory and creation methods that are
1854
# permitted to do this.
1855
self._set_inventory(_inventory, dirty=False)
1857
def _set_inventory(self, inv, dirty):
1858
"""Set the internal cached inventory.
1860
:param inv: The inventory to set.
1861
:param dirty: A boolean indicating whether the inventory is the same
1862
logical inventory as whats on disk. If True the inventory is not
1863
the same and should be written to disk or data will be lost, if
1864
False then the inventory is the same as that on disk and any
1865
serialisation would be unneeded overhead.
1867
self._inventory = inv
1868
self._inventory_is_modified = dirty
1870
def _serialize(self, inventory, out_file):
1871
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1874
def _deserialize(selt, in_file):
1875
return xml5.serializer_v5.read_inventory(in_file)
1877
@needs_tree_write_lock
1878
def _write_inventory(self, inv):
1879
"""Write inventory as the current inventory."""
1880
self._set_inventory(inv, dirty=True)
1883
# XXX: This method should be deprecated in favour of taking in a proper
1884
# new Inventory object.
1885
@needs_tree_write_lock
1886
def set_inventory(self, new_inventory_list):
1887
from bzrlib.inventory import (Inventory,
1891
inv = Inventory(self.get_root_id())
1892
for path, file_id, parent, kind in new_inventory_list:
1893
name = os.path.basename(path)
1896
# fixme, there should be a factory function inv,add_??
1897
if kind == 'directory':
1898
inv.add(InventoryDirectory(file_id, name, parent))
1899
elif kind == 'file':
1900
inv.add(InventoryFile(file_id, name, parent))
1901
elif kind == 'symlink':
1902
inv.add(InventoryLink(file_id, name, parent))
1904
raise errors.BzrError("unknown kind %r" % kind)
1905
self._write_inventory(inv)
1907
def _write_basis_inventory(self, xml):
1908
"""Write the basis inventory XML to the basis-inventory file"""
1909
path = self._basis_inventory_name()
1911
self._transport.put_file(path, sio,
1912
mode=self.bzrdir._get_file_mode())
1914
def _reset_data(self):
1915
"""Reset transient data that cannot be revalidated."""
1916
self._inventory_is_modified = False
1917
f = self._transport.get('inventory')
1919
result = self._deserialize(f)
2543
self.branch.unlock()
2546
class WorkingTree3(WorkingTree):
2547
"""This is the Format 3 working tree.
2549
This differs from the base WorkingTree by:
2550
- having its own file lock
2551
- having its own last-revision property.
2553
This is new in bzr 0.8
2557
def _last_revision(self):
2558
"""See Mutable.last_revision."""
1922
self._set_inventory(result, dirty=False)
1924
def _set_root_id(self, file_id):
1925
"""Set the root id for this tree, in a format specific manner.
1927
:param file_id: The file id to assign to the root. It must not be
1928
present in the current inventory or an error will occur. It must
1929
not be None, but rather a valid file id.
1931
inv = self._inventory
1932
orig_root_id = inv.root.file_id
1933
# TODO: it might be nice to exit early if there was nothing
1934
# to do, saving us from trigger a sync on unlock.
1935
self._inventory_is_modified = True
1936
# we preserve the root inventory entry object, but
1937
# unlinkit from the byid index
1938
del inv._byid[inv.root.file_id]
1939
inv.root.file_id = file_id
1940
# and link it into the index with the new changed id.
1941
inv._byid[inv.root.file_id] = inv.root
1942
# and finally update all children to reference the new id.
1943
# XXX: this should be safe to just look at the root.children
1944
# list, not the WHOLE INVENTORY.
1947
if entry.parent_id == orig_root_id:
1948
entry.parent_id = inv.root.file_id
1950
def all_file_ids(self):
1951
"""See Tree.iter_all_file_ids"""
1952
return set(self.inventory)
1954
@needs_tree_write_lock
1955
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1956
"""See MutableTree.set_parent_trees."""
1957
parent_ids = [rev for (rev, tree) in parents_list]
1958
for revision_id in parent_ids:
1959
_mod_revision.check_not_reserved_id(revision_id)
1961
self._check_parents_for_ghosts(parent_ids,
1962
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1964
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1966
if len(parent_ids) == 0:
1967
leftmost_parent_id = _mod_revision.NULL_REVISION
1968
leftmost_parent_tree = None
1970
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1972
if self._change_last_revision(leftmost_parent_id):
1973
if leftmost_parent_tree is None:
1974
# If we don't have a tree, fall back to reading the
1975
# parent tree from the repository.
1976
self._cache_basis_inventory(leftmost_parent_id)
1978
inv = leftmost_parent_tree.inventory
1979
xml = self._create_basis_xml_from_inventory(
1980
leftmost_parent_id, inv)
1981
self._write_basis_inventory(xml)
1982
self._set_merges_from_parent_ids(parent_ids)
1984
def _cache_basis_inventory(self, new_revision):
1985
"""Cache new_revision as the basis inventory."""
1986
# TODO: this should allow the ready-to-use inventory to be passed in,
1987
# as commit already has that ready-to-use [while the format is the
2560
return self._transport.get_bytes('last-revision')
2561
except errors.NoSuchFile:
2562
return _mod_revision.NULL_REVISION
2564
def _change_last_revision(self, revision_id):
2565
"""See WorkingTree._change_last_revision."""
2566
if revision_id is None or revision_id == NULL_REVISION:
2568
self._transport.delete('last-revision')
2569
except errors.NoSuchFile:
2573
self._transport.put_bytes('last-revision', revision_id,
2574
mode=self._control_files._file_mode)
1990
# this double handles the inventory - unpack and repack -
1991
# but is easier to understand. We can/should put a conditional
1992
# in here based on whether the inventory is in the latest format
1993
# - perhaps we should repack all inventories on a repository
1995
# the fast path is to copy the raw xml from the repository. If the
1996
# xml contains 'revision_id="', then we assume the right
1997
# revision_id is set. We must check for this full string, because a
1998
# root node id can legitimately look like 'revision_id' but cannot
2000
xml = self.branch.repository._get_inventory_xml(new_revision)
2001
firstline = xml.split('\n', 1)[0]
2002
if (not 'revision_id="' in firstline or
2003
'format="7"' not in firstline):
2004
inv = self.branch.repository._serializer.read_inventory_from_string(
2006
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2007
self._write_basis_inventory(xml)
2008
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2011
def _basis_inventory_name(self):
2012
return 'basis-inventory-cache'
2014
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2015
"""Create the text that will be saved in basis-inventory"""
2016
inventory.revision_id = revision_id
2017
return xml7.serializer_v7.write_inventory_to_string(inventory)
2577
2019
@needs_tree_write_lock
2578
2020
def set_conflicts(self, conflicts):
2579
self._put_rio('conflicts', conflicts.to_stanzas(),
2021
self._put_rio('conflicts', conflicts.to_stanzas(),
2580
2022
CONFLICT_HEADER_1)
2582
2024
@needs_tree_write_lock
2593
2035
except errors.NoSuchFile:
2594
2036
return _mod_conflicts.ConflictList()
2596
if confile.next() != CONFLICT_HEADER_1 + '\n':
2039
if confile.next() != CONFLICT_HEADER_1 + '\n':
2040
raise errors.ConflictFormatError()
2041
except StopIteration:
2597
2042
raise errors.ConflictFormatError()
2598
except StopIteration:
2599
raise errors.ConflictFormatError()
2600
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2603
# do non-implementation specific cleanup
2605
if self._control_files._lock_count == 1:
2606
# _inventory_is_modified is always False during a read lock.
2607
if self._inventory_is_modified:
2609
self._write_hashcache_if_dirty()
2610
# reverse order of locking.
2612
return self._control_files.unlock()
2614
self.branch.unlock()
2617
def get_conflicted_stem(path):
2618
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2619
if path.endswith(suffix):
2620
return path[:-len(suffix)]
2623
class WorkingTreeFormat(object):
2043
reader = _mod_rio.RioReader(confile)
2044
return _mod_conflicts.ConflictList.from_stanzas(reader)
2048
def read_basis_inventory(self):
2049
"""Read the cached basis inventory."""
2050
path = self._basis_inventory_name()
2051
return self._transport.get_bytes(path)
2054
def read_working_inventory(self):
2055
"""Read the working inventory.
2057
:raises errors.InventoryModified: read_working_inventory will fail
2058
when the current in memory inventory has been modified.
2060
# conceptually this should be an implementation detail of the tree.
2061
# XXX: Deprecate this.
2062
# ElementTree does its own conversion from UTF-8, so open in
2064
if self._inventory_is_modified:
2065
raise errors.InventoryModified(self)
2066
f = self._transport.get('inventory')
2068
result = self._deserialize(f)
2071
self._set_inventory(result, dirty=False)
2075
def get_root_id(self):
2076
"""Return the id of this trees root"""
2077
return self._inventory.root.file_id
2079
def has_id(self, file_id):
2080
# files that have been deleted are excluded
2081
inv = self.inventory
2082
if not inv.has_id(file_id):
2084
path = inv.id2path(file_id)
2085
return osutils.lexists(self.abspath(path))
2087
def has_or_had_id(self, file_id):
2088
if file_id == self.inventory.root.file_id:
2090
return self.inventory.has_id(file_id)
2092
__contains__ = has_id
2094
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2096
"""Iterate through file_ids for this tree.
2098
file_ids are in a WorkingTree if they are in the working inventory
2099
and the working file exists.
2101
inv = self._inventory
2102
for path, ie in inv.iter_entries():
2103
if osutils.lexists(self.abspath(path)):
2106
@needs_tree_write_lock
2107
def set_last_revision(self, new_revision):
2108
"""Change the last revision in the working tree."""
2109
if self._change_last_revision(new_revision):
2110
self._cache_basis_inventory(new_revision)
2112
def _get_check_refs(self):
2113
"""Return the references needed to perform a check of this tree.
2115
The default implementation returns no refs, and is only suitable for
2116
trees that have no local caching and can commit on ghosts at any time.
2118
:seealso: bzrlib.check for details about check_refs.
2123
def _check(self, references):
2124
"""Check the tree for consistency.
2126
:param references: A dict with keys matching the items returned by
2127
self._get_check_refs(), and values from looking those keys up in
2130
tree_basis = self.basis_tree()
2131
tree_basis.lock_read()
2133
repo_basis = references[('trees', self.last_revision())]
2134
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2135
raise errors.BzrCheckError(
2136
"Mismatched basis inventory content.")
2142
def check_state(self):
2143
"""Check that the working state is/isn't valid."""
2144
check_refs = self._get_check_refs()
2146
for ref in check_refs:
2149
refs[ref] = self.branch.repository.revision_tree(value)
2152
@needs_tree_write_lock
2153
def reset_state(self, revision_ids=None):
2154
"""Reset the state of the working tree.
2156
This does a hard-reset to a last-known-good state. This is a way to
2157
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2159
if revision_ids is None:
2160
revision_ids = self.get_parent_ids()
2161
if not revision_ids:
2162
rt = self.branch.repository.revision_tree(
2163
_mod_revision.NULL_REVISION)
2165
rt = self.branch.repository.revision_tree(revision_ids[0])
2166
self._write_inventory(rt.inventory)
2167
self.set_parent_ids(revision_ids)
2170
"""Write the in memory inventory to disk."""
2171
# TODO: Maybe this should only write on dirty ?
2172
if self._control_files._lock_mode != 'w':
2173
raise errors.NotWriteLocked(self)
2175
self._serialize(self._inventory, sio)
2177
self._transport.put_file('inventory', sio,
2178
mode=self.bzrdir._get_file_mode())
2179
self._inventory_is_modified = False
2182
def get_file_sha1(self, file_id, path=None, stat_value=None):
2184
path = self._inventory.id2path(file_id)
2185
return self._hashcache.get_sha1(path, stat_value)
2187
def get_file_mtime(self, file_id, path=None):
2188
"""See Tree.get_file_mtime."""
2190
path = self.inventory.id2path(file_id)
2191
return os.lstat(self.abspath(path)).st_mtime
2193
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2194
file_id = self.path2id(path)
2196
# For unversioned files on win32, we just assume they are not
2199
return self._inventory[file_id].executable
2201
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2202
mode = stat_result.st_mode
2203
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2205
if not supports_executable():
2206
def is_executable(self, file_id, path=None):
2207
return self._inventory[file_id].executable
2209
_is_executable_from_path_and_stat = \
2210
_is_executable_from_path_and_stat_from_basis
2212
def is_executable(self, file_id, path=None):
2214
path = self.id2path(file_id)
2215
mode = os.lstat(self.abspath(path)).st_mode
2216
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2218
_is_executable_from_path_and_stat = \
2219
_is_executable_from_path_and_stat_from_stat
2221
@needs_tree_write_lock
2222
def _add(self, files, ids, kinds):
2223
"""See MutableTree._add."""
2224
# TODO: Re-adding a file that is removed in the working copy
2225
# should probably put it back with the previous ID.
2226
# the read and write working inventory should not occur in this
2227
# function - they should be part of lock_write and unlock.
2228
inv = self.inventory
2229
for f, file_id, kind in zip(files, ids, kinds):
2231
inv.add_path(f, kind=kind)
2233
inv.add_path(f, kind=kind, file_id=file_id)
2234
self._inventory_is_modified = True
2236
def revision_tree(self, revision_id):
2237
"""See WorkingTree.revision_id."""
2238
if revision_id == self.last_revision():
2240
xml = self.read_basis_inventory()
2241
except errors.NoSuchFile:
2245
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2246
# dont use the repository revision_tree api because we want
2247
# to supply the inventory.
2248
if inv.revision_id == revision_id:
2249
return revisiontree.InventoryRevisionTree(
2250
self.branch.repository, inv, revision_id)
2251
except errors.BadInventoryFormat:
2253
# raise if there was no inventory, or if we read the wrong inventory.
2254
raise errors.NoSuchRevisionInTree(self, revision_id)
2257
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2258
"""See Tree.annotate_iter
2260
This implementation will use the basis tree implementation if possible.
2261
Lines not in the basis are attributed to CURRENT_REVISION
2263
If there are pending merges, lines added by those merges will be
2264
incorrectly attributed to CURRENT_REVISION (but after committing, the
2265
attribution will be correct).
2267
maybe_file_parent_keys = []
2268
for parent_id in self.get_parent_ids():
2270
parent_tree = self.revision_tree(parent_id)
2271
except errors.NoSuchRevisionInTree:
2272
parent_tree = self.branch.repository.revision_tree(parent_id)
2273
parent_tree.lock_read()
2275
if file_id not in parent_tree:
2277
ie = parent_tree.inventory[file_id]
2278
if ie.kind != 'file':
2279
# Note: this is slightly unnecessary, because symlinks and
2280
# directories have a "text" which is the empty text, and we
2281
# know that won't mess up annotations. But it seems cleaner
2283
parent_text_key = (file_id, ie.revision)
2284
if parent_text_key not in maybe_file_parent_keys:
2285
maybe_file_parent_keys.append(parent_text_key)
2287
parent_tree.unlock()
2288
graph = _mod_graph.Graph(self.branch.repository.texts)
2289
heads = graph.heads(maybe_file_parent_keys)
2290
file_parent_keys = []
2291
for key in maybe_file_parent_keys:
2293
file_parent_keys.append(key)
2295
# Now we have the parents of this content
2296
annotator = self.branch.repository.texts.get_annotator()
2297
text = self.get_file_text(file_id)
2298
this_key =(file_id, default_revision)
2299
annotator.add_special_text(this_key, file_parent_keys, text)
2300
annotations = [(key[-1], line)
2301
for key, line in annotator.annotate_flat(this_key)]
2305
def merge_modified(self):
2306
"""Return a dictionary of files modified by a merge.
2308
The list is initialized by WorkingTree.set_merge_modified, which is
2309
typically called after we make some automatic updates to the tree
2312
This returns a map of file_id->sha1, containing only files which are
2313
still in the working inventory and have that text hash.
2316
hashfile = self._transport.get('merge-hashes')
2317
except errors.NoSuchFile:
2322
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2323
raise errors.MergeModifiedFormatError()
2324
except StopIteration:
2325
raise errors.MergeModifiedFormatError()
2326
for s in _mod_rio.RioReader(hashfile):
2327
# RioReader reads in Unicode, so convert file_ids back to utf8
2328
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2329
if file_id not in self.inventory:
2331
text_hash = s.get("hash")
2332
if text_hash == self.get_file_sha1(file_id):
2333
merge_hashes[file_id] = text_hash
2339
def subsume(self, other_tree):
2340
def add_children(inventory, entry):
2341
for child_entry in entry.children.values():
2342
inventory._byid[child_entry.file_id] = child_entry
2343
if child_entry.kind == 'directory':
2344
add_children(inventory, child_entry)
2345
if other_tree.get_root_id() == self.get_root_id():
2346
raise errors.BadSubsumeSource(self, other_tree,
2347
'Trees have the same root')
2349
other_tree_path = self.relpath(other_tree.basedir)
2350
except errors.PathNotChild:
2351
raise errors.BadSubsumeSource(self, other_tree,
2352
'Tree is not contained by the other')
2353
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2354
if new_root_parent is None:
2355
raise errors.BadSubsumeSource(self, other_tree,
2356
'Parent directory is not versioned.')
2357
# We need to ensure that the result of a fetch will have a
2358
# versionedfile for the other_tree root, and only fetching into
2359
# RepositoryKnit2 guarantees that.
2360
if not self.branch.repository.supports_rich_root():
2361
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2362
other_tree.lock_tree_write()
2364
new_parents = other_tree.get_parent_ids()
2365
other_root = other_tree.inventory.root
2366
other_root.parent_id = new_root_parent
2367
other_root.name = osutils.basename(other_tree_path)
2368
self.inventory.add(other_root)
2369
add_children(self.inventory, other_root)
2370
self._write_inventory(self.inventory)
2371
# normally we don't want to fetch whole repositories, but i think
2372
# here we really do want to consolidate the whole thing.
2373
for parent_id in other_tree.get_parent_ids():
2374
self.branch.fetch(other_tree.branch, parent_id)
2375
self.add_parent_tree_id(parent_id)
2378
other_tree.bzrdir.retire_bzrdir()
2380
@needs_tree_write_lock
2381
def extract(self, file_id, format=None):
2382
"""Extract a subtree from this tree.
2384
A new branch will be created, relative to the path for this tree.
2388
segments = osutils.splitpath(path)
2389
transport = self.branch.bzrdir.root_transport
2390
for name in segments:
2391
transport = transport.clone(name)
2392
transport.ensure_base()
2395
sub_path = self.id2path(file_id)
2396
branch_transport = mkdirs(sub_path)
2398
format = self.bzrdir.cloning_metadir()
2399
branch_transport.ensure_base()
2400
branch_bzrdir = format.initialize_on_transport(branch_transport)
2402
repo = branch_bzrdir.find_repository()
2403
except errors.NoRepositoryPresent:
2404
repo = branch_bzrdir.create_repository()
2405
if not repo.supports_rich_root():
2406
raise errors.RootNotRich()
2407
new_branch = branch_bzrdir.create_branch()
2408
new_branch.pull(self.branch)
2409
for parent_id in self.get_parent_ids():
2410
new_branch.fetch(self.branch, parent_id)
2411
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2412
if tree_transport.base != branch_transport.base:
2413
tree_bzrdir = format.initialize_on_transport(tree_transport)
2414
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2415
target_branch=new_branch)
2417
tree_bzrdir = branch_bzrdir
2418
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2419
wt.set_parent_ids(self.get_parent_ids())
2420
my_inv = self.inventory
2421
child_inv = inventory.Inventory(root_id=None)
2422
new_root = my_inv[file_id]
2423
my_inv.remove_recursive_id(file_id)
2424
new_root.parent_id = None
2425
child_inv.add(new_root)
2426
self._write_inventory(my_inv)
2427
wt._write_inventory(child_inv)
2430
def list_files(self, include_root=False, from_dir=None, recursive=True):
2431
"""List all files as (path, class, kind, id, entry).
2433
Lists, but does not descend into unversioned directories.
2434
This does not include files that have been deleted in this
2435
tree. Skips the control directory.
2437
:param include_root: if True, return an entry for the root
2438
:param from_dir: start from this directory or None for the root
2439
:param recursive: whether to recurse into subdirectories or not
2441
# list_files is an iterator, so @needs_read_lock doesn't work properly
2442
# with it. So callers should be careful to always read_lock the tree.
2443
if not self.is_locked():
2444
raise errors.ObjectNotLocked(self)
2446
inv = self.inventory
2447
if from_dir is None and include_root is True:
2448
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2449
# Convert these into local objects to save lookup times
2450
pathjoin = osutils.pathjoin
2451
file_kind = self._kind
2453
# transport.base ends in a slash, we want the piece
2454
# between the last two slashes
2455
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2457
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2459
# directory file_id, relative path, absolute path, reverse sorted children
2460
if from_dir is not None:
2461
from_dir_id = inv.path2id(from_dir)
2462
if from_dir_id is None:
2463
# Directory not versioned
2465
from_dir_abspath = pathjoin(self.basedir, from_dir)
2467
from_dir_id = inv.root.file_id
2468
from_dir_abspath = self.basedir
2469
children = os.listdir(from_dir_abspath)
2471
# jam 20060527 The kernel sized tree seems equivalent whether we
2472
# use a deque and popleft to keep them sorted, or if we use a plain
2473
# list and just reverse() them.
2474
children = collections.deque(children)
2475
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2477
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2480
f = children.popleft()
2481
## TODO: If we find a subdirectory with its own .bzr
2482
## directory, then that is a separate tree and we
2483
## should exclude it.
2485
# the bzrdir for this tree
2486
if transport_base_dir == f:
2489
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2490
# and 'f' doesn't begin with one, we can do a string op, rather
2491
# than the checks of pathjoin(), all relative paths will have an extra slash
2493
fp = from_dir_relpath + '/' + f
2496
fap = from_dir_abspath + '/' + f
2498
dir_ie = inv[from_dir_id]
2499
if dir_ie.kind == 'directory':
2500
f_ie = dir_ie.children.get(f)
2505
elif self.is_ignored(fp[1:]):
2508
# we may not have found this file, because of a unicode
2509
# issue, or because the directory was actually a symlink.
2510
f_norm, can_access = osutils.normalized_filename(f)
2511
if f == f_norm or not can_access:
2512
# No change, so treat this file normally
2515
# this file can be accessed by a normalized path
2516
# check again if it is versioned
2517
# these lines are repeated here for performance
2519
fp = from_dir_relpath + '/' + f
2520
fap = from_dir_abspath + '/' + f
2521
f_ie = inv.get_child(from_dir_id, f)
2524
elif self.is_ignored(fp[1:]):
2531
# make a last minute entry
2533
yield fp[1:], c, fk, f_ie.file_id, f_ie
2536
yield fp[1:], c, fk, None, fk_entries[fk]()
2538
yield fp[1:], c, fk, None, TreeEntry()
2541
if fk != 'directory':
2544
# But do this child first if recursing down
2546
new_children = os.listdir(fap)
2548
new_children = collections.deque(new_children)
2549
stack.append((f_ie.file_id, fp, fap, new_children))
2550
# Break out of inner loop,
2551
# so that we start outer loop with child
2554
# if we finished all children, pop it off the stack
2557
@needs_tree_write_lock
2558
def move(self, from_paths, to_dir=None, after=False):
2561
to_dir must exist in the inventory.
2563
If to_dir exists and is a directory, the files are moved into
2564
it, keeping their old names.
2566
Note that to_dir is only the last component of the new name;
2567
this doesn't change the directory.
2569
For each entry in from_paths the move mode will be determined
2572
The first mode moves the file in the filesystem and updates the
2573
inventory. The second mode only updates the inventory without
2574
touching the file on the filesystem.
2576
move uses the second mode if 'after == True' and the target is not
2577
versioned but present in the working tree.
2579
move uses the second mode if 'after == False' and the source is
2580
versioned but no longer in the working tree, and the target is not
2581
versioned but present in the working tree.
2583
move uses the first mode if 'after == False' and the source is
2584
versioned and present in the working tree, and the target is not
2585
versioned and not present in the working tree.
2587
Everything else results in an error.
2589
This returns a list of (from_path, to_path) pairs for each
2590
entry that is moved.
2595
# check for deprecated use of signature
2597
raise TypeError('You must supply a target directory')
2598
# check destination directory
2599
if isinstance(from_paths, basestring):
2601
inv = self.inventory
2602
to_abs = self.abspath(to_dir)
2603
if not isdir(to_abs):
2604
raise errors.BzrMoveFailedError('',to_dir,
2605
errors.NotADirectory(to_abs))
2606
if not self.has_filename(to_dir):
2607
raise errors.BzrMoveFailedError('',to_dir,
2608
errors.NotInWorkingDirectory(to_dir))
2609
to_dir_id = inv.path2id(to_dir)
2610
if to_dir_id is None:
2611
raise errors.BzrMoveFailedError('',to_dir,
2612
errors.NotVersionedError(path=to_dir))
2614
to_dir_ie = inv[to_dir_id]
2615
if to_dir_ie.kind != 'directory':
2616
raise errors.BzrMoveFailedError('',to_dir,
2617
errors.NotADirectory(to_abs))
2619
# create rename entries and tuples
2620
for from_rel in from_paths:
2621
from_tail = splitpath(from_rel)[-1]
2622
from_id = inv.path2id(from_rel)
2624
raise errors.BzrMoveFailedError(from_rel,to_dir,
2625
errors.NotVersionedError(path=from_rel))
2627
from_entry = inv[from_id]
2628
from_parent_id = from_entry.parent_id
2629
to_rel = pathjoin(to_dir, from_tail)
2630
rename_entry = InventoryWorkingTree._RenameEntry(
2633
from_tail=from_tail,
2634
from_parent_id=from_parent_id,
2635
to_rel=to_rel, to_tail=from_tail,
2636
to_parent_id=to_dir_id)
2637
rename_entries.append(rename_entry)
2638
rename_tuples.append((from_rel, to_rel))
2640
# determine which move mode to use. checks also for movability
2641
rename_entries = self._determine_mv_mode(rename_entries, after)
2643
original_modified = self._inventory_is_modified
2646
self._inventory_is_modified = True
2647
self._move(rename_entries)
2649
# restore the inventory on error
2650
self._inventory_is_modified = original_modified
2652
self._write_inventory(inv)
2653
return rename_tuples
2655
@needs_tree_write_lock
2656
def rename_one(self, from_rel, to_rel, after=False):
2659
This can change the directory or the filename or both.
2661
rename_one has several 'modes' to work. First, it can rename a physical
2662
file and change the file_id. That is the normal mode. Second, it can
2663
only change the file_id without touching any physical file.
2665
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2666
versioned but present in the working tree.
2668
rename_one uses the second mode if 'after == False' and 'from_rel' is
2669
versioned but no longer in the working tree, and 'to_rel' is not
2670
versioned but present in the working tree.
2672
rename_one uses the first mode if 'after == False' and 'from_rel' is
2673
versioned and present in the working tree, and 'to_rel' is not
2674
versioned and not present in the working tree.
2676
Everything else results in an error.
2678
inv = self.inventory
2681
# create rename entries and tuples
2682
from_tail = splitpath(from_rel)[-1]
2683
from_id = inv.path2id(from_rel)
2685
# if file is missing in the inventory maybe it's in the basis_tree
2686
basis_tree = self.branch.basis_tree()
2687
from_id = basis_tree.path2id(from_rel)
2689
raise errors.BzrRenameFailedError(from_rel,to_rel,
2690
errors.NotVersionedError(path=from_rel))
2691
# put entry back in the inventory so we can rename it
2692
from_entry = basis_tree.inventory[from_id].copy()
2695
from_entry = inv[from_id]
2696
from_parent_id = from_entry.parent_id
2697
to_dir, to_tail = os.path.split(to_rel)
2698
to_dir_id = inv.path2id(to_dir)
2699
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2701
from_tail=from_tail,
2702
from_parent_id=from_parent_id,
2703
to_rel=to_rel, to_tail=to_tail,
2704
to_parent_id=to_dir_id)
2705
rename_entries.append(rename_entry)
2707
# determine which move mode to use. checks also for movability
2708
rename_entries = self._determine_mv_mode(rename_entries, after)
2710
# check if the target changed directory and if the target directory is
2712
if to_dir_id is None:
2713
raise errors.BzrMoveFailedError(from_rel,to_rel,
2714
errors.NotVersionedError(path=to_dir))
2716
# all checks done. now we can continue with our actual work
2717
mutter('rename_one:\n'
2722
' to_dir_id {%s}\n',
2723
from_id, from_rel, to_rel, to_dir, to_dir_id)
2725
self._move(rename_entries)
2726
self._write_inventory(inv)
2728
class _RenameEntry(object):
2729
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2730
to_rel, to_tail, to_parent_id, only_change_inv=False):
2731
self.from_rel = from_rel
2732
self.from_id = from_id
2733
self.from_tail = from_tail
2734
self.from_parent_id = from_parent_id
2735
self.to_rel = to_rel
2736
self.to_tail = to_tail
2737
self.to_parent_id = to_parent_id
2738
self.only_change_inv = only_change_inv
2740
def _determine_mv_mode(self, rename_entries, after=False):
2741
"""Determines for each from-to pair if both inventory and working tree
2742
or only the inventory has to be changed.
2744
Also does basic plausability tests.
2746
inv = self.inventory
2748
for rename_entry in rename_entries:
2749
# store to local variables for easier reference
2750
from_rel = rename_entry.from_rel
2751
from_id = rename_entry.from_id
2752
to_rel = rename_entry.to_rel
2753
to_id = inv.path2id(to_rel)
2754
only_change_inv = False
2756
# check the inventory for source and destination
2758
raise errors.BzrMoveFailedError(from_rel,to_rel,
2759
errors.NotVersionedError(path=from_rel))
2760
if to_id is not None:
2761
raise errors.BzrMoveFailedError(from_rel,to_rel,
2762
errors.AlreadyVersionedError(path=to_rel))
2764
# try to determine the mode for rename (only change inv or change
2765
# inv and file system)
2767
if not self.has_filename(to_rel):
2768
raise errors.BzrMoveFailedError(from_id,to_rel,
2769
errors.NoSuchFile(path=to_rel,
2770
extra="New file has not been created yet"))
2771
only_change_inv = True
2772
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2773
only_change_inv = True
2774
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2775
only_change_inv = False
2776
elif (not self.case_sensitive
2777
and from_rel.lower() == to_rel.lower()
2778
and self.has_filename(from_rel)):
2779
only_change_inv = False
2781
# something is wrong, so lets determine what exactly
2782
if not self.has_filename(from_rel) and \
2783
not self.has_filename(to_rel):
2784
raise errors.BzrRenameFailedError(from_rel,to_rel,
2785
errors.PathsDoNotExist(paths=(str(from_rel),
2788
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2789
rename_entry.only_change_inv = only_change_inv
2790
return rename_entries
2792
def _move(self, rename_entries):
2793
"""Moves a list of files.
2795
Depending on the value of the flag 'only_change_inv', the
2796
file will be moved on the file system or not.
2798
inv = self.inventory
2801
for entry in rename_entries:
2803
self._move_entry(entry)
2805
self._rollback_move(moved)
2809
def _rollback_move(self, moved):
2810
"""Try to rollback a previous move in case of an filesystem error."""
2811
inv = self.inventory
2814
self._move_entry(WorkingTree._RenameEntry(
2815
entry.to_rel, entry.from_id,
2816
entry.to_tail, entry.to_parent_id, entry.from_rel,
2817
entry.from_tail, entry.from_parent_id,
2818
entry.only_change_inv))
2819
except errors.BzrMoveFailedError, e:
2820
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2821
" The working tree is in an inconsistent state."
2822
" Please consider doing a 'bzr revert'."
2823
" Error message is: %s" % e)
2825
def _move_entry(self, entry):
2826
inv = self.inventory
2827
from_rel_abs = self.abspath(entry.from_rel)
2828
to_rel_abs = self.abspath(entry.to_rel)
2829
if from_rel_abs == to_rel_abs:
2830
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2831
"Source and target are identical.")
2833
if not entry.only_change_inv:
2835
osutils.rename(from_rel_abs, to_rel_abs)
2837
raise errors.BzrMoveFailedError(entry.from_rel,
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 file_id not in self._inventory:
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):
2624
2985
"""An encapsulation of the initialization and open routines for a format.
2626
2987
Formats provide three things:
2684
3071
"""Is this format supported?
2686
3073
Supported formats can be initialized and opened.
2687
Unsupported formats may not support initialization or committing or
3074
Unsupported formats may not support initialization or committing or
2688
3075
some other features depending on the reason for not being supported.
3079
def supports_content_filtering(self):
3080
"""True if this format supports content filtering."""
3083
def supports_views(self):
3084
"""True if this format supports stored views."""
3088
@symbol_versioning.deprecated_method(
3089
symbol_versioning.deprecated_in((2, 4, 0)))
2693
3090
def register_format(klass, format):
2694
klass._formats[format.get_format_string()] = format
3091
format_registry.register(format)
3094
@symbol_versioning.deprecated_method(
3095
symbol_versioning.deprecated_in((2, 4, 0)))
3096
def register_extra_format(klass, format):
3097
format_registry.register_extra(format)
3100
@symbol_versioning.deprecated_method(
3101
symbol_versioning.deprecated_in((2, 4, 0)))
3102
def unregister_extra_format(klass, format):
3103
format_registry.unregister_extra(format)
3106
@symbol_versioning.deprecated_method(
3107
symbol_versioning.deprecated_in((2, 4, 0)))
3108
def get_formats(klass):
3109
return format_registry._get_all()
3112
@symbol_versioning.deprecated_method(
3113
symbol_versioning.deprecated_in((2, 4, 0)))
2697
3114
def set_default_format(klass, format):
2698
klass._default_format = format
3115
format_registry.set_default(format)
3118
@symbol_versioning.deprecated_method(
3119
symbol_versioning.deprecated_in((2, 4, 0)))
2701
3120
def unregister_format(klass, format):
2702
del klass._formats[format.get_format_string()]
2705
class WorkingTreeFormat2(WorkingTreeFormat):
2706
"""The second working tree format.
2708
This format modified the hash cache from the format 1 hash cache.
2711
upgrade_recommended = True
2713
def get_format_description(self):
2714
"""See WorkingTreeFormat.get_format_description()."""
2715
return "Working tree format 2"
2717
def _stub_initialize_on_transport(self, transport, file_mode):
2718
"""Workaround: create control files for a remote working tree.
2720
This ensures that it can later be updated and dealt with locally,
2721
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2722
no working tree. (See bug #43064).
2726
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2728
transport.put_file('inventory', sio, file_mode)
2729
transport.put_bytes('pending-merges', '', file_mode)
2731
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2732
accelerator_tree=None, hardlink=False):
2733
"""See WorkingTreeFormat.initialize()."""
2734
if not isinstance(a_bzrdir.transport, LocalTransport):
2735
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2736
if from_branch is not None:
2737
branch = from_branch
2739
branch = a_bzrdir.open_branch()
2740
if revision_id is None:
2741
revision_id = _mod_revision.ensure_null(branch.last_revision())
2744
branch.generate_revision_history(revision_id)
2748
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2754
basis_tree = branch.repository.revision_tree(revision_id)
2755
if basis_tree.inventory.root is not None:
2756
wt.set_root_id(basis_tree.get_root_id())
2757
# set the parent list and cache the basis tree.
2758
if _mod_revision.is_null(revision_id):
2761
parent_trees = [(revision_id, basis_tree)]
2762
wt.set_parent_trees(parent_trees)
2763
transform.build_tree(basis_tree, wt)
2767
super(WorkingTreeFormat2, self).__init__()
2768
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2770
def open(self, a_bzrdir, _found=False):
2771
"""Return the WorkingTree object for a_bzrdir
2773
_found is a private parameter, do not use it. It is used to indicate
2774
if format probing has already been done.
2777
# we are being called directly and must probe.
2778
raise NotImplementedError
2779
if not isinstance(a_bzrdir.transport, LocalTransport):
2780
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2781
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2787
class WorkingTreeFormat3(WorkingTreeFormat):
2788
"""The second working tree format updated to record a format marker.
2791
- exists within a metadir controlling .bzr
2792
- includes an explicit version marker for the workingtree control
2793
files, separate from the BzrDir format
2794
- modifies the hash cache format
2796
- uses a LockDir to guard access for writes.
2799
upgrade_recommended = True
2801
def get_format_string(self):
2802
"""See WorkingTreeFormat.get_format_string()."""
2803
return "Bazaar-NG Working Tree format 3"
2805
def get_format_description(self):
2806
"""See WorkingTreeFormat.get_format_description()."""
2807
return "Working tree format 3"
2809
_lock_file_name = 'lock'
2810
_lock_class = LockDir
2812
_tree_class = WorkingTree3
2814
def __get_matchingbzrdir(self):
2815
return bzrdir.BzrDirMetaFormat1()
2817
_matchingbzrdir = property(__get_matchingbzrdir)
2819
def _open_control_files(self, a_bzrdir):
2820
transport = a_bzrdir.get_workingtree_transport(None)
2821
return LockableFiles(transport, self._lock_file_name,
2824
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2825
accelerator_tree=None, hardlink=False):
2826
"""See WorkingTreeFormat.initialize().
2828
:param revision_id: if supplied, create a working tree at a different
2829
revision than the branch is at.
2830
:param accelerator_tree: A tree which can be used for retrieving file
2831
contents more quickly than the revision tree, i.e. a workingtree.
2832
The revision tree will be used for cases where accelerator_tree's
2833
content is different.
2834
:param hardlink: If true, hard-link files from accelerator_tree,
2837
if not isinstance(a_bzrdir.transport, LocalTransport):
2838
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2839
transport = a_bzrdir.get_workingtree_transport(self)
2840
control_files = self._open_control_files(a_bzrdir)
2841
control_files.create_lock()
2842
control_files.lock_write()
2843
transport.put_bytes('format', self.get_format_string(),
2844
mode=control_files._file_mode)
2845
if from_branch is not None:
2846
branch = from_branch
2848
branch = a_bzrdir.open_branch()
2849
if revision_id is None:
2850
revision_id = _mod_revision.ensure_null(branch.last_revision())
2851
# WorkingTree3 can handle an inventory which has a unique root id.
2852
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2853
# those trees. And because there isn't a format bump inbetween, we
2854
# are maintaining compatibility with older clients.
2855
# inv = Inventory(root_id=gen_root_id())
2856
inv = self._initial_inventory()
2857
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2863
_control_files=control_files)
2864
wt.lock_tree_write()
2866
basis_tree = branch.repository.revision_tree(revision_id)
2867
# only set an explicit root id if there is one to set.
2868
if basis_tree.inventory.root is not None:
2869
wt.set_root_id(basis_tree.get_root_id())
2870
if revision_id == NULL_REVISION:
2871
wt.set_parent_trees([])
2873
wt.set_parent_trees([(revision_id, basis_tree)])
2874
transform.build_tree(basis_tree, wt)
2876
# Unlock in this order so that the unlock-triggers-flush in
2877
# WorkingTree is given a chance to fire.
2878
control_files.unlock()
2882
def _initial_inventory(self):
2886
super(WorkingTreeFormat3, self).__init__()
2888
def open(self, a_bzrdir, _found=False):
2889
"""Return the WorkingTree object for a_bzrdir
2891
_found is a private parameter, do not use it. It is used to indicate
2892
if format probing has already been done.
2895
# we are being called directly and must probe.
2896
raise NotImplementedError
2897
if not isinstance(a_bzrdir.transport, LocalTransport):
2898
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2899
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2902
def _open(self, a_bzrdir, control_files):
2903
"""Open the tree itself.
2905
:param a_bzrdir: the dir for the tree.
2906
:param control_files: the control files for the tree.
2908
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2912
_control_files=control_files)
2915
return self.get_format_string()
2918
__default_format = WorkingTreeFormat4()
2919
WorkingTreeFormat.register_format(__default_format)
2920
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2921
WorkingTreeFormat.set_default_format(__default_format)
2922
# formats which have no format string are not discoverable
2923
# and not independently creatable, so are not registered.
2924
_legacy_formats = [WorkingTreeFormat2(),
3121
format_registry.remove(format)
3124
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3125
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3126
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3127
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3128
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3129
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3130
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3131
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3132
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
