771
718
def set_merge_modified(self, modified_hashes):
772
719
def iter_stanzas():
773
720
for file_id, hash in modified_hashes.iteritems():
774
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
721
yield Stanza(file_id=file_id, hash=hash)
776
722
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
778
def _sha_from_stat(self, path, stat_result):
779
"""Get a sha digest from the tree's stat cache.
781
The default implementation assumes no stat cache is present.
783
:param path: The path.
784
:param stat_result: The stat result being looked up.
724
@needs_tree_write_lock
788
725
def _put_rio(self, filename, stanzas, header):
789
self._must_be_locked()
790
my_file = _mod_rio.rio_file(stanzas, header)
791
self._transport.put_file(filename, my_file,
792
mode=self.bzrdir._get_file_mode())
726
my_file = rio_file(stanzas, header)
727
self._control_files.put(filename, my_file)
794
729
@needs_write_lock # because merge pulls data into the branch.
795
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
796
merge_type=None, force=False):
730
def merge_from_branch(self, branch, to_revision=None):
797
731
"""Merge from a branch into this working tree.
799
733
:param branch: The branch to merge from.
800
:param to_revision: If non-None, the merge will merge to to_revision,
801
but not beyond it. to_revision does not need to be in the history
802
of the branch when it is supplied. If None, to_revision defaults to
734
:param to_revision: If non-None, the merge will merge to to_revision, but
735
not beyond it. to_revision does not need to be in the history of
736
the branch when it is supplied. If None, to_revision defaults to
803
737
branch.last_revision().
805
739
from bzrlib.merge import Merger, Merge3Merger
806
merger = Merger(self.branch, this_tree=self)
807
# check that there are no local alterations
808
if not force and self.has_changes():
809
raise errors.UncommittedChanges(self)
810
if to_revision is None:
811
to_revision = _mod_revision.ensure_null(branch.last_revision())
812
merger.other_rev_id = to_revision
813
if _mod_revision.is_null(merger.other_rev_id):
814
raise errors.NoCommits(branch)
815
self.branch.fetch(branch, last_revision=merger.other_rev_id)
816
merger.other_basis = merger.other_rev_id
817
merger.other_tree = self.branch.repository.revision_tree(
819
merger.other_branch = branch
820
if from_revision is None:
740
pb = bzrlib.ui.ui_factory.nested_progress_bar()
742
merger = Merger(self.branch, this_tree=self, pb=pb)
743
merger.pp = ProgressPhase("Merge phase", 5, pb)
744
merger.pp.next_phase()
745
# check that there are no
747
merger.check_basis(check_clean=True, require_commits=False)
748
if to_revision is None:
749
to_revision = branch.last_revision()
750
merger.other_rev_id = to_revision
751
if merger.other_rev_id is None:
752
raise error.NoCommits(branch)
753
self.branch.fetch(branch, last_revision=merger.other_rev_id)
754
merger.other_basis = merger.other_rev_id
755
merger.other_tree = self.branch.repository.revision_tree(
757
merger.pp.next_phase()
821
758
merger.find_base()
823
merger.set_base_revision(from_revision, branch)
824
if merger.base_rev_id == merger.other_rev_id:
825
raise errors.PointlessMerge
826
merger.backup_files = False
827
if merge_type is None:
759
if merger.base_rev_id == merger.other_rev_id:
760
raise errors.PointlessMerge
761
merger.backup_files = False
828
762
merger.merge_type = Merge3Merger
830
merger.merge_type = merge_type
831
merger.set_interesting_files(None)
832
merger.show_base = False
833
merger.reprocess = False
834
conflicts = merger.do_merge()
763
merger.set_interesting_files(None)
764
merger.show_base = False
765
merger.reprocess = False
766
conflicts = merger.do_merge()
838
773
def merge_modified(self):
839
"""Return a dictionary of files modified by a merge.
841
The list is initialized by WorkingTree.set_merge_modified, which is
842
typically called after we make some automatic updates to the tree
845
This returns a map of file_id->sha1, containing only files which are
846
still in the working inventory and have that text hash.
848
raise NotImplementedError(self.merge_modified)
775
hashfile = self._control_files.get('merge-hashes')
780
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
781
raise MergeModifiedFormatError()
782
except StopIteration:
783
raise MergeModifiedFormatError()
784
for s in RioReader(hashfile):
785
file_id = s.get("file_id")
786
if file_id not in self.inventory:
789
if hash == self.get_file_sha1(file_id):
790
merge_hashes[file_id] = hash
850
793
@needs_write_lock
851
794
def mkdir(self, path, file_id=None):
852
795
"""See MutableTree.mkdir()."""
853
796
if file_id is None:
854
file_id = generate_ids.gen_file_id(os.path.basename(path))
797
file_id = gen_file_id(os.path.basename(path))
855
798
os.mkdir(self.abspath(path))
856
799
self.add(path, file_id, 'directory')
859
def get_symlink_target(self, file_id, path=None):
861
abspath = self.abspath(path)
863
abspath = self.id2abspath(file_id)
864
target = osutils.readlink(abspath)
867
def subsume(self, other_tree):
868
raise NotImplementedError(self.subsume)
870
def _setup_directory_is_tree_reference(self):
871
if self._branch.repository._format.supports_tree_reference:
872
self._directory_is_tree_reference = \
873
self._directory_may_be_tree_reference
875
self._directory_is_tree_reference = \
876
self._directory_is_never_tree_reference
878
def _directory_is_never_tree_reference(self, relpath):
881
def _directory_may_be_tree_reference(self, relpath):
882
# as a special case, if a directory contains control files then
883
# it's a tree reference, except that the root of the tree is not
884
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
885
# TODO: We could ask all the control formats whether they
886
# recognize this directory, but at the moment there's no cheap api
887
# to do that. Since we probably can only nest bzr checkouts and
888
# they always use this name it's ok for now. -- mbp 20060306
890
# FIXME: There is an unhandled case here of a subdirectory
891
# containing .bzr but not a branch; that will probably blow up
892
# when you try to commit it. It might happen if there is a
893
# checkout in a subdirectory. This can be avoided by not adding
896
def extract(self, file_id, format=None):
897
"""Extract a subtree from this tree.
899
A new branch will be created, relative to the path for this tree.
901
raise NotImplementedError(self.extract)
904
"""Write the in memory meta data to disk."""
905
raise NotImplementedError(self.flush)
907
def _kind(self, relpath):
908
return osutils.file_kind(self.abspath(relpath))
910
def list_files(self, include_root=False, from_dir=None, recursive=True):
911
"""List all files as (path, class, kind, id, entry).
802
def get_symlink_target(self, file_id):
803
return os.readlink(self.id2abspath(file_id))
805
def file_class(self, filename):
806
if self.path2id(filename):
808
elif self.is_ignored(filename):
813
def list_files(self):
814
"""Recursively list all files as (path, class, kind, id, entry).
913
816
Lists, but does not descend into unversioned directories.
914
818
This does not include files that have been deleted in this
915
tree. Skips the control directory.
917
:param include_root: if True, return an entry for the root
918
:param from_dir: start from this directory or None for the root
919
:param recursive: whether to recurse into subdirectories or not
821
Skips the control directory.
921
raise NotImplementedError(self.list_files)
923
def move(self, from_paths, to_dir=None, after=False):
823
inv = self._inventory
824
# Convert these into local objects to save lookup times
825
pathjoin = osutils.pathjoin
826
file_kind = osutils.file_kind
828
# transport.base ends in a slash, we want the piece
829
# between the last two slashes
830
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
832
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
834
# directory file_id, relative path, absolute path, reverse sorted children
835
children = os.listdir(self.basedir)
837
# jam 20060527 The kernel sized tree seems equivalent whether we
838
# use a deque and popleft to keep them sorted, or if we use a plain
839
# list and just reverse() them.
840
children = collections.deque(children)
841
stack = [(inv.root.file_id, u'', self.basedir, children)]
843
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
846
f = children.popleft()
847
## TODO: If we find a subdirectory with its own .bzr
848
## directory, then that is a separate tree and we
849
## should exclude it.
851
# the bzrdir for this tree
852
if transport_base_dir == f:
855
# we know that from_dir_relpath and from_dir_abspath never end in a slash
856
# and 'f' doesn't begin with one, we can do a string op, rather
857
# than the checks of pathjoin(), all relative paths will have an extra slash
859
fp = from_dir_relpath + '/' + f
862
fap = from_dir_abspath + '/' + f
864
f_ie = inv.get_child(from_dir_id, f)
867
elif self.is_ignored(fp[1:]):
870
# we may not have found this file, because of a unicode issue
871
f_norm, can_access = osutils.normalized_filename(f)
872
if f == f_norm or not can_access:
873
# No change, so treat this file normally
876
# this file can be accessed by a normalized path
877
# check again if it is versioned
878
# these lines are repeated here for performance
880
fp = from_dir_relpath + '/' + f
881
fap = from_dir_abspath + '/' + f
882
f_ie = inv.get_child(from_dir_id, f)
885
elif self.is_ignored(fp[1:]):
894
raise BzrCheckError("file %r entered as kind %r id %r, "
896
% (fap, f_ie.kind, f_ie.file_id, fk))
898
# make a last minute entry
900
yield fp[1:], c, fk, f_ie.file_id, f_ie
903
yield fp[1:], c, fk, None, fk_entries[fk]()
905
yield fp[1:], c, fk, None, TreeEntry()
908
if fk != 'directory':
911
# But do this child first
912
new_children = os.listdir(fap)
914
new_children = collections.deque(new_children)
915
stack.append((f_ie.file_id, fp, fap, new_children))
916
# Break out of inner loop, so that we start outer loop with child
919
# if we finished all children, pop it off the stack
922
@needs_tree_write_lock
923
def move(self, from_paths, to_name):
926
to_dir must be known to the working tree.
928
If to_dir exists and is a directory, the files are moved into
929
it, keeping their old names.
931
Note that to_dir is only the last component of the new name;
926
to_name must exist in the inventory.
928
If to_name exists and is a directory, the files are moved into
929
it, keeping their old names.
931
Note that to_name is only the last component of the new name;
932
932
this doesn't change the directory.
934
For each entry in from_paths the move mode will be determined
937
The first mode moves the file in the filesystem and updates the
938
working tree metadata. The second mode only updates the working tree
939
metadata without touching the file on the filesystem.
941
move uses the second mode if 'after == True' and the target is not
942
versioned but present in the working tree.
944
move uses the second mode if 'after == False' and the source is
945
versioned but no longer in the working tree, and the target is not
946
versioned but present in the working tree.
948
move uses the first mode if 'after == False' and the source is
949
versioned and present in the working tree, and the target is not
950
versioned and not present in the working tree.
952
Everything else results in an error.
954
934
This returns a list of (from_path, to_path) pairs for each
955
935
entry that is moved.
957
raise NotImplementedError(self.move)
938
## TODO: Option to move IDs only
939
assert not isinstance(from_paths, basestring)
941
to_abs = self.abspath(to_name)
942
if not isdir(to_abs):
943
raise BzrError("destination %r is not a directory" % to_abs)
944
if not self.has_filename(to_name):
945
raise BzrError("destination %r not in working directory" % to_abs)
946
to_dir_id = inv.path2id(to_name)
947
if to_dir_id is None and to_name != '':
948
raise BzrError("destination %r is not a versioned directory" % to_name)
949
to_dir_ie = inv[to_dir_id]
950
if to_dir_ie.kind != 'directory':
951
raise BzrError("destination %r is not a directory" % to_abs)
953
to_idpath = inv.get_idpath(to_dir_id)
956
if not self.has_filename(f):
957
raise BzrError("%r does not exist in working tree" % f)
958
f_id = inv.path2id(f)
960
raise BzrError("%r is not versioned" % f)
961
name_tail = splitpath(f)[-1]
962
dest_path = pathjoin(to_name, name_tail)
963
if self.has_filename(dest_path):
964
raise BzrError("destination %r already exists" % dest_path)
965
if f_id in to_idpath:
966
raise BzrError("can't move %r to a subdirectory of itself" % f)
968
# OK, so there's a race here, it's possible that someone will
969
# create a file in this interval and then the rename might be
970
# left half-done. But we should have caught most problems.
971
orig_inv = deepcopy(self.inventory)
974
name_tail = splitpath(f)[-1]
975
dest_path = pathjoin(to_name, name_tail)
976
result.append((f, dest_path))
977
inv.rename(inv.path2id(f), to_dir_id, name_tail)
979
rename(self.abspath(f), self.abspath(dest_path))
981
raise BzrError("failed to rename %r to %r: %s" %
982
(f, dest_path, e[1]),
983
["rename rolled back"])
985
# restore the inventory on error
986
self._set_inventory(orig_inv)
988
self._write_inventory(inv)
959
991
@needs_tree_write_lock
960
def rename_one(self, from_rel, to_rel, after=False):
992
def rename_one(self, from_rel, to_rel):
961
993
"""Rename one file.
963
995
This can change the directory or the filename or both.
965
rename_one has several 'modes' to work. First, it can rename a physical
966
file and change the file_id. That is the normal mode. Second, it can
967
only change the file_id without touching any physical file.
969
rename_one uses the second mode if 'after == True' and 'to_rel' is
970
either not versioned or newly added, and present in the working tree.
972
rename_one uses the second mode if 'after == False' and 'from_rel' is
973
versioned but no longer in the working tree, and 'to_rel' is not
974
versioned but present in the working tree.
976
rename_one uses the first mode if 'after == False' and 'from_rel' is
977
versioned and present in the working tree, and 'to_rel' is not
978
versioned and not present in the working tree.
980
Everything else results in an error.
982
raise NotImplementedError(self.rename_one)
998
if not self.has_filename(from_rel):
999
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1000
if self.has_filename(to_rel):
1001
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1003
file_id = inv.path2id(from_rel)
1005
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1007
entry = inv[file_id]
1008
from_parent = entry.parent_id
1009
from_name = entry.name
1011
if inv.path2id(to_rel):
1012
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1014
to_dir, to_tail = os.path.split(to_rel)
1015
to_dir_id = inv.path2id(to_dir)
1016
if to_dir_id is None and to_dir != '':
1017
raise BzrError("can't determine destination directory id for %r" % to_dir)
1019
mutter("rename_one:")
1020
mutter(" file_id {%s}" % file_id)
1021
mutter(" from_rel %r" % from_rel)
1022
mutter(" to_rel %r" % to_rel)
1023
mutter(" to_dir %r" % to_dir)
1024
mutter(" to_dir_id {%s}" % to_dir_id)
1026
inv.rename(file_id, to_dir_id, to_tail)
1028
from_abs = self.abspath(from_rel)
1029
to_abs = self.abspath(to_rel)
1031
rename(from_abs, to_abs)
1033
inv.rename(file_id, from_parent, from_name)
1034
raise BzrError("failed to rename %r to %r: %s"
1035
% (from_abs, to_abs, e[1]),
1036
["rename rolled back"])
1037
self._write_inventory(inv)
984
1039
@needs_read_lock
985
1040
def unknowns(self):
1230
1358
def get_physical_lock_status(self):
1231
1359
return self._control_files.get_physical_lock_status()
1233
def _reset_data(self):
1234
"""Reset transient data that cannot be revalidated."""
1235
raise NotImplementedError(self._reset_data)
1361
def _basis_inventory_name(self):
1362
return 'basis-inventory-cache'
1364
@needs_tree_write_lock
1237
1365
def set_last_revision(self, new_revision):
1238
1366
"""Change the last revision in the working tree."""
1239
raise NotImplementedError(self.set_last_revision)
1367
if self._change_last_revision(new_revision):
1368
self._cache_basis_inventory(new_revision)
1241
1370
def _change_last_revision(self, new_revision):
1242
1371
"""Template method part of set_last_revision to perform the change.
1244
1373
This is used to allow WorkingTree3 instances to not affect branch
1245
1374
when their last revision is set.
1247
if _mod_revision.is_null(new_revision):
1248
self.branch.set_last_revision_info(0, new_revision)
1376
if new_revision is None:
1377
self.branch.set_revision_history([])
1250
_mod_revision.check_not_reserved_id(new_revision)
1252
1380
self.branch.generate_revision_history(new_revision)
1253
1381
except errors.NoSuchRevision:
1254
1382
# not present in the repo - dont try to set it deeper than the tip
1255
self.branch._set_revision_history([new_revision])
1383
self.branch.set_revision_history([new_revision])
1386
def _cache_basis_inventory(self, new_revision):
1387
"""Cache new_revision as the basis inventory."""
1388
# TODO: this should allow the ready-to-use inventory to be passed in,
1389
# as commit already has that ready-to-use [while the format is the
1392
# this double handles the inventory - unpack and repack -
1393
# but is easier to understand. We can/should put a conditional
1394
# in here based on whether the inventory is in the latest format
1395
# - perhaps we should repack all inventories on a repository
1397
# the fast path is to copy the raw xml from the repository. If the
1398
# xml contains 'revision_id="', then we assume the right
1399
# revision_id is set. We must check for this full string, because a
1400
# root node id can legitimately look like 'revision_id' but cannot
1402
xml = self.branch.repository.get_inventory_xml(new_revision)
1403
firstline = xml.split('\n', 1)[0]
1404
if (not 'revision_id="' in firstline or
1405
'format="6"' not in firstline):
1406
inv = self.branch.repository.deserialise_inventory(
1408
inv.revision_id = new_revision
1409
xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
1410
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1411
path = self._basis_inventory_name()
1413
self._control_files.put(path, sio)
1414
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1417
def read_basis_inventory(self):
1418
"""Read the cached basis inventory."""
1419
path = self._basis_inventory_name()
1420
return self._control_files.get(path).read()
1423
def read_working_inventory(self):
1424
"""Read the working inventory."""
1425
# ElementTree does its own conversion from UTF-8, so open in
1427
result = bzrlib.xml5.serializer_v5.read_inventory(
1428
self._control_files.get('inventory'))
1429
self._set_inventory(result)
1258
1432
@needs_tree_write_lock
1259
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1261
"""Remove nominated files from the working tree metadata.
1263
:files: File paths relative to the basedir.
1264
:keep_files: If true, the files will also be kept.
1265
:force: Delete files and directories, even if they are changed and
1266
even if the directories are not empty.
1433
def remove(self, files, verbose=False, to_file=None):
1434
"""Remove nominated files from the working inventory..
1436
This does not remove their text. This does not run on XXX on what? RBC
1438
TODO: Refuse to remove modified files unless --force is given?
1440
TODO: Do something useful with directories.
1442
TODO: Should this remove the text or not? Tough call; not
1443
removing may be useful and the user can just use use rm, and
1444
is the opposite of add. Removing it is consistent with most
1445
other tools. Maybe an option.
1447
## TODO: Normalize names
1448
## TODO: Remove nested loops; better scalability
1268
1449
if isinstance(files, basestring):
1269
1450
files = [files]
1273
all_files = set() # specified and nested files
1274
unknown_nested_files=set()
1276
to_file = sys.stdout
1278
files_to_backup = []
1280
def recurse_directory_to_add_files(directory):
1281
# Recurse directory and add all files
1282
# so we can check if they have changed.
1283
for parent_info, file_infos in self.walkdirs(directory):
1284
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1285
# Is it versioned or ignored?
1286
if self.path2id(relpath):
1287
# Add nested content for deletion.
1288
all_files.add(relpath)
1290
# Files which are not versioned
1291
# should be treated as unknown.
1292
files_to_backup.append(relpath)
1294
for filename in files:
1295
# Get file name into canonical form.
1296
abspath = self.abspath(filename)
1297
filename = self.relpath(abspath)
1298
if len(filename) > 0:
1299
all_files.add(filename)
1300
recurse_directory_to_add_files(filename)
1302
files = list(all_files)
1305
return # nothing to do
1307
# Sort needed to first handle directory content before the directory
1308
files.sort(reverse=True)
1310
# Bail out if we are going to delete files we shouldn't
1311
if not keep_files and not force:
1312
for (file_id, path, content_change, versioned, parent_id, name,
1313
kind, executable) in self.iter_changes(self.basis_tree(),
1314
include_unchanged=True, require_versioned=False,
1315
want_unversioned=True, specific_files=files):
1316
if versioned[0] == False:
1317
# The record is unknown or newly added
1318
files_to_backup.append(path[1])
1319
elif (content_change and (kind[1] is not None) and
1320
osutils.is_inside_any(files, path[1])):
1321
# Versioned and changed, but not deleted, and still
1322
# in one of the dirs to be deleted.
1323
files_to_backup.append(path[1])
1325
def backup(file_to_backup):
1326
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1327
osutils.rename(abs_path, self.abspath(backup_name))
1328
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1331
# Build inv_delta and delete files where applicable,
1332
# do this before any modifications to meta data.
1452
inv = self.inventory
1454
# do this before any modifications
1333
1455
for f in files:
1334
fid = self.path2id(f)
1456
fid = inv.path2id(f)
1337
message = "%s is not versioned." % (f,)
1340
# having removed it, it must be either ignored or unknown
1341
if self.is_ignored(f):
1345
# XXX: Really should be a more abstract reporter interface
1346
kind_ch = osutils.kind_marker(self.kind(fid))
1347
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1349
inv_delta.append((f, None, fid, None))
1350
message = "removed %s" % (f,)
1353
abs_path = self.abspath(f)
1354
if osutils.lexists(abs_path):
1355
if (osutils.isdir(abs_path) and
1356
len(os.listdir(abs_path)) > 0):
1358
osutils.rmtree(abs_path)
1359
message = "deleted %s" % (f,)
1363
if f in files_to_backup:
1366
osutils.delete_any(abs_path)
1367
message = "deleted %s" % (f,)
1368
elif message is not None:
1369
# Only care if we haven't done anything yet.
1370
message = "%s does not exist." % (f,)
1372
# Print only one message (if any) per file.
1373
if message is not None:
1375
self.apply_inventory_delta(inv_delta)
1458
# TODO: Perhaps make this just a warning, and continue?
1459
# This tends to happen when
1460
raise NotVersionedError(path=f)
1462
# having remove it, it must be either ignored or unknown
1463
if self.is_ignored(f):
1467
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1470
self._write_inventory(inv)
1377
1472
@needs_tree_write_lock
1378
def revert(self, filenames=None, old_tree=None, backups=True,
1379
pb=None, report_changes=False):
1380
from bzrlib.conflicts import resolve
1473
def revert(self, filenames, old_tree=None, backups=True,
1474
pb=DummyProgress()):
1475
from transform import revert
1476
from conflicts import resolve
1381
1477
if old_tree is None:
1382
basis_tree = self.basis_tree()
1383
basis_tree.lock_read()
1384
old_tree = basis_tree
1478
old_tree = self.basis_tree()
1479
conflicts = revert(self, old_tree, filenames, backups, pb)
1480
if not len(filenames):
1481
self.set_parent_ids(self.get_parent_ids()[:1])
1388
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1390
if filenames is None and len(self.get_parent_ids()) > 1:
1392
last_revision = self.last_revision()
1393
if last_revision != _mod_revision.NULL_REVISION:
1394
if basis_tree is None:
1395
basis_tree = self.basis_tree()
1396
basis_tree.lock_read()
1397
parent_trees.append((last_revision, basis_tree))
1398
self.set_parent_trees(parent_trees)
1484
resolve(self, filenames, ignore_misses=True)
1487
# XXX: This method should be deprecated in favour of taking in a proper
1488
# new Inventory object.
1489
@needs_tree_write_lock
1490
def set_inventory(self, new_inventory_list):
1491
from bzrlib.inventory import (Inventory,
1496
inv = Inventory(self.get_root_id())
1497
for path, file_id, parent, kind in new_inventory_list:
1498
name = os.path.basename(path)
1501
# fixme, there should be a factory function inv,add_??
1502
if kind == 'directory':
1503
inv.add(InventoryDirectory(file_id, name, parent))
1504
elif kind == 'file':
1505
inv.add(InventoryFile(file_id, name, parent))
1506
elif kind == 'symlink':
1507
inv.add(InventoryLink(file_id, name, parent))
1401
resolve(self, filenames, ignore_misses=True, recursive=True)
1403
if basis_tree is not None:
1407
def revision_tree(self, revision_id):
1408
"""See Tree.revision_tree.
1410
WorkingTree can supply revision_trees for the basis revision only
1411
because there is only one cached inventory in the bzr directory.
1413
raise NotImplementedError(self.revision_tree)
1509
raise BzrError("unknown kind %r" % kind)
1510
self._write_inventory(inv)
1415
1512
@needs_tree_write_lock
1416
1513
def set_root_id(self, file_id):
1417
1514
"""Set the root id for this tree."""
1421
'WorkingTree.set_root_id with fileid=None')
1422
file_id = osutils.safe_file_id(file_id)
1423
self._set_root_id(file_id)
1425
def _set_root_id(self, file_id):
1426
"""Set the root id for this tree, in a format specific manner.
1428
:param file_id: The file id to assign to the root. It must not be
1429
present in the current inventory or an error will occur. It must
1430
not be None, but rather a valid file id.
1432
raise NotImplementedError(self._set_root_id)
1515
inv = self.read_working_inventory()
1516
orig_root_id = inv.root.file_id
1517
del inv._byid[inv.root.file_id]
1518
inv.root.file_id = file_id
1519
inv._byid[inv.root.file_id] = inv.root
1522
if entry.parent_id == orig_root_id:
1523
entry.parent_id = inv.root.file_id
1524
self._write_inventory(inv)
1434
1526
def unlock(self):
1435
1527
"""See Branch.unlock.
1437
1529
WorkingTree locking just uses the Branch locking facilities.
1438
1530
This is current because all working trees have an embedded branch
1439
1531
within them. IF in the future, we were to make branch data shareable
1440
between multiple working trees, i.e. via shared storage, then we
1532
between multiple working trees, i.e. via shared storage, then we
1441
1533
would probably want to lock both the local tree, and the branch.
1443
1535
raise NotImplementedError(self.unlock)
1447
def update(self, change_reporter=None, possible_transports=None,
1448
revision=None, old_tip=_marker, show_base=False):
1449
1539
"""Update a working tree along its branch.
1451
This will update the branch if its bound too, which means we have
1452
multiple trees involved:
1454
- The new basis tree of the master.
1455
- The old basis tree of the branch.
1456
- The old basis tree of the working tree.
1457
- The current working tree state.
1459
Pathologically, all three may be different, and non-ancestors of each
1460
other. Conceptually we want to:
1462
- Preserve the wt.basis->wt.state changes
1463
- Transform the wt.basis to the new master basis.
1464
- Apply a merge of the old branch basis to get any 'local' changes from
1466
- Restore the wt.basis->wt.state changes.
1541
This will update the branch if its bound too, which means we have multiple trees involved:
1542
The new basis tree of the master.
1543
The old basis tree of the branch.
1544
The old basis tree of the working tree.
1545
The current working tree state.
1546
pathologically all three may be different, and non ancestors of each other.
1547
Conceptually we want to:
1548
Preserve the wt.basis->wt.state changes
1549
Transform the wt.basis to the new master basis.
1550
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1551
Restore the wt.basis->wt.state changes.
1468
1553
There isn't a single operation at the moment to do that, so we:
1470
- Merge current state -> basis tree of the master w.r.t. the old tree
1472
- Do a 'normal' merge of the old branch basis if it is relevant.
1474
:param revision: The target revision to update to. Must be in the
1476
:param old_tip: If branch.update() has already been run, the value it
1477
returned (old tip of the branch or None). _marker is used
1480
if self.branch.get_bound_location() is not None:
1482
update_branch = (old_tip is self._marker)
1484
self.lock_tree_write()
1485
update_branch = False
1488
old_tip = self.branch.update(possible_transports)
1490
if old_tip is self._marker:
1492
return self._update_tree(old_tip, change_reporter, revision, show_base)
1496
@needs_tree_write_lock
1497
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1499
"""Update a tree to the master branch.
1501
:param old_tip: if supplied, the previous tip revision the branch,
1502
before it was changed to the master branch's tip.
1554
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1555
Do a 'normal' merge of the old branch basis if it is relevant.
1557
old_tip = self.branch.update()
1504
1558
# here if old_tip is not None, it is the old tip of the branch before
1505
1559
# it was updated from the master branch. This should become a pending
1506
1560
# merge in the working tree to preserve the user existing work. we
1507
1561
# cant set that until we update the working trees last revision to be
1508
1562
# one from the new branch, because it will just get absorbed by the
1509
1563
# parent de-duplication logic.
1511
1565
# We MUST save it even if an error occurs, because otherwise the users
1512
1566
# local work is unreferenced and will appear to have been lost.
1516
1570
last_rev = self.get_parent_ids()[0]
1517
1571
except IndexError:
1518
last_rev = _mod_revision.NULL_REVISION
1519
if revision is None:
1520
revision = self.branch.last_revision()
1522
old_tip = old_tip or _mod_revision.NULL_REVISION
1524
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1525
# the branch we are bound to was updated
1526
# merge those changes in first
1527
base_tree = self.basis_tree()
1528
other_tree = self.branch.repository.revision_tree(old_tip)
1529
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1530
base_tree, this_tree=self,
1531
change_reporter=change_reporter,
1532
show_base=show_base)
1534
self.add_parent_tree((old_tip, other_tree))
1535
note('Rerun update after fixing the conflicts.')
1538
if last_rev != _mod_revision.ensure_null(revision):
1539
# the working tree is up to date with the branch
1540
# we can merge the specified revision from master
1541
to_tree = self.branch.repository.revision_tree(revision)
1542
to_root_id = to_tree.get_root_id()
1573
if last_rev != self.branch.last_revision():
1574
# merge tree state up to new branch tip.
1544
1575
basis = self.basis_tree()
1547
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1548
self.set_root_id(to_root_id)
1553
# determine the branch point
1554
graph = self.branch.repository.get_graph()
1555
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1557
base_tree = self.branch.repository.revision_tree(base_rev_id)
1559
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1561
change_reporter=change_reporter,
1562
show_base=show_base)
1563
self.set_last_revision(revision)
1576
to_tree = self.branch.basis_tree()
1577
result += merge_inner(self.branch,
1564
1581
# TODO - dedup parents list with things merged by pull ?
1565
1582
# reuse the tree we've updated to to set the basis:
1566
parent_trees = [(revision, to_tree)]
1583
parent_trees = [(self.branch.last_revision(), to_tree)]
1567
1584
merges = self.get_parent_ids()[1:]
1568
1585
# Ideally we ask the tree for the trees here, that way the working
1569
# tree can decide whether to give us the entire tree or give us a
1586
# tree can decide whether to give us teh entire tree or give us a
1570
1587
# lazy initialised tree. dirstate for instance will have the trees
1571
1588
# in ram already, whereas a last-revision + basis-inventory tree
1572
1589
# will not, but also does not need them when setting parents.
1573
1590
for parent in merges:
1574
1591
parent_trees.append(
1575
1592
(parent, self.branch.repository.revision_tree(parent)))
1576
if not _mod_revision.is_null(old_tip):
1593
if old_tip is not None:
1577
1594
parent_trees.append(
1578
1595
(old_tip, self.branch.repository.revision_tree(old_tip)))
1579
1596
self.set_parent_trees(parent_trees)
1580
1597
last_rev = parent_trees[0][0]
1583
def _write_hashcache_if_dirty(self):
1584
"""Write out the hashcache if it is dirty."""
1585
if self._hashcache.needs_write:
1599
# the working tree had the same last-revision as the master
1600
# branch did. We may still have pivot local work from the local
1601
# branch into old_tip:
1602
if old_tip is not None:
1603
self.add_parent_tree_id(old_tip)
1604
if old_tip and old_tip != last_rev:
1605
# our last revision was not the prior branch last revision
1606
# and we have converted that last revision to a pending merge.
1607
# base is somewhere between the branch tip now
1608
# and the now pending merge
1609
from bzrlib.revision import common_ancestor
1587
self._hashcache.write()
1589
if e.errno not in (errno.EPERM, errno.EACCES):
1591
# TODO: jam 20061219 Should this be a warning? A single line
1592
# warning might be sufficient to let the user know what
1594
mutter('Could not write hashcache for %s\nError: %s',
1595
self._hashcache.cache_file_name(), e)
1611
base_rev_id = common_ancestor(self.branch.last_revision(),
1613
self.branch.repository)
1614
except errors.NoCommonAncestor:
1616
base_tree = self.branch.repository.revision_tree(base_rev_id)
1617
other_tree = self.branch.repository.revision_tree(old_tip)
1618
result += merge_inner(self.branch,
1624
@needs_tree_write_lock
1625
def _write_inventory(self, inv):
1626
"""Write inventory as the current inventory."""
1628
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1630
self._control_files.put('inventory', sio)
1631
self._set_inventory(inv)
1632
mutter('wrote working inventory')
1597
1634
def set_conflicts(self, arg):
1598
raise errors.UnsupportedOperation(self.set_conflicts, self)
1635
raise UnsupportedOperation(self.set_conflicts, self)
1600
1637
def add_conflicts(self, arg):
1601
raise errors.UnsupportedOperation(self.add_conflicts, self)
1638
raise UnsupportedOperation(self.add_conflicts, self)
1603
1641
def conflicts(self):
1604
raise NotImplementedError(self.conflicts)
1606
def walkdirs(self, prefix=""):
1607
"""Walk the directories of this tree.
1609
returns a generator which yields items in the form:
1610
((curren_directory_path, fileid),
1611
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1614
This API returns a generator, which is only valid during the current
1615
tree transaction - within a single lock_read or lock_write duration.
1617
If the tree is not locked, it may cause an error to be raised,
1618
depending on the tree implementation.
1620
disk_top = self.abspath(prefix)
1621
if disk_top.endswith('/'):
1622
disk_top = disk_top[:-1]
1623
top_strip_len = len(disk_top) + 1
1624
inventory_iterator = self._walkdirs(prefix)
1625
disk_iterator = osutils.walkdirs(disk_top, prefix)
1627
current_disk = disk_iterator.next()
1628
disk_finished = False
1630
if not (e.errno == errno.ENOENT or
1631
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1634
disk_finished = True
1636
current_inv = inventory_iterator.next()
1637
inv_finished = False
1638
except StopIteration:
1641
while not inv_finished or not disk_finished:
1643
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1644
cur_disk_dir_content) = current_disk
1646
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1647
cur_disk_dir_content) = ((None, None), None)
1648
if not disk_finished:
1649
# strip out .bzr dirs
1650
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1651
len(cur_disk_dir_content) > 0):
1652
# osutils.walkdirs can be made nicer -
1653
# yield the path-from-prefix rather than the pathjoined
1655
bzrdir_loc = bisect_left(cur_disk_dir_content,
1657
if (bzrdir_loc < len(cur_disk_dir_content)
1658
and self.bzrdir.is_control_filename(
1659
cur_disk_dir_content[bzrdir_loc][0])):
1660
# we dont yield the contents of, or, .bzr itself.
1661
del cur_disk_dir_content[bzrdir_loc]
1663
# everything is unknown
1666
# everything is missing
1669
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1671
# disk is before inventory - unknown
1672
dirblock = [(relpath, basename, kind, stat, None, None) for
1673
relpath, basename, kind, stat, top_path in
1674
cur_disk_dir_content]
1675
yield (cur_disk_dir_relpath, None), dirblock
1677
current_disk = disk_iterator.next()
1678
except StopIteration:
1679
disk_finished = True
1681
# inventory is before disk - missing.
1682
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1683
for relpath, basename, dkind, stat, fileid, kind in
1685
yield (current_inv[0][0], current_inv[0][1]), dirblock
1687
current_inv = inventory_iterator.next()
1688
except StopIteration:
1691
# versioned present directory
1692
# merge the inventory and disk data together
1694
for relpath, subiterator in itertools.groupby(sorted(
1695
current_inv[1] + cur_disk_dir_content,
1696
key=operator.itemgetter(0)), operator.itemgetter(1)):
1697
path_elements = list(subiterator)
1698
if len(path_elements) == 2:
1699
inv_row, disk_row = path_elements
1700
# versioned, present file
1701
dirblock.append((inv_row[0],
1702
inv_row[1], disk_row[2],
1703
disk_row[3], inv_row[4],
1705
elif len(path_elements[0]) == 5:
1707
dirblock.append((path_elements[0][0],
1708
path_elements[0][1], path_elements[0][2],
1709
path_elements[0][3], None, None))
1710
elif len(path_elements[0]) == 6:
1711
# versioned, absent file.
1712
dirblock.append((path_elements[0][0],
1713
path_elements[0][1], 'unknown', None,
1714
path_elements[0][4], path_elements[0][5]))
1716
raise NotImplementedError('unreachable code')
1717
yield current_inv[0], dirblock
1719
current_inv = inventory_iterator.next()
1720
except StopIteration:
1723
current_disk = disk_iterator.next()
1724
except StopIteration:
1725
disk_finished = True
1727
def _walkdirs(self, prefix=""):
1728
"""Walk the directories of this tree.
1730
:param prefix: is used as the directrory to start with.
1731
:returns: a generator which yields items in the form::
1733
((curren_directory_path, fileid),
1734
[(file1_path, file1_name, file1_kind, None, file1_id,
1737
raise NotImplementedError(self._walkdirs)
1739
@needs_tree_write_lock
1740
def auto_resolve(self):
1741
"""Automatically resolve text conflicts according to contents.
1743
Only text conflicts are auto_resolvable. Files with no conflict markers
1744
are considered 'resolved', because bzr always puts conflict markers
1745
into files that have text conflicts. The corresponding .THIS .BASE and
1746
.OTHER files are deleted, as per 'resolve'.
1748
:return: a tuple of ConflictLists: (un_resolved, resolved).
1750
un_resolved = _mod_conflicts.ConflictList()
1751
resolved = _mod_conflicts.ConflictList()
1752
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1753
for conflict in self.conflicts():
1754
if (conflict.typestring != 'text conflict' or
1755
self.kind(conflict.file_id) != 'file'):
1756
un_resolved.append(conflict)
1758
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1642
conflicts = ConflictList()
1643
for conflicted in self._iter_conflicts():
1760
for line in my_file:
1761
if conflict_re.search(line):
1762
un_resolved.append(conflict)
1646
if file_kind(self.abspath(conflicted)) != "file":
1648
except errors.NoSuchFile:
1651
for suffix in ('.THIS', '.OTHER'):
1653
kind = file_kind(self.abspath(conflicted+suffix))
1656
except errors.NoSuchFile:
1765
resolved.append(conflict)
1768
resolved.remove_files(self)
1769
self.set_conflicts(un_resolved)
1770
return un_resolved, resolved
1772
def _validate(self):
1773
"""Validate internal structures.
1775
This is meant mostly for the test suite. To give it a chance to detect
1776
corruption after actions have occurred. The default implementation is a
1779
:return: None. An exception should be raised if there is an error.
1783
def check_state(self):
1784
"""Check that the working state is/isn't valid."""
1785
raise NotImplementedError(self.check_state)
1787
def reset_state(self, revision_ids=None):
1788
"""Reset the state of the working tree.
1790
This does a hard-reset to a last-known-good state. This is a way to
1791
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1793
raise NotImplementedError(self.reset_state)
1795
def _get_rules_searcher(self, default_searcher):
1796
"""See Tree._get_rules_searcher."""
1797
if self._rules_searcher is None:
1798
self._rules_searcher = super(WorkingTree,
1799
self)._get_rules_searcher(default_searcher)
1800
return self._rules_searcher
1802
def get_shelf_manager(self):
1803
"""Return the ShelfManager for this WorkingTree."""
1804
from bzrlib.shelf import ShelfManager
1805
return ShelfManager(self, self._transport)
1808
class InventoryWorkingTree(WorkingTree,
1809
bzrlib.mutabletree.MutableInventoryTree):
1810
"""Base class for working trees that are inventory-oriented.
1812
The inventory is held in the `Branch` working-inventory, and the
1813
files are in a directory on disk.
1815
It is possible for a `WorkingTree` to have a filename which is
1816
not listed in the Inventory and vice versa.
1660
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1661
conflicts.append(Conflict.factory(ctype, path=conflicted,
1662
file_id=self.path2id(conflicted)))
1666
class WorkingTree2(WorkingTree):
1667
"""This is the Format 2 working tree.
1669
This was the first weave based working tree.
1670
- uses os locks for locking.
1671
- uses the branch last-revision.
1819
def __init__(self, basedir='.',
1820
branch=DEPRECATED_PARAMETER,
1822
_control_files=None,
1826
"""Construct a InventoryWorkingTree instance. This is not a public API.
1828
:param branch: A branch to override probing for the branch.
1830
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1831
branch=branch, _control_files=_control_files, _internal=_internal,
1832
_format=_format, _bzrdir=_bzrdir)
1834
if _inventory is None:
1835
# This will be acquired on lock_read() or lock_write()
1836
self._inventory_is_modified = False
1837
self._inventory = None
1839
# the caller of __init__ has provided an inventory,
1840
# we assume they know what they are doing - as its only
1841
# the Format factory and creation methods that are
1842
# permitted to do this.
1843
self._set_inventory(_inventory, dirty=False)
1845
def _set_inventory(self, inv, dirty):
1846
"""Set the internal cached inventory.
1848
:param inv: The inventory to set.
1849
:param dirty: A boolean indicating whether the inventory is the same
1850
logical inventory as whats on disk. If True the inventory is not
1851
the same and should be written to disk or data will be lost, if
1852
False then the inventory is the same as that on disk and any
1853
serialisation would be unneeded overhead.
1855
self._inventory = inv
1856
self._inventory_is_modified = dirty
1858
def _serialize(self, inventory, out_file):
1859
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1862
def _deserialize(selt, in_file):
1863
return xml5.serializer_v5.read_inventory(in_file)
1865
@needs_tree_write_lock
1866
def _write_inventory(self, inv):
1867
"""Write inventory as the current inventory."""
1868
self._set_inventory(inv, dirty=True)
1871
# XXX: This method should be deprecated in favour of taking in a proper
1872
# new Inventory object.
1873
@needs_tree_write_lock
1874
def set_inventory(self, new_inventory_list):
1875
from bzrlib.inventory import (Inventory,
1879
inv = Inventory(self.get_root_id())
1880
for path, file_id, parent, kind in new_inventory_list:
1881
name = os.path.basename(path)
1884
# fixme, there should be a factory function inv,add_??
1885
if kind == 'directory':
1886
inv.add(InventoryDirectory(file_id, name, parent))
1887
elif kind == 'file':
1888
inv.add(InventoryFile(file_id, name, parent))
1889
elif kind == 'symlink':
1890
inv.add(InventoryLink(file_id, name, parent))
1892
raise errors.BzrError("unknown kind %r" % kind)
1893
self._write_inventory(inv)
1895
def _write_basis_inventory(self, xml):
1896
"""Write the basis inventory XML to the basis-inventory file"""
1897
path = self._basis_inventory_name()
1899
self._transport.put_file(path, sio,
1900
mode=self.bzrdir._get_file_mode())
1902
def _reset_data(self):
1903
"""Reset transient data that cannot be revalidated."""
1904
self._inventory_is_modified = False
1905
f = self._transport.get('inventory')
1907
result = self._deserialize(f)
1674
def lock_tree_write(self):
1675
"""See WorkingTree.lock_tree_write().
1677
In Format2 WorkingTrees we have a single lock for the branch and tree
1678
so lock_tree_write() degrades to lock_write().
1680
self.branch.lock_write()
1682
return self._control_files.lock_write()
1684
self.branch.unlock()
1688
# we share control files:
1689
if self._hashcache.needs_write and self._control_files._lock_count==3:
1690
self._hashcache.write()
1691
# reverse order of locking.
1693
return self._control_files.unlock()
1910
self._set_inventory(result, dirty=False)
1912
def _set_root_id(self, file_id):
1913
"""Set the root id for this tree, in a format specific manner.
1915
:param file_id: The file id to assign to the root. It must not be
1916
present in the current inventory or an error will occur. It must
1917
not be None, but rather a valid file id.
1919
inv = self._inventory
1920
orig_root_id = inv.root.file_id
1921
# TODO: it might be nice to exit early if there was nothing
1922
# to do, saving us from trigger a sync on unlock.
1923
self._inventory_is_modified = True
1924
# we preserve the root inventory entry object, but
1925
# unlinkit from the byid index
1926
del inv._byid[inv.root.file_id]
1927
inv.root.file_id = file_id
1928
# and link it into the index with the new changed id.
1929
inv._byid[inv.root.file_id] = inv.root
1930
# and finally update all children to reference the new id.
1931
# XXX: this should be safe to just look at the root.children
1932
# list, not the WHOLE INVENTORY.
1935
if entry.parent_id == orig_root_id:
1936
entry.parent_id = inv.root.file_id
1938
def all_file_ids(self):
1939
"""See Tree.iter_all_file_ids"""
1940
return set(self.inventory)
1942
@needs_tree_write_lock
1943
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1944
"""See MutableTree.set_parent_trees."""
1945
parent_ids = [rev for (rev, tree) in parents_list]
1946
for revision_id in parent_ids:
1947
_mod_revision.check_not_reserved_id(revision_id)
1949
self._check_parents_for_ghosts(parent_ids,
1950
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1952
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1954
if len(parent_ids) == 0:
1955
leftmost_parent_id = _mod_revision.NULL_REVISION
1956
leftmost_parent_tree = None
1695
self.branch.unlock()
1698
class WorkingTree3(WorkingTree):
1699
"""This is the Format 3 working tree.
1701
This differs from the base WorkingTree by:
1702
- having its own file lock
1703
- having its own last-revision property.
1705
This is new in bzr 0.8
1709
def _last_revision(self):
1710
"""See Mutable.last_revision."""
1712
return self._control_files.get_utf8('last-revision').read()
1716
def _change_last_revision(self, revision_id):
1717
"""See WorkingTree._change_last_revision."""
1718
if revision_id is None or revision_id == NULL_REVISION:
1720
self._control_files._transport.delete('last-revision')
1721
except errors.NoSuchFile:
1958
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1960
if self._change_last_revision(leftmost_parent_id):
1961
if leftmost_parent_tree is None:
1962
# If we don't have a tree, fall back to reading the
1963
# parent tree from the repository.
1964
self._cache_basis_inventory(leftmost_parent_id)
1966
inv = leftmost_parent_tree.inventory
1967
xml = self._create_basis_xml_from_inventory(
1968
leftmost_parent_id, inv)
1969
self._write_basis_inventory(xml)
1970
self._set_merges_from_parent_ids(parent_ids)
1972
def _cache_basis_inventory(self, new_revision):
1973
"""Cache new_revision as the basis inventory."""
1974
# TODO: this should allow the ready-to-use inventory to be passed in,
1975
# as commit already has that ready-to-use [while the format is the
1978
# this double handles the inventory - unpack and repack -
1979
# but is easier to understand. We can/should put a conditional
1980
# in here based on whether the inventory is in the latest format
1981
# - perhaps we should repack all inventories on a repository
1983
# the fast path is to copy the raw xml from the repository. If the
1984
# xml contains 'revision_id="', then we assume the right
1985
# revision_id is set. We must check for this full string, because a
1986
# root node id can legitimately look like 'revision_id' but cannot
1988
xml = self.branch.repository._get_inventory_xml(new_revision)
1989
firstline = xml.split('\n', 1)[0]
1990
if (not 'revision_id="' in firstline or
1991
'format="7"' not in firstline):
1992
inv = self.branch.repository._serializer.read_inventory_from_string(
1994
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1995
self._write_basis_inventory(xml)
1996
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1999
def _basis_inventory_name(self):
2000
return 'basis-inventory-cache'
2002
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2003
"""Create the text that will be saved in basis-inventory"""
2004
inventory.revision_id = revision_id
2005
return xml7.serializer_v7.write_inventory_to_string(inventory)
1725
self._control_files.put_utf8('last-revision', revision_id)
2007
1728
@needs_tree_write_lock
2008
1729
def set_conflicts(self, conflicts):
2009
self._put_rio('conflicts', conflicts.to_stanzas(),
1730
self._put_rio('conflicts', conflicts.to_stanzas(),
2010
1731
CONFLICT_HEADER_1)
2012
1733
@needs_tree_write_lock
2013
1734
def add_conflicts(self, new_conflicts):
2014
1735
conflict_set = set(self.conflicts())
2015
1736
conflict_set.update(set(list(new_conflicts)))
2016
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2017
key=_mod_conflicts.Conflict.sort_key)))
1737
self.set_conflicts(ConflictList(sorted(conflict_set,
1738
key=Conflict.sort_key)))
2019
1740
@needs_read_lock
2020
1741
def conflicts(self):
2022
confile = self._transport.get('conflicts')
2023
except errors.NoSuchFile:
2024
return _mod_conflicts.ConflictList()
2027
if confile.next() != CONFLICT_HEADER_1 + '\n':
2028
raise errors.ConflictFormatError()
2029
except StopIteration:
2030
raise errors.ConflictFormatError()
2031
reader = _mod_rio.RioReader(confile)
2032
return _mod_conflicts.ConflictList.from_stanzas(reader)
2036
def read_basis_inventory(self):
2037
"""Read the cached basis inventory."""
2038
path = self._basis_inventory_name()
2039
return self._transport.get_bytes(path)
2042
def read_working_inventory(self):
2043
"""Read the working inventory.
2045
:raises errors.InventoryModified: read_working_inventory will fail
2046
when the current in memory inventory has been modified.
2048
# conceptually this should be an implementation detail of the tree.
2049
# XXX: Deprecate this.
2050
# ElementTree does its own conversion from UTF-8, so open in
2052
if self._inventory_is_modified:
2053
raise errors.InventoryModified(self)
2054
f = self._transport.get('inventory')
2056
result = self._deserialize(f)
2059
self._set_inventory(result, dirty=False)
2063
def get_root_id(self):
2064
"""Return the id of this trees root"""
2065
return self._inventory.root.file_id
2067
def has_id(self, file_id):
2068
# files that have been deleted are excluded
2069
inv = self.inventory
2070
if not inv.has_id(file_id):
2072
path = inv.id2path(file_id)
2073
return osutils.lexists(self.abspath(path))
2075
def has_or_had_id(self, file_id):
2076
if file_id == self.inventory.root.file_id:
1743
confile = self._control_files.get('conflicts')
1745
return ConflictList()
1747
if confile.next() != CONFLICT_HEADER_1 + '\n':
1748
raise ConflictFormatError()
1749
except StopIteration:
1750
raise ConflictFormatError()
1751
return ConflictList.from_stanzas(RioReader(confile))
1754
if self._hashcache.needs_write and self._control_files._lock_count==1:
1755
self._hashcache.write()
1756
# reverse order of locking.
1758
return self._control_files.unlock()
1760
self.branch.unlock()
1763
def get_conflicted_stem(path):
1764
for suffix in CONFLICT_SUFFIXES:
1765
if path.endswith(suffix):
1766
return path[:-len(suffix)]
1768
@deprecated_function(zero_eight)
1769
def is_control_file(filename):
1770
"""See WorkingTree.is_control_filename(filename)."""
1771
## FIXME: better check
1772
filename = normpath(filename)
1773
while filename != '':
1774
head, tail = os.path.split(filename)
1775
## mutter('check %r for control file' % ((head, tail),))
2078
return self.inventory.has_id(file_id)
2080
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2082
"""Iterate through file_ids for this tree.
2084
file_ids are in a WorkingTree if they are in the working inventory
2085
and the working file exists.
2087
inv = self._inventory
2088
for path, ie in inv.iter_entries():
2089
if osutils.lexists(self.abspath(path)):
2092
@needs_tree_write_lock
2093
def set_last_revision(self, new_revision):
2094
"""Change the last revision in the working tree."""
2095
if self._change_last_revision(new_revision):
2096
self._cache_basis_inventory(new_revision)
2098
def _get_check_refs(self):
2099
"""Return the references needed to perform a check of this tree.
2101
The default implementation returns no refs, and is only suitable for
2102
trees that have no local caching and can commit on ghosts at any time.
2104
:seealso: bzrlib.check for details about check_refs.
2109
def _check(self, references):
2110
"""Check the tree for consistency.
2112
:param references: A dict with keys matching the items returned by
2113
self._get_check_refs(), and values from looking those keys up in
2116
tree_basis = self.basis_tree()
2117
tree_basis.lock_read()
2119
repo_basis = references[('trees', self.last_revision())]
2120
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2121
raise errors.BzrCheckError(
2122
"Mismatched basis inventory content.")
2128
def check_state(self):
2129
"""Check that the working state is/isn't valid."""
2130
check_refs = self._get_check_refs()
2132
for ref in check_refs:
2135
refs[ref] = self.branch.repository.revision_tree(value)
2138
@needs_tree_write_lock
2139
def reset_state(self, revision_ids=None):
2140
"""Reset the state of the working tree.
2142
This does a hard-reset to a last-known-good state. This is a way to
2143
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2145
if revision_ids is None:
2146
revision_ids = self.get_parent_ids()
2147
if not revision_ids:
2148
rt = self.branch.repository.revision_tree(
2149
_mod_revision.NULL_REVISION)
2151
rt = self.branch.repository.revision_tree(revision_ids[0])
2152
self._write_inventory(rt.inventory)
2153
self.set_parent_ids(revision_ids)
2156
"""Write the in memory inventory to disk."""
2157
# TODO: Maybe this should only write on dirty ?
2158
if self._control_files._lock_mode != 'w':
2159
raise errors.NotWriteLocked(self)
2161
self._serialize(self._inventory, sio)
2163
self._transport.put_file('inventory', sio,
2164
mode=self.bzrdir._get_file_mode())
2165
self._inventory_is_modified = False
2168
def get_file_sha1(self, file_id, path=None, stat_value=None):
2170
path = self._inventory.id2path(file_id)
2171
return self._hashcache.get_sha1(path, stat_value)
2173
def get_file_mtime(self, file_id, path=None):
2174
"""See Tree.get_file_mtime."""
2176
path = self.inventory.id2path(file_id)
2177
return os.lstat(self.abspath(path)).st_mtime
2179
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2180
file_id = self.path2id(path)
2182
# For unversioned files on win32, we just assume they are not
2185
return self._inventory[file_id].executable
2187
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2188
mode = stat_result.st_mode
2189
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2191
if not supports_executable():
2192
def is_executable(self, file_id, path=None):
2193
return self._inventory[file_id].executable
2195
_is_executable_from_path_and_stat = \
2196
_is_executable_from_path_and_stat_from_basis
2198
def is_executable(self, file_id, path=None):
2200
path = self.id2path(file_id)
2201
mode = os.lstat(self.abspath(path)).st_mode
2202
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2204
_is_executable_from_path_and_stat = \
2205
_is_executable_from_path_and_stat_from_stat
2207
@needs_tree_write_lock
2208
def _add(self, files, ids, kinds):
2209
"""See MutableTree._add."""
2210
# TODO: Re-adding a file that is removed in the working copy
2211
# should probably put it back with the previous ID.
2212
# the read and write working inventory should not occur in this
2213
# function - they should be part of lock_write and unlock.
2214
inv = self.inventory
2215
for f, file_id, kind in zip(files, ids, kinds):
2217
inv.add_path(f, kind=kind)
2219
inv.add_path(f, kind=kind, file_id=file_id)
2220
self._inventory_is_modified = True
2222
def revision_tree(self, revision_id):
2223
"""See WorkingTree.revision_id."""
2224
if revision_id == self.last_revision():
2226
xml = self.read_basis_inventory()
2227
except errors.NoSuchFile:
2231
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2232
# dont use the repository revision_tree api because we want
2233
# to supply the inventory.
2234
if inv.revision_id == revision_id:
2235
return revisiontree.InventoryRevisionTree(
2236
self.branch.repository, inv, revision_id)
2237
except errors.BadInventoryFormat:
2239
# raise if there was no inventory, or if we read the wrong inventory.
2240
raise errors.NoSuchRevisionInTree(self, revision_id)
2243
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2244
"""See Tree.annotate_iter
2246
This implementation will use the basis tree implementation if possible.
2247
Lines not in the basis are attributed to CURRENT_REVISION
2249
If there are pending merges, lines added by those merges will be
2250
incorrectly attributed to CURRENT_REVISION (but after committing, the
2251
attribution will be correct).
2253
maybe_file_parent_keys = []
2254
for parent_id in self.get_parent_ids():
2256
parent_tree = self.revision_tree(parent_id)
2257
except errors.NoSuchRevisionInTree:
2258
parent_tree = self.branch.repository.revision_tree(parent_id)
2259
parent_tree.lock_read()
2261
if not parent_tree.has_id(file_id):
2263
ie = parent_tree.inventory[file_id]
2264
if ie.kind != 'file':
2265
# Note: this is slightly unnecessary, because symlinks and
2266
# directories have a "text" which is the empty text, and we
2267
# know that won't mess up annotations. But it seems cleaner
2269
parent_text_key = (file_id, ie.revision)
2270
if parent_text_key not in maybe_file_parent_keys:
2271
maybe_file_parent_keys.append(parent_text_key)
2273
parent_tree.unlock()
2274
graph = _mod_graph.Graph(self.branch.repository.texts)
2275
heads = graph.heads(maybe_file_parent_keys)
2276
file_parent_keys = []
2277
for key in maybe_file_parent_keys:
2279
file_parent_keys.append(key)
2281
# Now we have the parents of this content
2282
annotator = self.branch.repository.texts.get_annotator()
2283
text = self.get_file_text(file_id)
2284
this_key =(file_id, default_revision)
2285
annotator.add_special_text(this_key, file_parent_keys, text)
2286
annotations = [(key[-1], line)
2287
for key, line in annotator.annotate_flat(this_key)]
2291
def merge_modified(self):
2292
"""Return a dictionary of files modified by a merge.
2294
The list is initialized by WorkingTree.set_merge_modified, which is
2295
typically called after we make some automatic updates to the tree
2298
This returns a map of file_id->sha1, containing only files which are
2299
still in the working inventory and have that text hash.
2302
hashfile = self._transport.get('merge-hashes')
2303
except errors.NoSuchFile:
2308
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2309
raise errors.MergeModifiedFormatError()
2310
except StopIteration:
2311
raise errors.MergeModifiedFormatError()
2312
for s in _mod_rio.RioReader(hashfile):
2313
# RioReader reads in Unicode, so convert file_ids back to utf8
2314
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2315
if not self.inventory.has_id(file_id):
2317
text_hash = s.get("hash")
2318
if text_hash == self.get_file_sha1(file_id):
2319
merge_hashes[file_id] = text_hash
2325
def subsume(self, other_tree):
2326
def add_children(inventory, entry):
2327
for child_entry in entry.children.values():
2328
inventory._byid[child_entry.file_id] = child_entry
2329
if child_entry.kind == 'directory':
2330
add_children(inventory, child_entry)
2331
if other_tree.get_root_id() == self.get_root_id():
2332
raise errors.BadSubsumeSource(self, other_tree,
2333
'Trees have the same root')
2335
other_tree_path = self.relpath(other_tree.basedir)
2336
except errors.PathNotChild:
2337
raise errors.BadSubsumeSource(self, other_tree,
2338
'Tree is not contained by the other')
2339
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2340
if new_root_parent is None:
2341
raise errors.BadSubsumeSource(self, other_tree,
2342
'Parent directory is not versioned.')
2343
# We need to ensure that the result of a fetch will have a
2344
# versionedfile for the other_tree root, and only fetching into
2345
# RepositoryKnit2 guarantees that.
2346
if not self.branch.repository.supports_rich_root():
2347
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2348
other_tree.lock_tree_write()
2350
new_parents = other_tree.get_parent_ids()
2351
other_root = other_tree.inventory.root
2352
other_root.parent_id = new_root_parent
2353
other_root.name = osutils.basename(other_tree_path)
2354
self.inventory.add(other_root)
2355
add_children(self.inventory, other_root)
2356
self._write_inventory(self.inventory)
2357
# normally we don't want to fetch whole repositories, but i think
2358
# here we really do want to consolidate the whole thing.
2359
for parent_id in other_tree.get_parent_ids():
2360
self.branch.fetch(other_tree.branch, parent_id)
2361
self.add_parent_tree_id(parent_id)
2364
other_tree.bzrdir.retire_bzrdir()
2366
@needs_tree_write_lock
2367
def extract(self, file_id, format=None):
2368
"""Extract a subtree from this tree.
2370
A new branch will be created, relative to the path for this tree.
2374
segments = osutils.splitpath(path)
2375
transport = self.branch.bzrdir.root_transport
2376
for name in segments:
2377
transport = transport.clone(name)
2378
transport.ensure_base()
2381
sub_path = self.id2path(file_id)
2382
branch_transport = mkdirs(sub_path)
2384
format = self.bzrdir.cloning_metadir()
2385
branch_transport.ensure_base()
2386
branch_bzrdir = format.initialize_on_transport(branch_transport)
2388
repo = branch_bzrdir.find_repository()
2389
except errors.NoRepositoryPresent:
2390
repo = branch_bzrdir.create_repository()
2391
if not repo.supports_rich_root():
2392
raise errors.RootNotRich()
2393
new_branch = branch_bzrdir.create_branch()
2394
new_branch.pull(self.branch)
2395
for parent_id in self.get_parent_ids():
2396
new_branch.fetch(self.branch, parent_id)
2397
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2398
if tree_transport.base != branch_transport.base:
2399
tree_bzrdir = format.initialize_on_transport(tree_transport)
2400
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2401
target_branch=new_branch)
2403
tree_bzrdir = branch_bzrdir
2404
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2405
wt.set_parent_ids(self.get_parent_ids())
2406
my_inv = self.inventory
2407
child_inv = inventory.Inventory(root_id=None)
2408
new_root = my_inv[file_id]
2409
my_inv.remove_recursive_id(file_id)
2410
new_root.parent_id = None
2411
child_inv.add(new_root)
2412
self._write_inventory(my_inv)
2413
wt._write_inventory(child_inv)
2416
def list_files(self, include_root=False, from_dir=None, recursive=True):
2417
"""List all files as (path, class, kind, id, entry).
2419
Lists, but does not descend into unversioned directories.
2420
This does not include files that have been deleted in this
2421
tree. Skips the control directory.
2423
:param include_root: if True, return an entry for the root
2424
:param from_dir: start from this directory or None for the root
2425
:param recursive: whether to recurse into subdirectories or not
2427
# list_files is an iterator, so @needs_read_lock doesn't work properly
2428
# with it. So callers should be careful to always read_lock the tree.
2429
if not self.is_locked():
2430
raise errors.ObjectNotLocked(self)
2432
inv = self.inventory
2433
if from_dir is None and include_root is True:
2434
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2435
# Convert these into local objects to save lookup times
2436
pathjoin = osutils.pathjoin
2437
file_kind = self._kind
2439
# transport.base ends in a slash, we want the piece
2440
# between the last two slashes
2441
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2443
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2445
# directory file_id, relative path, absolute path, reverse sorted children
2446
if from_dir is not None:
2447
from_dir_id = inv.path2id(from_dir)
2448
if from_dir_id is None:
2449
# Directory not versioned
2451
from_dir_abspath = pathjoin(self.basedir, from_dir)
2453
from_dir_id = inv.root.file_id
2454
from_dir_abspath = self.basedir
2455
children = os.listdir(from_dir_abspath)
2457
# jam 20060527 The kernel sized tree seems equivalent whether we
2458
# use a deque and popleft to keep them sorted, or if we use a plain
2459
# list and just reverse() them.
2460
children = collections.deque(children)
2461
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2463
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2466
f = children.popleft()
2467
## TODO: If we find a subdirectory with its own .bzr
2468
## directory, then that is a separate tree and we
2469
## should exclude it.
2471
# the bzrdir for this tree
2472
if transport_base_dir == f:
2475
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2476
# and 'f' doesn't begin with one, we can do a string op, rather
2477
# than the checks of pathjoin(), all relative paths will have an extra slash
2479
fp = from_dir_relpath + '/' + f
2482
fap = from_dir_abspath + '/' + f
2484
dir_ie = inv[from_dir_id]
2485
if dir_ie.kind == 'directory':
2486
f_ie = dir_ie.children.get(f)
2491
elif self.is_ignored(fp[1:]):
2494
# we may not have found this file, because of a unicode
2495
# issue, or because the directory was actually a symlink.
2496
f_norm, can_access = osutils.normalized_filename(f)
2497
if f == f_norm or not can_access:
2498
# No change, so treat this file normally
2501
# this file can be accessed by a normalized path
2502
# check again if it is versioned
2503
# these lines are repeated here for performance
2505
fp = from_dir_relpath + '/' + f
2506
fap = from_dir_abspath + '/' + f
2507
f_ie = inv.get_child(from_dir_id, f)
2510
elif self.is_ignored(fp[1:]):
2517
# make a last minute entry
2519
yield fp[1:], c, fk, f_ie.file_id, f_ie
2522
yield fp[1:], c, fk, None, fk_entries[fk]()
2524
yield fp[1:], c, fk, None, TreeEntry()
2527
if fk != 'directory':
2530
# But do this child first if recursing down
2532
new_children = os.listdir(fap)
2534
new_children = collections.deque(new_children)
2535
stack.append((f_ie.file_id, fp, fap, new_children))
2536
# Break out of inner loop,
2537
# so that we start outer loop with child
2540
# if we finished all children, pop it off the stack
2543
@needs_tree_write_lock
2544
def move(self, from_paths, to_dir=None, after=False):
2547
to_dir must exist in the inventory.
2549
If to_dir exists and is a directory, the files are moved into
2550
it, keeping their old names.
2552
Note that to_dir is only the last component of the new name;
2553
this doesn't change the directory.
2555
For each entry in from_paths the move mode will be determined
2558
The first mode moves the file in the filesystem and updates the
2559
inventory. The second mode only updates the inventory without
2560
touching the file on the filesystem.
2562
move uses the second mode if 'after == True' and the target is
2563
either not versioned or newly added, and present in the working tree.
2565
move uses the second mode if 'after == False' and the source is
2566
versioned but no longer in the working tree, and the target is not
2567
versioned but present in the working tree.
2569
move uses the first mode if 'after == False' and the source is
2570
versioned and present in the working tree, and the target is not
2571
versioned and not present in the working tree.
2573
Everything else results in an error.
2575
This returns a list of (from_path, to_path) pairs for each
2576
entry that is moved.
2581
# check for deprecated use of signature
2583
raise TypeError('You must supply a target directory')
2584
# check destination directory
2585
if isinstance(from_paths, basestring):
2587
inv = self.inventory
2588
to_abs = self.abspath(to_dir)
2589
if not isdir(to_abs):
2590
raise errors.BzrMoveFailedError('',to_dir,
2591
errors.NotADirectory(to_abs))
2592
if not self.has_filename(to_dir):
2593
raise errors.BzrMoveFailedError('',to_dir,
2594
errors.NotInWorkingDirectory(to_dir))
2595
to_dir_id = inv.path2id(to_dir)
2596
if to_dir_id is None:
2597
raise errors.BzrMoveFailedError('',to_dir,
2598
errors.NotVersionedError(path=to_dir))
2600
to_dir_ie = inv[to_dir_id]
2601
if to_dir_ie.kind != 'directory':
2602
raise errors.BzrMoveFailedError('',to_dir,
2603
errors.NotADirectory(to_abs))
2605
# create rename entries and tuples
2606
for from_rel in from_paths:
2607
from_tail = splitpath(from_rel)[-1]
2608
from_id = inv.path2id(from_rel)
2610
raise errors.BzrMoveFailedError(from_rel,to_dir,
2611
errors.NotVersionedError(path=from_rel))
2613
from_entry = inv[from_id]
2614
from_parent_id = from_entry.parent_id
2615
to_rel = pathjoin(to_dir, from_tail)
2616
rename_entry = InventoryWorkingTree._RenameEntry(
2619
from_tail=from_tail,
2620
from_parent_id=from_parent_id,
2621
to_rel=to_rel, to_tail=from_tail,
2622
to_parent_id=to_dir_id)
2623
rename_entries.append(rename_entry)
2624
rename_tuples.append((from_rel, to_rel))
2626
# determine which move mode to use. checks also for movability
2627
rename_entries = self._determine_mv_mode(rename_entries, after)
2629
original_modified = self._inventory_is_modified
2632
self._inventory_is_modified = True
2633
self._move(rename_entries)
2635
# restore the inventory on error
2636
self._inventory_is_modified = original_modified
2638
self._write_inventory(inv)
2639
return rename_tuples
2641
@needs_tree_write_lock
2642
def rename_one(self, from_rel, to_rel, after=False):
2645
This can change the directory or the filename or both.
2647
rename_one has several 'modes' to work. First, it can rename a physical
2648
file and change the file_id. That is the normal mode. Second, it can
2649
only change the file_id without touching any physical file.
2651
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2652
versioned but present in the working tree.
2654
rename_one uses the second mode if 'after == False' and 'from_rel' is
2655
versioned but no longer in the working tree, and 'to_rel' is not
2656
versioned but present in the working tree.
2658
rename_one uses the first mode if 'after == False' and 'from_rel' is
2659
versioned and present in the working tree, and 'to_rel' is not
2660
versioned and not present in the working tree.
2662
Everything else results in an error.
2664
inv = self.inventory
2667
# create rename entries and tuples
2668
from_tail = splitpath(from_rel)[-1]
2669
from_id = inv.path2id(from_rel)
2671
# if file is missing in the inventory maybe it's in the basis_tree
2672
basis_tree = self.branch.basis_tree()
2673
from_id = basis_tree.path2id(from_rel)
2675
raise errors.BzrRenameFailedError(from_rel,to_rel,
2676
errors.NotVersionedError(path=from_rel))
2677
# put entry back in the inventory so we can rename it
2678
from_entry = basis_tree.inventory[from_id].copy()
2681
from_entry = inv[from_id]
2682
from_parent_id = from_entry.parent_id
2683
to_dir, to_tail = os.path.split(to_rel)
2684
to_dir_id = inv.path2id(to_dir)
2685
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2687
from_tail=from_tail,
2688
from_parent_id=from_parent_id,
2689
to_rel=to_rel, to_tail=to_tail,
2690
to_parent_id=to_dir_id)
2691
rename_entries.append(rename_entry)
2693
# determine which move mode to use. checks also for movability
2694
rename_entries = self._determine_mv_mode(rename_entries, after)
2696
# check if the target changed directory and if the target directory is
2698
if to_dir_id is None:
2699
raise errors.BzrMoveFailedError(from_rel,to_rel,
2700
errors.NotVersionedError(path=to_dir))
2702
# all checks done. now we can continue with our actual work
2703
mutter('rename_one:\n'
2708
' to_dir_id {%s}\n',
2709
from_id, from_rel, to_rel, to_dir, to_dir_id)
2711
self._move(rename_entries)
2712
self._write_inventory(inv)
2714
class _RenameEntry(object):
2715
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2716
to_rel, to_tail, to_parent_id, only_change_inv=False,
2718
self.from_rel = from_rel
2719
self.from_id = from_id
2720
self.from_tail = from_tail
2721
self.from_parent_id = from_parent_id
2722
self.to_rel = to_rel
2723
self.to_tail = to_tail
2724
self.to_parent_id = to_parent_id
2725
self.change_id = change_id
2726
self.only_change_inv = only_change_inv
2728
def _determine_mv_mode(self, rename_entries, after=False):
2729
"""Determines for each from-to pair if both inventory and working tree
2730
or only the inventory has to be changed.
2732
Also does basic plausability tests.
2734
inv = self.inventory
2736
for rename_entry in rename_entries:
2737
# store to local variables for easier reference
2738
from_rel = rename_entry.from_rel
2739
from_id = rename_entry.from_id
2740
to_rel = rename_entry.to_rel
2741
to_id = inv.path2id(to_rel)
2742
only_change_inv = False
2745
# check the inventory for source and destination
2747
raise errors.BzrMoveFailedError(from_rel,to_rel,
2748
errors.NotVersionedError(path=from_rel))
2749
if to_id is not None:
2751
# allow it with --after but only if dest is newly added
2753
basis = self.basis_tree()
2756
if not basis.has_id(to_id):
2757
rename_entry.change_id = True
2762
raise errors.BzrMoveFailedError(from_rel,to_rel,
2763
errors.AlreadyVersionedError(path=to_rel))
2765
# try to determine the mode for rename (only change inv or change
2766
# inv and file system)
2768
if not self.has_filename(to_rel):
2769
raise errors.BzrMoveFailedError(from_id,to_rel,
2770
errors.NoSuchFile(path=to_rel,
2771
extra="New file has not been created yet"))
2772
only_change_inv = True
2773
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2774
only_change_inv = True
2775
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2776
only_change_inv = False
2777
elif (not self.case_sensitive
2778
and from_rel.lower() == to_rel.lower()
2779
and self.has_filename(from_rel)):
2780
only_change_inv = False
2782
# something is wrong, so lets determine what exactly
2783
if not self.has_filename(from_rel) and \
2784
not self.has_filename(to_rel):
2785
raise errors.BzrRenameFailedError(from_rel,to_rel,
2786
errors.PathsDoNotExist(paths=(str(from_rel),
2789
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2790
rename_entry.only_change_inv = only_change_inv
2791
return rename_entries
2793
def _move(self, rename_entries):
2794
"""Moves a list of files.
2796
Depending on the value of the flag 'only_change_inv', the
2797
file will be moved on the file system or not.
2799
inv = self.inventory
2802
for entry in rename_entries:
2804
self._move_entry(entry)
2806
self._rollback_move(moved)
2810
def _rollback_move(self, moved):
2811
"""Try to rollback a previous move in case of an filesystem error."""
2812
inv = self.inventory
2815
self._move_entry(WorkingTree._RenameEntry(
2816
entry.to_rel, entry.from_id,
2817
entry.to_tail, entry.to_parent_id, entry.from_rel,
2818
entry.from_tail, entry.from_parent_id,
2819
entry.only_change_inv))
2820
except errors.BzrMoveFailedError, e:
2821
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2822
" The working tree is in an inconsistent state."
2823
" Please consider doing a 'bzr revert'."
2824
" Error message is: %s" % e)
2826
def _move_entry(self, entry):
2827
inv = self.inventory
2828
from_rel_abs = self.abspath(entry.from_rel)
2829
to_rel_abs = self.abspath(entry.to_rel)
2830
if from_rel_abs == to_rel_abs:
2831
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2832
"Source and target are identical.")
2834
if not entry.only_change_inv:
2836
osutils.rename(from_rel_abs, to_rel_abs)
2838
raise errors.BzrMoveFailedError(entry.from_rel,
2841
to_id = inv.path2id(entry.to_rel)
2842
inv.remove_recursive_id(to_id)
2843
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2845
@needs_tree_write_lock
2846
def unversion(self, file_ids):
2847
"""Remove the file ids in file_ids from the current versioned set.
2849
When a file_id is unversioned, all of its children are automatically
2852
:param file_ids: The file ids to stop versioning.
2853
:raises: NoSuchId if any fileid is not currently versioned.
2855
for file_id in file_ids:
2856
if not self._inventory.has_id(file_id):
2857
raise errors.NoSuchId(self, file_id)
2858
for file_id in file_ids:
2859
if self._inventory.has_id(file_id):
2860
self._inventory.remove_recursive_id(file_id)
2862
# in the future this should just set a dirty bit to wait for the
2863
# final unlock. However, until all methods of workingtree start
2864
# with the current in -memory inventory rather than triggering
2865
# a read, it is more complex - we need to teach read_inventory
2866
# to know when to read, and when to not read first... and possibly
2867
# to save first when the in memory one may be corrupted.
2868
# so for now, we just only write it if it is indeed dirty.
2870
self._write_inventory(self._inventory)
2872
def stored_kind(self, file_id):
2873
"""See Tree.stored_kind"""
2874
return self.inventory[file_id].kind
2877
"""Yield all unversioned files in this WorkingTree.
2879
If there are any unversioned directories then only the directory is
2880
returned, not all its children. But if there are unversioned files
2881
under a versioned subdirectory, they are returned.
2883
Currently returned depth-first, sorted by name within directories.
2884
This is the same order used by 'osutils.walkdirs'.
2886
## TODO: Work from given directory downwards
2887
for path, dir_entry in self.inventory.directories():
2888
# mutter("search for unknowns in %r", path)
2889
dirabs = self.abspath(path)
2890
if not isdir(dirabs):
2891
# e.g. directory deleted
2895
for subf in os.listdir(dirabs):
2896
if self.bzrdir.is_control_filename(subf):
2898
if subf not in dir_entry.children:
2901
can_access) = osutils.normalized_filename(subf)
2902
except UnicodeDecodeError:
2903
path_os_enc = path.encode(osutils._fs_enc)
2904
relpath = path_os_enc + '/' + subf
2905
raise errors.BadFilenameEncoding(relpath,
2907
if subf_norm != subf and can_access:
2908
if subf_norm not in dir_entry.children:
2909
fl.append(subf_norm)
2915
subp = pathjoin(path, subf)
2918
def _walkdirs(self, prefix=""):
2919
"""Walk the directories of this tree.
2921
:param prefix: is used as the directrory to start with.
2922
:returns: a generator which yields items in the form::
2924
((curren_directory_path, fileid),
2925
[(file1_path, file1_name, file1_kind, None, file1_id,
2928
_directory = 'directory'
2929
# get the root in the inventory
2930
inv = self.inventory
2931
top_id = inv.path2id(prefix)
2935
pending = [(prefix, '', _directory, None, top_id, None)]
2938
currentdir = pending.pop()
2939
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2940
top_id = currentdir[4]
2942
relroot = currentdir[0] + '/'
2945
# FIXME: stash the node in pending
2947
if entry.kind == 'directory':
2948
for name, child in entry.sorted_children():
2949
dirblock.append((relroot + name, name, child.kind, None,
2950
child.file_id, child.kind
2952
yield (currentdir[0], entry.file_id), dirblock
2953
# push the user specified dirs from dirblock
2954
for dir in reversed(dirblock):
2955
if dir[2] == _directory:
2959
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2960
"""Registry for working tree formats."""
2962
def __init__(self, other_registry=None):
2963
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2964
self._default_format = None
2965
self._default_format_key = None
2967
def get_default(self):
2968
"""Return the current default format."""
2969
if (self._default_format_key is not None and
2970
self._default_format is None):
2971
self._default_format = self.get(self._default_format_key)
2972
return self._default_format
2974
def set_default(self, format):
2975
"""Set the default format."""
2976
self._default_format = format
2977
self._default_format_key = None
2979
def set_default_key(self, format_string):
2980
"""Set the default format by its format string."""
2981
self._default_format_key = format_string
2982
self._default_format = None
2985
format_registry = WorkingTreeFormatRegistry()
2988
class WorkingTreeFormat(controldir.ControlComponentFormat):
1778
if filename == head:
1784
class WorkingTreeFormat(object):
2989
1785
"""An encapsulation of the initialization and open routines for a format.
2991
1787
Formats provide three things: