2605
1772
def get_shelf_manager(self):
2606
1773
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
1774
from .shelf import ShelfManager
2608
1775
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.
1778
class InventoryWorkingTree(WorkingTree,
1779
mutabletree.MutableInventoryTree):
1780
"""Base class for working trees that are inventory-oriented.
1782
The inventory is held in the `Branch` working-inventory, and the
1783
files are in a directory on disk.
1785
It is possible for a `WorkingTree` to have a filename which is
1786
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())]
1789
def __init__(self, basedir='.',
1790
branch=DEPRECATED_PARAMETER,
1792
_control_files=None,
1796
"""Construct a InventoryWorkingTree instance. This is not a public API.
1798
:param branch: A branch to override probing for the branch.
1800
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1801
branch=branch, _transport=_control_files._transport,
1802
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1804
self._control_files = _control_files
1805
self._detect_case_handling()
1807
if _inventory is None:
1808
# This will be acquired on lock_read() or lock_write()
1809
self._inventory_is_modified = False
1810
self._inventory = None
1812
# the caller of __init__ has provided an inventory,
1813
# we assume they know what they are doing - as its only
1814
# the Format factory and creation methods that are
1815
# permitted to do this.
1816
self._set_inventory(_inventory, dirty=False)
1818
def _set_inventory(self, inv, dirty):
1819
"""Set the internal cached inventory.
1821
:param inv: The inventory to set.
1822
:param dirty: A boolean indicating whether the inventory is the same
1823
logical inventory as whats on disk. If True the inventory is not
1824
the same and should be written to disk or data will be lost, if
1825
False then the inventory is the same as that on disk and any
1826
serialisation would be unneeded overhead.
1828
self._inventory = inv
1829
self._inventory_is_modified = dirty
1831
def _detect_case_handling(self):
1832
wt_trans = self.bzrdir.get_workingtree_transport(None)
1834
wt_trans.stat(self._format.case_sensitive_filename)
1835
except errors.NoSuchFile:
1836
self.case_sensitive = True
1838
self.case_sensitive = False
1840
self._setup_directory_is_tree_reference()
1842
def _serialize(self, inventory, out_file):
1843
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1846
def _deserialize(selt, in_file):
1847
return xml5.serializer_v5.read_inventory(in_file)
1849
def break_lock(self):
1850
"""Break a lock if one is present from another instance.
1852
Uses the ui factory to ask for confirmation if the lock may be from
1855
This will probe the repository for its lock as well.
1857
self._control_files.break_lock()
1858
self.branch.break_lock()
1860
def is_locked(self):
1861
return self._control_files.is_locked()
1863
def _must_be_locked(self):
1864
if not self.is_locked():
1865
raise errors.ObjectNotLocked(self)
1867
def lock_read(self):
1868
"""Lock the tree for reading.
1870
This also locks the branch, and can be unlocked via self.unlock().
1872
:return: A breezy.lock.LogicalLockResult.
1874
if not self.is_locked():
1876
self.branch.lock_read()
1878
self._control_files.lock_read()
1879
return LogicalLockResult(self.unlock)
1881
self.branch.unlock()
2634
1884
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().
1885
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1887
:return: A breezy.lock.LogicalLockResult.
1889
if not self.is_locked():
1891
self.branch.lock_read()
1893
self._control_files.lock_write()
1894
return LogicalLockResult(self.unlock)
1896
self.branch.unlock()
1899
def lock_write(self):
1900
"""See MutableTree.lock_write, and WorkingTree.unlock.
1902
:return: A breezy.lock.LogicalLockResult.
1904
if not self.is_locked():
2640
1906
self.branch.lock_write()
2642
return self._control_files.lock_write()
1908
self._control_files.lock_write()
1909
return LogicalLockResult(self.unlock)
2644
1911
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.
1914
def get_physical_lock_status(self):
1915
return self._control_files.get_physical_lock_status()
1917
@needs_tree_write_lock
1918
def _write_inventory(self, inv):
1919
"""Write inventory as the current inventory."""
1920
self._set_inventory(inv, dirty=True)
1923
# XXX: This method should be deprecated in favour of taking in a proper
1924
# new Inventory object.
1925
@needs_tree_write_lock
1926
def set_inventory(self, new_inventory_list):
1927
from .inventory import (
1932
inv = Inventory(self.get_root_id())
1933
for path, file_id, parent, kind in new_inventory_list:
1934
name = os.path.basename(path)
1937
# fixme, there should be a factory function inv,add_??
1938
if kind == 'directory':
1939
inv.add(InventoryDirectory(file_id, name, parent))
1940
elif kind == 'file':
1941
inv.add(InventoryFile(file_id, name, parent))
1942
elif kind == 'symlink':
1943
inv.add(InventoryLink(file_id, name, parent))
1945
raise errors.BzrError("unknown kind %r" % kind)
1946
self._write_inventory(inv)
1948
def _write_basis_inventory(self, xml):
1949
"""Write the basis inventory XML to the basis-inventory file"""
1950
path = self._basis_inventory_name()
1952
self._transport.put_file(path, sio,
1953
mode=self.bzrdir._get_file_mode())
1955
def _reset_data(self):
1956
"""Reset transient data that cannot be revalidated."""
1957
self._inventory_is_modified = False
1958
f = self._transport.get('inventory')
2660
return self._control_files.unlock()
1960
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."""
1963
self._set_inventory(result, dirty=False)
1965
def _set_root_id(self, file_id):
1966
"""Set the root id for this tree, in a format specific manner.
1968
:param file_id: The file id to assign to the root. It must not be
1969
present in the current inventory or an error will occur. It must
1970
not be None, but rather a valid file id.
1972
inv = self._inventory
1973
orig_root_id = inv.root.file_id
1974
# TODO: it might be nice to exit early if there was nothing
1975
# to do, saving us from trigger a sync on unlock.
1976
self._inventory_is_modified = True
1977
# we preserve the root inventory entry object, but
1978
# unlinkit from the byid index
1979
del inv._byid[inv.root.file_id]
1980
inv.root.file_id = file_id
1981
# and link it into the index with the new changed id.
1982
inv._byid[inv.root.file_id] = inv.root
1983
# and finally update all children to reference the new id.
1984
# XXX: this should be safe to just look at the root.children
1985
# list, not the WHOLE INVENTORY.
1988
if entry.parent_id == orig_root_id:
1989
entry.parent_id = inv.root.file_id
1991
@needs_tree_write_lock
1992
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1993
"""See MutableTree.set_parent_trees."""
1994
parent_ids = [rev for (rev, tree) in parents_list]
1995
for revision_id in parent_ids:
1996
_mod_revision.check_not_reserved_id(revision_id)
1998
self._check_parents_for_ghosts(parent_ids,
1999
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
2001
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
2003
if len(parent_ids) == 0:
2004
leftmost_parent_id = _mod_revision.NULL_REVISION
2005
leftmost_parent_tree = None
2007
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
2009
if self._change_last_revision(leftmost_parent_id):
2010
if leftmost_parent_tree is None:
2011
# If we don't have a tree, fall back to reading the
2012
# parent tree from the repository.
2013
self._cache_basis_inventory(leftmost_parent_id)
2015
inv = leftmost_parent_tree.root_inventory
2016
xml = self._create_basis_xml_from_inventory(
2017
leftmost_parent_id, inv)
2018
self._write_basis_inventory(xml)
2019
self._set_merges_from_parent_ids(parent_ids)
2021
def _cache_basis_inventory(self, new_revision):
2022
"""Cache new_revision as the basis inventory."""
2023
# TODO: this should allow the ready-to-use inventory to be passed in,
2024
# 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())]
2027
# this double handles the inventory - unpack and repack -
2028
# but is easier to understand. We can/should put a conditional
2029
# in here based on whether the inventory is in the latest format
2030
# - perhaps we should repack all inventories on a repository
2032
# the fast path is to copy the raw xml from the repository. If the
2033
# xml contains 'revision_id="', then we assume the right
2034
# revision_id is set. We must check for this full string, because a
2035
# root node id can legitimately look like 'revision_id' but cannot
2037
xml = self.branch.repository._get_inventory_xml(new_revision)
2038
firstline = xml.split('\n', 1)[0]
2039
if (not 'revision_id="' in firstline or
2040
'format="7"' not in firstline):
2041
inv = self.branch.repository._serializer.read_inventory_from_string(
2043
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2044
self._write_basis_inventory(xml)
2045
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2048
def _basis_inventory_name(self):
2049
return 'basis-inventory-cache'
2051
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2052
"""Create the text that will be saved in basis-inventory"""
2053
inventory.revision_id = revision_id
2054
return xml7.serializer_v7.write_inventory_to_string(inventory)
2700
2056
@needs_tree_write_lock
2701
2057
def set_conflicts(self, conflicts):
2717
2073
return _mod_conflicts.ConflictList()
2720
if confile.next() != CONFLICT_HEADER_1 + '\n':
2076
if next(confile) != CONFLICT_HEADER_1 + '\n':
2721
2077
raise errors.ConflictFormatError()
2722
2078
except StopIteration:
2723
2079
raise errors.ConflictFormatError()
2724
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2080
reader = _mod_rio.RioReader(confile)
2081
return _mod_conflicts.ConflictList.from_stanzas(reader)
2726
2083
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):
2085
def read_basis_inventory(self):
2086
"""Read the cached basis inventory."""
2087
path = self._basis_inventory_name()
2088
return self._transport.get_bytes(path)
2091
def read_working_inventory(self):
2092
"""Read the working inventory.
2094
:raises errors.InventoryModified: read_working_inventory will fail
2095
when the current in memory inventory has been modified.
2097
# conceptually this should be an implementation detail of the tree.
2098
# XXX: Deprecate this.
2099
# ElementTree does its own conversion from UTF-8, so open in
2101
if self._inventory_is_modified:
2102
raise errors.InventoryModified(self)
2103
f = self._transport.get('inventory')
2105
result = self._deserialize(f)
2108
self._set_inventory(result, dirty=False)
2112
def get_root_id(self):
2113
"""Return the id of this trees root"""
2114
return self._inventory.root.file_id
2116
def has_id(self, file_id):
2117
# files that have been deleted are excluded
2118
inv, inv_file_id = self._unpack_file_id(file_id)
2119
if not inv.has_id(inv_file_id):
2121
path = inv.id2path(inv_file_id)
2122
return osutils.lexists(self.abspath(path))
2124
def has_or_had_id(self, file_id):
2125
if file_id == self.get_root_id():
2127
inv, inv_file_id = self._unpack_file_id(file_id)
2128
return inv.has_id(inv_file_id)
2130
def all_file_ids(self):
2131
"""Iterate through file_ids for this tree.
2133
file_ids are in a WorkingTree if they are in the working inventory
2134
and the working file exists.
2137
for path, ie in self.iter_entries_by_dir():
2141
@needs_tree_write_lock
2142
def set_last_revision(self, new_revision):
2143
"""Change the last revision in the working tree."""
2144
if self._change_last_revision(new_revision):
2145
self._cache_basis_inventory(new_revision)
2147
def _get_check_refs(self):
2148
"""Return the references needed to perform a check of this tree.
2150
The default implementation returns no refs, and is only suitable for
2151
trees that have no local caching and can commit on ghosts at any time.
2153
:seealso: breezy.check for details about check_refs.
2158
def _check(self, references):
2159
"""Check the tree for consistency.
2161
:param references: A dict with keys matching the items returned by
2162
self._get_check_refs(), and values from looking those keys up in
2165
tree_basis = self.basis_tree()
2166
tree_basis.lock_read()
2168
repo_basis = references[('trees', self.last_revision())]
2169
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2170
raise errors.BzrCheckError(
2171
"Mismatched basis inventory content.")
2177
def check_state(self):
2178
"""Check that the working state is/isn't valid."""
2179
check_refs = self._get_check_refs()
2181
for ref in check_refs:
2184
refs[ref] = self.branch.repository.revision_tree(value)
2187
@needs_tree_write_lock
2188
def reset_state(self, revision_ids=None):
2189
"""Reset the state of the working tree.
2191
This does a hard-reset to a last-known-good state. This is a way to
2192
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2194
if revision_ids is None:
2195
revision_ids = self.get_parent_ids()
2196
if not revision_ids:
2197
rt = self.branch.repository.revision_tree(
2198
_mod_revision.NULL_REVISION)
2200
rt = self.branch.repository.revision_tree(revision_ids[0])
2201
self._write_inventory(rt.root_inventory)
2202
self.set_parent_ids(revision_ids)
2205
"""Write the in memory inventory to disk."""
2206
# TODO: Maybe this should only write on dirty ?
2207
if self._control_files._lock_mode != 'w':
2208
raise errors.NotWriteLocked(self)
2210
self._serialize(self._inventory, sio)
2212
self._transport.put_file('inventory', sio,
2213
mode=self.bzrdir._get_file_mode())
2214
self._inventory_is_modified = False
2216
def get_file_mtime(self, file_id, path=None):
2217
"""See Tree.get_file_mtime."""
2219
path = self.id2path(file_id)
2221
return os.lstat(self.abspath(path)).st_mtime
2222
except OSError as e:
2223
if e.errno == errno.ENOENT:
2224
raise errors.FileTimestampUnavailable(path)
2227
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2228
inv, file_id = self._path2inv_file_id(path)
2230
# For unversioned files on win32, we just assume they are not
2233
return inv[file_id].executable
2235
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2236
mode = stat_result.st_mode
2237
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2239
def is_executable(self, file_id, path=None):
2240
if not self._supports_executable():
2241
inv, inv_file_id = self._unpack_file_id(file_id)
2242
return inv[inv_file_id].executable
2245
path = self.id2path(file_id)
2246
mode = os.lstat(self.abspath(path)).st_mode
2247
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2249
def _is_executable_from_path_and_stat(self, path, stat_result):
2250
if not self._supports_executable():
2251
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2253
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2255
@needs_tree_write_lock
2256
def _add(self, files, ids, kinds):
2257
"""See MutableTree._add."""
2258
# TODO: Re-adding a file that is removed in the working copy
2259
# should probably put it back with the previous ID.
2260
# the read and write working inventory should not occur in this
2261
# function - they should be part of lock_write and unlock.
2262
# FIXME: nested trees
2263
inv = self.root_inventory
2264
for f, file_id, kind in zip(files, ids, kinds):
2266
inv.add_path(f, kind=kind)
2268
inv.add_path(f, kind=kind, file_id=file_id)
2269
self._inventory_is_modified = True
2271
def revision_tree(self, revision_id):
2272
"""See WorkingTree.revision_id."""
2273
if revision_id == self.last_revision():
2275
xml = self.read_basis_inventory()
2276
except errors.NoSuchFile:
2280
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2281
# dont use the repository revision_tree api because we want
2282
# to supply the inventory.
2283
if inv.revision_id == revision_id:
2284
return revisiontree.InventoryRevisionTree(
2285
self.branch.repository, inv, revision_id)
2286
except errors.BadInventoryFormat:
2288
# raise if there was no inventory, or if we read the wrong inventory.
2289
raise errors.NoSuchRevisionInTree(self, revision_id)
2292
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2293
"""See Tree.annotate_iter
2295
This implementation will use the basis tree implementation if possible.
2296
Lines not in the basis are attributed to CURRENT_REVISION
2298
If there are pending merges, lines added by those merges will be
2299
incorrectly attributed to CURRENT_REVISION (but after committing, the
2300
attribution will be correct).
2302
maybe_file_parent_keys = []
2303
for parent_id in self.get_parent_ids():
2305
parent_tree = self.revision_tree(parent_id)
2306
except errors.NoSuchRevisionInTree:
2307
parent_tree = self.branch.repository.revision_tree(parent_id)
2308
parent_tree.lock_read()
2311
kind = parent_tree.kind(file_id)
2312
except errors.NoSuchId:
2315
# Note: this is slightly unnecessary, because symlinks and
2316
# directories have a "text" which is the empty text, and we
2317
# know that won't mess up annotations. But it seems cleaner
2320
file_id, parent_tree.get_file_revision(file_id))
2321
if parent_text_key not in maybe_file_parent_keys:
2322
maybe_file_parent_keys.append(parent_text_key)
2324
parent_tree.unlock()
2325
graph = _mod_graph.Graph(self.branch.repository.texts)
2326
heads = graph.heads(maybe_file_parent_keys)
2327
file_parent_keys = []
2328
for key in maybe_file_parent_keys:
2330
file_parent_keys.append(key)
2332
# Now we have the parents of this content
2333
annotator = self.branch.repository.texts.get_annotator()
2334
text = self.get_file_text(file_id)
2335
this_key =(file_id, default_revision)
2336
annotator.add_special_text(this_key, file_parent_keys, text)
2337
annotations = [(key[-1], line)
2338
for key, line in annotator.annotate_flat(this_key)]
2341
def _put_rio(self, filename, stanzas, header):
2342
self._must_be_locked()
2343
my_file = _mod_rio.rio_file(stanzas, header)
2344
self._transport.put_file(filename, my_file,
2345
mode=self.bzrdir._get_file_mode())
2347
@needs_tree_write_lock
2348
def set_merge_modified(self, modified_hashes):
2350
for file_id, hash in modified_hashes.iteritems():
2351
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2353
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2356
def merge_modified(self):
2357
"""Return a dictionary of files modified by a merge.
2359
The list is initialized by WorkingTree.set_merge_modified, which is
2360
typically called after we make some automatic updates to the tree
2363
This returns a map of file_id->sha1, containing only files which are
2364
still in the working inventory and have that text hash.
2367
hashfile = self._transport.get('merge-hashes')
2368
except errors.NoSuchFile:
2373
if next(hashfile) != MERGE_MODIFIED_HEADER_1 + '\n':
2374
raise errors.MergeModifiedFormatError()
2375
except StopIteration:
2376
raise errors.MergeModifiedFormatError()
2377
for s in _mod_rio.RioReader(hashfile):
2378
# RioReader reads in Unicode, so convert file_ids back to utf8
2379
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2380
if not self.has_id(file_id):
2382
text_hash = s.get("hash")
2383
if text_hash == self.get_file_sha1(file_id):
2384
merge_hashes[file_id] = text_hash
2390
def subsume(self, other_tree):
2391
def add_children(inventory, entry):
2392
for child_entry in entry.children.values():
2393
inventory._byid[child_entry.file_id] = child_entry
2394
if child_entry.kind == 'directory':
2395
add_children(inventory, child_entry)
2396
if other_tree.get_root_id() == self.get_root_id():
2397
raise errors.BadSubsumeSource(self, other_tree,
2398
'Trees have the same root')
2400
other_tree_path = self.relpath(other_tree.basedir)
2401
except errors.PathNotChild:
2402
raise errors.BadSubsumeSource(self, other_tree,
2403
'Tree is not contained by the other')
2404
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2405
if new_root_parent is None:
2406
raise errors.BadSubsumeSource(self, other_tree,
2407
'Parent directory is not versioned.')
2408
# We need to ensure that the result of a fetch will have a
2409
# versionedfile for the other_tree root, and only fetching into
2410
# RepositoryKnit2 guarantees that.
2411
if not self.branch.repository.supports_rich_root():
2412
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2413
other_tree.lock_tree_write()
2415
new_parents = other_tree.get_parent_ids()
2416
other_root = other_tree.root_inventory.root
2417
other_root.parent_id = new_root_parent
2418
other_root.name = osutils.basename(other_tree_path)
2419
self.root_inventory.add(other_root)
2420
add_children(self.root_inventory, other_root)
2421
self._write_inventory(self.root_inventory)
2422
# normally we don't want to fetch whole repositories, but i think
2423
# here we really do want to consolidate the whole thing.
2424
for parent_id in other_tree.get_parent_ids():
2425
self.branch.fetch(other_tree.branch, parent_id)
2426
self.add_parent_tree_id(parent_id)
2429
other_tree.bzrdir.retire_bzrdir()
2431
@needs_tree_write_lock
2432
def extract(self, file_id, format=None):
2433
"""Extract a subtree from this tree.
2435
A new branch will be created, relative to the path for this tree.
2439
segments = osutils.splitpath(path)
2440
transport = self.branch.bzrdir.root_transport
2441
for name in segments:
2442
transport = transport.clone(name)
2443
transport.ensure_base()
2446
sub_path = self.id2path(file_id)
2447
branch_transport = mkdirs(sub_path)
2449
format = self.bzrdir.cloning_metadir()
2450
branch_transport.ensure_base()
2451
branch_bzrdir = format.initialize_on_transport(branch_transport)
2453
repo = branch_bzrdir.find_repository()
2454
except errors.NoRepositoryPresent:
2455
repo = branch_bzrdir.create_repository()
2456
if not repo.supports_rich_root():
2457
raise errors.RootNotRich()
2458
new_branch = branch_bzrdir.create_branch()
2459
new_branch.pull(self.branch)
2460
for parent_id in self.get_parent_ids():
2461
new_branch.fetch(self.branch, parent_id)
2462
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2463
if tree_transport.base != branch_transport.base:
2464
tree_bzrdir = format.initialize_on_transport(tree_transport)
2465
tree_bzrdir.set_branch_reference(new_branch)
2467
tree_bzrdir = branch_bzrdir
2468
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2469
wt.set_parent_ids(self.get_parent_ids())
2470
# FIXME: Support nested trees
2471
my_inv = self.root_inventory
2472
child_inv = inventory.Inventory(root_id=None)
2473
new_root = my_inv[file_id]
2474
my_inv.remove_recursive_id(file_id)
2475
new_root.parent_id = None
2476
child_inv.add(new_root)
2477
self._write_inventory(my_inv)
2478
wt._write_inventory(child_inv)
2481
def list_files(self, include_root=False, from_dir=None, recursive=True):
2482
"""List all files as (path, class, kind, id, entry).
2484
Lists, but does not descend into unversioned directories.
2485
This does not include files that have been deleted in this
2486
tree. Skips the control directory.
2488
:param include_root: if True, return an entry for the root
2489
:param from_dir: start from this directory or None for the root
2490
:param recursive: whether to recurse into subdirectories or not
2492
# list_files is an iterator, so @needs_read_lock doesn't work properly
2493
# with it. So callers should be careful to always read_lock the tree.
2494
if not self.is_locked():
2495
raise errors.ObjectNotLocked(self)
2497
if from_dir is None and include_root is True:
2498
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2499
# Convert these into local objects to save lookup times
2500
pathjoin = osutils.pathjoin
2501
file_kind = self._kind
2503
# transport.base ends in a slash, we want the piece
2504
# between the last two slashes
2505
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2507
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2509
# directory file_id, relative path, absolute path, reverse sorted children
2510
if from_dir is not None:
2511
inv, from_dir_id = self._path2inv_file_id(from_dir)
2512
if from_dir_id is None:
2513
# Directory not versioned
2515
from_dir_abspath = pathjoin(self.basedir, from_dir)
2517
inv = self.root_inventory
2518
from_dir_id = inv.root.file_id
2519
from_dir_abspath = self.basedir
2520
children = sorted(os.listdir(from_dir_abspath))
2521
# jam 20060527 The kernel sized tree seems equivalent whether we
2522
# use a deque and popleft to keep them sorted, or if we use a plain
2523
# list and just reverse() them.
2524
children = collections.deque(children)
2525
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2527
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2530
f = children.popleft()
2531
## TODO: If we find a subdirectory with its own .bzr
2532
## directory, then that is a separate tree and we
2533
## should exclude it.
2535
# the bzrdir for this tree
2536
if transport_base_dir == f:
2539
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2540
# and 'f' doesn't begin with one, we can do a string op, rather
2541
# than the checks of pathjoin(), all relative paths will have an extra slash
2543
fp = from_dir_relpath + '/' + f
2546
fap = from_dir_abspath + '/' + f
2548
dir_ie = inv[from_dir_id]
2549
if dir_ie.kind == 'directory':
2550
f_ie = dir_ie.children.get(f)
2555
elif self.is_ignored(fp[1:]):
2558
# we may not have found this file, because of a unicode
2559
# issue, or because the directory was actually a symlink.
2560
f_norm, can_access = osutils.normalized_filename(f)
2561
if f == f_norm or not can_access:
2562
# No change, so treat this file normally
2565
# this file can be accessed by a normalized path
2566
# check again if it is versioned
2567
# these lines are repeated here for performance
2569
fp = from_dir_relpath + '/' + f
2570
fap = from_dir_abspath + '/' + f
2571
f_ie = inv.get_child(from_dir_id, f)
2574
elif self.is_ignored(fp[1:]):
2581
# make a last minute entry
2583
yield fp[1:], c, fk, f_ie.file_id, f_ie
2586
yield fp[1:], c, fk, None, fk_entries[fk]()
2588
yield fp[1:], c, fk, None, TreeEntry()
2591
if fk != 'directory':
2594
# But do this child first if recursing down
2596
new_children = sorted(os.listdir(fap))
2597
new_children = collections.deque(new_children)
2598
stack.append((f_ie.file_id, fp, fap, new_children))
2599
# Break out of inner loop,
2600
# so that we start outer loop with child
2603
# if we finished all children, pop it off the stack
2606
@needs_tree_write_lock
2607
def move(self, from_paths, to_dir=None, after=False):
2610
to_dir must exist in the inventory.
2612
If to_dir exists and is a directory, the files are moved into
2613
it, keeping their old names.
2615
Note that to_dir is only the last component of the new name;
2616
this doesn't change the directory.
2618
For each entry in from_paths the move mode will be determined
2621
The first mode moves the file in the filesystem and updates the
2622
inventory. The second mode only updates the inventory without
2623
touching the file on the filesystem.
2625
move uses the second mode if 'after == True' and the target is
2626
either not versioned or newly added, and present in the working tree.
2628
move uses the second mode if 'after == False' and the source is
2629
versioned but no longer in the working tree, and the target is not
2630
versioned but present in the working tree.
2632
move uses the first mode if 'after == False' and the source is
2633
versioned and present in the working tree, and the target is not
2634
versioned and not present in the working tree.
2636
Everything else results in an error.
2638
This returns a list of (from_path, to_path) pairs for each
2639
entry that is moved.
2644
invs_to_write = set()
2646
# check for deprecated use of signature
2648
raise TypeError('You must supply a target directory')
2649
# check destination directory
2650
if isinstance(from_paths, basestring):
2652
to_abs = self.abspath(to_dir)
2653
if not isdir(to_abs):
2654
raise errors.BzrMoveFailedError('',to_dir,
2655
errors.NotADirectory(to_abs))
2656
if not self.has_filename(to_dir):
2657
raise errors.BzrMoveFailedError('',to_dir,
2658
errors.NotInWorkingDirectory(to_dir))
2659
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2660
if to_dir_id is None:
2661
raise errors.BzrMoveFailedError('',to_dir,
2662
errors.NotVersionedError(path=to_dir))
2664
to_dir_ie = to_inv[to_dir_id]
2665
if to_dir_ie.kind != 'directory':
2666
raise errors.BzrMoveFailedError('',to_dir,
2667
errors.NotADirectory(to_abs))
2669
# create rename entries and tuples
2670
for from_rel in from_paths:
2671
from_tail = splitpath(from_rel)[-1]
2672
from_inv, from_id = self._path2inv_file_id(from_rel)
2674
raise errors.BzrMoveFailedError(from_rel,to_dir,
2675
errors.NotVersionedError(path=from_rel))
2677
from_entry = from_inv[from_id]
2678
from_parent_id = from_entry.parent_id
2679
to_rel = pathjoin(to_dir, from_tail)
2680
rename_entry = InventoryWorkingTree._RenameEntry(
2683
from_tail=from_tail,
2684
from_parent_id=from_parent_id,
2685
to_rel=to_rel, to_tail=from_tail,
2686
to_parent_id=to_dir_id)
2687
rename_entries.append(rename_entry)
2688
rename_tuples.append((from_rel, to_rel))
2690
# determine which move mode to use. checks also for movability
2691
rename_entries = self._determine_mv_mode(rename_entries, after)
2693
original_modified = self._inventory_is_modified
2696
self._inventory_is_modified = True
2697
self._move(rename_entries)
2699
# restore the inventory on error
2700
self._inventory_is_modified = original_modified
2702
#FIXME: Should potentially also write the from_invs
2703
self._write_inventory(to_inv)
2704
return rename_tuples
2706
@needs_tree_write_lock
2707
def rename_one(self, from_rel, to_rel, after=False):
2710
This can change the directory or the filename or both.
2712
rename_one has several 'modes' to work. First, it can rename a physical
2713
file and change the file_id. That is the normal mode. Second, it can
2714
only change the file_id without touching any physical file.
2716
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2717
versioned but present in the working tree.
2719
rename_one uses the second mode if 'after == False' and 'from_rel' is
2720
versioned but no longer in the working tree, and 'to_rel' is not
2721
versioned but present in the working tree.
2723
rename_one uses the first mode if 'after == False' and 'from_rel' is
2724
versioned and present in the working tree, and 'to_rel' is not
2725
versioned and not present in the working tree.
2727
Everything else results in an error.
2731
# create rename entries and tuples
2732
from_tail = splitpath(from_rel)[-1]
2733
from_inv, from_id = self._path2inv_file_id(from_rel)
2735
# if file is missing in the inventory maybe it's in the basis_tree
2736
basis_tree = self.branch.basis_tree()
2737
from_id = basis_tree.path2id(from_rel)
2739
raise errors.BzrRenameFailedError(from_rel,to_rel,
2740
errors.NotVersionedError(path=from_rel))
2741
# put entry back in the inventory so we can rename it
2742
from_entry = basis_tree.root_inventory[from_id].copy()
2743
from_inv.add(from_entry)
2745
from_inv, from_inv_id = self._unpack_file_id(from_id)
2746
from_entry = from_inv[from_inv_id]
2747
from_parent_id = from_entry.parent_id
2748
to_dir, to_tail = os.path.split(to_rel)
2749
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2750
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2752
from_tail=from_tail,
2753
from_parent_id=from_parent_id,
2754
to_rel=to_rel, to_tail=to_tail,
2755
to_parent_id=to_dir_id)
2756
rename_entries.append(rename_entry)
2758
# determine which move mode to use. checks also for movability
2759
rename_entries = self._determine_mv_mode(rename_entries, after)
2761
# check if the target changed directory and if the target directory is
2763
if to_dir_id is None:
2764
raise errors.BzrMoveFailedError(from_rel,to_rel,
2765
errors.NotVersionedError(path=to_dir))
2767
# all checks done. now we can continue with our actual work
2768
mutter('rename_one:\n'
2773
' to_dir_id {%s}\n',
2774
from_id, from_rel, to_rel, to_dir, to_dir_id)
2776
self._move(rename_entries)
2777
self._write_inventory(to_inv)
2779
class _RenameEntry(object):
2780
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2781
to_rel, to_tail, to_parent_id, only_change_inv=False,
2783
self.from_rel = from_rel
2784
self.from_id = from_id
2785
self.from_tail = from_tail
2786
self.from_parent_id = from_parent_id
2787
self.to_rel = to_rel
2788
self.to_tail = to_tail
2789
self.to_parent_id = to_parent_id
2790
self.change_id = change_id
2791
self.only_change_inv = only_change_inv
2793
def _determine_mv_mode(self, rename_entries, after=False):
2794
"""Determines for each from-to pair if both inventory and working tree
2795
or only the inventory has to be changed.
2797
Also does basic plausability tests.
2799
# FIXME: Handling of nested trees
2800
inv = self.root_inventory
2802
for rename_entry in rename_entries:
2803
# store to local variables for easier reference
2804
from_rel = rename_entry.from_rel
2805
from_id = rename_entry.from_id
2806
to_rel = rename_entry.to_rel
2807
to_id = inv.path2id(to_rel)
2808
only_change_inv = False
2811
# check the inventory for source and destination
2813
raise errors.BzrMoveFailedError(from_rel,to_rel,
2814
errors.NotVersionedError(path=from_rel))
2815
if to_id is not None:
2817
# allow it with --after but only if dest is newly added
2819
basis = self.basis_tree()
2822
if not basis.has_id(to_id):
2823
rename_entry.change_id = True
2828
raise errors.BzrMoveFailedError(from_rel,to_rel,
2829
errors.AlreadyVersionedError(path=to_rel))
2831
# try to determine the mode for rename (only change inv or change
2832
# inv and file system)
2834
if not self.has_filename(to_rel):
2835
raise errors.BzrMoveFailedError(from_id,to_rel,
2836
errors.NoSuchFile(path=to_rel,
2837
extra="New file has not been created yet"))
2838
only_change_inv = True
2839
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2840
only_change_inv = True
2841
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2842
only_change_inv = False
2843
elif (not self.case_sensitive
2844
and from_rel.lower() == to_rel.lower()
2845
and self.has_filename(from_rel)):
2846
only_change_inv = False
2848
# something is wrong, so lets determine what exactly
2849
if not self.has_filename(from_rel) and \
2850
not self.has_filename(to_rel):
2851
raise errors.BzrRenameFailedError(from_rel, to_rel,
2852
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2854
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2855
rename_entry.only_change_inv = only_change_inv
2856
return rename_entries
2858
def _move(self, rename_entries):
2859
"""Moves a list of files.
2861
Depending on the value of the flag 'only_change_inv', the
2862
file will be moved on the file system or not.
2866
for entry in rename_entries:
2868
self._move_entry(entry)
2870
self._rollback_move(moved)
2874
def _rollback_move(self, moved):
2875
"""Try to rollback a previous move in case of an filesystem error."""
2878
self._move_entry(WorkingTree._RenameEntry(
2879
entry.to_rel, entry.from_id,
2880
entry.to_tail, entry.to_parent_id, entry.from_rel,
2881
entry.from_tail, entry.from_parent_id,
2882
entry.only_change_inv))
2883
except errors.BzrMoveFailedError as e:
2884
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2885
" The working tree is in an inconsistent state."
2886
" Please consider doing a 'bzr revert'."
2887
" Error message is: %s" % e)
2889
def _move_entry(self, entry):
2890
inv = self.root_inventory
2891
from_rel_abs = self.abspath(entry.from_rel)
2892
to_rel_abs = self.abspath(entry.to_rel)
2893
if from_rel_abs == to_rel_abs:
2894
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2895
"Source and target are identical.")
2897
if not entry.only_change_inv:
2899
osutils.rename(from_rel_abs, to_rel_abs)
2900
except OSError as e:
2901
raise errors.BzrMoveFailedError(entry.from_rel,
2904
to_id = inv.path2id(entry.to_rel)
2905
inv.remove_recursive_id(to_id)
2906
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2908
@needs_tree_write_lock
2909
def unversion(self, file_ids):
2910
"""Remove the file ids in file_ids from the current versioned set.
2912
When a file_id is unversioned, all of its children are automatically
2915
:param file_ids: The file ids to stop versioning.
2916
:raises: NoSuchId if any fileid is not currently versioned.
2918
for file_id in file_ids:
2919
if not self._inventory.has_id(file_id):
2920
raise errors.NoSuchId(self, file_id)
2921
for file_id in file_ids:
2922
if self._inventory.has_id(file_id):
2923
self._inventory.remove_recursive_id(file_id)
2925
# in the future this should just set a dirty bit to wait for the
2926
# final unlock. However, until all methods of workingtree start
2927
# with the current in -memory inventory rather than triggering
2928
# a read, it is more complex - we need to teach read_inventory
2929
# to know when to read, and when to not read first... and possibly
2930
# to save first when the in memory one may be corrupted.
2931
# so for now, we just only write it if it is indeed dirty.
2933
self._write_inventory(self._inventory)
2935
def stored_kind(self, file_id):
2936
"""See Tree.stored_kind"""
2937
inv, inv_file_id = self._unpack_file_id(file_id)
2938
return inv[inv_file_id].kind
2941
"""Yield all unversioned files in this WorkingTree.
2943
If there are any unversioned directories then only the directory is
2944
returned, not all its children. But if there are unversioned files
2945
under a versioned subdirectory, they are returned.
2947
Currently returned depth-first, sorted by name within directories.
2948
This is the same order used by 'osutils.walkdirs'.
2950
## TODO: Work from given directory downwards
2951
for path, dir_entry in self.iter_entries_by_dir():
2952
if dir_entry.kind != 'directory':
2954
# mutter("search for unknowns in %r", path)
2955
dirabs = self.abspath(path)
2956
if not isdir(dirabs):
2957
# e.g. directory deleted
2961
for subf in os.listdir(dirabs):
2962
if self.bzrdir.is_control_filename(subf):
2964
if subf not in dir_entry.children:
2967
can_access) = osutils.normalized_filename(subf)
2968
except UnicodeDecodeError:
2969
path_os_enc = path.encode(osutils._fs_enc)
2970
relpath = path_os_enc + '/' + subf
2971
raise errors.BadFilenameEncoding(relpath,
2973
if subf_norm != subf and can_access:
2974
if subf_norm not in dir_entry.children:
2975
fl.append(subf_norm)
2981
subp = pathjoin(path, subf)
2984
def _walkdirs(self, prefix=""):
2985
"""Walk the directories of this tree.
2987
:param prefix: is used as the directrory to start with.
2988
:returns: a generator which yields items in the form::
2990
((curren_directory_path, fileid),
2991
[(file1_path, file1_name, file1_kind, None, file1_id,
2994
_directory = 'directory'
2995
# get the root in the inventory
2996
inv, top_id = self._path2inv_file_id(prefix)
3000
pending = [(prefix, '', _directory, None, top_id, None)]
3003
currentdir = pending.pop()
3004
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
3005
top_id = currentdir[4]
3007
relroot = currentdir[0] + '/'
3010
# FIXME: stash the node in pending
3012
if entry.kind == 'directory':
3013
for name, child in entry.sorted_children():
3014
dirblock.append((relroot + name, name, child.kind, None,
3015
child.file_id, child.kind
3017
yield (currentdir[0], entry.file_id), dirblock
3018
# push the user specified dirs from dirblock
3019
for dir in reversed(dirblock):
3020
if dir[2] == _directory:
3024
def update_feature_flags(self, updated_flags):
3025
"""Update the feature flags for this branch.
3027
:param updated_flags: Dictionary mapping feature names to necessities
3028
A necessity can be None to indicate the feature should be removed
3030
self._format._update_feature_flags(updated_flags)
3031
self.control_transport.put_bytes('format', self._format.as_string())
3034
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
3035
"""Registry for working tree formats."""
3037
def __init__(self, other_registry=None):
3038
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
3039
self._default_format = None
3040
self._default_format_key = None
3042
def get_default(self):
3043
"""Return the current default format."""
3044
if (self._default_format_key is not None and
3045
self._default_format is None):
3046
self._default_format = self.get(self._default_format_key)
3047
return self._default_format
3049
def set_default(self, format):
3050
"""Set the default format."""
3051
self._default_format = format
3052
self._default_format_key = None
3054
def set_default_key(self, format_string):
3055
"""Set the default format by its format string."""
3056
self._default_format_key = format_string
3057
self._default_format = None
3060
format_registry = WorkingTreeFormatRegistry()
3063
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
3064
"""An encapsulation of the initialization and open routines for a format.
2752
3066
Formats provide three things:
2823
3135
"""True if this format supports stored views."""
2827
def register_format(klass, format):
2828
klass._formats[format.get_format_string()] = format
2831
def set_default_format(klass, format):
2832
klass._default_format = format
2835
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(),
3138
def get_controldir_for_branch(self):
3139
"""Get the control directory format for creating branches.
3141
This is to support testing of working tree formats that can not exist
3142
in the same control directory as a branch.
3144
return self._matchingbzrdir
3147
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3148
"""Base class for working trees that live in bzr meta directories."""
3151
WorkingTreeFormat.__init__(self)
3152
bzrdir.BzrFormat.__init__(self)
3155
def find_format_string(klass, controldir):
3156
"""Return format name for the working tree object in controldir."""
3158
transport = controldir.get_workingtree_transport(None)
3159
return transport.get_bytes("format")
3160
except errors.NoSuchFile:
3161
raise errors.NoWorkingTree(base=transport.base)
3164
def find_format(klass, controldir):
3165
"""Return the format for the working tree object in controldir."""
3166
format_string = klass.find_format_string(controldir)
3167
return klass._find_format(format_registry, 'working tree',
3170
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3172
WorkingTreeFormat.check_support_status(self,
3173
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3175
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3176
recommend_upgrade=recommend_upgrade, basedir=basedir)
3178
def get_controldir_for_branch(self):
3179
"""Get the control directory format for creating branches.
3181
This is to support testing of working tree formats that can not exist
3182
in the same control directory as a branch.
3184
return self._matchingbzrdir
3187
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
3188
"""Base class for working trees that live in bzr meta directories."""
3191
WorkingTreeFormat.__init__(self)
3192
bzrdir.BzrFormat.__init__(self)
3195
def find_format_string(klass, controldir):
3196
"""Return format name for the working tree object in controldir."""
3198
transport = controldir.get_workingtree_transport(None)
3199
return transport.get_bytes("format")
3200
except errors.NoSuchFile:
3201
raise errors.NoWorkingTree(base=transport.base)
3204
def find_format(klass, controldir):
3205
"""Return the format for the working tree object in controldir."""
3206
format_string = klass.find_format_string(controldir)
3207
return klass._find_format(format_registry, 'working tree',
3210
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
3212
WorkingTreeFormat.check_support_status(self,
3213
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
3215
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
3216
recommend_upgrade=recommend_upgrade, basedir=basedir)
3219
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3220
"breezy.workingtree_4", "WorkingTreeFormat4")
3221
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3222
"breezy.workingtree_4", "WorkingTreeFormat5")
3223
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3224
"breezy.workingtree_4", "WorkingTreeFormat6")
3225
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3226
"breezy.workingtree_3", "WorkingTreeFormat3")
3227
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
