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
if not self.inventory.has_id(file_id):
2074
path = self.inventory.id2path(file_id)
2075
return osutils.lexists(self.abspath(path))
2077
def has_or_had_id(self, file_id):
2078
if file_id == self.inventory.root.file_id:
2080
return self.inventory.has_id(file_id)
2082
def all_file_ids(self):
2083
"""Iterate through file_ids for this tree.
2085
file_ids are in a WorkingTree if they are in the working inventory
2086
and the working file exists.
2089
for path, ie in self.iter_entries_by_dir():
2093
@needs_tree_write_lock
2094
def set_last_revision(self, new_revision):
2095
"""Change the last revision in the working tree."""
2096
if self._change_last_revision(new_revision):
2097
self._cache_basis_inventory(new_revision)
2099
def _get_check_refs(self):
2100
"""Return the references needed to perform a check of this tree.
2102
The default implementation returns no refs, and is only suitable for
2103
trees that have no local caching and can commit on ghosts at any time.
2105
:seealso: bzrlib.check for details about check_refs.
2110
def _check(self, references):
2111
"""Check the tree for consistency.
2113
:param references: A dict with keys matching the items returned by
2114
self._get_check_refs(), and values from looking those keys up in
2117
tree_basis = self.basis_tree()
2118
tree_basis.lock_read()
2120
repo_basis = references[('trees', self.last_revision())]
2121
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2122
raise errors.BzrCheckError(
2123
"Mismatched basis inventory content.")
2129
def check_state(self):
2130
"""Check that the working state is/isn't valid."""
2131
check_refs = self._get_check_refs()
2133
for ref in check_refs:
2136
refs[ref] = self.branch.repository.revision_tree(value)
2139
@needs_tree_write_lock
2140
def reset_state(self, revision_ids=None):
2141
"""Reset the state of the working tree.
2143
This does a hard-reset to a last-known-good state. This is a way to
2144
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2146
if revision_ids is None:
2147
revision_ids = self.get_parent_ids()
2148
if not revision_ids:
2149
rt = self.branch.repository.revision_tree(
2150
_mod_revision.NULL_REVISION)
2152
rt = self.branch.repository.revision_tree(revision_ids[0])
2153
self._write_inventory(rt.inventory)
2154
self.set_parent_ids(revision_ids)
2157
"""Write the in memory inventory to disk."""
2158
# TODO: Maybe this should only write on dirty ?
2159
if self._control_files._lock_mode != 'w':
2160
raise errors.NotWriteLocked(self)
2162
self._serialize(self._inventory, sio)
2164
self._transport.put_file('inventory', sio,
2165
mode=self.bzrdir._get_file_mode())
2166
self._inventory_is_modified = False
2168
def get_file_mtime(self, file_id, path=None):
2169
"""See Tree.get_file_mtime."""
2171
path = self.id2path(file_id)
2173
return os.lstat(self.abspath(path)).st_mtime
2175
if e.errno == errno.ENOENT:
2176
raise errors.FileTimestampUnavailable(path)
2179
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2180
file_id = self.path2id(path)
2182
# For unversioned files on win32, we just assume they are not
2185
return self.inventory[file_id].executable
2187
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2188
mode = stat_result.st_mode
2189
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2191
def is_executable(self, file_id, path=None):
2192
if not self._supports_executable():
2193
return self.inventory[file_id].executable
2196
path = self.id2path(file_id)
2197
mode = os.lstat(self.abspath(path)).st_mode
2198
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2200
def _is_executable_from_path_and_stat(self, path, stat_result):
2201
if not self._supports_executable():
2202
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2204
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2206
@needs_tree_write_lock
2207
def _add(self, files, ids, kinds):
2208
"""See MutableTree._add."""
2209
# TODO: Re-adding a file that is removed in the working copy
2210
# should probably put it back with the previous ID.
2211
# the read and write working inventory should not occur in this
2212
# function - they should be part of lock_write and unlock.
2213
inv = self.inventory
2214
for f, file_id, kind in zip(files, ids, kinds):
2216
inv.add_path(f, kind=kind)
2218
inv.add_path(f, kind=kind, file_id=file_id)
2219
self._inventory_is_modified = True
2221
def revision_tree(self, revision_id):
2222
"""See WorkingTree.revision_id."""
2223
if revision_id == self.last_revision():
2225
xml = self.read_basis_inventory()
2226
except errors.NoSuchFile:
2230
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2231
# dont use the repository revision_tree api because we want
2232
# to supply the inventory.
2233
if inv.revision_id == revision_id:
2234
return revisiontree.InventoryRevisionTree(
2235
self.branch.repository, inv, revision_id)
2236
except errors.BadInventoryFormat:
2238
# raise if there was no inventory, or if we read the wrong inventory.
2239
raise errors.NoSuchRevisionInTree(self, revision_id)
2242
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2243
"""See Tree.annotate_iter
2245
This implementation will use the basis tree implementation if possible.
2246
Lines not in the basis are attributed to CURRENT_REVISION
2248
If there are pending merges, lines added by those merges will be
2249
incorrectly attributed to CURRENT_REVISION (but after committing, the
2250
attribution will be correct).
2252
maybe_file_parent_keys = []
2253
for parent_id in self.get_parent_ids():
2255
parent_tree = self.revision_tree(parent_id)
2256
except errors.NoSuchRevisionInTree:
2257
parent_tree = self.branch.repository.revision_tree(parent_id)
2258
parent_tree.lock_read()
2261
kind = parent_tree.kind(file_id)
2262
except errors.NoSuchId:
2265
# Note: this is slightly unnecessary, because symlinks and
2266
# directories have a "text" which is the empty text, and we
2267
# know that won't mess up annotations. But it seems cleaner
2270
file_id, parent_tree.get_file_revision(file_id))
2271
if parent_text_key not in maybe_file_parent_keys:
2272
maybe_file_parent_keys.append(parent_text_key)
2274
parent_tree.unlock()
2275
graph = _mod_graph.Graph(self.branch.repository.texts)
2276
heads = graph.heads(maybe_file_parent_keys)
2277
file_parent_keys = []
2278
for key in maybe_file_parent_keys:
2280
file_parent_keys.append(key)
2282
# Now we have the parents of this content
2283
annotator = self.branch.repository.texts.get_annotator()
2284
text = self.get_file_text(file_id)
2285
this_key =(file_id, default_revision)
2286
annotator.add_special_text(this_key, file_parent_keys, text)
2287
annotations = [(key[-1], line)
2288
for key, line in annotator.annotate_flat(this_key)]
2291
def _put_rio(self, filename, stanzas, header):
2292
self._must_be_locked()
2293
my_file = _mod_rio.rio_file(stanzas, header)
2294
self._transport.put_file(filename, my_file,
2295
mode=self.bzrdir._get_file_mode())
2297
@needs_tree_write_lock
2298
def set_merge_modified(self, modified_hashes):
2300
for file_id, hash in modified_hashes.iteritems():
2301
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2303
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2306
def merge_modified(self):
2307
"""Return a dictionary of files modified by a merge.
2309
The list is initialized by WorkingTree.set_merge_modified, which is
2310
typically called after we make some automatic updates to the tree
2313
This returns a map of file_id->sha1, containing only files which are
2314
still in the working inventory and have that text hash.
2317
hashfile = self._transport.get('merge-hashes')
2318
except errors.NoSuchFile:
2323
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2324
raise errors.MergeModifiedFormatError()
2325
except StopIteration:
2326
raise errors.MergeModifiedFormatError()
2327
for s in _mod_rio.RioReader(hashfile):
2328
# RioReader reads in Unicode, so convert file_ids back to utf8
2329
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2330
if not self.has_id(file_id):
2332
text_hash = s.get("hash")
2333
if text_hash == self.get_file_sha1(file_id):
2334
merge_hashes[file_id] = text_hash
2340
def subsume(self, other_tree):
2341
def add_children(inventory, entry):
2342
for child_entry in entry.children.values():
2343
inventory._byid[child_entry.file_id] = child_entry
2344
if child_entry.kind == 'directory':
2345
add_children(inventory, child_entry)
2346
if other_tree.get_root_id() == self.get_root_id():
2347
raise errors.BadSubsumeSource(self, other_tree,
2348
'Trees have the same root')
2350
other_tree_path = self.relpath(other_tree.basedir)
2351
except errors.PathNotChild:
2352
raise errors.BadSubsumeSource(self, other_tree,
2353
'Tree is not contained by the other')
2354
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2355
if new_root_parent is None:
2356
raise errors.BadSubsumeSource(self, other_tree,
2357
'Parent directory is not versioned.')
2358
# We need to ensure that the result of a fetch will have a
2359
# versionedfile for the other_tree root, and only fetching into
2360
# RepositoryKnit2 guarantees that.
2361
if not self.branch.repository.supports_rich_root():
2362
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2363
other_tree.lock_tree_write()
2365
new_parents = other_tree.get_parent_ids()
2366
other_root = other_tree.inventory.root
2367
other_root.parent_id = new_root_parent
2368
other_root.name = osutils.basename(other_tree_path)
2369
self.inventory.add(other_root)
2370
add_children(self.inventory, other_root)
2371
self._write_inventory(self.inventory)
2372
# normally we don't want to fetch whole repositories, but i think
2373
# here we really do want to consolidate the whole thing.
2374
for parent_id in other_tree.get_parent_ids():
2375
self.branch.fetch(other_tree.branch, parent_id)
2376
self.add_parent_tree_id(parent_id)
2379
other_tree.bzrdir.retire_bzrdir()
2381
@needs_tree_write_lock
2382
def extract(self, file_id, format=None):
2383
"""Extract a subtree from this tree.
2385
A new branch will be created, relative to the path for this tree.
2389
segments = osutils.splitpath(path)
2390
transport = self.branch.bzrdir.root_transport
2391
for name in segments:
2392
transport = transport.clone(name)
2393
transport.ensure_base()
2396
sub_path = self.id2path(file_id)
2397
branch_transport = mkdirs(sub_path)
2399
format = self.bzrdir.cloning_metadir()
2400
branch_transport.ensure_base()
2401
branch_bzrdir = format.initialize_on_transport(branch_transport)
2403
repo = branch_bzrdir.find_repository()
2404
except errors.NoRepositoryPresent:
2405
repo = branch_bzrdir.create_repository()
2406
if not repo.supports_rich_root():
2407
raise errors.RootNotRich()
2408
new_branch = branch_bzrdir.create_branch()
2409
new_branch.pull(self.branch)
2410
for parent_id in self.get_parent_ids():
2411
new_branch.fetch(self.branch, parent_id)
2412
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2413
if tree_transport.base != branch_transport.base:
2414
tree_bzrdir = format.initialize_on_transport(tree_transport)
2415
tree_bzrdir.set_branch_reference(new_branch)
2417
tree_bzrdir = branch_bzrdir
2418
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2419
wt.set_parent_ids(self.get_parent_ids())
2420
my_inv = self.inventory
2421
child_inv = inventory.Inventory(root_id=None)
2422
new_root = my_inv[file_id]
2423
my_inv.remove_recursive_id(file_id)
2424
new_root.parent_id = None
2425
child_inv.add(new_root)
2426
self._write_inventory(my_inv)
2427
wt._write_inventory(child_inv)
2430
def list_files(self, include_root=False, from_dir=None, recursive=True):
2431
"""List all files as (path, class, kind, id, entry).
2433
Lists, but does not descend into unversioned directories.
2434
This does not include files that have been deleted in this
2435
tree. Skips the control directory.
2437
:param include_root: if True, return an entry for the root
2438
:param from_dir: start from this directory or None for the root
2439
:param recursive: whether to recurse into subdirectories or not
2441
# list_files is an iterator, so @needs_read_lock doesn't work properly
2442
# with it. So callers should be careful to always read_lock the tree.
2443
if not self.is_locked():
2444
raise errors.ObjectNotLocked(self)
2446
if from_dir is None and include_root is True:
2447
yield ('', 'V', 'directory', self.get_root_id(), self.inventory.root)
2448
# Convert these into local objects to save lookup times
2449
pathjoin = osutils.pathjoin
2450
file_kind = self._kind
2452
# transport.base ends in a slash, we want the piece
2453
# between the last two slashes
2454
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2456
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2458
# directory file_id, relative path, absolute path, reverse sorted children
2459
if from_dir is not None:
2460
inv = self.inventory
2461
from_dir_id = self.path2id(from_dir)
2462
if from_dir_id is None:
2463
# Directory not versioned
2465
from_dir_abspath = pathjoin(self.basedir, from_dir)
2467
inv = self.inventory
2468
from_dir_id = inv.root.file_id
2469
from_dir_abspath = self.basedir
2470
children = os.listdir(from_dir_abspath)
2472
# jam 20060527 The kernel sized tree seems equivalent whether we
2473
# use a deque and popleft to keep them sorted, or if we use a plain
2474
# list and just reverse() them.
2475
children = collections.deque(children)
2476
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2478
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2481
f = children.popleft()
2482
## TODO: If we find a subdirectory with its own .bzr
2483
## directory, then that is a separate tree and we
2484
## should exclude it.
2486
# the bzrdir for this tree
2487
if transport_base_dir == f:
2490
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2491
# and 'f' doesn't begin with one, we can do a string op, rather
2492
# than the checks of pathjoin(), all relative paths will have an extra slash
2494
fp = from_dir_relpath + '/' + f
2497
fap = from_dir_abspath + '/' + f
2499
dir_ie = inv[from_dir_id]
2500
if dir_ie.kind == 'directory':
2501
f_ie = dir_ie.children.get(f)
2506
elif self.is_ignored(fp[1:]):
2509
# we may not have found this file, because of a unicode
2510
# issue, or because the directory was actually a symlink.
2511
f_norm, can_access = osutils.normalized_filename(f)
2512
if f == f_norm or not can_access:
2513
# No change, so treat this file normally
2516
# this file can be accessed by a normalized path
2517
# check again if it is versioned
2518
# these lines are repeated here for performance
2520
fp = from_dir_relpath + '/' + f
2521
fap = from_dir_abspath + '/' + f
2522
f_ie = inv.get_child(from_dir_id, f)
2525
elif self.is_ignored(fp[1:]):
2532
# make a last minute entry
2534
yield fp[1:], c, fk, f_ie.file_id, f_ie
2537
yield fp[1:], c, fk, None, fk_entries[fk]()
2539
yield fp[1:], c, fk, None, TreeEntry()
2542
if fk != 'directory':
2545
# But do this child first if recursing down
2547
new_children = os.listdir(fap)
2549
new_children = collections.deque(new_children)
2550
stack.append((f_ie.file_id, fp, fap, new_children))
2551
# Break out of inner loop,
2552
# so that we start outer loop with child
2555
# if we finished all children, pop it off the stack
2558
@needs_tree_write_lock
2559
def move(self, from_paths, to_dir=None, after=False):
2562
to_dir must exist in the inventory.
2564
If to_dir exists and is a directory, the files are moved into
2565
it, keeping their old names.
2567
Note that to_dir is only the last component of the new name;
2568
this doesn't change the directory.
2570
For each entry in from_paths the move mode will be determined
2573
The first mode moves the file in the filesystem and updates the
2574
inventory. The second mode only updates the inventory without
2575
touching the file on the filesystem.
2577
move uses the second mode if 'after == True' and the target is
2578
either not versioned or newly added, and present in the working tree.
2580
move uses the second mode if 'after == False' and the source is
2581
versioned but no longer in the working tree, and the target is not
2582
versioned but present in the working tree.
2584
move uses the first mode if 'after == False' and the source is
2585
versioned and present in the working tree, and the target is not
2586
versioned and not present in the working tree.
2588
Everything else results in an error.
2590
This returns a list of (from_path, to_path) pairs for each
2591
entry that is moved.
2596
# check for deprecated use of signature
2598
raise TypeError('You must supply a target directory')
2599
# check destination directory
2600
if isinstance(from_paths, basestring):
2602
to_abs = self.abspath(to_dir)
2603
if not isdir(to_abs):
2604
raise errors.BzrMoveFailedError('',to_dir,
2605
errors.NotADirectory(to_abs))
2606
if not self.has_filename(to_dir):
2607
raise errors.BzrMoveFailedError('',to_dir,
2608
errors.NotInWorkingDirectory(to_dir))
2609
to_dir_id = self.path2id(to_dir)
2610
if to_dir_id is None:
2611
raise errors.BzrMoveFailedError('',to_dir,
2612
errors.NotVersionedError(path=to_dir))
2614
to_dir_ie = self.inventory[to_dir_id]
2615
if to_dir_ie.kind != 'directory':
2616
raise errors.BzrMoveFailedError('',to_dir,
2617
errors.NotADirectory(to_abs))
2619
# create rename entries and tuples
2620
for from_rel in from_paths:
2621
from_tail = splitpath(from_rel)[-1]
2622
from_id = self.path2id(from_rel)
2624
raise errors.BzrMoveFailedError(from_rel,to_dir,
2625
errors.NotVersionedError(path=from_rel))
2627
from_entry = self.inventory[from_id]
2628
from_parent_id = from_entry.parent_id
2629
to_rel = pathjoin(to_dir, from_tail)
2630
rename_entry = InventoryWorkingTree._RenameEntry(
2633
from_tail=from_tail,
2634
from_parent_id=from_parent_id,
2635
to_rel=to_rel, to_tail=from_tail,
2636
to_parent_id=to_dir_id)
2637
rename_entries.append(rename_entry)
2638
rename_tuples.append((from_rel, to_rel))
2640
# determine which move mode to use. checks also for movability
2641
rename_entries = self._determine_mv_mode(rename_entries, after)
2643
original_modified = self._inventory_is_modified
2646
self._inventory_is_modified = True
2647
self._move(rename_entries)
2649
# restore the inventory on error
2650
self._inventory_is_modified = original_modified
2652
self._write_inventory(self.inventory)
2653
return rename_tuples
2655
@needs_tree_write_lock
2656
def rename_one(self, from_rel, to_rel, after=False):
2659
This can change the directory or the filename or both.
2661
rename_one has several 'modes' to work. First, it can rename a physical
2662
file and change the file_id. That is the normal mode. Second, it can
2663
only change the file_id without touching any physical file.
2665
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2666
versioned but present in the working tree.
2668
rename_one uses the second mode if 'after == False' and 'from_rel' is
2669
versioned but no longer in the working tree, and 'to_rel' is not
2670
versioned but present in the working tree.
2672
rename_one uses the first mode if 'after == False' and 'from_rel' is
2673
versioned and present in the working tree, and 'to_rel' is not
2674
versioned and not present in the working tree.
2676
Everything else results in an error.
2680
# create rename entries and tuples
2681
from_tail = splitpath(from_rel)[-1]
2682
from_id = self.path2id(from_rel)
2684
# if file is missing in the inventory maybe it's in the basis_tree
2685
basis_tree = self.branch.basis_tree()
2686
from_id = basis_tree.path2id(from_rel)
2688
raise errors.BzrRenameFailedError(from_rel,to_rel,
2689
errors.NotVersionedError(path=from_rel))
2690
# put entry back in the inventory so we can rename it
2691
from_entry = basis_tree.inventory[from_id].copy()
2692
self.inventory.add(from_entry)
2694
from_entry = self.inventory[from_id]
2695
from_parent_id = from_entry.parent_id
2696
to_dir, to_tail = os.path.split(to_rel)
2697
to_dir_id = self.path2id(to_dir)
2698
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2700
from_tail=from_tail,
2701
from_parent_id=from_parent_id,
2702
to_rel=to_rel, to_tail=to_tail,
2703
to_parent_id=to_dir_id)
2704
rename_entries.append(rename_entry)
2706
# determine which move mode to use. checks also for movability
2707
rename_entries = self._determine_mv_mode(rename_entries, after)
2709
# check if the target changed directory and if the target directory is
2711
if to_dir_id is None:
2712
raise errors.BzrMoveFailedError(from_rel,to_rel,
2713
errors.NotVersionedError(path=to_dir))
2715
# all checks done. now we can continue with our actual work
2716
mutter('rename_one:\n'
2721
' to_dir_id {%s}\n',
2722
from_id, from_rel, to_rel, to_dir, to_dir_id)
2724
self._move(rename_entries)
2725
self._write_inventory(self.inventory)
2727
class _RenameEntry(object):
2728
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2729
to_rel, to_tail, to_parent_id, only_change_inv=False,
2731
self.from_rel = from_rel
2732
self.from_id = from_id
2733
self.from_tail = from_tail
2734
self.from_parent_id = from_parent_id
2735
self.to_rel = to_rel
2736
self.to_tail = to_tail
2737
self.to_parent_id = to_parent_id
2738
self.change_id = change_id
2739
self.only_change_inv = only_change_inv
2741
def _determine_mv_mode(self, rename_entries, after=False):
2742
"""Determines for each from-to pair if both inventory and working tree
2743
or only the inventory has to be changed.
2745
Also does basic plausability tests.
2747
inv = self.inventory
2749
for rename_entry in rename_entries:
2750
# store to local variables for easier reference
2751
from_rel = rename_entry.from_rel
2752
from_id = rename_entry.from_id
2753
to_rel = rename_entry.to_rel
2754
to_id = inv.path2id(to_rel)
2755
only_change_inv = False
2758
# check the inventory for source and destination
2760
raise errors.BzrMoveFailedError(from_rel,to_rel,
2761
errors.NotVersionedError(path=from_rel))
2762
if to_id is not None:
2764
# allow it with --after but only if dest is newly added
2766
basis = self.basis_tree()
2769
if not basis.has_id(to_id):
2770
rename_entry.change_id = True
2775
raise errors.BzrMoveFailedError(from_rel,to_rel,
2776
errors.AlreadyVersionedError(path=to_rel))
2778
# try to determine the mode for rename (only change inv or change
2779
# inv and file system)
2781
if not self.has_filename(to_rel):
2782
raise errors.BzrMoveFailedError(from_id,to_rel,
2783
errors.NoSuchFile(path=to_rel,
2784
extra="New file has not been created yet"))
2785
only_change_inv = True
2786
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2787
only_change_inv = True
2788
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2789
only_change_inv = False
2790
elif (not self.case_sensitive
2791
and from_rel.lower() == to_rel.lower()
2792
and self.has_filename(from_rel)):
2793
only_change_inv = False
2795
# something is wrong, so lets determine what exactly
2796
if not self.has_filename(from_rel) and \
2797
not self.has_filename(to_rel):
2798
raise errors.BzrRenameFailedError(from_rel, to_rel,
2799
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2801
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2802
rename_entry.only_change_inv = only_change_inv
2803
return rename_entries
2805
def _move(self, rename_entries):
2806
"""Moves a list of files.
2808
Depending on the value of the flag 'only_change_inv', the
2809
file will be moved on the file system or not.
2813
for entry in rename_entries:
2815
self._move_entry(entry)
2817
self._rollback_move(moved)
2821
def _rollback_move(self, moved):
2822
"""Try to rollback a previous move in case of an filesystem error."""
2825
self._move_entry(WorkingTree._RenameEntry(
2826
entry.to_rel, entry.from_id,
2827
entry.to_tail, entry.to_parent_id, entry.from_rel,
2828
entry.from_tail, entry.from_parent_id,
2829
entry.only_change_inv))
2830
except errors.BzrMoveFailedError, e:
2831
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2832
" The working tree is in an inconsistent state."
2833
" Please consider doing a 'bzr revert'."
2834
" Error message is: %s" % e)
2836
def _move_entry(self, entry):
2837
inv = self.inventory
2838
from_rel_abs = self.abspath(entry.from_rel)
2839
to_rel_abs = self.abspath(entry.to_rel)
2840
if from_rel_abs == to_rel_abs:
2841
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2842
"Source and target are identical.")
2844
if not entry.only_change_inv:
2846
osutils.rename(from_rel_abs, to_rel_abs)
2848
raise errors.BzrMoveFailedError(entry.from_rel,
2851
to_id = inv.path2id(entry.to_rel)
2852
inv.remove_recursive_id(to_id)
2853
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2855
@needs_tree_write_lock
2856
def unversion(self, file_ids):
2857
"""Remove the file ids in file_ids from the current versioned set.
2859
When a file_id is unversioned, all of its children are automatically
2862
:param file_ids: The file ids to stop versioning.
2863
:raises: NoSuchId if any fileid is not currently versioned.
2865
for file_id in file_ids:
2866
if not self._inventory.has_id(file_id):
2867
raise errors.NoSuchId(self, file_id)
2868
for file_id in file_ids:
2869
if self._inventory.has_id(file_id):
2870
self._inventory.remove_recursive_id(file_id)
2872
# in the future this should just set a dirty bit to wait for the
2873
# final unlock. However, until all methods of workingtree start
2874
# with the current in -memory inventory rather than triggering
2875
# a read, it is more complex - we need to teach read_inventory
2876
# to know when to read, and when to not read first... and possibly
2877
# to save first when the in memory one may be corrupted.
2878
# so for now, we just only write it if it is indeed dirty.
2880
self._write_inventory(self._inventory)
2882
def stored_kind(self, file_id):
2883
"""See Tree.stored_kind"""
2884
return self.inventory[file_id].kind
2887
"""Yield all unversioned files in this WorkingTree.
2889
If there are any unversioned directories then only the directory is
2890
returned, not all its children. But if there are unversioned files
2891
under a versioned subdirectory, they are returned.
2893
Currently returned depth-first, sorted by name within directories.
2894
This is the same order used by 'osutils.walkdirs'.
2896
## TODO: Work from given directory downwards
2897
for path, dir_entry in self.inventory.directories():
2898
# mutter("search for unknowns in %r", path)
2899
dirabs = self.abspath(path)
2900
if not isdir(dirabs):
2901
# e.g. directory deleted
2905
for subf in os.listdir(dirabs):
2906
if self.bzrdir.is_control_filename(subf):
2908
if subf not in dir_entry.children:
2911
can_access) = osutils.normalized_filename(subf)
2912
except UnicodeDecodeError:
2913
path_os_enc = path.encode(osutils._fs_enc)
2914
relpath = path_os_enc + '/' + subf
2915
raise errors.BadFilenameEncoding(relpath,
2917
if subf_norm != subf and can_access:
2918
if subf_norm not in dir_entry.children:
2919
fl.append(subf_norm)
2925
subp = pathjoin(path, subf)
2928
def _walkdirs(self, prefix=""):
2929
"""Walk the directories of this tree.
2931
:param prefix: is used as the directrory to start with.
2932
:returns: a generator which yields items in the form::
2934
((curren_directory_path, fileid),
2935
[(file1_path, file1_name, file1_kind, None, file1_id,
2938
_directory = 'directory'
2939
# get the root in the inventory
2940
inv = self.inventory
2941
top_id = inv.path2id(prefix)
2945
pending = [(prefix, '', _directory, None, top_id, None)]
2948
currentdir = pending.pop()
2949
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2950
top_id = currentdir[4]
2952
relroot = currentdir[0] + '/'
2955
# FIXME: stash the node in pending
2957
if entry.kind == 'directory':
2958
for name, child in entry.sorted_children():
2959
dirblock.append((relroot + name, name, child.kind, None,
2960
child.file_id, child.kind
2962
yield (currentdir[0], entry.file_id), dirblock
2963
# push the user specified dirs from dirblock
2964
for dir in reversed(dirblock):
2965
if dir[2] == _directory:
2969
def update_feature_flags(self, updated_flags):
2970
"""Update the feature flags for this branch.
2972
:param updated_flags: Dictionary mapping feature names to necessities
2973
A necessity can be None to indicate the feature should be removed
2975
self._format._update_feature_flags(updated_flags)
2976
self.control_transport.put_bytes('format', self._format.as_string())
2979
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2980
"""Registry for working tree formats."""
2982
def __init__(self, other_registry=None):
2983
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2984
self._default_format = None
2985
self._default_format_key = None
2987
def get_default(self):
2988
"""Return the current default format."""
2989
if (self._default_format_key is not None and
2990
self._default_format is None):
2991
self._default_format = self.get(self._default_format_key)
2992
return self._default_format
2994
def set_default(self, format):
2995
"""Set the default format."""
2996
self._default_format = format
2997
self._default_format_key = None
2999
def set_default_key(self, format_string):
3000
"""Set the default format by its format string."""
3001
self._default_format_key = format_string
3002
self._default_format = None
3005
format_registry = WorkingTreeFormatRegistry()
3008
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
3009
"""An encapsulation of the initialization and open routines for a format.
2752
3011
Formats provide three things:
3091
@symbol_versioning.deprecated_method(
3092
symbol_versioning.deprecated_in((2, 4, 0)))
2827
3093
def register_format(klass, format):
2828
klass._formats[format.get_format_string()] = format
3094
format_registry.register(format)
3097
@symbol_versioning.deprecated_method(
3098
symbol_versioning.deprecated_in((2, 4, 0)))
3099
def register_extra_format(klass, format):
3100
format_registry.register_extra(format)
3103
@symbol_versioning.deprecated_method(
3104
symbol_versioning.deprecated_in((2, 4, 0)))
3105
def unregister_extra_format(klass, format):
3106
format_registry.unregister_extra(format)
3109
@symbol_versioning.deprecated_method(
3110
symbol_versioning.deprecated_in((2, 4, 0)))
3111
def get_formats(klass):
3112
return format_registry._get_all()
3115
@symbol_versioning.deprecated_method(
3116
symbol_versioning.deprecated_in((2, 4, 0)))
2831
3117
def set_default_format(klass, format):
2832
klass._default_format = format
3118
format_registry.set_default(format)
3121
@symbol_versioning.deprecated_method(
3122
symbol_versioning.deprecated_in((2, 4, 0)))
2835
3123
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(),
3124
format_registry.remove(format)
3126
def get_controldir_for_branch(self):
3127
"""Get the control directory format for creating branches.
3129
This is to support testing of working tree formats that can not exist
3130
in the same control directory as a branch.
3132
return self._matchingbzrdir
3135
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3136
"""Base class for working trees that live in bzr meta directories."""
3139
WorkingTreeFormat.__init__(self)
3140
bzrdir.BzrFormat.__init__(self)
3143
def find_format_string(klass, controldir):
3144
"""Return format name for the working tree object in controldir."""
3146
transport = controldir.get_workingtree_transport(None)
3147
return transport.get_bytes("format")
3148
except errors.NoSuchFile:
3149
raise errors.NoWorkingTree(base=transport.base)
3152
def find_format(klass, controldir):
3153
"""Return the format for the working tree object in controldir."""
3154
format_string = klass.find_format_string(controldir)
3155
return klass._find_format(format_registry, 'working tree',
3158
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3160
WorkingTreeFormat.check_support_status(self,
3161
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3163
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3164
recommend_upgrade=recommend_upgrade, basedir=basedir)
3167
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3168
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3169
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3170
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3171
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3172
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3173
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3174
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3175
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
