2608
1767
return ShelfManager(self, self._transport)
2611
class WorkingTree2(WorkingTree):
2612
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2615
- uses os locks for locking.
2616
- uses the branch last-revision.
1770
class InventoryWorkingTree(WorkingTree,
1771
bzrlib.mutabletree.MutableInventoryTree):
1772
"""Base class for working trees that are inventory-oriented.
1774
The inventory is held in the `Branch` working-inventory, and the
1775
files are in a directory on disk.
1777
It is possible for a `WorkingTree` to have a filename which is
1778
not listed in the Inventory and vice versa.
2619
def __init__(self, *args, **kwargs):
2620
super(WorkingTree2, self).__init__(*args, **kwargs)
2621
# WorkingTree2 has more of a constraint that self._inventory must
2622
# exist. Because this is an older format, we don't mind the overhead
2623
# caused by the extra computation here.
2625
# Newer WorkingTree's should only have self._inventory set when they
2627
if self._inventory is None:
2628
self.read_working_inventory()
2630
def _get_check_refs(self):
2631
"""Return the references needed to perform a check of this tree."""
2632
return [('trees', self.last_revision())]
1781
def __init__(self, basedir='.',
1782
branch=DEPRECATED_PARAMETER,
1784
_control_files=None,
1788
"""Construct a InventoryWorkingTree instance. This is not a public API.
1790
:param branch: A branch to override probing for the branch.
1792
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1793
branch=branch, _transport=_control_files._transport,
1794
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1796
self._control_files = _control_files
1797
self._detect_case_handling()
1799
if _inventory is None:
1800
# This will be acquired on lock_read() or lock_write()
1801
self._inventory_is_modified = False
1802
self._inventory = None
1804
# the caller of __init__ has provided an inventory,
1805
# we assume they know what they are doing - as its only
1806
# the Format factory and creation methods that are
1807
# permitted to do this.
1808
self._set_inventory(_inventory, dirty=False)
1810
def _set_inventory(self, inv, dirty):
1811
"""Set the internal cached inventory.
1813
:param inv: The inventory to set.
1814
:param dirty: A boolean indicating whether the inventory is the same
1815
logical inventory as whats on disk. If True the inventory is not
1816
the same and should be written to disk or data will be lost, if
1817
False then the inventory is the same as that on disk and any
1818
serialisation would be unneeded overhead.
1820
self._inventory = inv
1821
self._inventory_is_modified = dirty
1823
def _detect_case_handling(self):
1824
wt_trans = self.bzrdir.get_workingtree_transport(None)
1826
wt_trans.stat(self._format.case_sensitive_filename)
1827
except errors.NoSuchFile:
1828
self.case_sensitive = True
1830
self.case_sensitive = False
1832
self._setup_directory_is_tree_reference()
1834
def _serialize(self, inventory, out_file):
1835
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1838
def _deserialize(selt, in_file):
1839
return xml5.serializer_v5.read_inventory(in_file)
1841
def break_lock(self):
1842
"""Break a lock if one is present from another instance.
1844
Uses the ui factory to ask for confirmation if the lock may be from
1847
This will probe the repository for its lock as well.
1849
self._control_files.break_lock()
1850
self.branch.break_lock()
1852
def is_locked(self):
1853
return self._control_files.is_locked()
1855
def _must_be_locked(self):
1856
if not self.is_locked():
1857
raise errors.ObjectNotLocked(self)
1859
def lock_read(self):
1860
"""Lock the tree for reading.
1862
This also locks the branch, and can be unlocked via self.unlock().
1864
:return: A bzrlib.lock.LogicalLockResult.
1866
if not self.is_locked():
1868
self.branch.lock_read()
1870
self._control_files.lock_read()
1871
return LogicalLockResult(self.unlock)
1873
self.branch.unlock()
2634
1876
def lock_tree_write(self):
2635
"""See WorkingTree.lock_tree_write().
2637
In Format2 WorkingTrees we have a single lock for the branch and tree
2638
so lock_tree_write() degrades to lock_write().
1877
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1879
:return: A bzrlib.lock.LogicalLockResult.
1881
if not self.is_locked():
1883
self.branch.lock_read()
1885
self._control_files.lock_write()
1886
return LogicalLockResult(self.unlock)
1888
self.branch.unlock()
1891
def lock_write(self):
1892
"""See MutableTree.lock_write, and WorkingTree.unlock.
1894
:return: A bzrlib.lock.LogicalLockResult.
1896
if not self.is_locked():
2640
1898
self.branch.lock_write()
2642
return self._control_files.lock_write()
1900
self._control_files.lock_write()
1901
return LogicalLockResult(self.unlock)
2644
1903
self.branch.unlock()
2648
# do non-implementation specific cleanup
2651
# we share control files:
2652
if self._control_files._lock_count == 3:
2653
# _inventory_is_modified is always False during a read lock.
2654
if self._inventory_is_modified:
2656
self._write_hashcache_if_dirty()
2658
# reverse order of locking.
1906
def get_physical_lock_status(self):
1907
return self._control_files.get_physical_lock_status()
1909
@needs_tree_write_lock
1910
def _write_inventory(self, inv):
1911
"""Write inventory as the current inventory."""
1912
self._set_inventory(inv, dirty=True)
1915
# XXX: This method should be deprecated in favour of taking in a proper
1916
# new Inventory object.
1917
@needs_tree_write_lock
1918
def set_inventory(self, new_inventory_list):
1919
from bzrlib.inventory import (Inventory,
1923
inv = Inventory(self.get_root_id())
1924
for path, file_id, parent, kind in new_inventory_list:
1925
name = os.path.basename(path)
1928
# fixme, there should be a factory function inv,add_??
1929
if kind == 'directory':
1930
inv.add(InventoryDirectory(file_id, name, parent))
1931
elif kind == 'file':
1932
inv.add(InventoryFile(file_id, name, parent))
1933
elif kind == 'symlink':
1934
inv.add(InventoryLink(file_id, name, parent))
1936
raise errors.BzrError("unknown kind %r" % kind)
1937
self._write_inventory(inv)
1939
def _write_basis_inventory(self, xml):
1940
"""Write the basis inventory XML to the basis-inventory file"""
1941
path = self._basis_inventory_name()
1943
self._transport.put_file(path, sio,
1944
mode=self.bzrdir._get_file_mode())
1946
def _reset_data(self):
1947
"""Reset transient data that cannot be revalidated."""
1948
self._inventory_is_modified = False
1949
f = self._transport.get('inventory')
2660
return self._control_files.unlock()
1951
result = self._deserialize(f)
2662
self.branch.unlock()
2665
class WorkingTree3(WorkingTree):
2666
"""This is the Format 3 working tree.
2668
This differs from the base WorkingTree by:
2669
- having its own file lock
2670
- having its own last-revision property.
2672
This is new in bzr 0.8
2676
def _last_revision(self):
2677
"""See Mutable.last_revision."""
1954
self._set_inventory(result, dirty=False)
1956
def _set_root_id(self, file_id):
1957
"""Set the root id for this tree, in a format specific manner.
1959
:param file_id: The file id to assign to the root. It must not be
1960
present in the current inventory or an error will occur. It must
1961
not be None, but rather a valid file id.
1963
inv = self._inventory
1964
orig_root_id = inv.root.file_id
1965
# TODO: it might be nice to exit early if there was nothing
1966
# to do, saving us from trigger a sync on unlock.
1967
self._inventory_is_modified = True
1968
# we preserve the root inventory entry object, but
1969
# unlinkit from the byid index
1970
del inv._byid[inv.root.file_id]
1971
inv.root.file_id = file_id
1972
# and link it into the index with the new changed id.
1973
inv._byid[inv.root.file_id] = inv.root
1974
# and finally update all children to reference the new id.
1975
# XXX: this should be safe to just look at the root.children
1976
# list, not the WHOLE INVENTORY.
1979
if entry.parent_id == orig_root_id:
1980
entry.parent_id = inv.root.file_id
1982
@needs_tree_write_lock
1983
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1984
"""See MutableTree.set_parent_trees."""
1985
parent_ids = [rev for (rev, tree) in parents_list]
1986
for revision_id in parent_ids:
1987
_mod_revision.check_not_reserved_id(revision_id)
1989
self._check_parents_for_ghosts(parent_ids,
1990
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1992
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1994
if len(parent_ids) == 0:
1995
leftmost_parent_id = _mod_revision.NULL_REVISION
1996
leftmost_parent_tree = None
1998
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
2000
if self._change_last_revision(leftmost_parent_id):
2001
if leftmost_parent_tree is None:
2002
# If we don't have a tree, fall back to reading the
2003
# parent tree from the repository.
2004
self._cache_basis_inventory(leftmost_parent_id)
2006
inv = leftmost_parent_tree.root_inventory
2007
xml = self._create_basis_xml_from_inventory(
2008
leftmost_parent_id, inv)
2009
self._write_basis_inventory(xml)
2010
self._set_merges_from_parent_ids(parent_ids)
2012
def _cache_basis_inventory(self, new_revision):
2013
"""Cache new_revision as the basis inventory."""
2014
# TODO: this should allow the ready-to-use inventory to be passed in,
2015
# as commit already has that ready-to-use [while the format is the
2679
return self._transport.get_bytes('last-revision')
2680
except errors.NoSuchFile:
2681
return _mod_revision.NULL_REVISION
2683
def _change_last_revision(self, revision_id):
2684
"""See WorkingTree._change_last_revision."""
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2687
self._transport.delete('last-revision')
2688
except errors.NoSuchFile:
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2696
def _get_check_refs(self):
2697
"""Return the references needed to perform a check of this tree."""
2698
return [('trees', self.last_revision())]
2018
# this double handles the inventory - unpack and repack -
2019
# but is easier to understand. We can/should put a conditional
2020
# in here based on whether the inventory is in the latest format
2021
# - perhaps we should repack all inventories on a repository
2023
# the fast path is to copy the raw xml from the repository. If the
2024
# xml contains 'revision_id="', then we assume the right
2025
# revision_id is set. We must check for this full string, because a
2026
# root node id can legitimately look like 'revision_id' but cannot
2028
xml = self.branch.repository._get_inventory_xml(new_revision)
2029
firstline = xml.split('\n', 1)[0]
2030
if (not 'revision_id="' in firstline or
2031
'format="7"' not in firstline):
2032
inv = self.branch.repository._serializer.read_inventory_from_string(
2034
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2035
self._write_basis_inventory(xml)
2036
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2039
def _basis_inventory_name(self):
2040
return 'basis-inventory-cache'
2042
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2043
"""Create the text that will be saved in basis-inventory"""
2044
inventory.revision_id = revision_id
2045
return xml7.serializer_v7.write_inventory_to_string(inventory)
2700
2047
@needs_tree_write_lock
2701
2048
def set_conflicts(self, conflicts):
2721
2068
raise errors.ConflictFormatError()
2722
2069
except StopIteration:
2723
2070
raise errors.ConflictFormatError()
2724
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2071
reader = _mod_rio.RioReader(confile)
2072
return _mod_conflicts.ConflictList.from_stanzas(reader)
2726
2074
confile.close()
2729
# do non-implementation specific cleanup
2731
if self._control_files._lock_count == 1:
2732
# _inventory_is_modified is always False during a read lock.
2733
if self._inventory_is_modified:
2735
self._write_hashcache_if_dirty()
2736
# reverse order of locking.
2738
return self._control_files.unlock()
2740
self.branch.unlock()
2743
def get_conflicted_stem(path):
2744
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
if path.endswith(suffix):
2746
return path[:-len(suffix)]
2749
class WorkingTreeFormat(object):
2076
def read_basis_inventory(self):
2077
"""Read the cached basis inventory."""
2078
path = self._basis_inventory_name()
2079
return self._transport.get_bytes(path)
2082
def read_working_inventory(self):
2083
"""Read the working inventory.
2085
:raises errors.InventoryModified: read_working_inventory will fail
2086
when the current in memory inventory has been modified.
2088
# conceptually this should be an implementation detail of the tree.
2089
# XXX: Deprecate this.
2090
# ElementTree does its own conversion from UTF-8, so open in
2092
if self._inventory_is_modified:
2093
raise errors.InventoryModified(self)
2094
f = self._transport.get('inventory')
2096
result = self._deserialize(f)
2099
self._set_inventory(result, dirty=False)
2103
def get_root_id(self):
2104
"""Return the id of this trees root"""
2105
return self._inventory.root.file_id
2107
def has_id(self, file_id):
2108
# files that have been deleted are excluded
2109
inv, inv_file_id = self._unpack_file_id(file_id)
2110
if not inv.has_id(inv_file_id):
2112
path = inv.id2path(inv_file_id)
2113
return osutils.lexists(self.abspath(path))
2115
def has_or_had_id(self, file_id):
2116
if file_id == self.get_root_id():
2118
inv, inv_file_id = self._unpack_file_id(file_id)
2119
return inv.has_id(inv_file_id)
2121
def all_file_ids(self):
2122
"""Iterate through file_ids for this tree.
2124
file_ids are in a WorkingTree if they are in the working inventory
2125
and the working file exists.
2128
for path, ie in self.iter_entries_by_dir():
2132
@needs_tree_write_lock
2133
def set_last_revision(self, new_revision):
2134
"""Change the last revision in the working tree."""
2135
if self._change_last_revision(new_revision):
2136
self._cache_basis_inventory(new_revision)
2138
def _get_check_refs(self):
2139
"""Return the references needed to perform a check of this tree.
2141
The default implementation returns no refs, and is only suitable for
2142
trees that have no local caching and can commit on ghosts at any time.
2144
:seealso: bzrlib.check for details about check_refs.
2149
def _check(self, references):
2150
"""Check the tree for consistency.
2152
:param references: A dict with keys matching the items returned by
2153
self._get_check_refs(), and values from looking those keys up in
2156
tree_basis = self.basis_tree()
2157
tree_basis.lock_read()
2159
repo_basis = references[('trees', self.last_revision())]
2160
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2161
raise errors.BzrCheckError(
2162
"Mismatched basis inventory content.")
2168
def check_state(self):
2169
"""Check that the working state is/isn't valid."""
2170
check_refs = self._get_check_refs()
2172
for ref in check_refs:
2175
refs[ref] = self.branch.repository.revision_tree(value)
2178
@needs_tree_write_lock
2179
def reset_state(self, revision_ids=None):
2180
"""Reset the state of the working tree.
2182
This does a hard-reset to a last-known-good state. This is a way to
2183
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2185
if revision_ids is None:
2186
revision_ids = self.get_parent_ids()
2187
if not revision_ids:
2188
rt = self.branch.repository.revision_tree(
2189
_mod_revision.NULL_REVISION)
2191
rt = self.branch.repository.revision_tree(revision_ids[0])
2192
self._write_inventory(rt.root_inventory)
2193
self.set_parent_ids(revision_ids)
2196
"""Write the in memory inventory to disk."""
2197
# TODO: Maybe this should only write on dirty ?
2198
if self._control_files._lock_mode != 'w':
2199
raise errors.NotWriteLocked(self)
2201
self._serialize(self._inventory, sio)
2203
self._transport.put_file('inventory', sio,
2204
mode=self.bzrdir._get_file_mode())
2205
self._inventory_is_modified = False
2207
def get_file_mtime(self, file_id, path=None):
2208
"""See Tree.get_file_mtime."""
2210
path = self.id2path(file_id)
2212
return os.lstat(self.abspath(path)).st_mtime
2214
if e.errno == errno.ENOENT:
2215
raise errors.FileTimestampUnavailable(path)
2218
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2219
inv, file_id = self._path2inv_file_id(path)
2221
# For unversioned files on win32, we just assume they are not
2224
return inv[file_id].executable
2226
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2227
mode = stat_result.st_mode
2228
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2230
def is_executable(self, file_id, path=None):
2231
if not self._supports_executable():
2232
inv, inv_file_id = self._unpack_file_id(file_id)
2233
return inv[inv_file_id].executable
2236
path = self.id2path(file_id)
2237
mode = os.lstat(self.abspath(path)).st_mode
2238
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2240
def _is_executable_from_path_and_stat(self, path, stat_result):
2241
if not self._supports_executable():
2242
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2244
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2246
@needs_tree_write_lock
2247
def _add(self, files, ids, kinds):
2248
"""See MutableTree._add."""
2249
# TODO: Re-adding a file that is removed in the working copy
2250
# should probably put it back with the previous ID.
2251
# the read and write working inventory should not occur in this
2252
# function - they should be part of lock_write and unlock.
2253
# FIXME: nested trees
2254
inv = self.root_inventory
2255
for f, file_id, kind in zip(files, ids, kinds):
2257
inv.add_path(f, kind=kind)
2259
inv.add_path(f, kind=kind, file_id=file_id)
2260
self._inventory_is_modified = True
2262
def revision_tree(self, revision_id):
2263
"""See WorkingTree.revision_id."""
2264
if revision_id == self.last_revision():
2266
xml = self.read_basis_inventory()
2267
except errors.NoSuchFile:
2271
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2272
# dont use the repository revision_tree api because we want
2273
# to supply the inventory.
2274
if inv.revision_id == revision_id:
2275
return revisiontree.InventoryRevisionTree(
2276
self.branch.repository, inv, revision_id)
2277
except errors.BadInventoryFormat:
2279
# raise if there was no inventory, or if we read the wrong inventory.
2280
raise errors.NoSuchRevisionInTree(self, revision_id)
2283
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2284
"""See Tree.annotate_iter
2286
This implementation will use the basis tree implementation if possible.
2287
Lines not in the basis are attributed to CURRENT_REVISION
2289
If there are pending merges, lines added by those merges will be
2290
incorrectly attributed to CURRENT_REVISION (but after committing, the
2291
attribution will be correct).
2293
maybe_file_parent_keys = []
2294
for parent_id in self.get_parent_ids():
2296
parent_tree = self.revision_tree(parent_id)
2297
except errors.NoSuchRevisionInTree:
2298
parent_tree = self.branch.repository.revision_tree(parent_id)
2299
parent_tree.lock_read()
2302
kind = parent_tree.kind(file_id)
2303
except errors.NoSuchId:
2306
# Note: this is slightly unnecessary, because symlinks and
2307
# directories have a "text" which is the empty text, and we
2308
# know that won't mess up annotations. But it seems cleaner
2311
file_id, parent_tree.get_file_revision(file_id))
2312
if parent_text_key not in maybe_file_parent_keys:
2313
maybe_file_parent_keys.append(parent_text_key)
2315
parent_tree.unlock()
2316
graph = _mod_graph.Graph(self.branch.repository.texts)
2317
heads = graph.heads(maybe_file_parent_keys)
2318
file_parent_keys = []
2319
for key in maybe_file_parent_keys:
2321
file_parent_keys.append(key)
2323
# Now we have the parents of this content
2324
annotator = self.branch.repository.texts.get_annotator()
2325
text = self.get_file_text(file_id)
2326
this_key =(file_id, default_revision)
2327
annotator.add_special_text(this_key, file_parent_keys, text)
2328
annotations = [(key[-1], line)
2329
for key, line in annotator.annotate_flat(this_key)]
2332
def _put_rio(self, filename, stanzas, header):
2333
self._must_be_locked()
2334
my_file = _mod_rio.rio_file(stanzas, header)
2335
self._transport.put_file(filename, my_file,
2336
mode=self.bzrdir._get_file_mode())
2338
@needs_tree_write_lock
2339
def set_merge_modified(self, modified_hashes):
2341
for file_id, hash in modified_hashes.iteritems():
2342
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2344
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2347
def merge_modified(self):
2348
"""Return a dictionary of files modified by a merge.
2350
The list is initialized by WorkingTree.set_merge_modified, which is
2351
typically called after we make some automatic updates to the tree
2354
This returns a map of file_id->sha1, containing only files which are
2355
still in the working inventory and have that text hash.
2358
hashfile = self._transport.get('merge-hashes')
2359
except errors.NoSuchFile:
2364
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2365
raise errors.MergeModifiedFormatError()
2366
except StopIteration:
2367
raise errors.MergeModifiedFormatError()
2368
for s in _mod_rio.RioReader(hashfile):
2369
# RioReader reads in Unicode, so convert file_ids back to utf8
2370
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2371
if not self.has_id(file_id):
2373
text_hash = s.get("hash")
2374
if text_hash == self.get_file_sha1(file_id):
2375
merge_hashes[file_id] = text_hash
2381
def subsume(self, other_tree):
2382
def add_children(inventory, entry):
2383
for child_entry in entry.children.values():
2384
inventory._byid[child_entry.file_id] = child_entry
2385
if child_entry.kind == 'directory':
2386
add_children(inventory, child_entry)
2387
if other_tree.get_root_id() == self.get_root_id():
2388
raise errors.BadSubsumeSource(self, other_tree,
2389
'Trees have the same root')
2391
other_tree_path = self.relpath(other_tree.basedir)
2392
except errors.PathNotChild:
2393
raise errors.BadSubsumeSource(self, other_tree,
2394
'Tree is not contained by the other')
2395
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2396
if new_root_parent is None:
2397
raise errors.BadSubsumeSource(self, other_tree,
2398
'Parent directory is not versioned.')
2399
# We need to ensure that the result of a fetch will have a
2400
# versionedfile for the other_tree root, and only fetching into
2401
# RepositoryKnit2 guarantees that.
2402
if not self.branch.repository.supports_rich_root():
2403
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2404
other_tree.lock_tree_write()
2406
new_parents = other_tree.get_parent_ids()
2407
other_root = other_tree.root_inventory.root
2408
other_root.parent_id = new_root_parent
2409
other_root.name = osutils.basename(other_tree_path)
2410
self.root_inventory.add(other_root)
2411
add_children(self.root_inventory, other_root)
2412
self._write_inventory(self.root_inventory)
2413
# normally we don't want to fetch whole repositories, but i think
2414
# here we really do want to consolidate the whole thing.
2415
for parent_id in other_tree.get_parent_ids():
2416
self.branch.fetch(other_tree.branch, parent_id)
2417
self.add_parent_tree_id(parent_id)
2420
other_tree.bzrdir.retire_bzrdir()
2422
@needs_tree_write_lock
2423
def extract(self, file_id, format=None):
2424
"""Extract a subtree from this tree.
2426
A new branch will be created, relative to the path for this tree.
2430
segments = osutils.splitpath(path)
2431
transport = self.branch.bzrdir.root_transport
2432
for name in segments:
2433
transport = transport.clone(name)
2434
transport.ensure_base()
2437
sub_path = self.id2path(file_id)
2438
branch_transport = mkdirs(sub_path)
2440
format = self.bzrdir.cloning_metadir()
2441
branch_transport.ensure_base()
2442
branch_bzrdir = format.initialize_on_transport(branch_transport)
2444
repo = branch_bzrdir.find_repository()
2445
except errors.NoRepositoryPresent:
2446
repo = branch_bzrdir.create_repository()
2447
if not repo.supports_rich_root():
2448
raise errors.RootNotRich()
2449
new_branch = branch_bzrdir.create_branch()
2450
new_branch.pull(self.branch)
2451
for parent_id in self.get_parent_ids():
2452
new_branch.fetch(self.branch, parent_id)
2453
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2454
if tree_transport.base != branch_transport.base:
2455
tree_bzrdir = format.initialize_on_transport(tree_transport)
2456
tree_bzrdir.set_branch_reference(new_branch)
2458
tree_bzrdir = branch_bzrdir
2459
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2460
wt.set_parent_ids(self.get_parent_ids())
2461
# FIXME: Support nested trees
2462
my_inv = self.root_inventory
2463
child_inv = inventory.Inventory(root_id=None)
2464
new_root = my_inv[file_id]
2465
my_inv.remove_recursive_id(file_id)
2466
new_root.parent_id = None
2467
child_inv.add(new_root)
2468
self._write_inventory(my_inv)
2469
wt._write_inventory(child_inv)
2472
def list_files(self, include_root=False, from_dir=None, recursive=True):
2473
"""List all files as (path, class, kind, id, entry).
2475
Lists, but does not descend into unversioned directories.
2476
This does not include files that have been deleted in this
2477
tree. Skips the control directory.
2479
:param include_root: if True, return an entry for the root
2480
:param from_dir: start from this directory or None for the root
2481
:param recursive: whether to recurse into subdirectories or not
2483
# list_files is an iterator, so @needs_read_lock doesn't work properly
2484
# with it. So callers should be careful to always read_lock the tree.
2485
if not self.is_locked():
2486
raise errors.ObjectNotLocked(self)
2488
if from_dir is None and include_root is True:
2489
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2490
# Convert these into local objects to save lookup times
2491
pathjoin = osutils.pathjoin
2492
file_kind = self._kind
2494
# transport.base ends in a slash, we want the piece
2495
# between the last two slashes
2496
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2498
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2500
# directory file_id, relative path, absolute path, reverse sorted children
2501
if from_dir is not None:
2502
inv, from_dir_id = self._path2inv_file_id(from_dir)
2503
if from_dir_id is None:
2504
# Directory not versioned
2506
from_dir_abspath = pathjoin(self.basedir, from_dir)
2508
inv = self.root_inventory
2509
from_dir_id = inv.root.file_id
2510
from_dir_abspath = self.basedir
2511
children = os.listdir(from_dir_abspath)
2513
# jam 20060527 The kernel sized tree seems equivalent whether we
2514
# use a deque and popleft to keep them sorted, or if we use a plain
2515
# list and just reverse() them.
2516
children = collections.deque(children)
2517
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2519
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2522
f = children.popleft()
2523
## TODO: If we find a subdirectory with its own .bzr
2524
## directory, then that is a separate tree and we
2525
## should exclude it.
2527
# the bzrdir for this tree
2528
if transport_base_dir == f:
2531
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2532
# and 'f' doesn't begin with one, we can do a string op, rather
2533
# than the checks of pathjoin(), all relative paths will have an extra slash
2535
fp = from_dir_relpath + '/' + f
2538
fap = from_dir_abspath + '/' + f
2540
dir_ie = inv[from_dir_id]
2541
if dir_ie.kind == 'directory':
2542
f_ie = dir_ie.children.get(f)
2547
elif self.is_ignored(fp[1:]):
2550
# we may not have found this file, because of a unicode
2551
# issue, or because the directory was actually a symlink.
2552
f_norm, can_access = osutils.normalized_filename(f)
2553
if f == f_norm or not can_access:
2554
# No change, so treat this file normally
2557
# this file can be accessed by a normalized path
2558
# check again if it is versioned
2559
# these lines are repeated here for performance
2561
fp = from_dir_relpath + '/' + f
2562
fap = from_dir_abspath + '/' + f
2563
f_ie = inv.get_child(from_dir_id, f)
2566
elif self.is_ignored(fp[1:]):
2573
# make a last minute entry
2575
yield fp[1:], c, fk, f_ie.file_id, f_ie
2578
yield fp[1:], c, fk, None, fk_entries[fk]()
2580
yield fp[1:], c, fk, None, TreeEntry()
2583
if fk != 'directory':
2586
# But do this child first if recursing down
2588
new_children = os.listdir(fap)
2590
new_children = collections.deque(new_children)
2591
stack.append((f_ie.file_id, fp, fap, new_children))
2592
# Break out of inner loop,
2593
# so that we start outer loop with child
2596
# if we finished all children, pop it off the stack
2599
@needs_tree_write_lock
2600
def move(self, from_paths, to_dir=None, after=False):
2603
to_dir must exist in the inventory.
2605
If to_dir exists and is a directory, the files are moved into
2606
it, keeping their old names.
2608
Note that to_dir is only the last component of the new name;
2609
this doesn't change the directory.
2611
For each entry in from_paths the move mode will be determined
2614
The first mode moves the file in the filesystem and updates the
2615
inventory. The second mode only updates the inventory without
2616
touching the file on the filesystem.
2618
move uses the second mode if 'after == True' and the target is
2619
either not versioned or newly added, and present in the working tree.
2621
move uses the second mode if 'after == False' and the source is
2622
versioned but no longer in the working tree, and the target is not
2623
versioned but present in the working tree.
2625
move uses the first mode if 'after == False' and the source is
2626
versioned and present in the working tree, and the target is not
2627
versioned and not present in the working tree.
2629
Everything else results in an error.
2631
This returns a list of (from_path, to_path) pairs for each
2632
entry that is moved.
2637
invs_to_write = set()
2639
# check for deprecated use of signature
2641
raise TypeError('You must supply a target directory')
2642
# check destination directory
2643
if isinstance(from_paths, basestring):
2645
to_abs = self.abspath(to_dir)
2646
if not isdir(to_abs):
2647
raise errors.BzrMoveFailedError('',to_dir,
2648
errors.NotADirectory(to_abs))
2649
if not self.has_filename(to_dir):
2650
raise errors.BzrMoveFailedError('',to_dir,
2651
errors.NotInWorkingDirectory(to_dir))
2652
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2653
if to_dir_id is None:
2654
raise errors.BzrMoveFailedError('',to_dir,
2655
errors.NotVersionedError(path=to_dir))
2657
to_dir_ie = to_inv[to_dir_id]
2658
if to_dir_ie.kind != 'directory':
2659
raise errors.BzrMoveFailedError('',to_dir,
2660
errors.NotADirectory(to_abs))
2662
# create rename entries and tuples
2663
for from_rel in from_paths:
2664
from_tail = splitpath(from_rel)[-1]
2665
from_inv, from_id = self._path2inv_file_id(from_rel)
2667
raise errors.BzrMoveFailedError(from_rel,to_dir,
2668
errors.NotVersionedError(path=from_rel))
2670
from_entry = from_inv[from_id]
2671
from_parent_id = from_entry.parent_id
2672
to_rel = pathjoin(to_dir, from_tail)
2673
rename_entry = InventoryWorkingTree._RenameEntry(
2676
from_tail=from_tail,
2677
from_parent_id=from_parent_id,
2678
to_rel=to_rel, to_tail=from_tail,
2679
to_parent_id=to_dir_id)
2680
rename_entries.append(rename_entry)
2681
rename_tuples.append((from_rel, to_rel))
2683
# determine which move mode to use. checks also for movability
2684
rename_entries = self._determine_mv_mode(rename_entries, after)
2686
original_modified = self._inventory_is_modified
2689
self._inventory_is_modified = True
2690
self._move(rename_entries)
2692
# restore the inventory on error
2693
self._inventory_is_modified = original_modified
2695
#FIXME: Should potentially also write the from_invs
2696
self._write_inventory(to_inv)
2697
return rename_tuples
2699
@needs_tree_write_lock
2700
def rename_one(self, from_rel, to_rel, after=False):
2703
This can change the directory or the filename or both.
2705
rename_one has several 'modes' to work. First, it can rename a physical
2706
file and change the file_id. That is the normal mode. Second, it can
2707
only change the file_id without touching any physical file.
2709
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2710
versioned but present in the working tree.
2712
rename_one uses the second mode if 'after == False' and 'from_rel' is
2713
versioned but no longer in the working tree, and 'to_rel' is not
2714
versioned but present in the working tree.
2716
rename_one uses the first mode if 'after == False' and 'from_rel' is
2717
versioned and present in the working tree, and 'to_rel' is not
2718
versioned and not present in the working tree.
2720
Everything else results in an error.
2724
# create rename entries and tuples
2725
from_tail = splitpath(from_rel)[-1]
2726
from_inv, from_id = self._path2inv_file_id(from_rel)
2728
# if file is missing in the inventory maybe it's in the basis_tree
2729
basis_tree = self.branch.basis_tree()
2730
from_id = basis_tree.path2id(from_rel)
2732
raise errors.BzrRenameFailedError(from_rel,to_rel,
2733
errors.NotVersionedError(path=from_rel))
2734
# put entry back in the inventory so we can rename it
2735
from_entry = basis_tree.root_inventory[from_id].copy()
2736
from_inv.add(from_entry)
2738
from_inv, from_inv_id = self._unpack_file_id(from_id)
2739
from_entry = from_inv[from_inv_id]
2740
from_parent_id = from_entry.parent_id
2741
to_dir, to_tail = os.path.split(to_rel)
2742
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2743
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2745
from_tail=from_tail,
2746
from_parent_id=from_parent_id,
2747
to_rel=to_rel, to_tail=to_tail,
2748
to_parent_id=to_dir_id)
2749
rename_entries.append(rename_entry)
2751
# determine which move mode to use. checks also for movability
2752
rename_entries = self._determine_mv_mode(rename_entries, after)
2754
# check if the target changed directory and if the target directory is
2756
if to_dir_id is None:
2757
raise errors.BzrMoveFailedError(from_rel,to_rel,
2758
errors.NotVersionedError(path=to_dir))
2760
# all checks done. now we can continue with our actual work
2761
mutter('rename_one:\n'
2766
' to_dir_id {%s}\n',
2767
from_id, from_rel, to_rel, to_dir, to_dir_id)
2769
self._move(rename_entries)
2770
self._write_inventory(to_inv)
2772
class _RenameEntry(object):
2773
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2774
to_rel, to_tail, to_parent_id, only_change_inv=False,
2776
self.from_rel = from_rel
2777
self.from_id = from_id
2778
self.from_tail = from_tail
2779
self.from_parent_id = from_parent_id
2780
self.to_rel = to_rel
2781
self.to_tail = to_tail
2782
self.to_parent_id = to_parent_id
2783
self.change_id = change_id
2784
self.only_change_inv = only_change_inv
2786
def _determine_mv_mode(self, rename_entries, after=False):
2787
"""Determines for each from-to pair if both inventory and working tree
2788
or only the inventory has to be changed.
2790
Also does basic plausability tests.
2792
# FIXME: Handling of nested trees
2793
inv = self.root_inventory
2795
for rename_entry in rename_entries:
2796
# store to local variables for easier reference
2797
from_rel = rename_entry.from_rel
2798
from_id = rename_entry.from_id
2799
to_rel = rename_entry.to_rel
2800
to_id = inv.path2id(to_rel)
2801
only_change_inv = False
2804
# check the inventory for source and destination
2806
raise errors.BzrMoveFailedError(from_rel,to_rel,
2807
errors.NotVersionedError(path=from_rel))
2808
if to_id is not None:
2810
# allow it with --after but only if dest is newly added
2812
basis = self.basis_tree()
2815
if not basis.has_id(to_id):
2816
rename_entry.change_id = True
2821
raise errors.BzrMoveFailedError(from_rel,to_rel,
2822
errors.AlreadyVersionedError(path=to_rel))
2824
# try to determine the mode for rename (only change inv or change
2825
# inv and file system)
2827
if not self.has_filename(to_rel):
2828
raise errors.BzrMoveFailedError(from_id,to_rel,
2829
errors.NoSuchFile(path=to_rel,
2830
extra="New file has not been created yet"))
2831
only_change_inv = True
2832
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2833
only_change_inv = True
2834
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2835
only_change_inv = False
2836
elif (not self.case_sensitive
2837
and from_rel.lower() == to_rel.lower()
2838
and self.has_filename(from_rel)):
2839
only_change_inv = False
2841
# something is wrong, so lets determine what exactly
2842
if not self.has_filename(from_rel) and \
2843
not self.has_filename(to_rel):
2844
raise errors.BzrRenameFailedError(from_rel, to_rel,
2845
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2847
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2848
rename_entry.only_change_inv = only_change_inv
2849
return rename_entries
2851
def _move(self, rename_entries):
2852
"""Moves a list of files.
2854
Depending on the value of the flag 'only_change_inv', the
2855
file will be moved on the file system or not.
2859
for entry in rename_entries:
2861
self._move_entry(entry)
2863
self._rollback_move(moved)
2867
def _rollback_move(self, moved):
2868
"""Try to rollback a previous move in case of an filesystem error."""
2871
self._move_entry(WorkingTree._RenameEntry(
2872
entry.to_rel, entry.from_id,
2873
entry.to_tail, entry.to_parent_id, entry.from_rel,
2874
entry.from_tail, entry.from_parent_id,
2875
entry.only_change_inv))
2876
except errors.BzrMoveFailedError, e:
2877
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2878
" The working tree is in an inconsistent state."
2879
" Please consider doing a 'bzr revert'."
2880
" Error message is: %s" % e)
2882
def _move_entry(self, entry):
2883
inv = self.root_inventory
2884
from_rel_abs = self.abspath(entry.from_rel)
2885
to_rel_abs = self.abspath(entry.to_rel)
2886
if from_rel_abs == to_rel_abs:
2887
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2888
"Source and target are identical.")
2890
if not entry.only_change_inv:
2892
osutils.rename(from_rel_abs, to_rel_abs)
2894
raise errors.BzrMoveFailedError(entry.from_rel,
2897
to_id = inv.path2id(entry.to_rel)
2898
inv.remove_recursive_id(to_id)
2899
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2901
@needs_tree_write_lock
2902
def unversion(self, file_ids):
2903
"""Remove the file ids in file_ids from the current versioned set.
2905
When a file_id is unversioned, all of its children are automatically
2908
:param file_ids: The file ids to stop versioning.
2909
:raises: NoSuchId if any fileid is not currently versioned.
2911
for file_id in file_ids:
2912
if not self._inventory.has_id(file_id):
2913
raise errors.NoSuchId(self, file_id)
2914
for file_id in file_ids:
2915
if self._inventory.has_id(file_id):
2916
self._inventory.remove_recursive_id(file_id)
2918
# in the future this should just set a dirty bit to wait for the
2919
# final unlock. However, until all methods of workingtree start
2920
# with the current in -memory inventory rather than triggering
2921
# a read, it is more complex - we need to teach read_inventory
2922
# to know when to read, and when to not read first... and possibly
2923
# to save first when the in memory one may be corrupted.
2924
# so for now, we just only write it if it is indeed dirty.
2926
self._write_inventory(self._inventory)
2928
def stored_kind(self, file_id):
2929
"""See Tree.stored_kind"""
2930
inv, inv_file_id = self._unpack_file_id(file_id)
2931
return inv[inv_file_id].kind
2934
"""Yield all unversioned files in this WorkingTree.
2936
If there are any unversioned directories then only the directory is
2937
returned, not all its children. But if there are unversioned files
2938
under a versioned subdirectory, they are returned.
2940
Currently returned depth-first, sorted by name within directories.
2941
This is the same order used by 'osutils.walkdirs'.
2943
## TODO: Work from given directory downwards
2944
for path, dir_entry in self.iter_entries_by_dir():
2945
if dir_entry.kind != 'directory':
2947
# mutter("search for unknowns in %r", path)
2948
dirabs = self.abspath(path)
2949
if not isdir(dirabs):
2950
# e.g. directory deleted
2954
for subf in os.listdir(dirabs):
2955
if self.bzrdir.is_control_filename(subf):
2957
if subf not in dir_entry.children:
2960
can_access) = osutils.normalized_filename(subf)
2961
except UnicodeDecodeError:
2962
path_os_enc = path.encode(osutils._fs_enc)
2963
relpath = path_os_enc + '/' + subf
2964
raise errors.BadFilenameEncoding(relpath,
2966
if subf_norm != subf and can_access:
2967
if subf_norm not in dir_entry.children:
2968
fl.append(subf_norm)
2974
subp = pathjoin(path, subf)
2977
def _walkdirs(self, prefix=""):
2978
"""Walk the directories of this tree.
2980
:param prefix: is used as the directrory to start with.
2981
:returns: a generator which yields items in the form::
2983
((curren_directory_path, fileid),
2984
[(file1_path, file1_name, file1_kind, None, file1_id,
2987
_directory = 'directory'
2988
# get the root in the inventory
2989
inv, top_id = self._path2inv_file_id(prefix)
2993
pending = [(prefix, '', _directory, None, top_id, None)]
2996
currentdir = pending.pop()
2997
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2998
top_id = currentdir[4]
3000
relroot = currentdir[0] + '/'
3003
# FIXME: stash the node in pending
3005
if entry.kind == 'directory':
3006
for name, child in entry.sorted_children():
3007
dirblock.append((relroot + name, name, child.kind, None,
3008
child.file_id, child.kind
3010
yield (currentdir[0], entry.file_id), dirblock
3011
# push the user specified dirs from dirblock
3012
for dir in reversed(dirblock):
3013
if dir[2] == _directory:
3017
def update_feature_flags(self, updated_flags):
3018
"""Update the feature flags for this branch.
3020
:param updated_flags: Dictionary mapping feature names to necessities
3021
A necessity can be None to indicate the feature should be removed
3023
self._format._update_feature_flags(updated_flags)
3024
self.control_transport.put_bytes('format', self._format.as_string())
3027
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
3028
"""Registry for working tree formats."""
3030
def __init__(self, other_registry=None):
3031
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
3032
self._default_format = None
3033
self._default_format_key = None
3035
def get_default(self):
3036
"""Return the current default format."""
3037
if (self._default_format_key is not None and
3038
self._default_format is None):
3039
self._default_format = self.get(self._default_format_key)
3040
return self._default_format
3042
def set_default(self, format):
3043
"""Set the default format."""
3044
self._default_format = format
3045
self._default_format_key = None
3047
def set_default_key(self, format_string):
3048
"""Set the default format by its format string."""
3049
self._default_format_key = format_string
3050
self._default_format = None
3053
format_registry = WorkingTreeFormatRegistry()
3056
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
3057
"""An encapsulation of the initialization and open routines for a format.
2752
3059
Formats provide three things:
2823
3128
"""True if this format supports stored views."""
2827
def register_format(klass, format):
2828
klass._formats[format.get_format_string()] = format
2831
def set_default_format(klass, format):
2832
klass._default_format = format
2835
def unregister_format(klass, format):
2836
del klass._formats[format.get_format_string()]
2839
class WorkingTreeFormat2(WorkingTreeFormat):
2840
"""The second working tree format.
2842
This format modified the hash cache from the format 1 hash cache.
2845
upgrade_recommended = True
2847
def get_format_description(self):
2848
"""See WorkingTreeFormat.get_format_description()."""
2849
return "Working tree format 2"
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
2854
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
no working tree. (See bug #43064).
2859
inv = inventory.Inventory()
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
2867
"""See WorkingTreeFormat.initialize()."""
2868
if not isinstance(a_bzrdir.transport, LocalTransport):
2869
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
if from_branch is not None:
2871
branch = from_branch
2873
branch = a_bzrdir.open_branch()
2874
if revision_id is None:
2875
revision_id = _mod_revision.ensure_null(branch.last_revision())
2878
branch.generate_revision_history(revision_id)
2881
inv = inventory.Inventory()
2882
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2888
basis_tree = branch.repository.revision_tree(revision_id)
2889
if basis_tree.inventory.root is not None:
2890
wt.set_root_id(basis_tree.get_root_id())
2891
# set the parent list and cache the basis tree.
2892
if _mod_revision.is_null(revision_id):
2895
parent_trees = [(revision_id, basis_tree)]
2896
wt.set_parent_trees(parent_trees)
2897
transform.build_tree(basis_tree, wt)
2901
super(WorkingTreeFormat2, self).__init__()
2902
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2904
def open(self, a_bzrdir, _found=False):
2905
"""Return the WorkingTree object for a_bzrdir
2907
_found is a private parameter, do not use it. It is used to indicate
2908
if format probing has already been done.
2911
# we are being called directly and must probe.
2912
raise NotImplementedError
2913
if not isinstance(a_bzrdir.transport, LocalTransport):
2914
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2921
class WorkingTreeFormat3(WorkingTreeFormat):
2922
"""The second working tree format updated to record a format marker.
2925
- exists within a metadir controlling .bzr
2926
- includes an explicit version marker for the workingtree control
2927
files, separate from the BzrDir format
2928
- modifies the hash cache format
2930
- uses a LockDir to guard access for writes.
2933
upgrade_recommended = True
2935
def get_format_string(self):
2936
"""See WorkingTreeFormat.get_format_string()."""
2937
return "Bazaar-NG Working Tree format 3"
2939
def get_format_description(self):
2940
"""See WorkingTreeFormat.get_format_description()."""
2941
return "Working tree format 3"
2943
_lock_file_name = 'lock'
2944
_lock_class = LockDir
2946
_tree_class = WorkingTree3
2948
def __get_matchingbzrdir(self):
2949
return bzrdir.BzrDirMetaFormat1()
2951
_matchingbzrdir = property(__get_matchingbzrdir)
2953
def _open_control_files(self, a_bzrdir):
2954
transport = a_bzrdir.get_workingtree_transport(None)
2955
return LockableFiles(transport, self._lock_file_name,
2958
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
accelerator_tree=None, hardlink=False):
2960
"""See WorkingTreeFormat.initialize().
2962
:param revision_id: if supplied, create a working tree at a different
2963
revision than the branch is at.
2964
:param accelerator_tree: A tree which can be used for retrieving file
2965
contents more quickly than the revision tree, i.e. a workingtree.
2966
The revision tree will be used for cases where accelerator_tree's
2967
content is different.
2968
:param hardlink: If true, hard-link files from accelerator_tree,
2971
if not isinstance(a_bzrdir.transport, LocalTransport):
2972
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2973
transport = a_bzrdir.get_workingtree_transport(self)
2974
control_files = self._open_control_files(a_bzrdir)
2975
control_files.create_lock()
2976
control_files.lock_write()
2977
transport.put_bytes('format', self.get_format_string(),
2978
mode=a_bzrdir._get_file_mode())
2979
if from_branch is not None:
2980
branch = from_branch
2982
branch = a_bzrdir.open_branch()
2983
if revision_id is None:
2984
revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
# WorkingTree3 can handle an inventory which has a unique root id.
2986
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
# those trees. And because there isn't a format bump inbetween, we
2988
# are maintaining compatibility with older clients.
2989
# inv = Inventory(root_id=gen_root_id())
2990
inv = self._initial_inventory()
2991
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2997
_control_files=control_files)
2998
wt.lock_tree_write()
3000
basis_tree = branch.repository.revision_tree(revision_id)
3001
# only set an explicit root id if there is one to set.
3002
if basis_tree.inventory.root is not None:
3003
wt.set_root_id(basis_tree.get_root_id())
3004
if revision_id == _mod_revision.NULL_REVISION:
3005
wt.set_parent_trees([])
3007
wt.set_parent_trees([(revision_id, basis_tree)])
3008
transform.build_tree(basis_tree, wt)
3010
# Unlock in this order so that the unlock-triggers-flush in
3011
# WorkingTree is given a chance to fire.
3012
control_files.unlock()
3016
def _initial_inventory(self):
3017
return inventory.Inventory()
3020
super(WorkingTreeFormat3, self).__init__()
3022
def open(self, a_bzrdir, _found=False):
3023
"""Return the WorkingTree object for a_bzrdir
3025
_found is a private parameter, do not use it. It is used to indicate
3026
if format probing has already been done.
3029
# we are being called directly and must probe.
3030
raise NotImplementedError
3031
if not isinstance(a_bzrdir.transport, LocalTransport):
3032
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3036
def _open(self, a_bzrdir, control_files):
3037
"""Open the tree itself.
3039
:param a_bzrdir: the dir for the tree.
3040
:param control_files: the control files for the tree.
3042
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3046
_control_files=control_files)
3049
return self.get_format_string()
3052
__default_format = WorkingTreeFormat6()
3053
WorkingTreeFormat.register_format(__default_format)
3054
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
WorkingTreeFormat.set_default_format(__default_format)
3058
# formats which have no format string are not discoverable
3059
# and not independently creatable, so are not registered.
3060
_legacy_formats = [WorkingTreeFormat2(),
3131
def get_controldir_for_branch(self):
3132
"""Get the control directory format for creating branches.
3134
This is to support testing of working tree formats that can not exist
3135
in the same control directory as a branch.
3137
return self._matchingbzrdir
3140
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3141
"""Base class for working trees that live in bzr meta directories."""
3144
WorkingTreeFormat.__init__(self)
3145
bzrdir.BzrFormat.__init__(self)
3148
def find_format_string(klass, controldir):
3149
"""Return format name for the working tree object in controldir."""
3151
transport = controldir.get_workingtree_transport(None)
3152
return transport.get_bytes("format")
3153
except errors.NoSuchFile:
3154
raise errors.NoWorkingTree(base=transport.base)
3157
def find_format(klass, controldir):
3158
"""Return the format for the working tree object in controldir."""
3159
format_string = klass.find_format_string(controldir)
3160
return klass._find_format(format_registry, 'working tree',
3163
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3165
WorkingTreeFormat.check_support_status(self,
3166
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3168
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3169
recommend_upgrade=recommend_upgrade, basedir=basedir)
3171
def get_controldir_for_branch(self):
3172
"""Get the control directory format for creating branches.
3174
This is to support testing of working tree formats that can not exist
3175
in the same control directory as a branch.
3177
return self._matchingbzrdir
3180
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3181
"""Base class for working trees that live in bzr meta directories."""
3184
WorkingTreeFormat.__init__(self)
3185
bzrdir.BzrFormat.__init__(self)
3188
def find_format_string(klass, controldir):
3189
"""Return format name for the working tree object in controldir."""
3191
transport = controldir.get_workingtree_transport(None)
3192
return transport.get_bytes("format")
3193
except errors.NoSuchFile:
3194
raise errors.NoWorkingTree(base=transport.base)
3197
def find_format(klass, controldir):
3198
"""Return the format for the working tree object in controldir."""
3199
format_string = klass.find_format_string(controldir)
3200
return klass._find_format(format_registry, 'working tree',
3203
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3205
WorkingTreeFormat.check_support_status(self,
3206
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3208
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3209
recommend_upgrade=recommend_upgrade, basedir=basedir)
3212
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3213
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3214
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3215
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3216
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3217
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3218
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3219
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3220
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")