1813
2689
return ShelfManager(self, self._transport)
1816
class InventoryWorkingTree(WorkingTree,
1817
bzrlib.mutabletree.MutableInventoryTree):
1818
"""Base class for working trees that are inventory-oriented.
1820
The inventory is held in the `Branch` working-inventory, and the
1821
files are in a directory on disk.
1823
It is possible for a `WorkingTree` to have a filename which is
1824
not listed in the Inventory and vice versa.
2692
class WorkingTree3(WorkingTree):
2693
"""This is the Format 3 working tree.
2695
This differs from the base WorkingTree by:
2696
- having its own file lock
2697
- having its own last-revision property.
2699
This is new in bzr 0.8
1827
def __init__(self, basedir='.',
1828
branch=DEPRECATED_PARAMETER,
1830
_control_files=None,
1834
"""Construct a InventoryWorkingTree instance. This is not a public API.
1836
:param branch: A branch to override probing for the branch.
1838
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1839
branch=branch, _control_files=_control_files, _internal=_internal,
1840
_format=_format, _bzrdir=_bzrdir)
1842
if _inventory is None:
1843
# This will be acquired on lock_read() or lock_write()
1844
self._inventory_is_modified = False
1845
self._inventory = None
1847
# the caller of __init__ has provided an inventory,
1848
# we assume they know what they are doing - as its only
1849
# the Format factory and creation methods that are
1850
# permitted to do this.
1851
self._set_inventory(_inventory, dirty=False)
1853
def _set_inventory(self, inv, dirty):
1854
"""Set the internal cached inventory.
1856
:param inv: The inventory to set.
1857
:param dirty: A boolean indicating whether the inventory is the same
1858
logical inventory as whats on disk. If True the inventory is not
1859
the same and should be written to disk or data will be lost, if
1860
False then the inventory is the same as that on disk and any
1861
serialisation would be unneeded overhead.
1863
self._inventory = inv
1864
self._inventory_is_modified = dirty
1866
def _serialize(self, inventory, out_file):
1867
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1870
def _deserialize(selt, in_file):
1871
return xml5.serializer_v5.read_inventory(in_file)
1873
@needs_tree_write_lock
1874
def _write_inventory(self, inv):
1875
"""Write inventory as the current inventory."""
1876
self._set_inventory(inv, dirty=True)
1879
# XXX: This method should be deprecated in favour of taking in a proper
1880
# new Inventory object.
1881
@needs_tree_write_lock
1882
def set_inventory(self, new_inventory_list):
1883
from bzrlib.inventory import (Inventory,
1887
inv = Inventory(self.get_root_id())
1888
for path, file_id, parent, kind in new_inventory_list:
1889
name = os.path.basename(path)
1892
# fixme, there should be a factory function inv,add_??
1893
if kind == 'directory':
1894
inv.add(InventoryDirectory(file_id, name, parent))
1895
elif kind == 'file':
1896
inv.add(InventoryFile(file_id, name, parent))
1897
elif kind == 'symlink':
1898
inv.add(InventoryLink(file_id, name, parent))
1900
raise errors.BzrError("unknown kind %r" % kind)
1901
self._write_inventory(inv)
1903
def _write_basis_inventory(self, xml):
1904
"""Write the basis inventory XML to the basis-inventory file"""
1905
path = self._basis_inventory_name()
1907
self._transport.put_file(path, sio,
1908
mode=self.bzrdir._get_file_mode())
1910
def _reset_data(self):
1911
"""Reset transient data that cannot be revalidated."""
1912
self._inventory_is_modified = False
1913
f = self._transport.get('inventory')
1915
result = self._deserialize(f)
1918
self._set_inventory(result, dirty=False)
1920
def _set_root_id(self, file_id):
1921
"""Set the root id for this tree, in a format specific manner.
1923
:param file_id: The file id to assign to the root. It must not be
1924
present in the current inventory or an error will occur. It must
1925
not be None, but rather a valid file id.
1927
inv = self._inventory
1928
orig_root_id = inv.root.file_id
1929
# TODO: it might be nice to exit early if there was nothing
1930
# to do, saving us from trigger a sync on unlock.
1931
self._inventory_is_modified = True
1932
# we preserve the root inventory entry object, but
1933
# unlinkit from the byid index
1934
del inv._byid[inv.root.file_id]
1935
inv.root.file_id = file_id
1936
# and link it into the index with the new changed id.
1937
inv._byid[inv.root.file_id] = inv.root
1938
# and finally update all children to reference the new id.
1939
# XXX: this should be safe to just look at the root.children
1940
# list, not the WHOLE INVENTORY.
1943
if entry.parent_id == orig_root_id:
1944
entry.parent_id = inv.root.file_id
1946
def all_file_ids(self):
1947
"""See Tree.iter_all_file_ids"""
1948
return set(self.inventory)
1950
@needs_tree_write_lock
1951
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1952
"""See MutableTree.set_parent_trees."""
1953
parent_ids = [rev for (rev, tree) in parents_list]
1954
for revision_id in parent_ids:
1955
_mod_revision.check_not_reserved_id(revision_id)
1957
self._check_parents_for_ghosts(parent_ids,
1958
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1960
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1962
if len(parent_ids) == 0:
1963
leftmost_parent_id = _mod_revision.NULL_REVISION
1964
leftmost_parent_tree = None
1966
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1968
if self._change_last_revision(leftmost_parent_id):
1969
if leftmost_parent_tree is None:
1970
# If we don't have a tree, fall back to reading the
1971
# parent tree from the repository.
1972
self._cache_basis_inventory(leftmost_parent_id)
1974
inv = leftmost_parent_tree.inventory
1975
xml = self._create_basis_xml_from_inventory(
1976
leftmost_parent_id, inv)
1977
self._write_basis_inventory(xml)
1978
self._set_merges_from_parent_ids(parent_ids)
1980
def _cache_basis_inventory(self, new_revision):
1981
"""Cache new_revision as the basis inventory."""
1982
# TODO: this should allow the ready-to-use inventory to be passed in,
1983
# as commit already has that ready-to-use [while the format is the
1986
# this double handles the inventory - unpack and repack -
1987
# but is easier to understand. We can/should put a conditional
1988
# in here based on whether the inventory is in the latest format
1989
# - perhaps we should repack all inventories on a repository
1991
# the fast path is to copy the raw xml from the repository. If the
1992
# xml contains 'revision_id="', then we assume the right
1993
# revision_id is set. We must check for this full string, because a
1994
# root node id can legitimately look like 'revision_id' but cannot
1996
xml = self.branch.repository._get_inventory_xml(new_revision)
1997
firstline = xml.split('\n', 1)[0]
1998
if (not 'revision_id="' in firstline or
1999
'format="7"' not in firstline):
2000
inv = self.branch.repository._serializer.read_inventory_from_string(
2002
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2003
self._write_basis_inventory(xml)
2004
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2007
def _basis_inventory_name(self):
2008
return 'basis-inventory-cache'
2010
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2011
"""Create the text that will be saved in basis-inventory"""
2012
inventory.revision_id = revision_id
2013
return xml7.serializer_v7.write_inventory_to_string(inventory)
2703
def _last_revision(self):
2704
"""See Mutable.last_revision."""
2706
return self._transport.get_bytes('last-revision')
2707
except errors.NoSuchFile:
2708
return _mod_revision.NULL_REVISION
2710
def _change_last_revision(self, revision_id):
2711
"""See WorkingTree._change_last_revision."""
2712
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2714
self._transport.delete('last-revision')
2715
except errors.NoSuchFile:
2719
self._transport.put_bytes('last-revision', revision_id,
2720
mode=self.bzrdir._get_file_mode())
2723
def _get_check_refs(self):
2724
"""Return the references needed to perform a check of this tree."""
2725
return [('trees', self.last_revision())]
2015
2727
@needs_tree_write_lock
2016
2728
def set_conflicts(self, conflicts):
2042
2754
confile.close()
2044
def read_basis_inventory(self):
2045
"""Read the cached basis inventory."""
2046
path = self._basis_inventory_name()
2047
return self._transport.get_bytes(path)
2050
def read_working_inventory(self):
2051
"""Read the working inventory.
2053
:raises errors.InventoryModified: read_working_inventory will fail
2054
when the current in memory inventory has been modified.
2056
# conceptually this should be an implementation detail of the tree.
2057
# XXX: Deprecate this.
2058
# ElementTree does its own conversion from UTF-8, so open in
2060
if self._inventory_is_modified:
2061
raise errors.InventoryModified(self)
2062
f = self._transport.get('inventory')
2064
result = self._deserialize(f)
2067
self._set_inventory(result, dirty=False)
2071
def get_root_id(self):
2072
"""Return the id of this trees root"""
2073
return self._inventory.root.file_id
2075
def has_id(self, file_id):
2076
# files that have been deleted are excluded
2077
inv = self.inventory
2078
if not inv.has_id(file_id):
2080
path = inv.id2path(file_id)
2081
return osutils.lexists(self.abspath(path))
2083
def has_or_had_id(self, file_id):
2084
if file_id == self.inventory.root.file_id:
2086
return self.inventory.has_id(file_id)
2088
__contains__ = has_id
2090
# should be deprecated - this is slow and in any case treating them as a
2091
# container is (we now know) bad style -- mbp 20070302
2092
## @deprecated_method(zero_fifteen)
2094
"""Iterate through file_ids for this tree.
2096
file_ids are in a WorkingTree if they are in the working inventory
2097
and the working file exists.
2099
inv = self._inventory
2100
for path, ie in inv.iter_entries():
2101
if osutils.lexists(self.abspath(path)):
2104
@needs_tree_write_lock
2105
def set_last_revision(self, new_revision):
2106
"""Change the last revision in the working tree."""
2107
if self._change_last_revision(new_revision):
2108
self._cache_basis_inventory(new_revision)
2110
@needs_tree_write_lock
2111
def reset_state(self, revision_ids=None):
2112
"""Reset the state of the working tree.
2114
This does a hard-reset to a last-known-good state. This is a way to
2115
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2117
if revision_ids is None:
2118
revision_ids = self.get_parent_ids()
2119
if not revision_ids:
2120
rt = self.branch.repository.revision_tree(
2121
_mod_revision.NULL_REVISION)
2123
rt = self.branch.repository.revision_tree(revision_ids[0])
2124
self._write_inventory(rt.inventory)
2125
self.set_parent_ids(revision_ids)
2128
"""Write the in memory inventory to disk."""
2129
# TODO: Maybe this should only write on dirty ?
2130
if self._control_files._lock_mode != 'w':
2131
raise errors.NotWriteLocked(self)
2133
self._serialize(self._inventory, sio)
2135
self._transport.put_file('inventory', sio,
2136
mode=self.bzrdir._get_file_mode())
2137
self._inventory_is_modified = False
2140
def get_file_sha1(self, file_id, path=None, stat_value=None):
2142
path = self._inventory.id2path(file_id)
2143
return self._hashcache.get_sha1(path, stat_value)
2145
def get_file_mtime(self, file_id, path=None):
2146
"""See Tree.get_file_mtime."""
2148
path = self.inventory.id2path(file_id)
2149
return os.lstat(self.abspath(path)).st_mtime
2151
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2152
file_id = self.path2id(path)
2154
# For unversioned files on win32, we just assume they are not
2157
return self._inventory[file_id].executable
2159
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2160
mode = stat_result.st_mode
2161
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2163
if not supports_executable():
2164
def is_executable(self, file_id, path=None):
2165
return self._inventory[file_id].executable
2167
_is_executable_from_path_and_stat = \
2168
_is_executable_from_path_and_stat_from_basis
2170
def is_executable(self, file_id, path=None):
2172
path = self.id2path(file_id)
2173
mode = os.lstat(self.abspath(path)).st_mode
2174
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2176
_is_executable_from_path_and_stat = \
2177
_is_executable_from_path_and_stat_from_stat
2179
@needs_tree_write_lock
2180
def _add(self, files, ids, kinds):
2181
"""See MutableTree._add."""
2182
# TODO: Re-adding a file that is removed in the working copy
2183
# should probably put it back with the previous ID.
2184
# the read and write working inventory should not occur in this
2185
# function - they should be part of lock_write and unlock.
2186
inv = self.inventory
2187
for f, file_id, kind in zip(files, ids, kinds):
2189
inv.add_path(f, kind=kind)
2191
inv.add_path(f, kind=kind, file_id=file_id)
2192
self._inventory_is_modified = True
2194
def revision_tree(self, revision_id):
2195
"""See WorkingTree.revision_id."""
2196
if revision_id == self.last_revision():
2198
xml = self.read_basis_inventory()
2199
except errors.NoSuchFile:
2203
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2204
# dont use the repository revision_tree api because we want
2205
# to supply the inventory.
2206
if inv.revision_id == revision_id:
2207
return revisiontree.InventoryRevisionTree(
2208
self.branch.repository, inv, revision_id)
2209
except errors.BadInventoryFormat:
2211
# raise if there was no inventory, or if we read the wrong inventory.
2212
raise errors.NoSuchRevisionInTree(self, revision_id)
2215
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2216
"""See Tree.annotate_iter
2218
This implementation will use the basis tree implementation if possible.
2219
Lines not in the basis are attributed to CURRENT_REVISION
2221
If there are pending merges, lines added by those merges will be
2222
incorrectly attributed to CURRENT_REVISION (but after committing, the
2223
attribution will be correct).
2225
maybe_file_parent_keys = []
2226
for parent_id in self.get_parent_ids():
2228
parent_tree = self.revision_tree(parent_id)
2229
except errors.NoSuchRevisionInTree:
2230
parent_tree = self.branch.repository.revision_tree(parent_id)
2231
parent_tree.lock_read()
2233
if file_id not in parent_tree:
2235
ie = parent_tree.inventory[file_id]
2236
if ie.kind != 'file':
2237
# Note: this is slightly unnecessary, because symlinks and
2238
# directories have a "text" which is the empty text, and we
2239
# know that won't mess up annotations. But it seems cleaner
2241
parent_text_key = (file_id, ie.revision)
2242
if parent_text_key not in maybe_file_parent_keys:
2243
maybe_file_parent_keys.append(parent_text_key)
2245
parent_tree.unlock()
2246
graph = _mod_graph.Graph(self.branch.repository.texts)
2247
heads = graph.heads(maybe_file_parent_keys)
2248
file_parent_keys = []
2249
for key in maybe_file_parent_keys:
2251
file_parent_keys.append(key)
2253
# Now we have the parents of this content
2254
annotator = self.branch.repository.texts.get_annotator()
2255
text = self.get_file_text(file_id)
2256
this_key =(file_id, default_revision)
2257
annotator.add_special_text(this_key, file_parent_keys, text)
2258
annotations = [(key[-1], line)
2259
for key, line in annotator.annotate_flat(this_key)]
2263
def merge_modified(self):
2264
"""Return a dictionary of files modified by a merge.
2266
The list is initialized by WorkingTree.set_merge_modified, which is
2267
typically called after we make some automatic updates to the tree
2270
This returns a map of file_id->sha1, containing only files which are
2271
still in the working inventory and have that text hash.
2274
hashfile = self._transport.get('merge-hashes')
2275
except errors.NoSuchFile:
2280
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2281
raise errors.MergeModifiedFormatError()
2282
except StopIteration:
2283
raise errors.MergeModifiedFormatError()
2284
for s in _mod_rio.RioReader(hashfile):
2285
# RioReader reads in Unicode, so convert file_ids back to utf8
2286
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2287
if file_id not in self.inventory:
2289
text_hash = s.get("hash")
2290
if text_hash == self.get_file_sha1(file_id):
2291
merge_hashes[file_id] = text_hash
2297
def subsume(self, other_tree):
2298
def add_children(inventory, entry):
2299
for child_entry in entry.children.values():
2300
inventory._byid[child_entry.file_id] = child_entry
2301
if child_entry.kind == 'directory':
2302
add_children(inventory, child_entry)
2303
if other_tree.get_root_id() == self.get_root_id():
2304
raise errors.BadSubsumeSource(self, other_tree,
2305
'Trees have the same root')
2307
other_tree_path = self.relpath(other_tree.basedir)
2308
except errors.PathNotChild:
2309
raise errors.BadSubsumeSource(self, other_tree,
2310
'Tree is not contained by the other')
2311
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2312
if new_root_parent is None:
2313
raise errors.BadSubsumeSource(self, other_tree,
2314
'Parent directory is not versioned.')
2315
# We need to ensure that the result of a fetch will have a
2316
# versionedfile for the other_tree root, and only fetching into
2317
# RepositoryKnit2 guarantees that.
2318
if not self.branch.repository.supports_rich_root():
2319
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2320
other_tree.lock_tree_write()
2322
new_parents = other_tree.get_parent_ids()
2323
other_root = other_tree.inventory.root
2324
other_root.parent_id = new_root_parent
2325
other_root.name = osutils.basename(other_tree_path)
2326
self.inventory.add(other_root)
2327
add_children(self.inventory, other_root)
2328
self._write_inventory(self.inventory)
2329
# normally we don't want to fetch whole repositories, but i think
2330
# here we really do want to consolidate the whole thing.
2331
for parent_id in other_tree.get_parent_ids():
2332
self.branch.fetch(other_tree.branch, parent_id)
2333
self.add_parent_tree_id(parent_id)
2336
other_tree.bzrdir.retire_bzrdir()
2338
@needs_tree_write_lock
2339
def extract(self, file_id, format=None):
2340
"""Extract a subtree from this tree.
2342
A new branch will be created, relative to the path for this tree.
2346
segments = osutils.splitpath(path)
2347
transport = self.branch.bzrdir.root_transport
2348
for name in segments:
2349
transport = transport.clone(name)
2350
transport.ensure_base()
2353
sub_path = self.id2path(file_id)
2354
branch_transport = mkdirs(sub_path)
2356
format = self.bzrdir.cloning_metadir()
2357
branch_transport.ensure_base()
2358
branch_bzrdir = format.initialize_on_transport(branch_transport)
2360
repo = branch_bzrdir.find_repository()
2361
except errors.NoRepositoryPresent:
2362
repo = branch_bzrdir.create_repository()
2363
if not repo.supports_rich_root():
2364
raise errors.RootNotRich()
2365
new_branch = branch_bzrdir.create_branch()
2366
new_branch.pull(self.branch)
2367
for parent_id in self.get_parent_ids():
2368
new_branch.fetch(self.branch, parent_id)
2369
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2370
if tree_transport.base != branch_transport.base:
2371
tree_bzrdir = format.initialize_on_transport(tree_transport)
2372
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2373
target_branch=new_branch)
2375
tree_bzrdir = branch_bzrdir
2376
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2377
wt.set_parent_ids(self.get_parent_ids())
2378
my_inv = self.inventory
2379
child_inv = inventory.Inventory(root_id=None)
2380
new_root = my_inv[file_id]
2381
my_inv.remove_recursive_id(file_id)
2382
new_root.parent_id = None
2383
child_inv.add(new_root)
2384
self._write_inventory(my_inv)
2385
wt._write_inventory(child_inv)
2388
def list_files(self, include_root=False, from_dir=None, recursive=True):
2389
"""List all files as (path, class, kind, id, entry).
2391
Lists, but does not descend into unversioned directories.
2392
This does not include files that have been deleted in this
2393
tree. Skips the control directory.
2395
:param include_root: if True, return an entry for the root
2396
:param from_dir: start from this directory or None for the root
2397
:param recursive: whether to recurse into subdirectories or not
2399
# list_files is an iterator, so @needs_read_lock doesn't work properly
2400
# with it. So callers should be careful to always read_lock the tree.
2401
if not self.is_locked():
2402
raise errors.ObjectNotLocked(self)
2404
inv = self.inventory
2405
if from_dir is None and include_root is True:
2406
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2407
# Convert these into local objects to save lookup times
2408
pathjoin = osutils.pathjoin
2409
file_kind = self._kind
2411
# transport.base ends in a slash, we want the piece
2412
# between the last two slashes
2413
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2415
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2417
# directory file_id, relative path, absolute path, reverse sorted children
2418
if from_dir is not None:
2419
from_dir_id = inv.path2id(from_dir)
2420
if from_dir_id is None:
2421
# Directory not versioned
2423
from_dir_abspath = pathjoin(self.basedir, from_dir)
2425
from_dir_id = inv.root.file_id
2426
from_dir_abspath = self.basedir
2427
children = os.listdir(from_dir_abspath)
2429
# jam 20060527 The kernel sized tree seems equivalent whether we
2430
# use a deque and popleft to keep them sorted, or if we use a plain
2431
# list and just reverse() them.
2432
children = collections.deque(children)
2433
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2435
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2438
f = children.popleft()
2439
## TODO: If we find a subdirectory with its own .bzr
2440
## directory, then that is a separate tree and we
2441
## should exclude it.
2443
# the bzrdir for this tree
2444
if transport_base_dir == f:
2447
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2448
# and 'f' doesn't begin with one, we can do a string op, rather
2449
# than the checks of pathjoin(), all relative paths will have an extra slash
2451
fp = from_dir_relpath + '/' + f
2454
fap = from_dir_abspath + '/' + f
2456
dir_ie = inv[from_dir_id]
2457
if dir_ie.kind == 'directory':
2458
f_ie = dir_ie.children.get(f)
2463
elif self.is_ignored(fp[1:]):
2466
# we may not have found this file, because of a unicode
2467
# issue, or because the directory was actually a symlink.
2468
f_norm, can_access = osutils.normalized_filename(f)
2469
if f == f_norm or not can_access:
2470
# No change, so treat this file normally
2473
# this file can be accessed by a normalized path
2474
# check again if it is versioned
2475
# these lines are repeated here for performance
2477
fp = from_dir_relpath + '/' + f
2478
fap = from_dir_abspath + '/' + f
2479
f_ie = inv.get_child(from_dir_id, f)
2482
elif self.is_ignored(fp[1:]):
2489
# make a last minute entry
2491
yield fp[1:], c, fk, f_ie.file_id, f_ie
2494
yield fp[1:], c, fk, None, fk_entries[fk]()
2496
yield fp[1:], c, fk, None, TreeEntry()
2499
if fk != 'directory':
2502
# But do this child first if recursing down
2504
new_children = os.listdir(fap)
2506
new_children = collections.deque(new_children)
2507
stack.append((f_ie.file_id, fp, fap, new_children))
2508
# Break out of inner loop,
2509
# so that we start outer loop with child
2512
# if we finished all children, pop it off the stack
2515
@needs_tree_write_lock
2516
def move(self, from_paths, to_dir=None, after=False):
2519
to_dir must exist in the inventory.
2521
If to_dir exists and is a directory, the files are moved into
2522
it, keeping their old names.
2524
Note that to_dir is only the last component of the new name;
2525
this doesn't change the directory.
2527
For each entry in from_paths the move mode will be determined
2530
The first mode moves the file in the filesystem and updates the
2531
inventory. The second mode only updates the inventory without
2532
touching the file on the filesystem.
2534
move uses the second mode if 'after == True' and the target is not
2535
versioned but present in the working tree.
2537
move uses the second mode if 'after == False' and the source is
2538
versioned but no longer in the working tree, and the target is not
2539
versioned but present in the working tree.
2541
move uses the first mode if 'after == False' and the source is
2542
versioned and present in the working tree, and the target is not
2543
versioned and not present in the working tree.
2545
Everything else results in an error.
2547
This returns a list of (from_path, to_path) pairs for each
2548
entry that is moved.
2553
# check for deprecated use of signature
2555
raise TypeError('You must supply a target directory')
2556
# check destination directory
2557
if isinstance(from_paths, basestring):
2559
inv = self.inventory
2560
to_abs = self.abspath(to_dir)
2561
if not isdir(to_abs):
2562
raise errors.BzrMoveFailedError('',to_dir,
2563
errors.NotADirectory(to_abs))
2564
if not self.has_filename(to_dir):
2565
raise errors.BzrMoveFailedError('',to_dir,
2566
errors.NotInWorkingDirectory(to_dir))
2567
to_dir_id = inv.path2id(to_dir)
2568
if to_dir_id is None:
2569
raise errors.BzrMoveFailedError('',to_dir,
2570
errors.NotVersionedError(path=to_dir))
2572
to_dir_ie = inv[to_dir_id]
2573
if to_dir_ie.kind != 'directory':
2574
raise errors.BzrMoveFailedError('',to_dir,
2575
errors.NotADirectory(to_abs))
2577
# create rename entries and tuples
2578
for from_rel in from_paths:
2579
from_tail = splitpath(from_rel)[-1]
2580
from_id = inv.path2id(from_rel)
2582
raise errors.BzrMoveFailedError(from_rel,to_dir,
2583
errors.NotVersionedError(path=from_rel))
2585
from_entry = inv[from_id]
2586
from_parent_id = from_entry.parent_id
2587
to_rel = pathjoin(to_dir, from_tail)
2588
rename_entry = InventoryWorkingTree._RenameEntry(
2591
from_tail=from_tail,
2592
from_parent_id=from_parent_id,
2593
to_rel=to_rel, to_tail=from_tail,
2594
to_parent_id=to_dir_id)
2595
rename_entries.append(rename_entry)
2596
rename_tuples.append((from_rel, to_rel))
2598
# determine which move mode to use. checks also for movability
2599
rename_entries = self._determine_mv_mode(rename_entries, after)
2601
original_modified = self._inventory_is_modified
2604
self._inventory_is_modified = True
2605
self._move(rename_entries)
2607
# restore the inventory on error
2608
self._inventory_is_modified = original_modified
2610
self._write_inventory(inv)
2611
return rename_tuples
2613
@needs_tree_write_lock
2614
def rename_one(self, from_rel, to_rel, after=False):
2617
This can change the directory or the filename or both.
2619
rename_one has several 'modes' to work. First, it can rename a physical
2620
file and change the file_id. That is the normal mode. Second, it can
2621
only change the file_id without touching any physical file.
2623
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2624
versioned but present in the working tree.
2626
rename_one uses the second mode if 'after == False' and 'from_rel' is
2627
versioned but no longer in the working tree, and 'to_rel' is not
2628
versioned but present in the working tree.
2630
rename_one uses the first mode if 'after == False' and 'from_rel' is
2631
versioned and present in the working tree, and 'to_rel' is not
2632
versioned and not present in the working tree.
2634
Everything else results in an error.
2636
inv = self.inventory
2639
# create rename entries and tuples
2640
from_tail = splitpath(from_rel)[-1]
2641
from_id = inv.path2id(from_rel)
2643
# if file is missing in the inventory maybe it's in the basis_tree
2644
basis_tree = self.branch.basis_tree()
2645
from_id = basis_tree.path2id(from_rel)
2647
raise errors.BzrRenameFailedError(from_rel,to_rel,
2648
errors.NotVersionedError(path=from_rel))
2649
# put entry back in the inventory so we can rename it
2650
from_entry = basis_tree.inventory[from_id].copy()
2653
from_entry = inv[from_id]
2654
from_parent_id = from_entry.parent_id
2655
to_dir, to_tail = os.path.split(to_rel)
2656
to_dir_id = inv.path2id(to_dir)
2657
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2659
from_tail=from_tail,
2660
from_parent_id=from_parent_id,
2661
to_rel=to_rel, to_tail=to_tail,
2662
to_parent_id=to_dir_id)
2663
rename_entries.append(rename_entry)
2665
# determine which move mode to use. checks also for movability
2666
rename_entries = self._determine_mv_mode(rename_entries, after)
2668
# check if the target changed directory and if the target directory is
2670
if to_dir_id is None:
2671
raise errors.BzrMoveFailedError(from_rel,to_rel,
2672
errors.NotVersionedError(path=to_dir))
2674
# all checks done. now we can continue with our actual work
2675
mutter('rename_one:\n'
2680
' to_dir_id {%s}\n',
2681
from_id, from_rel, to_rel, to_dir, to_dir_id)
2683
self._move(rename_entries)
2684
self._write_inventory(inv)
2686
class _RenameEntry(object):
2687
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2688
to_rel, to_tail, to_parent_id, only_change_inv=False):
2689
self.from_rel = from_rel
2690
self.from_id = from_id
2691
self.from_tail = from_tail
2692
self.from_parent_id = from_parent_id
2693
self.to_rel = to_rel
2694
self.to_tail = to_tail
2695
self.to_parent_id = to_parent_id
2696
self.only_change_inv = only_change_inv
2698
def _determine_mv_mode(self, rename_entries, after=False):
2699
"""Determines for each from-to pair if both inventory and working tree
2700
or only the inventory has to be changed.
2702
Also does basic plausability tests.
2704
inv = self.inventory
2706
for rename_entry in rename_entries:
2707
# store to local variables for easier reference
2708
from_rel = rename_entry.from_rel
2709
from_id = rename_entry.from_id
2710
to_rel = rename_entry.to_rel
2711
to_id = inv.path2id(to_rel)
2712
only_change_inv = False
2714
# check the inventory for source and destination
2716
raise errors.BzrMoveFailedError(from_rel,to_rel,
2717
errors.NotVersionedError(path=from_rel))
2718
if to_id is not None:
2719
raise errors.BzrMoveFailedError(from_rel,to_rel,
2720
errors.AlreadyVersionedError(path=to_rel))
2722
# try to determine the mode for rename (only change inv or change
2723
# inv and file system)
2725
if not self.has_filename(to_rel):
2726
raise errors.BzrMoveFailedError(from_id,to_rel,
2727
errors.NoSuchFile(path=to_rel,
2728
extra="New file has not been created yet"))
2729
only_change_inv = True
2730
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2731
only_change_inv = True
2732
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2733
only_change_inv = False
2734
elif (not self.case_sensitive
2735
and from_rel.lower() == to_rel.lower()
2736
and self.has_filename(from_rel)):
2737
only_change_inv = False
2739
# something is wrong, so lets determine what exactly
2740
if not self.has_filename(from_rel) and \
2741
not self.has_filename(to_rel):
2742
raise errors.BzrRenameFailedError(from_rel,to_rel,
2743
errors.PathsDoNotExist(paths=(str(from_rel),
2746
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2747
rename_entry.only_change_inv = only_change_inv
2748
return rename_entries
2750
def _move(self, rename_entries):
2751
"""Moves a list of files.
2753
Depending on the value of the flag 'only_change_inv', the
2754
file will be moved on the file system or not.
2756
inv = self.inventory
2759
for entry in rename_entries:
2761
self._move_entry(entry)
2763
self._rollback_move(moved)
2767
def _rollback_move(self, moved):
2768
"""Try to rollback a previous move in case of an filesystem error."""
2769
inv = self.inventory
2772
self._move_entry(WorkingTree._RenameEntry(
2773
entry.to_rel, entry.from_id,
2774
entry.to_tail, entry.to_parent_id, entry.from_rel,
2775
entry.from_tail, entry.from_parent_id,
2776
entry.only_change_inv))
2777
except errors.BzrMoveFailedError, e:
2778
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2779
" The working tree is in an inconsistent state."
2780
" Please consider doing a 'bzr revert'."
2781
" Error message is: %s" % e)
2783
def _move_entry(self, entry):
2784
inv = self.inventory
2785
from_rel_abs = self.abspath(entry.from_rel)
2786
to_rel_abs = self.abspath(entry.to_rel)
2787
if from_rel_abs == to_rel_abs:
2788
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2789
"Source and target are identical.")
2791
if not entry.only_change_inv:
2793
osutils.rename(from_rel_abs, to_rel_abs)
2795
raise errors.BzrMoveFailedError(entry.from_rel,
2797
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2799
@needs_tree_write_lock
2800
def unversion(self, file_ids):
2801
"""Remove the file ids in file_ids from the current versioned set.
2803
When a file_id is unversioned, all of its children are automatically
2806
:param file_ids: The file ids to stop versioning.
2807
:raises: NoSuchId if any fileid is not currently versioned.
2809
for file_id in file_ids:
2810
if file_id not in self._inventory:
2811
raise errors.NoSuchId(self, file_id)
2812
for file_id in file_ids:
2813
if self._inventory.has_id(file_id):
2814
self._inventory.remove_recursive_id(file_id)
2816
# in the future this should just set a dirty bit to wait for the
2817
# final unlock. However, until all methods of workingtree start
2818
# with the current in -memory inventory rather than triggering
2819
# a read, it is more complex - we need to teach read_inventory
2820
# to know when to read, and when to not read first... and possibly
2821
# to save first when the in memory one may be corrupted.
2822
# so for now, we just only write it if it is indeed dirty.
2824
self._write_inventory(self._inventory)
2826
def stored_kind(self, file_id):
2827
"""See Tree.stored_kind"""
2828
return self.inventory[file_id].kind
2831
"""Yield all unversioned files in this WorkingTree.
2833
If there are any unversioned directories then only the directory is
2834
returned, not all its children. But if there are unversioned files
2835
under a versioned subdirectory, they are returned.
2837
Currently returned depth-first, sorted by name within directories.
2838
This is the same order used by 'osutils.walkdirs'.
2840
## TODO: Work from given directory downwards
2841
for path, dir_entry in self.inventory.directories():
2842
# mutter("search for unknowns in %r", path)
2843
dirabs = self.abspath(path)
2844
if not isdir(dirabs):
2845
# e.g. directory deleted
2849
for subf in os.listdir(dirabs):
2850
if self.bzrdir.is_control_filename(subf):
2852
if subf not in dir_entry.children:
2855
can_access) = osutils.normalized_filename(subf)
2856
except UnicodeDecodeError:
2857
path_os_enc = path.encode(osutils._fs_enc)
2858
relpath = path_os_enc + '/' + subf
2859
raise errors.BadFilenameEncoding(relpath,
2861
if subf_norm != subf and can_access:
2862
if subf_norm not in dir_entry.children:
2863
fl.append(subf_norm)
2869
subp = pathjoin(path, subf)
2872
def _walkdirs(self, prefix=""):
2873
"""Walk the directories of this tree.
2875
:prefix: is used as the directrory to start with.
2876
returns a generator which yields items in the form:
2877
((curren_directory_path, fileid),
2878
[(file1_path, file1_name, file1_kind, None, file1_id,
2881
_directory = 'directory'
2882
# get the root in the inventory
2883
inv = self.inventory
2884
top_id = inv.path2id(prefix)
2888
pending = [(prefix, '', _directory, None, top_id, None)]
2891
currentdir = pending.pop()
2892
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2893
top_id = currentdir[4]
2895
relroot = currentdir[0] + '/'
2898
# FIXME: stash the node in pending
2900
if entry.kind == 'directory':
2901
for name, child in entry.sorted_children():
2902
dirblock.append((relroot + name, name, child.kind, None,
2903
child.file_id, child.kind
2905
yield (currentdir[0], entry.file_id), dirblock
2906
# push the user specified dirs from dirblock
2907
for dir in reversed(dirblock):
2908
if dir[2] == _directory:
2757
# do non-implementation specific cleanup
2759
if self._control_files._lock_count == 1:
2760
# _inventory_is_modified is always False during a read lock.
2761
if self._inventory_is_modified:
2763
self._write_hashcache_if_dirty()
2764
# reverse order of locking.
2766
return self._control_files.unlock()
2768
self.branch.unlock()
2912
2771
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):