2608
1730
return ShelfManager(self, self._transport)
2611
class WorkingTree2(WorkingTree):
2612
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2615
- uses os locks for locking.
2616
- uses the branch last-revision.
1733
class InventoryWorkingTree(WorkingTree,
1734
bzrlib.mutabletree.MutableInventoryTree):
1735
"""Base class for working trees that are inventory-oriented.
1737
The inventory is held in the `Branch` working-inventory, and the
1738
files are in a directory on disk.
1740
It is possible for a `WorkingTree` to have a filename which is
1741
not listed in the Inventory and vice versa.
2619
def __init__(self, *args, **kwargs):
2620
super(WorkingTree2, self).__init__(*args, **kwargs)
2621
# WorkingTree2 has more of a constraint that self._inventory must
2622
# exist. Because this is an older format, we don't mind the overhead
2623
# caused by the extra computation here.
2625
# Newer WorkingTree's should only have self._inventory set when they
2627
if self._inventory is None:
2628
self.read_working_inventory()
2630
def _get_check_refs(self):
2631
"""Return the references needed to perform a check of this tree."""
2632
return [('trees', self.last_revision())]
1744
def __init__(self, basedir='.',
1745
branch=DEPRECATED_PARAMETER,
1747
_control_files=None,
1751
"""Construct a InventoryWorkingTree instance. This is not a public API.
1753
:param branch: A branch to override probing for the branch.
1755
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1756
branch=branch, _transport=_control_files._transport,
1757
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1759
self._control_files = _control_files
1760
self._detect_case_handling()
1762
if _inventory is None:
1763
# This will be acquired on lock_read() or lock_write()
1764
self._inventory_is_modified = False
1765
self._inventory = None
1767
# the caller of __init__ has provided an inventory,
1768
# we assume they know what they are doing - as its only
1769
# the Format factory and creation methods that are
1770
# permitted to do this.
1771
self._set_inventory(_inventory, dirty=False)
1773
def _set_inventory(self, inv, dirty):
1774
"""Set the internal cached inventory.
1776
:param inv: The inventory to set.
1777
:param dirty: A boolean indicating whether the inventory is the same
1778
logical inventory as whats on disk. If True the inventory is not
1779
the same and should be written to disk or data will be lost, if
1780
False then the inventory is the same as that on disk and any
1781
serialisation would be unneeded overhead.
1783
self._inventory = inv
1784
self._inventory_is_modified = dirty
1786
def _detect_case_handling(self):
1787
wt_trans = self.bzrdir.get_workingtree_transport(None)
1789
wt_trans.stat(self._format.case_sensitive_filename)
1790
except errors.NoSuchFile:
1791
self.case_sensitive = True
1793
self.case_sensitive = False
1795
self._setup_directory_is_tree_reference()
1797
def _serialize(self, inventory, out_file):
1798
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1801
def _deserialize(selt, in_file):
1802
return xml5.serializer_v5.read_inventory(in_file)
1804
def break_lock(self):
1805
"""Break a lock if one is present from another instance.
1807
Uses the ui factory to ask for confirmation if the lock may be from
1810
This will probe the repository for its lock as well.
1812
self._control_files.break_lock()
1813
self.branch.break_lock()
1815
def is_locked(self):
1816
return self._control_files.is_locked()
1818
def _must_be_locked(self):
1819
if not self.is_locked():
1820
raise errors.ObjectNotLocked(self)
1822
def lock_read(self):
1823
"""Lock the tree for reading.
1825
This also locks the branch, and can be unlocked via self.unlock().
1827
:return: A bzrlib.lock.LogicalLockResult.
1829
if not self.is_locked():
1831
self.branch.lock_read()
1833
self._control_files.lock_read()
1834
return LogicalLockResult(self.unlock)
1836
self.branch.unlock()
2634
1839
def lock_tree_write(self):
2635
"""See WorkingTree.lock_tree_write().
2637
In Format2 WorkingTrees we have a single lock for the branch and tree
2638
so lock_tree_write() degrades to lock_write().
1840
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1842
:return: A bzrlib.lock.LogicalLockResult.
1844
if not self.is_locked():
1846
self.branch.lock_read()
1848
self._control_files.lock_write()
1849
return LogicalLockResult(self.unlock)
1851
self.branch.unlock()
1854
def lock_write(self):
1855
"""See MutableTree.lock_write, and WorkingTree.unlock.
1857
:return: A bzrlib.lock.LogicalLockResult.
1859
if not self.is_locked():
2640
1861
self.branch.lock_write()
2642
return self._control_files.lock_write()
1863
self._control_files.lock_write()
1864
return LogicalLockResult(self.unlock)
2644
1866
self.branch.unlock()
2648
# do non-implementation specific cleanup
2651
# we share control files:
2652
if self._control_files._lock_count == 3:
2653
# _inventory_is_modified is always False during a read lock.
2654
if self._inventory_is_modified:
2656
self._write_hashcache_if_dirty()
2658
# reverse order of locking.
1869
def get_physical_lock_status(self):
1870
return self._control_files.get_physical_lock_status()
1872
@needs_tree_write_lock
1873
def _write_inventory(self, inv):
1874
"""Write inventory as the current inventory."""
1875
self._set_inventory(inv, dirty=True)
1878
# XXX: This method should be deprecated in favour of taking in a proper
1879
# new Inventory object.
1880
@needs_tree_write_lock
1881
def set_inventory(self, new_inventory_list):
1882
from bzrlib.inventory import (Inventory,
1886
inv = Inventory(self.get_root_id())
1887
for path, file_id, parent, kind in new_inventory_list:
1888
name = os.path.basename(path)
1891
# fixme, there should be a factory function inv,add_??
1892
if kind == 'directory':
1893
inv.add(InventoryDirectory(file_id, name, parent))
1894
elif kind == 'file':
1895
inv.add(InventoryFile(file_id, name, parent))
1896
elif kind == 'symlink':
1897
inv.add(InventoryLink(file_id, name, parent))
1899
raise errors.BzrError("unknown kind %r" % kind)
1900
self._write_inventory(inv)
1902
def _write_basis_inventory(self, xml):
1903
"""Write the basis inventory XML to the basis-inventory file"""
1904
path = self._basis_inventory_name()
1906
self._transport.put_file(path, sio,
1907
mode=self.bzrdir._get_file_mode())
1909
def _reset_data(self):
1910
"""Reset transient data that cannot be revalidated."""
1911
self._inventory_is_modified = False
1912
f = self._transport.get('inventory')
2660
return self._control_files.unlock()
1914
result = self._deserialize(f)
2662
self.branch.unlock()
2665
class WorkingTree3(WorkingTree):
2666
"""This is the Format 3 working tree.
2668
This differs from the base WorkingTree by:
2669
- having its own file lock
2670
- having its own last-revision property.
2672
This is new in bzr 0.8
2676
def _last_revision(self):
2677
"""See Mutable.last_revision."""
1917
self._set_inventory(result, dirty=False)
1919
def _set_root_id(self, file_id):
1920
"""Set the root id for this tree, in a format specific manner.
1922
:param file_id: The file id to assign to the root. It must not be
1923
present in the current inventory or an error will occur. It must
1924
not be None, but rather a valid file id.
1926
inv = self._inventory
1927
orig_root_id = inv.root.file_id
1928
# TODO: it might be nice to exit early if there was nothing
1929
# to do, saving us from trigger a sync on unlock.
1930
self._inventory_is_modified = True
1931
# we preserve the root inventory entry object, but
1932
# unlinkit from the byid index
1933
del inv._byid[inv.root.file_id]
1934
inv.root.file_id = file_id
1935
# and link it into the index with the new changed id.
1936
inv._byid[inv.root.file_id] = inv.root
1937
# and finally update all children to reference the new id.
1938
# XXX: this should be safe to just look at the root.children
1939
# list, not the WHOLE INVENTORY.
1942
if entry.parent_id == orig_root_id:
1943
entry.parent_id = inv.root.file_id
1945
@needs_tree_write_lock
1946
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1947
"""See MutableTree.set_parent_trees."""
1948
parent_ids = [rev for (rev, tree) in parents_list]
1949
for revision_id in parent_ids:
1950
_mod_revision.check_not_reserved_id(revision_id)
1952
self._check_parents_for_ghosts(parent_ids,
1953
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1955
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1957
if len(parent_ids) == 0:
1958
leftmost_parent_id = _mod_revision.NULL_REVISION
1959
leftmost_parent_tree = None
1961
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1963
if self._change_last_revision(leftmost_parent_id):
1964
if leftmost_parent_tree is None:
1965
# If we don't have a tree, fall back to reading the
1966
# parent tree from the repository.
1967
self._cache_basis_inventory(leftmost_parent_id)
1969
inv = leftmost_parent_tree.inventory
1970
xml = self._create_basis_xml_from_inventory(
1971
leftmost_parent_id, inv)
1972
self._write_basis_inventory(xml)
1973
self._set_merges_from_parent_ids(parent_ids)
1975
def _cache_basis_inventory(self, new_revision):
1976
"""Cache new_revision as the basis inventory."""
1977
# TODO: this should allow the ready-to-use inventory to be passed in,
1978
# as commit already has that ready-to-use [while the format is the
2679
return self._transport.get_bytes('last-revision')
2680
except errors.NoSuchFile:
2681
return _mod_revision.NULL_REVISION
2683
def _change_last_revision(self, revision_id):
2684
"""See WorkingTree._change_last_revision."""
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2687
self._transport.delete('last-revision')
2688
except errors.NoSuchFile:
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2696
def _get_check_refs(self):
2697
"""Return the references needed to perform a check of this tree."""
2698
return [('trees', self.last_revision())]
1981
# this double handles the inventory - unpack and repack -
1982
# but is easier to understand. We can/should put a conditional
1983
# in here based on whether the inventory is in the latest format
1984
# - perhaps we should repack all inventories on a repository
1986
# the fast path is to copy the raw xml from the repository. If the
1987
# xml contains 'revision_id="', then we assume the right
1988
# revision_id is set. We must check for this full string, because a
1989
# root node id can legitimately look like 'revision_id' but cannot
1991
xml = self.branch.repository._get_inventory_xml(new_revision)
1992
firstline = xml.split('\n', 1)[0]
1993
if (not 'revision_id="' in firstline or
1994
'format="7"' not in firstline):
1995
inv = self.branch.repository._serializer.read_inventory_from_string(
1997
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1998
self._write_basis_inventory(xml)
1999
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2002
def _basis_inventory_name(self):
2003
return 'basis-inventory-cache'
2005
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2006
"""Create the text that will be saved in basis-inventory"""
2007
inventory.revision_id = revision_id
2008
return xml7.serializer_v7.write_inventory_to_string(inventory)
2700
2010
@needs_tree_write_lock
2701
2011
def set_conflicts(self, conflicts):
2721
2031
raise errors.ConflictFormatError()
2722
2032
except StopIteration:
2723
2033
raise errors.ConflictFormatError()
2724
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2034
reader = _mod_rio.RioReader(confile)
2035
return _mod_conflicts.ConflictList.from_stanzas(reader)
2726
2037
confile.close()
2729
# do non-implementation specific cleanup
2731
if self._control_files._lock_count == 1:
2732
# _inventory_is_modified is always False during a read lock.
2733
if self._inventory_is_modified:
2735
self._write_hashcache_if_dirty()
2736
# reverse order of locking.
2738
return self._control_files.unlock()
2740
self.branch.unlock()
2743
def get_conflicted_stem(path):
2744
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
if path.endswith(suffix):
2746
return path[:-len(suffix)]
2749
class WorkingTreeFormat(object):
2039
def read_basis_inventory(self):
2040
"""Read the cached basis inventory."""
2041
path = self._basis_inventory_name()
2042
return self._transport.get_bytes(path)
2045
def read_working_inventory(self):
2046
"""Read the working inventory.
2048
:raises errors.InventoryModified: read_working_inventory will fail
2049
when the current in memory inventory has been modified.
2051
# conceptually this should be an implementation detail of the tree.
2052
# XXX: Deprecate this.
2053
# ElementTree does its own conversion from UTF-8, so open in
2055
if self._inventory_is_modified:
2056
raise errors.InventoryModified(self)
2057
f = self._transport.get('inventory')
2059
result = self._deserialize(f)
2062
self._set_inventory(result, dirty=False)
2066
def get_root_id(self):
2067
"""Return the id of this trees root"""
2068
return self._inventory.root.file_id
2070
def has_id(self, file_id):
2071
# files that have been deleted are excluded
2072
inv, inv_file_id = self._unpack_file_id(file_id)
2073
if not inv.has_id(inv_file_id):
2075
path = inv.id2path(inv_file_id)
2076
return osutils.lexists(self.abspath(path))
2078
def has_or_had_id(self, file_id):
2079
if file_id == self.inventory.root.file_id:
2081
inv, inv_file_id = self._unpack_file_id(file_id)
2082
return inv.has_id(inv_file_id)
2084
def all_file_ids(self):
2085
"""Iterate through file_ids for this tree.
2087
file_ids are in a WorkingTree if they are in the working inventory
2088
and the working file exists.
2091
for path, ie in self.iter_entries_by_dir():
2095
@needs_tree_write_lock
2096
def set_last_revision(self, new_revision):
2097
"""Change the last revision in the working tree."""
2098
if self._change_last_revision(new_revision):
2099
self._cache_basis_inventory(new_revision)
2101
def _get_check_refs(self):
2102
"""Return the references needed to perform a check of this tree.
2104
The default implementation returns no refs, and is only suitable for
2105
trees that have no local caching and can commit on ghosts at any time.
2107
:seealso: bzrlib.check for details about check_refs.
2112
def _check(self, references):
2113
"""Check the tree for consistency.
2115
:param references: A dict with keys matching the items returned by
2116
self._get_check_refs(), and values from looking those keys up in
2119
tree_basis = self.basis_tree()
2120
tree_basis.lock_read()
2122
repo_basis = references[('trees', self.last_revision())]
2123
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2124
raise errors.BzrCheckError(
2125
"Mismatched basis inventory content.")
2131
def check_state(self):
2132
"""Check that the working state is/isn't valid."""
2133
check_refs = self._get_check_refs()
2135
for ref in check_refs:
2138
refs[ref] = self.branch.repository.revision_tree(value)
2141
@needs_tree_write_lock
2142
def reset_state(self, revision_ids=None):
2143
"""Reset the state of the working tree.
2145
This does a hard-reset to a last-known-good state. This is a way to
2146
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2148
if revision_ids is None:
2149
revision_ids = self.get_parent_ids()
2150
if not revision_ids:
2151
rt = self.branch.repository.revision_tree(
2152
_mod_revision.NULL_REVISION)
2154
rt = self.branch.repository.revision_tree(revision_ids[0])
2155
self._write_inventory(rt.inventory)
2156
self.set_parent_ids(revision_ids)
2159
"""Write the in memory inventory to disk."""
2160
# TODO: Maybe this should only write on dirty ?
2161
if self._control_files._lock_mode != 'w':
2162
raise errors.NotWriteLocked(self)
2164
self._serialize(self._inventory, sio)
2166
self._transport.put_file('inventory', sio,
2167
mode=self.bzrdir._get_file_mode())
2168
self._inventory_is_modified = False
2170
def get_file_mtime(self, file_id, path=None):
2171
"""See Tree.get_file_mtime."""
2173
path = self.id2path(file_id)
2175
return os.lstat(self.abspath(path)).st_mtime
2177
if e.errno == errno.ENOENT:
2178
raise errors.FileTimestampUnavailable(path)
2181
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2182
inv, file_id = self._path2inv_file_id(path)
2184
# For unversioned files on win32, we just assume they are not
2187
return inv[file_id].executable
2189
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2190
mode = stat_result.st_mode
2191
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2193
def is_executable(self, file_id, path=None):
2194
if not self._supports_executable():
2195
inv, inv_file_id = self._unpack_file_id(file_id)
2196
return inv[inv_file_id].executable
2199
path = self.id2path(file_id)
2200
mode = os.lstat(self.abspath(path)).st_mode
2201
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2203
def _is_executable_from_path_and_stat(self, path, stat_result):
2204
if not self._supports_executable():
2205
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2207
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2209
@needs_tree_write_lock
2210
def _add(self, files, ids, kinds):
2211
"""See MutableTree._add."""
2212
# TODO: Re-adding a file that is removed in the working copy
2213
# should probably put it back with the previous ID.
2214
# the read and write working inventory should not occur in this
2215
# function - they should be part of lock_write and unlock.
2216
inv = self.inventory
2217
for f, file_id, kind in zip(files, ids, kinds):
2219
inv.add_path(f, kind=kind)
2221
inv.add_path(f, kind=kind, file_id=file_id)
2222
self._inventory_is_modified = True
2224
def revision_tree(self, revision_id):
2225
"""See WorkingTree.revision_id."""
2226
if revision_id == self.last_revision():
2228
xml = self.read_basis_inventory()
2229
except errors.NoSuchFile:
2233
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2234
# dont use the repository revision_tree api because we want
2235
# to supply the inventory.
2236
if inv.revision_id == revision_id:
2237
return revisiontree.InventoryRevisionTree(
2238
self.branch.repository, inv, revision_id)
2239
except errors.BadInventoryFormat:
2241
# raise if there was no inventory, or if we read the wrong inventory.
2242
raise errors.NoSuchRevisionInTree(self, revision_id)
2245
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2246
"""See Tree.annotate_iter
2248
This implementation will use the basis tree implementation if possible.
2249
Lines not in the basis are attributed to CURRENT_REVISION
2251
If there are pending merges, lines added by those merges will be
2252
incorrectly attributed to CURRENT_REVISION (but after committing, the
2253
attribution will be correct).
2255
maybe_file_parent_keys = []
2256
for parent_id in self.get_parent_ids():
2258
parent_tree = self.revision_tree(parent_id)
2259
except errors.NoSuchRevisionInTree:
2260
parent_tree = self.branch.repository.revision_tree(parent_id)
2261
parent_tree.lock_read()
2264
kind = parent_tree.kind(file_id)
2265
except errors.NoSuchId:
2268
# Note: this is slightly unnecessary, because symlinks and
2269
# directories have a "text" which is the empty text, and we
2270
# know that won't mess up annotations. But it seems cleaner
2273
file_id, parent_tree.get_file_revision(file_id))
2274
if parent_text_key not in maybe_file_parent_keys:
2275
maybe_file_parent_keys.append(parent_text_key)
2277
parent_tree.unlock()
2278
graph = _mod_graph.Graph(self.branch.repository.texts)
2279
heads = graph.heads(maybe_file_parent_keys)
2280
file_parent_keys = []
2281
for key in maybe_file_parent_keys:
2283
file_parent_keys.append(key)
2285
# Now we have the parents of this content
2286
annotator = self.branch.repository.texts.get_annotator()
2287
text = self.get_file_text(file_id)
2288
this_key =(file_id, default_revision)
2289
annotator.add_special_text(this_key, file_parent_keys, text)
2290
annotations = [(key[-1], line)
2291
for key, line in annotator.annotate_flat(this_key)]
2294
def _put_rio(self, filename, stanzas, header):
2295
self._must_be_locked()
2296
my_file = _mod_rio.rio_file(stanzas, header)
2297
self._transport.put_file(filename, my_file,
2298
mode=self.bzrdir._get_file_mode())
2300
@needs_tree_write_lock
2301
def set_merge_modified(self, modified_hashes):
2303
for file_id, hash in modified_hashes.iteritems():
2304
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2306
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2309
def merge_modified(self):
2310
"""Return a dictionary of files modified by a merge.
2312
The list is initialized by WorkingTree.set_merge_modified, which is
2313
typically called after we make some automatic updates to the tree
2316
This returns a map of file_id->sha1, containing only files which are
2317
still in the working inventory and have that text hash.
2320
hashfile = self._transport.get('merge-hashes')
2321
except errors.NoSuchFile:
2326
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2327
raise errors.MergeModifiedFormatError()
2328
except StopIteration:
2329
raise errors.MergeModifiedFormatError()
2330
for s in _mod_rio.RioReader(hashfile):
2331
# RioReader reads in Unicode, so convert file_ids back to utf8
2332
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2333
if not self.has_id(file_id):
2335
text_hash = s.get("hash")
2336
if text_hash == self.get_file_sha1(file_id):
2337
merge_hashes[file_id] = text_hash
2343
def subsume(self, other_tree):
2344
def add_children(inventory, entry):
2345
for child_entry in entry.children.values():
2346
inventory._byid[child_entry.file_id] = child_entry
2347
if child_entry.kind == 'directory':
2348
add_children(inventory, child_entry)
2349
if other_tree.get_root_id() == self.get_root_id():
2350
raise errors.BadSubsumeSource(self, other_tree,
2351
'Trees have the same root')
2353
other_tree_path = self.relpath(other_tree.basedir)
2354
except errors.PathNotChild:
2355
raise errors.BadSubsumeSource(self, other_tree,
2356
'Tree is not contained by the other')
2357
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2358
if new_root_parent is None:
2359
raise errors.BadSubsumeSource(self, other_tree,
2360
'Parent directory is not versioned.')
2361
# We need to ensure that the result of a fetch will have a
2362
# versionedfile for the other_tree root, and only fetching into
2363
# RepositoryKnit2 guarantees that.
2364
if not self.branch.repository.supports_rich_root():
2365
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2366
other_tree.lock_tree_write()
2368
new_parents = other_tree.get_parent_ids()
2369
other_root = other_tree.inventory.root
2370
other_root.parent_id = new_root_parent
2371
other_root.name = osutils.basename(other_tree_path)
2372
self.inventory.add(other_root)
2373
add_children(self.inventory, other_root)
2374
self._write_inventory(self.inventory)
2375
# normally we don't want to fetch whole repositories, but i think
2376
# here we really do want to consolidate the whole thing.
2377
for parent_id in other_tree.get_parent_ids():
2378
self.branch.fetch(other_tree.branch, parent_id)
2379
self.add_parent_tree_id(parent_id)
2382
other_tree.bzrdir.retire_bzrdir()
2384
@needs_tree_write_lock
2385
def extract(self, file_id, format=None):
2386
"""Extract a subtree from this tree.
2388
A new branch will be created, relative to the path for this tree.
2392
segments = osutils.splitpath(path)
2393
transport = self.branch.bzrdir.root_transport
2394
for name in segments:
2395
transport = transport.clone(name)
2396
transport.ensure_base()
2399
sub_path = self.id2path(file_id)
2400
branch_transport = mkdirs(sub_path)
2402
format = self.bzrdir.cloning_metadir()
2403
branch_transport.ensure_base()
2404
branch_bzrdir = format.initialize_on_transport(branch_transport)
2406
repo = branch_bzrdir.find_repository()
2407
except errors.NoRepositoryPresent:
2408
repo = branch_bzrdir.create_repository()
2409
if not repo.supports_rich_root():
2410
raise errors.RootNotRich()
2411
new_branch = branch_bzrdir.create_branch()
2412
new_branch.pull(self.branch)
2413
for parent_id in self.get_parent_ids():
2414
new_branch.fetch(self.branch, parent_id)
2415
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2416
if tree_transport.base != branch_transport.base:
2417
tree_bzrdir = format.initialize_on_transport(tree_transport)
2418
tree_bzrdir.set_branch_reference(new_branch)
2420
tree_bzrdir = branch_bzrdir
2421
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2422
wt.set_parent_ids(self.get_parent_ids())
2423
my_inv = self.inventory
2424
child_inv = inventory.Inventory(root_id=None)
2425
new_root = my_inv[file_id]
2426
my_inv.remove_recursive_id(file_id)
2427
new_root.parent_id = None
2428
child_inv.add(new_root)
2429
self._write_inventory(my_inv)
2430
wt._write_inventory(child_inv)
2433
def list_files(self, include_root=False, from_dir=None, recursive=True):
2434
"""List all files as (path, class, kind, id, entry).
2436
Lists, but does not descend into unversioned directories.
2437
This does not include files that have been deleted in this
2438
tree. Skips the control directory.
2440
:param include_root: if True, return an entry for the root
2441
:param from_dir: start from this directory or None for the root
2442
:param recursive: whether to recurse into subdirectories or not
2444
# list_files is an iterator, so @needs_read_lock doesn't work properly
2445
# with it. So callers should be careful to always read_lock the tree.
2446
if not self.is_locked():
2447
raise errors.ObjectNotLocked(self)
2449
if from_dir is None and include_root is True:
2450
yield ('', 'V', 'directory', self.get_root_id(), self.inventory.root)
2451
# Convert these into local objects to save lookup times
2452
pathjoin = osutils.pathjoin
2453
file_kind = self._kind
2455
# transport.base ends in a slash, we want the piece
2456
# between the last two slashes
2457
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2459
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2461
# directory file_id, relative path, absolute path, reverse sorted children
2462
if from_dir is not None:
2463
inv, from_dir_id = self._path2inv_file_id(from_dir)
2464
if from_dir_id is None:
2465
# Directory not versioned
2467
from_dir_abspath = pathjoin(self.basedir, from_dir)
2469
inv = self.inventory
2470
from_dir_id = inv.root.file_id
2471
from_dir_abspath = self.basedir
2472
children = os.listdir(from_dir_abspath)
2474
# jam 20060527 The kernel sized tree seems equivalent whether we
2475
# use a deque and popleft to keep them sorted, or if we use a plain
2476
# list and just reverse() them.
2477
children = collections.deque(children)
2478
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2480
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2483
f = children.popleft()
2484
## TODO: If we find a subdirectory with its own .bzr
2485
## directory, then that is a separate tree and we
2486
## should exclude it.
2488
# the bzrdir for this tree
2489
if transport_base_dir == f:
2492
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2493
# and 'f' doesn't begin with one, we can do a string op, rather
2494
# than the checks of pathjoin(), all relative paths will have an extra slash
2496
fp = from_dir_relpath + '/' + f
2499
fap = from_dir_abspath + '/' + f
2501
dir_ie = inv[from_dir_id]
2502
if dir_ie.kind == 'directory':
2503
f_ie = dir_ie.children.get(f)
2508
elif self.is_ignored(fp[1:]):
2511
# we may not have found this file, because of a unicode
2512
# issue, or because the directory was actually a symlink.
2513
f_norm, can_access = osutils.normalized_filename(f)
2514
if f == f_norm or not can_access:
2515
# No change, so treat this file normally
2518
# this file can be accessed by a normalized path
2519
# check again if it is versioned
2520
# these lines are repeated here for performance
2522
fp = from_dir_relpath + '/' + f
2523
fap = from_dir_abspath + '/' + f
2524
f_ie = inv.get_child(from_dir_id, f)
2527
elif self.is_ignored(fp[1:]):
2534
# make a last minute entry
2536
yield fp[1:], c, fk, f_ie.file_id, f_ie
2539
yield fp[1:], c, fk, None, fk_entries[fk]()
2541
yield fp[1:], c, fk, None, TreeEntry()
2544
if fk != 'directory':
2547
# But do this child first if recursing down
2549
new_children = os.listdir(fap)
2551
new_children = collections.deque(new_children)
2552
stack.append((f_ie.file_id, fp, fap, new_children))
2553
# Break out of inner loop,
2554
# so that we start outer loop with child
2557
# if we finished all children, pop it off the stack
2560
@needs_tree_write_lock
2561
def move(self, from_paths, to_dir=None, after=False):
2564
to_dir must exist in the inventory.
2566
If to_dir exists and is a directory, the files are moved into
2567
it, keeping their old names.
2569
Note that to_dir is only the last component of the new name;
2570
this doesn't change the directory.
2572
For each entry in from_paths the move mode will be determined
2575
The first mode moves the file in the filesystem and updates the
2576
inventory. The second mode only updates the inventory without
2577
touching the file on the filesystem.
2579
move uses the second mode if 'after == True' and the target is
2580
either not versioned or newly added, and present in the working tree.
2582
move uses the second mode if 'after == False' and the source is
2583
versioned but no longer in the working tree, and the target is not
2584
versioned but present in the working tree.
2586
move uses the first mode if 'after == False' and the source is
2587
versioned and present in the working tree, and the target is not
2588
versioned and not present in the working tree.
2590
Everything else results in an error.
2592
This returns a list of (from_path, to_path) pairs for each
2593
entry that is moved.
2598
# check for deprecated use of signature
2600
raise TypeError('You must supply a target directory')
2601
# check destination directory
2602
if isinstance(from_paths, basestring):
2604
to_abs = self.abspath(to_dir)
2605
if not isdir(to_abs):
2606
raise errors.BzrMoveFailedError('',to_dir,
2607
errors.NotADirectory(to_abs))
2608
if not self.has_filename(to_dir):
2609
raise errors.BzrMoveFailedError('',to_dir,
2610
errors.NotInWorkingDirectory(to_dir))
2611
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2612
if to_dir_id is None:
2613
raise errors.BzrMoveFailedError('',to_dir,
2614
errors.NotVersionedError(path=to_dir))
2616
to_dir_ie = to_inv[to_dir_id]
2617
if to_dir_ie.kind != 'directory':
2618
raise errors.BzrMoveFailedError('',to_dir,
2619
errors.NotADirectory(to_abs))
2621
# create rename entries and tuples
2622
for from_rel in from_paths:
2623
from_tail = splitpath(from_rel)[-1]
2624
from_inv, from_id = self._path2inv_file_id(from_rel)
2626
raise errors.BzrMoveFailedError(from_rel,to_dir,
2627
errors.NotVersionedError(path=from_rel))
2629
from_entry = from_inv[from_id]
2630
from_parent_id = from_entry.parent_id
2631
to_rel = pathjoin(to_dir, from_tail)
2632
rename_entry = InventoryWorkingTree._RenameEntry(
2635
from_tail=from_tail,
2636
from_parent_id=from_parent_id,
2637
to_rel=to_rel, to_tail=from_tail,
2638
to_parent_id=to_dir_id)
2639
rename_entries.append(rename_entry)
2640
rename_tuples.append((from_rel, to_rel))
2642
# determine which move mode to use. checks also for movability
2643
rename_entries = self._determine_mv_mode(rename_entries, after)
2645
original_modified = self._inventory_is_modified
2648
self._inventory_is_modified = True
2649
self._move(rename_entries)
2651
# restore the inventory on error
2652
self._inventory_is_modified = original_modified
2654
#FIXME: Should potentially also write the from_invs
2655
self._write_inventory(to_inv)
2656
return rename_tuples
2658
@needs_tree_write_lock
2659
def rename_one(self, from_rel, to_rel, after=False):
2662
This can change the directory or the filename or both.
2664
rename_one has several 'modes' to work. First, it can rename a physical
2665
file and change the file_id. That is the normal mode. Second, it can
2666
only change the file_id without touching any physical file.
2668
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2669
versioned but present in the working tree.
2671
rename_one uses the second mode if 'after == False' and 'from_rel' is
2672
versioned but no longer in the working tree, and 'to_rel' is not
2673
versioned but present in the working tree.
2675
rename_one uses the first mode if 'after == False' and 'from_rel' is
2676
versioned and present in the working tree, and 'to_rel' is not
2677
versioned and not present in the working tree.
2679
Everything else results in an error.
2683
# create rename entries and tuples
2684
from_tail = splitpath(from_rel)[-1]
2685
from_inv, from_id = self._path2inv_file_id(from_rel)
2687
# if file is missing in the inventory maybe it's in the basis_tree
2688
basis_tree = self.branch.basis_tree()
2689
from_id = basis_tree.path2id(from_rel)
2691
raise errors.BzrRenameFailedError(from_rel,to_rel,
2692
errors.NotVersionedError(path=from_rel))
2693
# put entry back in the inventory so we can rename it
2694
from_entry = basis_tree.inventory[from_id].copy()
2695
from_inv.add(from_entry)
2697
from_inv, from_inv_id = self._unpack_file_id(from_id)
2698
from_entry = from_inv[from_inv_id]
2699
from_parent_id = from_entry.parent_id
2700
to_dir, to_tail = os.path.split(to_rel)
2701
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2702
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2704
from_tail=from_tail,
2705
from_parent_id=from_parent_id,
2706
to_rel=to_rel, to_tail=to_tail,
2707
to_parent_id=to_dir_id)
2708
rename_entries.append(rename_entry)
2710
# determine which move mode to use. checks also for movability
2711
rename_entries = self._determine_mv_mode(rename_entries, after)
2713
# check if the target changed directory and if the target directory is
2715
if to_dir_id is None:
2716
raise errors.BzrMoveFailedError(from_rel,to_rel,
2717
errors.NotVersionedError(path=to_dir))
2719
# all checks done. now we can continue with our actual work
2720
mutter('rename_one:\n'
2725
' to_dir_id {%s}\n',
2726
from_id, from_rel, to_rel, to_dir, to_dir_id)
2728
self._move(rename_entries)
2729
self._write_inventory(to_inv)
2731
class _RenameEntry(object):
2732
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2733
to_rel, to_tail, to_parent_id, only_change_inv=False,
2735
self.from_rel = from_rel
2736
self.from_id = from_id
2737
self.from_tail = from_tail
2738
self.from_parent_id = from_parent_id
2739
self.to_rel = to_rel
2740
self.to_tail = to_tail
2741
self.to_parent_id = to_parent_id
2742
self.change_id = change_id
2743
self.only_change_inv = only_change_inv
2745
def _determine_mv_mode(self, rename_entries, after=False):
2746
"""Determines for each from-to pair if both inventory and working tree
2747
or only the inventory has to be changed.
2749
Also does basic plausability tests.
2751
inv = self.inventory
2753
for rename_entry in rename_entries:
2754
# store to local variables for easier reference
2755
from_rel = rename_entry.from_rel
2756
from_id = rename_entry.from_id
2757
to_rel = rename_entry.to_rel
2758
to_id = inv.path2id(to_rel)
2759
only_change_inv = False
2762
# check the inventory for source and destination
2764
raise errors.BzrMoveFailedError(from_rel,to_rel,
2765
errors.NotVersionedError(path=from_rel))
2766
if to_id is not None:
2768
# allow it with --after but only if dest is newly added
2770
basis = self.basis_tree()
2773
if not basis.has_id(to_id):
2774
rename_entry.change_id = True
2779
raise errors.BzrMoveFailedError(from_rel,to_rel,
2780
errors.AlreadyVersionedError(path=to_rel))
2782
# try to determine the mode for rename (only change inv or change
2783
# inv and file system)
2785
if not self.has_filename(to_rel):
2786
raise errors.BzrMoveFailedError(from_id,to_rel,
2787
errors.NoSuchFile(path=to_rel,
2788
extra="New file has not been created yet"))
2789
only_change_inv = True
2790
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2791
only_change_inv = True
2792
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2793
only_change_inv = False
2794
elif (not self.case_sensitive
2795
and from_rel.lower() == to_rel.lower()
2796
and self.has_filename(from_rel)):
2797
only_change_inv = False
2799
# something is wrong, so lets determine what exactly
2800
if not self.has_filename(from_rel) and \
2801
not self.has_filename(to_rel):
2802
raise errors.BzrRenameFailedError(from_rel, to_rel,
2803
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2805
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2806
rename_entry.only_change_inv = only_change_inv
2807
return rename_entries
2809
def _move(self, rename_entries):
2810
"""Moves a list of files.
2812
Depending on the value of the flag 'only_change_inv', the
2813
file will be moved on the file system or not.
2817
for entry in rename_entries:
2819
self._move_entry(entry)
2821
self._rollback_move(moved)
2825
def _rollback_move(self, moved):
2826
"""Try to rollback a previous move in case of an filesystem error."""
2829
self._move_entry(WorkingTree._RenameEntry(
2830
entry.to_rel, entry.from_id,
2831
entry.to_tail, entry.to_parent_id, entry.from_rel,
2832
entry.from_tail, entry.from_parent_id,
2833
entry.only_change_inv))
2834
except errors.BzrMoveFailedError, e:
2835
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2836
" The working tree is in an inconsistent state."
2837
" Please consider doing a 'bzr revert'."
2838
" Error message is: %s" % e)
2840
def _move_entry(self, entry):
2841
inv = self.inventory
2842
from_rel_abs = self.abspath(entry.from_rel)
2843
to_rel_abs = self.abspath(entry.to_rel)
2844
if from_rel_abs == to_rel_abs:
2845
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2846
"Source and target are identical.")
2848
if not entry.only_change_inv:
2850
osutils.rename(from_rel_abs, to_rel_abs)
2852
raise errors.BzrMoveFailedError(entry.from_rel,
2855
to_id = inv.path2id(entry.to_rel)
2856
inv.remove_recursive_id(to_id)
2857
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2859
@needs_tree_write_lock
2860
def unversion(self, file_ids):
2861
"""Remove the file ids in file_ids from the current versioned set.
2863
When a file_id is unversioned, all of its children are automatically
2866
:param file_ids: The file ids to stop versioning.
2867
:raises: NoSuchId if any fileid is not currently versioned.
2869
for file_id in file_ids:
2870
if not self._inventory.has_id(file_id):
2871
raise errors.NoSuchId(self, file_id)
2872
for file_id in file_ids:
2873
if self._inventory.has_id(file_id):
2874
self._inventory.remove_recursive_id(file_id)
2876
# in the future this should just set a dirty bit to wait for the
2877
# final unlock. However, until all methods of workingtree start
2878
# with the current in -memory inventory rather than triggering
2879
# a read, it is more complex - we need to teach read_inventory
2880
# to know when to read, and when to not read first... and possibly
2881
# to save first when the in memory one may be corrupted.
2882
# so for now, we just only write it if it is indeed dirty.
2884
self._write_inventory(self._inventory)
2886
def stored_kind(self, file_id):
2887
"""See Tree.stored_kind"""
2888
inv, inv_file_id = self._unpack_file_id(file_id)
2889
return inv[inv_file_id].kind
2892
"""Yield all unversioned files in this WorkingTree.
2894
If there are any unversioned directories then only the directory is
2895
returned, not all its children. But if there are unversioned files
2896
under a versioned subdirectory, they are returned.
2898
Currently returned depth-first, sorted by name within directories.
2899
This is the same order used by 'osutils.walkdirs'.
2901
## TODO: Work from given directory downwards
2902
for path, dir_entry in self.inventory.directories():
2903
# mutter("search for unknowns in %r", path)
2904
dirabs = self.abspath(path)
2905
if not isdir(dirabs):
2906
# e.g. directory deleted
2910
for subf in os.listdir(dirabs):
2911
if self.bzrdir.is_control_filename(subf):
2913
if subf not in dir_entry.children:
2916
can_access) = osutils.normalized_filename(subf)
2917
except UnicodeDecodeError:
2918
path_os_enc = path.encode(osutils._fs_enc)
2919
relpath = path_os_enc + '/' + subf
2920
raise errors.BadFilenameEncoding(relpath,
2922
if subf_norm != subf and can_access:
2923
if subf_norm not in dir_entry.children:
2924
fl.append(subf_norm)
2930
subp = pathjoin(path, subf)
2933
def _walkdirs(self, prefix=""):
2934
"""Walk the directories of this tree.
2936
:param prefix: is used as the directrory to start with.
2937
:returns: a generator which yields items in the form::
2939
((curren_directory_path, fileid),
2940
[(file1_path, file1_name, file1_kind, None, file1_id,
2943
_directory = 'directory'
2944
# get the root in the inventory
2945
inv, top_id = self._path2inv_file_id(prefix)
2949
pending = [(prefix, '', _directory, None, top_id, None)]
2952
currentdir = pending.pop()
2953
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2954
top_id = currentdir[4]
2956
relroot = currentdir[0] + '/'
2959
# FIXME: stash the node in pending
2961
if entry.kind == 'directory':
2962
for name, child in entry.sorted_children():
2963
dirblock.append((relroot + name, name, child.kind, None,
2964
child.file_id, child.kind
2966
yield (currentdir[0], entry.file_id), dirblock
2967
# push the user specified dirs from dirblock
2968
for dir in reversed(dirblock):
2969
if dir[2] == _directory:
2973
def update_feature_flags(self, updated_flags):
2974
"""Update the feature flags for this branch.
2976
:param updated_flags: Dictionary mapping feature names to necessities
2977
A necessity can be None to indicate the feature should be removed
2979
self._format._update_feature_flags(updated_flags)
2980
self.control_transport.put_bytes('format', self._format.as_string())
2983
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2984
"""Registry for working tree formats."""
2986
def __init__(self, other_registry=None):
2987
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2988
self._default_format = None
2989
self._default_format_key = None
2991
def get_default(self):
2992
"""Return the current default format."""
2993
if (self._default_format_key is not None and
2994
self._default_format is None):
2995
self._default_format = self.get(self._default_format_key)
2996
return self._default_format
2998
def set_default(self, format):
2999
"""Set the default format."""
3000
self._default_format = format
3001
self._default_format_key = None
3003
def set_default_key(self, format_string):
3004
"""Set the default format by its format string."""
3005
self._default_format_key = format_string
3006
self._default_format = None
3009
format_registry = WorkingTreeFormatRegistry()
3012
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
3013
"""An encapsulation of the initialization and open routines for a format.
2752
3015
Formats provide three things:
3095
@symbol_versioning.deprecated_method(
3096
symbol_versioning.deprecated_in((2, 4, 0)))
2827
3097
def register_format(klass, format):
2828
klass._formats[format.get_format_string()] = format
3098
format_registry.register(format)
3101
@symbol_versioning.deprecated_method(
3102
symbol_versioning.deprecated_in((2, 4, 0)))
3103
def register_extra_format(klass, format):
3104
format_registry.register_extra(format)
3107
@symbol_versioning.deprecated_method(
3108
symbol_versioning.deprecated_in((2, 4, 0)))
3109
def unregister_extra_format(klass, format):
3110
format_registry.unregister_extra(format)
3113
@symbol_versioning.deprecated_method(
3114
symbol_versioning.deprecated_in((2, 4, 0)))
3115
def get_formats(klass):
3116
return format_registry._get_all()
3119
@symbol_versioning.deprecated_method(
3120
symbol_versioning.deprecated_in((2, 4, 0)))
2831
3121
def set_default_format(klass, format):
2832
klass._default_format = format
3122
format_registry.set_default(format)
3125
@symbol_versioning.deprecated_method(
3126
symbol_versioning.deprecated_in((2, 4, 0)))
2835
3127
def unregister_format(klass, format):
2836
del klass._formats[format.get_format_string()]
2839
class WorkingTreeFormat2(WorkingTreeFormat):
2840
"""The second working tree format.
2842
This format modified the hash cache from the format 1 hash cache.
2845
upgrade_recommended = True
2847
def get_format_description(self):
2848
"""See WorkingTreeFormat.get_format_description()."""
2849
return "Working tree format 2"
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
2854
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
no working tree. (See bug #43064).
2859
inv = inventory.Inventory()
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
2867
"""See WorkingTreeFormat.initialize()."""
2868
if not isinstance(a_bzrdir.transport, LocalTransport):
2869
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
if from_branch is not None:
2871
branch = from_branch
2873
branch = a_bzrdir.open_branch()
2874
if revision_id is None:
2875
revision_id = _mod_revision.ensure_null(branch.last_revision())
2878
branch.generate_revision_history(revision_id)
2881
inv = inventory.Inventory()
2882
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2888
basis_tree = branch.repository.revision_tree(revision_id)
2889
if basis_tree.inventory.root is not None:
2890
wt.set_root_id(basis_tree.get_root_id())
2891
# set the parent list and cache the basis tree.
2892
if _mod_revision.is_null(revision_id):
2895
parent_trees = [(revision_id, basis_tree)]
2896
wt.set_parent_trees(parent_trees)
2897
transform.build_tree(basis_tree, wt)
2901
super(WorkingTreeFormat2, self).__init__()
2902
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2904
def open(self, a_bzrdir, _found=False):
2905
"""Return the WorkingTree object for a_bzrdir
2907
_found is a private parameter, do not use it. It is used to indicate
2908
if format probing has already been done.
2911
# we are being called directly and must probe.
2912
raise NotImplementedError
2913
if not isinstance(a_bzrdir.transport, LocalTransport):
2914
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2921
class WorkingTreeFormat3(WorkingTreeFormat):
2922
"""The second working tree format updated to record a format marker.
2925
- exists within a metadir controlling .bzr
2926
- includes an explicit version marker for the workingtree control
2927
files, separate from the BzrDir format
2928
- modifies the hash cache format
2930
- uses a LockDir to guard access for writes.
2933
upgrade_recommended = True
2935
def get_format_string(self):
2936
"""See WorkingTreeFormat.get_format_string()."""
2937
return "Bazaar-NG Working Tree format 3"
2939
def get_format_description(self):
2940
"""See WorkingTreeFormat.get_format_description()."""
2941
return "Working tree format 3"
2943
_lock_file_name = 'lock'
2944
_lock_class = LockDir
2946
_tree_class = WorkingTree3
2948
def __get_matchingbzrdir(self):
2949
return bzrdir.BzrDirMetaFormat1()
2951
_matchingbzrdir = property(__get_matchingbzrdir)
2953
def _open_control_files(self, a_bzrdir):
2954
transport = a_bzrdir.get_workingtree_transport(None)
2955
return LockableFiles(transport, self._lock_file_name,
2958
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
accelerator_tree=None, hardlink=False):
2960
"""See WorkingTreeFormat.initialize().
2962
:param revision_id: if supplied, create a working tree at a different
2963
revision than the branch is at.
2964
:param accelerator_tree: A tree which can be used for retrieving file
2965
contents more quickly than the revision tree, i.e. a workingtree.
2966
The revision tree will be used for cases where accelerator_tree's
2967
content is different.
2968
:param hardlink: If true, hard-link files from accelerator_tree,
2971
if not isinstance(a_bzrdir.transport, LocalTransport):
2972
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2973
transport = a_bzrdir.get_workingtree_transport(self)
2974
control_files = self._open_control_files(a_bzrdir)
2975
control_files.create_lock()
2976
control_files.lock_write()
2977
transport.put_bytes('format', self.get_format_string(),
2978
mode=a_bzrdir._get_file_mode())
2979
if from_branch is not None:
2980
branch = from_branch
2982
branch = a_bzrdir.open_branch()
2983
if revision_id is None:
2984
revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
# WorkingTree3 can handle an inventory which has a unique root id.
2986
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
# those trees. And because there isn't a format bump inbetween, we
2988
# are maintaining compatibility with older clients.
2989
# inv = Inventory(root_id=gen_root_id())
2990
inv = self._initial_inventory()
2991
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2997
_control_files=control_files)
2998
wt.lock_tree_write()
3000
basis_tree = branch.repository.revision_tree(revision_id)
3001
# only set an explicit root id if there is one to set.
3002
if basis_tree.inventory.root is not None:
3003
wt.set_root_id(basis_tree.get_root_id())
3004
if revision_id == _mod_revision.NULL_REVISION:
3005
wt.set_parent_trees([])
3007
wt.set_parent_trees([(revision_id, basis_tree)])
3008
transform.build_tree(basis_tree, wt)
3010
# Unlock in this order so that the unlock-triggers-flush in
3011
# WorkingTree is given a chance to fire.
3012
control_files.unlock()
3016
def _initial_inventory(self):
3017
return inventory.Inventory()
3020
super(WorkingTreeFormat3, self).__init__()
3022
def open(self, a_bzrdir, _found=False):
3023
"""Return the WorkingTree object for a_bzrdir
3025
_found is a private parameter, do not use it. It is used to indicate
3026
if format probing has already been done.
3029
# we are being called directly and must probe.
3030
raise NotImplementedError
3031
if not isinstance(a_bzrdir.transport, LocalTransport):
3032
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3036
def _open(self, a_bzrdir, control_files):
3037
"""Open the tree itself.
3039
:param a_bzrdir: the dir for the tree.
3040
:param control_files: the control files for the tree.
3042
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3046
_control_files=control_files)
3049
return self.get_format_string()
3052
__default_format = WorkingTreeFormat6()
3053
WorkingTreeFormat.register_format(__default_format)
3054
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
WorkingTreeFormat.set_default_format(__default_format)
3058
# formats which have no format string are not discoverable
3059
# and not independently creatable, so are not registered.
3060
_legacy_formats = [WorkingTreeFormat2(),
3128
format_registry.remove(format)
3130
def get_controldir_for_branch(self):
3131
"""Get the control directory format for creating branches.
3133
This is to support testing of working tree formats that can not exist
3134
in the same control directory as a branch.
3136
return self._matchingbzrdir
3139
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3140
"""Base class for working trees that live in bzr meta directories."""
3143
WorkingTreeFormat.__init__(self)
3144
bzrdir.BzrFormat.__init__(self)
3147
def find_format_string(klass, controldir):
3148
"""Return format name for the working tree object in controldir."""
3150
transport = controldir.get_workingtree_transport(None)
3151
return transport.get_bytes("format")
3152
except errors.NoSuchFile:
3153
raise errors.NoWorkingTree(base=transport.base)
3156
def find_format(klass, controldir):
3157
"""Return the format for the working tree object in controldir."""
3158
format_string = klass.find_format_string(controldir)
3159
return klass._find_format(format_registry, 'working tree',
3162
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3164
WorkingTreeFormat.check_support_status(self,
3165
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3167
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3168
recommend_upgrade=recommend_upgrade, basedir=basedir)
3171
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3172
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3173
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3174
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3175
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3176
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3177
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3178
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3179
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
