2621
1768
def get_shelf_manager(self):
2622
1769
"""Return the ShelfManager for this WorkingTree."""
2623
from bzrlib.shelf import ShelfManager
1770
from .shelf import ShelfManager
2624
1771
return ShelfManager(self, self._transport)
2627
class WorkingTree2(WorkingTree):
2628
"""This is the Format 2 working tree.
2630
This was the first weave based working tree.
2631
- uses os locks for locking.
2632
- uses the branch last-revision.
1774
class InventoryWorkingTree(WorkingTree,
1775
mutabletree.MutableInventoryTree):
1776
"""Base class for working trees that are inventory-oriented.
1778
The inventory is held in the `Branch` working-inventory, and the
1779
files are in a directory on disk.
1781
It is possible for a `WorkingTree` to have a filename which is
1782
not listed in the Inventory and vice versa.
2635
def __init__(self, *args, **kwargs):
2636
super(WorkingTree2, self).__init__(*args, **kwargs)
2637
# WorkingTree2 has more of a constraint that self._inventory must
2638
# exist. Because this is an older format, we don't mind the overhead
2639
# caused by the extra computation here.
2641
# Newer WorkingTree's should only have self._inventory set when they
2643
if self._inventory is None:
2644
self.read_working_inventory()
2646
def _get_check_refs(self):
2647
"""Return the references needed to perform a check of this tree."""
2648
return [('trees', self.last_revision())]
1785
def __init__(self, basedir='.',
1788
_control_files=None,
1792
"""Construct a InventoryWorkingTree instance. This is not a public API.
1794
:param branch: A branch to override probing for the branch.
1796
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1797
branch=branch, _transport=_control_files._transport,
1798
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1800
self._control_files = _control_files
1801
self._detect_case_handling()
1803
if _inventory is None:
1804
# This will be acquired on lock_read() or lock_write()
1805
self._inventory_is_modified = False
1806
self._inventory = None
1808
# the caller of __init__ has provided an inventory,
1809
# we assume they know what they are doing - as its only
1810
# the Format factory and creation methods that are
1811
# permitted to do this.
1812
self._set_inventory(_inventory, dirty=False)
1814
def _set_inventory(self, inv, dirty):
1815
"""Set the internal cached inventory.
1817
:param inv: The inventory to set.
1818
:param dirty: A boolean indicating whether the inventory is the same
1819
logical inventory as whats on disk. If True the inventory is not
1820
the same and should be written to disk or data will be lost, if
1821
False then the inventory is the same as that on disk and any
1822
serialisation would be unneeded overhead.
1824
self._inventory = inv
1825
self._inventory_is_modified = dirty
1827
def _detect_case_handling(self):
1828
wt_trans = self.bzrdir.get_workingtree_transport(None)
1830
wt_trans.stat(self._format.case_sensitive_filename)
1831
except errors.NoSuchFile:
1832
self.case_sensitive = True
1834
self.case_sensitive = False
1836
self._setup_directory_is_tree_reference()
1838
def _serialize(self, inventory, out_file):
1839
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1842
def _deserialize(selt, in_file):
1843
return xml5.serializer_v5.read_inventory(in_file)
1845
def break_lock(self):
1846
"""Break a lock if one is present from another instance.
1848
Uses the ui factory to ask for confirmation if the lock may be from
1851
This will probe the repository for its lock as well.
1853
self._control_files.break_lock()
1854
self.branch.break_lock()
1856
def is_locked(self):
1857
return self._control_files.is_locked()
1859
def _must_be_locked(self):
1860
if not self.is_locked():
1861
raise errors.ObjectNotLocked(self)
1863
def lock_read(self):
1864
"""Lock the tree for reading.
1866
This also locks the branch, and can be unlocked via self.unlock().
1868
:return: A breezy.lock.LogicalLockResult.
1870
if not self.is_locked():
1872
self.branch.lock_read()
1874
self._control_files.lock_read()
1875
return LogicalLockResult(self.unlock)
1877
self.branch.unlock()
2650
1880
def lock_tree_write(self):
2651
"""See WorkingTree.lock_tree_write().
2653
In Format2 WorkingTrees we have a single lock for the branch and tree
2654
so lock_tree_write() degrades to lock_write().
2656
:return: An object with an unlock method which will release the lock
1881
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1883
:return: A breezy.lock.LogicalLockResult.
1885
if not self.is_locked():
1887
self.branch.lock_read()
1889
self._control_files.lock_write()
1890
return LogicalLockResult(self.unlock)
1892
self.branch.unlock()
1895
def lock_write(self):
1896
"""See MutableTree.lock_write, and WorkingTree.unlock.
1898
:return: A breezy.lock.LogicalLockResult.
1900
if not self.is_locked():
2659
1902
self.branch.lock_write()
2661
1904
self._control_files.lock_write()
1905
return LogicalLockResult(self.unlock)
2664
1907
self.branch.unlock()
2668
# do non-implementation specific cleanup
2671
# we share control files:
2672
if self._control_files._lock_count == 3:
2673
# _inventory_is_modified is always False during a read lock.
2674
if self._inventory_is_modified:
2676
self._write_hashcache_if_dirty()
2678
# reverse order of locking.
1910
def get_physical_lock_status(self):
1911
return self._control_files.get_physical_lock_status()
1913
@needs_tree_write_lock
1914
def _write_inventory(self, inv):
1915
"""Write inventory as the current inventory."""
1916
self._set_inventory(inv, dirty=True)
1919
# XXX: This method should be deprecated in favour of taking in a proper
1920
# new Inventory object.
1921
@needs_tree_write_lock
1922
def set_inventory(self, new_inventory_list):
1923
from .inventory import (
1928
inv = Inventory(self.get_root_id())
1929
for path, file_id, parent, kind in new_inventory_list:
1930
name = os.path.basename(path)
1933
# fixme, there should be a factory function inv,add_??
1934
if kind == 'directory':
1935
inv.add(InventoryDirectory(file_id, name, parent))
1936
elif kind == 'file':
1937
inv.add(InventoryFile(file_id, name, parent))
1938
elif kind == 'symlink':
1939
inv.add(InventoryLink(file_id, name, parent))
1941
raise errors.BzrError("unknown kind %r" % kind)
1942
self._write_inventory(inv)
1944
def _write_basis_inventory(self, xml):
1945
"""Write the basis inventory XML to the basis-inventory file"""
1946
path = self._basis_inventory_name()
1948
self._transport.put_file(path, sio,
1949
mode=self.bzrdir._get_file_mode())
1951
def _reset_data(self):
1952
"""Reset transient data that cannot be revalidated."""
1953
self._inventory_is_modified = False
1954
f = self._transport.get('inventory')
2680
return self._control_files.unlock()
1956
result = self._deserialize(f)
2682
self.branch.unlock()
2685
class WorkingTree3(WorkingTree):
2686
"""This is the Format 3 working tree.
2688
This differs from the base WorkingTree by:
2689
- having its own file lock
2690
- having its own last-revision property.
2692
This is new in bzr 0.8
2696
def _last_revision(self):
2697
"""See Mutable.last_revision."""
1959
self._set_inventory(result, dirty=False)
1961
def _set_root_id(self, file_id):
1962
"""Set the root id for this tree, in a format specific manner.
1964
:param file_id: The file id to assign to the root. It must not be
1965
present in the current inventory or an error will occur. It must
1966
not be None, but rather a valid file id.
1968
inv = self._inventory
1969
orig_root_id = inv.root.file_id
1970
# TODO: it might be nice to exit early if there was nothing
1971
# to do, saving us from trigger a sync on unlock.
1972
self._inventory_is_modified = True
1973
# we preserve the root inventory entry object, but
1974
# unlinkit from the byid index
1975
del inv._byid[inv.root.file_id]
1976
inv.root.file_id = file_id
1977
# and link it into the index with the new changed id.
1978
inv._byid[inv.root.file_id] = inv.root
1979
# and finally update all children to reference the new id.
1980
# XXX: this should be safe to just look at the root.children
1981
# list, not the WHOLE INVENTORY.
1984
if entry.parent_id == orig_root_id:
1985
entry.parent_id = inv.root.file_id
1987
@needs_tree_write_lock
1988
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1989
"""See MutableTree.set_parent_trees."""
1990
parent_ids = [rev for (rev, tree) in parents_list]
1991
for revision_id in parent_ids:
1992
_mod_revision.check_not_reserved_id(revision_id)
1994
self._check_parents_for_ghosts(parent_ids,
1995
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1997
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1999
if len(parent_ids) == 0:
2000
leftmost_parent_id = _mod_revision.NULL_REVISION
2001
leftmost_parent_tree = None
2003
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
2005
if self._change_last_revision(leftmost_parent_id):
2006
if leftmost_parent_tree is None:
2007
# If we don't have a tree, fall back to reading the
2008
# parent tree from the repository.
2009
self._cache_basis_inventory(leftmost_parent_id)
2011
inv = leftmost_parent_tree.root_inventory
2012
xml = self._create_basis_xml_from_inventory(
2013
leftmost_parent_id, inv)
2014
self._write_basis_inventory(xml)
2015
self._set_merges_from_parent_ids(parent_ids)
2017
def _cache_basis_inventory(self, new_revision):
2018
"""Cache new_revision as the basis inventory."""
2019
# TODO: this should allow the ready-to-use inventory to be passed in,
2020
# as commit already has that ready-to-use [while the format is the
2699
return self._transport.get_bytes('last-revision')
2700
except errors.NoSuchFile:
2701
return _mod_revision.NULL_REVISION
2703
def _change_last_revision(self, revision_id):
2704
"""See WorkingTree._change_last_revision."""
2705
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2707
self._transport.delete('last-revision')
2708
except errors.NoSuchFile:
2712
self._transport.put_bytes('last-revision', revision_id,
2713
mode=self.bzrdir._get_file_mode())
2716
def _get_check_refs(self):
2717
"""Return the references needed to perform a check of this tree."""
2718
return [('trees', self.last_revision())]
2023
# this double handles the inventory - unpack and repack -
2024
# but is easier to understand. We can/should put a conditional
2025
# in here based on whether the inventory is in the latest format
2026
# - perhaps we should repack all inventories on a repository
2028
# the fast path is to copy the raw xml from the repository. If the
2029
# xml contains 'revision_id="', then we assume the right
2030
# revision_id is set. We must check for this full string, because a
2031
# root node id can legitimately look like 'revision_id' but cannot
2033
xml = self.branch.repository._get_inventory_xml(new_revision)
2034
firstline = xml.split('\n', 1)[0]
2035
if (not 'revision_id="' in firstline or
2036
'format="7"' not in firstline):
2037
inv = self.branch.repository._serializer.read_inventory_from_string(
2039
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2040
self._write_basis_inventory(xml)
2041
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2044
def _basis_inventory_name(self):
2045
return 'basis-inventory-cache'
2047
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2048
"""Create the text that will be saved in basis-inventory"""
2049
inventory.revision_id = revision_id
2050
return xml7.serializer_v7.write_inventory_to_string(inventory)
2720
2052
@needs_tree_write_lock
2721
2053
def set_conflicts(self, conflicts):
2737
2069
return _mod_conflicts.ConflictList()
2740
if confile.next() != CONFLICT_HEADER_1 + '\n':
2072
if next(confile) != CONFLICT_HEADER_1 + '\n':
2741
2073
raise errors.ConflictFormatError()
2742
2074
except StopIteration:
2743
2075
raise errors.ConflictFormatError()
2744
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2076
reader = _mod_rio.RioReader(confile)
2077
return _mod_conflicts.ConflictList.from_stanzas(reader)
2746
2079
confile.close()
2749
# do non-implementation specific cleanup
2751
if self._control_files._lock_count == 1:
2752
# _inventory_is_modified is always False during a read lock.
2753
if self._inventory_is_modified:
2755
self._write_hashcache_if_dirty()
2756
# reverse order of locking.
2758
return self._control_files.unlock()
2760
self.branch.unlock()
2763
def get_conflicted_stem(path):
2764
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2765
if path.endswith(suffix):
2766
return path[:-len(suffix)]
2769
class WorkingTreeFormat(object):
2081
def read_basis_inventory(self):
2082
"""Read the cached basis inventory."""
2083
path = self._basis_inventory_name()
2084
return self._transport.get_bytes(path)
2087
def read_working_inventory(self):
2088
"""Read the working inventory.
2090
:raises errors.InventoryModified: read_working_inventory will fail
2091
when the current in memory inventory has been modified.
2093
# conceptually this should be an implementation detail of the tree.
2094
# XXX: Deprecate this.
2095
# ElementTree does its own conversion from UTF-8, so open in
2097
if self._inventory_is_modified:
2098
raise errors.InventoryModified(self)
2099
f = self._transport.get('inventory')
2101
result = self._deserialize(f)
2104
self._set_inventory(result, dirty=False)
2108
def get_root_id(self):
2109
"""Return the id of this trees root"""
2110
return self._inventory.root.file_id
2112
def has_id(self, file_id):
2113
# files that have been deleted are excluded
2114
inv, inv_file_id = self._unpack_file_id(file_id)
2115
if not inv.has_id(inv_file_id):
2117
path = inv.id2path(inv_file_id)
2118
return osutils.lexists(self.abspath(path))
2120
def has_or_had_id(self, file_id):
2121
if file_id == self.get_root_id():
2123
inv, inv_file_id = self._unpack_file_id(file_id)
2124
return inv.has_id(inv_file_id)
2126
def all_file_ids(self):
2127
"""Iterate through file_ids for this tree.
2129
file_ids are in a WorkingTree if they are in the working inventory
2130
and the working file exists.
2133
for path, ie in self.iter_entries_by_dir():
2137
@needs_tree_write_lock
2138
def set_last_revision(self, new_revision):
2139
"""Change the last revision in the working tree."""
2140
if self._change_last_revision(new_revision):
2141
self._cache_basis_inventory(new_revision)
2143
def _get_check_refs(self):
2144
"""Return the references needed to perform a check of this tree.
2146
The default implementation returns no refs, and is only suitable for
2147
trees that have no local caching and can commit on ghosts at any time.
2149
:seealso: breezy.check for details about check_refs.
2154
def _check(self, references):
2155
"""Check the tree for consistency.
2157
:param references: A dict with keys matching the items returned by
2158
self._get_check_refs(), and values from looking those keys up in
2161
tree_basis = self.basis_tree()
2162
tree_basis.lock_read()
2164
repo_basis = references[('trees', self.last_revision())]
2165
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2166
raise errors.BzrCheckError(
2167
"Mismatched basis inventory content.")
2173
def check_state(self):
2174
"""Check that the working state is/isn't valid."""
2175
check_refs = self._get_check_refs()
2177
for ref in check_refs:
2180
refs[ref] = self.branch.repository.revision_tree(value)
2183
@needs_tree_write_lock
2184
def reset_state(self, revision_ids=None):
2185
"""Reset the state of the working tree.
2187
This does a hard-reset to a last-known-good state. This is a way to
2188
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2190
if revision_ids is None:
2191
revision_ids = self.get_parent_ids()
2192
if not revision_ids:
2193
rt = self.branch.repository.revision_tree(
2194
_mod_revision.NULL_REVISION)
2196
rt = self.branch.repository.revision_tree(revision_ids[0])
2197
self._write_inventory(rt.root_inventory)
2198
self.set_parent_ids(revision_ids)
2201
"""Write the in memory inventory to disk."""
2202
# TODO: Maybe this should only write on dirty ?
2203
if self._control_files._lock_mode != 'w':
2204
raise errors.NotWriteLocked(self)
2206
self._serialize(self._inventory, sio)
2208
self._transport.put_file('inventory', sio,
2209
mode=self.bzrdir._get_file_mode())
2210
self._inventory_is_modified = False
2212
def get_file_mtime(self, file_id, path=None):
2213
"""See Tree.get_file_mtime."""
2215
path = self.id2path(file_id)
2217
return os.lstat(self.abspath(path)).st_mtime
2218
except OSError as e:
2219
if e.errno == errno.ENOENT:
2220
raise errors.FileTimestampUnavailable(path)
2223
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2224
inv, file_id = self._path2inv_file_id(path)
2226
# For unversioned files on win32, we just assume they are not
2229
return inv[file_id].executable
2231
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2232
mode = stat_result.st_mode
2233
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2235
def is_executable(self, file_id, path=None):
2236
if not self._supports_executable():
2237
inv, inv_file_id = self._unpack_file_id(file_id)
2238
return inv[inv_file_id].executable
2241
path = self.id2path(file_id)
2242
mode = os.lstat(self.abspath(path)).st_mode
2243
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2245
def _is_executable_from_path_and_stat(self, path, stat_result):
2246
if not self._supports_executable():
2247
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2249
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2251
@needs_tree_write_lock
2252
def _add(self, files, ids, kinds):
2253
"""See MutableTree._add."""
2254
# TODO: Re-adding a file that is removed in the working copy
2255
# should probably put it back with the previous ID.
2256
# the read and write working inventory should not occur in this
2257
# function - they should be part of lock_write and unlock.
2258
# FIXME: nested trees
2259
inv = self.root_inventory
2260
for f, file_id, kind in zip(files, ids, kinds):
2262
inv.add_path(f, kind=kind)
2264
inv.add_path(f, kind=kind, file_id=file_id)
2265
self._inventory_is_modified = True
2267
def revision_tree(self, revision_id):
2268
"""See WorkingTree.revision_id."""
2269
if revision_id == self.last_revision():
2271
xml = self.read_basis_inventory()
2272
except errors.NoSuchFile:
2276
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2277
# dont use the repository revision_tree api because we want
2278
# to supply the inventory.
2279
if inv.revision_id == revision_id:
2280
return revisiontree.InventoryRevisionTree(
2281
self.branch.repository, inv, revision_id)
2282
except errors.BadInventoryFormat:
2284
# raise if there was no inventory, or if we read the wrong inventory.
2285
raise errors.NoSuchRevisionInTree(self, revision_id)
2288
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2289
"""See Tree.annotate_iter
2291
This implementation will use the basis tree implementation if possible.
2292
Lines not in the basis are attributed to CURRENT_REVISION
2294
If there are pending merges, lines added by those merges will be
2295
incorrectly attributed to CURRENT_REVISION (but after committing, the
2296
attribution will be correct).
2298
maybe_file_parent_keys = []
2299
for parent_id in self.get_parent_ids():
2301
parent_tree = self.revision_tree(parent_id)
2302
except errors.NoSuchRevisionInTree:
2303
parent_tree = self.branch.repository.revision_tree(parent_id)
2304
parent_tree.lock_read()
2307
kind = parent_tree.kind(file_id)
2308
except errors.NoSuchId:
2311
# Note: this is slightly unnecessary, because symlinks and
2312
# directories have a "text" which is the empty text, and we
2313
# know that won't mess up annotations. But it seems cleaner
2316
file_id, parent_tree.get_file_revision(file_id))
2317
if parent_text_key not in maybe_file_parent_keys:
2318
maybe_file_parent_keys.append(parent_text_key)
2320
parent_tree.unlock()
2321
graph = _mod_graph.Graph(self.branch.repository.texts)
2322
heads = graph.heads(maybe_file_parent_keys)
2323
file_parent_keys = []
2324
for key in maybe_file_parent_keys:
2326
file_parent_keys.append(key)
2328
# Now we have the parents of this content
2329
annotator = self.branch.repository.texts.get_annotator()
2330
text = self.get_file_text(file_id)
2331
this_key =(file_id, default_revision)
2332
annotator.add_special_text(this_key, file_parent_keys, text)
2333
annotations = [(key[-1], line)
2334
for key, line in annotator.annotate_flat(this_key)]
2337
def _put_rio(self, filename, stanzas, header):
2338
self._must_be_locked()
2339
my_file = _mod_rio.rio_file(stanzas, header)
2340
self._transport.put_file(filename, my_file,
2341
mode=self.bzrdir._get_file_mode())
2343
@needs_tree_write_lock
2344
def set_merge_modified(self, modified_hashes):
2346
for file_id in modified_hashes:
2347
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2348
hash=modified_hashes[file_id])
2349
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2352
def merge_modified(self):
2353
"""Return a dictionary of files modified by a merge.
2355
The list is initialized by WorkingTree.set_merge_modified, which is
2356
typically called after we make some automatic updates to the tree
2359
This returns a map of file_id->sha1, containing only files which are
2360
still in the working inventory and have that text hash.
2363
hashfile = self._transport.get('merge-hashes')
2364
except errors.NoSuchFile:
2369
if next(hashfile) != MERGE_MODIFIED_HEADER_1 + '\n':
2370
raise errors.MergeModifiedFormatError()
2371
except StopIteration:
2372
raise errors.MergeModifiedFormatError()
2373
for s in _mod_rio.RioReader(hashfile):
2374
# RioReader reads in Unicode, so convert file_ids back to utf8
2375
file_id = cache_utf8.encode(s.get("file_id"))
2376
if not self.has_id(file_id):
2378
text_hash = s.get("hash")
2379
if text_hash == self.get_file_sha1(file_id):
2380
merge_hashes[file_id] = text_hash
2386
def subsume(self, other_tree):
2387
def add_children(inventory, entry):
2388
for child_entry in entry.children.values():
2389
inventory._byid[child_entry.file_id] = child_entry
2390
if child_entry.kind == 'directory':
2391
add_children(inventory, child_entry)
2392
if other_tree.get_root_id() == self.get_root_id():
2393
raise errors.BadSubsumeSource(self, other_tree,
2394
'Trees have the same root')
2396
other_tree_path = self.relpath(other_tree.basedir)
2397
except errors.PathNotChild:
2398
raise errors.BadSubsumeSource(self, other_tree,
2399
'Tree is not contained by the other')
2400
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2401
if new_root_parent is None:
2402
raise errors.BadSubsumeSource(self, other_tree,
2403
'Parent directory is not versioned.')
2404
# We need to ensure that the result of a fetch will have a
2405
# versionedfile for the other_tree root, and only fetching into
2406
# RepositoryKnit2 guarantees that.
2407
if not self.branch.repository.supports_rich_root():
2408
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2409
other_tree.lock_tree_write()
2411
new_parents = other_tree.get_parent_ids()
2412
other_root = other_tree.root_inventory.root
2413
other_root.parent_id = new_root_parent
2414
other_root.name = osutils.basename(other_tree_path)
2415
self.root_inventory.add(other_root)
2416
add_children(self.root_inventory, other_root)
2417
self._write_inventory(self.root_inventory)
2418
# normally we don't want to fetch whole repositories, but i think
2419
# here we really do want to consolidate the whole thing.
2420
for parent_id in other_tree.get_parent_ids():
2421
self.branch.fetch(other_tree.branch, parent_id)
2422
self.add_parent_tree_id(parent_id)
2425
other_tree.bzrdir.retire_bzrdir()
2427
@needs_tree_write_lock
2428
def extract(self, file_id, format=None):
2429
"""Extract a subtree from this tree.
2431
A new branch will be created, relative to the path for this tree.
2435
segments = osutils.splitpath(path)
2436
transport = self.branch.bzrdir.root_transport
2437
for name in segments:
2438
transport = transport.clone(name)
2439
transport.ensure_base()
2442
sub_path = self.id2path(file_id)
2443
branch_transport = mkdirs(sub_path)
2445
format = self.bzrdir.cloning_metadir()
2446
branch_transport.ensure_base()
2447
branch_bzrdir = format.initialize_on_transport(branch_transport)
2449
repo = branch_bzrdir.find_repository()
2450
except errors.NoRepositoryPresent:
2451
repo = branch_bzrdir.create_repository()
2452
if not repo.supports_rich_root():
2453
raise errors.RootNotRich()
2454
new_branch = branch_bzrdir.create_branch()
2455
new_branch.pull(self.branch)
2456
for parent_id in self.get_parent_ids():
2457
new_branch.fetch(self.branch, parent_id)
2458
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2459
if tree_transport.base != branch_transport.base:
2460
tree_bzrdir = format.initialize_on_transport(tree_transport)
2461
tree_bzrdir.set_branch_reference(new_branch)
2463
tree_bzrdir = branch_bzrdir
2464
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2465
wt.set_parent_ids(self.get_parent_ids())
2466
# FIXME: Support nested trees
2467
my_inv = self.root_inventory
2468
child_inv = inventory.Inventory(root_id=None)
2469
new_root = my_inv[file_id]
2470
my_inv.remove_recursive_id(file_id)
2471
new_root.parent_id = None
2472
child_inv.add(new_root)
2473
self._write_inventory(my_inv)
2474
wt._write_inventory(child_inv)
2477
def list_files(self, include_root=False, from_dir=None, recursive=True):
2478
"""List all files as (path, class, kind, id, entry).
2480
Lists, but does not descend into unversioned directories.
2481
This does not include files that have been deleted in this
2482
tree. Skips the control directory.
2484
:param include_root: if True, return an entry for the root
2485
:param from_dir: start from this directory or None for the root
2486
:param recursive: whether to recurse into subdirectories or not
2488
# list_files is an iterator, so @needs_read_lock doesn't work properly
2489
# with it. So callers should be careful to always read_lock the tree.
2490
if not self.is_locked():
2491
raise errors.ObjectNotLocked(self)
2493
if from_dir is None and include_root is True:
2494
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2495
# Convert these into local objects to save lookup times
2496
pathjoin = osutils.pathjoin
2497
file_kind = self._kind
2499
# transport.base ends in a slash, we want the piece
2500
# between the last two slashes
2501
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2503
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2505
# directory file_id, relative path, absolute path, reverse sorted children
2506
if from_dir is not None:
2507
inv, from_dir_id = self._path2inv_file_id(from_dir)
2508
if from_dir_id is None:
2509
# Directory not versioned
2511
from_dir_abspath = pathjoin(self.basedir, from_dir)
2513
inv = self.root_inventory
2514
from_dir_id = inv.root.file_id
2515
from_dir_abspath = self.basedir
2516
children = sorted(os.listdir(from_dir_abspath))
2517
# jam 20060527 The kernel sized tree seems equivalent whether we
2518
# use a deque and popleft to keep them sorted, or if we use a plain
2519
# list and just reverse() them.
2520
children = collections.deque(children)
2521
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2523
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2526
f = children.popleft()
2527
## TODO: If we find a subdirectory with its own .bzr
2528
## directory, then that is a separate tree and we
2529
## should exclude it.
2531
# the bzrdir for this tree
2532
if transport_base_dir == f:
2535
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2536
# and 'f' doesn't begin with one, we can do a string op, rather
2537
# than the checks of pathjoin(), all relative paths will have an extra slash
2539
fp = from_dir_relpath + '/' + f
2542
fap = from_dir_abspath + '/' + f
2544
dir_ie = inv[from_dir_id]
2545
if dir_ie.kind == 'directory':
2546
f_ie = dir_ie.children.get(f)
2551
elif self.is_ignored(fp[1:]):
2554
# we may not have found this file, because of a unicode
2555
# issue, or because the directory was actually a symlink.
2556
f_norm, can_access = osutils.normalized_filename(f)
2557
if f == f_norm or not can_access:
2558
# No change, so treat this file normally
2561
# this file can be accessed by a normalized path
2562
# check again if it is versioned
2563
# these lines are repeated here for performance
2565
fp = from_dir_relpath + '/' + f
2566
fap = from_dir_abspath + '/' + f
2567
f_ie = inv.get_child(from_dir_id, f)
2570
elif self.is_ignored(fp[1:]):
2577
# make a last minute entry
2579
yield fp[1:], c, fk, f_ie.file_id, f_ie
2582
yield fp[1:], c, fk, None, fk_entries[fk]()
2584
yield fp[1:], c, fk, None, TreeEntry()
2587
if fk != 'directory':
2590
# But do this child first if recursing down
2592
new_children = sorted(os.listdir(fap))
2593
new_children = collections.deque(new_children)
2594
stack.append((f_ie.file_id, fp, fap, new_children))
2595
# Break out of inner loop,
2596
# so that we start outer loop with child
2599
# if we finished all children, pop it off the stack
2602
@needs_tree_write_lock
2603
def move(self, from_paths, to_dir=None, after=False):
2606
to_dir must exist in the inventory.
2608
If to_dir exists and is a directory, the files are moved into
2609
it, keeping their old names.
2611
Note that to_dir is only the last component of the new name;
2612
this doesn't change the directory.
2614
For each entry in from_paths the move mode will be determined
2617
The first mode moves the file in the filesystem and updates the
2618
inventory. The second mode only updates the inventory without
2619
touching the file on the filesystem.
2621
move uses the second mode if 'after == True' and the target is
2622
either not versioned or newly added, and present in the working tree.
2624
move uses the second mode if 'after == False' and the source is
2625
versioned but no longer in the working tree, and the target is not
2626
versioned but present in the working tree.
2628
move uses the first mode if 'after == False' and the source is
2629
versioned and present in the working tree, and the target is not
2630
versioned and not present in the working tree.
2632
Everything else results in an error.
2634
This returns a list of (from_path, to_path) pairs for each
2635
entry that is moved.
2640
invs_to_write = set()
2642
# check for deprecated use of signature
2644
raise TypeError('You must supply a target directory')
2645
# check destination directory
2646
if isinstance(from_paths, basestring):
2648
to_abs = self.abspath(to_dir)
2649
if not isdir(to_abs):
2650
raise errors.BzrMoveFailedError('',to_dir,
2651
errors.NotADirectory(to_abs))
2652
if not self.has_filename(to_dir):
2653
raise errors.BzrMoveFailedError('',to_dir,
2654
errors.NotInWorkingDirectory(to_dir))
2655
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2656
if to_dir_id is None:
2657
raise errors.BzrMoveFailedError('',to_dir,
2658
errors.NotVersionedError(path=to_dir))
2660
to_dir_ie = to_inv[to_dir_id]
2661
if to_dir_ie.kind != 'directory':
2662
raise errors.BzrMoveFailedError('',to_dir,
2663
errors.NotADirectory(to_abs))
2665
# create rename entries and tuples
2666
for from_rel in from_paths:
2667
from_tail = splitpath(from_rel)[-1]
2668
from_inv, from_id = self._path2inv_file_id(from_rel)
2670
raise errors.BzrMoveFailedError(from_rel,to_dir,
2671
errors.NotVersionedError(path=from_rel))
2673
from_entry = from_inv[from_id]
2674
from_parent_id = from_entry.parent_id
2675
to_rel = pathjoin(to_dir, from_tail)
2676
rename_entry = InventoryWorkingTree._RenameEntry(
2679
from_tail=from_tail,
2680
from_parent_id=from_parent_id,
2681
to_rel=to_rel, to_tail=from_tail,
2682
to_parent_id=to_dir_id)
2683
rename_entries.append(rename_entry)
2684
rename_tuples.append((from_rel, to_rel))
2686
# determine which move mode to use. checks also for movability
2687
rename_entries = self._determine_mv_mode(rename_entries, after)
2689
original_modified = self._inventory_is_modified
2692
self._inventory_is_modified = True
2693
self._move(rename_entries)
2695
# restore the inventory on error
2696
self._inventory_is_modified = original_modified
2698
#FIXME: Should potentially also write the from_invs
2699
self._write_inventory(to_inv)
2700
return rename_tuples
2702
@needs_tree_write_lock
2703
def rename_one(self, from_rel, to_rel, after=False):
2706
This can change the directory or the filename or both.
2708
rename_one has several 'modes' to work. First, it can rename a physical
2709
file and change the file_id. That is the normal mode. Second, it can
2710
only change the file_id without touching any physical file.
2712
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2713
versioned but present in the working tree.
2715
rename_one uses the second mode if 'after == False' and 'from_rel' is
2716
versioned but no longer in the working tree, and 'to_rel' is not
2717
versioned but present in the working tree.
2719
rename_one uses the first mode if 'after == False' and 'from_rel' is
2720
versioned and present in the working tree, and 'to_rel' is not
2721
versioned and not present in the working tree.
2723
Everything else results in an error.
2727
# create rename entries and tuples
2728
from_tail = splitpath(from_rel)[-1]
2729
from_inv, from_id = self._path2inv_file_id(from_rel)
2731
# if file is missing in the inventory maybe it's in the basis_tree
2732
basis_tree = self.branch.basis_tree()
2733
from_id = basis_tree.path2id(from_rel)
2735
raise errors.BzrRenameFailedError(from_rel,to_rel,
2736
errors.NotVersionedError(path=from_rel))
2737
# put entry back in the inventory so we can rename it
2738
from_entry = basis_tree.root_inventory[from_id].copy()
2739
from_inv.add(from_entry)
2741
from_inv, from_inv_id = self._unpack_file_id(from_id)
2742
from_entry = from_inv[from_inv_id]
2743
from_parent_id = from_entry.parent_id
2744
to_dir, to_tail = os.path.split(to_rel)
2745
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2746
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2748
from_tail=from_tail,
2749
from_parent_id=from_parent_id,
2750
to_rel=to_rel, to_tail=to_tail,
2751
to_parent_id=to_dir_id)
2752
rename_entries.append(rename_entry)
2754
# determine which move mode to use. checks also for movability
2755
rename_entries = self._determine_mv_mode(rename_entries, after)
2757
# check if the target changed directory and if the target directory is
2759
if to_dir_id is None:
2760
raise errors.BzrMoveFailedError(from_rel,to_rel,
2761
errors.NotVersionedError(path=to_dir))
2763
# all checks done. now we can continue with our actual work
2764
mutter('rename_one:\n'
2769
' to_dir_id {%s}\n',
2770
from_id, from_rel, to_rel, to_dir, to_dir_id)
2772
self._move(rename_entries)
2773
self._write_inventory(to_inv)
2775
class _RenameEntry(object):
2776
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2777
to_rel, to_tail, to_parent_id, only_change_inv=False,
2779
self.from_rel = from_rel
2780
self.from_id = from_id
2781
self.from_tail = from_tail
2782
self.from_parent_id = from_parent_id
2783
self.to_rel = to_rel
2784
self.to_tail = to_tail
2785
self.to_parent_id = to_parent_id
2786
self.change_id = change_id
2787
self.only_change_inv = only_change_inv
2789
def _determine_mv_mode(self, rename_entries, after=False):
2790
"""Determines for each from-to pair if both inventory and working tree
2791
or only the inventory has to be changed.
2793
Also does basic plausability tests.
2795
# FIXME: Handling of nested trees
2796
inv = self.root_inventory
2798
for rename_entry in rename_entries:
2799
# store to local variables for easier reference
2800
from_rel = rename_entry.from_rel
2801
from_id = rename_entry.from_id
2802
to_rel = rename_entry.to_rel
2803
to_id = inv.path2id(to_rel)
2804
only_change_inv = False
2807
# check the inventory for source and destination
2809
raise errors.BzrMoveFailedError(from_rel,to_rel,
2810
errors.NotVersionedError(path=from_rel))
2811
if to_id is not None:
2813
# allow it with --after but only if dest is newly added
2815
basis = self.basis_tree()
2818
if not basis.has_id(to_id):
2819
rename_entry.change_id = True
2824
raise errors.BzrMoveFailedError(from_rel,to_rel,
2825
errors.AlreadyVersionedError(path=to_rel))
2827
# try to determine the mode for rename (only change inv or change
2828
# inv and file system)
2830
if not self.has_filename(to_rel):
2831
raise errors.BzrMoveFailedError(from_id,to_rel,
2832
errors.NoSuchFile(path=to_rel,
2833
extra="New file has not been created yet"))
2834
only_change_inv = True
2835
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2836
only_change_inv = True
2837
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2838
only_change_inv = False
2839
elif (not self.case_sensitive
2840
and from_rel.lower() == to_rel.lower()
2841
and self.has_filename(from_rel)):
2842
only_change_inv = False
2844
# something is wrong, so lets determine what exactly
2845
if not self.has_filename(from_rel) and \
2846
not self.has_filename(to_rel):
2847
raise errors.BzrRenameFailedError(from_rel, to_rel,
2848
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2850
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2851
rename_entry.only_change_inv = only_change_inv
2852
return rename_entries
2854
def _move(self, rename_entries):
2855
"""Moves a list of files.
2857
Depending on the value of the flag 'only_change_inv', the
2858
file will be moved on the file system or not.
2862
for entry in rename_entries:
2864
self._move_entry(entry)
2866
self._rollback_move(moved)
2870
def _rollback_move(self, moved):
2871
"""Try to rollback a previous move in case of an filesystem error."""
2874
self._move_entry(WorkingTree._RenameEntry(
2875
entry.to_rel, entry.from_id,
2876
entry.to_tail, entry.to_parent_id, entry.from_rel,
2877
entry.from_tail, entry.from_parent_id,
2878
entry.only_change_inv))
2879
except errors.BzrMoveFailedError as e:
2880
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2881
" The working tree is in an inconsistent state."
2882
" Please consider doing a 'bzr revert'."
2883
" Error message is: %s" % e)
2885
def _move_entry(self, entry):
2886
inv = self.root_inventory
2887
from_rel_abs = self.abspath(entry.from_rel)
2888
to_rel_abs = self.abspath(entry.to_rel)
2889
if from_rel_abs == to_rel_abs:
2890
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2891
"Source and target are identical.")
2893
if not entry.only_change_inv:
2895
osutils.rename(from_rel_abs, to_rel_abs)
2896
except OSError as e:
2897
raise errors.BzrMoveFailedError(entry.from_rel,
2900
to_id = inv.path2id(entry.to_rel)
2901
inv.remove_recursive_id(to_id)
2902
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2904
@needs_tree_write_lock
2905
def unversion(self, file_ids):
2906
"""Remove the file ids in file_ids from the current versioned set.
2908
When a file_id is unversioned, all of its children are automatically
2911
:param file_ids: The file ids to stop versioning.
2912
:raises: NoSuchId if any fileid is not currently versioned.
2914
for file_id in file_ids:
2915
if not self._inventory.has_id(file_id):
2916
raise errors.NoSuchId(self, file_id)
2917
for file_id in file_ids:
2918
if self._inventory.has_id(file_id):
2919
self._inventory.remove_recursive_id(file_id)
2921
# in the future this should just set a dirty bit to wait for the
2922
# final unlock. However, until all methods of workingtree start
2923
# with the current in -memory inventory rather than triggering
2924
# a read, it is more complex - we need to teach read_inventory
2925
# to know when to read, and when to not read first... and possibly
2926
# to save first when the in memory one may be corrupted.
2927
# so for now, we just only write it if it is indeed dirty.
2929
self._write_inventory(self._inventory)
2931
def stored_kind(self, file_id):
2932
"""See Tree.stored_kind"""
2933
inv, inv_file_id = self._unpack_file_id(file_id)
2934
return inv[inv_file_id].kind
2937
"""Yield all unversioned files in this WorkingTree.
2939
If there are any unversioned directories then only the directory is
2940
returned, not all its children. But if there are unversioned files
2941
under a versioned subdirectory, they are returned.
2943
Currently returned depth-first, sorted by name within directories.
2944
This is the same order used by 'osutils.walkdirs'.
2946
## TODO: Work from given directory downwards
2947
for path, dir_entry in self.iter_entries_by_dir():
2948
if dir_entry.kind != 'directory':
2950
# mutter("search for unknowns in %r", path)
2951
dirabs = self.abspath(path)
2952
if not isdir(dirabs):
2953
# e.g. directory deleted
2957
for subf in os.listdir(dirabs):
2958
if self.bzrdir.is_control_filename(subf):
2960
if subf not in dir_entry.children:
2963
can_access) = osutils.normalized_filename(subf)
2964
except UnicodeDecodeError:
2965
path_os_enc = path.encode(osutils._fs_enc)
2966
relpath = path_os_enc + '/' + subf
2967
raise errors.BadFilenameEncoding(relpath,
2969
if subf_norm != subf and can_access:
2970
if subf_norm not in dir_entry.children:
2971
fl.append(subf_norm)
2977
subp = pathjoin(path, subf)
2980
def _walkdirs(self, prefix=""):
2981
"""Walk the directories of this tree.
2983
:param prefix: is used as the directrory to start with.
2984
:returns: a generator which yields items in the form::
2986
((curren_directory_path, fileid),
2987
[(file1_path, file1_name, file1_kind, None, file1_id,
2990
_directory = 'directory'
2991
# get the root in the inventory
2992
inv, top_id = self._path2inv_file_id(prefix)
2996
pending = [(prefix, '', _directory, None, top_id, None)]
2999
currentdir = pending.pop()
3000
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
3001
top_id = currentdir[4]
3003
relroot = currentdir[0] + '/'
3006
# FIXME: stash the node in pending
3008
if entry.kind == 'directory':
3009
for name, child in entry.sorted_children():
3010
dirblock.append((relroot + name, name, child.kind, None,
3011
child.file_id, child.kind
3013
yield (currentdir[0], entry.file_id), dirblock
3014
# push the user specified dirs from dirblock
3015
for dir in reversed(dirblock):
3016
if dir[2] == _directory:
3020
def update_feature_flags(self, updated_flags):
3021
"""Update the feature flags for this branch.
3023
:param updated_flags: Dictionary mapping feature names to necessities
3024
A necessity can be None to indicate the feature should be removed
3026
self._format._update_feature_flags(updated_flags)
3027
self.control_transport.put_bytes('format', self._format.as_string())
3030
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
3031
"""Registry for working tree formats."""
3033
def __init__(self, other_registry=None):
3034
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
3035
self._default_format = None
3036
self._default_format_key = None
3038
def get_default(self):
3039
"""Return the current default format."""
3040
if (self._default_format_key is not None and
3041
self._default_format is None):
3042
self._default_format = self.get(self._default_format_key)
3043
return self._default_format
3045
def set_default(self, format):
3046
"""Set the default format."""
3047
self._default_format = format
3048
self._default_format_key = None
3050
def set_default_key(self, format_string):
3051
"""Set the default format by its format string."""
3052
self._default_format_key = format_string
3053
self._default_format = None
3056
format_registry = WorkingTreeFormatRegistry()
3059
class WorkingTreeFormat(controldir.ControlComponentFormat):
2770
3060
"""An encapsulation of the initialization and open routines for a format.
2772
3062
Formats provide three things:
2843
3131
"""True if this format supports stored views."""
2847
def register_format(klass, format):
2848
klass._formats[format.get_format_string()] = format
2851
def set_default_format(klass, format):
2852
klass._default_format = format
2855
def unregister_format(klass, format):
2856
del klass._formats[format.get_format_string()]
2859
class WorkingTreeFormat2(WorkingTreeFormat):
2860
"""The second working tree format.
2862
This format modified the hash cache from the format 1 hash cache.
2865
upgrade_recommended = True
2867
def get_format_description(self):
2868
"""See WorkingTreeFormat.get_format_description()."""
2869
return "Working tree format 2"
2871
def _stub_initialize_on_transport(self, transport, file_mode):
2872
"""Workaround: create control files for a remote working tree.
2874
This ensures that it can later be updated and dealt with locally,
2875
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2876
no working tree. (See bug #43064).
2879
inv = inventory.Inventory()
2880
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
transport.put_file('inventory', sio, file_mode)
2883
transport.put_bytes('pending-merges', '', file_mode)
2885
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
accelerator_tree=None, hardlink=False):
2887
"""See WorkingTreeFormat.initialize()."""
2888
if not isinstance(a_bzrdir.transport, LocalTransport):
2889
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2890
if from_branch is not None:
2891
branch = from_branch
2893
branch = a_bzrdir.open_branch()
2894
if revision_id is None:
2895
revision_id = _mod_revision.ensure_null(branch.last_revision())
2898
branch.generate_revision_history(revision_id)
2901
inv = inventory.Inventory()
2902
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2908
basis_tree = branch.repository.revision_tree(revision_id)
2909
if basis_tree.inventory.root is not None:
2910
wt.set_root_id(basis_tree.get_root_id())
2911
# set the parent list and cache the basis tree.
2912
if _mod_revision.is_null(revision_id):
2915
parent_trees = [(revision_id, basis_tree)]
2916
wt.set_parent_trees(parent_trees)
2917
transform.build_tree(basis_tree, wt)
2921
super(WorkingTreeFormat2, self).__init__()
2922
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2924
def open(self, a_bzrdir, _found=False):
2925
"""Return the WorkingTree object for a_bzrdir
2927
_found is a private parameter, do not use it. It is used to indicate
2928
if format probing has already been done.
2931
# we are being called directly and must probe.
2932
raise NotImplementedError
2933
if not isinstance(a_bzrdir.transport, LocalTransport):
2934
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2935
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2941
class WorkingTreeFormat3(WorkingTreeFormat):
2942
"""The second working tree format updated to record a format marker.
2945
- exists within a metadir controlling .bzr
2946
- includes an explicit version marker for the workingtree control
2947
files, separate from the BzrDir format
2948
- modifies the hash cache format
2950
- uses a LockDir to guard access for writes.
2953
upgrade_recommended = True
2955
def get_format_string(self):
2956
"""See WorkingTreeFormat.get_format_string()."""
2957
return "Bazaar-NG Working Tree format 3"
2959
def get_format_description(self):
2960
"""See WorkingTreeFormat.get_format_description()."""
2961
return "Working tree format 3"
2963
_lock_file_name = 'lock'
2964
_lock_class = LockDir
2966
_tree_class = WorkingTree3
2968
def __get_matchingbzrdir(self):
2969
return bzrdir.BzrDirMetaFormat1()
2971
_matchingbzrdir = property(__get_matchingbzrdir)
2973
def _open_control_files(self, a_bzrdir):
2974
transport = a_bzrdir.get_workingtree_transport(None)
2975
return LockableFiles(transport, self._lock_file_name,
2978
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
accelerator_tree=None, hardlink=False):
2980
"""See WorkingTreeFormat.initialize().
2982
:param revision_id: if supplied, create a working tree at a different
2983
revision than the branch is at.
2984
:param accelerator_tree: A tree which can be used for retrieving file
2985
contents more quickly than the revision tree, i.e. a workingtree.
2986
The revision tree will be used for cases where accelerator_tree's
2987
content is different.
2988
:param hardlink: If true, hard-link files from accelerator_tree,
2991
if not isinstance(a_bzrdir.transport, LocalTransport):
2992
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2993
transport = a_bzrdir.get_workingtree_transport(self)
2994
control_files = self._open_control_files(a_bzrdir)
2995
control_files.create_lock()
2996
control_files.lock_write()
2997
transport.put_bytes('format', self.get_format_string(),
2998
mode=a_bzrdir._get_file_mode())
2999
if from_branch is not None:
3000
branch = from_branch
3002
branch = a_bzrdir.open_branch()
3003
if revision_id is None:
3004
revision_id = _mod_revision.ensure_null(branch.last_revision())
3005
# WorkingTree3 can handle an inventory which has a unique root id.
3006
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3007
# those trees. And because there isn't a format bump inbetween, we
3008
# are maintaining compatibility with older clients.
3009
# inv = Inventory(root_id=gen_root_id())
3010
inv = self._initial_inventory()
3011
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3017
_control_files=control_files)
3018
wt.lock_tree_write()
3020
basis_tree = branch.repository.revision_tree(revision_id)
3021
# only set an explicit root id if there is one to set.
3022
if basis_tree.inventory.root is not None:
3023
wt.set_root_id(basis_tree.get_root_id())
3024
if revision_id == _mod_revision.NULL_REVISION:
3025
wt.set_parent_trees([])
3027
wt.set_parent_trees([(revision_id, basis_tree)])
3028
transform.build_tree(basis_tree, wt)
3030
# Unlock in this order so that the unlock-triggers-flush in
3031
# WorkingTree is given a chance to fire.
3032
control_files.unlock()
3036
def _initial_inventory(self):
3037
return inventory.Inventory()
3040
super(WorkingTreeFormat3, self).__init__()
3042
def open(self, a_bzrdir, _found=False):
3043
"""Return the WorkingTree object for a_bzrdir
3045
_found is a private parameter, do not use it. It is used to indicate
3046
if format probing has already been done.
3049
# we are being called directly and must probe.
3050
raise NotImplementedError
3051
if not isinstance(a_bzrdir.transport, LocalTransport):
3052
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3053
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3056
def _open(self, a_bzrdir, control_files):
3057
"""Open the tree itself.
3059
:param a_bzrdir: the dir for the tree.
3060
:param control_files: the control files for the tree.
3062
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3066
_control_files=control_files)
3069
return self.get_format_string()
3072
__default_format = WorkingTreeFormat6()
3073
WorkingTreeFormat.register_format(__default_format)
3074
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
WorkingTreeFormat.set_default_format(__default_format)
3078
# formats which have no format string are not discoverable
3079
# and not independently creatable, so are not registered.
3080
_legacy_formats = [WorkingTreeFormat2(),
3134
def get_controldir_for_branch(self):
3135
"""Get the control directory format for creating branches.
3137
This is to support testing of working tree formats that can not exist
3138
in the same control directory as a branch.
3140
return self._matchingbzrdir
3143
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3144
"""Base class for working trees that live in bzr meta directories."""
3147
WorkingTreeFormat.__init__(self)
3148
bzrdir.BzrFormat.__init__(self)
3151
def find_format_string(klass, controldir):
3152
"""Return format name for the working tree object in controldir."""
3154
transport = controldir.get_workingtree_transport(None)
3155
return transport.get_bytes("format")
3156
except errors.NoSuchFile:
3157
raise errors.NoWorkingTree(base=transport.base)
3160
def find_format(klass, controldir):
3161
"""Return the format for the working tree object in controldir."""
3162
format_string = klass.find_format_string(controldir)
3163
return klass._find_format(format_registry, 'working tree',
3166
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3168
WorkingTreeFormat.check_support_status(self,
3169
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3171
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3172
recommend_upgrade=recommend_upgrade, basedir=basedir)
3174
def get_controldir_for_branch(self):
3175
"""Get the control directory format for creating branches.
3177
This is to support testing of working tree formats that can not exist
3178
in the same control directory as a branch.
3180
return self._matchingbzrdir
3183
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3184
"""Base class for working trees that live in bzr meta directories."""
3187
WorkingTreeFormat.__init__(self)
3188
bzrdir.BzrFormat.__init__(self)
3191
def find_format_string(klass, controldir):
3192
"""Return format name for the working tree object in controldir."""
3194
transport = controldir.get_workingtree_transport(None)
3195
return transport.get_bytes("format")
3196
except errors.NoSuchFile:
3197
raise errors.NoWorkingTree(base=transport.base)
3200
def find_format(klass, controldir):
3201
"""Return the format for the working tree object in controldir."""
3202
format_string = klass.find_format_string(controldir)
3203
return klass._find_format(format_registry, 'working tree',
3206
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3208
WorkingTreeFormat.check_support_status(self,
3209
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3211
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3212
recommend_upgrade=recommend_upgrade, basedir=basedir)
3215
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3216
"breezy.workingtree_4", "WorkingTreeFormat4")
3217
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3218
"breezy.workingtree_4", "WorkingTreeFormat5")
3219
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3220
"breezy.workingtree_4", "WorkingTreeFormat6")
3221
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3222
"breezy.workingtree_3", "WorkingTreeFormat3")
3223
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
