2686
1723
return ShelfManager(self, self._transport)
2689
class WorkingTree2(WorkingTree):
2690
"""This is the Format 2 working tree.
2692
This was the first weave based working tree.
2693
- uses os locks for locking.
2694
- uses the branch last-revision.
1726
class InventoryWorkingTree(WorkingTree,
1727
bzrlib.mutabletree.MutableInventoryTree):
1728
"""Base class for working trees that are inventory-oriented.
1730
The inventory is held in the `Branch` working-inventory, and the
1731
files are in a directory on disk.
1733
It is possible for a `WorkingTree` to have a filename which is
1734
not listed in the Inventory and vice versa.
2697
def __init__(self, *args, **kwargs):
2698
super(WorkingTree2, self).__init__(*args, **kwargs)
2699
# WorkingTree2 has more of a constraint that self._inventory must
2700
# exist. Because this is an older format, we don't mind the overhead
2701
# caused by the extra computation here.
2703
# Newer WorkingTree's should only have self._inventory set when they
2705
if self._inventory is None:
2706
self.read_working_inventory()
2708
def _get_check_refs(self):
2709
"""Return the references needed to perform a check of this tree."""
2710
return [('trees', self.last_revision())]
1737
def __init__(self, basedir='.',
1738
branch=DEPRECATED_PARAMETER,
1740
_control_files=None,
1744
"""Construct a InventoryWorkingTree instance. This is not a public API.
1746
:param branch: A branch to override probing for the branch.
1748
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1749
branch=branch, _transport=_control_files._transport,
1750
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1752
self._control_files = _control_files
1753
self._detect_case_handling()
1755
if _inventory is None:
1756
# This will be acquired on lock_read() or lock_write()
1757
self._inventory_is_modified = False
1758
self._inventory = None
1760
# the caller of __init__ has provided an inventory,
1761
# we assume they know what they are doing - as its only
1762
# the Format factory and creation methods that are
1763
# permitted to do this.
1764
self._set_inventory(_inventory, dirty=False)
1766
def _set_inventory(self, inv, dirty):
1767
"""Set the internal cached inventory.
1769
:param inv: The inventory to set.
1770
:param dirty: A boolean indicating whether the inventory is the same
1771
logical inventory as whats on disk. If True the inventory is not
1772
the same and should be written to disk or data will be lost, if
1773
False then the inventory is the same as that on disk and any
1774
serialisation would be unneeded overhead.
1776
self._inventory = inv
1777
self._inventory_is_modified = dirty
1779
def _detect_case_handling(self):
1780
wt_trans = self.bzrdir.get_workingtree_transport(None)
1782
wt_trans.stat(self._format.case_sensitive_filename)
1783
except errors.NoSuchFile:
1784
self.case_sensitive = True
1786
self.case_sensitive = False
1788
self._setup_directory_is_tree_reference()
1790
def _serialize(self, inventory, out_file):
1791
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1794
def _deserialize(selt, in_file):
1795
return xml5.serializer_v5.read_inventory(in_file)
1797
def break_lock(self):
1798
"""Break a lock if one is present from another instance.
1800
Uses the ui factory to ask for confirmation if the lock may be from
1803
This will probe the repository for its lock as well.
1805
self._control_files.break_lock()
1806
self.branch.break_lock()
1808
def is_locked(self):
1809
return self._control_files.is_locked()
1811
def _must_be_locked(self):
1812
if not self.is_locked():
1813
raise errors.ObjectNotLocked(self)
1815
def lock_read(self):
1816
"""Lock the tree for reading.
1818
This also locks the branch, and can be unlocked via self.unlock().
1820
:return: A bzrlib.lock.LogicalLockResult.
1822
if not self.is_locked():
1824
self.branch.lock_read()
1826
self._control_files.lock_read()
1827
return LogicalLockResult(self.unlock)
1829
self.branch.unlock()
2712
1832
def lock_tree_write(self):
2713
"""See WorkingTree.lock_tree_write().
2715
In Format2 WorkingTrees we have a single lock for the branch and tree
2716
so lock_tree_write() degrades to lock_write().
2718
:return: An object with an unlock method which will release the lock
1833
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1835
:return: A bzrlib.lock.LogicalLockResult.
1837
if not self.is_locked():
1839
self.branch.lock_read()
1841
self._control_files.lock_write()
1842
return LogicalLockResult(self.unlock)
1844
self.branch.unlock()
1847
def lock_write(self):
1848
"""See MutableTree.lock_write, and WorkingTree.unlock.
1850
:return: A bzrlib.lock.LogicalLockResult.
1852
if not self.is_locked():
2721
1854
self.branch.lock_write()
2723
1856
self._control_files.lock_write()
1857
return LogicalLockResult(self.unlock)
2726
1859
self.branch.unlock()
2730
# do non-implementation specific cleanup
2733
# we share control files:
2734
if self._control_files._lock_count == 3:
2735
# _inventory_is_modified is always False during a read lock.
2736
if self._inventory_is_modified:
2738
self._write_hashcache_if_dirty()
2740
# reverse order of locking.
1862
def get_physical_lock_status(self):
1863
return self._control_files.get_physical_lock_status()
1865
@needs_tree_write_lock
1866
def _write_inventory(self, inv):
1867
"""Write inventory as the current inventory."""
1868
self._set_inventory(inv, dirty=True)
1871
# XXX: This method should be deprecated in favour of taking in a proper
1872
# new Inventory object.
1873
@needs_tree_write_lock
1874
def set_inventory(self, new_inventory_list):
1875
from bzrlib.inventory import (Inventory,
1879
inv = Inventory(self.get_root_id())
1880
for path, file_id, parent, kind in new_inventory_list:
1881
name = os.path.basename(path)
1884
# fixme, there should be a factory function inv,add_??
1885
if kind == 'directory':
1886
inv.add(InventoryDirectory(file_id, name, parent))
1887
elif kind == 'file':
1888
inv.add(InventoryFile(file_id, name, parent))
1889
elif kind == 'symlink':
1890
inv.add(InventoryLink(file_id, name, parent))
1892
raise errors.BzrError("unknown kind %r" % kind)
1893
self._write_inventory(inv)
1895
def _write_basis_inventory(self, xml):
1896
"""Write the basis inventory XML to the basis-inventory file"""
1897
path = self._basis_inventory_name()
1899
self._transport.put_file(path, sio,
1900
mode=self.bzrdir._get_file_mode())
1902
def _reset_data(self):
1903
"""Reset transient data that cannot be revalidated."""
1904
self._inventory_is_modified = False
1905
f = self._transport.get('inventory')
2742
return self._control_files.unlock()
1907
result = self._deserialize(f)
2744
self.branch.unlock()
2747
class WorkingTree3(WorkingTree):
2748
"""This is the Format 3 working tree.
2750
This differs from the base WorkingTree by:
2751
- having its own file lock
2752
- having its own last-revision property.
2754
This is new in bzr 0.8
2758
def _last_revision(self):
2759
"""See Mutable.last_revision."""
1910
self._set_inventory(result, dirty=False)
1912
def _set_root_id(self, file_id):
1913
"""Set the root id for this tree, in a format specific manner.
1915
:param file_id: The file id to assign to the root. It must not be
1916
present in the current inventory or an error will occur. It must
1917
not be None, but rather a valid file id.
1919
inv = self._inventory
1920
orig_root_id = inv.root.file_id
1921
# TODO: it might be nice to exit early if there was nothing
1922
# to do, saving us from trigger a sync on unlock.
1923
self._inventory_is_modified = True
1924
# we preserve the root inventory entry object, but
1925
# unlinkit from the byid index
1926
del inv._byid[inv.root.file_id]
1927
inv.root.file_id = file_id
1928
# and link it into the index with the new changed id.
1929
inv._byid[inv.root.file_id] = inv.root
1930
# and finally update all children to reference the new id.
1931
# XXX: this should be safe to just look at the root.children
1932
# list, not the WHOLE INVENTORY.
1935
if entry.parent_id == orig_root_id:
1936
entry.parent_id = inv.root.file_id
1938
def all_file_ids(self):
1939
"""See Tree.iter_all_file_ids"""
1940
return set(self.inventory)
1942
@needs_tree_write_lock
1943
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1944
"""See MutableTree.set_parent_trees."""
1945
parent_ids = [rev for (rev, tree) in parents_list]
1946
for revision_id in parent_ids:
1947
_mod_revision.check_not_reserved_id(revision_id)
1949
self._check_parents_for_ghosts(parent_ids,
1950
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1952
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1954
if len(parent_ids) == 0:
1955
leftmost_parent_id = _mod_revision.NULL_REVISION
1956
leftmost_parent_tree = None
1958
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1960
if self._change_last_revision(leftmost_parent_id):
1961
if leftmost_parent_tree is None:
1962
# If we don't have a tree, fall back to reading the
1963
# parent tree from the repository.
1964
self._cache_basis_inventory(leftmost_parent_id)
1966
inv = leftmost_parent_tree.inventory
1967
xml = self._create_basis_xml_from_inventory(
1968
leftmost_parent_id, inv)
1969
self._write_basis_inventory(xml)
1970
self._set_merges_from_parent_ids(parent_ids)
1972
def _cache_basis_inventory(self, new_revision):
1973
"""Cache new_revision as the basis inventory."""
1974
# TODO: this should allow the ready-to-use inventory to be passed in,
1975
# as commit already has that ready-to-use [while the format is the
2761
return self._transport.get_bytes('last-revision')
2762
except errors.NoSuchFile:
2763
return _mod_revision.NULL_REVISION
2765
def _change_last_revision(self, revision_id):
2766
"""See WorkingTree._change_last_revision."""
2767
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2769
self._transport.delete('last-revision')
2770
except errors.NoSuchFile:
2774
self._transport.put_bytes('last-revision', revision_id,
2775
mode=self.bzrdir._get_file_mode())
2778
def _get_check_refs(self):
2779
"""Return the references needed to perform a check of this tree."""
2780
return [('trees', self.last_revision())]
1978
# this double handles the inventory - unpack and repack -
1979
# but is easier to understand. We can/should put a conditional
1980
# in here based on whether the inventory is in the latest format
1981
# - perhaps we should repack all inventories on a repository
1983
# the fast path is to copy the raw xml from the repository. If the
1984
# xml contains 'revision_id="', then we assume the right
1985
# revision_id is set. We must check for this full string, because a
1986
# root node id can legitimately look like 'revision_id' but cannot
1988
xml = self.branch.repository._get_inventory_xml(new_revision)
1989
firstline = xml.split('\n', 1)[0]
1990
if (not 'revision_id="' in firstline or
1991
'format="7"' not in firstline):
1992
inv = self.branch.repository._serializer.read_inventory_from_string(
1994
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1995
self._write_basis_inventory(xml)
1996
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1999
def _basis_inventory_name(self):
2000
return 'basis-inventory-cache'
2002
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2003
"""Create the text that will be saved in basis-inventory"""
2004
inventory.revision_id = revision_id
2005
return xml7.serializer_v7.write_inventory_to_string(inventory)
2782
2007
@needs_tree_write_lock
2783
2008
def set_conflicts(self, conflicts):
2803
2028
raise errors.ConflictFormatError()
2804
2029
except StopIteration:
2805
2030
raise errors.ConflictFormatError()
2806
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2031
reader = _mod_rio.RioReader(confile)
2032
return _mod_conflicts.ConflictList.from_stanzas(reader)
2808
2034
confile.close()
2811
# do non-implementation specific cleanup
2813
if self._control_files._lock_count == 1:
2814
# _inventory_is_modified is always False during a read lock.
2815
if self._inventory_is_modified:
2817
self._write_hashcache_if_dirty()
2818
# reverse order of locking.
2820
return self._control_files.unlock()
2822
self.branch.unlock()
2825
def get_conflicted_stem(path):
2826
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2827
if path.endswith(suffix):
2828
return path[:-len(suffix)]
2831
class WorkingTreeFormat(object):
2036
def read_basis_inventory(self):
2037
"""Read the cached basis inventory."""
2038
path = self._basis_inventory_name()
2039
return self._transport.get_bytes(path)
2042
def read_working_inventory(self):
2043
"""Read the working inventory.
2045
:raises errors.InventoryModified: read_working_inventory will fail
2046
when the current in memory inventory has been modified.
2048
# conceptually this should be an implementation detail of the tree.
2049
# XXX: Deprecate this.
2050
# ElementTree does its own conversion from UTF-8, so open in
2052
if self._inventory_is_modified:
2053
raise errors.InventoryModified(self)
2054
f = self._transport.get('inventory')
2056
result = self._deserialize(f)
2059
self._set_inventory(result, dirty=False)
2063
def get_root_id(self):
2064
"""Return the id of this trees root"""
2065
return self._inventory.root.file_id
2067
def has_id(self, file_id):
2068
# files that have been deleted are excluded
2069
inv = self.inventory
2070
if not inv.has_id(file_id):
2072
path = inv.id2path(file_id)
2073
return osutils.lexists(self.abspath(path))
2075
def has_or_had_id(self, file_id):
2076
if file_id == self.inventory.root.file_id:
2078
return self.inventory.has_id(file_id)
2080
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2082
"""Iterate through file_ids for this tree.
2084
file_ids are in a WorkingTree if they are in the working inventory
2085
and the working file exists.
2087
inv = self._inventory
2088
for path, ie in inv.iter_entries():
2089
if osutils.lexists(self.abspath(path)):
2092
@needs_tree_write_lock
2093
def set_last_revision(self, new_revision):
2094
"""Change the last revision in the working tree."""
2095
if self._change_last_revision(new_revision):
2096
self._cache_basis_inventory(new_revision)
2098
def _get_check_refs(self):
2099
"""Return the references needed to perform a check of this tree.
2101
The default implementation returns no refs, and is only suitable for
2102
trees that have no local caching and can commit on ghosts at any time.
2104
:seealso: bzrlib.check for details about check_refs.
2109
def _check(self, references):
2110
"""Check the tree for consistency.
2112
:param references: A dict with keys matching the items returned by
2113
self._get_check_refs(), and values from looking those keys up in
2116
tree_basis = self.basis_tree()
2117
tree_basis.lock_read()
2119
repo_basis = references[('trees', self.last_revision())]
2120
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2121
raise errors.BzrCheckError(
2122
"Mismatched basis inventory content.")
2128
def check_state(self):
2129
"""Check that the working state is/isn't valid."""
2130
check_refs = self._get_check_refs()
2132
for ref in check_refs:
2135
refs[ref] = self.branch.repository.revision_tree(value)
2138
@needs_tree_write_lock
2139
def reset_state(self, revision_ids=None):
2140
"""Reset the state of the working tree.
2142
This does a hard-reset to a last-known-good state. This is a way to
2143
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2145
if revision_ids is None:
2146
revision_ids = self.get_parent_ids()
2147
if not revision_ids:
2148
rt = self.branch.repository.revision_tree(
2149
_mod_revision.NULL_REVISION)
2151
rt = self.branch.repository.revision_tree(revision_ids[0])
2152
self._write_inventory(rt.inventory)
2153
self.set_parent_ids(revision_ids)
2156
"""Write the in memory inventory to disk."""
2157
# TODO: Maybe this should only write on dirty ?
2158
if self._control_files._lock_mode != 'w':
2159
raise errors.NotWriteLocked(self)
2161
self._serialize(self._inventory, sio)
2163
self._transport.put_file('inventory', sio,
2164
mode=self.bzrdir._get_file_mode())
2165
self._inventory_is_modified = False
2167
def get_file_mtime(self, file_id, path=None):
2168
"""See Tree.get_file_mtime."""
2170
path = self.inventory.id2path(file_id)
2172
return os.lstat(self.abspath(path)).st_mtime
2174
if e.errno == errno.ENOENT:
2175
raise errors.FileTimestampUnavailable(path)
2178
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2179
file_id = self.path2id(path)
2181
# For unversioned files on win32, we just assume they are not
2184
return self._inventory[file_id].executable
2186
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2187
mode = stat_result.st_mode
2188
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2190
if not supports_executable():
2191
def is_executable(self, file_id, path=None):
2192
return self._inventory[file_id].executable
2194
_is_executable_from_path_and_stat = \
2195
_is_executable_from_path_and_stat_from_basis
2197
def is_executable(self, file_id, path=None):
2199
path = self.id2path(file_id)
2200
mode = os.lstat(self.abspath(path)).st_mode
2201
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2203
_is_executable_from_path_and_stat = \
2204
_is_executable_from_path_and_stat_from_stat
2206
@needs_tree_write_lock
2207
def _add(self, files, ids, kinds):
2208
"""See MutableTree._add."""
2209
# TODO: Re-adding a file that is removed in the working copy
2210
# should probably put it back with the previous ID.
2211
# the read and write working inventory should not occur in this
2212
# function - they should be part of lock_write and unlock.
2213
inv = self.inventory
2214
for f, file_id, kind in zip(files, ids, kinds):
2216
inv.add_path(f, kind=kind)
2218
inv.add_path(f, kind=kind, file_id=file_id)
2219
self._inventory_is_modified = True
2221
def revision_tree(self, revision_id):
2222
"""See WorkingTree.revision_id."""
2223
if revision_id == self.last_revision():
2225
xml = self.read_basis_inventory()
2226
except errors.NoSuchFile:
2230
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2231
# dont use the repository revision_tree api because we want
2232
# to supply the inventory.
2233
if inv.revision_id == revision_id:
2234
return revisiontree.InventoryRevisionTree(
2235
self.branch.repository, inv, revision_id)
2236
except errors.BadInventoryFormat:
2238
# raise if there was no inventory, or if we read the wrong inventory.
2239
raise errors.NoSuchRevisionInTree(self, revision_id)
2242
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2243
"""See Tree.annotate_iter
2245
This implementation will use the basis tree implementation if possible.
2246
Lines not in the basis are attributed to CURRENT_REVISION
2248
If there are pending merges, lines added by those merges will be
2249
incorrectly attributed to CURRENT_REVISION (but after committing, the
2250
attribution will be correct).
2252
maybe_file_parent_keys = []
2253
for parent_id in self.get_parent_ids():
2255
parent_tree = self.revision_tree(parent_id)
2256
except errors.NoSuchRevisionInTree:
2257
parent_tree = self.branch.repository.revision_tree(parent_id)
2258
parent_tree.lock_read()
2260
if not parent_tree.has_id(file_id):
2262
ie = parent_tree.inventory[file_id]
2263
if ie.kind != 'file':
2264
# Note: this is slightly unnecessary, because symlinks and
2265
# directories have a "text" which is the empty text, and we
2266
# know that won't mess up annotations. But it seems cleaner
2268
parent_text_key = (file_id, ie.revision)
2269
if parent_text_key not in maybe_file_parent_keys:
2270
maybe_file_parent_keys.append(parent_text_key)
2272
parent_tree.unlock()
2273
graph = _mod_graph.Graph(self.branch.repository.texts)
2274
heads = graph.heads(maybe_file_parent_keys)
2275
file_parent_keys = []
2276
for key in maybe_file_parent_keys:
2278
file_parent_keys.append(key)
2280
# Now we have the parents of this content
2281
annotator = self.branch.repository.texts.get_annotator()
2282
text = self.get_file_text(file_id)
2283
this_key =(file_id, default_revision)
2284
annotator.add_special_text(this_key, file_parent_keys, text)
2285
annotations = [(key[-1], line)
2286
for key, line in annotator.annotate_flat(this_key)]
2289
def _put_rio(self, filename, stanzas, header):
2290
self._must_be_locked()
2291
my_file = _mod_rio.rio_file(stanzas, header)
2292
self._transport.put_file(filename, my_file,
2293
mode=self.bzrdir._get_file_mode())
2295
@needs_tree_write_lock
2296
def set_merge_modified(self, modified_hashes):
2298
for file_id, hash in modified_hashes.iteritems():
2299
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2301
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2304
def merge_modified(self):
2305
"""Return a dictionary of files modified by a merge.
2307
The list is initialized by WorkingTree.set_merge_modified, which is
2308
typically called after we make some automatic updates to the tree
2311
This returns a map of file_id->sha1, containing only files which are
2312
still in the working inventory and have that text hash.
2315
hashfile = self._transport.get('merge-hashes')
2316
except errors.NoSuchFile:
2321
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2322
raise errors.MergeModifiedFormatError()
2323
except StopIteration:
2324
raise errors.MergeModifiedFormatError()
2325
for s in _mod_rio.RioReader(hashfile):
2326
# RioReader reads in Unicode, so convert file_ids back to utf8
2327
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2328
if not self.inventory.has_id(file_id):
2330
text_hash = s.get("hash")
2331
if text_hash == self.get_file_sha1(file_id):
2332
merge_hashes[file_id] = text_hash
2338
def subsume(self, other_tree):
2339
def add_children(inventory, entry):
2340
for child_entry in entry.children.values():
2341
inventory._byid[child_entry.file_id] = child_entry
2342
if child_entry.kind == 'directory':
2343
add_children(inventory, child_entry)
2344
if other_tree.get_root_id() == self.get_root_id():
2345
raise errors.BadSubsumeSource(self, other_tree,
2346
'Trees have the same root')
2348
other_tree_path = self.relpath(other_tree.basedir)
2349
except errors.PathNotChild:
2350
raise errors.BadSubsumeSource(self, other_tree,
2351
'Tree is not contained by the other')
2352
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2353
if new_root_parent is None:
2354
raise errors.BadSubsumeSource(self, other_tree,
2355
'Parent directory is not versioned.')
2356
# We need to ensure that the result of a fetch will have a
2357
# versionedfile for the other_tree root, and only fetching into
2358
# RepositoryKnit2 guarantees that.
2359
if not self.branch.repository.supports_rich_root():
2360
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2361
other_tree.lock_tree_write()
2363
new_parents = other_tree.get_parent_ids()
2364
other_root = other_tree.inventory.root
2365
other_root.parent_id = new_root_parent
2366
other_root.name = osutils.basename(other_tree_path)
2367
self.inventory.add(other_root)
2368
add_children(self.inventory, other_root)
2369
self._write_inventory(self.inventory)
2370
# normally we don't want to fetch whole repositories, but i think
2371
# here we really do want to consolidate the whole thing.
2372
for parent_id in other_tree.get_parent_ids():
2373
self.branch.fetch(other_tree.branch, parent_id)
2374
self.add_parent_tree_id(parent_id)
2377
other_tree.bzrdir.retire_bzrdir()
2379
@needs_tree_write_lock
2380
def extract(self, file_id, format=None):
2381
"""Extract a subtree from this tree.
2383
A new branch will be created, relative to the path for this tree.
2387
segments = osutils.splitpath(path)
2388
transport = self.branch.bzrdir.root_transport
2389
for name in segments:
2390
transport = transport.clone(name)
2391
transport.ensure_base()
2394
sub_path = self.id2path(file_id)
2395
branch_transport = mkdirs(sub_path)
2397
format = self.bzrdir.cloning_metadir()
2398
branch_transport.ensure_base()
2399
branch_bzrdir = format.initialize_on_transport(branch_transport)
2401
repo = branch_bzrdir.find_repository()
2402
except errors.NoRepositoryPresent:
2403
repo = branch_bzrdir.create_repository()
2404
if not repo.supports_rich_root():
2405
raise errors.RootNotRich()
2406
new_branch = branch_bzrdir.create_branch()
2407
new_branch.pull(self.branch)
2408
for parent_id in self.get_parent_ids():
2409
new_branch.fetch(self.branch, parent_id)
2410
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2411
if tree_transport.base != branch_transport.base:
2412
tree_bzrdir = format.initialize_on_transport(tree_transport)
2413
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2414
target_branch=new_branch)
2416
tree_bzrdir = branch_bzrdir
2417
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2418
wt.set_parent_ids(self.get_parent_ids())
2419
my_inv = self.inventory
2420
child_inv = inventory.Inventory(root_id=None)
2421
new_root = my_inv[file_id]
2422
my_inv.remove_recursive_id(file_id)
2423
new_root.parent_id = None
2424
child_inv.add(new_root)
2425
self._write_inventory(my_inv)
2426
wt._write_inventory(child_inv)
2429
def list_files(self, include_root=False, from_dir=None, recursive=True):
2430
"""List all files as (path, class, kind, id, entry).
2432
Lists, but does not descend into unversioned directories.
2433
This does not include files that have been deleted in this
2434
tree. Skips the control directory.
2436
:param include_root: if True, return an entry for the root
2437
:param from_dir: start from this directory or None for the root
2438
:param recursive: whether to recurse into subdirectories or not
2440
# list_files is an iterator, so @needs_read_lock doesn't work properly
2441
# with it. So callers should be careful to always read_lock the tree.
2442
if not self.is_locked():
2443
raise errors.ObjectNotLocked(self)
2445
inv = self.inventory
2446
if from_dir is None and include_root is True:
2447
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2448
# Convert these into local objects to save lookup times
2449
pathjoin = osutils.pathjoin
2450
file_kind = self._kind
2452
# transport.base ends in a slash, we want the piece
2453
# between the last two slashes
2454
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2456
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2458
# directory file_id, relative path, absolute path, reverse sorted children
2459
if from_dir is not None:
2460
from_dir_id = inv.path2id(from_dir)
2461
if from_dir_id is None:
2462
# Directory not versioned
2464
from_dir_abspath = pathjoin(self.basedir, from_dir)
2466
from_dir_id = inv.root.file_id
2467
from_dir_abspath = self.basedir
2468
children = os.listdir(from_dir_abspath)
2470
# jam 20060527 The kernel sized tree seems equivalent whether we
2471
# use a deque and popleft to keep them sorted, or if we use a plain
2472
# list and just reverse() them.
2473
children = collections.deque(children)
2474
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2476
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2479
f = children.popleft()
2480
## TODO: If we find a subdirectory with its own .bzr
2481
## directory, then that is a separate tree and we
2482
## should exclude it.
2484
# the bzrdir for this tree
2485
if transport_base_dir == f:
2488
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2489
# and 'f' doesn't begin with one, we can do a string op, rather
2490
# than the checks of pathjoin(), all relative paths will have an extra slash
2492
fp = from_dir_relpath + '/' + f
2495
fap = from_dir_abspath + '/' + f
2497
dir_ie = inv[from_dir_id]
2498
if dir_ie.kind == 'directory':
2499
f_ie = dir_ie.children.get(f)
2504
elif self.is_ignored(fp[1:]):
2507
# we may not have found this file, because of a unicode
2508
# issue, or because the directory was actually a symlink.
2509
f_norm, can_access = osutils.normalized_filename(f)
2510
if f == f_norm or not can_access:
2511
# No change, so treat this file normally
2514
# this file can be accessed by a normalized path
2515
# check again if it is versioned
2516
# these lines are repeated here for performance
2518
fp = from_dir_relpath + '/' + f
2519
fap = from_dir_abspath + '/' + f
2520
f_ie = inv.get_child(from_dir_id, f)
2523
elif self.is_ignored(fp[1:]):
2530
# make a last minute entry
2532
yield fp[1:], c, fk, f_ie.file_id, f_ie
2535
yield fp[1:], c, fk, None, fk_entries[fk]()
2537
yield fp[1:], c, fk, None, TreeEntry()
2540
if fk != 'directory':
2543
# But do this child first if recursing down
2545
new_children = os.listdir(fap)
2547
new_children = collections.deque(new_children)
2548
stack.append((f_ie.file_id, fp, fap, new_children))
2549
# Break out of inner loop,
2550
# so that we start outer loop with child
2553
# if we finished all children, pop it off the stack
2556
@needs_tree_write_lock
2557
def move(self, from_paths, to_dir=None, after=False):
2560
to_dir must exist in the inventory.
2562
If to_dir exists and is a directory, the files are moved into
2563
it, keeping their old names.
2565
Note that to_dir is only the last component of the new name;
2566
this doesn't change the directory.
2568
For each entry in from_paths the move mode will be determined
2571
The first mode moves the file in the filesystem and updates the
2572
inventory. The second mode only updates the inventory without
2573
touching the file on the filesystem.
2575
move uses the second mode if 'after == True' and the target is
2576
either not versioned or newly added, and present in the working tree.
2578
move uses the second mode if 'after == False' and the source is
2579
versioned but no longer in the working tree, and the target is not
2580
versioned but present in the working tree.
2582
move uses the first mode if 'after == False' and the source is
2583
versioned and present in the working tree, and the target is not
2584
versioned and not present in the working tree.
2586
Everything else results in an error.
2588
This returns a list of (from_path, to_path) pairs for each
2589
entry that is moved.
2594
# check for deprecated use of signature
2596
raise TypeError('You must supply a target directory')
2597
# check destination directory
2598
if isinstance(from_paths, basestring):
2600
inv = self.inventory
2601
to_abs = self.abspath(to_dir)
2602
if not isdir(to_abs):
2603
raise errors.BzrMoveFailedError('',to_dir,
2604
errors.NotADirectory(to_abs))
2605
if not self.has_filename(to_dir):
2606
raise errors.BzrMoveFailedError('',to_dir,
2607
errors.NotInWorkingDirectory(to_dir))
2608
to_dir_id = inv.path2id(to_dir)
2609
if to_dir_id is None:
2610
raise errors.BzrMoveFailedError('',to_dir,
2611
errors.NotVersionedError(path=to_dir))
2613
to_dir_ie = inv[to_dir_id]
2614
if to_dir_ie.kind != 'directory':
2615
raise errors.BzrMoveFailedError('',to_dir,
2616
errors.NotADirectory(to_abs))
2618
# create rename entries and tuples
2619
for from_rel in from_paths:
2620
from_tail = splitpath(from_rel)[-1]
2621
from_id = inv.path2id(from_rel)
2623
raise errors.BzrMoveFailedError(from_rel,to_dir,
2624
errors.NotVersionedError(path=from_rel))
2626
from_entry = inv[from_id]
2627
from_parent_id = from_entry.parent_id
2628
to_rel = pathjoin(to_dir, from_tail)
2629
rename_entry = InventoryWorkingTree._RenameEntry(
2632
from_tail=from_tail,
2633
from_parent_id=from_parent_id,
2634
to_rel=to_rel, to_tail=from_tail,
2635
to_parent_id=to_dir_id)
2636
rename_entries.append(rename_entry)
2637
rename_tuples.append((from_rel, to_rel))
2639
# determine which move mode to use. checks also for movability
2640
rename_entries = self._determine_mv_mode(rename_entries, after)
2642
original_modified = self._inventory_is_modified
2645
self._inventory_is_modified = True
2646
self._move(rename_entries)
2648
# restore the inventory on error
2649
self._inventory_is_modified = original_modified
2651
self._write_inventory(inv)
2652
return rename_tuples
2654
@needs_tree_write_lock
2655
def rename_one(self, from_rel, to_rel, after=False):
2658
This can change the directory or the filename or both.
2660
rename_one has several 'modes' to work. First, it can rename a physical
2661
file and change the file_id. That is the normal mode. Second, it can
2662
only change the file_id without touching any physical file.
2664
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2665
versioned but present in the working tree.
2667
rename_one uses the second mode if 'after == False' and 'from_rel' is
2668
versioned but no longer in the working tree, and 'to_rel' is not
2669
versioned but present in the working tree.
2671
rename_one uses the first mode if 'after == False' and 'from_rel' is
2672
versioned and present in the working tree, and 'to_rel' is not
2673
versioned and not present in the working tree.
2675
Everything else results in an error.
2677
inv = self.inventory
2680
# create rename entries and tuples
2681
from_tail = splitpath(from_rel)[-1]
2682
from_id = inv.path2id(from_rel)
2684
# if file is missing in the inventory maybe it's in the basis_tree
2685
basis_tree = self.branch.basis_tree()
2686
from_id = basis_tree.path2id(from_rel)
2688
raise errors.BzrRenameFailedError(from_rel,to_rel,
2689
errors.NotVersionedError(path=from_rel))
2690
# put entry back in the inventory so we can rename it
2691
from_entry = basis_tree.inventory[from_id].copy()
2694
from_entry = inv[from_id]
2695
from_parent_id = from_entry.parent_id
2696
to_dir, to_tail = os.path.split(to_rel)
2697
to_dir_id = inv.path2id(to_dir)
2698
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2700
from_tail=from_tail,
2701
from_parent_id=from_parent_id,
2702
to_rel=to_rel, to_tail=to_tail,
2703
to_parent_id=to_dir_id)
2704
rename_entries.append(rename_entry)
2706
# determine which move mode to use. checks also for movability
2707
rename_entries = self._determine_mv_mode(rename_entries, after)
2709
# check if the target changed directory and if the target directory is
2711
if to_dir_id is None:
2712
raise errors.BzrMoveFailedError(from_rel,to_rel,
2713
errors.NotVersionedError(path=to_dir))
2715
# all checks done. now we can continue with our actual work
2716
mutter('rename_one:\n'
2721
' to_dir_id {%s}\n',
2722
from_id, from_rel, to_rel, to_dir, to_dir_id)
2724
self._move(rename_entries)
2725
self._write_inventory(inv)
2727
class _RenameEntry(object):
2728
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2729
to_rel, to_tail, to_parent_id, only_change_inv=False,
2731
self.from_rel = from_rel
2732
self.from_id = from_id
2733
self.from_tail = from_tail
2734
self.from_parent_id = from_parent_id
2735
self.to_rel = to_rel
2736
self.to_tail = to_tail
2737
self.to_parent_id = to_parent_id
2738
self.change_id = change_id
2739
self.only_change_inv = only_change_inv
2741
def _determine_mv_mode(self, rename_entries, after=False):
2742
"""Determines for each from-to pair if both inventory and working tree
2743
or only the inventory has to be changed.
2745
Also does basic plausability tests.
2747
inv = self.inventory
2749
for rename_entry in rename_entries:
2750
# store to local variables for easier reference
2751
from_rel = rename_entry.from_rel
2752
from_id = rename_entry.from_id
2753
to_rel = rename_entry.to_rel
2754
to_id = inv.path2id(to_rel)
2755
only_change_inv = False
2758
# check the inventory for source and destination
2760
raise errors.BzrMoveFailedError(from_rel,to_rel,
2761
errors.NotVersionedError(path=from_rel))
2762
if to_id is not None:
2764
# allow it with --after but only if dest is newly added
2766
basis = self.basis_tree()
2769
if not basis.has_id(to_id):
2770
rename_entry.change_id = True
2775
raise errors.BzrMoveFailedError(from_rel,to_rel,
2776
errors.AlreadyVersionedError(path=to_rel))
2778
# try to determine the mode for rename (only change inv or change
2779
# inv and file system)
2781
if not self.has_filename(to_rel):
2782
raise errors.BzrMoveFailedError(from_id,to_rel,
2783
errors.NoSuchFile(path=to_rel,
2784
extra="New file has not been created yet"))
2785
only_change_inv = True
2786
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2787
only_change_inv = True
2788
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2789
only_change_inv = False
2790
elif (not self.case_sensitive
2791
and from_rel.lower() == to_rel.lower()
2792
and self.has_filename(from_rel)):
2793
only_change_inv = False
2795
# something is wrong, so lets determine what exactly
2796
if not self.has_filename(from_rel) and \
2797
not self.has_filename(to_rel):
2798
raise errors.BzrRenameFailedError(from_rel, to_rel,
2799
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2801
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2802
rename_entry.only_change_inv = only_change_inv
2803
return rename_entries
2805
def _move(self, rename_entries):
2806
"""Moves a list of files.
2808
Depending on the value of the flag 'only_change_inv', the
2809
file will be moved on the file system or not.
2811
inv = self.inventory
2814
for entry in rename_entries:
2816
self._move_entry(entry)
2818
self._rollback_move(moved)
2822
def _rollback_move(self, moved):
2823
"""Try to rollback a previous move in case of an filesystem error."""
2824
inv = self.inventory
2827
self._move_entry(WorkingTree._RenameEntry(
2828
entry.to_rel, entry.from_id,
2829
entry.to_tail, entry.to_parent_id, entry.from_rel,
2830
entry.from_tail, entry.from_parent_id,
2831
entry.only_change_inv))
2832
except errors.BzrMoveFailedError, e:
2833
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2834
" The working tree is in an inconsistent state."
2835
" Please consider doing a 'bzr revert'."
2836
" Error message is: %s" % e)
2838
def _move_entry(self, entry):
2839
inv = self.inventory
2840
from_rel_abs = self.abspath(entry.from_rel)
2841
to_rel_abs = self.abspath(entry.to_rel)
2842
if from_rel_abs == to_rel_abs:
2843
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2844
"Source and target are identical.")
2846
if not entry.only_change_inv:
2848
osutils.rename(from_rel_abs, to_rel_abs)
2850
raise errors.BzrMoveFailedError(entry.from_rel,
2853
to_id = inv.path2id(entry.to_rel)
2854
inv.remove_recursive_id(to_id)
2855
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2857
@needs_tree_write_lock
2858
def unversion(self, file_ids):
2859
"""Remove the file ids in file_ids from the current versioned set.
2861
When a file_id is unversioned, all of its children are automatically
2864
:param file_ids: The file ids to stop versioning.
2865
:raises: NoSuchId if any fileid is not currently versioned.
2867
for file_id in file_ids:
2868
if not self._inventory.has_id(file_id):
2869
raise errors.NoSuchId(self, file_id)
2870
for file_id in file_ids:
2871
if self._inventory.has_id(file_id):
2872
self._inventory.remove_recursive_id(file_id)
2874
# in the future this should just set a dirty bit to wait for the
2875
# final unlock. However, until all methods of workingtree start
2876
# with the current in -memory inventory rather than triggering
2877
# a read, it is more complex - we need to teach read_inventory
2878
# to know when to read, and when to not read first... and possibly
2879
# to save first when the in memory one may be corrupted.
2880
# so for now, we just only write it if it is indeed dirty.
2882
self._write_inventory(self._inventory)
2884
def stored_kind(self, file_id):
2885
"""See Tree.stored_kind"""
2886
return self.inventory[file_id].kind
2889
"""Yield all unversioned files in this WorkingTree.
2891
If there are any unversioned directories then only the directory is
2892
returned, not all its children. But if there are unversioned files
2893
under a versioned subdirectory, they are returned.
2895
Currently returned depth-first, sorted by name within directories.
2896
This is the same order used by 'osutils.walkdirs'.
2898
## TODO: Work from given directory downwards
2899
for path, dir_entry in self.inventory.directories():
2900
# mutter("search for unknowns in %r", path)
2901
dirabs = self.abspath(path)
2902
if not isdir(dirabs):
2903
# e.g. directory deleted
2907
for subf in os.listdir(dirabs):
2908
if self.bzrdir.is_control_filename(subf):
2910
if subf not in dir_entry.children:
2913
can_access) = osutils.normalized_filename(subf)
2914
except UnicodeDecodeError:
2915
path_os_enc = path.encode(osutils._fs_enc)
2916
relpath = path_os_enc + '/' + subf
2917
raise errors.BadFilenameEncoding(relpath,
2919
if subf_norm != subf and can_access:
2920
if subf_norm not in dir_entry.children:
2921
fl.append(subf_norm)
2927
subp = pathjoin(path, subf)
2930
def _walkdirs(self, prefix=""):
2931
"""Walk the directories of this tree.
2933
:param prefix: is used as the directrory to start with.
2934
:returns: a generator which yields items in the form::
2936
((curren_directory_path, fileid),
2937
[(file1_path, file1_name, file1_kind, None, file1_id,
2940
_directory = 'directory'
2941
# get the root in the inventory
2942
inv = self.inventory
2943
top_id = inv.path2id(prefix)
2947
pending = [(prefix, '', _directory, None, top_id, None)]
2950
currentdir = pending.pop()
2951
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2952
top_id = currentdir[4]
2954
relroot = currentdir[0] + '/'
2957
# FIXME: stash the node in pending
2959
if entry.kind == 'directory':
2960
for name, child in entry.sorted_children():
2961
dirblock.append((relroot + name, name, child.kind, None,
2962
child.file_id, child.kind
2964
yield (currentdir[0], entry.file_id), dirblock
2965
# push the user specified dirs from dirblock
2966
for dir in reversed(dirblock):
2967
if dir[2] == _directory:
2971
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2972
"""Registry for working tree formats."""
2974
def __init__(self, other_registry=None):
2975
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2976
self._default_format = None
2977
self._default_format_key = None
2979
def get_default(self):
2980
"""Return the current default format."""
2981
if (self._default_format_key is not None and
2982
self._default_format is None):
2983
self._default_format = self.get(self._default_format_key)
2984
return self._default_format
2986
def set_default(self, format):
2987
"""Set the default format."""
2988
self._default_format = format
2989
self._default_format_key = None
2991
def set_default_key(self, format_string):
2992
"""Set the default format by its format string."""
2993
self._default_format_key = format_string
2994
self._default_format = None
2997
format_registry = WorkingTreeFormatRegistry()
3000
class WorkingTreeFormat(controldir.ControlComponentFormat):
2832
3001
"""An encapsulation of the initialization and open routines for a format.
2834
3003
Formats provide three things:
3083
@symbol_versioning.deprecated_method(
3084
symbol_versioning.deprecated_in((2, 4, 0)))
2909
3085
def register_format(klass, format):
2910
klass._formats[format.get_format_string()] = format
3086
format_registry.register(format)
3089
@symbol_versioning.deprecated_method(
3090
symbol_versioning.deprecated_in((2, 4, 0)))
3091
def register_extra_format(klass, format):
3092
format_registry.register_extra(format)
3095
@symbol_versioning.deprecated_method(
3096
symbol_versioning.deprecated_in((2, 4, 0)))
3097
def unregister_extra_format(klass, format):
3098
format_registry.unregister_extra(format)
3101
@symbol_versioning.deprecated_method(
3102
symbol_versioning.deprecated_in((2, 4, 0)))
3103
def get_formats(klass):
3104
return format_registry._get_all()
3107
@symbol_versioning.deprecated_method(
3108
symbol_versioning.deprecated_in((2, 4, 0)))
2913
3109
def set_default_format(klass, format):
2914
klass._default_format = format
3110
format_registry.set_default(format)
3113
@symbol_versioning.deprecated_method(
3114
symbol_versioning.deprecated_in((2, 4, 0)))
2917
3115
def unregister_format(klass, format):
2918
del klass._formats[format.get_format_string()]
2921
class WorkingTreeFormat2(WorkingTreeFormat):
2922
"""The second working tree format.
2924
This format modified the hash cache from the format 1 hash cache.
2927
upgrade_recommended = True
2929
def get_format_description(self):
2930
"""See WorkingTreeFormat.get_format_description()."""
2931
return "Working tree format 2"
2933
def _stub_initialize_on_transport(self, transport, file_mode):
2934
"""Workaround: create control files for a remote working tree.
2936
This ensures that it can later be updated and dealt with locally,
2937
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2938
no working tree. (See bug #43064).
2941
inv = inventory.Inventory()
2942
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2944
transport.put_file('inventory', sio, file_mode)
2945
transport.put_bytes('pending-merges', '', file_mode)
2947
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2948
accelerator_tree=None, hardlink=False):
2949
"""See WorkingTreeFormat.initialize()."""
2950
if not isinstance(a_bzrdir.transport, LocalTransport):
2951
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2952
if from_branch is not None:
2953
branch = from_branch
2955
branch = a_bzrdir.open_branch()
2956
if revision_id is None:
2957
revision_id = _mod_revision.ensure_null(branch.last_revision())
2960
branch.generate_revision_history(revision_id)
2963
inv = inventory.Inventory()
2964
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2970
basis_tree = branch.repository.revision_tree(revision_id)
2971
if basis_tree.inventory.root is not None:
2972
wt.set_root_id(basis_tree.get_root_id())
2973
# set the parent list and cache the basis tree.
2974
if _mod_revision.is_null(revision_id):
2977
parent_trees = [(revision_id, basis_tree)]
2978
wt.set_parent_trees(parent_trees)
2979
transform.build_tree(basis_tree, wt)
2983
super(WorkingTreeFormat2, self).__init__()
2984
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2986
def open(self, a_bzrdir, _found=False):
2987
"""Return the WorkingTree object for a_bzrdir
2989
_found is a private parameter, do not use it. It is used to indicate
2990
if format probing has already been done.
2993
# we are being called directly and must probe.
2994
raise NotImplementedError
2995
if not isinstance(a_bzrdir.transport, LocalTransport):
2996
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2997
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
3003
class WorkingTreeFormat3(WorkingTreeFormat):
3004
"""The second working tree format updated to record a format marker.
3007
- exists within a metadir controlling .bzr
3008
- includes an explicit version marker for the workingtree control
3009
files, separate from the BzrDir format
3010
- modifies the hash cache format
3012
- uses a LockDir to guard access for writes.
3015
upgrade_recommended = True
3017
def get_format_string(self):
3018
"""See WorkingTreeFormat.get_format_string()."""
3019
return "Bazaar-NG Working Tree format 3"
3021
def get_format_description(self):
3022
"""See WorkingTreeFormat.get_format_description()."""
3023
return "Working tree format 3"
3025
_lock_file_name = 'lock'
3026
_lock_class = LockDir
3028
_tree_class = WorkingTree3
3030
def __get_matchingbzrdir(self):
3031
return bzrdir.BzrDirMetaFormat1()
3033
_matchingbzrdir = property(__get_matchingbzrdir)
3035
def _open_control_files(self, a_bzrdir):
3036
transport = a_bzrdir.get_workingtree_transport(None)
3037
return LockableFiles(transport, self._lock_file_name,
3040
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3041
accelerator_tree=None, hardlink=False):
3042
"""See WorkingTreeFormat.initialize().
3044
:param revision_id: if supplied, create a working tree at a different
3045
revision than the branch is at.
3046
:param accelerator_tree: A tree which can be used for retrieving file
3047
contents more quickly than the revision tree, i.e. a workingtree.
3048
The revision tree will be used for cases where accelerator_tree's
3049
content is different.
3050
:param hardlink: If true, hard-link files from accelerator_tree,
3053
if not isinstance(a_bzrdir.transport, LocalTransport):
3054
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3055
transport = a_bzrdir.get_workingtree_transport(self)
3056
control_files = self._open_control_files(a_bzrdir)
3057
control_files.create_lock()
3058
control_files.lock_write()
3059
transport.put_bytes('format', self.get_format_string(),
3060
mode=a_bzrdir._get_file_mode())
3061
if from_branch is not None:
3062
branch = from_branch
3064
branch = a_bzrdir.open_branch()
3065
if revision_id is None:
3066
revision_id = _mod_revision.ensure_null(branch.last_revision())
3067
# WorkingTree3 can handle an inventory which has a unique root id.
3068
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3069
# those trees. And because there isn't a format bump inbetween, we
3070
# are maintaining compatibility with older clients.
3071
# inv = Inventory(root_id=gen_root_id())
3072
inv = self._initial_inventory()
3073
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3079
_control_files=control_files)
3080
wt.lock_tree_write()
3082
basis_tree = branch.repository.revision_tree(revision_id)
3083
# only set an explicit root id if there is one to set.
3084
if basis_tree.inventory.root is not None:
3085
wt.set_root_id(basis_tree.get_root_id())
3086
if revision_id == _mod_revision.NULL_REVISION:
3087
wt.set_parent_trees([])
3089
wt.set_parent_trees([(revision_id, basis_tree)])
3090
transform.build_tree(basis_tree, wt)
3092
# Unlock in this order so that the unlock-triggers-flush in
3093
# WorkingTree is given a chance to fire.
3094
control_files.unlock()
3098
def _initial_inventory(self):
3099
return inventory.Inventory()
3102
super(WorkingTreeFormat3, self).__init__()
3104
def open(self, a_bzrdir, _found=False):
3105
"""Return the WorkingTree object for a_bzrdir
3107
_found is a private parameter, do not use it. It is used to indicate
3108
if format probing has already been done.
3111
# we are being called directly and must probe.
3112
raise NotImplementedError
3113
if not isinstance(a_bzrdir.transport, LocalTransport):
3114
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3115
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3118
def _open(self, a_bzrdir, control_files):
3119
"""Open the tree itself.
3121
:param a_bzrdir: the dir for the tree.
3122
:param control_files: the control files for the tree.
3124
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3128
_control_files=control_files)
3131
return self.get_format_string()
3134
__default_format = WorkingTreeFormat6()
3135
WorkingTreeFormat.register_format(__default_format)
3136
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3137
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3138
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3139
WorkingTreeFormat.set_default_format(__default_format)
3140
# formats which have no format string are not discoverable
3141
# and not independently creatable, so are not registered.
3142
_legacy_formats = [WorkingTreeFormat2(),
3116
format_registry.remove(format)
3118
def get_controldir_for_branch(self):
3119
"""Get the control directory format for creating branches.
3121
This is to support testing of working tree formats that can not exist
3122
in the same control directory as a branch.
3124
return self._matchingbzrdir
3127
class WorkingTreeFormatMetaDir(bzrdir.BzrDirMetaComponentFormat, WorkingTreeFormat):
3128
"""Base class for working trees that live in bzr meta directories."""
3131
WorkingTreeFormat.__init__(self)
3132
bzrdir.BzrDirMetaComponentFormat.__init__(self)
3135
def find_format_string(klass, controldir):
3136
"""Return format name for the working tree object in controldir."""
3138
transport = controldir.get_workingtree_transport(None)
3139
return transport.get_bytes("format")
3140
except errors.NoSuchFile:
3141
raise errors.NoWorkingTree(base=transport.base)
3144
def find_format(klass, controldir):
3145
"""Return the format for the working tree object in controldir."""
3146
format_string = klass.find_format_string(controldir)
3147
return klass._find_format(format_registry, 'working tree',
3151
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3152
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3153
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3154
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3155
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3156
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3157
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3158
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3159
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
