2716
1738
return ShelfManager(self, self._transport)
2719
class WorkingTree2(WorkingTree):
2720
"""This is the Format 2 working tree.
2722
This was the first weave based working tree.
2723
- uses os locks for locking.
2724
- uses the branch last-revision.
1741
class InventoryWorkingTree(WorkingTree,
1742
bzrlib.mutabletree.MutableInventoryTree):
1743
"""Base class for working trees that are inventory-oriented.
1745
The inventory is held in the `Branch` working-inventory, and the
1746
files are in a directory on disk.
1748
It is possible for a `WorkingTree` to have a filename which is
1749
not listed in the Inventory and vice versa.
2727
def __init__(self, *args, **kwargs):
2728
super(WorkingTree2, self).__init__(*args, **kwargs)
2729
# WorkingTree2 has more of a constraint that self._inventory must
2730
# exist. Because this is an older format, we don't mind the overhead
2731
# caused by the extra computation here.
2733
# Newer WorkingTree's should only have self._inventory set when they
2735
if self._inventory is None:
2736
self.read_working_inventory()
2738
def _get_check_refs(self):
2739
"""Return the references needed to perform a check of this tree."""
2740
return [('trees', self.last_revision())]
1752
def __init__(self, basedir='.',
1753
branch=DEPRECATED_PARAMETER,
1755
_control_files=None,
1759
"""Construct a InventoryWorkingTree instance. This is not a public API.
1761
:param branch: A branch to override probing for the branch.
1763
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1764
branch=branch, _transport=_control_files._transport,
1765
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1767
self._control_files = _control_files
1768
self._detect_case_handling()
1770
if _inventory is None:
1771
# This will be acquired on lock_read() or lock_write()
1772
self._inventory_is_modified = False
1773
self._inventory = None
1775
# the caller of __init__ has provided an inventory,
1776
# we assume they know what they are doing - as its only
1777
# the Format factory and creation methods that are
1778
# permitted to do this.
1779
self._set_inventory(_inventory, dirty=False)
1781
def _set_inventory(self, inv, dirty):
1782
"""Set the internal cached inventory.
1784
:param inv: The inventory to set.
1785
:param dirty: A boolean indicating whether the inventory is the same
1786
logical inventory as whats on disk. If True the inventory is not
1787
the same and should be written to disk or data will be lost, if
1788
False then the inventory is the same as that on disk and any
1789
serialisation would be unneeded overhead.
1791
self._inventory = inv
1792
self._inventory_is_modified = dirty
1794
def _detect_case_handling(self):
1795
wt_trans = self.bzrdir.get_workingtree_transport(None)
1797
wt_trans.stat(self._format.case_sensitive_filename)
1798
except errors.NoSuchFile:
1799
self.case_sensitive = True
1801
self.case_sensitive = False
1803
self._setup_directory_is_tree_reference()
1805
def _serialize(self, inventory, out_file):
1806
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1809
def _deserialize(selt, in_file):
1810
return xml5.serializer_v5.read_inventory(in_file)
1812
def break_lock(self):
1813
"""Break a lock if one is present from another instance.
1815
Uses the ui factory to ask for confirmation if the lock may be from
1818
This will probe the repository for its lock as well.
1820
self._control_files.break_lock()
1821
self.branch.break_lock()
1823
def is_locked(self):
1824
return self._control_files.is_locked()
1826
def _must_be_locked(self):
1827
if not self.is_locked():
1828
raise errors.ObjectNotLocked(self)
1830
def lock_read(self):
1831
"""Lock the tree for reading.
1833
This also locks the branch, and can be unlocked via self.unlock().
1835
:return: A bzrlib.lock.LogicalLockResult.
1837
if not self.is_locked():
1839
self.branch.lock_read()
1841
self._control_files.lock_read()
1842
return LogicalLockResult(self.unlock)
1844
self.branch.unlock()
2742
1847
def lock_tree_write(self):
2743
"""See WorkingTree.lock_tree_write().
2745
In Format2 WorkingTrees we have a single lock for the branch and tree
2746
so lock_tree_write() degrades to lock_write().
2748
:return: An object with an unlock method which will release the lock
1848
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1850
:return: A bzrlib.lock.LogicalLockResult.
1852
if not self.is_locked():
1854
self.branch.lock_read()
1856
self._control_files.lock_write()
1857
return LogicalLockResult(self.unlock)
1859
self.branch.unlock()
1862
def lock_write(self):
1863
"""See MutableTree.lock_write, and WorkingTree.unlock.
1865
:return: A bzrlib.lock.LogicalLockResult.
1867
if not self.is_locked():
2751
1869
self.branch.lock_write()
2753
1871
self._control_files.lock_write()
1872
return LogicalLockResult(self.unlock)
2756
1874
self.branch.unlock()
2760
# do non-implementation specific cleanup
2763
# we share control files:
2764
if self._control_files._lock_count == 3:
2765
# _inventory_is_modified is always False during a read lock.
2766
if self._inventory_is_modified:
2768
self._write_hashcache_if_dirty()
2770
# reverse order of locking.
1877
def get_physical_lock_status(self):
1878
return self._control_files.get_physical_lock_status()
1880
@needs_tree_write_lock
1881
def _write_inventory(self, inv):
1882
"""Write inventory as the current inventory."""
1883
self._set_inventory(inv, dirty=True)
1886
# XXX: This method should be deprecated in favour of taking in a proper
1887
# new Inventory object.
1888
@needs_tree_write_lock
1889
def set_inventory(self, new_inventory_list):
1890
from bzrlib.inventory import (Inventory,
1894
inv = Inventory(self.get_root_id())
1895
for path, file_id, parent, kind in new_inventory_list:
1896
name = os.path.basename(path)
1899
# fixme, there should be a factory function inv,add_??
1900
if kind == 'directory':
1901
inv.add(InventoryDirectory(file_id, name, parent))
1902
elif kind == 'file':
1903
inv.add(InventoryFile(file_id, name, parent))
1904
elif kind == 'symlink':
1905
inv.add(InventoryLink(file_id, name, parent))
1907
raise errors.BzrError("unknown kind %r" % kind)
1908
self._write_inventory(inv)
1910
def _write_basis_inventory(self, xml):
1911
"""Write the basis inventory XML to the basis-inventory file"""
1912
path = self._basis_inventory_name()
1914
self._transport.put_file(path, sio,
1915
mode=self.bzrdir._get_file_mode())
1917
def _reset_data(self):
1918
"""Reset transient data that cannot be revalidated."""
1919
self._inventory_is_modified = False
1920
f = self._transport.get('inventory')
2772
return self._control_files.unlock()
1922
result = self._deserialize(f)
2774
self.branch.unlock()
2777
class WorkingTree3(WorkingTree):
2778
"""This is the Format 3 working tree.
2780
This differs from the base WorkingTree by:
2781
- having its own file lock
2782
- having its own last-revision property.
2784
This is new in bzr 0.8
2788
def _last_revision(self):
2789
"""See Mutable.last_revision."""
1925
self._set_inventory(result, dirty=False)
1927
def _set_root_id(self, file_id):
1928
"""Set the root id for this tree, in a format specific manner.
1930
:param file_id: The file id to assign to the root. It must not be
1931
present in the current inventory or an error will occur. It must
1932
not be None, but rather a valid file id.
1934
inv = self._inventory
1935
orig_root_id = inv.root.file_id
1936
# TODO: it might be nice to exit early if there was nothing
1937
# to do, saving us from trigger a sync on unlock.
1938
self._inventory_is_modified = True
1939
# we preserve the root inventory entry object, but
1940
# unlinkit from the byid index
1941
del inv._byid[inv.root.file_id]
1942
inv.root.file_id = file_id
1943
# and link it into the index with the new changed id.
1944
inv._byid[inv.root.file_id] = inv.root
1945
# and finally update all children to reference the new id.
1946
# XXX: this should be safe to just look at the root.children
1947
# list, not the WHOLE INVENTORY.
1950
if entry.parent_id == orig_root_id:
1951
entry.parent_id = inv.root.file_id
1953
@needs_tree_write_lock
1954
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1955
"""See MutableTree.set_parent_trees."""
1956
parent_ids = [rev for (rev, tree) in parents_list]
1957
for revision_id in parent_ids:
1958
_mod_revision.check_not_reserved_id(revision_id)
1960
self._check_parents_for_ghosts(parent_ids,
1961
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1963
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1965
if len(parent_ids) == 0:
1966
leftmost_parent_id = _mod_revision.NULL_REVISION
1967
leftmost_parent_tree = None
1969
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1971
if self._change_last_revision(leftmost_parent_id):
1972
if leftmost_parent_tree is None:
1973
# If we don't have a tree, fall back to reading the
1974
# parent tree from the repository.
1975
self._cache_basis_inventory(leftmost_parent_id)
1977
inv = leftmost_parent_tree.root_inventory
1978
xml = self._create_basis_xml_from_inventory(
1979
leftmost_parent_id, inv)
1980
self._write_basis_inventory(xml)
1981
self._set_merges_from_parent_ids(parent_ids)
1983
def _cache_basis_inventory(self, new_revision):
1984
"""Cache new_revision as the basis inventory."""
1985
# TODO: this should allow the ready-to-use inventory to be passed in,
1986
# as commit already has that ready-to-use [while the format is the
2791
return self._transport.get_bytes('last-revision')
2792
except errors.NoSuchFile:
2793
return _mod_revision.NULL_REVISION
2795
def _change_last_revision(self, revision_id):
2796
"""See WorkingTree._change_last_revision."""
2797
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2799
self._transport.delete('last-revision')
2800
except errors.NoSuchFile:
2804
self._transport.put_bytes('last-revision', revision_id,
2805
mode=self.bzrdir._get_file_mode())
2808
def _get_check_refs(self):
2809
"""Return the references needed to perform a check of this tree."""
2810
return [('trees', self.last_revision())]
1989
# this double handles the inventory - unpack and repack -
1990
# but is easier to understand. We can/should put a conditional
1991
# in here based on whether the inventory is in the latest format
1992
# - perhaps we should repack all inventories on a repository
1994
# the fast path is to copy the raw xml from the repository. If the
1995
# xml contains 'revision_id="', then we assume the right
1996
# revision_id is set. We must check for this full string, because a
1997
# root node id can legitimately look like 'revision_id' but cannot
1999
xml = self.branch.repository._get_inventory_xml(new_revision)
2000
firstline = xml.split('\n', 1)[0]
2001
if (not 'revision_id="' in firstline or
2002
'format="7"' not in firstline):
2003
inv = self.branch.repository._serializer.read_inventory_from_string(
2005
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2006
self._write_basis_inventory(xml)
2007
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2010
def _basis_inventory_name(self):
2011
return 'basis-inventory-cache'
2013
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2014
"""Create the text that will be saved in basis-inventory"""
2015
inventory.revision_id = revision_id
2016
return xml7.serializer_v7.write_inventory_to_string(inventory)
2812
2018
@needs_tree_write_lock
2813
2019
def set_conflicts(self, conflicts):
2833
2039
raise errors.ConflictFormatError()
2834
2040
except StopIteration:
2835
2041
raise errors.ConflictFormatError()
2836
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2042
reader = _mod_rio.RioReader(confile)
2043
return _mod_conflicts.ConflictList.from_stanzas(reader)
2838
2045
confile.close()
2841
# do non-implementation specific cleanup
2843
if self._control_files._lock_count == 1:
2844
# _inventory_is_modified is always False during a read lock.
2845
if self._inventory_is_modified:
2847
self._write_hashcache_if_dirty()
2848
# reverse order of locking.
2850
return self._control_files.unlock()
2852
self.branch.unlock()
2855
def get_conflicted_stem(path):
2856
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2857
if path.endswith(suffix):
2858
return path[:-len(suffix)]
2861
class WorkingTreeFormat(object):
2047
def read_basis_inventory(self):
2048
"""Read the cached basis inventory."""
2049
path = self._basis_inventory_name()
2050
return self._transport.get_bytes(path)
2053
def read_working_inventory(self):
2054
"""Read the working inventory.
2056
:raises errors.InventoryModified: read_working_inventory will fail
2057
when the current in memory inventory has been modified.
2059
# conceptually this should be an implementation detail of the tree.
2060
# XXX: Deprecate this.
2061
# ElementTree does its own conversion from UTF-8, so open in
2063
if self._inventory_is_modified:
2064
raise errors.InventoryModified(self)
2065
f = self._transport.get('inventory')
2067
result = self._deserialize(f)
2070
self._set_inventory(result, dirty=False)
2074
def get_root_id(self):
2075
"""Return the id of this trees root"""
2076
return self._inventory.root.file_id
2078
def has_id(self, file_id):
2079
# files that have been deleted are excluded
2080
inv, inv_file_id = self._unpack_file_id(file_id)
2081
if not inv.has_id(inv_file_id):
2083
path = inv.id2path(inv_file_id)
2084
return osutils.lexists(self.abspath(path))
2086
def has_or_had_id(self, file_id):
2087
if file_id == self.root_inventory.root.file_id:
2089
inv, inv_file_id = self._unpack_file_id(file_id)
2090
return inv.has_id(inv_file_id)
2092
def all_file_ids(self):
2093
"""Iterate through file_ids for this tree.
2095
file_ids are in a WorkingTree if they are in the working inventory
2096
and the working file exists.
2099
for path, ie in self.iter_entries_by_dir():
2103
@needs_tree_write_lock
2104
def set_last_revision(self, new_revision):
2105
"""Change the last revision in the working tree."""
2106
if self._change_last_revision(new_revision):
2107
self._cache_basis_inventory(new_revision)
2109
def _get_check_refs(self):
2110
"""Return the references needed to perform a check of this tree.
2112
The default implementation returns no refs, and is only suitable for
2113
trees that have no local caching and can commit on ghosts at any time.
2115
:seealso: bzrlib.check for details about check_refs.
2120
def _check(self, references):
2121
"""Check the tree for consistency.
2123
:param references: A dict with keys matching the items returned by
2124
self._get_check_refs(), and values from looking those keys up in
2127
tree_basis = self.basis_tree()
2128
tree_basis.lock_read()
2130
repo_basis = references[('trees', self.last_revision())]
2131
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2132
raise errors.BzrCheckError(
2133
"Mismatched basis inventory content.")
2139
def check_state(self):
2140
"""Check that the working state is/isn't valid."""
2141
check_refs = self._get_check_refs()
2143
for ref in check_refs:
2146
refs[ref] = self.branch.repository.revision_tree(value)
2149
@needs_tree_write_lock
2150
def reset_state(self, revision_ids=None):
2151
"""Reset the state of the working tree.
2153
This does a hard-reset to a last-known-good state. This is a way to
2154
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2156
if revision_ids is None:
2157
revision_ids = self.get_parent_ids()
2158
if not revision_ids:
2159
rt = self.branch.repository.revision_tree(
2160
_mod_revision.NULL_REVISION)
2162
rt = self.branch.repository.revision_tree(revision_ids[0])
2163
self._write_inventory(rt.root_inventory)
2164
self.set_parent_ids(revision_ids)
2167
"""Write the in memory inventory to disk."""
2168
# TODO: Maybe this should only write on dirty ?
2169
if self._control_files._lock_mode != 'w':
2170
raise errors.NotWriteLocked(self)
2172
self._serialize(self._inventory, sio)
2174
self._transport.put_file('inventory', sio,
2175
mode=self.bzrdir._get_file_mode())
2176
self._inventory_is_modified = False
2178
def get_file_mtime(self, file_id, path=None):
2179
"""See Tree.get_file_mtime."""
2181
path = self.id2path(file_id)
2183
return os.lstat(self.abspath(path)).st_mtime
2185
if e.errno == errno.ENOENT:
2186
raise errors.FileTimestampUnavailable(path)
2189
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2190
inv, file_id = self._path2inv_file_id(path)
2192
# For unversioned files on win32, we just assume they are not
2195
return inv[file_id].executable
2197
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2198
mode = stat_result.st_mode
2199
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2201
def is_executable(self, file_id, path=None):
2202
if not self._supports_executable():
2203
inv, inv_file_id = self._unpack_file_id(file_id)
2204
return inv[inv_file_id].executable
2207
path = self.id2path(file_id)
2208
mode = os.lstat(self.abspath(path)).st_mode
2209
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2211
def _is_executable_from_path_and_stat(self, path, stat_result):
2212
if not self._supports_executable():
2213
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2215
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2217
@needs_tree_write_lock
2218
def _add(self, files, ids, kinds):
2219
"""See MutableTree._add."""
2220
# TODO: Re-adding a file that is removed in the working copy
2221
# should probably put it back with the previous ID.
2222
# the read and write working inventory should not occur in this
2223
# function - they should be part of lock_write and unlock.
2224
# FIXME: nested trees
2225
inv = self.root_inventory
2226
for f, file_id, kind in zip(files, ids, kinds):
2228
inv.add_path(f, kind=kind)
2230
inv.add_path(f, kind=kind, file_id=file_id)
2231
self._inventory_is_modified = True
2233
def revision_tree(self, revision_id):
2234
"""See WorkingTree.revision_id."""
2235
if revision_id == self.last_revision():
2237
xml = self.read_basis_inventory()
2238
except errors.NoSuchFile:
2242
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2243
# dont use the repository revision_tree api because we want
2244
# to supply the inventory.
2245
if inv.revision_id == revision_id:
2246
return revisiontree.InventoryRevisionTree(
2247
self.branch.repository, inv, revision_id)
2248
except errors.BadInventoryFormat:
2250
# raise if there was no inventory, or if we read the wrong inventory.
2251
raise errors.NoSuchRevisionInTree(self, revision_id)
2254
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2255
"""See Tree.annotate_iter
2257
This implementation will use the basis tree implementation if possible.
2258
Lines not in the basis are attributed to CURRENT_REVISION
2260
If there are pending merges, lines added by those merges will be
2261
incorrectly attributed to CURRENT_REVISION (but after committing, the
2262
attribution will be correct).
2264
maybe_file_parent_keys = []
2265
for parent_id in self.get_parent_ids():
2267
parent_tree = self.revision_tree(parent_id)
2268
except errors.NoSuchRevisionInTree:
2269
parent_tree = self.branch.repository.revision_tree(parent_id)
2270
parent_tree.lock_read()
2273
kind = parent_tree.kind(file_id)
2274
except errors.NoSuchId:
2277
# Note: this is slightly unnecessary, because symlinks and
2278
# directories have a "text" which is the empty text, and we
2279
# know that won't mess up annotations. But it seems cleaner
2282
file_id, parent_tree.get_file_revision(file_id))
2283
if parent_text_key not in maybe_file_parent_keys:
2284
maybe_file_parent_keys.append(parent_text_key)
2286
parent_tree.unlock()
2287
graph = _mod_graph.Graph(self.branch.repository.texts)
2288
heads = graph.heads(maybe_file_parent_keys)
2289
file_parent_keys = []
2290
for key in maybe_file_parent_keys:
2292
file_parent_keys.append(key)
2294
# Now we have the parents of this content
2295
annotator = self.branch.repository.texts.get_annotator()
2296
text = self.get_file_text(file_id)
2297
this_key =(file_id, default_revision)
2298
annotator.add_special_text(this_key, file_parent_keys, text)
2299
annotations = [(key[-1], line)
2300
for key, line in annotator.annotate_flat(this_key)]
2303
def _put_rio(self, filename, stanzas, header):
2304
self._must_be_locked()
2305
my_file = _mod_rio.rio_file(stanzas, header)
2306
self._transport.put_file(filename, my_file,
2307
mode=self.bzrdir._get_file_mode())
2309
@needs_tree_write_lock
2310
def set_merge_modified(self, modified_hashes):
2312
for file_id, hash in modified_hashes.iteritems():
2313
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2315
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2318
def merge_modified(self):
2319
"""Return a dictionary of files modified by a merge.
2321
The list is initialized by WorkingTree.set_merge_modified, which is
2322
typically called after we make some automatic updates to the tree
2325
This returns a map of file_id->sha1, containing only files which are
2326
still in the working inventory and have that text hash.
2329
hashfile = self._transport.get('merge-hashes')
2330
except errors.NoSuchFile:
2335
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2336
raise errors.MergeModifiedFormatError()
2337
except StopIteration:
2338
raise errors.MergeModifiedFormatError()
2339
for s in _mod_rio.RioReader(hashfile):
2340
# RioReader reads in Unicode, so convert file_ids back to utf8
2341
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2342
if not self.has_id(file_id):
2344
text_hash = s.get("hash")
2345
if text_hash == self.get_file_sha1(file_id):
2346
merge_hashes[file_id] = text_hash
2352
def subsume(self, other_tree):
2353
def add_children(inventory, entry):
2354
for child_entry in entry.children.values():
2355
inventory._byid[child_entry.file_id] = child_entry
2356
if child_entry.kind == 'directory':
2357
add_children(inventory, child_entry)
2358
if other_tree.get_root_id() == self.get_root_id():
2359
raise errors.BadSubsumeSource(self, other_tree,
2360
'Trees have the same root')
2362
other_tree_path = self.relpath(other_tree.basedir)
2363
except errors.PathNotChild:
2364
raise errors.BadSubsumeSource(self, other_tree,
2365
'Tree is not contained by the other')
2366
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2367
if new_root_parent is None:
2368
raise errors.BadSubsumeSource(self, other_tree,
2369
'Parent directory is not versioned.')
2370
# We need to ensure that the result of a fetch will have a
2371
# versionedfile for the other_tree root, and only fetching into
2372
# RepositoryKnit2 guarantees that.
2373
if not self.branch.repository.supports_rich_root():
2374
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2375
other_tree.lock_tree_write()
2377
new_parents = other_tree.get_parent_ids()
2378
other_root = other_tree.root_inventory.root
2379
other_root.parent_id = new_root_parent
2380
other_root.name = osutils.basename(other_tree_path)
2381
self.root_inventory.add(other_root)
2382
add_children(self.root_inventory, other_root)
2383
self._write_inventory(self.root_inventory)
2384
# normally we don't want to fetch whole repositories, but i think
2385
# here we really do want to consolidate the whole thing.
2386
for parent_id in other_tree.get_parent_ids():
2387
self.branch.fetch(other_tree.branch, parent_id)
2388
self.add_parent_tree_id(parent_id)
2391
other_tree.bzrdir.retire_bzrdir()
2393
@needs_tree_write_lock
2394
def extract(self, file_id, format=None):
2395
"""Extract a subtree from this tree.
2397
A new branch will be created, relative to the path for this tree.
2401
segments = osutils.splitpath(path)
2402
transport = self.branch.bzrdir.root_transport
2403
for name in segments:
2404
transport = transport.clone(name)
2405
transport.ensure_base()
2408
sub_path = self.id2path(file_id)
2409
branch_transport = mkdirs(sub_path)
2411
format = self.bzrdir.cloning_metadir()
2412
branch_transport.ensure_base()
2413
branch_bzrdir = format.initialize_on_transport(branch_transport)
2415
repo = branch_bzrdir.find_repository()
2416
except errors.NoRepositoryPresent:
2417
repo = branch_bzrdir.create_repository()
2418
if not repo.supports_rich_root():
2419
raise errors.RootNotRich()
2420
new_branch = branch_bzrdir.create_branch()
2421
new_branch.pull(self.branch)
2422
for parent_id in self.get_parent_ids():
2423
new_branch.fetch(self.branch, parent_id)
2424
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2425
if tree_transport.base != branch_transport.base:
2426
tree_bzrdir = format.initialize_on_transport(tree_transport)
2427
tree_bzrdir.set_branch_reference(new_branch)
2429
tree_bzrdir = branch_bzrdir
2430
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2431
wt.set_parent_ids(self.get_parent_ids())
2432
# FIXME: Support nested trees
2433
my_inv = self.root_inventory
2434
child_inv = inventory.Inventory(root_id=None)
2435
new_root = my_inv[file_id]
2436
my_inv.remove_recursive_id(file_id)
2437
new_root.parent_id = None
2438
child_inv.add(new_root)
2439
self._write_inventory(my_inv)
2440
wt._write_inventory(child_inv)
2443
def list_files(self, include_root=False, from_dir=None, recursive=True):
2444
"""List all files as (path, class, kind, id, entry).
2446
Lists, but does not descend into unversioned directories.
2447
This does not include files that have been deleted in this
2448
tree. Skips the control directory.
2450
:param include_root: if True, return an entry for the root
2451
:param from_dir: start from this directory or None for the root
2452
:param recursive: whether to recurse into subdirectories or not
2454
# list_files is an iterator, so @needs_read_lock doesn't work properly
2455
# with it. So callers should be careful to always read_lock the tree.
2456
if not self.is_locked():
2457
raise errors.ObjectNotLocked(self)
2459
if from_dir is None and include_root is True:
2460
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2461
# Convert these into local objects to save lookup times
2462
pathjoin = osutils.pathjoin
2463
file_kind = self._kind
2465
# transport.base ends in a slash, we want the piece
2466
# between the last two slashes
2467
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2469
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2471
# directory file_id, relative path, absolute path, reverse sorted children
2472
if from_dir is not None:
2473
inv, from_dir_id = self._path2inv_file_id(from_dir)
2474
if from_dir_id is None:
2475
# Directory not versioned
2477
from_dir_abspath = pathjoin(self.basedir, from_dir)
2479
inv = self.root_inventory
2480
from_dir_id = inv.root.file_id
2481
from_dir_abspath = self.basedir
2482
children = os.listdir(from_dir_abspath)
2484
# jam 20060527 The kernel sized tree seems equivalent whether we
2485
# use a deque and popleft to keep them sorted, or if we use a plain
2486
# list and just reverse() them.
2487
children = collections.deque(children)
2488
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2490
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2493
f = children.popleft()
2494
## TODO: If we find a subdirectory with its own .bzr
2495
## directory, then that is a separate tree and we
2496
## should exclude it.
2498
# the bzrdir for this tree
2499
if transport_base_dir == f:
2502
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2503
# and 'f' doesn't begin with one, we can do a string op, rather
2504
# than the checks of pathjoin(), all relative paths will have an extra slash
2506
fp = from_dir_relpath + '/' + f
2509
fap = from_dir_abspath + '/' + f
2511
dir_ie = inv[from_dir_id]
2512
if dir_ie.kind == 'directory':
2513
f_ie = dir_ie.children.get(f)
2518
elif self.is_ignored(fp[1:]):
2521
# we may not have found this file, because of a unicode
2522
# issue, or because the directory was actually a symlink.
2523
f_norm, can_access = osutils.normalized_filename(f)
2524
if f == f_norm or not can_access:
2525
# No change, so treat this file normally
2528
# this file can be accessed by a normalized path
2529
# check again if it is versioned
2530
# these lines are repeated here for performance
2532
fp = from_dir_relpath + '/' + f
2533
fap = from_dir_abspath + '/' + f
2534
f_ie = inv.get_child(from_dir_id, f)
2537
elif self.is_ignored(fp[1:]):
2544
# make a last minute entry
2546
yield fp[1:], c, fk, f_ie.file_id, f_ie
2549
yield fp[1:], c, fk, None, fk_entries[fk]()
2551
yield fp[1:], c, fk, None, TreeEntry()
2554
if fk != 'directory':
2557
# But do this child first if recursing down
2559
new_children = os.listdir(fap)
2561
new_children = collections.deque(new_children)
2562
stack.append((f_ie.file_id, fp, fap, new_children))
2563
# Break out of inner loop,
2564
# so that we start outer loop with child
2567
# if we finished all children, pop it off the stack
2570
@needs_tree_write_lock
2571
def move(self, from_paths, to_dir=None, after=False):
2574
to_dir must exist in the inventory.
2576
If to_dir exists and is a directory, the files are moved into
2577
it, keeping their old names.
2579
Note that to_dir is only the last component of the new name;
2580
this doesn't change the directory.
2582
For each entry in from_paths the move mode will be determined
2585
The first mode moves the file in the filesystem and updates the
2586
inventory. The second mode only updates the inventory without
2587
touching the file on the filesystem.
2589
move uses the second mode if 'after == True' and the target is
2590
either not versioned or newly added, and present in the working tree.
2592
move uses the second mode if 'after == False' and the source is
2593
versioned but no longer in the working tree, and the target is not
2594
versioned but present in the working tree.
2596
move uses the first mode if 'after == False' and the source is
2597
versioned and present in the working tree, and the target is not
2598
versioned and not present in the working tree.
2600
Everything else results in an error.
2602
This returns a list of (from_path, to_path) pairs for each
2603
entry that is moved.
2608
invs_to_write = set()
2610
# check for deprecated use of signature
2612
raise TypeError('You must supply a target directory')
2613
# check destination directory
2614
if isinstance(from_paths, basestring):
2616
to_abs = self.abspath(to_dir)
2617
if not isdir(to_abs):
2618
raise errors.BzrMoveFailedError('',to_dir,
2619
errors.NotADirectory(to_abs))
2620
if not self.has_filename(to_dir):
2621
raise errors.BzrMoveFailedError('',to_dir,
2622
errors.NotInWorkingDirectory(to_dir))
2623
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2624
if to_dir_id is None:
2625
raise errors.BzrMoveFailedError('',to_dir,
2626
errors.NotVersionedError(path=to_dir))
2628
to_dir_ie = to_inv[to_dir_id]
2629
if to_dir_ie.kind != 'directory':
2630
raise errors.BzrMoveFailedError('',to_dir,
2631
errors.NotADirectory(to_abs))
2633
# create rename entries and tuples
2634
for from_rel in from_paths:
2635
from_tail = splitpath(from_rel)[-1]
2636
from_inv, from_id = self._path2inv_file_id(from_rel)
2638
raise errors.BzrMoveFailedError(from_rel,to_dir,
2639
errors.NotVersionedError(path=from_rel))
2641
from_entry = from_inv[from_id]
2642
from_parent_id = from_entry.parent_id
2643
to_rel = pathjoin(to_dir, from_tail)
2644
rename_entry = InventoryWorkingTree._RenameEntry(
2647
from_tail=from_tail,
2648
from_parent_id=from_parent_id,
2649
to_rel=to_rel, to_tail=from_tail,
2650
to_parent_id=to_dir_id)
2651
rename_entries.append(rename_entry)
2652
rename_tuples.append((from_rel, to_rel))
2654
# determine which move mode to use. checks also for movability
2655
rename_entries = self._determine_mv_mode(rename_entries, after)
2657
original_modified = self._inventory_is_modified
2660
self._inventory_is_modified = True
2661
self._move(rename_entries)
2663
# restore the inventory on error
2664
self._inventory_is_modified = original_modified
2666
#FIXME: Should potentially also write the from_invs
2667
self._write_inventory(to_inv)
2668
return rename_tuples
2670
@needs_tree_write_lock
2671
def rename_one(self, from_rel, to_rel, after=False):
2674
This can change the directory or the filename or both.
2676
rename_one has several 'modes' to work. First, it can rename a physical
2677
file and change the file_id. That is the normal mode. Second, it can
2678
only change the file_id without touching any physical file.
2680
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2681
versioned but present in the working tree.
2683
rename_one uses the second mode if 'after == False' and 'from_rel' is
2684
versioned but no longer in the working tree, and 'to_rel' is not
2685
versioned but present in the working tree.
2687
rename_one uses the first mode if 'after == False' and 'from_rel' is
2688
versioned and present in the working tree, and 'to_rel' is not
2689
versioned and not present in the working tree.
2691
Everything else results in an error.
2695
# create rename entries and tuples
2696
from_tail = splitpath(from_rel)[-1]
2697
from_inv, from_id = self._path2inv_file_id(from_rel)
2699
# if file is missing in the inventory maybe it's in the basis_tree
2700
basis_tree = self.branch.basis_tree()
2701
from_id = basis_tree.path2id(from_rel)
2703
raise errors.BzrRenameFailedError(from_rel,to_rel,
2704
errors.NotVersionedError(path=from_rel))
2705
# put entry back in the inventory so we can rename it
2706
from_entry = basis_tree.root_inventory[from_id].copy()
2707
from_inv.add(from_entry)
2709
from_inv, from_inv_id = self._unpack_file_id(from_id)
2710
from_entry = from_inv[from_inv_id]
2711
from_parent_id = from_entry.parent_id
2712
to_dir, to_tail = os.path.split(to_rel)
2713
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2714
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2716
from_tail=from_tail,
2717
from_parent_id=from_parent_id,
2718
to_rel=to_rel, to_tail=to_tail,
2719
to_parent_id=to_dir_id)
2720
rename_entries.append(rename_entry)
2722
# determine which move mode to use. checks also for movability
2723
rename_entries = self._determine_mv_mode(rename_entries, after)
2725
# check if the target changed directory and if the target directory is
2727
if to_dir_id is None:
2728
raise errors.BzrMoveFailedError(from_rel,to_rel,
2729
errors.NotVersionedError(path=to_dir))
2731
# all checks done. now we can continue with our actual work
2732
mutter('rename_one:\n'
2737
' to_dir_id {%s}\n',
2738
from_id, from_rel, to_rel, to_dir, to_dir_id)
2740
self._move(rename_entries)
2741
self._write_inventory(to_inv)
2743
class _RenameEntry(object):
2744
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2745
to_rel, to_tail, to_parent_id, only_change_inv=False,
2747
self.from_rel = from_rel
2748
self.from_id = from_id
2749
self.from_tail = from_tail
2750
self.from_parent_id = from_parent_id
2751
self.to_rel = to_rel
2752
self.to_tail = to_tail
2753
self.to_parent_id = to_parent_id
2754
self.change_id = change_id
2755
self.only_change_inv = only_change_inv
2757
def _determine_mv_mode(self, rename_entries, after=False):
2758
"""Determines for each from-to pair if both inventory and working tree
2759
or only the inventory has to be changed.
2761
Also does basic plausability tests.
2763
# FIXME: Handling of nested trees
2764
inv = self.root_inventory
2766
for rename_entry in rename_entries:
2767
# store to local variables for easier reference
2768
from_rel = rename_entry.from_rel
2769
from_id = rename_entry.from_id
2770
to_rel = rename_entry.to_rel
2771
to_id = inv.path2id(to_rel)
2772
only_change_inv = False
2775
# check the inventory for source and destination
2777
raise errors.BzrMoveFailedError(from_rel,to_rel,
2778
errors.NotVersionedError(path=from_rel))
2779
if to_id is not None:
2781
# allow it with --after but only if dest is newly added
2783
basis = self.basis_tree()
2786
if not basis.has_id(to_id):
2787
rename_entry.change_id = True
2792
raise errors.BzrMoveFailedError(from_rel,to_rel,
2793
errors.AlreadyVersionedError(path=to_rel))
2795
# try to determine the mode for rename (only change inv or change
2796
# inv and file system)
2798
if not self.has_filename(to_rel):
2799
raise errors.BzrMoveFailedError(from_id,to_rel,
2800
errors.NoSuchFile(path=to_rel,
2801
extra="New file has not been created yet"))
2802
only_change_inv = True
2803
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2804
only_change_inv = True
2805
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2806
only_change_inv = False
2807
elif (not self.case_sensitive
2808
and from_rel.lower() == to_rel.lower()
2809
and self.has_filename(from_rel)):
2810
only_change_inv = False
2812
# something is wrong, so lets determine what exactly
2813
if not self.has_filename(from_rel) and \
2814
not self.has_filename(to_rel):
2815
raise errors.BzrRenameFailedError(from_rel, to_rel,
2816
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2818
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2819
rename_entry.only_change_inv = only_change_inv
2820
return rename_entries
2822
def _move(self, rename_entries):
2823
"""Moves a list of files.
2825
Depending on the value of the flag 'only_change_inv', the
2826
file will be moved on the file system or not.
2830
for entry in rename_entries:
2832
self._move_entry(entry)
2834
self._rollback_move(moved)
2838
def _rollback_move(self, moved):
2839
"""Try to rollback a previous move in case of an filesystem error."""
2842
self._move_entry(WorkingTree._RenameEntry(
2843
entry.to_rel, entry.from_id,
2844
entry.to_tail, entry.to_parent_id, entry.from_rel,
2845
entry.from_tail, entry.from_parent_id,
2846
entry.only_change_inv))
2847
except errors.BzrMoveFailedError, e:
2848
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2849
" The working tree is in an inconsistent state."
2850
" Please consider doing a 'bzr revert'."
2851
" Error message is: %s" % e)
2853
def _move_entry(self, entry):
2854
inv = self.root_inventory
2855
from_rel_abs = self.abspath(entry.from_rel)
2856
to_rel_abs = self.abspath(entry.to_rel)
2857
if from_rel_abs == to_rel_abs:
2858
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2859
"Source and target are identical.")
2861
if not entry.only_change_inv:
2863
osutils.rename(from_rel_abs, to_rel_abs)
2865
raise errors.BzrMoveFailedError(entry.from_rel,
2868
to_id = inv.path2id(entry.to_rel)
2869
inv.remove_recursive_id(to_id)
2870
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2872
@needs_tree_write_lock
2873
def unversion(self, file_ids):
2874
"""Remove the file ids in file_ids from the current versioned set.
2876
When a file_id is unversioned, all of its children are automatically
2879
:param file_ids: The file ids to stop versioning.
2880
:raises: NoSuchId if any fileid is not currently versioned.
2882
for file_id in file_ids:
2883
if not self._inventory.has_id(file_id):
2884
raise errors.NoSuchId(self, file_id)
2885
for file_id in file_ids:
2886
if self._inventory.has_id(file_id):
2887
self._inventory.remove_recursive_id(file_id)
2889
# in the future this should just set a dirty bit to wait for the
2890
# final unlock. However, until all methods of workingtree start
2891
# with the current in -memory inventory rather than triggering
2892
# a read, it is more complex - we need to teach read_inventory
2893
# to know when to read, and when to not read first... and possibly
2894
# to save first when the in memory one may be corrupted.
2895
# so for now, we just only write it if it is indeed dirty.
2897
self._write_inventory(self._inventory)
2899
def stored_kind(self, file_id):
2900
"""See Tree.stored_kind"""
2901
inv, inv_file_id = self._unpack_file_id(file_id)
2902
return inv[inv_file_id].kind
2905
"""Yield all unversioned files in this WorkingTree.
2907
If there are any unversioned directories then only the directory is
2908
returned, not all its children. But if there are unversioned files
2909
under a versioned subdirectory, they are returned.
2911
Currently returned depth-first, sorted by name within directories.
2912
This is the same order used by 'osutils.walkdirs'.
2914
## TODO: Work from given directory downwards
2915
for path, dir_entry in self.root_inventory.directories():
2916
# mutter("search for unknowns in %r", path)
2917
dirabs = self.abspath(path)
2918
if not isdir(dirabs):
2919
# e.g. directory deleted
2923
for subf in os.listdir(dirabs):
2924
if self.bzrdir.is_control_filename(subf):
2926
if subf not in dir_entry.children:
2929
can_access) = osutils.normalized_filename(subf)
2930
except UnicodeDecodeError:
2931
path_os_enc = path.encode(osutils._fs_enc)
2932
relpath = path_os_enc + '/' + subf
2933
raise errors.BadFilenameEncoding(relpath,
2935
if subf_norm != subf and can_access:
2936
if subf_norm not in dir_entry.children:
2937
fl.append(subf_norm)
2943
subp = pathjoin(path, subf)
2946
def _walkdirs(self, prefix=""):
2947
"""Walk the directories of this tree.
2949
:param prefix: is used as the directrory to start with.
2950
:returns: a generator which yields items in the form::
2952
((curren_directory_path, fileid),
2953
[(file1_path, file1_name, file1_kind, None, file1_id,
2956
_directory = 'directory'
2957
# get the root in the inventory
2958
inv, top_id = self._path2inv_file_id(prefix)
2962
pending = [(prefix, '', _directory, None, top_id, None)]
2965
currentdir = pending.pop()
2966
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2967
top_id = currentdir[4]
2969
relroot = currentdir[0] + '/'
2972
# FIXME: stash the node in pending
2974
if entry.kind == 'directory':
2975
for name, child in entry.sorted_children():
2976
dirblock.append((relroot + name, name, child.kind, None,
2977
child.file_id, child.kind
2979
yield (currentdir[0], entry.file_id), dirblock
2980
# push the user specified dirs from dirblock
2981
for dir in reversed(dirblock):
2982
if dir[2] == _directory:
2986
def update_feature_flags(self, updated_flags):
2987
"""Update the feature flags for this branch.
2989
:param updated_flags: Dictionary mapping feature names to necessities
2990
A necessity can be None to indicate the feature should be removed
2992
self._format._update_feature_flags(updated_flags)
2993
self.control_transport.put_bytes('format', self._format.as_string())
2996
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2997
"""Registry for working tree formats."""
2999
def __init__(self, other_registry=None):
3000
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
3001
self._default_format = None
3002
self._default_format_key = None
3004
def get_default(self):
3005
"""Return the current default format."""
3006
if (self._default_format_key is not None and
3007
self._default_format is None):
3008
self._default_format = self.get(self._default_format_key)
3009
return self._default_format
3011
def set_default(self, format):
3012
"""Set the default format."""
3013
self._default_format = format
3014
self._default_format_key = None
3016
def set_default_key(self, format_string):
3017
"""Set the default format by its format string."""
3018
self._default_format_key = format_string
3019
self._default_format = None
3022
format_registry = WorkingTreeFormatRegistry()
3025
class WorkingTreeFormat(controldir.ControlComponentFormat):
2862
3026
"""An encapsulation of the initialization and open routines for a format.
2864
3028
Formats provide three things:
3108
@symbol_versioning.deprecated_method(
3109
symbol_versioning.deprecated_in((2, 4, 0)))
2949
3110
def register_format(klass, format):
2950
klass._formats[format.get_format_string()] = format
3111
format_registry.register(format)
3114
@symbol_versioning.deprecated_method(
3115
symbol_versioning.deprecated_in((2, 4, 0)))
2953
3116
def register_extra_format(klass, format):
2954
klass._extra_formats.append(format)
3117
format_registry.register_extra(format)
3120
@symbol_versioning.deprecated_method(
3121
symbol_versioning.deprecated_in((2, 4, 0)))
2957
3122
def unregister_extra_format(klass, format):
2958
klass._extra_formats.remove(format)
3123
format_registry.unregister_extra(format)
3126
@symbol_versioning.deprecated_method(
3127
symbol_versioning.deprecated_in((2, 4, 0)))
2961
3128
def get_formats(klass):
2962
return klass._formats.values() + klass._extra_formats
3129
return format_registry._get_all()
3132
@symbol_versioning.deprecated_method(
3133
symbol_versioning.deprecated_in((2, 4, 0)))
2965
3134
def set_default_format(klass, format):
2966
klass._default_format = format
3135
format_registry.set_default(format)
3138
@symbol_versioning.deprecated_method(
3139
symbol_versioning.deprecated_in((2, 4, 0)))
2969
3140
def unregister_format(klass, format):
2970
del klass._formats[format.get_format_string()]
2973
class WorkingTreeFormat2(WorkingTreeFormat):
2974
"""The second working tree format.
2976
This format modified the hash cache from the format 1 hash cache.
2979
upgrade_recommended = True
2981
requires_normalized_unicode_filenames = True
2983
case_sensitive_filename = "Branch-FoRMaT"
2985
missing_parent_conflicts = False
2987
def get_format_description(self):
2988
"""See WorkingTreeFormat.get_format_description()."""
2989
return "Working tree format 2"
2991
def _stub_initialize_on_transport(self, transport, file_mode):
2992
"""Workaround: create control files for a remote working tree.
2994
This ensures that it can later be updated and dealt with locally,
2995
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2996
no working tree. (See bug #43064).
2999
inv = inventory.Inventory()
3000
xml5.serializer_v5.write_inventory(inv, sio, working=True)
3002
transport.put_file('inventory', sio, file_mode)
3003
transport.put_bytes('pending-merges', '', file_mode)
3005
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3006
accelerator_tree=None, hardlink=False):
3007
"""See WorkingTreeFormat.initialize()."""
3008
if not isinstance(a_bzrdir.transport, LocalTransport):
3009
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3010
if from_branch is not None:
3011
branch = from_branch
3013
branch = a_bzrdir.open_branch()
3014
if revision_id is None:
3015
revision_id = _mod_revision.ensure_null(branch.last_revision())
3018
branch.generate_revision_history(revision_id)
3021
inv = inventory.Inventory()
3022
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
3028
_control_files=branch.control_files)
3029
basis_tree = branch.repository.revision_tree(revision_id)
3030
if basis_tree.inventory.root is not None:
3031
wt.set_root_id(basis_tree.get_root_id())
3032
# set the parent list and cache the basis tree.
3033
if _mod_revision.is_null(revision_id):
3036
parent_trees = [(revision_id, basis_tree)]
3037
wt.set_parent_trees(parent_trees)
3038
transform.build_tree(basis_tree, wt)
3042
super(WorkingTreeFormat2, self).__init__()
3043
self._matchingbzrdir = bzrdir.BzrDirFormat6()
3045
def open(self, a_bzrdir, _found=False):
3046
"""Return the WorkingTree object for a_bzrdir
3048
_found is a private parameter, do not use it. It is used to indicate
3049
if format probing has already been done.
3052
# we are being called directly and must probe.
3053
raise NotImplementedError
3054
if not isinstance(a_bzrdir.transport, LocalTransport):
3055
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3056
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
3060
_control_files=a_bzrdir.open_branch().control_files)
3063
class WorkingTreeFormat3(WorkingTreeFormat):
3064
"""The second working tree format updated to record a format marker.
3067
- exists within a metadir controlling .bzr
3068
- includes an explicit version marker for the workingtree control
3069
files, separate from the BzrDir format
3070
- modifies the hash cache format
3072
- uses a LockDir to guard access for writes.
3075
upgrade_recommended = True
3077
missing_parent_conflicts = True
3079
def get_format_string(self):
3080
"""See WorkingTreeFormat.get_format_string()."""
3081
return "Bazaar-NG Working Tree format 3"
3083
def get_format_description(self):
3084
"""See WorkingTreeFormat.get_format_description()."""
3085
return "Working tree format 3"
3087
_lock_file_name = 'lock'
3088
_lock_class = LockDir
3090
_tree_class = WorkingTree3
3092
def __get_matchingbzrdir(self):
3093
return bzrdir.BzrDirMetaFormat1()
3095
_matchingbzrdir = property(__get_matchingbzrdir)
3097
def _open_control_files(self, a_bzrdir):
3098
transport = a_bzrdir.get_workingtree_transport(None)
3099
return LockableFiles(transport, self._lock_file_name,
3102
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3103
accelerator_tree=None, hardlink=False):
3104
"""See WorkingTreeFormat.initialize().
3106
:param revision_id: if supplied, create a working tree at a different
3107
revision than the branch is at.
3108
:param accelerator_tree: A tree which can be used for retrieving file
3109
contents more quickly than the revision tree, i.e. a workingtree.
3110
The revision tree will be used for cases where accelerator_tree's
3111
content is different.
3112
:param hardlink: If true, hard-link files from accelerator_tree,
3115
if not isinstance(a_bzrdir.transport, LocalTransport):
3116
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3117
transport = a_bzrdir.get_workingtree_transport(self)
3118
control_files = self._open_control_files(a_bzrdir)
3119
control_files.create_lock()
3120
control_files.lock_write()
3121
transport.put_bytes('format', self.get_format_string(),
3122
mode=a_bzrdir._get_file_mode())
3123
if from_branch is not None:
3124
branch = from_branch
3126
branch = a_bzrdir.open_branch()
3127
if revision_id is None:
3128
revision_id = _mod_revision.ensure_null(branch.last_revision())
3129
# WorkingTree3 can handle an inventory which has a unique root id.
3130
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3131
# those trees. And because there isn't a format bump inbetween, we
3132
# are maintaining compatibility with older clients.
3133
# inv = Inventory(root_id=gen_root_id())
3134
inv = self._initial_inventory()
3135
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3141
_control_files=control_files)
3142
wt.lock_tree_write()
3144
basis_tree = branch.repository.revision_tree(revision_id)
3145
# only set an explicit root id if there is one to set.
3146
if basis_tree.inventory.root is not None:
3147
wt.set_root_id(basis_tree.get_root_id())
3148
if revision_id == _mod_revision.NULL_REVISION:
3149
wt.set_parent_trees([])
3151
wt.set_parent_trees([(revision_id, basis_tree)])
3152
transform.build_tree(basis_tree, wt)
3154
# Unlock in this order so that the unlock-triggers-flush in
3155
# WorkingTree is given a chance to fire.
3156
control_files.unlock()
3160
def _initial_inventory(self):
3161
return inventory.Inventory()
3164
super(WorkingTreeFormat3, self).__init__()
3166
def open(self, a_bzrdir, _found=False):
3167
"""Return the WorkingTree object for a_bzrdir
3169
_found is a private parameter, do not use it. It is used to indicate
3170
if format probing has already been done.
3173
# we are being called directly and must probe.
3174
raise NotImplementedError
3175
if not isinstance(a_bzrdir.transport, LocalTransport):
3176
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3177
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3180
def _open(self, a_bzrdir, control_files):
3181
"""Open the tree itself.
3183
:param a_bzrdir: the dir for the tree.
3184
:param control_files: the control files for the tree.
3186
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3190
_control_files=control_files)
3193
return self.get_format_string()
3196
__default_format = WorkingTreeFormat6()
3197
WorkingTreeFormat.register_format(__default_format)
3198
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3199
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3200
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3201
WorkingTreeFormat.set_default_format(__default_format)
3202
# Register extra formats which have no format string are not discoverable
3203
# and not independently creatable. They are implicitly created as part of
3204
# e.g. older Bazaar formats or foreign formats.
3205
WorkingTreeFormat.register_extra_format(WorkingTreeFormat2())
3141
format_registry.remove(format)
3143
def get_controldir_for_branch(self):
3144
"""Get the control directory format for creating branches.
3146
This is to support testing of working tree formats that can not exist
3147
in the same control directory as a branch.
3149
return self._matchingbzrdir
3152
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3153
"""Base class for working trees that live in bzr meta directories."""
3156
WorkingTreeFormat.__init__(self)
3157
bzrdir.BzrFormat.__init__(self)
3160
def find_format_string(klass, controldir):
3161
"""Return format name for the working tree object in controldir."""
3163
transport = controldir.get_workingtree_transport(None)
3164
return transport.get_bytes("format")
3165
except errors.NoSuchFile:
3166
raise errors.NoWorkingTree(base=transport.base)
3169
def find_format(klass, controldir):
3170
"""Return the format for the working tree object in controldir."""
3171
format_string = klass.find_format_string(controldir)
3172
return klass._find_format(format_registry, 'working tree',
3175
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3177
WorkingTreeFormat.check_support_status(self,
3178
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3180
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3181
recommend_upgrade=recommend_upgrade, basedir=basedir)
3184
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3185
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3186
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3187
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3188
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3189
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3190
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3191
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3192
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
