2607
1728
return ShelfManager(self, self._transport)
2610
class WorkingTree2(WorkingTree):
2611
"""This is the Format 2 working tree.
2613
This was the first weave based working tree.
2614
- uses os locks for locking.
2615
- uses the branch last-revision.
1731
class InventoryWorkingTree(WorkingTree,
1732
bzrlib.mutabletree.MutableInventoryTree):
1733
"""Base class for working trees that are inventory-oriented.
1735
The inventory is held in the `Branch` working-inventory, and the
1736
files are in a directory on disk.
1738
It is possible for a `WorkingTree` to have a filename which is
1739
not listed in the Inventory and vice versa.
2618
def __init__(self, *args, **kwargs):
2619
super(WorkingTree2, self).__init__(*args, **kwargs)
2620
# WorkingTree2 has more of a constraint that self._inventory must
2621
# exist. Because this is an older format, we don't mind the overhead
2622
# caused by the extra computation here.
2624
# Newer WorkingTree's should only have self._inventory set when they
2626
if self._inventory is None:
2627
self.read_working_inventory()
2629
def _get_check_refs(self):
2630
"""Return the references needed to perform a check of this tree."""
2631
return [('trees', self.last_revision())]
1742
def __init__(self, basedir='.',
1743
branch=DEPRECATED_PARAMETER,
1745
_control_files=None,
1749
"""Construct a InventoryWorkingTree instance. This is not a public API.
1751
:param branch: A branch to override probing for the branch.
1753
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1754
branch=branch, _transport=_control_files._transport,
1755
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1757
self._control_files = _control_files
1758
self._detect_case_handling()
1760
if _inventory is None:
1761
# This will be acquired on lock_read() or lock_write()
1762
self._inventory_is_modified = False
1763
self._inventory = None
1765
# the caller of __init__ has provided an inventory,
1766
# we assume they know what they are doing - as its only
1767
# the Format factory and creation methods that are
1768
# permitted to do this.
1769
self._set_inventory(_inventory, dirty=False)
1771
def _set_inventory(self, inv, dirty):
1772
"""Set the internal cached inventory.
1774
:param inv: The inventory to set.
1775
:param dirty: A boolean indicating whether the inventory is the same
1776
logical inventory as whats on disk. If True the inventory is not
1777
the same and should be written to disk or data will be lost, if
1778
False then the inventory is the same as that on disk and any
1779
serialisation would be unneeded overhead.
1781
self._inventory = inv
1782
self._inventory_is_modified = dirty
1784
def _detect_case_handling(self):
1785
wt_trans = self.bzrdir.get_workingtree_transport(None)
1787
wt_trans.stat(self._format.case_sensitive_filename)
1788
except errors.NoSuchFile:
1789
self.case_sensitive = True
1791
self.case_sensitive = False
1793
self._setup_directory_is_tree_reference()
1795
def _serialize(self, inventory, out_file):
1796
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1799
def _deserialize(selt, in_file):
1800
return xml5.serializer_v5.read_inventory(in_file)
1802
def break_lock(self):
1803
"""Break a lock if one is present from another instance.
1805
Uses the ui factory to ask for confirmation if the lock may be from
1808
This will probe the repository for its lock as well.
1810
self._control_files.break_lock()
1811
self.branch.break_lock()
1813
def is_locked(self):
1814
return self._control_files.is_locked()
1816
def _must_be_locked(self):
1817
if not self.is_locked():
1818
raise errors.ObjectNotLocked(self)
1820
def lock_read(self):
1821
"""Lock the tree for reading.
1823
This also locks the branch, and can be unlocked via self.unlock().
1825
:return: A bzrlib.lock.LogicalLockResult.
1827
if not self.is_locked():
1829
self.branch.lock_read()
1831
self._control_files.lock_read()
1832
return LogicalLockResult(self.unlock)
1834
self.branch.unlock()
2633
1837
def lock_tree_write(self):
2634
"""See WorkingTree.lock_tree_write().
2636
In Format2 WorkingTrees we have a single lock for the branch and tree
2637
so lock_tree_write() degrades to lock_write().
1838
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1840
:return: A bzrlib.lock.LogicalLockResult.
1842
if not self.is_locked():
1844
self.branch.lock_read()
1846
self._control_files.lock_write()
1847
return LogicalLockResult(self.unlock)
1849
self.branch.unlock()
1852
def lock_write(self):
1853
"""See MutableTree.lock_write, and WorkingTree.unlock.
1855
:return: A bzrlib.lock.LogicalLockResult.
1857
if not self.is_locked():
2639
1859
self.branch.lock_write()
2641
return self._control_files.lock_write()
1861
self._control_files.lock_write()
1862
return LogicalLockResult(self.unlock)
2643
1864
self.branch.unlock()
2647
# do non-implementation specific cleanup
2650
# we share control files:
2651
if self._control_files._lock_count == 3:
2652
# _inventory_is_modified is always False during a read lock.
2653
if self._inventory_is_modified:
2655
self._write_hashcache_if_dirty()
2657
# reverse order of locking.
1867
def get_physical_lock_status(self):
1868
return self._control_files.get_physical_lock_status()
1870
@needs_tree_write_lock
1871
def _write_inventory(self, inv):
1872
"""Write inventory as the current inventory."""
1873
self._set_inventory(inv, dirty=True)
1876
# XXX: This method should be deprecated in favour of taking in a proper
1877
# new Inventory object.
1878
@needs_tree_write_lock
1879
def set_inventory(self, new_inventory_list):
1880
from bzrlib.inventory import (Inventory,
1884
inv = Inventory(self.get_root_id())
1885
for path, file_id, parent, kind in new_inventory_list:
1886
name = os.path.basename(path)
1889
# fixme, there should be a factory function inv,add_??
1890
if kind == 'directory':
1891
inv.add(InventoryDirectory(file_id, name, parent))
1892
elif kind == 'file':
1893
inv.add(InventoryFile(file_id, name, parent))
1894
elif kind == 'symlink':
1895
inv.add(InventoryLink(file_id, name, parent))
1897
raise errors.BzrError("unknown kind %r" % kind)
1898
self._write_inventory(inv)
1900
def _write_basis_inventory(self, xml):
1901
"""Write the basis inventory XML to the basis-inventory file"""
1902
path = self._basis_inventory_name()
1904
self._transport.put_file(path, sio,
1905
mode=self.bzrdir._get_file_mode())
1907
def _reset_data(self):
1908
"""Reset transient data that cannot be revalidated."""
1909
self._inventory_is_modified = False
1910
f = self._transport.get('inventory')
2659
return self._control_files.unlock()
1912
result = self._deserialize(f)
2661
self.branch.unlock()
2664
class WorkingTree3(WorkingTree):
2665
"""This is the Format 3 working tree.
2667
This differs from the base WorkingTree by:
2668
- having its own file lock
2669
- having its own last-revision property.
2671
This is new in bzr 0.8
2675
def _last_revision(self):
2676
"""See Mutable.last_revision."""
1915
self._set_inventory(result, dirty=False)
1917
def _set_root_id(self, file_id):
1918
"""Set the root id for this tree, in a format specific manner.
1920
:param file_id: The file id to assign to the root. It must not be
1921
present in the current inventory or an error will occur. It must
1922
not be None, but rather a valid file id.
1924
inv = self._inventory
1925
orig_root_id = inv.root.file_id
1926
# TODO: it might be nice to exit early if there was nothing
1927
# to do, saving us from trigger a sync on unlock.
1928
self._inventory_is_modified = True
1929
# we preserve the root inventory entry object, but
1930
# unlinkit from the byid index
1931
del inv._byid[inv.root.file_id]
1932
inv.root.file_id = file_id
1933
# and link it into the index with the new changed id.
1934
inv._byid[inv.root.file_id] = inv.root
1935
# and finally update all children to reference the new id.
1936
# XXX: this should be safe to just look at the root.children
1937
# list, not the WHOLE INVENTORY.
1940
if entry.parent_id == orig_root_id:
1941
entry.parent_id = inv.root.file_id
1943
def all_file_ids(self):
1944
"""See Tree.iter_all_file_ids"""
1945
return set(self.inventory)
1947
@needs_tree_write_lock
1948
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1949
"""See MutableTree.set_parent_trees."""
1950
parent_ids = [rev for (rev, tree) in parents_list]
1951
for revision_id in parent_ids:
1952
_mod_revision.check_not_reserved_id(revision_id)
1954
self._check_parents_for_ghosts(parent_ids,
1955
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1957
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1959
if len(parent_ids) == 0:
1960
leftmost_parent_id = _mod_revision.NULL_REVISION
1961
leftmost_parent_tree = None
1963
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1965
if self._change_last_revision(leftmost_parent_id):
1966
if leftmost_parent_tree is None:
1967
# If we don't have a tree, fall back to reading the
1968
# parent tree from the repository.
1969
self._cache_basis_inventory(leftmost_parent_id)
1971
inv = leftmost_parent_tree.inventory
1972
xml = self._create_basis_xml_from_inventory(
1973
leftmost_parent_id, inv)
1974
self._write_basis_inventory(xml)
1975
self._set_merges_from_parent_ids(parent_ids)
1977
def _cache_basis_inventory(self, new_revision):
1978
"""Cache new_revision as the basis inventory."""
1979
# TODO: this should allow the ready-to-use inventory to be passed in,
1980
# as commit already has that ready-to-use [while the format is the
2678
return self._transport.get_bytes('last-revision')
2679
except errors.NoSuchFile:
2680
return _mod_revision.NULL_REVISION
2682
def _change_last_revision(self, revision_id):
2683
"""See WorkingTree._change_last_revision."""
2684
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2686
self._transport.delete('last-revision')
2687
except errors.NoSuchFile:
2691
self._transport.put_bytes('last-revision', revision_id,
2692
mode=self.bzrdir._get_file_mode())
2695
def _get_check_refs(self):
2696
"""Return the references needed to perform a check of this tree."""
2697
return [('trees', self.last_revision())]
1983
# this double handles the inventory - unpack and repack -
1984
# but is easier to understand. We can/should put a conditional
1985
# in here based on whether the inventory is in the latest format
1986
# - perhaps we should repack all inventories on a repository
1988
# the fast path is to copy the raw xml from the repository. If the
1989
# xml contains 'revision_id="', then we assume the right
1990
# revision_id is set. We must check for this full string, because a
1991
# root node id can legitimately look like 'revision_id' but cannot
1993
xml = self.branch.repository._get_inventory_xml(new_revision)
1994
firstline = xml.split('\n', 1)[0]
1995
if (not 'revision_id="' in firstline or
1996
'format="7"' not in firstline):
1997
inv = self.branch.repository._serializer.read_inventory_from_string(
1999
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2000
self._write_basis_inventory(xml)
2001
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2004
def _basis_inventory_name(self):
2005
return 'basis-inventory-cache'
2007
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2008
"""Create the text that will be saved in basis-inventory"""
2009
inventory.revision_id = revision_id
2010
return xml7.serializer_v7.write_inventory_to_string(inventory)
2699
2012
@needs_tree_write_lock
2700
2013
def set_conflicts(self, conflicts):
2720
2033
raise errors.ConflictFormatError()
2721
2034
except StopIteration:
2722
2035
raise errors.ConflictFormatError()
2723
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2036
reader = _mod_rio.RioReader(confile)
2037
return _mod_conflicts.ConflictList.from_stanzas(reader)
2725
2039
confile.close()
2728
# do non-implementation specific cleanup
2730
if self._control_files._lock_count == 1:
2731
# _inventory_is_modified is always False during a read lock.
2732
if self._inventory_is_modified:
2734
self._write_hashcache_if_dirty()
2735
# reverse order of locking.
2737
return self._control_files.unlock()
2739
self.branch.unlock()
2742
def get_conflicted_stem(path):
2743
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2744
if path.endswith(suffix):
2745
return path[:-len(suffix)]
2748
class WorkingTreeFormat(object):
2041
def read_basis_inventory(self):
2042
"""Read the cached basis inventory."""
2043
path = self._basis_inventory_name()
2044
return self._transport.get_bytes(path)
2047
def read_working_inventory(self):
2048
"""Read the working inventory.
2050
:raises errors.InventoryModified: read_working_inventory will fail
2051
when the current in memory inventory has been modified.
2053
# conceptually this should be an implementation detail of the tree.
2054
# XXX: Deprecate this.
2055
# ElementTree does its own conversion from UTF-8, so open in
2057
if self._inventory_is_modified:
2058
raise errors.InventoryModified(self)
2059
f = self._transport.get('inventory')
2061
result = self._deserialize(f)
2064
self._set_inventory(result, dirty=False)
2068
def get_root_id(self):
2069
"""Return the id of this trees root"""
2070
return self._inventory.root.file_id
2072
def has_id(self, file_id):
2073
# files that have been deleted are excluded
2074
inv = self.inventory
2075
if not inv.has_id(file_id):
2077
path = inv.id2path(file_id)
2078
return osutils.lexists(self.abspath(path))
2080
def has_or_had_id(self, file_id):
2081
if file_id == self.inventory.root.file_id:
2083
return self.inventory.has_id(file_id)
2085
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2087
"""Iterate through file_ids for this tree.
2089
file_ids are in a WorkingTree if they are in the working inventory
2090
and the working file exists.
2092
inv = self._inventory
2093
for path, ie in inv.iter_entries():
2094
if osutils.lexists(self.abspath(path)):
2097
@needs_tree_write_lock
2098
def set_last_revision(self, new_revision):
2099
"""Change the last revision in the working tree."""
2100
if self._change_last_revision(new_revision):
2101
self._cache_basis_inventory(new_revision)
2103
def _get_check_refs(self):
2104
"""Return the references needed to perform a check of this tree.
2106
The default implementation returns no refs, and is only suitable for
2107
trees that have no local caching and can commit on ghosts at any time.
2109
:seealso: bzrlib.check for details about check_refs.
2114
def _check(self, references):
2115
"""Check the tree for consistency.
2117
:param references: A dict with keys matching the items returned by
2118
self._get_check_refs(), and values from looking those keys up in
2121
tree_basis = self.basis_tree()
2122
tree_basis.lock_read()
2124
repo_basis = references[('trees', self.last_revision())]
2125
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2126
raise errors.BzrCheckError(
2127
"Mismatched basis inventory content.")
2133
def check_state(self):
2134
"""Check that the working state is/isn't valid."""
2135
check_refs = self._get_check_refs()
2137
for ref in check_refs:
2140
refs[ref] = self.branch.repository.revision_tree(value)
2143
@needs_tree_write_lock
2144
def reset_state(self, revision_ids=None):
2145
"""Reset the state of the working tree.
2147
This does a hard-reset to a last-known-good state. This is a way to
2148
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2150
if revision_ids is None:
2151
revision_ids = self.get_parent_ids()
2152
if not revision_ids:
2153
rt = self.branch.repository.revision_tree(
2154
_mod_revision.NULL_REVISION)
2156
rt = self.branch.repository.revision_tree(revision_ids[0])
2157
self._write_inventory(rt.inventory)
2158
self.set_parent_ids(revision_ids)
2161
"""Write the in memory inventory to disk."""
2162
# TODO: Maybe this should only write on dirty ?
2163
if self._control_files._lock_mode != 'w':
2164
raise errors.NotWriteLocked(self)
2166
self._serialize(self._inventory, sio)
2168
self._transport.put_file('inventory', sio,
2169
mode=self.bzrdir._get_file_mode())
2170
self._inventory_is_modified = False
2172
def get_file_mtime(self, file_id, path=None):
2173
"""See Tree.get_file_mtime."""
2175
path = self.inventory.id2path(file_id)
2177
return os.lstat(self.abspath(path)).st_mtime
2179
if e.errno == errno.ENOENT:
2180
raise errors.FileTimestampUnavailable(path)
2183
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2184
file_id = self.path2id(path)
2186
# For unversioned files on win32, we just assume they are not
2189
return self._inventory[file_id].executable
2191
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2192
mode = stat_result.st_mode
2193
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2195
if not supports_executable():
2196
def is_executable(self, file_id, path=None):
2197
return self._inventory[file_id].executable
2199
_is_executable_from_path_and_stat = \
2200
_is_executable_from_path_and_stat_from_basis
2202
def is_executable(self, file_id, path=None):
2204
path = self.id2path(file_id)
2205
mode = os.lstat(self.abspath(path)).st_mode
2206
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2208
_is_executable_from_path_and_stat = \
2209
_is_executable_from_path_and_stat_from_stat
2211
@needs_tree_write_lock
2212
def _add(self, files, ids, kinds):
2213
"""See MutableTree._add."""
2214
# TODO: Re-adding a file that is removed in the working copy
2215
# should probably put it back with the previous ID.
2216
# the read and write working inventory should not occur in this
2217
# function - they should be part of lock_write and unlock.
2218
inv = self.inventory
2219
for f, file_id, kind in zip(files, ids, kinds):
2221
inv.add_path(f, kind=kind)
2223
inv.add_path(f, kind=kind, file_id=file_id)
2224
self._inventory_is_modified = True
2226
def revision_tree(self, revision_id):
2227
"""See WorkingTree.revision_id."""
2228
if revision_id == self.last_revision():
2230
xml = self.read_basis_inventory()
2231
except errors.NoSuchFile:
2235
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2236
# dont use the repository revision_tree api because we want
2237
# to supply the inventory.
2238
if inv.revision_id == revision_id:
2239
return revisiontree.InventoryRevisionTree(
2240
self.branch.repository, inv, revision_id)
2241
except errors.BadInventoryFormat:
2243
# raise if there was no inventory, or if we read the wrong inventory.
2244
raise errors.NoSuchRevisionInTree(self, revision_id)
2247
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2248
"""See Tree.annotate_iter
2250
This implementation will use the basis tree implementation if possible.
2251
Lines not in the basis are attributed to CURRENT_REVISION
2253
If there are pending merges, lines added by those merges will be
2254
incorrectly attributed to CURRENT_REVISION (but after committing, the
2255
attribution will be correct).
2257
maybe_file_parent_keys = []
2258
for parent_id in self.get_parent_ids():
2260
parent_tree = self.revision_tree(parent_id)
2261
except errors.NoSuchRevisionInTree:
2262
parent_tree = self.branch.repository.revision_tree(parent_id)
2263
parent_tree.lock_read()
2265
if not parent_tree.has_id(file_id):
2267
ie = parent_tree.inventory[file_id]
2268
if ie.kind != 'file':
2269
# Note: this is slightly unnecessary, because symlinks and
2270
# directories have a "text" which is the empty text, and we
2271
# know that won't mess up annotations. But it seems cleaner
2273
parent_text_key = (file_id, ie.revision)
2274
if parent_text_key not in maybe_file_parent_keys:
2275
maybe_file_parent_keys.append(parent_text_key)
2277
parent_tree.unlock()
2278
graph = _mod_graph.Graph(self.branch.repository.texts)
2279
heads = graph.heads(maybe_file_parent_keys)
2280
file_parent_keys = []
2281
for key in maybe_file_parent_keys:
2283
file_parent_keys.append(key)
2285
# Now we have the parents of this content
2286
annotator = self.branch.repository.texts.get_annotator()
2287
text = self.get_file_text(file_id)
2288
this_key =(file_id, default_revision)
2289
annotator.add_special_text(this_key, file_parent_keys, text)
2290
annotations = [(key[-1], line)
2291
for key, line in annotator.annotate_flat(this_key)]
2294
def _put_rio(self, filename, stanzas, header):
2295
self._must_be_locked()
2296
my_file = _mod_rio.rio_file(stanzas, header)
2297
self._transport.put_file(filename, my_file,
2298
mode=self.bzrdir._get_file_mode())
2300
@needs_tree_write_lock
2301
def set_merge_modified(self, modified_hashes):
2303
for file_id, hash in modified_hashes.iteritems():
2304
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2306
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2309
def merge_modified(self):
2310
"""Return a dictionary of files modified by a merge.
2312
The list is initialized by WorkingTree.set_merge_modified, which is
2313
typically called after we make some automatic updates to the tree
2316
This returns a map of file_id->sha1, containing only files which are
2317
still in the working inventory and have that text hash.
2320
hashfile = self._transport.get('merge-hashes')
2321
except errors.NoSuchFile:
2326
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2327
raise errors.MergeModifiedFormatError()
2328
except StopIteration:
2329
raise errors.MergeModifiedFormatError()
2330
for s in _mod_rio.RioReader(hashfile):
2331
# RioReader reads in Unicode, so convert file_ids back to utf8
2332
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2333
if not self.inventory.has_id(file_id):
2335
text_hash = s.get("hash")
2336
if text_hash == self.get_file_sha1(file_id):
2337
merge_hashes[file_id] = text_hash
2343
def subsume(self, other_tree):
2344
def add_children(inventory, entry):
2345
for child_entry in entry.children.values():
2346
inventory._byid[child_entry.file_id] = child_entry
2347
if child_entry.kind == 'directory':
2348
add_children(inventory, child_entry)
2349
if other_tree.get_root_id() == self.get_root_id():
2350
raise errors.BadSubsumeSource(self, other_tree,
2351
'Trees have the same root')
2353
other_tree_path = self.relpath(other_tree.basedir)
2354
except errors.PathNotChild:
2355
raise errors.BadSubsumeSource(self, other_tree,
2356
'Tree is not contained by the other')
2357
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2358
if new_root_parent is None:
2359
raise errors.BadSubsumeSource(self, other_tree,
2360
'Parent directory is not versioned.')
2361
# We need to ensure that the result of a fetch will have a
2362
# versionedfile for the other_tree root, and only fetching into
2363
# RepositoryKnit2 guarantees that.
2364
if not self.branch.repository.supports_rich_root():
2365
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2366
other_tree.lock_tree_write()
2368
new_parents = other_tree.get_parent_ids()
2369
other_root = other_tree.inventory.root
2370
other_root.parent_id = new_root_parent
2371
other_root.name = osutils.basename(other_tree_path)
2372
self.inventory.add(other_root)
2373
add_children(self.inventory, other_root)
2374
self._write_inventory(self.inventory)
2375
# normally we don't want to fetch whole repositories, but i think
2376
# here we really do want to consolidate the whole thing.
2377
for parent_id in other_tree.get_parent_ids():
2378
self.branch.fetch(other_tree.branch, parent_id)
2379
self.add_parent_tree_id(parent_id)
2382
other_tree.bzrdir.retire_bzrdir()
2384
@needs_tree_write_lock
2385
def extract(self, file_id, format=None):
2386
"""Extract a subtree from this tree.
2388
A new branch will be created, relative to the path for this tree.
2392
segments = osutils.splitpath(path)
2393
transport = self.branch.bzrdir.root_transport
2394
for name in segments:
2395
transport = transport.clone(name)
2396
transport.ensure_base()
2399
sub_path = self.id2path(file_id)
2400
branch_transport = mkdirs(sub_path)
2402
format = self.bzrdir.cloning_metadir()
2403
branch_transport.ensure_base()
2404
branch_bzrdir = format.initialize_on_transport(branch_transport)
2406
repo = branch_bzrdir.find_repository()
2407
except errors.NoRepositoryPresent:
2408
repo = branch_bzrdir.create_repository()
2409
if not repo.supports_rich_root():
2410
raise errors.RootNotRich()
2411
new_branch = branch_bzrdir.create_branch()
2412
new_branch.pull(self.branch)
2413
for parent_id in self.get_parent_ids():
2414
new_branch.fetch(self.branch, parent_id)
2415
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2416
if tree_transport.base != branch_transport.base:
2417
tree_bzrdir = format.initialize_on_transport(tree_transport)
2418
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2419
target_branch=new_branch)
2421
tree_bzrdir = branch_bzrdir
2422
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2423
wt.set_parent_ids(self.get_parent_ids())
2424
my_inv = self.inventory
2425
child_inv = inventory.Inventory(root_id=None)
2426
new_root = my_inv[file_id]
2427
my_inv.remove_recursive_id(file_id)
2428
new_root.parent_id = None
2429
child_inv.add(new_root)
2430
self._write_inventory(my_inv)
2431
wt._write_inventory(child_inv)
2434
def list_files(self, include_root=False, from_dir=None, recursive=True):
2435
"""List all files as (path, class, kind, id, entry).
2437
Lists, but does not descend into unversioned directories.
2438
This does not include files that have been deleted in this
2439
tree. Skips the control directory.
2441
:param include_root: if True, return an entry for the root
2442
:param from_dir: start from this directory or None for the root
2443
:param recursive: whether to recurse into subdirectories or not
2445
# list_files is an iterator, so @needs_read_lock doesn't work properly
2446
# with it. So callers should be careful to always read_lock the tree.
2447
if not self.is_locked():
2448
raise errors.ObjectNotLocked(self)
2450
inv = self.inventory
2451
if from_dir is None and include_root is True:
2452
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2453
# Convert these into local objects to save lookup times
2454
pathjoin = osutils.pathjoin
2455
file_kind = self._kind
2457
# transport.base ends in a slash, we want the piece
2458
# between the last two slashes
2459
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2461
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2463
# directory file_id, relative path, absolute path, reverse sorted children
2464
if from_dir is not None:
2465
from_dir_id = inv.path2id(from_dir)
2466
if from_dir_id is None:
2467
# Directory not versioned
2469
from_dir_abspath = pathjoin(self.basedir, from_dir)
2471
from_dir_id = inv.root.file_id
2472
from_dir_abspath = self.basedir
2473
children = os.listdir(from_dir_abspath)
2475
# jam 20060527 The kernel sized tree seems equivalent whether we
2476
# use a deque and popleft to keep them sorted, or if we use a plain
2477
# list and just reverse() them.
2478
children = collections.deque(children)
2479
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2481
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2484
f = children.popleft()
2485
## TODO: If we find a subdirectory with its own .bzr
2486
## directory, then that is a separate tree and we
2487
## should exclude it.
2489
# the bzrdir for this tree
2490
if transport_base_dir == f:
2493
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2494
# and 'f' doesn't begin with one, we can do a string op, rather
2495
# than the checks of pathjoin(), all relative paths will have an extra slash
2497
fp = from_dir_relpath + '/' + f
2500
fap = from_dir_abspath + '/' + f
2502
dir_ie = inv[from_dir_id]
2503
if dir_ie.kind == 'directory':
2504
f_ie = dir_ie.children.get(f)
2509
elif self.is_ignored(fp[1:]):
2512
# we may not have found this file, because of a unicode
2513
# issue, or because the directory was actually a symlink.
2514
f_norm, can_access = osutils.normalized_filename(f)
2515
if f == f_norm or not can_access:
2516
# No change, so treat this file normally
2519
# this file can be accessed by a normalized path
2520
# check again if it is versioned
2521
# these lines are repeated here for performance
2523
fp = from_dir_relpath + '/' + f
2524
fap = from_dir_abspath + '/' + f
2525
f_ie = inv.get_child(from_dir_id, f)
2528
elif self.is_ignored(fp[1:]):
2535
# make a last minute entry
2537
yield fp[1:], c, fk, f_ie.file_id, f_ie
2540
yield fp[1:], c, fk, None, fk_entries[fk]()
2542
yield fp[1:], c, fk, None, TreeEntry()
2545
if fk != 'directory':
2548
# But do this child first if recursing down
2550
new_children = os.listdir(fap)
2552
new_children = collections.deque(new_children)
2553
stack.append((f_ie.file_id, fp, fap, new_children))
2554
# Break out of inner loop,
2555
# so that we start outer loop with child
2558
# if we finished all children, pop it off the stack
2561
@needs_tree_write_lock
2562
def move(self, from_paths, to_dir=None, after=False):
2565
to_dir must exist in the inventory.
2567
If to_dir exists and is a directory, the files are moved into
2568
it, keeping their old names.
2570
Note that to_dir is only the last component of the new name;
2571
this doesn't change the directory.
2573
For each entry in from_paths the move mode will be determined
2576
The first mode moves the file in the filesystem and updates the
2577
inventory. The second mode only updates the inventory without
2578
touching the file on the filesystem.
2580
move uses the second mode if 'after == True' and the target is
2581
either not versioned or newly added, and present in the working tree.
2583
move uses the second mode if 'after == False' and the source is
2584
versioned but no longer in the working tree, and the target is not
2585
versioned but present in the working tree.
2587
move uses the first mode if 'after == False' and the source is
2588
versioned and present in the working tree, and the target is not
2589
versioned and not present in the working tree.
2591
Everything else results in an error.
2593
This returns a list of (from_path, to_path) pairs for each
2594
entry that is moved.
2599
# check for deprecated use of signature
2601
raise TypeError('You must supply a target directory')
2602
# check destination directory
2603
if isinstance(from_paths, basestring):
2605
inv = self.inventory
2606
to_abs = self.abspath(to_dir)
2607
if not isdir(to_abs):
2608
raise errors.BzrMoveFailedError('',to_dir,
2609
errors.NotADirectory(to_abs))
2610
if not self.has_filename(to_dir):
2611
raise errors.BzrMoveFailedError('',to_dir,
2612
errors.NotInWorkingDirectory(to_dir))
2613
to_dir_id = inv.path2id(to_dir)
2614
if to_dir_id is None:
2615
raise errors.BzrMoveFailedError('',to_dir,
2616
errors.NotVersionedError(path=to_dir))
2618
to_dir_ie = inv[to_dir_id]
2619
if to_dir_ie.kind != 'directory':
2620
raise errors.BzrMoveFailedError('',to_dir,
2621
errors.NotADirectory(to_abs))
2623
# create rename entries and tuples
2624
for from_rel in from_paths:
2625
from_tail = splitpath(from_rel)[-1]
2626
from_id = inv.path2id(from_rel)
2628
raise errors.BzrMoveFailedError(from_rel,to_dir,
2629
errors.NotVersionedError(path=from_rel))
2631
from_entry = inv[from_id]
2632
from_parent_id = from_entry.parent_id
2633
to_rel = pathjoin(to_dir, from_tail)
2634
rename_entry = InventoryWorkingTree._RenameEntry(
2637
from_tail=from_tail,
2638
from_parent_id=from_parent_id,
2639
to_rel=to_rel, to_tail=from_tail,
2640
to_parent_id=to_dir_id)
2641
rename_entries.append(rename_entry)
2642
rename_tuples.append((from_rel, to_rel))
2644
# determine which move mode to use. checks also for movability
2645
rename_entries = self._determine_mv_mode(rename_entries, after)
2647
original_modified = self._inventory_is_modified
2650
self._inventory_is_modified = True
2651
self._move(rename_entries)
2653
# restore the inventory on error
2654
self._inventory_is_modified = original_modified
2656
self._write_inventory(inv)
2657
return rename_tuples
2659
@needs_tree_write_lock
2660
def rename_one(self, from_rel, to_rel, after=False):
2663
This can change the directory or the filename or both.
2665
rename_one has several 'modes' to work. First, it can rename a physical
2666
file and change the file_id. That is the normal mode. Second, it can
2667
only change the file_id without touching any physical file.
2669
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2670
versioned but present in the working tree.
2672
rename_one uses the second mode if 'after == False' and 'from_rel' is
2673
versioned but no longer in the working tree, and 'to_rel' is not
2674
versioned but present in the working tree.
2676
rename_one uses the first mode if 'after == False' and 'from_rel' is
2677
versioned and present in the working tree, and 'to_rel' is not
2678
versioned and not present in the working tree.
2680
Everything else results in an error.
2682
inv = self.inventory
2685
# create rename entries and tuples
2686
from_tail = splitpath(from_rel)[-1]
2687
from_id = inv.path2id(from_rel)
2689
# if file is missing in the inventory maybe it's in the basis_tree
2690
basis_tree = self.branch.basis_tree()
2691
from_id = basis_tree.path2id(from_rel)
2693
raise errors.BzrRenameFailedError(from_rel,to_rel,
2694
errors.NotVersionedError(path=from_rel))
2695
# put entry back in the inventory so we can rename it
2696
from_entry = basis_tree.inventory[from_id].copy()
2699
from_entry = inv[from_id]
2700
from_parent_id = from_entry.parent_id
2701
to_dir, to_tail = os.path.split(to_rel)
2702
to_dir_id = inv.path2id(to_dir)
2703
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2705
from_tail=from_tail,
2706
from_parent_id=from_parent_id,
2707
to_rel=to_rel, to_tail=to_tail,
2708
to_parent_id=to_dir_id)
2709
rename_entries.append(rename_entry)
2711
# determine which move mode to use. checks also for movability
2712
rename_entries = self._determine_mv_mode(rename_entries, after)
2714
# check if the target changed directory and if the target directory is
2716
if to_dir_id is None:
2717
raise errors.BzrMoveFailedError(from_rel,to_rel,
2718
errors.NotVersionedError(path=to_dir))
2720
# all checks done. now we can continue with our actual work
2721
mutter('rename_one:\n'
2726
' to_dir_id {%s}\n',
2727
from_id, from_rel, to_rel, to_dir, to_dir_id)
2729
self._move(rename_entries)
2730
self._write_inventory(inv)
2732
class _RenameEntry(object):
2733
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2734
to_rel, to_tail, to_parent_id, only_change_inv=False,
2736
self.from_rel = from_rel
2737
self.from_id = from_id
2738
self.from_tail = from_tail
2739
self.from_parent_id = from_parent_id
2740
self.to_rel = to_rel
2741
self.to_tail = to_tail
2742
self.to_parent_id = to_parent_id
2743
self.change_id = change_id
2744
self.only_change_inv = only_change_inv
2746
def _determine_mv_mode(self, rename_entries, after=False):
2747
"""Determines for each from-to pair if both inventory and working tree
2748
or only the inventory has to be changed.
2750
Also does basic plausability tests.
2752
inv = self.inventory
2754
for rename_entry in rename_entries:
2755
# store to local variables for easier reference
2756
from_rel = rename_entry.from_rel
2757
from_id = rename_entry.from_id
2758
to_rel = rename_entry.to_rel
2759
to_id = inv.path2id(to_rel)
2760
only_change_inv = False
2763
# check the inventory for source and destination
2765
raise errors.BzrMoveFailedError(from_rel,to_rel,
2766
errors.NotVersionedError(path=from_rel))
2767
if to_id is not None:
2769
# allow it with --after but only if dest is newly added
2771
basis = self.basis_tree()
2774
if not basis.has_id(to_id):
2775
rename_entry.change_id = True
2780
raise errors.BzrMoveFailedError(from_rel,to_rel,
2781
errors.AlreadyVersionedError(path=to_rel))
2783
# try to determine the mode for rename (only change inv or change
2784
# inv and file system)
2786
if not self.has_filename(to_rel):
2787
raise errors.BzrMoveFailedError(from_id,to_rel,
2788
errors.NoSuchFile(path=to_rel,
2789
extra="New file has not been created yet"))
2790
only_change_inv = True
2791
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2792
only_change_inv = True
2793
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2794
only_change_inv = False
2795
elif (not self.case_sensitive
2796
and from_rel.lower() == to_rel.lower()
2797
and self.has_filename(from_rel)):
2798
only_change_inv = False
2800
# something is wrong, so lets determine what exactly
2801
if not self.has_filename(from_rel) and \
2802
not self.has_filename(to_rel):
2803
raise errors.BzrRenameFailedError(from_rel, to_rel,
2804
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2806
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2807
rename_entry.only_change_inv = only_change_inv
2808
return rename_entries
2810
def _move(self, rename_entries):
2811
"""Moves a list of files.
2813
Depending on the value of the flag 'only_change_inv', the
2814
file will be moved on the file system or not.
2816
inv = self.inventory
2819
for entry in rename_entries:
2821
self._move_entry(entry)
2823
self._rollback_move(moved)
2827
def _rollback_move(self, moved):
2828
"""Try to rollback a previous move in case of an filesystem error."""
2829
inv = self.inventory
2832
self._move_entry(WorkingTree._RenameEntry(
2833
entry.to_rel, entry.from_id,
2834
entry.to_tail, entry.to_parent_id, entry.from_rel,
2835
entry.from_tail, entry.from_parent_id,
2836
entry.only_change_inv))
2837
except errors.BzrMoveFailedError, e:
2838
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2839
" The working tree is in an inconsistent state."
2840
" Please consider doing a 'bzr revert'."
2841
" Error message is: %s" % e)
2843
def _move_entry(self, entry):
2844
inv = self.inventory
2845
from_rel_abs = self.abspath(entry.from_rel)
2846
to_rel_abs = self.abspath(entry.to_rel)
2847
if from_rel_abs == to_rel_abs:
2848
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2849
"Source and target are identical.")
2851
if not entry.only_change_inv:
2853
osutils.rename(from_rel_abs, to_rel_abs)
2855
raise errors.BzrMoveFailedError(entry.from_rel,
2858
to_id = inv.path2id(entry.to_rel)
2859
inv.remove_recursive_id(to_id)
2860
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2862
@needs_tree_write_lock
2863
def unversion(self, file_ids):
2864
"""Remove the file ids in file_ids from the current versioned set.
2866
When a file_id is unversioned, all of its children are automatically
2869
:param file_ids: The file ids to stop versioning.
2870
:raises: NoSuchId if any fileid is not currently versioned.
2872
for file_id in file_ids:
2873
if not self._inventory.has_id(file_id):
2874
raise errors.NoSuchId(self, file_id)
2875
for file_id in file_ids:
2876
if self._inventory.has_id(file_id):
2877
self._inventory.remove_recursive_id(file_id)
2879
# in the future this should just set a dirty bit to wait for the
2880
# final unlock. However, until all methods of workingtree start
2881
# with the current in -memory inventory rather than triggering
2882
# a read, it is more complex - we need to teach read_inventory
2883
# to know when to read, and when to not read first... and possibly
2884
# to save first when the in memory one may be corrupted.
2885
# so for now, we just only write it if it is indeed dirty.
2887
self._write_inventory(self._inventory)
2889
def stored_kind(self, file_id):
2890
"""See Tree.stored_kind"""
2891
return self.inventory[file_id].kind
2894
"""Yield all unversioned files in this WorkingTree.
2896
If there are any unversioned directories then only the directory is
2897
returned, not all its children. But if there are unversioned files
2898
under a versioned subdirectory, they are returned.
2900
Currently returned depth-first, sorted by name within directories.
2901
This is the same order used by 'osutils.walkdirs'.
2903
## TODO: Work from given directory downwards
2904
for path, dir_entry in self.inventory.directories():
2905
# mutter("search for unknowns in %r", path)
2906
dirabs = self.abspath(path)
2907
if not isdir(dirabs):
2908
# e.g. directory deleted
2912
for subf in os.listdir(dirabs):
2913
if self.bzrdir.is_control_filename(subf):
2915
if subf not in dir_entry.children:
2918
can_access) = osutils.normalized_filename(subf)
2919
except UnicodeDecodeError:
2920
path_os_enc = path.encode(osutils._fs_enc)
2921
relpath = path_os_enc + '/' + subf
2922
raise errors.BadFilenameEncoding(relpath,
2924
if subf_norm != subf and can_access:
2925
if subf_norm not in dir_entry.children:
2926
fl.append(subf_norm)
2932
subp = pathjoin(path, subf)
2935
def _walkdirs(self, prefix=""):
2936
"""Walk the directories of this tree.
2938
:param prefix: is used as the directrory to start with.
2939
:returns: a generator which yields items in the form::
2941
((curren_directory_path, fileid),
2942
[(file1_path, file1_name, file1_kind, None, file1_id,
2945
_directory = 'directory'
2946
# get the root in the inventory
2947
inv = self.inventory
2948
top_id = inv.path2id(prefix)
2952
pending = [(prefix, '', _directory, None, top_id, None)]
2955
currentdir = pending.pop()
2956
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2957
top_id = currentdir[4]
2959
relroot = currentdir[0] + '/'
2962
# FIXME: stash the node in pending
2964
if entry.kind == 'directory':
2965
for name, child in entry.sorted_children():
2966
dirblock.append((relroot + name, name, child.kind, None,
2967
child.file_id, child.kind
2969
yield (currentdir[0], entry.file_id), dirblock
2970
# push the user specified dirs from dirblock
2971
for dir in reversed(dirblock):
2972
if dir[2] == _directory:
2976
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2977
"""Registry for working tree formats."""
2979
def __init__(self, other_registry=None):
2980
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2981
self._default_format = None
2982
self._default_format_key = None
2984
def get_default(self):
2985
"""Return the current default format."""
2986
if (self._default_format_key is not None and
2987
self._default_format is None):
2988
self._default_format = self.get(self._default_format_key)
2989
return self._default_format
2991
def set_default(self, format):
2992
"""Set the default format."""
2993
self._default_format = format
2994
self._default_format_key = None
2996
def set_default_key(self, format_string):
2997
"""Set the default format by its format string."""
2998
self._default_format_key = format_string
2999
self._default_format = None
3002
format_registry = WorkingTreeFormatRegistry()
3005
class WorkingTreeFormat(controldir.ControlComponentFormat):
2749
3006
"""An encapsulation of the initialization and open routines for a format.
2751
3008
Formats provide three things:
3088
@symbol_versioning.deprecated_method(
3089
symbol_versioning.deprecated_in((2, 4, 0)))
2826
3090
def register_format(klass, format):
2827
klass._formats[format.get_format_string()] = format
3091
format_registry.register(format)
3094
@symbol_versioning.deprecated_method(
3095
symbol_versioning.deprecated_in((2, 4, 0)))
3096
def register_extra_format(klass, format):
3097
format_registry.register_extra(format)
3100
@symbol_versioning.deprecated_method(
3101
symbol_versioning.deprecated_in((2, 4, 0)))
3102
def unregister_extra_format(klass, format):
3103
format_registry.unregister_extra(format)
3106
@symbol_versioning.deprecated_method(
3107
symbol_versioning.deprecated_in((2, 4, 0)))
3108
def get_formats(klass):
3109
return format_registry._get_all()
3112
@symbol_versioning.deprecated_method(
3113
symbol_versioning.deprecated_in((2, 4, 0)))
2830
3114
def set_default_format(klass, format):
2831
klass._default_format = format
3115
format_registry.set_default(format)
3118
@symbol_versioning.deprecated_method(
3119
symbol_versioning.deprecated_in((2, 4, 0)))
2834
3120
def unregister_format(klass, format):
2835
del klass._formats[format.get_format_string()]
2838
class WorkingTreeFormat2(WorkingTreeFormat):
2839
"""The second working tree format.
2841
This format modified the hash cache from the format 1 hash cache.
2844
upgrade_recommended = True
2846
def get_format_description(self):
2847
"""See WorkingTreeFormat.get_format_description()."""
2848
return "Working tree format 2"
2850
def _stub_initialize_on_transport(self, transport, file_mode):
2851
"""Workaround: create control files for a remote working tree.
2853
This ensures that it can later be updated and dealt with locally,
2854
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2855
no working tree. (See bug #43064).
2858
inv = inventory.Inventory()
2859
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
transport.put_file('inventory', sio, file_mode)
2862
transport.put_bytes('pending-merges', '', file_mode)
2864
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2865
accelerator_tree=None, hardlink=False):
2866
"""See WorkingTreeFormat.initialize()."""
2867
if not isinstance(a_bzrdir.transport, LocalTransport):
2868
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2869
if from_branch is not None:
2870
branch = from_branch
2872
branch = a_bzrdir.open_branch()
2873
if revision_id is None:
2874
revision_id = _mod_revision.ensure_null(branch.last_revision())
2877
branch.generate_revision_history(revision_id)
2880
inv = inventory.Inventory()
2881
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2887
basis_tree = branch.repository.revision_tree(revision_id)
2888
if basis_tree.inventory.root is not None:
2889
wt.set_root_id(basis_tree.get_root_id())
2890
# set the parent list and cache the basis tree.
2891
if _mod_revision.is_null(revision_id):
2894
parent_trees = [(revision_id, basis_tree)]
2895
wt.set_parent_trees(parent_trees)
2896
transform.build_tree(basis_tree, wt)
2900
super(WorkingTreeFormat2, self).__init__()
2901
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2903
def open(self, a_bzrdir, _found=False):
2904
"""Return the WorkingTree object for a_bzrdir
2906
_found is a private parameter, do not use it. It is used to indicate
2907
if format probing has already been done.
2910
# we are being called directly and must probe.
2911
raise NotImplementedError
2912
if not isinstance(a_bzrdir.transport, LocalTransport):
2913
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2914
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2920
class WorkingTreeFormat3(WorkingTreeFormat):
2921
"""The second working tree format updated to record a format marker.
2924
- exists within a metadir controlling .bzr
2925
- includes an explicit version marker for the workingtree control
2926
files, separate from the BzrDir format
2927
- modifies the hash cache format
2929
- uses a LockDir to guard access for writes.
2932
upgrade_recommended = True
2934
def get_format_string(self):
2935
"""See WorkingTreeFormat.get_format_string()."""
2936
return "Bazaar-NG Working Tree format 3"
2938
def get_format_description(self):
2939
"""See WorkingTreeFormat.get_format_description()."""
2940
return "Working tree format 3"
2942
_lock_file_name = 'lock'
2943
_lock_class = LockDir
2945
_tree_class = WorkingTree3
2947
def __get_matchingbzrdir(self):
2948
return bzrdir.BzrDirMetaFormat1()
2950
_matchingbzrdir = property(__get_matchingbzrdir)
2952
def _open_control_files(self, a_bzrdir):
2953
transport = a_bzrdir.get_workingtree_transport(None)
2954
return LockableFiles(transport, self._lock_file_name,
2957
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2958
accelerator_tree=None, hardlink=False):
2959
"""See WorkingTreeFormat.initialize().
2961
:param revision_id: if supplied, create a working tree at a different
2962
revision than the branch is at.
2963
:param accelerator_tree: A tree which can be used for retrieving file
2964
contents more quickly than the revision tree, i.e. a workingtree.
2965
The revision tree will be used for cases where accelerator_tree's
2966
content is different.
2967
:param hardlink: If true, hard-link files from accelerator_tree,
2970
if not isinstance(a_bzrdir.transport, LocalTransport):
2971
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2972
transport = a_bzrdir.get_workingtree_transport(self)
2973
control_files = self._open_control_files(a_bzrdir)
2974
control_files.create_lock()
2975
control_files.lock_write()
2976
transport.put_bytes('format', self.get_format_string(),
2977
mode=a_bzrdir._get_file_mode())
2978
if from_branch is not None:
2979
branch = from_branch
2981
branch = a_bzrdir.open_branch()
2982
if revision_id is None:
2983
revision_id = _mod_revision.ensure_null(branch.last_revision())
2984
# WorkingTree3 can handle an inventory which has a unique root id.
2985
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2986
# those trees. And because there isn't a format bump inbetween, we
2987
# are maintaining compatibility with older clients.
2988
# inv = Inventory(root_id=gen_root_id())
2989
inv = self._initial_inventory()
2990
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2996
_control_files=control_files)
2997
wt.lock_tree_write()
2999
basis_tree = branch.repository.revision_tree(revision_id)
3000
# only set an explicit root id if there is one to set.
3001
if basis_tree.inventory.root is not None:
3002
wt.set_root_id(basis_tree.get_root_id())
3003
if revision_id == _mod_revision.NULL_REVISION:
3004
wt.set_parent_trees([])
3006
wt.set_parent_trees([(revision_id, basis_tree)])
3007
transform.build_tree(basis_tree, wt)
3009
# Unlock in this order so that the unlock-triggers-flush in
3010
# WorkingTree is given a chance to fire.
3011
control_files.unlock()
3015
def _initial_inventory(self):
3016
return inventory.Inventory()
3019
super(WorkingTreeFormat3, self).__init__()
3021
def open(self, a_bzrdir, _found=False):
3022
"""Return the WorkingTree object for a_bzrdir
3024
_found is a private parameter, do not use it. It is used to indicate
3025
if format probing has already been done.
3028
# we are being called directly and must probe.
3029
raise NotImplementedError
3030
if not isinstance(a_bzrdir.transport, LocalTransport):
3031
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3032
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3035
def _open(self, a_bzrdir, control_files):
3036
"""Open the tree itself.
3038
:param a_bzrdir: the dir for the tree.
3039
:param control_files: the control files for the tree.
3041
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3045
_control_files=control_files)
3048
return self.get_format_string()
3051
__default_format = WorkingTreeFormat6()
3052
WorkingTreeFormat.register_format(__default_format)
3053
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3054
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3055
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3056
WorkingTreeFormat.set_default_format(__default_format)
3057
# formats which have no format string are not discoverable
3058
# and not independently creatable, so are not registered.
3059
_legacy_formats = [WorkingTreeFormat2(),
3121
format_registry.remove(format)
3123
def get_controldir_for_branch(self):
3124
"""Get the control directory format for creating branches.
3126
This is to support testing of working tree formats that can not exist
3127
in the same control directory as a branch.
3129
return self._matchingbzrdir
3132
class WorkingTreeFormatMetaDir(bzrdir.BzrDirMetaComponentFormat, WorkingTreeFormat):
3133
"""Base class for working trees that live in bzr meta directories."""
3136
WorkingTreeFormat.__init__(self)
3137
bzrdir.BzrDirMetaComponentFormat.__init__(self)
3140
def find_format_string(klass, controldir):
3141
"""Return format name for the working tree object in controldir."""
3143
transport = controldir.get_workingtree_transport(None)
3144
return transport.get_bytes("format")
3145
except errors.NoSuchFile:
3146
raise errors.NoWorkingTree(base=transport.base)
3149
def find_format(klass, controldir):
3150
"""Return the format for the working tree object in controldir."""
3151
format_string = klass.find_format_string(controldir)
3152
return klass._find_format(format_registry, 'working tree',
3156
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3157
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3158
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3159
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3160
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3161
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3162
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3163
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3164
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
