1015
861
# checkout in a subdirectory. This can be avoided by not adding
1016
862
# it. mbp 20070306
1018
@needs_tree_write_lock
1019
864
def extract(self, file_id, format=None):
1020
865
"""Extract a subtree from this tree.
1022
867
A new branch will be created, relative to the path for this tree.
1026
segments = osutils.splitpath(path)
1027
transport = self.branch.bzrdir.root_transport
1028
for name in segments:
1029
transport = transport.clone(name)
1030
transport.ensure_base()
1033
sub_path = self.id2path(file_id)
1034
branch_transport = mkdirs(sub_path)
1036
format = self.bzrdir.cloning_metadir()
1037
branch_transport.ensure_base()
1038
branch_bzrdir = format.initialize_on_transport(branch_transport)
1040
repo = branch_bzrdir.find_repository()
1041
except errors.NoRepositoryPresent:
1042
repo = branch_bzrdir.create_repository()
1043
if not repo.supports_rich_root():
1044
raise errors.RootNotRich()
1045
new_branch = branch_bzrdir.create_branch()
1046
new_branch.pull(self.branch)
1047
for parent_id in self.get_parent_ids():
1048
new_branch.fetch(self.branch, parent_id)
1049
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1050
if tree_transport.base != branch_transport.base:
1051
tree_bzrdir = format.initialize_on_transport(tree_transport)
1052
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1054
tree_bzrdir = branch_bzrdir
1055
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1056
wt.set_parent_ids(self.get_parent_ids())
1057
my_inv = self.inventory
1058
child_inv = Inventory(root_id=None)
1059
new_root = my_inv[file_id]
1060
my_inv.remove_recursive_id(file_id)
1061
new_root.parent_id = None
1062
child_inv.add(new_root)
1063
self._write_inventory(my_inv)
1064
wt._write_inventory(child_inv)
1067
def _serialize(self, inventory, out_file):
1068
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1071
def _deserialize(selt, in_file):
1072
return xml5.serializer_v5.read_inventory(in_file)
869
raise NotImplementedError(self.extract)
1074
871
def flush(self):
1075
"""Write the in memory inventory to disk."""
1076
# TODO: Maybe this should only write on dirty ?
1077
if self._control_files._lock_mode != 'w':
1078
raise errors.NotWriteLocked(self)
1080
self._serialize(self._inventory, sio)
1082
self._transport.put_file('inventory', sio,
1083
mode=self._control_files._file_mode)
1084
self._inventory_is_modified = False
872
"""Write the in memory meta data to disk."""
873
raise NotImplementedError(self.flush)
1086
875
def _kind(self, relpath):
1087
876
return osutils.file_kind(self.abspath(relpath))
1089
def list_files(self, include_root=False):
1090
"""Recursively list all files as (path, class, kind, id, entry).
878
def list_files(self, include_root=False, from_dir=None, recursive=True):
879
"""List all files as (path, class, kind, id, entry).
1092
881
Lists, but does not descend into unversioned directories.
1094
882
This does not include files that have been deleted in this
883
tree. Skips the control directory.
1097
Skips the control directory.
885
:param include_root: if True, return an entry for the root
886
:param from_dir: start from this directory or None for the root
887
:param recursive: whether to recurse into subdirectories or not
1099
# list_files is an iterator, so @needs_read_lock doesn't work properly
1100
# with it. So callers should be careful to always read_lock the tree.
1101
if not self.is_locked():
1102
raise errors.ObjectNotLocked(self)
1104
inv = self.inventory
1105
if include_root is True:
1106
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1107
# Convert these into local objects to save lookup times
1108
pathjoin = osutils.pathjoin
1109
file_kind = self._kind
1111
# transport.base ends in a slash, we want the piece
1112
# between the last two slashes
1113
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1115
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1117
# directory file_id, relative path, absolute path, reverse sorted children
1118
children = os.listdir(self.basedir)
1120
# jam 20060527 The kernel sized tree seems equivalent whether we
1121
# use a deque and popleft to keep them sorted, or if we use a plain
1122
# list and just reverse() them.
1123
children = collections.deque(children)
1124
stack = [(inv.root.file_id, u'', self.basedir, children)]
1126
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1129
f = children.popleft()
1130
## TODO: If we find a subdirectory with its own .bzr
1131
## directory, then that is a separate tree and we
1132
## should exclude it.
1134
# the bzrdir for this tree
1135
if transport_base_dir == f:
1138
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1139
# and 'f' doesn't begin with one, we can do a string op, rather
1140
# than the checks of pathjoin(), all relative paths will have an extra slash
1142
fp = from_dir_relpath + '/' + f
1145
fap = from_dir_abspath + '/' + f
1147
f_ie = inv.get_child(from_dir_id, f)
1150
elif self.is_ignored(fp[1:]):
1153
# we may not have found this file, because of a unicode issue
1154
f_norm, can_access = osutils.normalized_filename(f)
1155
if f == f_norm or not can_access:
1156
# No change, so treat this file normally
1159
# this file can be accessed by a normalized path
1160
# check again if it is versioned
1161
# these lines are repeated here for performance
1163
fp = from_dir_relpath + '/' + f
1164
fap = from_dir_abspath + '/' + f
1165
f_ie = inv.get_child(from_dir_id, f)
1168
elif self.is_ignored(fp[1:]):
1175
# make a last minute entry
1177
yield fp[1:], c, fk, f_ie.file_id, f_ie
1180
yield fp[1:], c, fk, None, fk_entries[fk]()
1182
yield fp[1:], c, fk, None, TreeEntry()
1185
if fk != 'directory':
1188
# But do this child first
1189
new_children = os.listdir(fap)
1191
new_children = collections.deque(new_children)
1192
stack.append((f_ie.file_id, fp, fap, new_children))
1193
# Break out of inner loop,
1194
# so that we start outer loop with child
1197
# if we finished all children, pop it off the stack
1200
@needs_tree_write_lock
1201
def move(self, from_paths, to_dir=None, after=False, **kwargs):
889
raise NotImplementedError(self.list_files)
891
def move(self, from_paths, to_dir=None, after=False):
1202
892
"""Rename files.
1204
to_dir must exist in the inventory.
894
to_dir must be known to the working tree.
1206
896
If to_dir exists and is a directory, the files are moved into
1207
it, keeping their old names.
897
it, keeping their old names.
1209
899
Note that to_dir is only the last component of the new name;
1210
900
this doesn't change the directory.
2521
1758
return ShelfManager(self, self._transport)
2524
class WorkingTree2(WorkingTree):
2525
"""This is the Format 2 working tree.
2527
This was the first weave based working tree.
2528
- uses os locks for locking.
2529
- uses the branch last-revision.
1761
class InventoryWorkingTree(WorkingTree,
1762
bzrlib.mutabletree.MutableInventoryTree):
1763
"""Base class for working trees that are inventory-oriented.
1765
The inventory is held in the `Branch` working-inventory, and the
1766
files are in a directory on disk.
1768
It is possible for a `WorkingTree` to have a filename which is
1769
not listed in the Inventory and vice versa.
2532
def __init__(self, *args, **kwargs):
2533
super(WorkingTree2, self).__init__(*args, **kwargs)
2534
# WorkingTree2 has more of a constraint that self._inventory must
2535
# exist. Because this is an older format, we don't mind the overhead
2536
# caused by the extra computation here.
2538
# Newer WorkingTree's should only have self._inventory set when they
2540
if self._inventory is None:
2541
self.read_working_inventory()
2543
def lock_tree_write(self):
2544
"""See WorkingTree.lock_tree_write().
2546
In Format2 WorkingTrees we have a single lock for the branch and tree
2547
so lock_tree_write() degrades to lock_write().
2549
self.branch.lock_write()
2551
return self._control_files.lock_write()
2553
self.branch.unlock()
2557
# do non-implementation specific cleanup
2560
# we share control files:
2561
if self._control_files._lock_count == 3:
2562
# _inventory_is_modified is always False during a read lock.
2563
if self._inventory_is_modified:
2565
self._write_hashcache_if_dirty()
2567
# reverse order of locking.
2569
return self._control_files.unlock()
1772
def __init__(self, basedir='.',
1773
branch=DEPRECATED_PARAMETER,
1775
_control_files=None,
1779
"""Construct a InventoryWorkingTree instance. This is not a public API.
1781
:param branch: A branch to override probing for the branch.
1783
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1784
branch=branch, _control_files=_control_files, _internal=_internal,
1785
_format=_format, _bzrdir=_bzrdir)
1787
self._detect_case_handling()
1789
if _inventory is None:
1790
# This will be acquired on lock_read() or lock_write()
1791
self._inventory_is_modified = False
1792
self._inventory = None
1794
# the caller of __init__ has provided an inventory,
1795
# we assume they know what they are doing - as its only
1796
# the Format factory and creation methods that are
1797
# permitted to do this.
1798
self._set_inventory(_inventory, dirty=False)
1800
def _set_inventory(self, inv, dirty):
1801
"""Set the internal cached inventory.
1803
:param inv: The inventory to set.
1804
:param dirty: A boolean indicating whether the inventory is the same
1805
logical inventory as whats on disk. If True the inventory is not
1806
the same and should be written to disk or data will be lost, if
1807
False then the inventory is the same as that on disk and any
1808
serialisation would be unneeded overhead.
1810
self._inventory = inv
1811
self._inventory_is_modified = dirty
1813
def _detect_case_handling(self):
1814
wt_trans = self.bzrdir.get_workingtree_transport(None)
1816
wt_trans.stat(self._format.case_sensitive_filename)
1817
except errors.NoSuchFile:
1818
self.case_sensitive = True
1820
self.case_sensitive = False
1822
self._setup_directory_is_tree_reference()
1824
def _serialize(self, inventory, out_file):
1825
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1828
def _deserialize(selt, in_file):
1829
return xml5.serializer_v5.read_inventory(in_file)
1831
@needs_tree_write_lock
1832
def _write_inventory(self, inv):
1833
"""Write inventory as the current inventory."""
1834
self._set_inventory(inv, dirty=True)
1837
# XXX: This method should be deprecated in favour of taking in a proper
1838
# new Inventory object.
1839
@needs_tree_write_lock
1840
def set_inventory(self, new_inventory_list):
1841
from bzrlib.inventory import (Inventory,
1845
inv = Inventory(self.get_root_id())
1846
for path, file_id, parent, kind in new_inventory_list:
1847
name = os.path.basename(path)
1850
# fixme, there should be a factory function inv,add_??
1851
if kind == 'directory':
1852
inv.add(InventoryDirectory(file_id, name, parent))
1853
elif kind == 'file':
1854
inv.add(InventoryFile(file_id, name, parent))
1855
elif kind == 'symlink':
1856
inv.add(InventoryLink(file_id, name, parent))
1858
raise errors.BzrError("unknown kind %r" % kind)
1859
self._write_inventory(inv)
1861
def _write_basis_inventory(self, xml):
1862
"""Write the basis inventory XML to the basis-inventory file"""
1863
path = self._basis_inventory_name()
1865
self._transport.put_file(path, sio,
1866
mode=self.bzrdir._get_file_mode())
1868
def _reset_data(self):
1869
"""Reset transient data that cannot be revalidated."""
1870
self._inventory_is_modified = False
1871
f = self._transport.get('inventory')
1873
result = self._deserialize(f)
2571
self.branch.unlock()
2574
class WorkingTree3(WorkingTree):
2575
"""This is the Format 3 working tree.
2577
This differs from the base WorkingTree by:
2578
- having its own file lock
2579
- having its own last-revision property.
2581
This is new in bzr 0.8
2585
def _last_revision(self):
2586
"""See Mutable.last_revision."""
1876
self._set_inventory(result, dirty=False)
1878
def _set_root_id(self, file_id):
1879
"""Set the root id for this tree, in a format specific manner.
1881
:param file_id: The file id to assign to the root. It must not be
1882
present in the current inventory or an error will occur. It must
1883
not be None, but rather a valid file id.
1885
inv = self._inventory
1886
orig_root_id = inv.root.file_id
1887
# TODO: it might be nice to exit early if there was nothing
1888
# to do, saving us from trigger a sync on unlock.
1889
self._inventory_is_modified = True
1890
# we preserve the root inventory entry object, but
1891
# unlinkit from the byid index
1892
del inv._byid[inv.root.file_id]
1893
inv.root.file_id = file_id
1894
# and link it into the index with the new changed id.
1895
inv._byid[inv.root.file_id] = inv.root
1896
# and finally update all children to reference the new id.
1897
# XXX: this should be safe to just look at the root.children
1898
# list, not the WHOLE INVENTORY.
1901
if entry.parent_id == orig_root_id:
1902
entry.parent_id = inv.root.file_id
1904
def all_file_ids(self):
1905
"""See Tree.iter_all_file_ids"""
1906
return set(self.inventory)
1908
@needs_tree_write_lock
1909
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1910
"""See MutableTree.set_parent_trees."""
1911
parent_ids = [rev for (rev, tree) in parents_list]
1912
for revision_id in parent_ids:
1913
_mod_revision.check_not_reserved_id(revision_id)
1915
self._check_parents_for_ghosts(parent_ids,
1916
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1918
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1920
if len(parent_ids) == 0:
1921
leftmost_parent_id = _mod_revision.NULL_REVISION
1922
leftmost_parent_tree = None
1924
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1926
if self._change_last_revision(leftmost_parent_id):
1927
if leftmost_parent_tree is None:
1928
# If we don't have a tree, fall back to reading the
1929
# parent tree from the repository.
1930
self._cache_basis_inventory(leftmost_parent_id)
1932
inv = leftmost_parent_tree.inventory
1933
xml = self._create_basis_xml_from_inventory(
1934
leftmost_parent_id, inv)
1935
self._write_basis_inventory(xml)
1936
self._set_merges_from_parent_ids(parent_ids)
1938
def _cache_basis_inventory(self, new_revision):
1939
"""Cache new_revision as the basis inventory."""
1940
# TODO: this should allow the ready-to-use inventory to be passed in,
1941
# as commit already has that ready-to-use [while the format is the
2588
return self._transport.get_bytes('last-revision')
2589
except errors.NoSuchFile:
2590
return _mod_revision.NULL_REVISION
2592
def _change_last_revision(self, revision_id):
2593
"""See WorkingTree._change_last_revision."""
2594
if revision_id is None or revision_id == NULL_REVISION:
2596
self._transport.delete('last-revision')
2597
except errors.NoSuchFile:
2601
self._transport.put_bytes('last-revision', revision_id,
2602
mode=self._control_files._file_mode)
1944
# this double handles the inventory - unpack and repack -
1945
# but is easier to understand. We can/should put a conditional
1946
# in here based on whether the inventory is in the latest format
1947
# - perhaps we should repack all inventories on a repository
1949
# the fast path is to copy the raw xml from the repository. If the
1950
# xml contains 'revision_id="', then we assume the right
1951
# revision_id is set. We must check for this full string, because a
1952
# root node id can legitimately look like 'revision_id' but cannot
1954
xml = self.branch.repository._get_inventory_xml(new_revision)
1955
firstline = xml.split('\n', 1)[0]
1956
if (not 'revision_id="' in firstline or
1957
'format="7"' not in firstline):
1958
inv = self.branch.repository._serializer.read_inventory_from_string(
1960
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1961
self._write_basis_inventory(xml)
1962
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1965
def _basis_inventory_name(self):
1966
return 'basis-inventory-cache'
1968
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1969
"""Create the text that will be saved in basis-inventory"""
1970
inventory.revision_id = revision_id
1971
return xml7.serializer_v7.write_inventory_to_string(inventory)
2605
1973
@needs_tree_write_lock
2606
1974
def set_conflicts(self, conflicts):
2607
self._put_rio('conflicts', conflicts.to_stanzas(),
1975
self._put_rio('conflicts', conflicts.to_stanzas(),
2608
1976
CONFLICT_HEADER_1)
2610
1978
@needs_tree_write_lock
2626
1994
raise errors.ConflictFormatError()
2627
1995
except StopIteration:
2628
1996
raise errors.ConflictFormatError()
2629
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1997
reader = _mod_rio.RioReader(confile)
1998
return _mod_conflicts.ConflictList.from_stanzas(reader)
2631
2000
confile.close()
2634
# do non-implementation specific cleanup
2636
if self._control_files._lock_count == 1:
2637
# _inventory_is_modified is always False during a read lock.
2638
if self._inventory_is_modified:
2640
self._write_hashcache_if_dirty()
2641
# reverse order of locking.
2643
return self._control_files.unlock()
2645
self.branch.unlock()
2648
def get_conflicted_stem(path):
2649
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2650
if path.endswith(suffix):
2651
return path[:-len(suffix)]
2654
class WorkingTreeFormat(object):
2002
def read_basis_inventory(self):
2003
"""Read the cached basis inventory."""
2004
path = self._basis_inventory_name()
2005
return self._transport.get_bytes(path)
2008
def read_working_inventory(self):
2009
"""Read the working inventory.
2011
:raises errors.InventoryModified: read_working_inventory will fail
2012
when the current in memory inventory has been modified.
2014
# conceptually this should be an implementation detail of the tree.
2015
# XXX: Deprecate this.
2016
# ElementTree does its own conversion from UTF-8, so open in
2018
if self._inventory_is_modified:
2019
raise errors.InventoryModified(self)
2020
f = self._transport.get('inventory')
2022
result = self._deserialize(f)
2025
self._set_inventory(result, dirty=False)
2029
def get_root_id(self):
2030
"""Return the id of this trees root"""
2031
return self._inventory.root.file_id
2033
def has_id(self, file_id):
2034
# files that have been deleted are excluded
2035
inv = self.inventory
2036
if not inv.has_id(file_id):
2038
path = inv.id2path(file_id)
2039
return osutils.lexists(self.abspath(path))
2041
def has_or_had_id(self, file_id):
2042
if file_id == self.inventory.root.file_id:
2044
return self.inventory.has_id(file_id)
2046
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2048
"""Iterate through file_ids for this tree.
2050
file_ids are in a WorkingTree if they are in the working inventory
2051
and the working file exists.
2053
inv = self._inventory
2054
for path, ie in inv.iter_entries():
2055
if osutils.lexists(self.abspath(path)):
2058
@needs_tree_write_lock
2059
def set_last_revision(self, new_revision):
2060
"""Change the last revision in the working tree."""
2061
if self._change_last_revision(new_revision):
2062
self._cache_basis_inventory(new_revision)
2064
def _get_check_refs(self):
2065
"""Return the references needed to perform a check of this tree.
2067
The default implementation returns no refs, and is only suitable for
2068
trees that have no local caching and can commit on ghosts at any time.
2070
:seealso: bzrlib.check for details about check_refs.
2075
def _check(self, references):
2076
"""Check the tree for consistency.
2078
:param references: A dict with keys matching the items returned by
2079
self._get_check_refs(), and values from looking those keys up in
2082
tree_basis = self.basis_tree()
2083
tree_basis.lock_read()
2085
repo_basis = references[('trees', self.last_revision())]
2086
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2087
raise errors.BzrCheckError(
2088
"Mismatched basis inventory content.")
2094
def check_state(self):
2095
"""Check that the working state is/isn't valid."""
2096
check_refs = self._get_check_refs()
2098
for ref in check_refs:
2101
refs[ref] = self.branch.repository.revision_tree(value)
2104
@needs_tree_write_lock
2105
def reset_state(self, revision_ids=None):
2106
"""Reset the state of the working tree.
2108
This does a hard-reset to a last-known-good state. This is a way to
2109
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2111
if revision_ids is None:
2112
revision_ids = self.get_parent_ids()
2113
if not revision_ids:
2114
rt = self.branch.repository.revision_tree(
2115
_mod_revision.NULL_REVISION)
2117
rt = self.branch.repository.revision_tree(revision_ids[0])
2118
self._write_inventory(rt.inventory)
2119
self.set_parent_ids(revision_ids)
2122
"""Write the in memory inventory to disk."""
2123
# TODO: Maybe this should only write on dirty ?
2124
if self._control_files._lock_mode != 'w':
2125
raise errors.NotWriteLocked(self)
2127
self._serialize(self._inventory, sio)
2129
self._transport.put_file('inventory', sio,
2130
mode=self.bzrdir._get_file_mode())
2131
self._inventory_is_modified = False
2133
def get_file_mtime(self, file_id, path=None):
2134
"""See Tree.get_file_mtime."""
2136
path = self.inventory.id2path(file_id)
2138
return os.lstat(self.abspath(path)).st_mtime
2140
if e.errno == errno.ENOENT:
2141
raise errors.FileTimestampUnavailable(path)
2144
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2145
file_id = self.path2id(path)
2147
# For unversioned files on win32, we just assume they are not
2150
return self._inventory[file_id].executable
2152
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2153
mode = stat_result.st_mode
2154
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2156
if not supports_executable():
2157
def is_executable(self, file_id, path=None):
2158
return self._inventory[file_id].executable
2160
_is_executable_from_path_and_stat = \
2161
_is_executable_from_path_and_stat_from_basis
2163
def is_executable(self, file_id, path=None):
2165
path = self.id2path(file_id)
2166
mode = os.lstat(self.abspath(path)).st_mode
2167
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2169
_is_executable_from_path_and_stat = \
2170
_is_executable_from_path_and_stat_from_stat
2172
@needs_tree_write_lock
2173
def _add(self, files, ids, kinds):
2174
"""See MutableTree._add."""
2175
# TODO: Re-adding a file that is removed in the working copy
2176
# should probably put it back with the previous ID.
2177
# the read and write working inventory should not occur in this
2178
# function - they should be part of lock_write and unlock.
2179
inv = self.inventory
2180
for f, file_id, kind in zip(files, ids, kinds):
2182
inv.add_path(f, kind=kind)
2184
inv.add_path(f, kind=kind, file_id=file_id)
2185
self._inventory_is_modified = True
2187
def revision_tree(self, revision_id):
2188
"""See WorkingTree.revision_id."""
2189
if revision_id == self.last_revision():
2191
xml = self.read_basis_inventory()
2192
except errors.NoSuchFile:
2196
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2197
# dont use the repository revision_tree api because we want
2198
# to supply the inventory.
2199
if inv.revision_id == revision_id:
2200
return revisiontree.InventoryRevisionTree(
2201
self.branch.repository, inv, revision_id)
2202
except errors.BadInventoryFormat:
2204
# raise if there was no inventory, or if we read the wrong inventory.
2205
raise errors.NoSuchRevisionInTree(self, revision_id)
2208
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2209
"""See Tree.annotate_iter
2211
This implementation will use the basis tree implementation if possible.
2212
Lines not in the basis are attributed to CURRENT_REVISION
2214
If there are pending merges, lines added by those merges will be
2215
incorrectly attributed to CURRENT_REVISION (but after committing, the
2216
attribution will be correct).
2218
maybe_file_parent_keys = []
2219
for parent_id in self.get_parent_ids():
2221
parent_tree = self.revision_tree(parent_id)
2222
except errors.NoSuchRevisionInTree:
2223
parent_tree = self.branch.repository.revision_tree(parent_id)
2224
parent_tree.lock_read()
2226
if not parent_tree.has_id(file_id):
2228
ie = parent_tree.inventory[file_id]
2229
if ie.kind != 'file':
2230
# Note: this is slightly unnecessary, because symlinks and
2231
# directories have a "text" which is the empty text, and we
2232
# know that won't mess up annotations. But it seems cleaner
2234
parent_text_key = (file_id, ie.revision)
2235
if parent_text_key not in maybe_file_parent_keys:
2236
maybe_file_parent_keys.append(parent_text_key)
2238
parent_tree.unlock()
2239
graph = _mod_graph.Graph(self.branch.repository.texts)
2240
heads = graph.heads(maybe_file_parent_keys)
2241
file_parent_keys = []
2242
for key in maybe_file_parent_keys:
2244
file_parent_keys.append(key)
2246
# Now we have the parents of this content
2247
annotator = self.branch.repository.texts.get_annotator()
2248
text = self.get_file_text(file_id)
2249
this_key =(file_id, default_revision)
2250
annotator.add_special_text(this_key, file_parent_keys, text)
2251
annotations = [(key[-1], line)
2252
for key, line in annotator.annotate_flat(this_key)]
2256
def merge_modified(self):
2257
"""Return a dictionary of files modified by a merge.
2259
The list is initialized by WorkingTree.set_merge_modified, which is
2260
typically called after we make some automatic updates to the tree
2263
This returns a map of file_id->sha1, containing only files which are
2264
still in the working inventory and have that text hash.
2267
hashfile = self._transport.get('merge-hashes')
2268
except errors.NoSuchFile:
2273
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2274
raise errors.MergeModifiedFormatError()
2275
except StopIteration:
2276
raise errors.MergeModifiedFormatError()
2277
for s in _mod_rio.RioReader(hashfile):
2278
# RioReader reads in Unicode, so convert file_ids back to utf8
2279
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2280
if not self.inventory.has_id(file_id):
2282
text_hash = s.get("hash")
2283
if text_hash == self.get_file_sha1(file_id):
2284
merge_hashes[file_id] = text_hash
2290
def subsume(self, other_tree):
2291
def add_children(inventory, entry):
2292
for child_entry in entry.children.values():
2293
inventory._byid[child_entry.file_id] = child_entry
2294
if child_entry.kind == 'directory':
2295
add_children(inventory, child_entry)
2296
if other_tree.get_root_id() == self.get_root_id():
2297
raise errors.BadSubsumeSource(self, other_tree,
2298
'Trees have the same root')
2300
other_tree_path = self.relpath(other_tree.basedir)
2301
except errors.PathNotChild:
2302
raise errors.BadSubsumeSource(self, other_tree,
2303
'Tree is not contained by the other')
2304
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2305
if new_root_parent is None:
2306
raise errors.BadSubsumeSource(self, other_tree,
2307
'Parent directory is not versioned.')
2308
# We need to ensure that the result of a fetch will have a
2309
# versionedfile for the other_tree root, and only fetching into
2310
# RepositoryKnit2 guarantees that.
2311
if not self.branch.repository.supports_rich_root():
2312
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2313
other_tree.lock_tree_write()
2315
new_parents = other_tree.get_parent_ids()
2316
other_root = other_tree.inventory.root
2317
other_root.parent_id = new_root_parent
2318
other_root.name = osutils.basename(other_tree_path)
2319
self.inventory.add(other_root)
2320
add_children(self.inventory, other_root)
2321
self._write_inventory(self.inventory)
2322
# normally we don't want to fetch whole repositories, but i think
2323
# here we really do want to consolidate the whole thing.
2324
for parent_id in other_tree.get_parent_ids():
2325
self.branch.fetch(other_tree.branch, parent_id)
2326
self.add_parent_tree_id(parent_id)
2329
other_tree.bzrdir.retire_bzrdir()
2331
@needs_tree_write_lock
2332
def extract(self, file_id, format=None):
2333
"""Extract a subtree from this tree.
2335
A new branch will be created, relative to the path for this tree.
2339
segments = osutils.splitpath(path)
2340
transport = self.branch.bzrdir.root_transport
2341
for name in segments:
2342
transport = transport.clone(name)
2343
transport.ensure_base()
2346
sub_path = self.id2path(file_id)
2347
branch_transport = mkdirs(sub_path)
2349
format = self.bzrdir.cloning_metadir()
2350
branch_transport.ensure_base()
2351
branch_bzrdir = format.initialize_on_transport(branch_transport)
2353
repo = branch_bzrdir.find_repository()
2354
except errors.NoRepositoryPresent:
2355
repo = branch_bzrdir.create_repository()
2356
if not repo.supports_rich_root():
2357
raise errors.RootNotRich()
2358
new_branch = branch_bzrdir.create_branch()
2359
new_branch.pull(self.branch)
2360
for parent_id in self.get_parent_ids():
2361
new_branch.fetch(self.branch, parent_id)
2362
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2363
if tree_transport.base != branch_transport.base:
2364
tree_bzrdir = format.initialize_on_transport(tree_transport)
2365
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2366
target_branch=new_branch)
2368
tree_bzrdir = branch_bzrdir
2369
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2370
wt.set_parent_ids(self.get_parent_ids())
2371
my_inv = self.inventory
2372
child_inv = inventory.Inventory(root_id=None)
2373
new_root = my_inv[file_id]
2374
my_inv.remove_recursive_id(file_id)
2375
new_root.parent_id = None
2376
child_inv.add(new_root)
2377
self._write_inventory(my_inv)
2378
wt._write_inventory(child_inv)
2381
def list_files(self, include_root=False, from_dir=None, recursive=True):
2382
"""List all files as (path, class, kind, id, entry).
2384
Lists, but does not descend into unversioned directories.
2385
This does not include files that have been deleted in this
2386
tree. Skips the control directory.
2388
:param include_root: if True, return an entry for the root
2389
:param from_dir: start from this directory or None for the root
2390
:param recursive: whether to recurse into subdirectories or not
2392
# list_files is an iterator, so @needs_read_lock doesn't work properly
2393
# with it. So callers should be careful to always read_lock the tree.
2394
if not self.is_locked():
2395
raise errors.ObjectNotLocked(self)
2397
inv = self.inventory
2398
if from_dir is None and include_root is True:
2399
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2400
# Convert these into local objects to save lookup times
2401
pathjoin = osutils.pathjoin
2402
file_kind = self._kind
2404
# transport.base ends in a slash, we want the piece
2405
# between the last two slashes
2406
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2408
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2410
# directory file_id, relative path, absolute path, reverse sorted children
2411
if from_dir is not None:
2412
from_dir_id = inv.path2id(from_dir)
2413
if from_dir_id is None:
2414
# Directory not versioned
2416
from_dir_abspath = pathjoin(self.basedir, from_dir)
2418
from_dir_id = inv.root.file_id
2419
from_dir_abspath = self.basedir
2420
children = os.listdir(from_dir_abspath)
2422
# jam 20060527 The kernel sized tree seems equivalent whether we
2423
# use a deque and popleft to keep them sorted, or if we use a plain
2424
# list and just reverse() them.
2425
children = collections.deque(children)
2426
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2428
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2431
f = children.popleft()
2432
## TODO: If we find a subdirectory with its own .bzr
2433
## directory, then that is a separate tree and we
2434
## should exclude it.
2436
# the bzrdir for this tree
2437
if transport_base_dir == f:
2440
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2441
# and 'f' doesn't begin with one, we can do a string op, rather
2442
# than the checks of pathjoin(), all relative paths will have an extra slash
2444
fp = from_dir_relpath + '/' + f
2447
fap = from_dir_abspath + '/' + f
2449
dir_ie = inv[from_dir_id]
2450
if dir_ie.kind == 'directory':
2451
f_ie = dir_ie.children.get(f)
2456
elif self.is_ignored(fp[1:]):
2459
# we may not have found this file, because of a unicode
2460
# issue, or because the directory was actually a symlink.
2461
f_norm, can_access = osutils.normalized_filename(f)
2462
if f == f_norm or not can_access:
2463
# No change, so treat this file normally
2466
# this file can be accessed by a normalized path
2467
# check again if it is versioned
2468
# these lines are repeated here for performance
2470
fp = from_dir_relpath + '/' + f
2471
fap = from_dir_abspath + '/' + f
2472
f_ie = inv.get_child(from_dir_id, f)
2475
elif self.is_ignored(fp[1:]):
2482
# make a last minute entry
2484
yield fp[1:], c, fk, f_ie.file_id, f_ie
2487
yield fp[1:], c, fk, None, fk_entries[fk]()
2489
yield fp[1:], c, fk, None, TreeEntry()
2492
if fk != 'directory':
2495
# But do this child first if recursing down
2497
new_children = os.listdir(fap)
2499
new_children = collections.deque(new_children)
2500
stack.append((f_ie.file_id, fp, fap, new_children))
2501
# Break out of inner loop,
2502
# so that we start outer loop with child
2505
# if we finished all children, pop it off the stack
2508
@needs_tree_write_lock
2509
def move(self, from_paths, to_dir=None, after=False):
2512
to_dir must exist in the inventory.
2514
If to_dir exists and is a directory, the files are moved into
2515
it, keeping their old names.
2517
Note that to_dir is only the last component of the new name;
2518
this doesn't change the directory.
2520
For each entry in from_paths the move mode will be determined
2523
The first mode moves the file in the filesystem and updates the
2524
inventory. The second mode only updates the inventory without
2525
touching the file on the filesystem.
2527
move uses the second mode if 'after == True' and the target is
2528
either not versioned or newly added, and present in the working tree.
2530
move uses the second mode if 'after == False' and the source is
2531
versioned but no longer in the working tree, and the target is not
2532
versioned but present in the working tree.
2534
move uses the first mode if 'after == False' and the source is
2535
versioned and present in the working tree, and the target is not
2536
versioned and not present in the working tree.
2538
Everything else results in an error.
2540
This returns a list of (from_path, to_path) pairs for each
2541
entry that is moved.
2546
# check for deprecated use of signature
2548
raise TypeError('You must supply a target directory')
2549
# check destination directory
2550
if isinstance(from_paths, basestring):
2552
inv = self.inventory
2553
to_abs = self.abspath(to_dir)
2554
if not isdir(to_abs):
2555
raise errors.BzrMoveFailedError('',to_dir,
2556
errors.NotADirectory(to_abs))
2557
if not self.has_filename(to_dir):
2558
raise errors.BzrMoveFailedError('',to_dir,
2559
errors.NotInWorkingDirectory(to_dir))
2560
to_dir_id = inv.path2id(to_dir)
2561
if to_dir_id is None:
2562
raise errors.BzrMoveFailedError('',to_dir,
2563
errors.NotVersionedError(path=to_dir))
2565
to_dir_ie = inv[to_dir_id]
2566
if to_dir_ie.kind != 'directory':
2567
raise errors.BzrMoveFailedError('',to_dir,
2568
errors.NotADirectory(to_abs))
2570
# create rename entries and tuples
2571
for from_rel in from_paths:
2572
from_tail = splitpath(from_rel)[-1]
2573
from_id = inv.path2id(from_rel)
2575
raise errors.BzrMoveFailedError(from_rel,to_dir,
2576
errors.NotVersionedError(path=from_rel))
2578
from_entry = inv[from_id]
2579
from_parent_id = from_entry.parent_id
2580
to_rel = pathjoin(to_dir, from_tail)
2581
rename_entry = InventoryWorkingTree._RenameEntry(
2584
from_tail=from_tail,
2585
from_parent_id=from_parent_id,
2586
to_rel=to_rel, to_tail=from_tail,
2587
to_parent_id=to_dir_id)
2588
rename_entries.append(rename_entry)
2589
rename_tuples.append((from_rel, to_rel))
2591
# determine which move mode to use. checks also for movability
2592
rename_entries = self._determine_mv_mode(rename_entries, after)
2594
original_modified = self._inventory_is_modified
2597
self._inventory_is_modified = True
2598
self._move(rename_entries)
2600
# restore the inventory on error
2601
self._inventory_is_modified = original_modified
2603
self._write_inventory(inv)
2604
return rename_tuples
2606
@needs_tree_write_lock
2607
def rename_one(self, from_rel, to_rel, after=False):
2610
This can change the directory or the filename or both.
2612
rename_one has several 'modes' to work. First, it can rename a physical
2613
file and change the file_id. That is the normal mode. Second, it can
2614
only change the file_id without touching any physical file.
2616
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2617
versioned but present in the working tree.
2619
rename_one uses the second mode if 'after == False' and 'from_rel' is
2620
versioned but no longer in the working tree, and 'to_rel' is not
2621
versioned but present in the working tree.
2623
rename_one uses the first mode if 'after == False' and 'from_rel' is
2624
versioned and present in the working tree, and 'to_rel' is not
2625
versioned and not present in the working tree.
2627
Everything else results in an error.
2629
inv = self.inventory
2632
# create rename entries and tuples
2633
from_tail = splitpath(from_rel)[-1]
2634
from_id = inv.path2id(from_rel)
2636
# if file is missing in the inventory maybe it's in the basis_tree
2637
basis_tree = self.branch.basis_tree()
2638
from_id = basis_tree.path2id(from_rel)
2640
raise errors.BzrRenameFailedError(from_rel,to_rel,
2641
errors.NotVersionedError(path=from_rel))
2642
# put entry back in the inventory so we can rename it
2643
from_entry = basis_tree.inventory[from_id].copy()
2646
from_entry = inv[from_id]
2647
from_parent_id = from_entry.parent_id
2648
to_dir, to_tail = os.path.split(to_rel)
2649
to_dir_id = inv.path2id(to_dir)
2650
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2652
from_tail=from_tail,
2653
from_parent_id=from_parent_id,
2654
to_rel=to_rel, to_tail=to_tail,
2655
to_parent_id=to_dir_id)
2656
rename_entries.append(rename_entry)
2658
# determine which move mode to use. checks also for movability
2659
rename_entries = self._determine_mv_mode(rename_entries, after)
2661
# check if the target changed directory and if the target directory is
2663
if to_dir_id is None:
2664
raise errors.BzrMoveFailedError(from_rel,to_rel,
2665
errors.NotVersionedError(path=to_dir))
2667
# all checks done. now we can continue with our actual work
2668
mutter('rename_one:\n'
2673
' to_dir_id {%s}\n',
2674
from_id, from_rel, to_rel, to_dir, to_dir_id)
2676
self._move(rename_entries)
2677
self._write_inventory(inv)
2679
class _RenameEntry(object):
2680
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2681
to_rel, to_tail, to_parent_id, only_change_inv=False,
2683
self.from_rel = from_rel
2684
self.from_id = from_id
2685
self.from_tail = from_tail
2686
self.from_parent_id = from_parent_id
2687
self.to_rel = to_rel
2688
self.to_tail = to_tail
2689
self.to_parent_id = to_parent_id
2690
self.change_id = change_id
2691
self.only_change_inv = only_change_inv
2693
def _determine_mv_mode(self, rename_entries, after=False):
2694
"""Determines for each from-to pair if both inventory and working tree
2695
or only the inventory has to be changed.
2697
Also does basic plausability tests.
2699
inv = self.inventory
2701
for rename_entry in rename_entries:
2702
# store to local variables for easier reference
2703
from_rel = rename_entry.from_rel
2704
from_id = rename_entry.from_id
2705
to_rel = rename_entry.to_rel
2706
to_id = inv.path2id(to_rel)
2707
only_change_inv = False
2710
# check the inventory for source and destination
2712
raise errors.BzrMoveFailedError(from_rel,to_rel,
2713
errors.NotVersionedError(path=from_rel))
2714
if to_id is not None:
2716
# allow it with --after but only if dest is newly added
2718
basis = self.basis_tree()
2721
if not basis.has_id(to_id):
2722
rename_entry.change_id = True
2727
raise errors.BzrMoveFailedError(from_rel,to_rel,
2728
errors.AlreadyVersionedError(path=to_rel))
2730
# try to determine the mode for rename (only change inv or change
2731
# inv and file system)
2733
if not self.has_filename(to_rel):
2734
raise errors.BzrMoveFailedError(from_id,to_rel,
2735
errors.NoSuchFile(path=to_rel,
2736
extra="New file has not been created yet"))
2737
only_change_inv = True
2738
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2739
only_change_inv = True
2740
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2741
only_change_inv = False
2742
elif (not self.case_sensitive
2743
and from_rel.lower() == to_rel.lower()
2744
and self.has_filename(from_rel)):
2745
only_change_inv = False
2747
# something is wrong, so lets determine what exactly
2748
if not self.has_filename(from_rel) and \
2749
not self.has_filename(to_rel):
2750
raise errors.BzrRenameFailedError(from_rel,to_rel,
2751
errors.PathsDoNotExist(paths=(str(from_rel),
2754
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2755
rename_entry.only_change_inv = only_change_inv
2756
return rename_entries
2758
def _move(self, rename_entries):
2759
"""Moves a list of files.
2761
Depending on the value of the flag 'only_change_inv', the
2762
file will be moved on the file system or not.
2764
inv = self.inventory
2767
for entry in rename_entries:
2769
self._move_entry(entry)
2771
self._rollback_move(moved)
2775
def _rollback_move(self, moved):
2776
"""Try to rollback a previous move in case of an filesystem error."""
2777
inv = self.inventory
2780
self._move_entry(WorkingTree._RenameEntry(
2781
entry.to_rel, entry.from_id,
2782
entry.to_tail, entry.to_parent_id, entry.from_rel,
2783
entry.from_tail, entry.from_parent_id,
2784
entry.only_change_inv))
2785
except errors.BzrMoveFailedError, e:
2786
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2787
" The working tree is in an inconsistent state."
2788
" Please consider doing a 'bzr revert'."
2789
" Error message is: %s" % e)
2791
def _move_entry(self, entry):
2792
inv = self.inventory
2793
from_rel_abs = self.abspath(entry.from_rel)
2794
to_rel_abs = self.abspath(entry.to_rel)
2795
if from_rel_abs == to_rel_abs:
2796
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2797
"Source and target are identical.")
2799
if not entry.only_change_inv:
2801
osutils.rename(from_rel_abs, to_rel_abs)
2803
raise errors.BzrMoveFailedError(entry.from_rel,
2806
to_id = inv.path2id(entry.to_rel)
2807
inv.remove_recursive_id(to_id)
2808
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2810
@needs_tree_write_lock
2811
def unversion(self, file_ids):
2812
"""Remove the file ids in file_ids from the current versioned set.
2814
When a file_id is unversioned, all of its children are automatically
2817
:param file_ids: The file ids to stop versioning.
2818
:raises: NoSuchId if any fileid is not currently versioned.
2820
for file_id in file_ids:
2821
if not self._inventory.has_id(file_id):
2822
raise errors.NoSuchId(self, file_id)
2823
for file_id in file_ids:
2824
if self._inventory.has_id(file_id):
2825
self._inventory.remove_recursive_id(file_id)
2827
# in the future this should just set a dirty bit to wait for the
2828
# final unlock. However, until all methods of workingtree start
2829
# with the current in -memory inventory rather than triggering
2830
# a read, it is more complex - we need to teach read_inventory
2831
# to know when to read, and when to not read first... and possibly
2832
# to save first when the in memory one may be corrupted.
2833
# so for now, we just only write it if it is indeed dirty.
2835
self._write_inventory(self._inventory)
2837
def stored_kind(self, file_id):
2838
"""See Tree.stored_kind"""
2839
return self.inventory[file_id].kind
2842
"""Yield all unversioned files in this WorkingTree.
2844
If there are any unversioned directories then only the directory is
2845
returned, not all its children. But if there are unversioned files
2846
under a versioned subdirectory, they are returned.
2848
Currently returned depth-first, sorted by name within directories.
2849
This is the same order used by 'osutils.walkdirs'.
2851
## TODO: Work from given directory downwards
2852
for path, dir_entry in self.inventory.directories():
2853
# mutter("search for unknowns in %r", path)
2854
dirabs = self.abspath(path)
2855
if not isdir(dirabs):
2856
# e.g. directory deleted
2860
for subf in os.listdir(dirabs):
2861
if self.bzrdir.is_control_filename(subf):
2863
if subf not in dir_entry.children:
2866
can_access) = osutils.normalized_filename(subf)
2867
except UnicodeDecodeError:
2868
path_os_enc = path.encode(osutils._fs_enc)
2869
relpath = path_os_enc + '/' + subf
2870
raise errors.BadFilenameEncoding(relpath,
2872
if subf_norm != subf and can_access:
2873
if subf_norm not in dir_entry.children:
2874
fl.append(subf_norm)
2880
subp = pathjoin(path, subf)
2883
def _walkdirs(self, prefix=""):
2884
"""Walk the directories of this tree.
2886
:param prefix: is used as the directrory to start with.
2887
:returns: a generator which yields items in the form::
2889
((curren_directory_path, fileid),
2890
[(file1_path, file1_name, file1_kind, None, file1_id,
2893
_directory = 'directory'
2894
# get the root in the inventory
2895
inv = self.inventory
2896
top_id = inv.path2id(prefix)
2900
pending = [(prefix, '', _directory, None, top_id, None)]
2903
currentdir = pending.pop()
2904
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2905
top_id = currentdir[4]
2907
relroot = currentdir[0] + '/'
2910
# FIXME: stash the node in pending
2912
if entry.kind == 'directory':
2913
for name, child in entry.sorted_children():
2914
dirblock.append((relroot + name, name, child.kind, None,
2915
child.file_id, child.kind
2917
yield (currentdir[0], entry.file_id), dirblock
2918
# push the user specified dirs from dirblock
2919
for dir in reversed(dirblock):
2920
if dir[2] == _directory:
2924
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2925
"""Registry for working tree formats."""
2927
def __init__(self, other_registry=None):
2928
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2929
self._default_format = None
2930
self._default_format_key = None
2932
def get_default(self):
2933
"""Return the current default format."""
2934
if (self._default_format_key is not None and
2935
self._default_format is None):
2936
self._default_format = self.get(self._default_format_key)
2937
return self._default_format
2939
def set_default(self, format):
2940
"""Set the default format."""
2941
self._default_format = format
2942
self._default_format_key = None
2944
def set_default_key(self, format_string):
2945
"""Set the default format by its format string."""
2946
self._default_format_key = format_string
2947
self._default_format = None
2950
format_registry = WorkingTreeFormatRegistry()
2953
class WorkingTreeFormat(controldir.ControlComponentFormat):
2655
2954
"""An encapsulation of the initialization and open routines for a format.
2657
2956
Formats provide three things:
3059
@symbol_versioning.deprecated_method(
3060
symbol_versioning.deprecated_in((2, 4, 0)))
2732
3061
def register_format(klass, format):
2733
klass._formats[format.get_format_string()] = format
3062
format_registry.register(format)
3065
@symbol_versioning.deprecated_method(
3066
symbol_versioning.deprecated_in((2, 4, 0)))
3067
def register_extra_format(klass, format):
3068
format_registry.register_extra(format)
3071
@symbol_versioning.deprecated_method(
3072
symbol_versioning.deprecated_in((2, 4, 0)))
3073
def unregister_extra_format(klass, format):
3074
format_registry.unregister_extra(format)
3077
@symbol_versioning.deprecated_method(
3078
symbol_versioning.deprecated_in((2, 4, 0)))
3079
def get_formats(klass):
3080
return format_registry._get_all()
3083
@symbol_versioning.deprecated_method(
3084
symbol_versioning.deprecated_in((2, 4, 0)))
2736
3085
def set_default_format(klass, format):
2737
klass._default_format = format
3086
format_registry.set_default(format)
3089
@symbol_versioning.deprecated_method(
3090
symbol_versioning.deprecated_in((2, 4, 0)))
2740
3091
def unregister_format(klass, format):
2741
del klass._formats[format.get_format_string()]
2744
class WorkingTreeFormat2(WorkingTreeFormat):
2745
"""The second working tree format.
2747
This format modified the hash cache from the format 1 hash cache.
2750
upgrade_recommended = True
2752
def get_format_description(self):
2753
"""See WorkingTreeFormat.get_format_description()."""
2754
return "Working tree format 2"
2756
def _stub_initialize_on_transport(self, transport, file_mode):
2757
"""Workaround: create control files for a remote working tree.
2759
This ensures that it can later be updated and dealt with locally,
2760
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2761
no working tree. (See bug #43064).
2765
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2767
transport.put_file('inventory', sio, file_mode)
2768
transport.put_bytes('pending-merges', '', file_mode)
2770
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2771
accelerator_tree=None, hardlink=False):
2772
"""See WorkingTreeFormat.initialize()."""
2773
if not isinstance(a_bzrdir.transport, LocalTransport):
2774
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2775
if from_branch is not None:
2776
branch = from_branch
2778
branch = a_bzrdir.open_branch()
2779
if revision_id is None:
2780
revision_id = _mod_revision.ensure_null(branch.last_revision())
2783
branch.generate_revision_history(revision_id)
2787
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2793
basis_tree = branch.repository.revision_tree(revision_id)
2794
if basis_tree.inventory.root is not None:
2795
wt.set_root_id(basis_tree.get_root_id())
2796
# set the parent list and cache the basis tree.
2797
if _mod_revision.is_null(revision_id):
2800
parent_trees = [(revision_id, basis_tree)]
2801
wt.set_parent_trees(parent_trees)
2802
transform.build_tree(basis_tree, wt)
2806
super(WorkingTreeFormat2, self).__init__()
2807
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2809
def open(self, a_bzrdir, _found=False):
2810
"""Return the WorkingTree object for a_bzrdir
2812
_found is a private parameter, do not use it. It is used to indicate
2813
if format probing has already been done.
2816
# we are being called directly and must probe.
2817
raise NotImplementedError
2818
if not isinstance(a_bzrdir.transport, LocalTransport):
2819
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2820
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2826
class WorkingTreeFormat3(WorkingTreeFormat):
2827
"""The second working tree format updated to record a format marker.
2830
- exists within a metadir controlling .bzr
2831
- includes an explicit version marker for the workingtree control
2832
files, separate from the BzrDir format
2833
- modifies the hash cache format
2835
- uses a LockDir to guard access for writes.
2838
upgrade_recommended = True
2840
def get_format_string(self):
2841
"""See WorkingTreeFormat.get_format_string()."""
2842
return "Bazaar-NG Working Tree format 3"
2844
def get_format_description(self):
2845
"""See WorkingTreeFormat.get_format_description()."""
2846
return "Working tree format 3"
2848
_lock_file_name = 'lock'
2849
_lock_class = LockDir
2851
_tree_class = WorkingTree3
2853
def __get_matchingbzrdir(self):
2854
return bzrdir.BzrDirMetaFormat1()
2856
_matchingbzrdir = property(__get_matchingbzrdir)
2858
def _open_control_files(self, a_bzrdir):
2859
transport = a_bzrdir.get_workingtree_transport(None)
2860
return LockableFiles(transport, self._lock_file_name,
2863
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2864
accelerator_tree=None, hardlink=False):
2865
"""See WorkingTreeFormat.initialize().
2867
:param revision_id: if supplied, create a working tree at a different
2868
revision than the branch is at.
2869
:param accelerator_tree: A tree which can be used for retrieving file
2870
contents more quickly than the revision tree, i.e. a workingtree.
2871
The revision tree will be used for cases where accelerator_tree's
2872
content is different.
2873
:param hardlink: If true, hard-link files from accelerator_tree,
2876
if not isinstance(a_bzrdir.transport, LocalTransport):
2877
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2878
transport = a_bzrdir.get_workingtree_transport(self)
2879
control_files = self._open_control_files(a_bzrdir)
2880
control_files.create_lock()
2881
control_files.lock_write()
2882
transport.put_bytes('format', self.get_format_string(),
2883
mode=control_files._file_mode)
2884
if from_branch is not None:
2885
branch = from_branch
2887
branch = a_bzrdir.open_branch()
2888
if revision_id is None:
2889
revision_id = _mod_revision.ensure_null(branch.last_revision())
2890
# WorkingTree3 can handle an inventory which has a unique root id.
2891
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2892
# those trees. And because there isn't a format bump inbetween, we
2893
# are maintaining compatibility with older clients.
2894
# inv = Inventory(root_id=gen_root_id())
2895
inv = self._initial_inventory()
2896
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2902
_control_files=control_files)
2903
wt.lock_tree_write()
2905
basis_tree = branch.repository.revision_tree(revision_id)
2906
# only set an explicit root id if there is one to set.
2907
if basis_tree.inventory.root is not None:
2908
wt.set_root_id(basis_tree.get_root_id())
2909
if revision_id == NULL_REVISION:
2910
wt.set_parent_trees([])
2912
wt.set_parent_trees([(revision_id, basis_tree)])
2913
transform.build_tree(basis_tree, wt)
2915
# Unlock in this order so that the unlock-triggers-flush in
2916
# WorkingTree is given a chance to fire.
2917
control_files.unlock()
2921
def _initial_inventory(self):
2925
super(WorkingTreeFormat3, self).__init__()
2927
def open(self, a_bzrdir, _found=False):
2928
"""Return the WorkingTree object for a_bzrdir
2930
_found is a private parameter, do not use it. It is used to indicate
2931
if format probing has already been done.
2934
# we are being called directly and must probe.
2935
raise NotImplementedError
2936
if not isinstance(a_bzrdir.transport, LocalTransport):
2937
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2938
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2941
def _open(self, a_bzrdir, control_files):
2942
"""Open the tree itself.
2944
:param a_bzrdir: the dir for the tree.
2945
:param control_files: the control files for the tree.
2947
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2951
_control_files=control_files)
2954
return self.get_format_string()
2957
__default_format = WorkingTreeFormat4()
2958
WorkingTreeFormat.register_format(__default_format)
2959
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2960
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2961
WorkingTreeFormat.set_default_format(__default_format)
2962
# formats which have no format string are not discoverable
2963
# and not independently creatable, so are not registered.
2964
_legacy_formats = [WorkingTreeFormat2(),
3092
format_registry.remove(format)
3094
def get_controldir_for_branch(self):
3095
"""Get the control directory format for creating branches.
3097
This is to support testing of working tree formats that can not exist
3098
in the same control directory as a branch.
3100
return self._matchingbzrdir
3103
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3104
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3105
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3106
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3107
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3108
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3109
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3110
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3111
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
