1733
2628
return ShelfManager(self, self._transport)
1736
class InventoryWorkingTree(WorkingTree,
1737
bzrlib.mutabletree.MutableInventoryTree):
1738
"""Base class for working trees that are inventory-oriented.
1740
The inventory is held in the `Branch` working-inventory, and the
1741
files are in a directory on disk.
1743
It is possible for a `WorkingTree` to have a filename which is
1744
not listed in the Inventory and vice versa.
2631
class WorkingTree2(WorkingTree):
2632
"""This is the Format 2 working tree.
2634
This was the first weave based working tree.
2635
- uses os locks for locking.
2636
- uses the branch last-revision.
1747
def __init__(self, basedir='.',
1748
branch=DEPRECATED_PARAMETER,
1750
_control_files=None,
1754
"""Construct a InventoryWorkingTree instance. This is not a public API.
1756
:param branch: A branch to override probing for the branch.
1758
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1759
branch=branch, _transport=_control_files._transport,
1760
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1762
self._control_files = _control_files
1763
self._detect_case_handling()
1765
if _inventory is None:
1766
# This will be acquired on lock_read() or lock_write()
1767
self._inventory_is_modified = False
1768
self._inventory = None
1770
# the caller of __init__ has provided an inventory,
1771
# we assume they know what they are doing - as its only
1772
# the Format factory and creation methods that are
1773
# permitted to do this.
1774
self._set_inventory(_inventory, dirty=False)
1776
def _set_inventory(self, inv, dirty):
1777
"""Set the internal cached inventory.
1779
:param inv: The inventory to set.
1780
:param dirty: A boolean indicating whether the inventory is the same
1781
logical inventory as whats on disk. If True the inventory is not
1782
the same and should be written to disk or data will be lost, if
1783
False then the inventory is the same as that on disk and any
1784
serialisation would be unneeded overhead.
1786
self._inventory = inv
1787
self._inventory_is_modified = dirty
1789
def _detect_case_handling(self):
1790
wt_trans = self.bzrdir.get_workingtree_transport(None)
1792
wt_trans.stat(self._format.case_sensitive_filename)
1793
except errors.NoSuchFile:
1794
self.case_sensitive = True
1796
self.case_sensitive = False
1798
self._setup_directory_is_tree_reference()
1800
def _serialize(self, inventory, out_file):
1801
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1804
def _deserialize(selt, in_file):
1805
return xml5.serializer_v5.read_inventory(in_file)
1807
def break_lock(self):
1808
"""Break a lock if one is present from another instance.
1810
Uses the ui factory to ask for confirmation if the lock may be from
1813
This will probe the repository for its lock as well.
1815
self._control_files.break_lock()
1816
self.branch.break_lock()
1818
def is_locked(self):
1819
return self._control_files.is_locked()
1821
def _must_be_locked(self):
1822
if not self.is_locked():
1823
raise errors.ObjectNotLocked(self)
1825
def lock_read(self):
1826
"""Lock the tree for reading.
1828
This also locks the branch, and can be unlocked via self.unlock().
1830
:return: A bzrlib.lock.LogicalLockResult.
1832
if not self.is_locked():
1834
self.branch.lock_read()
1836
self._control_files.lock_read()
1837
return LogicalLockResult(self.unlock)
1839
self.branch.unlock()
2639
def __init__(self, *args, **kwargs):
2640
super(WorkingTree2, self).__init__(*args, **kwargs)
2641
# WorkingTree2 has more of a constraint that self._inventory must
2642
# exist. Because this is an older format, we don't mind the overhead
2643
# caused by the extra computation here.
2645
# Newer WorkingTree's should only have self._inventory set when they
2647
if self._inventory is None:
2648
self.read_working_inventory()
2650
def _get_check_refs(self):
2651
"""Return the references needed to perform a check of this tree."""
2652
return [('trees', self.last_revision())]
1842
2654
def lock_tree_write(self):
1843
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1845
:return: A bzrlib.lock.LogicalLockResult.
1847
if not self.is_locked():
1849
self.branch.lock_read()
1851
self._control_files.lock_write()
1852
return LogicalLockResult(self.unlock)
1854
self.branch.unlock()
1857
def lock_write(self):
1858
"""See MutableTree.lock_write, and WorkingTree.unlock.
1860
:return: A bzrlib.lock.LogicalLockResult.
1862
if not self.is_locked():
2655
"""See WorkingTree.lock_tree_write().
2657
In Format2 WorkingTrees we have a single lock for the branch and tree
2658
so lock_tree_write() degrades to lock_write().
2660
:return: An object with an unlock method which will release the lock
1864
2663
self.branch.lock_write()
1866
2665
self._control_files.lock_write()
1867
return LogicalLockResult(self.unlock)
1869
2668
self.branch.unlock()
1872
def get_physical_lock_status(self):
1873
return self._control_files.get_physical_lock_status()
1875
@needs_tree_write_lock
1876
def _write_inventory(self, inv):
1877
"""Write inventory as the current inventory."""
1878
self._set_inventory(inv, dirty=True)
1881
# XXX: This method should be deprecated in favour of taking in a proper
1882
# new Inventory object.
1883
@needs_tree_write_lock
1884
def set_inventory(self, new_inventory_list):
1885
from bzrlib.inventory import (Inventory,
1889
inv = Inventory(self.get_root_id())
1890
for path, file_id, parent, kind in new_inventory_list:
1891
name = os.path.basename(path)
1894
# fixme, there should be a factory function inv,add_??
1895
if kind == 'directory':
1896
inv.add(InventoryDirectory(file_id, name, parent))
1897
elif kind == 'file':
1898
inv.add(InventoryFile(file_id, name, parent))
1899
elif kind == 'symlink':
1900
inv.add(InventoryLink(file_id, name, parent))
1902
raise errors.BzrError("unknown kind %r" % kind)
1903
self._write_inventory(inv)
1905
def _write_basis_inventory(self, xml):
1906
"""Write the basis inventory XML to the basis-inventory file"""
1907
path = self._basis_inventory_name()
1909
self._transport.put_file(path, sio,
1910
mode=self.bzrdir._get_file_mode())
1912
def _reset_data(self):
1913
"""Reset transient data that cannot be revalidated."""
1914
self._inventory_is_modified = False
1915
f = self._transport.get('inventory')
2672
# do non-implementation specific cleanup
2675
# we share control files:
2676
if self._control_files._lock_count == 3:
2677
# _inventory_is_modified is always False during a read lock.
2678
if self._inventory_is_modified:
2680
self._write_hashcache_if_dirty()
2682
# reverse order of locking.
1917
result = self._deserialize(f)
2684
return self._control_files.unlock()
1920
self._set_inventory(result, dirty=False)
1922
def _set_root_id(self, file_id):
1923
"""Set the root id for this tree, in a format specific manner.
1925
:param file_id: The file id to assign to the root. It must not be
1926
present in the current inventory or an error will occur. It must
1927
not be None, but rather a valid file id.
1929
inv = self._inventory
1930
orig_root_id = inv.root.file_id
1931
# TODO: it might be nice to exit early if there was nothing
1932
# to do, saving us from trigger a sync on unlock.
1933
self._inventory_is_modified = True
1934
# we preserve the root inventory entry object, but
1935
# unlinkit from the byid index
1936
del inv._byid[inv.root.file_id]
1937
inv.root.file_id = file_id
1938
# and link it into the index with the new changed id.
1939
inv._byid[inv.root.file_id] = inv.root
1940
# and finally update all children to reference the new id.
1941
# XXX: this should be safe to just look at the root.children
1942
# list, not the WHOLE INVENTORY.
1945
if entry.parent_id == orig_root_id:
1946
entry.parent_id = inv.root.file_id
1948
def all_file_ids(self):
1949
"""See Tree.iter_all_file_ids"""
1950
return set(self.inventory)
1952
@needs_tree_write_lock
1953
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1954
"""See MutableTree.set_parent_trees."""
1955
parent_ids = [rev for (rev, tree) in parents_list]
1956
for revision_id in parent_ids:
1957
_mod_revision.check_not_reserved_id(revision_id)
1959
self._check_parents_for_ghosts(parent_ids,
1960
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1962
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1964
if len(parent_ids) == 0:
1965
leftmost_parent_id = _mod_revision.NULL_REVISION
1966
leftmost_parent_tree = None
2686
self.branch.unlock()
2689
class WorkingTree3(WorkingTree):
2690
"""This is the Format 3 working tree.
2692
This differs from the base WorkingTree by:
2693
- having its own file lock
2694
- having its own last-revision property.
2696
This is new in bzr 0.8
2700
def _last_revision(self):
2701
"""See Mutable.last_revision."""
2703
return self._transport.get_bytes('last-revision')
2704
except errors.NoSuchFile:
2705
return _mod_revision.NULL_REVISION
2707
def _change_last_revision(self, revision_id):
2708
"""See WorkingTree._change_last_revision."""
2709
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2711
self._transport.delete('last-revision')
2712
except errors.NoSuchFile:
1968
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1970
if self._change_last_revision(leftmost_parent_id):
1971
if leftmost_parent_tree is None:
1972
# If we don't have a tree, fall back to reading the
1973
# parent tree from the repository.
1974
self._cache_basis_inventory(leftmost_parent_id)
1976
inv = leftmost_parent_tree.inventory
1977
xml = self._create_basis_xml_from_inventory(
1978
leftmost_parent_id, inv)
1979
self._write_basis_inventory(xml)
1980
self._set_merges_from_parent_ids(parent_ids)
1982
def _cache_basis_inventory(self, new_revision):
1983
"""Cache new_revision as the basis inventory."""
1984
# TODO: this should allow the ready-to-use inventory to be passed in,
1985
# as commit already has that ready-to-use [while the format is the
1988
# this double handles the inventory - unpack and repack -
1989
# but is easier to understand. We can/should put a conditional
1990
# in here based on whether the inventory is in the latest format
1991
# - perhaps we should repack all inventories on a repository
1993
# the fast path is to copy the raw xml from the repository. If the
1994
# xml contains 'revision_id="', then we assume the right
1995
# revision_id is set. We must check for this full string, because a
1996
# root node id can legitimately look like 'revision_id' but cannot
1998
xml = self.branch.repository._get_inventory_xml(new_revision)
1999
firstline = xml.split('\n', 1)[0]
2000
if (not 'revision_id="' in firstline or
2001
'format="7"' not in firstline):
2002
inv = self.branch.repository._serializer.read_inventory_from_string(
2004
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2005
self._write_basis_inventory(xml)
2006
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2009
def _basis_inventory_name(self):
2010
return 'basis-inventory-cache'
2012
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2013
"""Create the text that will be saved in basis-inventory"""
2014
inventory.revision_id = revision_id
2015
return xml7.serializer_v7.write_inventory_to_string(inventory)
2716
self._transport.put_bytes('last-revision', revision_id,
2717
mode=self.bzrdir._get_file_mode())
2720
def _get_check_refs(self):
2721
"""Return the references needed to perform a check of this tree."""
2722
return [('trees', self.last_revision())]
2017
2724
@needs_tree_write_lock
2018
2725
def set_conflicts(self, conflicts):
2038
2745
raise errors.ConflictFormatError()
2039
2746
except StopIteration:
2040
2747
raise errors.ConflictFormatError()
2041
reader = _mod_rio.RioReader(confile)
2042
return _mod_conflicts.ConflictList.from_stanzas(reader)
2748
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2044
2750
confile.close()
2046
def read_basis_inventory(self):
2047
"""Read the cached basis inventory."""
2048
path = self._basis_inventory_name()
2049
return self._transport.get_bytes(path)
2052
def read_working_inventory(self):
2053
"""Read the working inventory.
2055
:raises errors.InventoryModified: read_working_inventory will fail
2056
when the current in memory inventory has been modified.
2058
# conceptually this should be an implementation detail of the tree.
2059
# XXX: Deprecate this.
2060
# ElementTree does its own conversion from UTF-8, so open in
2062
if self._inventory_is_modified:
2063
raise errors.InventoryModified(self)
2064
f = self._transport.get('inventory')
2066
result = self._deserialize(f)
2069
self._set_inventory(result, dirty=False)
2073
def get_root_id(self):
2074
"""Return the id of this trees root"""
2075
return self._inventory.root.file_id
2077
def has_id(self, file_id):
2078
# files that have been deleted are excluded
2079
inv = self.inventory
2080
if not inv.has_id(file_id):
2082
path = inv.id2path(file_id)
2083
return osutils.lexists(self.abspath(path))
2085
def has_or_had_id(self, file_id):
2086
if file_id == self.inventory.root.file_id:
2088
return self.inventory.has_id(file_id)
2090
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2092
"""Iterate through file_ids for this tree.
2094
file_ids are in a WorkingTree if they are in the working inventory
2095
and the working file exists.
2097
inv = self._inventory
2098
for path, ie in inv.iter_entries():
2099
if osutils.lexists(self.abspath(path)):
2102
@needs_tree_write_lock
2103
def set_last_revision(self, new_revision):
2104
"""Change the last revision in the working tree."""
2105
if self._change_last_revision(new_revision):
2106
self._cache_basis_inventory(new_revision)
2108
def _get_check_refs(self):
2109
"""Return the references needed to perform a check of this tree.
2111
The default implementation returns no refs, and is only suitable for
2112
trees that have no local caching and can commit on ghosts at any time.
2114
:seealso: bzrlib.check for details about check_refs.
2119
def _check(self, references):
2120
"""Check the tree for consistency.
2122
:param references: A dict with keys matching the items returned by
2123
self._get_check_refs(), and values from looking those keys up in
2126
tree_basis = self.basis_tree()
2127
tree_basis.lock_read()
2129
repo_basis = references[('trees', self.last_revision())]
2130
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2131
raise errors.BzrCheckError(
2132
"Mismatched basis inventory content.")
2138
def check_state(self):
2139
"""Check that the working state is/isn't valid."""
2140
check_refs = self._get_check_refs()
2142
for ref in check_refs:
2145
refs[ref] = self.branch.repository.revision_tree(value)
2148
@needs_tree_write_lock
2149
def reset_state(self, revision_ids=None):
2150
"""Reset the state of the working tree.
2152
This does a hard-reset to a last-known-good state. This is a way to
2153
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2155
if revision_ids is None:
2156
revision_ids = self.get_parent_ids()
2157
if not revision_ids:
2158
rt = self.branch.repository.revision_tree(
2159
_mod_revision.NULL_REVISION)
2161
rt = self.branch.repository.revision_tree(revision_ids[0])
2162
self._write_inventory(rt.inventory)
2163
self.set_parent_ids(revision_ids)
2166
"""Write the in memory inventory to disk."""
2167
# TODO: Maybe this should only write on dirty ?
2168
if self._control_files._lock_mode != 'w':
2169
raise errors.NotWriteLocked(self)
2171
self._serialize(self._inventory, sio)
2173
self._transport.put_file('inventory', sio,
2174
mode=self.bzrdir._get_file_mode())
2175
self._inventory_is_modified = False
2177
def get_file_mtime(self, file_id, path=None):
2178
"""See Tree.get_file_mtime."""
2180
path = self.inventory.id2path(file_id)
2182
return os.lstat(self.abspath(path)).st_mtime
2184
if e.errno == errno.ENOENT:
2185
raise errors.FileTimestampUnavailable(path)
2188
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2189
file_id = self.path2id(path)
2191
# For unversioned files on win32, we just assume they are not
2194
return self._inventory[file_id].executable
2196
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2197
mode = stat_result.st_mode
2198
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2200
def is_executable(self, file_id, path=None):
2201
if not self._supports_executable():
2202
return self._inventory[file_id].executable
2205
path = self.id2path(file_id)
2206
mode = os.lstat(self.abspath(path)).st_mode
2207
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2209
def _is_executable_from_path_and_stat(self, path, stat_result):
2210
if not self._supports_executable():
2211
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2213
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2215
@needs_tree_write_lock
2216
def _add(self, files, ids, kinds):
2217
"""See MutableTree._add."""
2218
# TODO: Re-adding a file that is removed in the working copy
2219
# should probably put it back with the previous ID.
2220
# the read and write working inventory should not occur in this
2221
# function - they should be part of lock_write and unlock.
2222
inv = self.inventory
2223
for f, file_id, kind in zip(files, ids, kinds):
2225
inv.add_path(f, kind=kind)
2227
inv.add_path(f, kind=kind, file_id=file_id)
2228
self._inventory_is_modified = True
2230
def revision_tree(self, revision_id):
2231
"""See WorkingTree.revision_id."""
2232
if revision_id == self.last_revision():
2234
xml = self.read_basis_inventory()
2235
except errors.NoSuchFile:
2239
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2240
# dont use the repository revision_tree api because we want
2241
# to supply the inventory.
2242
if inv.revision_id == revision_id:
2243
return revisiontree.InventoryRevisionTree(
2244
self.branch.repository, inv, revision_id)
2245
except errors.BadInventoryFormat:
2247
# raise if there was no inventory, or if we read the wrong inventory.
2248
raise errors.NoSuchRevisionInTree(self, revision_id)
2251
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2252
"""See Tree.annotate_iter
2254
This implementation will use the basis tree implementation if possible.
2255
Lines not in the basis are attributed to CURRENT_REVISION
2257
If there are pending merges, lines added by those merges will be
2258
incorrectly attributed to CURRENT_REVISION (but after committing, the
2259
attribution will be correct).
2261
maybe_file_parent_keys = []
2262
for parent_id in self.get_parent_ids():
2264
parent_tree = self.revision_tree(parent_id)
2265
except errors.NoSuchRevisionInTree:
2266
parent_tree = self.branch.repository.revision_tree(parent_id)
2267
parent_tree.lock_read()
2269
if not parent_tree.has_id(file_id):
2271
ie = parent_tree.inventory[file_id]
2272
if ie.kind != 'file':
2273
# Note: this is slightly unnecessary, because symlinks and
2274
# directories have a "text" which is the empty text, and we
2275
# know that won't mess up annotations. But it seems cleaner
2277
parent_text_key = (file_id, ie.revision)
2278
if parent_text_key not in maybe_file_parent_keys:
2279
maybe_file_parent_keys.append(parent_text_key)
2281
parent_tree.unlock()
2282
graph = _mod_graph.Graph(self.branch.repository.texts)
2283
heads = graph.heads(maybe_file_parent_keys)
2284
file_parent_keys = []
2285
for key in maybe_file_parent_keys:
2287
file_parent_keys.append(key)
2289
# Now we have the parents of this content
2290
annotator = self.branch.repository.texts.get_annotator()
2291
text = self.get_file_text(file_id)
2292
this_key =(file_id, default_revision)
2293
annotator.add_special_text(this_key, file_parent_keys, text)
2294
annotations = [(key[-1], line)
2295
for key, line in annotator.annotate_flat(this_key)]
2298
def _put_rio(self, filename, stanzas, header):
2299
self._must_be_locked()
2300
my_file = _mod_rio.rio_file(stanzas, header)
2301
self._transport.put_file(filename, my_file,
2302
mode=self.bzrdir._get_file_mode())
2304
@needs_tree_write_lock
2305
def set_merge_modified(self, modified_hashes):
2307
for file_id, hash in modified_hashes.iteritems():
2308
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2310
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2313
def merge_modified(self):
2314
"""Return a dictionary of files modified by a merge.
2316
The list is initialized by WorkingTree.set_merge_modified, which is
2317
typically called after we make some automatic updates to the tree
2320
This returns a map of file_id->sha1, containing only files which are
2321
still in the working inventory and have that text hash.
2324
hashfile = self._transport.get('merge-hashes')
2325
except errors.NoSuchFile:
2330
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2331
raise errors.MergeModifiedFormatError()
2332
except StopIteration:
2333
raise errors.MergeModifiedFormatError()
2334
for s in _mod_rio.RioReader(hashfile):
2335
# RioReader reads in Unicode, so convert file_ids back to utf8
2336
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2337
if not self.inventory.has_id(file_id):
2339
text_hash = s.get("hash")
2340
if text_hash == self.get_file_sha1(file_id):
2341
merge_hashes[file_id] = text_hash
2347
def subsume(self, other_tree):
2348
def add_children(inventory, entry):
2349
for child_entry in entry.children.values():
2350
inventory._byid[child_entry.file_id] = child_entry
2351
if child_entry.kind == 'directory':
2352
add_children(inventory, child_entry)
2353
if other_tree.get_root_id() == self.get_root_id():
2354
raise errors.BadSubsumeSource(self, other_tree,
2355
'Trees have the same root')
2357
other_tree_path = self.relpath(other_tree.basedir)
2358
except errors.PathNotChild:
2359
raise errors.BadSubsumeSource(self, other_tree,
2360
'Tree is not contained by the other')
2361
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2362
if new_root_parent is None:
2363
raise errors.BadSubsumeSource(self, other_tree,
2364
'Parent directory is not versioned.')
2365
# We need to ensure that the result of a fetch will have a
2366
# versionedfile for the other_tree root, and only fetching into
2367
# RepositoryKnit2 guarantees that.
2368
if not self.branch.repository.supports_rich_root():
2369
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2370
other_tree.lock_tree_write()
2372
new_parents = other_tree.get_parent_ids()
2373
other_root = other_tree.inventory.root
2374
other_root.parent_id = new_root_parent
2375
other_root.name = osutils.basename(other_tree_path)
2376
self.inventory.add(other_root)
2377
add_children(self.inventory, other_root)
2378
self._write_inventory(self.inventory)
2379
# normally we don't want to fetch whole repositories, but i think
2380
# here we really do want to consolidate the whole thing.
2381
for parent_id in other_tree.get_parent_ids():
2382
self.branch.fetch(other_tree.branch, parent_id)
2383
self.add_parent_tree_id(parent_id)
2386
other_tree.bzrdir.retire_bzrdir()
2388
@needs_tree_write_lock
2389
def extract(self, file_id, format=None):
2390
"""Extract a subtree from this tree.
2392
A new branch will be created, relative to the path for this tree.
2396
segments = osutils.splitpath(path)
2397
transport = self.branch.bzrdir.root_transport
2398
for name in segments:
2399
transport = transport.clone(name)
2400
transport.ensure_base()
2403
sub_path = self.id2path(file_id)
2404
branch_transport = mkdirs(sub_path)
2406
format = self.bzrdir.cloning_metadir()
2407
branch_transport.ensure_base()
2408
branch_bzrdir = format.initialize_on_transport(branch_transport)
2410
repo = branch_bzrdir.find_repository()
2411
except errors.NoRepositoryPresent:
2412
repo = branch_bzrdir.create_repository()
2413
if not repo.supports_rich_root():
2414
raise errors.RootNotRich()
2415
new_branch = branch_bzrdir.create_branch()
2416
new_branch.pull(self.branch)
2417
for parent_id in self.get_parent_ids():
2418
new_branch.fetch(self.branch, parent_id)
2419
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2420
if tree_transport.base != branch_transport.base:
2421
tree_bzrdir = format.initialize_on_transport(tree_transport)
2422
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2423
target_branch=new_branch)
2425
tree_bzrdir = branch_bzrdir
2426
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2427
wt.set_parent_ids(self.get_parent_ids())
2428
my_inv = self.inventory
2429
child_inv = inventory.Inventory(root_id=None)
2430
new_root = my_inv[file_id]
2431
my_inv.remove_recursive_id(file_id)
2432
new_root.parent_id = None
2433
child_inv.add(new_root)
2434
self._write_inventory(my_inv)
2435
wt._write_inventory(child_inv)
2438
def list_files(self, include_root=False, from_dir=None, recursive=True):
2439
"""List all files as (path, class, kind, id, entry).
2441
Lists, but does not descend into unversioned directories.
2442
This does not include files that have been deleted in this
2443
tree. Skips the control directory.
2445
:param include_root: if True, return an entry for the root
2446
:param from_dir: start from this directory or None for the root
2447
:param recursive: whether to recurse into subdirectories or not
2449
# list_files is an iterator, so @needs_read_lock doesn't work properly
2450
# with it. So callers should be careful to always read_lock the tree.
2451
if not self.is_locked():
2452
raise errors.ObjectNotLocked(self)
2454
inv = self.inventory
2455
if from_dir is None and include_root is True:
2456
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2457
# Convert these into local objects to save lookup times
2458
pathjoin = osutils.pathjoin
2459
file_kind = self._kind
2461
# transport.base ends in a slash, we want the piece
2462
# between the last two slashes
2463
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2465
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2467
# directory file_id, relative path, absolute path, reverse sorted children
2468
if from_dir is not None:
2469
from_dir_id = inv.path2id(from_dir)
2470
if from_dir_id is None:
2471
# Directory not versioned
2473
from_dir_abspath = pathjoin(self.basedir, from_dir)
2475
from_dir_id = inv.root.file_id
2476
from_dir_abspath = self.basedir
2477
children = os.listdir(from_dir_abspath)
2479
# jam 20060527 The kernel sized tree seems equivalent whether we
2480
# use a deque and popleft to keep them sorted, or if we use a plain
2481
# list and just reverse() them.
2482
children = collections.deque(children)
2483
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2485
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2488
f = children.popleft()
2489
## TODO: If we find a subdirectory with its own .bzr
2490
## directory, then that is a separate tree and we
2491
## should exclude it.
2493
# the bzrdir for this tree
2494
if transport_base_dir == f:
2497
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2498
# and 'f' doesn't begin with one, we can do a string op, rather
2499
# than the checks of pathjoin(), all relative paths will have an extra slash
2501
fp = from_dir_relpath + '/' + f
2504
fap = from_dir_abspath + '/' + f
2506
dir_ie = inv[from_dir_id]
2507
if dir_ie.kind == 'directory':
2508
f_ie = dir_ie.children.get(f)
2513
elif self.is_ignored(fp[1:]):
2516
# we may not have found this file, because of a unicode
2517
# issue, or because the directory was actually a symlink.
2518
f_norm, can_access = osutils.normalized_filename(f)
2519
if f == f_norm or not can_access:
2520
# No change, so treat this file normally
2523
# this file can be accessed by a normalized path
2524
# check again if it is versioned
2525
# these lines are repeated here for performance
2527
fp = from_dir_relpath + '/' + f
2528
fap = from_dir_abspath + '/' + f
2529
f_ie = inv.get_child(from_dir_id, f)
2532
elif self.is_ignored(fp[1:]):
2539
# make a last minute entry
2541
yield fp[1:], c, fk, f_ie.file_id, f_ie
2544
yield fp[1:], c, fk, None, fk_entries[fk]()
2546
yield fp[1:], c, fk, None, TreeEntry()
2549
if fk != 'directory':
2552
# But do this child first if recursing down
2554
new_children = os.listdir(fap)
2556
new_children = collections.deque(new_children)
2557
stack.append((f_ie.file_id, fp, fap, new_children))
2558
# Break out of inner loop,
2559
# so that we start outer loop with child
2562
# if we finished all children, pop it off the stack
2565
@needs_tree_write_lock
2566
def move(self, from_paths, to_dir=None, after=False):
2569
to_dir must exist in the inventory.
2571
If to_dir exists and is a directory, the files are moved into
2572
it, keeping their old names.
2574
Note that to_dir is only the last component of the new name;
2575
this doesn't change the directory.
2577
For each entry in from_paths the move mode will be determined
2580
The first mode moves the file in the filesystem and updates the
2581
inventory. The second mode only updates the inventory without
2582
touching the file on the filesystem.
2584
move uses the second mode if 'after == True' and the target is
2585
either not versioned or newly added, and present in the working tree.
2587
move uses the second mode if 'after == False' and the source is
2588
versioned but no longer in the working tree, and the target is not
2589
versioned but present in the working tree.
2591
move uses the first mode if 'after == False' and the source is
2592
versioned and present in the working tree, and the target is not
2593
versioned and not present in the working tree.
2595
Everything else results in an error.
2597
This returns a list of (from_path, to_path) pairs for each
2598
entry that is moved.
2603
# check for deprecated use of signature
2605
raise TypeError('You must supply a target directory')
2606
# check destination directory
2607
if isinstance(from_paths, basestring):
2609
inv = self.inventory
2610
to_abs = self.abspath(to_dir)
2611
if not isdir(to_abs):
2612
raise errors.BzrMoveFailedError('',to_dir,
2613
errors.NotADirectory(to_abs))
2614
if not self.has_filename(to_dir):
2615
raise errors.BzrMoveFailedError('',to_dir,
2616
errors.NotInWorkingDirectory(to_dir))
2617
to_dir_id = inv.path2id(to_dir)
2618
if to_dir_id is None:
2619
raise errors.BzrMoveFailedError('',to_dir,
2620
errors.NotVersionedError(path=to_dir))
2622
to_dir_ie = inv[to_dir_id]
2623
if to_dir_ie.kind != 'directory':
2624
raise errors.BzrMoveFailedError('',to_dir,
2625
errors.NotADirectory(to_abs))
2627
# create rename entries and tuples
2628
for from_rel in from_paths:
2629
from_tail = splitpath(from_rel)[-1]
2630
from_id = inv.path2id(from_rel)
2632
raise errors.BzrMoveFailedError(from_rel,to_dir,
2633
errors.NotVersionedError(path=from_rel))
2635
from_entry = inv[from_id]
2636
from_parent_id = from_entry.parent_id
2637
to_rel = pathjoin(to_dir, from_tail)
2638
rename_entry = InventoryWorkingTree._RenameEntry(
2641
from_tail=from_tail,
2642
from_parent_id=from_parent_id,
2643
to_rel=to_rel, to_tail=from_tail,
2644
to_parent_id=to_dir_id)
2645
rename_entries.append(rename_entry)
2646
rename_tuples.append((from_rel, to_rel))
2648
# determine which move mode to use. checks also for movability
2649
rename_entries = self._determine_mv_mode(rename_entries, after)
2651
original_modified = self._inventory_is_modified
2654
self._inventory_is_modified = True
2655
self._move(rename_entries)
2657
# restore the inventory on error
2658
self._inventory_is_modified = original_modified
2660
self._write_inventory(inv)
2661
return rename_tuples
2663
@needs_tree_write_lock
2664
def rename_one(self, from_rel, to_rel, after=False):
2667
This can change the directory or the filename or both.
2669
rename_one has several 'modes' to work. First, it can rename a physical
2670
file and change the file_id. That is the normal mode. Second, it can
2671
only change the file_id without touching any physical file.
2673
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2674
versioned but present in the working tree.
2676
rename_one uses the second mode if 'after == False' and 'from_rel' is
2677
versioned but no longer in the working tree, and 'to_rel' is not
2678
versioned but present in the working tree.
2680
rename_one uses the first mode if 'after == False' and 'from_rel' is
2681
versioned and present in the working tree, and 'to_rel' is not
2682
versioned and not present in the working tree.
2684
Everything else results in an error.
2686
inv = self.inventory
2689
# create rename entries and tuples
2690
from_tail = splitpath(from_rel)[-1]
2691
from_id = inv.path2id(from_rel)
2693
# if file is missing in the inventory maybe it's in the basis_tree
2694
basis_tree = self.branch.basis_tree()
2695
from_id = basis_tree.path2id(from_rel)
2697
raise errors.BzrRenameFailedError(from_rel,to_rel,
2698
errors.NotVersionedError(path=from_rel))
2699
# put entry back in the inventory so we can rename it
2700
from_entry = basis_tree.inventory[from_id].copy()
2703
from_entry = inv[from_id]
2704
from_parent_id = from_entry.parent_id
2705
to_dir, to_tail = os.path.split(to_rel)
2706
to_dir_id = inv.path2id(to_dir)
2707
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2709
from_tail=from_tail,
2710
from_parent_id=from_parent_id,
2711
to_rel=to_rel, to_tail=to_tail,
2712
to_parent_id=to_dir_id)
2713
rename_entries.append(rename_entry)
2715
# determine which move mode to use. checks also for movability
2716
rename_entries = self._determine_mv_mode(rename_entries, after)
2718
# check if the target changed directory and if the target directory is
2720
if to_dir_id is None:
2721
raise errors.BzrMoveFailedError(from_rel,to_rel,
2722
errors.NotVersionedError(path=to_dir))
2724
# all checks done. now we can continue with our actual work
2725
mutter('rename_one:\n'
2730
' to_dir_id {%s}\n',
2731
from_id, from_rel, to_rel, to_dir, to_dir_id)
2733
self._move(rename_entries)
2734
self._write_inventory(inv)
2736
class _RenameEntry(object):
2737
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2738
to_rel, to_tail, to_parent_id, only_change_inv=False,
2740
self.from_rel = from_rel
2741
self.from_id = from_id
2742
self.from_tail = from_tail
2743
self.from_parent_id = from_parent_id
2744
self.to_rel = to_rel
2745
self.to_tail = to_tail
2746
self.to_parent_id = to_parent_id
2747
self.change_id = change_id
2748
self.only_change_inv = only_change_inv
2750
def _determine_mv_mode(self, rename_entries, after=False):
2751
"""Determines for each from-to pair if both inventory and working tree
2752
or only the inventory has to be changed.
2754
Also does basic plausability tests.
2756
inv = self.inventory
2758
for rename_entry in rename_entries:
2759
# store to local variables for easier reference
2760
from_rel = rename_entry.from_rel
2761
from_id = rename_entry.from_id
2762
to_rel = rename_entry.to_rel
2763
to_id = inv.path2id(to_rel)
2764
only_change_inv = False
2767
# check the inventory for source and destination
2769
raise errors.BzrMoveFailedError(from_rel,to_rel,
2770
errors.NotVersionedError(path=from_rel))
2771
if to_id is not None:
2773
# allow it with --after but only if dest is newly added
2775
basis = self.basis_tree()
2778
if not basis.has_id(to_id):
2779
rename_entry.change_id = True
2784
raise errors.BzrMoveFailedError(from_rel,to_rel,
2785
errors.AlreadyVersionedError(path=to_rel))
2787
# try to determine the mode for rename (only change inv or change
2788
# inv and file system)
2790
if not self.has_filename(to_rel):
2791
raise errors.BzrMoveFailedError(from_id,to_rel,
2792
errors.NoSuchFile(path=to_rel,
2793
extra="New file has not been created yet"))
2794
only_change_inv = True
2795
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2796
only_change_inv = True
2797
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2798
only_change_inv = False
2799
elif (not self.case_sensitive
2800
and from_rel.lower() == to_rel.lower()
2801
and self.has_filename(from_rel)):
2802
only_change_inv = False
2804
# something is wrong, so lets determine what exactly
2805
if not self.has_filename(from_rel) and \
2806
not self.has_filename(to_rel):
2807
raise errors.BzrRenameFailedError(from_rel, to_rel,
2808
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2810
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2811
rename_entry.only_change_inv = only_change_inv
2812
return rename_entries
2814
def _move(self, rename_entries):
2815
"""Moves a list of files.
2817
Depending on the value of the flag 'only_change_inv', the
2818
file will be moved on the file system or not.
2820
inv = self.inventory
2823
for entry in rename_entries:
2825
self._move_entry(entry)
2827
self._rollback_move(moved)
2831
def _rollback_move(self, moved):
2832
"""Try to rollback a previous move in case of an filesystem error."""
2833
inv = self.inventory
2836
self._move_entry(WorkingTree._RenameEntry(
2837
entry.to_rel, entry.from_id,
2838
entry.to_tail, entry.to_parent_id, entry.from_rel,
2839
entry.from_tail, entry.from_parent_id,
2840
entry.only_change_inv))
2841
except errors.BzrMoveFailedError, e:
2842
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2843
" The working tree is in an inconsistent state."
2844
" Please consider doing a 'bzr revert'."
2845
" Error message is: %s" % e)
2847
def _move_entry(self, entry):
2848
inv = self.inventory
2849
from_rel_abs = self.abspath(entry.from_rel)
2850
to_rel_abs = self.abspath(entry.to_rel)
2851
if from_rel_abs == to_rel_abs:
2852
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2853
"Source and target are identical.")
2855
if not entry.only_change_inv:
2857
osutils.rename(from_rel_abs, to_rel_abs)
2859
raise errors.BzrMoveFailedError(entry.from_rel,
2862
to_id = inv.path2id(entry.to_rel)
2863
inv.remove_recursive_id(to_id)
2864
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2866
@needs_tree_write_lock
2867
def unversion(self, file_ids):
2868
"""Remove the file ids in file_ids from the current versioned set.
2870
When a file_id is unversioned, all of its children are automatically
2873
:param file_ids: The file ids to stop versioning.
2874
:raises: NoSuchId if any fileid is not currently versioned.
2876
for file_id in file_ids:
2877
if not self._inventory.has_id(file_id):
2878
raise errors.NoSuchId(self, file_id)
2879
for file_id in file_ids:
2880
if self._inventory.has_id(file_id):
2881
self._inventory.remove_recursive_id(file_id)
2883
# in the future this should just set a dirty bit to wait for the
2884
# final unlock. However, until all methods of workingtree start
2885
# with the current in -memory inventory rather than triggering
2886
# a read, it is more complex - we need to teach read_inventory
2887
# to know when to read, and when to not read first... and possibly
2888
# to save first when the in memory one may be corrupted.
2889
# so for now, we just only write it if it is indeed dirty.
2891
self._write_inventory(self._inventory)
2893
def stored_kind(self, file_id):
2894
"""See Tree.stored_kind"""
2895
return self.inventory[file_id].kind
2898
"""Yield all unversioned files in this WorkingTree.
2900
If there are any unversioned directories then only the directory is
2901
returned, not all its children. But if there are unversioned files
2902
under a versioned subdirectory, they are returned.
2904
Currently returned depth-first, sorted by name within directories.
2905
This is the same order used by 'osutils.walkdirs'.
2907
## TODO: Work from given directory downwards
2908
for path, dir_entry in self.inventory.directories():
2909
# mutter("search for unknowns in %r", path)
2910
dirabs = self.abspath(path)
2911
if not isdir(dirabs):
2912
# e.g. directory deleted
2916
for subf in os.listdir(dirabs):
2917
if self.bzrdir.is_control_filename(subf):
2919
if subf not in dir_entry.children:
2922
can_access) = osutils.normalized_filename(subf)
2923
except UnicodeDecodeError:
2924
path_os_enc = path.encode(osutils._fs_enc)
2925
relpath = path_os_enc + '/' + subf
2926
raise errors.BadFilenameEncoding(relpath,
2928
if subf_norm != subf and can_access:
2929
if subf_norm not in dir_entry.children:
2930
fl.append(subf_norm)
2936
subp = pathjoin(path, subf)
2939
def _walkdirs(self, prefix=""):
2940
"""Walk the directories of this tree.
2942
:param prefix: is used as the directrory to start with.
2943
:returns: a generator which yields items in the form::
2945
((curren_directory_path, fileid),
2946
[(file1_path, file1_name, file1_kind, None, file1_id,
2949
_directory = 'directory'
2950
# get the root in the inventory
2951
inv = self.inventory
2952
top_id = inv.path2id(prefix)
2956
pending = [(prefix, '', _directory, None, top_id, None)]
2959
currentdir = pending.pop()
2960
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2961
top_id = currentdir[4]
2963
relroot = currentdir[0] + '/'
2966
# FIXME: stash the node in pending
2968
if entry.kind == 'directory':
2969
for name, child in entry.sorted_children():
2970
dirblock.append((relroot + name, name, child.kind, None,
2971
child.file_id, child.kind
2973
yield (currentdir[0], entry.file_id), dirblock
2974
# push the user specified dirs from dirblock
2975
for dir in reversed(dirblock):
2976
if dir[2] == _directory:
2980
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2981
"""Registry for working tree formats."""
2983
def __init__(self, other_registry=None):
2984
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2985
self._default_format = None
2986
self._default_format_key = None
2988
def get_default(self):
2989
"""Return the current default format."""
2990
if (self._default_format_key is not None and
2991
self._default_format is None):
2992
self._default_format = self.get(self._default_format_key)
2993
return self._default_format
2995
def set_default(self, format):
2996
"""Set the default format."""
2997
self._default_format = format
2998
self._default_format_key = None
3000
def set_default_key(self, format_string):
3001
"""Set the default format by its format string."""
3002
self._default_format_key = format_string
3003
self._default_format = None
3006
format_registry = WorkingTreeFormatRegistry()
3009
class WorkingTreeFormat(controldir.ControlComponentFormat):
2753
# do non-implementation specific cleanup
2755
if self._control_files._lock_count == 1:
2756
# _inventory_is_modified is always False during a read lock.
2757
if self._inventory_is_modified:
2759
self._write_hashcache_if_dirty()
2760
# reverse order of locking.
2762
return self._control_files.unlock()
2764
self.branch.unlock()
2767
def get_conflicted_stem(path):
2768
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2769
if path.endswith(suffix):
2770
return path[:-len(suffix)]
2773
class WorkingTreeFormat(object):
3010
2774
"""An encapsulation of the initialization and open routines for a format.
3012
2776
Formats provide three things:
3092
@symbol_versioning.deprecated_method(
3093
symbol_versioning.deprecated_in((2, 4, 0)))
3094
2851
def register_format(klass, format):
3095
format_registry.register(format)
3098
@symbol_versioning.deprecated_method(
3099
symbol_versioning.deprecated_in((2, 4, 0)))
3100
def register_extra_format(klass, format):
3101
format_registry.register_extra(format)
3104
@symbol_versioning.deprecated_method(
3105
symbol_versioning.deprecated_in((2, 4, 0)))
3106
def unregister_extra_format(klass, format):
3107
format_registry.unregister_extra(format)
3110
@symbol_versioning.deprecated_method(
3111
symbol_versioning.deprecated_in((2, 4, 0)))
3112
def get_formats(klass):
3113
return format_registry._get_all()
3116
@symbol_versioning.deprecated_method(
3117
symbol_versioning.deprecated_in((2, 4, 0)))
2852
klass._formats[format.get_format_string()] = format
3118
2855
def set_default_format(klass, format):
3119
format_registry.set_default(format)
2856
klass._default_format = format
3122
@symbol_versioning.deprecated_method(
3123
symbol_versioning.deprecated_in((2, 4, 0)))
3124
2859
def unregister_format(klass, format):
3125
format_registry.remove(format)
3127
def get_controldir_for_branch(self):
3128
"""Get the control directory format for creating branches.
3130
This is to support testing of working tree formats that can not exist
3131
in the same control directory as a branch.
3133
return self._matchingbzrdir
3136
class WorkingTreeFormatMetaDir(bzrdir.BzrDirMetaComponentFormat, WorkingTreeFormat):
3137
"""Base class for working trees that live in bzr meta directories."""
3140
WorkingTreeFormat.__init__(self)
3141
bzrdir.BzrDirMetaComponentFormat.__init__(self)
3144
def find_format_string(klass, controldir):
3145
"""Return format name for the working tree object in controldir."""
3147
transport = controldir.get_workingtree_transport(None)
3148
return transport.get_bytes("format")
3149
except errors.NoSuchFile:
3150
raise errors.NoWorkingTree(base=transport.base)
3153
def find_format(klass, controldir):
3154
"""Return the format for the working tree object in controldir."""
3155
format_string = klass.find_format_string(controldir)
3156
return klass._find_format(format_registry, 'working tree',
3160
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3161
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3162
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3163
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3164
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3165
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3166
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3167
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3168
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
2860
del klass._formats[format.get_format_string()]
2863
class WorkingTreeFormat2(WorkingTreeFormat):
2864
"""The second working tree format.
2866
This format modified the hash cache from the format 1 hash cache.
2869
upgrade_recommended = True
2871
def get_format_description(self):
2872
"""See WorkingTreeFormat.get_format_description()."""
2873
return "Working tree format 2"
2875
def _stub_initialize_on_transport(self, transport, file_mode):
2876
"""Workaround: create control files for a remote working tree.
2878
This ensures that it can later be updated and dealt with locally,
2879
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2880
no working tree. (See bug #43064).
2883
inv = inventory.Inventory()
2884
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2886
transport.put_file('inventory', sio, file_mode)
2887
transport.put_bytes('pending-merges', '', file_mode)
2889
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2890
accelerator_tree=None, hardlink=False):
2891
"""See WorkingTreeFormat.initialize()."""
2892
if not isinstance(a_bzrdir.transport, LocalTransport):
2893
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2894
if from_branch is not None:
2895
branch = from_branch
2897
branch = a_bzrdir.open_branch()
2898
if revision_id is None:
2899
revision_id = _mod_revision.ensure_null(branch.last_revision())
2902
branch.generate_revision_history(revision_id)
2905
inv = inventory.Inventory()
2906
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2912
basis_tree = branch.repository.revision_tree(revision_id)
2913
if basis_tree.inventory.root is not None:
2914
wt.set_root_id(basis_tree.get_root_id())
2915
# set the parent list and cache the basis tree.
2916
if _mod_revision.is_null(revision_id):
2919
parent_trees = [(revision_id, basis_tree)]
2920
wt.set_parent_trees(parent_trees)
2921
transform.build_tree(basis_tree, wt)
2925
super(WorkingTreeFormat2, self).__init__()
2926
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2928
def open(self, a_bzrdir, _found=False):
2929
"""Return the WorkingTree object for a_bzrdir
2931
_found is a private parameter, do not use it. It is used to indicate
2932
if format probing has already been done.
2935
# we are being called directly and must probe.
2936
raise NotImplementedError
2937
if not isinstance(a_bzrdir.transport, LocalTransport):
2938
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2939
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2945
class WorkingTreeFormat3(WorkingTreeFormat):
2946
"""The second working tree format updated to record a format marker.
2949
- exists within a metadir controlling .bzr
2950
- includes an explicit version marker for the workingtree control
2951
files, separate from the BzrDir format
2952
- modifies the hash cache format
2954
- uses a LockDir to guard access for writes.
2957
upgrade_recommended = True
2959
def get_format_string(self):
2960
"""See WorkingTreeFormat.get_format_string()."""
2961
return "Bazaar-NG Working Tree format 3"
2963
def get_format_description(self):
2964
"""See WorkingTreeFormat.get_format_description()."""
2965
return "Working tree format 3"
2967
_lock_file_name = 'lock'
2968
_lock_class = LockDir
2970
_tree_class = WorkingTree3
2972
def __get_matchingbzrdir(self):
2973
return bzrdir.BzrDirMetaFormat1()
2975
_matchingbzrdir = property(__get_matchingbzrdir)
2977
def _open_control_files(self, a_bzrdir):
2978
transport = a_bzrdir.get_workingtree_transport(None)
2979
return LockableFiles(transport, self._lock_file_name,
2982
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2983
accelerator_tree=None, hardlink=False):
2984
"""See WorkingTreeFormat.initialize().
2986
:param revision_id: if supplied, create a working tree at a different
2987
revision than the branch is at.
2988
:param accelerator_tree: A tree which can be used for retrieving file
2989
contents more quickly than the revision tree, i.e. a workingtree.
2990
The revision tree will be used for cases where accelerator_tree's
2991
content is different.
2992
:param hardlink: If true, hard-link files from accelerator_tree,
2995
if not isinstance(a_bzrdir.transport, LocalTransport):
2996
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2997
transport = a_bzrdir.get_workingtree_transport(self)
2998
control_files = self._open_control_files(a_bzrdir)
2999
control_files.create_lock()
3000
control_files.lock_write()
3001
transport.put_bytes('format', self.get_format_string(),
3002
mode=a_bzrdir._get_file_mode())
3003
if from_branch is not None:
3004
branch = from_branch
3006
branch = a_bzrdir.open_branch()
3007
if revision_id is None:
3008
revision_id = _mod_revision.ensure_null(branch.last_revision())
3009
# WorkingTree3 can handle an inventory which has a unique root id.
3010
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3011
# those trees. And because there isn't a format bump inbetween, we
3012
# are maintaining compatibility with older clients.
3013
# inv = Inventory(root_id=gen_root_id())
3014
inv = self._initial_inventory()
3015
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3021
_control_files=control_files)
3022
wt.lock_tree_write()
3024
basis_tree = branch.repository.revision_tree(revision_id)
3025
# only set an explicit root id if there is one to set.
3026
if basis_tree.inventory.root is not None:
3027
wt.set_root_id(basis_tree.get_root_id())
3028
if revision_id == _mod_revision.NULL_REVISION:
3029
wt.set_parent_trees([])
3031
wt.set_parent_trees([(revision_id, basis_tree)])
3032
transform.build_tree(basis_tree, wt)
3034
# Unlock in this order so that the unlock-triggers-flush in
3035
# WorkingTree is given a chance to fire.
3036
control_files.unlock()
3040
def _initial_inventory(self):
3041
return inventory.Inventory()
3044
super(WorkingTreeFormat3, self).__init__()
3046
def open(self, a_bzrdir, _found=False):
3047
"""Return the WorkingTree object for a_bzrdir
3049
_found is a private parameter, do not use it. It is used to indicate
3050
if format probing has already been done.
3053
# we are being called directly and must probe.
3054
raise NotImplementedError
3055
if not isinstance(a_bzrdir.transport, LocalTransport):
3056
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3057
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3060
def _open(self, a_bzrdir, control_files):
3061
"""Open the tree itself.
3063
:param a_bzrdir: the dir for the tree.
3064
:param control_files: the control files for the tree.
3066
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3070
_control_files=control_files)
3073
return self.get_format_string()
3076
__default_format = WorkingTreeFormat6()
3077
WorkingTreeFormat.register_format(__default_format)
3078
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3079
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3080
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3081
WorkingTreeFormat.set_default_format(__default_format)
3082
# formats which have no format string are not discoverable
3083
# and not independently creatable, so are not registered.
3084
_legacy_formats = [WorkingTreeFormat2(),