2608
1817
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.
1820
class InventoryWorkingTree(WorkingTree,
1821
bzrlib.mutabletree.MutableInventoryTree):
1822
"""Base class for working trees that are inventory-oriented.
1824
The inventory is held in the `Branch` working-inventory, and the
1825
files are in a directory on disk.
1827
It is possible for a `WorkingTree` to have a filename which is
1828
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())]
2634
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().
2640
self.branch.lock_write()
2642
return self._control_files.lock_write()
1831
def __init__(self, basedir='.',
1832
branch=DEPRECATED_PARAMETER,
1834
_control_files=None,
1838
"""Construct a InventoryWorkingTree instance. This is not a public API.
1840
:param branch: A branch to override probing for the branch.
1842
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1843
branch=branch, _control_files=_control_files, _internal=_internal,
1844
_format=_format, _bzrdir=_bzrdir)
1846
if _inventory is None:
1847
# This will be acquired on lock_read() or lock_write()
1848
self._inventory_is_modified = False
1849
self._inventory = None
1851
# the caller of __init__ has provided an inventory,
1852
# we assume they know what they are doing - as its only
1853
# the Format factory and creation methods that are
1854
# permitted to do this.
1855
self._set_inventory(_inventory, dirty=False)
1857
def _set_inventory(self, inv, dirty):
1858
"""Set the internal cached inventory.
1860
:param inv: The inventory to set.
1861
:param dirty: A boolean indicating whether the inventory is the same
1862
logical inventory as whats on disk. If True the inventory is not
1863
the same and should be written to disk or data will be lost, if
1864
False then the inventory is the same as that on disk and any
1865
serialisation would be unneeded overhead.
1867
self._inventory = inv
1868
self._inventory_is_modified = dirty
1870
def _serialize(self, inventory, out_file):
1871
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1874
def _deserialize(selt, in_file):
1875
return xml5.serializer_v5.read_inventory(in_file)
1877
@needs_tree_write_lock
1878
def _write_inventory(self, inv):
1879
"""Write inventory as the current inventory."""
1880
self._set_inventory(inv, dirty=True)
1883
# XXX: This method should be deprecated in favour of taking in a proper
1884
# new Inventory object.
1885
@needs_tree_write_lock
1886
def set_inventory(self, new_inventory_list):
1887
from bzrlib.inventory import (Inventory,
1891
inv = Inventory(self.get_root_id())
1892
for path, file_id, parent, kind in new_inventory_list:
1893
name = os.path.basename(path)
1896
# fixme, there should be a factory function inv,add_??
1897
if kind == 'directory':
1898
inv.add(InventoryDirectory(file_id, name, parent))
1899
elif kind == 'file':
1900
inv.add(InventoryFile(file_id, name, parent))
1901
elif kind == 'symlink':
1902
inv.add(InventoryLink(file_id, name, parent))
1904
raise errors.BzrError("unknown kind %r" % kind)
1905
self._write_inventory(inv)
1907
def _write_basis_inventory(self, xml):
1908
"""Write the basis inventory XML to the basis-inventory file"""
1909
path = self._basis_inventory_name()
1911
self._transport.put_file(path, sio,
1912
mode=self.bzrdir._get_file_mode())
1914
def _reset_data(self):
1915
"""Reset transient data that cannot be revalidated."""
1916
self._inventory_is_modified = False
1917
f = self._transport.get('inventory')
1919
result = self._deserialize(f)
1922
self._set_inventory(result, dirty=False)
1924
def _set_root_id(self, file_id):
1925
"""Set the root id for this tree, in a format specific manner.
1927
:param file_id: The file id to assign to the root. It must not be
1928
present in the current inventory or an error will occur. It must
1929
not be None, but rather a valid file id.
1931
inv = self._inventory
1932
orig_root_id = inv.root.file_id
1933
# TODO: it might be nice to exit early if there was nothing
1934
# to do, saving us from trigger a sync on unlock.
1935
self._inventory_is_modified = True
1936
# we preserve the root inventory entry object, but
1937
# unlinkit from the byid index
1938
del inv._byid[inv.root.file_id]
1939
inv.root.file_id = file_id
1940
# and link it into the index with the new changed id.
1941
inv._byid[inv.root.file_id] = inv.root
1942
# and finally update all children to reference the new id.
1943
# XXX: this should be safe to just look at the root.children
1944
# list, not the WHOLE INVENTORY.
1947
if entry.parent_id == orig_root_id:
1948
entry.parent_id = inv.root.file_id
1950
def all_file_ids(self):
1951
"""See Tree.iter_all_file_ids"""
1952
return set(self.inventory)
1954
@needs_tree_write_lock
1955
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1956
"""See MutableTree.set_parent_trees."""
1957
parent_ids = [rev for (rev, tree) in parents_list]
1958
for revision_id in parent_ids:
1959
_mod_revision.check_not_reserved_id(revision_id)
1961
self._check_parents_for_ghosts(parent_ids,
1962
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1964
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1966
if len(parent_ids) == 0:
1967
leftmost_parent_id = _mod_revision.NULL_REVISION
1968
leftmost_parent_tree = None
1970
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1972
if self._change_last_revision(leftmost_parent_id):
1973
if leftmost_parent_tree is None:
1974
# If we don't have a tree, fall back to reading the
1975
# parent tree from the repository.
1976
self._cache_basis_inventory(leftmost_parent_id)
1978
inv = leftmost_parent_tree.inventory
1979
xml = self._create_basis_xml_from_inventory(
1980
leftmost_parent_id, inv)
1981
self._write_basis_inventory(xml)
1982
self._set_merges_from_parent_ids(parent_ids)
1984
def _cache_basis_inventory(self, new_revision):
1985
"""Cache new_revision as the basis inventory."""
1986
# TODO: this should allow the ready-to-use inventory to be passed in,
1987
# as commit already has that ready-to-use [while the format is the
1990
# this double handles the inventory - unpack and repack -
1991
# but is easier to understand. We can/should put a conditional
1992
# in here based on whether the inventory is in the latest format
1993
# - perhaps we should repack all inventories on a repository
1995
# the fast path is to copy the raw xml from the repository. If the
1996
# xml contains 'revision_id="', then we assume the right
1997
# revision_id is set. We must check for this full string, because a
1998
# root node id can legitimately look like 'revision_id' but cannot
2000
xml = self.branch.repository._get_inventory_xml(new_revision)
2001
firstline = xml.split('\n', 1)[0]
2002
if (not 'revision_id="' in firstline or
2003
'format="7"' not in firstline):
2004
inv = self.branch.repository._serializer.read_inventory_from_string(
2006
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2007
self._write_basis_inventory(xml)
2008
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2011
def _basis_inventory_name(self):
2012
return 'basis-inventory-cache'
2014
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2015
"""Create the text that will be saved in basis-inventory"""
2016
inventory.revision_id = revision_id
2017
return xml7.serializer_v7.write_inventory_to_string(inventory)
2019
def read_basis_inventory(self):
2020
"""Read the cached basis inventory."""
2021
path = self._basis_inventory_name()
2022
return self._transport.get_bytes(path)
2025
def read_working_inventory(self):
2026
"""Read the working inventory.
2028
:raises errors.InventoryModified: read_working_inventory will fail
2029
when the current in memory inventory has been modified.
2031
# conceptually this should be an implementation detail of the tree.
2032
# XXX: Deprecate this.
2033
# ElementTree does its own conversion from UTF-8, so open in
2035
if self._inventory_is_modified:
2036
raise errors.InventoryModified(self)
2037
f = self._transport.get('inventory')
2039
result = self._deserialize(f)
2042
self._set_inventory(result, dirty=False)
2046
def get_root_id(self):
2047
"""Return the id of this trees root"""
2048
return self._inventory.root.file_id
2050
def has_id(self, file_id):
2051
# files that have been deleted are excluded
2052
inv = self.inventory
2053
if not inv.has_id(file_id):
2055
path = inv.id2path(file_id)
2056
return osutils.lexists(self.abspath(path))
2058
def has_or_had_id(self, file_id):
2059
if file_id == self.inventory.root.file_id:
2061
return self.inventory.has_id(file_id)
2063
__contains__ = has_id
2065
# should be deprecated - this is slow and in any case treating them as a
2066
# container is (we now know) bad style -- mbp 20070302
2067
## @deprecated_method(zero_fifteen)
2069
"""Iterate through file_ids for this tree.
2071
file_ids are in a WorkingTree if they are in the working inventory
2072
and the working file exists.
2074
inv = self._inventory
2075
for path, ie in inv.iter_entries():
2076
if osutils.lexists(self.abspath(path)):
2079
@needs_tree_write_lock
2080
def set_last_revision(self, new_revision):
2081
"""Change the last revision in the working tree."""
2082
if self._change_last_revision(new_revision):
2083
self._cache_basis_inventory(new_revision)
2085
@needs_tree_write_lock
2086
def reset_state(self, revision_ids=None):
2087
"""Reset the state of the working tree.
2089
This does a hard-reset to a last-known-good state. This is a way to
2090
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2092
if revision_ids is None:
2093
revision_ids = self.get_parent_ids()
2094
if not revision_ids:
2095
rt = self.branch.repository.revision_tree(
2096
_mod_revision.NULL_REVISION)
2098
rt = self.branch.repository.revision_tree(revision_ids[0])
2099
self._write_inventory(rt.inventory)
2100
self.set_parent_ids(revision_ids)
2103
"""Write the in memory inventory to disk."""
2104
# TODO: Maybe this should only write on dirty ?
2105
if self._control_files._lock_mode != 'w':
2106
raise errors.NotWriteLocked(self)
2108
self._serialize(self._inventory, sio)
2110
self._transport.put_file('inventory', sio,
2111
mode=self.bzrdir._get_file_mode())
2112
self._inventory_is_modified = False
2115
def get_file_sha1(self, file_id, path=None, stat_value=None):
2117
path = self._inventory.id2path(file_id)
2118
return self._hashcache.get_sha1(path, stat_value)
2120
def get_file_mtime(self, file_id, path=None):
2121
"""See Tree.get_file_mtime."""
2123
path = self.inventory.id2path(file_id)
2124
return os.lstat(self.abspath(path)).st_mtime
2126
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2127
file_id = self.path2id(path)
2129
# For unversioned files on win32, we just assume they are not
2132
return self._inventory[file_id].executable
2134
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2135
mode = stat_result.st_mode
2136
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2138
if not supports_executable():
2139
def is_executable(self, file_id, path=None):
2140
return self._inventory[file_id].executable
2142
_is_executable_from_path_and_stat = \
2143
_is_executable_from_path_and_stat_from_basis
2145
def is_executable(self, file_id, path=None):
2147
path = self.id2path(file_id)
2148
mode = os.lstat(self.abspath(path)).st_mode
2149
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2151
_is_executable_from_path_and_stat = \
2152
_is_executable_from_path_and_stat_from_stat
2154
@needs_tree_write_lock
2155
def _add(self, files, ids, kinds):
2156
"""See MutableTree._add."""
2157
# TODO: Re-adding a file that is removed in the working copy
2158
# should probably put it back with the previous ID.
2159
# the read and write working inventory should not occur in this
2160
# function - they should be part of lock_write and unlock.
2161
inv = self.inventory
2162
for f, file_id, kind in zip(files, ids, kinds):
2164
inv.add_path(f, kind=kind)
2166
inv.add_path(f, kind=kind, file_id=file_id)
2167
self._inventory_is_modified = True
2169
def revision_tree(self, revision_id):
2170
"""See WorkingTree.revision_id."""
2171
if revision_id == self.last_revision():
2173
xml = self.read_basis_inventory()
2174
except errors.NoSuchFile:
2178
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2179
# dont use the repository revision_tree api because we want
2180
# to supply the inventory.
2181
if inv.revision_id == revision_id:
2182
return revisiontree.InventoryRevisionTree(
2183
self.branch.repository, inv, revision_id)
2184
except errors.BadInventoryFormat:
2186
# raise if there was no inventory, or if we read the wrong inventory.
2187
raise errors.NoSuchRevisionInTree(self, revision_id)
2190
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2191
"""See Tree.annotate_iter
2193
This implementation will use the basis tree implementation if possible.
2194
Lines not in the basis are attributed to CURRENT_REVISION
2196
If there are pending merges, lines added by those merges will be
2197
incorrectly attributed to CURRENT_REVISION (but after committing, the
2198
attribution will be correct).
2200
maybe_file_parent_keys = []
2201
for parent_id in self.get_parent_ids():
2203
parent_tree = self.revision_tree(parent_id)
2204
except errors.NoSuchRevisionInTree:
2205
parent_tree = self.branch.repository.revision_tree(parent_id)
2206
parent_tree.lock_read()
2208
if file_id not in parent_tree:
2210
ie = parent_tree.inventory[file_id]
2211
if ie.kind != 'file':
2212
# Note: this is slightly unnecessary, because symlinks and
2213
# directories have a "text" which is the empty text, and we
2214
# know that won't mess up annotations. But it seems cleaner
2216
parent_text_key = (file_id, ie.revision)
2217
if parent_text_key not in maybe_file_parent_keys:
2218
maybe_file_parent_keys.append(parent_text_key)
2220
parent_tree.unlock()
2221
graph = _mod_graph.Graph(self.branch.repository.texts)
2222
heads = graph.heads(maybe_file_parent_keys)
2223
file_parent_keys = []
2224
for key in maybe_file_parent_keys:
2226
file_parent_keys.append(key)
2228
# Now we have the parents of this content
2229
annotator = self.branch.repository.texts.get_annotator()
2230
text = self.get_file_text(file_id)
2231
this_key =(file_id, default_revision)
2232
annotator.add_special_text(this_key, file_parent_keys, text)
2233
annotations = [(key[-1], line)
2234
for key, line in annotator.annotate_flat(this_key)]
2238
def merge_modified(self):
2239
"""Return a dictionary of files modified by a merge.
2241
The list is initialized by WorkingTree.set_merge_modified, which is
2242
typically called after we make some automatic updates to the tree
2245
This returns a map of file_id->sha1, containing only files which are
2246
still in the working inventory and have that text hash.
2249
hashfile = self._transport.get('merge-hashes')
2250
except errors.NoSuchFile:
2255
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2256
raise errors.MergeModifiedFormatError()
2257
except StopIteration:
2258
raise errors.MergeModifiedFormatError()
2259
for s in _mod_rio.RioReader(hashfile):
2260
# RioReader reads in Unicode, so convert file_ids back to utf8
2261
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2262
if file_id not in self.inventory:
2264
text_hash = s.get("hash")
2265
if text_hash == self.get_file_sha1(file_id):
2266
merge_hashes[file_id] = text_hash
2272
def subsume(self, other_tree):
2273
def add_children(inventory, entry):
2274
for child_entry in entry.children.values():
2275
inventory._byid[child_entry.file_id] = child_entry
2276
if child_entry.kind == 'directory':
2277
add_children(inventory, child_entry)
2278
if other_tree.get_root_id() == self.get_root_id():
2279
raise errors.BadSubsumeSource(self, other_tree,
2280
'Trees have the same root')
2282
other_tree_path = self.relpath(other_tree.basedir)
2283
except errors.PathNotChild:
2284
raise errors.BadSubsumeSource(self, other_tree,
2285
'Tree is not contained by the other')
2286
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2287
if new_root_parent is None:
2288
raise errors.BadSubsumeSource(self, other_tree,
2289
'Parent directory is not versioned.')
2290
# We need to ensure that the result of a fetch will have a
2291
# versionedfile for the other_tree root, and only fetching into
2292
# RepositoryKnit2 guarantees that.
2293
if not self.branch.repository.supports_rich_root():
2294
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2295
other_tree.lock_tree_write()
2297
new_parents = other_tree.get_parent_ids()
2298
other_root = other_tree.inventory.root
2299
other_root.parent_id = new_root_parent
2300
other_root.name = osutils.basename(other_tree_path)
2301
self.inventory.add(other_root)
2302
add_children(self.inventory, other_root)
2303
self._write_inventory(self.inventory)
2304
# normally we don't want to fetch whole repositories, but i think
2305
# here we really do want to consolidate the whole thing.
2306
for parent_id in other_tree.get_parent_ids():
2307
self.branch.fetch(other_tree.branch, parent_id)
2308
self.add_parent_tree_id(parent_id)
2311
other_tree.bzrdir.retire_bzrdir()
2313
@needs_tree_write_lock
2314
def extract(self, file_id, format=None):
2315
"""Extract a subtree from this tree.
2317
A new branch will be created, relative to the path for this tree.
2321
segments = osutils.splitpath(path)
2322
transport = self.branch.bzrdir.root_transport
2323
for name in segments:
2324
transport = transport.clone(name)
2325
transport.ensure_base()
2328
sub_path = self.id2path(file_id)
2329
branch_transport = mkdirs(sub_path)
2331
format = self.bzrdir.cloning_metadir()
2332
branch_transport.ensure_base()
2333
branch_bzrdir = format.initialize_on_transport(branch_transport)
2335
repo = branch_bzrdir.find_repository()
2336
except errors.NoRepositoryPresent:
2337
repo = branch_bzrdir.create_repository()
2338
if not repo.supports_rich_root():
2339
raise errors.RootNotRich()
2340
new_branch = branch_bzrdir.create_branch()
2341
new_branch.pull(self.branch)
2342
for parent_id in self.get_parent_ids():
2343
new_branch.fetch(self.branch, parent_id)
2344
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2345
if tree_transport.base != branch_transport.base:
2346
tree_bzrdir = format.initialize_on_transport(tree_transport)
2347
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2348
target_branch=new_branch)
2350
tree_bzrdir = branch_bzrdir
2351
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2352
wt.set_parent_ids(self.get_parent_ids())
2353
my_inv = self.inventory
2354
child_inv = inventory.Inventory(root_id=None)
2355
new_root = my_inv[file_id]
2356
my_inv.remove_recursive_id(file_id)
2357
new_root.parent_id = None
2358
child_inv.add(new_root)
2359
self._write_inventory(my_inv)
2360
wt._write_inventory(child_inv)
2363
def list_files(self, include_root=False, from_dir=None, recursive=True):
2364
"""List all files as (path, class, kind, id, entry).
2366
Lists, but does not descend into unversioned directories.
2367
This does not include files that have been deleted in this
2368
tree. Skips the control directory.
2370
:param include_root: if True, return an entry for the root
2371
:param from_dir: start from this directory or None for the root
2372
:param recursive: whether to recurse into subdirectories or not
2374
# list_files is an iterator, so @needs_read_lock doesn't work properly
2375
# with it. So callers should be careful to always read_lock the tree.
2376
if not self.is_locked():
2377
raise errors.ObjectNotLocked(self)
2379
inv = self.inventory
2380
if from_dir is None and include_root is True:
2381
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2382
# Convert these into local objects to save lookup times
2383
pathjoin = osutils.pathjoin
2384
file_kind = self._kind
2386
# transport.base ends in a slash, we want the piece
2387
# between the last two slashes
2388
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2390
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2392
# directory file_id, relative path, absolute path, reverse sorted children
2393
if from_dir is not None:
2394
from_dir_id = inv.path2id(from_dir)
2395
if from_dir_id is None:
2396
# Directory not versioned
2398
from_dir_abspath = pathjoin(self.basedir, from_dir)
2400
from_dir_id = inv.root.file_id
2401
from_dir_abspath = self.basedir
2402
children = os.listdir(from_dir_abspath)
2404
# jam 20060527 The kernel sized tree seems equivalent whether we
2405
# use a deque and popleft to keep them sorted, or if we use a plain
2406
# list and just reverse() them.
2407
children = collections.deque(children)
2408
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2410
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2413
f = children.popleft()
2414
## TODO: If we find a subdirectory with its own .bzr
2415
## directory, then that is a separate tree and we
2416
## should exclude it.
2418
# the bzrdir for this tree
2419
if transport_base_dir == f:
2422
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2423
# and 'f' doesn't begin with one, we can do a string op, rather
2424
# than the checks of pathjoin(), all relative paths will have an extra slash
2426
fp = from_dir_relpath + '/' + f
2429
fap = from_dir_abspath + '/' + f
2431
dir_ie = inv[from_dir_id]
2432
if dir_ie.kind == 'directory':
2433
f_ie = dir_ie.children.get(f)
2438
elif self.is_ignored(fp[1:]):
2441
# we may not have found this file, because of a unicode
2442
# issue, or because the directory was actually a symlink.
2443
f_norm, can_access = osutils.normalized_filename(f)
2444
if f == f_norm or not can_access:
2445
# No change, so treat this file normally
2448
# this file can be accessed by a normalized path
2449
# check again if it is versioned
2450
# these lines are repeated here for performance
2452
fp = from_dir_relpath + '/' + f
2453
fap = from_dir_abspath + '/' + f
2454
f_ie = inv.get_child(from_dir_id, f)
2457
elif self.is_ignored(fp[1:]):
2464
# make a last minute entry
2466
yield fp[1:], c, fk, f_ie.file_id, f_ie
2469
yield fp[1:], c, fk, None, fk_entries[fk]()
2471
yield fp[1:], c, fk, None, TreeEntry()
2474
if fk != 'directory':
2477
# But do this child first if recursing down
2479
new_children = os.listdir(fap)
2481
new_children = collections.deque(new_children)
2482
stack.append((f_ie.file_id, fp, fap, new_children))
2483
# Break out of inner loop,
2484
# so that we start outer loop with child
2487
# if we finished all children, pop it off the stack
2490
@needs_tree_write_lock
2491
def move(self, from_paths, to_dir=None, after=False):
2494
to_dir must exist in the inventory.
2496
If to_dir exists and is a directory, the files are moved into
2497
it, keeping their old names.
2499
Note that to_dir is only the last component of the new name;
2500
this doesn't change the directory.
2502
For each entry in from_paths the move mode will be determined
2505
The first mode moves the file in the filesystem and updates the
2506
inventory. The second mode only updates the inventory without
2507
touching the file on the filesystem.
2509
move uses the second mode if 'after == True' and the target is not
2510
versioned but present in the working tree.
2512
move uses the second mode if 'after == False' and the source is
2513
versioned but no longer in the working tree, and the target is not
2514
versioned but present in the working tree.
2516
move uses the first mode if 'after == False' and the source is
2517
versioned and present in the working tree, and the target is not
2518
versioned and not present in the working tree.
2520
Everything else results in an error.
2522
This returns a list of (from_path, to_path) pairs for each
2523
entry that is moved.
2528
# check for deprecated use of signature
2530
raise TypeError('You must supply a target directory')
2531
# check destination directory
2532
if isinstance(from_paths, basestring):
2534
inv = self.inventory
2535
to_abs = self.abspath(to_dir)
2536
if not isdir(to_abs):
2537
raise errors.BzrMoveFailedError('',to_dir,
2538
errors.NotADirectory(to_abs))
2539
if not self.has_filename(to_dir):
2540
raise errors.BzrMoveFailedError('',to_dir,
2541
errors.NotInWorkingDirectory(to_dir))
2542
to_dir_id = inv.path2id(to_dir)
2543
if to_dir_id is None:
2544
raise errors.BzrMoveFailedError('',to_dir,
2545
errors.NotVersionedError(path=to_dir))
2547
to_dir_ie = inv[to_dir_id]
2548
if to_dir_ie.kind != 'directory':
2549
raise errors.BzrMoveFailedError('',to_dir,
2550
errors.NotADirectory(to_abs))
2552
# create rename entries and tuples
2553
for from_rel in from_paths:
2554
from_tail = splitpath(from_rel)[-1]
2555
from_id = inv.path2id(from_rel)
2557
raise errors.BzrMoveFailedError(from_rel,to_dir,
2558
errors.NotVersionedError(path=from_rel))
2560
from_entry = inv[from_id]
2561
from_parent_id = from_entry.parent_id
2562
to_rel = pathjoin(to_dir, from_tail)
2563
rename_entry = InventoryWorkingTree._RenameEntry(
2566
from_tail=from_tail,
2567
from_parent_id=from_parent_id,
2568
to_rel=to_rel, to_tail=from_tail,
2569
to_parent_id=to_dir_id)
2570
rename_entries.append(rename_entry)
2571
rename_tuples.append((from_rel, to_rel))
2573
# determine which move mode to use. checks also for movability
2574
rename_entries = self._determine_mv_mode(rename_entries, after)
2576
original_modified = self._inventory_is_modified
2579
self._inventory_is_modified = True
2580
self._move(rename_entries)
2644
self.branch.unlock()
2582
# restore the inventory on error
2583
self._inventory_is_modified = original_modified
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.
2660
return self._control_files.unlock()
2662
self.branch.unlock()
2665
class WorkingTree3(WorkingTree):
2585
self._write_inventory(inv)
2586
return rename_tuples
2588
@needs_tree_write_lock
2589
def rename_one(self, from_rel, to_rel, after=False):
2592
This can change the directory or the filename or both.
2594
rename_one has several 'modes' to work. First, it can rename a physical
2595
file and change the file_id. That is the normal mode. Second, it can
2596
only change the file_id without touching any physical file.
2598
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2599
versioned but present in the working tree.
2601
rename_one uses the second mode if 'after == False' and 'from_rel' is
2602
versioned but no longer in the working tree, and 'to_rel' is not
2603
versioned but present in the working tree.
2605
rename_one uses the first mode if 'after == False' and 'from_rel' is
2606
versioned and present in the working tree, and 'to_rel' is not
2607
versioned and not present in the working tree.
2609
Everything else results in an error.
2611
inv = self.inventory
2614
# create rename entries and tuples
2615
from_tail = splitpath(from_rel)[-1]
2616
from_id = inv.path2id(from_rel)
2618
# if file is missing in the inventory maybe it's in the basis_tree
2619
basis_tree = self.branch.basis_tree()
2620
from_id = basis_tree.path2id(from_rel)
2622
raise errors.BzrRenameFailedError(from_rel,to_rel,
2623
errors.NotVersionedError(path=from_rel))
2624
# put entry back in the inventory so we can rename it
2625
from_entry = basis_tree.inventory[from_id].copy()
2628
from_entry = inv[from_id]
2629
from_parent_id = from_entry.parent_id
2630
to_dir, to_tail = os.path.split(to_rel)
2631
to_dir_id = inv.path2id(to_dir)
2632
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2634
from_tail=from_tail,
2635
from_parent_id=from_parent_id,
2636
to_rel=to_rel, to_tail=to_tail,
2637
to_parent_id=to_dir_id)
2638
rename_entries.append(rename_entry)
2640
# determine which move mode to use. checks also for movability
2641
rename_entries = self._determine_mv_mode(rename_entries, after)
2643
# check if the target changed directory and if the target directory is
2645
if to_dir_id is None:
2646
raise errors.BzrMoveFailedError(from_rel,to_rel,
2647
errors.NotVersionedError(path=to_dir))
2649
# all checks done. now we can continue with our actual work
2650
mutter('rename_one:\n'
2655
' to_dir_id {%s}\n',
2656
from_id, from_rel, to_rel, to_dir, to_dir_id)
2658
self._move(rename_entries)
2659
self._write_inventory(inv)
2661
class _RenameEntry(object):
2662
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2663
to_rel, to_tail, to_parent_id, only_change_inv=False):
2664
self.from_rel = from_rel
2665
self.from_id = from_id
2666
self.from_tail = from_tail
2667
self.from_parent_id = from_parent_id
2668
self.to_rel = to_rel
2669
self.to_tail = to_tail
2670
self.to_parent_id = to_parent_id
2671
self.only_change_inv = only_change_inv
2673
def _determine_mv_mode(self, rename_entries, after=False):
2674
"""Determines for each from-to pair if both inventory and working tree
2675
or only the inventory has to be changed.
2677
Also does basic plausability tests.
2679
inv = self.inventory
2681
for rename_entry in rename_entries:
2682
# store to local variables for easier reference
2683
from_rel = rename_entry.from_rel
2684
from_id = rename_entry.from_id
2685
to_rel = rename_entry.to_rel
2686
to_id = inv.path2id(to_rel)
2687
only_change_inv = False
2689
# check the inventory for source and destination
2691
raise errors.BzrMoveFailedError(from_rel,to_rel,
2692
errors.NotVersionedError(path=from_rel))
2693
if to_id is not None:
2694
raise errors.BzrMoveFailedError(from_rel,to_rel,
2695
errors.AlreadyVersionedError(path=to_rel))
2697
# try to determine the mode for rename (only change inv or change
2698
# inv and file system)
2700
if not self.has_filename(to_rel):
2701
raise errors.BzrMoveFailedError(from_id,to_rel,
2702
errors.NoSuchFile(path=to_rel,
2703
extra="New file has not been created yet"))
2704
only_change_inv = True
2705
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2706
only_change_inv = True
2707
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2708
only_change_inv = False
2709
elif (not self.case_sensitive
2710
and from_rel.lower() == to_rel.lower()
2711
and self.has_filename(from_rel)):
2712
only_change_inv = False
2714
# something is wrong, so lets determine what exactly
2715
if not self.has_filename(from_rel) and \
2716
not self.has_filename(to_rel):
2717
raise errors.BzrRenameFailedError(from_rel,to_rel,
2718
errors.PathsDoNotExist(paths=(str(from_rel),
2721
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2722
rename_entry.only_change_inv = only_change_inv
2723
return rename_entries
2725
def _move(self, rename_entries):
2726
"""Moves a list of files.
2728
Depending on the value of the flag 'only_change_inv', the
2729
file will be moved on the file system or not.
2731
inv = self.inventory
2734
for entry in rename_entries:
2736
self._move_entry(entry)
2738
self._rollback_move(moved)
2742
def _rollback_move(self, moved):
2743
"""Try to rollback a previous move in case of an filesystem error."""
2744
inv = self.inventory
2747
self._move_entry(WorkingTree._RenameEntry(
2748
entry.to_rel, entry.from_id,
2749
entry.to_tail, entry.to_parent_id, entry.from_rel,
2750
entry.from_tail, entry.from_parent_id,
2751
entry.only_change_inv))
2752
except errors.BzrMoveFailedError, e:
2753
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2754
" The working tree is in an inconsistent state."
2755
" Please consider doing a 'bzr revert'."
2756
" Error message is: %s" % e)
2758
def _move_entry(self, entry):
2759
inv = self.inventory
2760
from_rel_abs = self.abspath(entry.from_rel)
2761
to_rel_abs = self.abspath(entry.to_rel)
2762
if from_rel_abs == to_rel_abs:
2763
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2764
"Source and target are identical.")
2766
if not entry.only_change_inv:
2768
osutils.rename(from_rel_abs, to_rel_abs)
2770
raise errors.BzrMoveFailedError(entry.from_rel,
2772
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2774
@needs_tree_write_lock
2775
def unversion(self, file_ids):
2776
"""Remove the file ids in file_ids from the current versioned set.
2778
When a file_id is unversioned, all of its children are automatically
2781
:param file_ids: The file ids to stop versioning.
2782
:raises: NoSuchId if any fileid is not currently versioned.
2784
for file_id in file_ids:
2785
if file_id not in self._inventory:
2786
raise errors.NoSuchId(self, file_id)
2787
for file_id in file_ids:
2788
if self._inventory.has_id(file_id):
2789
self._inventory.remove_recursive_id(file_id)
2791
# in the future this should just set a dirty bit to wait for the
2792
# final unlock. However, until all methods of workingtree start
2793
# with the current in -memory inventory rather than triggering
2794
# a read, it is more complex - we need to teach read_inventory
2795
# to know when to read, and when to not read first... and possibly
2796
# to save first when the in memory one may be corrupted.
2797
# so for now, we just only write it if it is indeed dirty.
2799
self._write_inventory(self._inventory)
2801
def stored_kind(self, file_id):
2802
"""See Tree.stored_kind"""
2803
return self.inventory[file_id].kind
2806
"""Yield all unversioned files in this WorkingTree.
2808
If there are any unversioned directories then only the directory is
2809
returned, not all its children. But if there are unversioned files
2810
under a versioned subdirectory, they are returned.
2812
Currently returned depth-first, sorted by name within directories.
2813
This is the same order used by 'osutils.walkdirs'.
2815
## TODO: Work from given directory downwards
2816
for path, dir_entry in self.inventory.directories():
2817
# mutter("search for unknowns in %r", path)
2818
dirabs = self.abspath(path)
2819
if not isdir(dirabs):
2820
# e.g. directory deleted
2824
for subf in os.listdir(dirabs):
2825
if self.bzrdir.is_control_filename(subf):
2827
if subf not in dir_entry.children:
2830
can_access) = osutils.normalized_filename(subf)
2831
except UnicodeDecodeError:
2832
path_os_enc = path.encode(osutils._fs_enc)
2833
relpath = path_os_enc + '/' + subf
2834
raise errors.BadFilenameEncoding(relpath,
2836
if subf_norm != subf and can_access:
2837
if subf_norm not in dir_entry.children:
2838
fl.append(subf_norm)
2844
subp = pathjoin(path, subf)
2847
def _walkdirs(self, prefix=""):
2848
"""Walk the directories of this tree.
2850
:prefix: is used as the directrory to start with.
2851
returns a generator which yields items in the form:
2852
((curren_directory_path, fileid),
2853
[(file1_path, file1_name, file1_kind, None, file1_id,
2856
_directory = 'directory'
2857
# get the root in the inventory
2858
inv = self.inventory
2859
top_id = inv.path2id(prefix)
2863
pending = [(prefix, '', _directory, None, top_id, None)]
2866
currentdir = pending.pop()
2867
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2868
top_id = currentdir[4]
2870
relroot = currentdir[0] + '/'
2873
# FIXME: stash the node in pending
2875
if entry.kind == 'directory':
2876
for name, child in entry.sorted_children():
2877
dirblock.append((relroot + name, name, child.kind, None,
2878
child.file_id, child.kind
2880
yield (currentdir[0], entry.file_id), dirblock
2881
# push the user specified dirs from dirblock
2882
for dir in reversed(dirblock):
2883
if dir[2] == _directory:
2887
class WorkingTree3(InventoryWorkingTree):
2666
2888
"""This is the Format 3 working tree.
2668
2890
This differs from the base WorkingTree by:
added
removed
bzrlib/workingtree.py
