2608
1725
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.
1728
class InventoryWorkingTree(WorkingTree,
1729
bzrlib.mutabletree.MutableInventoryTree):
1730
"""Base class for working trees that are inventory-oriented.
1732
The inventory is held in the `Branch` working-inventory, and the
1733
files are in a directory on disk.
1735
It is possible for a `WorkingTree` to have a filename which is
1736
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())]
1739
def __init__(self, basedir='.',
1740
branch=DEPRECATED_PARAMETER,
1742
_control_files=None,
1746
"""Construct a InventoryWorkingTree instance. This is not a public API.
1748
:param branch: A branch to override probing for the branch.
1750
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1751
branch=branch, _transport=_control_files._transport,
1752
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1754
self._control_files = _control_files
1755
self._detect_case_handling()
1757
if _inventory is None:
1758
# This will be acquired on lock_read() or lock_write()
1759
self._inventory_is_modified = False
1760
self._inventory = None
1762
# the caller of __init__ has provided an inventory,
1763
# we assume they know what they are doing - as its only
1764
# the Format factory and creation methods that are
1765
# permitted to do this.
1766
self._set_inventory(_inventory, dirty=False)
1768
def _set_inventory(self, inv, dirty):
1769
"""Set the internal cached inventory.
1771
:param inv: The inventory to set.
1772
:param dirty: A boolean indicating whether the inventory is the same
1773
logical inventory as whats on disk. If True the inventory is not
1774
the same and should be written to disk or data will be lost, if
1775
False then the inventory is the same as that on disk and any
1776
serialisation would be unneeded overhead.
1778
self._inventory = inv
1779
self._inventory_is_modified = dirty
1781
def _detect_case_handling(self):
1782
wt_trans = self.bzrdir.get_workingtree_transport(None)
1784
wt_trans.stat(self._format.case_sensitive_filename)
1785
except errors.NoSuchFile:
1786
self.case_sensitive = True
1788
self.case_sensitive = False
1790
self._setup_directory_is_tree_reference()
1792
def _serialize(self, inventory, out_file):
1793
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1796
def _deserialize(selt, in_file):
1797
return xml5.serializer_v5.read_inventory(in_file)
1799
def break_lock(self):
1800
"""Break a lock if one is present from another instance.
1802
Uses the ui factory to ask for confirmation if the lock may be from
1805
This will probe the repository for its lock as well.
1807
self._control_files.break_lock()
1808
self.branch.break_lock()
1810
def is_locked(self):
1811
return self._control_files.is_locked()
1813
def _must_be_locked(self):
1814
if not self.is_locked():
1815
raise errors.ObjectNotLocked(self)
1817
def lock_read(self):
1818
"""Lock the tree for reading.
1820
This also locks the branch, and can be unlocked via self.unlock().
1822
:return: A bzrlib.lock.LogicalLockResult.
1824
if not self.is_locked():
1826
self.branch.lock_read()
1828
self._control_files.lock_read()
1829
return LogicalLockResult(self.unlock)
1831
self.branch.unlock()
2634
1834
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().
1835
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1837
:return: A bzrlib.lock.LogicalLockResult.
1839
if not self.is_locked():
1841
self.branch.lock_read()
1843
self._control_files.lock_write()
1844
return LogicalLockResult(self.unlock)
1846
self.branch.unlock()
1849
def lock_write(self):
1850
"""See MutableTree.lock_write, and WorkingTree.unlock.
1852
:return: A bzrlib.lock.LogicalLockResult.
1854
if not self.is_locked():
2640
1856
self.branch.lock_write()
2642
return self._control_files.lock_write()
1858
self._control_files.lock_write()
1859
return LogicalLockResult(self.unlock)
2644
1861
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.
1864
def get_physical_lock_status(self):
1865
return self._control_files.get_physical_lock_status()
1867
@needs_tree_write_lock
1868
def _write_inventory(self, inv):
1869
"""Write inventory as the current inventory."""
1870
self._set_inventory(inv, dirty=True)
1873
# XXX: This method should be deprecated in favour of taking in a proper
1874
# new Inventory object.
1875
@needs_tree_write_lock
1876
def set_inventory(self, new_inventory_list):
1877
from bzrlib.inventory import (Inventory,
1881
inv = Inventory(self.get_root_id())
1882
for path, file_id, parent, kind in new_inventory_list:
1883
name = os.path.basename(path)
1886
# fixme, there should be a factory function inv,add_??
1887
if kind == 'directory':
1888
inv.add(InventoryDirectory(file_id, name, parent))
1889
elif kind == 'file':
1890
inv.add(InventoryFile(file_id, name, parent))
1891
elif kind == 'symlink':
1892
inv.add(InventoryLink(file_id, name, parent))
1894
raise errors.BzrError("unknown kind %r" % kind)
1895
self._write_inventory(inv)
1897
def _write_basis_inventory(self, xml):
1898
"""Write the basis inventory XML to the basis-inventory file"""
1899
path = self._basis_inventory_name()
1901
self._transport.put_file(path, sio,
1902
mode=self.bzrdir._get_file_mode())
1904
def _reset_data(self):
1905
"""Reset transient data that cannot be revalidated."""
1906
self._inventory_is_modified = False
1907
f = self._transport.get('inventory')
2660
return self._control_files.unlock()
1909
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."""
1912
self._set_inventory(result, dirty=False)
1914
def _set_root_id(self, file_id):
1915
"""Set the root id for this tree, in a format specific manner.
1917
:param file_id: The file id to assign to the root. It must not be
1918
present in the current inventory or an error will occur. It must
1919
not be None, but rather a valid file id.
1921
inv = self._inventory
1922
orig_root_id = inv.root.file_id
1923
# TODO: it might be nice to exit early if there was nothing
1924
# to do, saving us from trigger a sync on unlock.
1925
self._inventory_is_modified = True
1926
# we preserve the root inventory entry object, but
1927
# unlinkit from the byid index
1928
del inv._byid[inv.root.file_id]
1929
inv.root.file_id = file_id
1930
# and link it into the index with the new changed id.
1931
inv._byid[inv.root.file_id] = inv.root
1932
# and finally update all children to reference the new id.
1933
# XXX: this should be safe to just look at the root.children
1934
# list, not the WHOLE INVENTORY.
1937
if entry.parent_id == orig_root_id:
1938
entry.parent_id = inv.root.file_id
1940
def all_file_ids(self):
1941
"""See Tree.iter_all_file_ids"""
1942
return set(self.inventory)
1944
@needs_tree_write_lock
1945
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1946
"""See MutableTree.set_parent_trees."""
1947
parent_ids = [rev for (rev, tree) in parents_list]
1948
for revision_id in parent_ids:
1949
_mod_revision.check_not_reserved_id(revision_id)
1951
self._check_parents_for_ghosts(parent_ids,
1952
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1954
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1956
if len(parent_ids) == 0:
1957
leftmost_parent_id = _mod_revision.NULL_REVISION
1958
leftmost_parent_tree = None
1960
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1962
if self._change_last_revision(leftmost_parent_id):
1963
if leftmost_parent_tree is None:
1964
# If we don't have a tree, fall back to reading the
1965
# parent tree from the repository.
1966
self._cache_basis_inventory(leftmost_parent_id)
1968
inv = leftmost_parent_tree.inventory
1969
xml = self._create_basis_xml_from_inventory(
1970
leftmost_parent_id, inv)
1971
self._write_basis_inventory(xml)
1972
self._set_merges_from_parent_ids(parent_ids)
1974
def _cache_basis_inventory(self, new_revision):
1975
"""Cache new_revision as the basis inventory."""
1976
# TODO: this should allow the ready-to-use inventory to be passed in,
1977
# 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())]
1980
# this double handles the inventory - unpack and repack -
1981
# but is easier to understand. We can/should put a conditional
1982
# in here based on whether the inventory is in the latest format
1983
# - perhaps we should repack all inventories on a repository
1985
# the fast path is to copy the raw xml from the repository. If the
1986
# xml contains 'revision_id="', then we assume the right
1987
# revision_id is set. We must check for this full string, because a
1988
# root node id can legitimately look like 'revision_id' but cannot
1990
xml = self.branch.repository._get_inventory_xml(new_revision)
1991
firstline = xml.split('\n', 1)[0]
1992
if (not 'revision_id="' in firstline or
1993
'format="7"' not in firstline):
1994
inv = self.branch.repository._serializer.read_inventory_from_string(
1996
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1997
self._write_basis_inventory(xml)
1998
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2001
def _basis_inventory_name(self):
2002
return 'basis-inventory-cache'
2004
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2005
"""Create the text that will be saved in basis-inventory"""
2006
inventory.revision_id = revision_id
2007
return xml7.serializer_v7.write_inventory_to_string(inventory)
2700
2009
@needs_tree_write_lock
2701
2010
def set_conflicts(self, conflicts):
2721
2030
raise errors.ConflictFormatError()
2722
2031
except StopIteration:
2723
2032
raise errors.ConflictFormatError()
2724
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2033
reader = _mod_rio.RioReader(confile)
2034
return _mod_conflicts.ConflictList.from_stanzas(reader)
2726
2036
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):
2038
def read_basis_inventory(self):
2039
"""Read the cached basis inventory."""
2040
path = self._basis_inventory_name()
2041
return self._transport.get_bytes(path)
2044
def read_working_inventory(self):
2045
"""Read the working inventory.
2047
:raises errors.InventoryModified: read_working_inventory will fail
2048
when the current in memory inventory has been modified.
2050
# conceptually this should be an implementation detail of the tree.
2051
# XXX: Deprecate this.
2052
# ElementTree does its own conversion from UTF-8, so open in
2054
if self._inventory_is_modified:
2055
raise errors.InventoryModified(self)
2056
f = self._transport.get('inventory')
2058
result = self._deserialize(f)
2061
self._set_inventory(result, dirty=False)
2065
def get_root_id(self):
2066
"""Return the id of this trees root"""
2067
return self._inventory.root.file_id
2069
def has_id(self, file_id):
2070
# files that have been deleted are excluded
2071
inv = self.inventory
2072
if not inv.has_id(file_id):
2074
path = inv.id2path(file_id)
2075
return osutils.lexists(self.abspath(path))
2077
def has_or_had_id(self, file_id):
2078
if file_id == self.inventory.root.file_id:
2080
return self.inventory.has_id(file_id)
2082
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2084
"""Iterate through file_ids for this tree.
2086
file_ids are in a WorkingTree if they are in the working inventory
2087
and the working file exists.
2089
inv = self._inventory
2090
for path, ie in inv.iter_entries():
2091
if osutils.lexists(self.abspath(path)):
2094
@needs_tree_write_lock
2095
def set_last_revision(self, new_revision):
2096
"""Change the last revision in the working tree."""
2097
if self._change_last_revision(new_revision):
2098
self._cache_basis_inventory(new_revision)
2100
def _get_check_refs(self):
2101
"""Return the references needed to perform a check of this tree.
2103
The default implementation returns no refs, and is only suitable for
2104
trees that have no local caching and can commit on ghosts at any time.
2106
:seealso: bzrlib.check for details about check_refs.
2111
def _check(self, references):
2112
"""Check the tree for consistency.
2114
:param references: A dict with keys matching the items returned by
2115
self._get_check_refs(), and values from looking those keys up in
2118
tree_basis = self.basis_tree()
2119
tree_basis.lock_read()
2121
repo_basis = references[('trees', self.last_revision())]
2122
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2123
raise errors.BzrCheckError(
2124
"Mismatched basis inventory content.")
2130
def check_state(self):
2131
"""Check that the working state is/isn't valid."""
2132
check_refs = self._get_check_refs()
2134
for ref in check_refs:
2137
refs[ref] = self.branch.repository.revision_tree(value)
2140
@needs_tree_write_lock
2141
def reset_state(self, revision_ids=None):
2142
"""Reset the state of the working tree.
2144
This does a hard-reset to a last-known-good state. This is a way to
2145
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2147
if revision_ids is None:
2148
revision_ids = self.get_parent_ids()
2149
if not revision_ids:
2150
rt = self.branch.repository.revision_tree(
2151
_mod_revision.NULL_REVISION)
2153
rt = self.branch.repository.revision_tree(revision_ids[0])
2154
self._write_inventory(rt.inventory)
2155
self.set_parent_ids(revision_ids)
2158
"""Write the in memory inventory to disk."""
2159
# TODO: Maybe this should only write on dirty ?
2160
if self._control_files._lock_mode != 'w':
2161
raise errors.NotWriteLocked(self)
2163
self._serialize(self._inventory, sio)
2165
self._transport.put_file('inventory', sio,
2166
mode=self.bzrdir._get_file_mode())
2167
self._inventory_is_modified = False
2169
def get_file_mtime(self, file_id, path=None):
2170
"""See Tree.get_file_mtime."""
2172
path = self.inventory.id2path(file_id)
2174
return os.lstat(self.abspath(path)).st_mtime
2176
if e.errno == errno.ENOENT:
2177
raise errors.FileTimestampUnavailable(path)
2180
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2181
file_id = self.path2id(path)
2183
# For unversioned files on win32, we just assume they are not
2186
return self._inventory[file_id].executable
2188
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2189
mode = stat_result.st_mode
2190
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2192
if not supports_executable():
2193
def is_executable(self, file_id, path=None):
2194
return self._inventory[file_id].executable
2196
_is_executable_from_path_and_stat = \
2197
_is_executable_from_path_and_stat_from_basis
2199
def is_executable(self, file_id, path=None):
2201
path = self.id2path(file_id)
2202
mode = os.lstat(self.abspath(path)).st_mode
2203
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2205
_is_executable_from_path_and_stat = \
2206
_is_executable_from_path_and_stat_from_stat
2208
@needs_tree_write_lock
2209
def _add(self, files, ids, kinds):
2210
"""See MutableTree._add."""
2211
# TODO: Re-adding a file that is removed in the working copy
2212
# should probably put it back with the previous ID.
2213
# the read and write working inventory should not occur in this
2214
# function - they should be part of lock_write and unlock.
2215
inv = self.inventory
2216
for f, file_id, kind in zip(files, ids, kinds):
2218
inv.add_path(f, kind=kind)
2220
inv.add_path(f, kind=kind, file_id=file_id)
2221
self._inventory_is_modified = True
2223
def revision_tree(self, revision_id):
2224
"""See WorkingTree.revision_id."""
2225
if revision_id == self.last_revision():
2227
xml = self.read_basis_inventory()
2228
except errors.NoSuchFile:
2232
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2233
# dont use the repository revision_tree api because we want
2234
# to supply the inventory.
2235
if inv.revision_id == revision_id:
2236
return revisiontree.InventoryRevisionTree(
2237
self.branch.repository, inv, revision_id)
2238
except errors.BadInventoryFormat:
2240
# raise if there was no inventory, or if we read the wrong inventory.
2241
raise errors.NoSuchRevisionInTree(self, revision_id)
2244
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2245
"""See Tree.annotate_iter
2247
This implementation will use the basis tree implementation if possible.
2248
Lines not in the basis are attributed to CURRENT_REVISION
2250
If there are pending merges, lines added by those merges will be
2251
incorrectly attributed to CURRENT_REVISION (but after committing, the
2252
attribution will be correct).
2254
maybe_file_parent_keys = []
2255
for parent_id in self.get_parent_ids():
2257
parent_tree = self.revision_tree(parent_id)
2258
except errors.NoSuchRevisionInTree:
2259
parent_tree = self.branch.repository.revision_tree(parent_id)
2260
parent_tree.lock_read()
2262
if not parent_tree.has_id(file_id):
2264
ie = parent_tree.inventory[file_id]
2265
if ie.kind != 'file':
2266
# Note: this is slightly unnecessary, because symlinks and
2267
# directories have a "text" which is the empty text, and we
2268
# know that won't mess up annotations. But it seems cleaner
2270
parent_text_key = (file_id, ie.revision)
2271
if parent_text_key not in maybe_file_parent_keys:
2272
maybe_file_parent_keys.append(parent_text_key)
2274
parent_tree.unlock()
2275
graph = _mod_graph.Graph(self.branch.repository.texts)
2276
heads = graph.heads(maybe_file_parent_keys)
2277
file_parent_keys = []
2278
for key in maybe_file_parent_keys:
2280
file_parent_keys.append(key)
2282
# Now we have the parents of this content
2283
annotator = self.branch.repository.texts.get_annotator()
2284
text = self.get_file_text(file_id)
2285
this_key =(file_id, default_revision)
2286
annotator.add_special_text(this_key, file_parent_keys, text)
2287
annotations = [(key[-1], line)
2288
for key, line in annotator.annotate_flat(this_key)]
2291
def _put_rio(self, filename, stanzas, header):
2292
self._must_be_locked()
2293
my_file = _mod_rio.rio_file(stanzas, header)
2294
self._transport.put_file(filename, my_file,
2295
mode=self.bzrdir._get_file_mode())
2297
@needs_tree_write_lock
2298
def set_merge_modified(self, modified_hashes):
2300
for file_id, hash in modified_hashes.iteritems():
2301
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2303
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2306
def merge_modified(self):
2307
"""Return a dictionary of files modified by a merge.
2309
The list is initialized by WorkingTree.set_merge_modified, which is
2310
typically called after we make some automatic updates to the tree
2313
This returns a map of file_id->sha1, containing only files which are
2314
still in the working inventory and have that text hash.
2317
hashfile = self._transport.get('merge-hashes')
2318
except errors.NoSuchFile:
2323
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2324
raise errors.MergeModifiedFormatError()
2325
except StopIteration:
2326
raise errors.MergeModifiedFormatError()
2327
for s in _mod_rio.RioReader(hashfile):
2328
# RioReader reads in Unicode, so convert file_ids back to utf8
2329
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2330
if not self.inventory.has_id(file_id):
2332
text_hash = s.get("hash")
2333
if text_hash == self.get_file_sha1(file_id):
2334
merge_hashes[file_id] = text_hash
2340
def subsume(self, other_tree):
2341
def add_children(inventory, entry):
2342
for child_entry in entry.children.values():
2343
inventory._byid[child_entry.file_id] = child_entry
2344
if child_entry.kind == 'directory':
2345
add_children(inventory, child_entry)
2346
if other_tree.get_root_id() == self.get_root_id():
2347
raise errors.BadSubsumeSource(self, other_tree,
2348
'Trees have the same root')
2350
other_tree_path = self.relpath(other_tree.basedir)
2351
except errors.PathNotChild:
2352
raise errors.BadSubsumeSource(self, other_tree,
2353
'Tree is not contained by the other')
2354
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2355
if new_root_parent is None:
2356
raise errors.BadSubsumeSource(self, other_tree,
2357
'Parent directory is not versioned.')
2358
# We need to ensure that the result of a fetch will have a
2359
# versionedfile for the other_tree root, and only fetching into
2360
# RepositoryKnit2 guarantees that.
2361
if not self.branch.repository.supports_rich_root():
2362
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2363
other_tree.lock_tree_write()
2365
new_parents = other_tree.get_parent_ids()
2366
other_root = other_tree.inventory.root
2367
other_root.parent_id = new_root_parent
2368
other_root.name = osutils.basename(other_tree_path)
2369
self.inventory.add(other_root)
2370
add_children(self.inventory, other_root)
2371
self._write_inventory(self.inventory)
2372
# normally we don't want to fetch whole repositories, but i think
2373
# here we really do want to consolidate the whole thing.
2374
for parent_id in other_tree.get_parent_ids():
2375
self.branch.fetch(other_tree.branch, parent_id)
2376
self.add_parent_tree_id(parent_id)
2379
other_tree.bzrdir.retire_bzrdir()
2381
@needs_tree_write_lock
2382
def extract(self, file_id, format=None):
2383
"""Extract a subtree from this tree.
2385
A new branch will be created, relative to the path for this tree.
2389
segments = osutils.splitpath(path)
2390
transport = self.branch.bzrdir.root_transport
2391
for name in segments:
2392
transport = transport.clone(name)
2393
transport.ensure_base()
2396
sub_path = self.id2path(file_id)
2397
branch_transport = mkdirs(sub_path)
2399
format = self.bzrdir.cloning_metadir()
2400
branch_transport.ensure_base()
2401
branch_bzrdir = format.initialize_on_transport(branch_transport)
2403
repo = branch_bzrdir.find_repository()
2404
except errors.NoRepositoryPresent:
2405
repo = branch_bzrdir.create_repository()
2406
if not repo.supports_rich_root():
2407
raise errors.RootNotRich()
2408
new_branch = branch_bzrdir.create_branch()
2409
new_branch.pull(self.branch)
2410
for parent_id in self.get_parent_ids():
2411
new_branch.fetch(self.branch, parent_id)
2412
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2413
if tree_transport.base != branch_transport.base:
2414
tree_bzrdir = format.initialize_on_transport(tree_transport)
2415
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2416
target_branch=new_branch)
2418
tree_bzrdir = branch_bzrdir
2419
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2420
wt.set_parent_ids(self.get_parent_ids())
2421
my_inv = self.inventory
2422
child_inv = inventory.Inventory(root_id=None)
2423
new_root = my_inv[file_id]
2424
my_inv.remove_recursive_id(file_id)
2425
new_root.parent_id = None
2426
child_inv.add(new_root)
2427
self._write_inventory(my_inv)
2428
wt._write_inventory(child_inv)
2431
def list_files(self, include_root=False, from_dir=None, recursive=True):
2432
"""List all files as (path, class, kind, id, entry).
2434
Lists, but does not descend into unversioned directories.
2435
This does not include files that have been deleted in this
2436
tree. Skips the control directory.
2438
:param include_root: if True, return an entry for the root
2439
:param from_dir: start from this directory or None for the root
2440
:param recursive: whether to recurse into subdirectories or not
2442
# list_files is an iterator, so @needs_read_lock doesn't work properly
2443
# with it. So callers should be careful to always read_lock the tree.
2444
if not self.is_locked():
2445
raise errors.ObjectNotLocked(self)
2447
inv = self.inventory
2448
if from_dir is None and include_root is True:
2449
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2450
# Convert these into local objects to save lookup times
2451
pathjoin = osutils.pathjoin
2452
file_kind = self._kind
2454
# transport.base ends in a slash, we want the piece
2455
# between the last two slashes
2456
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2458
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2460
# directory file_id, relative path, absolute path, reverse sorted children
2461
if from_dir is not None:
2462
from_dir_id = inv.path2id(from_dir)
2463
if from_dir_id is None:
2464
# Directory not versioned
2466
from_dir_abspath = pathjoin(self.basedir, from_dir)
2468
from_dir_id = inv.root.file_id
2469
from_dir_abspath = self.basedir
2470
children = os.listdir(from_dir_abspath)
2472
# jam 20060527 The kernel sized tree seems equivalent whether we
2473
# use a deque and popleft to keep them sorted, or if we use a plain
2474
# list and just reverse() them.
2475
children = collections.deque(children)
2476
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2478
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2481
f = children.popleft()
2482
## TODO: If we find a subdirectory with its own .bzr
2483
## directory, then that is a separate tree and we
2484
## should exclude it.
2486
# the bzrdir for this tree
2487
if transport_base_dir == f:
2490
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2491
# and 'f' doesn't begin with one, we can do a string op, rather
2492
# than the checks of pathjoin(), all relative paths will have an extra slash
2494
fp = from_dir_relpath + '/' + f
2497
fap = from_dir_abspath + '/' + f
2499
dir_ie = inv[from_dir_id]
2500
if dir_ie.kind == 'directory':
2501
f_ie = dir_ie.children.get(f)
2506
elif self.is_ignored(fp[1:]):
2509
# we may not have found this file, because of a unicode
2510
# issue, or because the directory was actually a symlink.
2511
f_norm, can_access = osutils.normalized_filename(f)
2512
if f == f_norm or not can_access:
2513
# No change, so treat this file normally
2516
# this file can be accessed by a normalized path
2517
# check again if it is versioned
2518
# these lines are repeated here for performance
2520
fp = from_dir_relpath + '/' + f
2521
fap = from_dir_abspath + '/' + f
2522
f_ie = inv.get_child(from_dir_id, f)
2525
elif self.is_ignored(fp[1:]):
2532
# make a last minute entry
2534
yield fp[1:], c, fk, f_ie.file_id, f_ie
2537
yield fp[1:], c, fk, None, fk_entries[fk]()
2539
yield fp[1:], c, fk, None, TreeEntry()
2542
if fk != 'directory':
2545
# But do this child first if recursing down
2547
new_children = os.listdir(fap)
2549
new_children = collections.deque(new_children)
2550
stack.append((f_ie.file_id, fp, fap, new_children))
2551
# Break out of inner loop,
2552
# so that we start outer loop with child
2555
# if we finished all children, pop it off the stack
2558
@needs_tree_write_lock
2559
def move(self, from_paths, to_dir=None, after=False):
2562
to_dir must exist in the inventory.
2564
If to_dir exists and is a directory, the files are moved into
2565
it, keeping their old names.
2567
Note that to_dir is only the last component of the new name;
2568
this doesn't change the directory.
2570
For each entry in from_paths the move mode will be determined
2573
The first mode moves the file in the filesystem and updates the
2574
inventory. The second mode only updates the inventory without
2575
touching the file on the filesystem.
2577
move uses the second mode if 'after == True' and the target is
2578
either not versioned or newly added, and present in the working tree.
2580
move uses the second mode if 'after == False' and the source is
2581
versioned but no longer in the working tree, and the target is not
2582
versioned but present in the working tree.
2584
move uses the first mode if 'after == False' and the source is
2585
versioned and present in the working tree, and the target is not
2586
versioned and not present in the working tree.
2588
Everything else results in an error.
2590
This returns a list of (from_path, to_path) pairs for each
2591
entry that is moved.
2596
# check for deprecated use of signature
2598
raise TypeError('You must supply a target directory')
2599
# check destination directory
2600
if isinstance(from_paths, basestring):
2602
inv = self.inventory
2603
to_abs = self.abspath(to_dir)
2604
if not isdir(to_abs):
2605
raise errors.BzrMoveFailedError('',to_dir,
2606
errors.NotADirectory(to_abs))
2607
if not self.has_filename(to_dir):
2608
raise errors.BzrMoveFailedError('',to_dir,
2609
errors.NotInWorkingDirectory(to_dir))
2610
to_dir_id = inv.path2id(to_dir)
2611
if to_dir_id is None:
2612
raise errors.BzrMoveFailedError('',to_dir,
2613
errors.NotVersionedError(path=to_dir))
2615
to_dir_ie = inv[to_dir_id]
2616
if to_dir_ie.kind != 'directory':
2617
raise errors.BzrMoveFailedError('',to_dir,
2618
errors.NotADirectory(to_abs))
2620
# create rename entries and tuples
2621
for from_rel in from_paths:
2622
from_tail = splitpath(from_rel)[-1]
2623
from_id = inv.path2id(from_rel)
2625
raise errors.BzrMoveFailedError(from_rel,to_dir,
2626
errors.NotVersionedError(path=from_rel))
2628
from_entry = inv[from_id]
2629
from_parent_id = from_entry.parent_id
2630
to_rel = pathjoin(to_dir, from_tail)
2631
rename_entry = InventoryWorkingTree._RenameEntry(
2634
from_tail=from_tail,
2635
from_parent_id=from_parent_id,
2636
to_rel=to_rel, to_tail=from_tail,
2637
to_parent_id=to_dir_id)
2638
rename_entries.append(rename_entry)
2639
rename_tuples.append((from_rel, to_rel))
2641
# determine which move mode to use. checks also for movability
2642
rename_entries = self._determine_mv_mode(rename_entries, after)
2644
original_modified = self._inventory_is_modified
2647
self._inventory_is_modified = True
2648
self._move(rename_entries)
2650
# restore the inventory on error
2651
self._inventory_is_modified = original_modified
2653
self._write_inventory(inv)
2654
return rename_tuples
2656
@needs_tree_write_lock
2657
def rename_one(self, from_rel, to_rel, after=False):
2660
This can change the directory or the filename or both.
2662
rename_one has several 'modes' to work. First, it can rename a physical
2663
file and change the file_id. That is the normal mode. Second, it can
2664
only change the file_id without touching any physical file.
2666
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2667
versioned but present in the working tree.
2669
rename_one uses the second mode if 'after == False' and 'from_rel' is
2670
versioned but no longer in the working tree, and 'to_rel' is not
2671
versioned but present in the working tree.
2673
rename_one uses the first mode if 'after == False' and 'from_rel' is
2674
versioned and present in the working tree, and 'to_rel' is not
2675
versioned and not present in the working tree.
2677
Everything else results in an error.
2679
inv = self.inventory
2682
# create rename entries and tuples
2683
from_tail = splitpath(from_rel)[-1]
2684
from_id = inv.path2id(from_rel)
2686
# if file is missing in the inventory maybe it's in the basis_tree
2687
basis_tree = self.branch.basis_tree()
2688
from_id = basis_tree.path2id(from_rel)
2690
raise errors.BzrRenameFailedError(from_rel,to_rel,
2691
errors.NotVersionedError(path=from_rel))
2692
# put entry back in the inventory so we can rename it
2693
from_entry = basis_tree.inventory[from_id].copy()
2696
from_entry = inv[from_id]
2697
from_parent_id = from_entry.parent_id
2698
to_dir, to_tail = os.path.split(to_rel)
2699
to_dir_id = inv.path2id(to_dir)
2700
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2702
from_tail=from_tail,
2703
from_parent_id=from_parent_id,
2704
to_rel=to_rel, to_tail=to_tail,
2705
to_parent_id=to_dir_id)
2706
rename_entries.append(rename_entry)
2708
# determine which move mode to use. checks also for movability
2709
rename_entries = self._determine_mv_mode(rename_entries, after)
2711
# check if the target changed directory and if the target directory is
2713
if to_dir_id is None:
2714
raise errors.BzrMoveFailedError(from_rel,to_rel,
2715
errors.NotVersionedError(path=to_dir))
2717
# all checks done. now we can continue with our actual work
2718
mutter('rename_one:\n'
2723
' to_dir_id {%s}\n',
2724
from_id, from_rel, to_rel, to_dir, to_dir_id)
2726
self._move(rename_entries)
2727
self._write_inventory(inv)
2729
class _RenameEntry(object):
2730
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2731
to_rel, to_tail, to_parent_id, only_change_inv=False,
2733
self.from_rel = from_rel
2734
self.from_id = from_id
2735
self.from_tail = from_tail
2736
self.from_parent_id = from_parent_id
2737
self.to_rel = to_rel
2738
self.to_tail = to_tail
2739
self.to_parent_id = to_parent_id
2740
self.change_id = change_id
2741
self.only_change_inv = only_change_inv
2743
def _determine_mv_mode(self, rename_entries, after=False):
2744
"""Determines for each from-to pair if both inventory and working tree
2745
or only the inventory has to be changed.
2747
Also does basic plausability tests.
2749
inv = self.inventory
2751
for rename_entry in rename_entries:
2752
# store to local variables for easier reference
2753
from_rel = rename_entry.from_rel
2754
from_id = rename_entry.from_id
2755
to_rel = rename_entry.to_rel
2756
to_id = inv.path2id(to_rel)
2757
only_change_inv = False
2760
# check the inventory for source and destination
2762
raise errors.BzrMoveFailedError(from_rel,to_rel,
2763
errors.NotVersionedError(path=from_rel))
2764
if to_id is not None:
2766
# allow it with --after but only if dest is newly added
2768
basis = self.basis_tree()
2771
if not basis.has_id(to_id):
2772
rename_entry.change_id = True
2777
raise errors.BzrMoveFailedError(from_rel,to_rel,
2778
errors.AlreadyVersionedError(path=to_rel))
2780
# try to determine the mode for rename (only change inv or change
2781
# inv and file system)
2783
if not self.has_filename(to_rel):
2784
raise errors.BzrMoveFailedError(from_id,to_rel,
2785
errors.NoSuchFile(path=to_rel,
2786
extra="New file has not been created yet"))
2787
only_change_inv = True
2788
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2789
only_change_inv = True
2790
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2791
only_change_inv = False
2792
elif (not self.case_sensitive
2793
and from_rel.lower() == to_rel.lower()
2794
and self.has_filename(from_rel)):
2795
only_change_inv = False
2797
# something is wrong, so lets determine what exactly
2798
if not self.has_filename(from_rel) and \
2799
not self.has_filename(to_rel):
2800
raise errors.BzrRenameFailedError(from_rel, to_rel,
2801
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2803
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2804
rename_entry.only_change_inv = only_change_inv
2805
return rename_entries
2807
def _move(self, rename_entries):
2808
"""Moves a list of files.
2810
Depending on the value of the flag 'only_change_inv', the
2811
file will be moved on the file system or not.
2813
inv = self.inventory
2816
for entry in rename_entries:
2818
self._move_entry(entry)
2820
self._rollback_move(moved)
2824
def _rollback_move(self, moved):
2825
"""Try to rollback a previous move in case of an filesystem error."""
2826
inv = self.inventory
2829
self._move_entry(WorkingTree._RenameEntry(
2830
entry.to_rel, entry.from_id,
2831
entry.to_tail, entry.to_parent_id, entry.from_rel,
2832
entry.from_tail, entry.from_parent_id,
2833
entry.only_change_inv))
2834
except errors.BzrMoveFailedError, e:
2835
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2836
" The working tree is in an inconsistent state."
2837
" Please consider doing a 'bzr revert'."
2838
" Error message is: %s" % e)
2840
def _move_entry(self, entry):
2841
inv = self.inventory
2842
from_rel_abs = self.abspath(entry.from_rel)
2843
to_rel_abs = self.abspath(entry.to_rel)
2844
if from_rel_abs == to_rel_abs:
2845
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2846
"Source and target are identical.")
2848
if not entry.only_change_inv:
2850
osutils.rename(from_rel_abs, to_rel_abs)
2852
raise errors.BzrMoveFailedError(entry.from_rel,
2855
to_id = inv.path2id(entry.to_rel)
2856
inv.remove_recursive_id(to_id)
2857
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2859
@needs_tree_write_lock
2860
def unversion(self, file_ids):
2861
"""Remove the file ids in file_ids from the current versioned set.
2863
When a file_id is unversioned, all of its children are automatically
2866
:param file_ids: The file ids to stop versioning.
2867
:raises: NoSuchId if any fileid is not currently versioned.
2869
for file_id in file_ids:
2870
if not self._inventory.has_id(file_id):
2871
raise errors.NoSuchId(self, file_id)
2872
for file_id in file_ids:
2873
if self._inventory.has_id(file_id):
2874
self._inventory.remove_recursive_id(file_id)
2876
# in the future this should just set a dirty bit to wait for the
2877
# final unlock. However, until all methods of workingtree start
2878
# with the current in -memory inventory rather than triggering
2879
# a read, it is more complex - we need to teach read_inventory
2880
# to know when to read, and when to not read first... and possibly
2881
# to save first when the in memory one may be corrupted.
2882
# so for now, we just only write it if it is indeed dirty.
2884
self._write_inventory(self._inventory)
2886
def stored_kind(self, file_id):
2887
"""See Tree.stored_kind"""
2888
return self.inventory[file_id].kind
2891
"""Yield all unversioned files in this WorkingTree.
2893
If there are any unversioned directories then only the directory is
2894
returned, not all its children. But if there are unversioned files
2895
under a versioned subdirectory, they are returned.
2897
Currently returned depth-first, sorted by name within directories.
2898
This is the same order used by 'osutils.walkdirs'.
2900
## TODO: Work from given directory downwards
2901
for path, dir_entry in self.inventory.directories():
2902
# mutter("search for unknowns in %r", path)
2903
dirabs = self.abspath(path)
2904
if not isdir(dirabs):
2905
# e.g. directory deleted
2909
for subf in os.listdir(dirabs):
2910
if self.bzrdir.is_control_filename(subf):
2912
if subf not in dir_entry.children:
2915
can_access) = osutils.normalized_filename(subf)
2916
except UnicodeDecodeError:
2917
path_os_enc = path.encode(osutils._fs_enc)
2918
relpath = path_os_enc + '/' + subf
2919
raise errors.BadFilenameEncoding(relpath,
2921
if subf_norm != subf and can_access:
2922
if subf_norm not in dir_entry.children:
2923
fl.append(subf_norm)
2929
subp = pathjoin(path, subf)
2932
def _walkdirs(self, prefix=""):
2933
"""Walk the directories of this tree.
2935
:param prefix: is used as the directrory to start with.
2936
:returns: a generator which yields items in the form::
2938
((curren_directory_path, fileid),
2939
[(file1_path, file1_name, file1_kind, None, file1_id,
2942
_directory = 'directory'
2943
# get the root in the inventory
2944
inv = self.inventory
2945
top_id = inv.path2id(prefix)
2949
pending = [(prefix, '', _directory, None, top_id, None)]
2952
currentdir = pending.pop()
2953
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2954
top_id = currentdir[4]
2956
relroot = currentdir[0] + '/'
2959
# FIXME: stash the node in pending
2961
if entry.kind == 'directory':
2962
for name, child in entry.sorted_children():
2963
dirblock.append((relroot + name, name, child.kind, None,
2964
child.file_id, child.kind
2966
yield (currentdir[0], entry.file_id), dirblock
2967
# push the user specified dirs from dirblock
2968
for dir in reversed(dirblock):
2969
if dir[2] == _directory:
2973
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2974
"""Registry for working tree formats."""
2976
def __init__(self, other_registry=None):
2977
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2978
self._default_format = None
2979
self._default_format_key = None
2981
def get_default(self):
2982
"""Return the current default format."""
2983
if (self._default_format_key is not None and
2984
self._default_format is None):
2985
self._default_format = self.get(self._default_format_key)
2986
return self._default_format
2988
def set_default(self, format):
2989
"""Set the default format."""
2990
self._default_format = format
2991
self._default_format_key = None
2993
def set_default_key(self, format_string):
2994
"""Set the default format by its format string."""
2995
self._default_format_key = format_string
2996
self._default_format = None
2999
format_registry = WorkingTreeFormatRegistry()
3002
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
3003
"""An encapsulation of the initialization and open routines for a format.
2752
3005
Formats provide three things:
3085
@symbol_versioning.deprecated_method(
3086
symbol_versioning.deprecated_in((2, 4, 0)))
2827
3087
def register_format(klass, format):
2828
klass._formats[format.get_format_string()] = format
3088
format_registry.register(format)
3091
@symbol_versioning.deprecated_method(
3092
symbol_versioning.deprecated_in((2, 4, 0)))
3093
def register_extra_format(klass, format):
3094
format_registry.register_extra(format)
3097
@symbol_versioning.deprecated_method(
3098
symbol_versioning.deprecated_in((2, 4, 0)))
3099
def unregister_extra_format(klass, format):
3100
format_registry.unregister_extra(format)
3103
@symbol_versioning.deprecated_method(
3104
symbol_versioning.deprecated_in((2, 4, 0)))
3105
def get_formats(klass):
3106
return format_registry._get_all()
3109
@symbol_versioning.deprecated_method(
3110
symbol_versioning.deprecated_in((2, 4, 0)))
2831
3111
def set_default_format(klass, format):
2832
klass._default_format = format
3112
format_registry.set_default(format)
3115
@symbol_versioning.deprecated_method(
3116
symbol_versioning.deprecated_in((2, 4, 0)))
2835
3117
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(),
3118
format_registry.remove(format)
3120
def get_controldir_for_branch(self):
3121
"""Get the control directory format for creating branches.
3123
This is to support testing of working tree formats that can not exist
3124
in the same control directory as a branch.
3126
return self._matchingbzrdir
3129
class WorkingTreeFormatMetaDir(bzrdir.BzrDirMetaComponentFormat, WorkingTreeFormat):
3130
"""Base class for working trees that live in bzr meta directories."""
3133
WorkingTreeFormat.__init__(self)
3134
bzrdir.BzrDirMetaComponentFormat.__init__(self)
3137
def find_format_string(klass, controldir):
3138
"""Return format name for the working tree object in controldir."""
3140
transport = controldir.get_workingtree_transport(None)
3141
return transport.get_bytes("format")
3142
except errors.NoSuchFile:
3143
raise errors.NoWorkingTree(base=transport.base)
3146
def find_format(klass, controldir):
3147
"""Return the format for the working tree object in controldir."""
3148
format_string = klass.find_format_string(controldir)
3149
return klass._find_format(format_registry, 'working tree',
3153
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3154
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3155
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3156
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3157
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3158
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3159
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3160
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3161
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")