398
295
def abspath(self, filename):
399
296
return pathjoin(self.basedir, filename)
401
def basis_tree(self):
402
"""Return RevisionTree for the current last revision.
404
If the left most parent is a ghost then the returned tree will be an
405
empty tree - one obtained by calling
406
repository.revision_tree(NULL_REVISION).
409
revision_id = self.get_parent_ids()[0]
411
# no parents, return an empty revision tree.
412
# in the future this should return the tree for
413
# 'empty:' - the implicit root empty tree.
414
return self.branch.repository.revision_tree(
415
_mod_revision.NULL_REVISION)
417
return self.revision_tree(revision_id)
418
except errors.NoSuchRevision:
420
# No cached copy available, retrieve from the repository.
421
# FIXME? RBC 20060403 should we cache the inventory locally
424
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
# the basis tree *may* be a ghost or a low level error may have
427
# occurred. If the revision is present, its a problem, if its not
429
if self.branch.repository.has_revision(revision_id):
431
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
436
self._flush_ignore_list_cache()
438
def relpath(self, path):
439
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
442
interpreted relative to the python current working directory.
444
return osutils.relpath(self.basedir, path)
299
def create(branch, directory):
300
"""Create a workingtree for branch at directory.
302
If existing_directory already exists it must have a .bzr directory.
303
If it does not exist, it will be created.
305
This returns a new WorkingTree object for the new checkout.
307
TODO FIXME RBC 20060124 when we have checkout formats in place this
308
should accept an optional revisionid to checkout [and reject this if
309
checking out into the same dir as a pre-checkout-aware branch format.]
311
XXX: When BzrDir is present, these should be created through that
317
if e.errno != errno.EEXIST:
320
os.mkdir(pathjoin(directory, '.bzr'))
322
if e.errno != errno.EEXIST:
324
inv = branch.repository.revision_tree(branch.last_revision()).inventory
325
wt = WorkingTree(directory, branch, inv)
326
wt._write_inventory(inv)
327
if branch.last_revision() is not None:
328
wt.set_last_revision(branch.last_revision())
329
wt.set_pending_merges([])
334
def create_standalone(directory):
335
"""Create a checkout and a branch at directory.
337
Directory must exist and be empty.
339
XXX: When BzrDir is present, these should be created through that
342
directory = safe_unicode(directory)
343
b = Branch.create(directory)
344
return WorkingTree.create(b, directory)
346
def relpath(self, abs):
347
"""Return the local path portion from a given absolute path."""
348
return relpath(self.basedir, abs)
446
350
def has_filename(self, filename):
447
return osutils.lexists(self.abspath(filename))
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
486
"""See Tree.annotate_iter
488
This implementation will use the basis tree implementation if possible.
489
Lines not in the basis are attributed to CURRENT_REVISION
491
If there are pending merges, lines added by those merges will be
492
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
539
def get_parent_ids(self):
540
"""See Tree.get_parent_ids.
542
This implementation reads the pending merges list and last_revision
543
value and uses that to decide what the parents list should be.
545
last_rev = _mod_revision.ensure_null(self._last_revision())
546
if _mod_revision.NULL_REVISION == last_rev:
551
merges_bytes = self._transport.get_bytes('pending-merges')
552
except errors.NoSuchFile:
555
for l in osutils.split_lines(merges_bytes):
556
revision_id = l.rstrip('\n')
557
parents.append(revision_id)
351
return bzrlib.osutils.lexists(self.abspath(filename))
353
def get_file(self, file_id):
354
return self.get_file_byname(self.id2path(file_id))
356
def get_file_byname(self, filename):
357
return file(self.abspath(filename), 'rb')
561
359
def get_root_id(self):
562
360
"""Return the id of this trees root"""
563
return self._inventory.root.file_id
361
inv = self.read_working_inventory()
362
return inv.root.file_id
565
364
def _get_store_filename(self, file_id):
566
365
## XXX: badly named; this is not in the store at all
567
366
return self.abspath(self.id2path(file_id))
570
def clone(self, to_bzrdir, revision_id=None):
571
"""Duplicate this working tree into to_bzr, including all state.
573
Specifically modified files are kept as modified, but
574
ignored and unknown files are discarded.
576
If you want to make a new line of development, see bzrdir.sprout()
579
If not None, the cloned tree will have its last revision set to
580
revision, and difference between the source trees last revision
581
and this one merged in.
583
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
585
self.copy_content_into(result, revision_id)
589
def copy_content_into(self, tree, revision_id=None):
590
"""Copy the current content and user files of this tree into tree."""
591
tree.set_root_id(self.get_root_id())
592
if revision_id is None:
593
merge.transform_tree(tree, self)
595
# TODO now merge from tree.last_revision to revision (to preserve
596
# user local changes)
597
merge.transform_tree(tree, self)
598
tree.set_parent_ids([revision_id])
369
def commit(self, *args, **kwargs):
370
from bzrlib.commit import Commit
371
# args for wt.commit start at message from the Commit.commit method,
372
# but with branch a kwarg now, passing in args as is results in the
373
#message being used for the branch
374
args = (DEPRECATED_PARAMETER, ) + args
375
Commit().commit(working_tree=self, *args, **kwargs)
376
self._set_inventory(self.read_working_inventory())
600
378
def id2abspath(self, file_id):
601
379
return self.abspath(self.id2path(file_id))
603
381
def has_id(self, file_id):
604
382
# files that have been deleted are excluded
383
inv = self._inventory
606
384
if not inv.has_id(file_id):
608
386
path = inv.id2path(file_id)
609
return osutils.lexists(self.abspath(path))
387
return bzrlib.osutils.lexists(self.abspath(path))
611
389
def has_or_had_id(self, file_id):
612
390
if file_id == self.inventory.root.file_id:
616
394
__contains__ = has_id
618
396
def get_file_size(self, file_id):
619
"""See Tree.get_file_size"""
620
# XXX: this returns the on-disk size; it should probably return the
623
return os.path.getsize(self.id2abspath(file_id))
625
if e.errno != errno.ENOENT:
397
return os.path.getsize(self.id2abspath(file_id))
631
def get_file_sha1(self, file_id, path=None, stat_value=None):
400
def get_file_sha1(self, file_id):
401
path = self._inventory.id2path(file_id)
402
return self._hashcache.get_sha1(path)
404
def is_executable(self, file_id):
406
return self._inventory[file_id].executable
633
408
path = self._inventory.id2path(file_id)
634
return self._hashcache.get_sha1(path, stat_value)
636
def get_file_mtime(self, file_id, path=None):
638
path = self.inventory.id2path(file_id)
639
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
if not supports_executable():
654
def is_executable(self, file_id, path=None):
655
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
660
def is_executable(self, file_id, path=None):
662
path = self.id2path(file_id)
663
409
mode = os.lstat(self.abspath(path)).st_mode
664
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
@needs_tree_write_lock
670
def _add(self, files, ids, kinds):
671
"""See MutableTree._add."""
410
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
413
def add(self, files, ids=None):
414
"""Make files versioned.
416
Note that the command line normally calls smart_add instead,
417
which can automatically recurse.
419
This adds the files to the inventory, so that they will be
420
recorded by the next commit.
423
List of paths to add, relative to the base of the tree.
426
If set, use these instead of automatically generated ids.
427
Must be the same length as the list of files, but may
428
contain None for ids that are to be autogenerated.
430
TODO: Perhaps have an option to add the ids even if the files do
433
TODO: Perhaps callback with the ids and paths as they're added.
672
435
# TODO: Re-adding a file that is removed in the working copy
673
436
# should probably put it back with the previous ID.
674
# the read and write working inventory should not occur in this
675
# function - they should be part of lock_write and unlock.
677
for f, file_id, kind in zip(files, ids, kinds):
437
if isinstance(files, basestring):
438
assert(ids is None or isinstance(ids, basestring))
444
ids = [None] * len(files)
446
assert(len(ids) == len(files))
448
inv = self.read_working_inventory()
449
for f,file_id in zip(files, ids):
450
if is_control_file(f):
451
raise BzrError("cannot add control file %s" % quotefn(f))
456
raise BzrError("cannot add top-level %r" % f)
458
fullpath = normpath(self.abspath(f))
461
kind = file_kind(fullpath)
463
# maybe something better?
464
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
466
if not InventoryEntry.versionable_kind(kind):
467
raise BzrError('cannot add: not a versionable file ('
468
'i.e. regular file, symlink or directory): %s' % quotefn(f))
678
470
if file_id is None:
679
inv.add_path(f, kind=kind)
681
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
471
file_id = gen_file_id(f)
472
inv.add_path(f, kind=kind, file_id=file_id)
684
@needs_tree_write_lock
685
def _gather_kinds(self, files, kinds):
686
"""See MutableTree._gather_kinds."""
687
for pos, f in enumerate(files):
688
if kinds[pos] is None:
689
fullpath = normpath(self.abspath(f))
691
kinds[pos] = file_kind(fullpath)
693
if e.errno == errno.ENOENT:
694
raise errors.NoSuchFile(fullpath)
474
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
475
self._write_inventory(inv)
696
477
@needs_write_lock
697
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
698
"""Add revision_id as a parent.
700
This is equivalent to retrieving the current list of parent ids
701
and setting the list to its value plus revision_id.
703
:param revision_id: The revision id to add to the parent list. It may
704
be a ghost revision as long as its not the first parent to be added,
705
or the allow_leftmost_as_ghost parameter is set True.
706
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
708
parents = self.get_parent_ids() + [revision_id]
709
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
710
or allow_leftmost_as_ghost)
712
@needs_tree_write_lock
713
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
714
"""Add revision_id, tree tuple as a parent.
716
This is equivalent to retrieving the current list of parent trees
717
and setting the list to its value plus parent_tuple. See also
718
add_parent_tree_id - if you only have a parent id available it will be
719
simpler to use that api. If you have the parent already available, using
720
this api is preferred.
722
:param parent_tuple: The (revision id, tree) to add to the parent list.
723
If the revision_id is a ghost, pass None for the tree.
724
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
726
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
727
if len(parent_ids) > 1:
728
# the leftmost may have already been a ghost, preserve that if it
730
allow_leftmost_as_ghost = True
731
self.set_parent_ids(parent_ids,
732
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
734
@needs_tree_write_lock
735
478
def add_pending_merge(self, *revision_ids):
736
479
# TODO: Perhaps should check at this point that the
737
480
# history of the revision is actually present?
738
parents = self.get_parent_ids()
481
p = self.pending_merges()
740
483
for rev_id in revision_ids:
741
if rev_id in parents:
743
parents.append(rev_id)
746
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
def path_content_summary(self, path, _lstat=os.lstat,
749
_mapper=osutils.file_kind_from_stat_mode):
750
"""See Tree.path_content_summary."""
751
abspath = self.abspath(path)
489
self.set_pending_merges(p)
492
def pending_merges(self):
493
"""Return a list of pending merges.
495
These are revisions that have been merged into the working
496
directory but not yet committed.
753
stat_result = _lstat(abspath)
499
merges_file = self._control_files.get_utf8('pending-merges')
754
500
except OSError, e:
755
if getattr(e, 'errno', None) == errno.ENOENT:
757
return ('missing', None, None, None)
758
# propagate other errors
760
kind = _mapper(stat_result.st_mode)
762
return self._file_content_summary(path, stat_result)
763
elif kind == 'directory':
764
# perhaps it looks like a plain directory, but it's really a
766
if self._directory_is_tree_reference(path):
767
kind = 'tree-reference'
768
return kind, None, None, None
769
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
773
return (kind, None, None, None)
775
def _file_content_summary(self, path, stat_result):
776
size = stat_result.st_size
777
executable = self._is_executable_from_path_and_stat(path, stat_result)
778
# try for a stat cache lookup
779
return ('file', size, executable, self._sha_from_stat(
782
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
"""Common ghost checking functionality from set_parent_*.
785
This checks that the left hand-parent exists if there are any
788
if len(revision_ids) > 0:
789
leftmost_id = revision_ids[0]
790
if (not allow_leftmost_as_ghost and not
791
self.branch.repository.has_revision(leftmost_id)):
792
raise errors.GhostRevisionUnusableHere(leftmost_id)
794
def _set_merges_from_parent_ids(self, parent_ids):
795
merges = parent_ids[1:]
796
self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
mode=self.bzrdir._get_file_mode())
799
def _filter_parent_ids_by_ancestry(self, revision_ids):
800
"""Check that all merged revisions are proper 'heads'.
802
This will always return the first revision_id, and any merged revisions
805
if len(revision_ids) == 0:
807
graph = self.branch.repository.get_graph()
808
heads = graph.heads(revision_ids)
809
new_revision_ids = revision_ids[:1]
810
for revision_id in revision_ids[1:]:
811
if revision_id in heads and revision_id not in new_revision_ids:
812
new_revision_ids.append(revision_id)
813
if new_revision_ids != revision_ids:
814
trace.mutter('requested to set revision_ids = %s,'
815
' but filtered to %s', revision_ids, new_revision_ids)
816
return new_revision_ids
818
@needs_tree_write_lock
819
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
"""Set the parent ids to revision_ids.
822
See also set_parent_trees. This api will try to retrieve the tree data
823
for each element of revision_ids from the trees repository. If you have
824
tree data already available, it is more efficient to use
825
set_parent_trees rather than set_parent_ids. set_parent_ids is however
826
an easier API to use.
828
:param revision_ids: The revision_ids to set as the parent ids of this
829
working tree. Any of these may be ghosts.
831
self._check_parents_for_ghosts(revision_ids,
832
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
for revision_id in revision_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
if len(revision_ids) > 0:
839
self.set_last_revision(revision_ids[0])
841
self.set_last_revision(_mod_revision.NULL_REVISION)
843
self._set_merges_from_parent_ids(revision_ids)
845
@needs_tree_write_lock
846
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
"""See MutableTree.set_parent_trees."""
848
parent_ids = [rev for (rev, tree) in parents_list]
849
for revision_id in parent_ids:
850
_mod_revision.check_not_reserved_id(revision_id)
852
self._check_parents_for_ghosts(parent_ids,
853
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
if len(parent_ids) == 0:
858
leftmost_parent_id = _mod_revision.NULL_REVISION
859
leftmost_parent_tree = None
861
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
863
if self._change_last_revision(leftmost_parent_id):
864
if leftmost_parent_tree is None:
865
# If we don't have a tree, fall back to reading the
866
# parent tree from the repository.
867
self._cache_basis_inventory(leftmost_parent_id)
869
inv = leftmost_parent_tree.inventory
870
xml = self._create_basis_xml_from_inventory(
871
leftmost_parent_id, inv)
872
self._write_basis_inventory(xml)
873
self._set_merges_from_parent_ids(parent_ids)
875
@needs_tree_write_lock
501
if e.errno != errno.ENOENT:
505
for l in merges_file.readlines():
506
p.append(l.rstrip('\n'))
876
510
def set_pending_merges(self, rev_list):
877
parents = self.get_parent_ids()
878
leftmost = parents[:1]
879
new_parents = leftmost + rev_list
880
self.set_parent_ids(new_parents)
882
@needs_tree_write_lock
883
def set_merge_modified(self, modified_hashes):
885
for file_id, hash in modified_hashes.iteritems():
886
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
889
def _sha_from_stat(self, path, stat_result):
890
"""Get a sha digest from the tree's stat cache.
892
The default implementation assumes no stat cache is present.
894
:param path: The path.
895
:param stat_result: The stat result being looked up.
899
def _put_rio(self, filename, stanzas, header):
900
self._must_be_locked()
901
my_file = rio_file(stanzas, header)
902
self._transport.put_file(filename, my_file,
903
mode=self.bzrdir._get_file_mode())
905
@needs_write_lock # because merge pulls data into the branch.
906
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
merge_type=None, force=False):
908
"""Merge from a branch into this working tree.
910
:param branch: The branch to merge from.
911
:param to_revision: If non-None, the merge will merge to to_revision,
912
but not beyond it. to_revision does not need to be in the history
913
of the branch when it is supplied. If None, to_revision defaults to
914
branch.last_revision().
916
from bzrlib.merge import Merger, Merge3Merger
917
merger = Merger(self.branch, this_tree=self)
918
# check that there are no local alterations
919
if not force and self.has_changes():
920
raise errors.UncommittedChanges(self)
921
if to_revision is None:
922
to_revision = _mod_revision.ensure_null(branch.last_revision())
923
merger.other_rev_id = to_revision
924
if _mod_revision.is_null(merger.other_rev_id):
925
raise errors.NoCommits(branch)
926
self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
merger.other_basis = merger.other_rev_id
928
merger.other_tree = self.branch.repository.revision_tree(
930
merger.other_branch = branch
931
if from_revision is None:
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
939
merger.merge_type = Merge3Merger
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
conflicts = merger.do_merge()
950
def merge_modified(self):
951
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
954
typically called after we make some automatic updates to the tree
957
This returns a map of file_id->sha1, containing only files which are
958
still in the working inventory and have that text hash.
961
hashfile = self._transport.get('merge-hashes')
962
except errors.NoSuchFile:
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
970
raise errors.MergeModifiedFormatError()
971
for s in RioReader(hashfile):
972
# RioReader reads in Unicode, so convert file_ids back to utf8
973
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
if file_id not in self.inventory:
976
text_hash = s.get("hash")
977
if text_hash == self.get_file_sha1(file_id):
978
merge_hashes[file_id] = text_hash
984
def mkdir(self, path, file_id=None):
985
"""See MutableTree.mkdir()."""
987
file_id = generate_ids.gen_file_id(os.path.basename(path))
988
os.mkdir(self.abspath(path))
989
self.add(path, file_id, 'directory')
511
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
992
513
def get_symlink_target(self, file_id):
993
abspath = self.id2abspath(file_id)
994
target = osutils.readlink(abspath)
998
def subsume(self, other_tree):
999
def add_children(inventory, entry):
1000
for child_entry in entry.children.values():
1001
inventory._byid[child_entry.file_id] = child_entry
1002
if child_entry.kind == 'directory':
1003
add_children(inventory, child_entry)
1004
if other_tree.get_root_id() == self.get_root_id():
1005
raise errors.BadSubsumeSource(self, other_tree,
1006
'Trees have the same root')
1008
other_tree_path = self.relpath(other_tree.basedir)
1009
except errors.PathNotChild:
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Tree is not contained by the other')
1012
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
if new_root_parent is None:
1014
raise errors.BadSubsumeSource(self, other_tree,
1015
'Parent directory is not versioned.')
1016
# We need to ensure that the result of a fetch will have a
1017
# versionedfile for the other_tree root, and only fetching into
1018
# RepositoryKnit2 guarantees that.
1019
if not self.branch.repository.supports_rich_root():
1020
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
other_tree.lock_tree_write()
1023
new_parents = other_tree.get_parent_ids()
1024
other_root = other_tree.inventory.root
1025
other_root.parent_id = new_root_parent
1026
other_root.name = osutils.basename(other_tree_path)
1027
self.inventory.add(other_root)
1028
add_children(self.inventory, other_root)
1029
self._write_inventory(self.inventory)
1030
# normally we don't want to fetch whole repositories, but i think
1031
# here we really do want to consolidate the whole thing.
1032
for parent_id in other_tree.get_parent_ids():
1033
self.branch.fetch(other_tree.branch, parent_id)
1034
self.add_parent_tree_id(parent_id)
1037
other_tree.bzrdir.retire_bzrdir()
1039
def _setup_directory_is_tree_reference(self):
1040
if self._branch.repository._format.supports_tree_reference:
1041
self._directory_is_tree_reference = \
1042
self._directory_may_be_tree_reference
1044
self._directory_is_tree_reference = \
1045
self._directory_is_never_tree_reference
1047
def _directory_is_never_tree_reference(self, relpath):
1050
def _directory_may_be_tree_reference(self, relpath):
1051
# as a special case, if a directory contains control files then
1052
# it's a tree reference, except that the root of the tree is not
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
# TODO: We could ask all the control formats whether they
1055
# recognize this directory, but at the moment there's no cheap api
1056
# to do that. Since we probably can only nest bzr checkouts and
1057
# they always use this name it's ok for now. -- mbp 20060306
1059
# FIXME: There is an unhandled case here of a subdirectory
1060
# containing .bzr but not a branch; that will probably blow up
1061
# when you try to commit it. It might happen if there is a
1062
# checkout in a subdirectory. This can be avoided by not adding
1065
@needs_tree_write_lock
1066
def extract(self, file_id, format=None):
1067
"""Extract a subtree from this tree.
1069
A new branch will be created, relative to the path for this tree.
1073
segments = osutils.splitpath(path)
1074
transport = self.branch.bzrdir.root_transport
1075
for name in segments:
1076
transport = transport.clone(name)
1077
transport.ensure_base()
1080
sub_path = self.id2path(file_id)
1081
branch_transport = mkdirs(sub_path)
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
1085
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
repo = branch_bzrdir.find_repository()
1088
except errors.NoRepositoryPresent:
1089
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
1092
new_branch = branch_bzrdir.create_branch()
1093
new_branch.pull(self.branch)
1094
for parent_id in self.get_parent_ids():
1095
new_branch.fetch(self.branch, parent_id)
1096
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
if tree_transport.base != branch_transport.base:
1098
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1102
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
wt.set_parent_ids(self.get_parent_ids())
1105
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1107
new_root = my_inv[file_id]
1108
my_inv.remove_recursive_id(file_id)
1109
new_root.parent_id = None
1110
child_inv.add(new_root)
1111
self._write_inventory(my_inv)
1112
wt._write_inventory(child_inv)
1115
def _serialize(self, inventory, out_file):
1116
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1119
def _deserialize(selt, in_file):
1120
return xml5.serializer_v5.read_inventory(in_file)
1123
"""Write the in memory inventory to disk."""
1124
# TODO: Maybe this should only write on dirty ?
1125
if self._control_files._lock_mode != 'w':
1126
raise errors.NotWriteLocked(self)
1128
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1132
self._inventory_is_modified = False
1134
def _kind(self, relpath):
1135
return osutils.file_kind(self.abspath(relpath))
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""List all files as (path, class, kind, id, entry).
514
return os.readlink(self.id2abspath(file_id))
516
def file_class(self, filename):
517
if self.path2id(filename):
519
elif self.is_ignored(filename):
525
def list_files(self):
526
"""Recursively list all files as (path, class, kind, id).
1140
528
Lists, but does not descend into unversioned directories.
1141
530
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1144
:param include_root: if True, return an entry for the root
1145
:param from_dir: start from this directory or None for the root
1146
:param recursive: whether to recurse into subdirectories or not
533
Skips the control directory.
1148
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
# with it. So callers should be careful to always read_lock the tree.
1150
if not self.is_locked():
1151
raise errors.ObjectNotLocked(self)
1153
inv = self.inventory
1154
if from_dir is None and include_root is True:
1155
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
# Convert these into local objects to save lookup times
1157
pathjoin = osutils.pathjoin
1158
file_kind = self._kind
1160
# transport.base ends in a slash, we want the piece
1161
# between the last two slashes
1162
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1164
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
# directory file_id, relative path, absolute path, reverse sorted children
1167
if from_dir is not None:
1168
from_dir_id = inv.path2id(from_dir)
1169
if from_dir_id is None:
1170
# Directory not versioned
1172
from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
from_dir_id = inv.root.file_id
1175
from_dir_abspath = self.basedir
1176
children = os.listdir(from_dir_abspath)
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1179
# use a deque and popleft to keep them sorted, or if we use a plain
1180
# list and just reverse() them.
1181
children = collections.deque(children)
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1184
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1187
f = children.popleft()
535
inv = self._inventory
537
def descend(from_dir_relpath, from_dir_id, dp):
1188
541
## TODO: If we find a subdirectory with its own .bzr
1189
542
## directory, then that is a separate tree and we
1190
543
## should exclude it.
1192
# the bzrdir for this tree
1193
if transport_base_dir == f:
544
if bzrlib.BZRDIR == f:
1196
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1197
# and 'f' doesn't begin with one, we can do a string op, rather
1198
# than the checks of pathjoin(), all relative paths will have an extra slash
1200
fp = from_dir_relpath + '/' + f
548
fp = appendpath(from_dir_relpath, f)
1203
fap = from_dir_abspath + '/' + f
551
fap = appendpath(dp, f)
1205
553
f_ie = inv.get_child(from_dir_id, f)
1208
elif self.is_ignored(fp[1:]):
556
elif self.is_ignored(fp):
1211
# we may not have found this file, because of a unicode issue
1212
f_norm, can_access = osutils.normalized_filename(f)
1213
if f == f_norm or not can_access:
1214
# No change, so treat this file normally
1217
# this file can be accessed by a normalized path
1218
# check again if it is versioned
1219
# these lines are repeated here for performance
1221
fp = from_dir_relpath + '/' + f
1222
fap = from_dir_abspath + '/' + f
1223
f_ie = inv.get_child(from_dir_id, f)
1226
elif self.is_ignored(fp[1:]):
1231
561
fk = file_kind(fap)
565
raise BzrCheckError("file %r entered as kind %r id %r, "
567
% (fap, f_ie.kind, f_ie.file_id, fk))
1233
569
# make a last minute entry
1235
yield fp[1:], c, fk, f_ie.file_id, f_ie
1238
yield fp[1:], c, fk, None, fk_entries[fk]()
1240
yield fp[1:], c, fk, None, TreeEntry()
573
if fk == 'directory':
574
entry = TreeDirectory()
577
elif fk == 'symlink':
582
yield fp, c, fk, (f_ie and f_ie.file_id), entry
1243
584
if fk != 'directory':
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# so that we start outer loop with child
1256
# if we finished all children, pop it off the stack
1259
@needs_tree_write_lock
1260
def move(self, from_paths, to_dir=None, after=False, **kwargs):
588
# don't descend unversioned directories
591
for ff in descend(fp, f_ie.file_id, fap):
594
for f in descend(u'', inv.root.file_id, self.basedir):
598
def move(self, from_paths, to_name):
1261
599
"""Rename files.
1263
to_dir must exist in the inventory.
1265
If to_dir exists and is a directory, the files are moved into
1266
it, keeping their old names.
1268
Note that to_dir is only the last component of the new name;
601
to_name must exist in the inventory.
603
If to_name exists and is a directory, the files are moved into
604
it, keeping their old names.
606
Note that to_name is only the last component of the new name;
1269
607
this doesn't change the directory.
1271
For each entry in from_paths the move mode will be determined
1274
The first mode moves the file in the filesystem and updates the
1275
inventory. The second mode only updates the inventory without
1276
touching the file on the filesystem. This is the new mode introduced
1279
move uses the second mode if 'after == True' and the target is not
1280
versioned but present in the working tree.
1282
move uses the second mode if 'after == False' and the source is
1283
versioned but no longer in the working tree, and the target is not
1284
versioned but present in the working tree.
1286
move uses the first mode if 'after == False' and the source is
1287
versioned and present in the working tree, and the target is not
1288
versioned and not present in the working tree.
1290
Everything else results in an error.
1292
609
This returns a list of (from_path, to_path) pairs for each
1293
610
entry that is moved.
1298
# check for deprecated use of signature
1300
to_dir = kwargs.get('to_name', None)
1302
raise TypeError('You must supply a target directory')
1304
symbol_versioning.warn('The parameter to_name was deprecated'
1305
' in version 0.13. Use to_dir instead',
1308
# check destination directory
1309
if isinstance(from_paths, basestring):
613
## TODO: Option to move IDs only
614
assert not isinstance(from_paths, basestring)
1311
615
inv = self.inventory
1312
to_abs = self.abspath(to_dir)
616
to_abs = self.abspath(to_name)
1313
617
if not isdir(to_abs):
1314
raise errors.BzrMoveFailedError('',to_dir,
1315
errors.NotADirectory(to_abs))
1316
if not self.has_filename(to_dir):
1317
raise errors.BzrMoveFailedError('',to_dir,
1318
errors.NotInWorkingDirectory(to_dir))
1319
to_dir_id = inv.path2id(to_dir)
1320
if to_dir_id is None:
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotVersionedError(path=str(to_dir)))
618
raise BzrError("destination %r is not a directory" % to_abs)
619
if not self.has_filename(to_name):
620
raise BzrError("destination %r not in working directory" % to_abs)
621
to_dir_id = inv.path2id(to_name)
622
if to_dir_id == None and to_name != '':
623
raise BzrError("destination %r is not a versioned directory" % to_name)
1324
624
to_dir_ie = inv[to_dir_id]
1325
if to_dir_ie.kind != 'directory':
1326
raise errors.BzrMoveFailedError('',to_dir,
1327
errors.NotADirectory(to_abs))
1329
# create rename entries and tuples
1330
for from_rel in from_paths:
1331
from_tail = splitpath(from_rel)[-1]
1332
from_id = inv.path2id(from_rel)
1334
raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
errors.NotVersionedError(path=str(from_rel)))
1337
from_entry = inv[from_id]
1338
from_parent_id = from_entry.parent_id
1339
to_rel = pathjoin(to_dir, from_tail)
1340
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1342
from_tail=from_tail,
1343
from_parent_id=from_parent_id,
1344
to_rel=to_rel, to_tail=from_tail,
1345
to_parent_id=to_dir_id)
1346
rename_entries.append(rename_entry)
1347
rename_tuples.append((from_rel, to_rel))
1349
# determine which move mode to use. checks also for movability
1350
rename_entries = self._determine_mv_mode(rename_entries, after)
1352
original_modified = self._inventory_is_modified
625
if to_dir_ie.kind not in ('directory', 'root_directory'):
626
raise BzrError("destination %r is not a directory" % to_abs)
628
to_idpath = inv.get_idpath(to_dir_id)
631
if not self.has_filename(f):
632
raise BzrError("%r does not exist in working tree" % f)
633
f_id = inv.path2id(f)
635
raise BzrError("%r is not versioned" % f)
636
name_tail = splitpath(f)[-1]
637
dest_path = appendpath(to_name, name_tail)
638
if self.has_filename(dest_path):
639
raise BzrError("destination %r already exists" % dest_path)
640
if f_id in to_idpath:
641
raise BzrError("can't move %r to a subdirectory of itself" % f)
643
# OK, so there's a race here, it's possible that someone will
644
# create a file in this interval and then the rename might be
645
# left half-done. But we should have caught most problems.
646
orig_inv = deepcopy(self.inventory)
1355
self._inventory_is_modified = True
1356
self._move(rename_entries)
649
name_tail = splitpath(f)[-1]
650
dest_path = appendpath(to_name, name_tail)
651
result.append((f, dest_path))
652
inv.rename(inv.path2id(f), to_dir_id, name_tail)
654
rename(self.abspath(f), self.abspath(dest_path))
656
raise BzrError("failed to rename %r to %r: %s" %
657
(f, dest_path, e[1]),
658
["rename rolled back"])
1358
660
# restore the inventory on error
1359
self._inventory_is_modified = original_modified
661
self._set_inventory(orig_inv)
1361
663
self._write_inventory(inv)
1362
return rename_tuples
1364
def _determine_mv_mode(self, rename_entries, after=False):
1365
"""Determines for each from-to pair if both inventory and working tree
1366
or only the inventory has to be changed.
1368
Also does basic plausability tests.
1370
inv = self.inventory
1372
for rename_entry in rename_entries:
1373
# store to local variables for easier reference
1374
from_rel = rename_entry.from_rel
1375
from_id = rename_entry.from_id
1376
to_rel = rename_entry.to_rel
1377
to_id = inv.path2id(to_rel)
1378
only_change_inv = False
1380
# check the inventory for source and destination
1382
raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
errors.NotVersionedError(path=str(from_rel)))
1384
if to_id is not None:
1385
raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
errors.AlreadyVersionedError(path=str(to_rel)))
1388
# try to determine the mode for rename (only change inv or change
1389
# inv and file system)
1391
if not self.has_filename(to_rel):
1392
raise errors.BzrMoveFailedError(from_id,to_rel,
1393
errors.NoSuchFile(path=str(to_rel),
1394
extra="New file has not been created yet"))
1395
only_change_inv = True
1396
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1397
only_change_inv = True
1398
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
only_change_inv = False
1400
elif (not self.case_sensitive
1401
and from_rel.lower() == to_rel.lower()
1402
and self.has_filename(from_rel)):
1403
only_change_inv = False
1405
# something is wrong, so lets determine what exactly
1406
if not self.has_filename(from_rel) and \
1407
not self.has_filename(to_rel):
1408
raise errors.BzrRenameFailedError(from_rel,to_rel,
1409
errors.PathsDoNotExist(paths=(str(from_rel),
1412
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1413
rename_entry.only_change_inv = only_change_inv
1414
return rename_entries
1416
def _move(self, rename_entries):
1417
"""Moves a list of files.
1419
Depending on the value of the flag 'only_change_inv', the
1420
file will be moved on the file system or not.
1422
inv = self.inventory
1425
for entry in rename_entries:
1427
self._move_entry(entry)
1429
self._rollback_move(moved)
1433
def _rollback_move(self, moved):
1434
"""Try to rollback a previous move in case of an filesystem error."""
1435
inv = self.inventory
1438
self._move_entry(WorkingTree._RenameEntry(
1439
entry.to_rel, entry.from_id,
1440
entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
entry.from_tail, entry.from_parent_id,
1442
entry.only_change_inv))
1443
except errors.BzrMoveFailedError, e:
1444
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1445
" The working tree is in an inconsistent state."
1446
" Please consider doing a 'bzr revert'."
1447
" Error message is: %s" % e)
1449
def _move_entry(self, entry):
1450
inv = self.inventory
1451
from_rel_abs = self.abspath(entry.from_rel)
1452
to_rel_abs = self.abspath(entry.to_rel)
1453
if from_rel_abs == to_rel_abs:
1454
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1455
"Source and target are identical.")
1457
if not entry.only_change_inv:
1459
osutils.rename(from_rel_abs, to_rel_abs)
1461
raise errors.BzrMoveFailedError(entry.from_rel,
1463
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1465
@needs_tree_write_lock
1466
def rename_one(self, from_rel, to_rel, after=False):
667
def rename_one(self, from_rel, to_rel):
1467
668
"""Rename one file.
1469
670
This can change the directory or the filename or both.
1471
rename_one has several 'modes' to work. First, it can rename a physical
1472
file and change the file_id. That is the normal mode. Second, it can
1473
only change the file_id without touching any physical file. This is
1474
the new mode introduced in version 0.15.
1476
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
versioned but present in the working tree.
1479
rename_one uses the second mode if 'after == False' and 'from_rel' is
1480
versioned but no longer in the working tree, and 'to_rel' is not
1481
versioned but present in the working tree.
1483
rename_one uses the first mode if 'after == False' and 'from_rel' is
1484
versioned and present in the working tree, and 'to_rel' is not
1485
versioned and not present in the working tree.
1487
Everything else results in an error.
1489
672
inv = self.inventory
1492
# create rename entries and tuples
1493
from_tail = splitpath(from_rel)[-1]
1494
from_id = inv.path2id(from_rel)
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
from_entry = inv[from_id]
1507
from_parent_id = from_entry.parent_id
673
if not self.has_filename(from_rel):
674
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
675
if self.has_filename(to_rel):
676
raise BzrError("can't rename: new working file %r already exists" % to_rel)
678
file_id = inv.path2id(from_rel)
680
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
683
from_parent = entry.parent_id
684
from_name = entry.name
686
if inv.path2id(to_rel):
687
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1508
689
to_dir, to_tail = os.path.split(to_rel)
1509
690
to_dir_id = inv.path2id(to_dir)
1510
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1512
from_tail=from_tail,
1513
from_parent_id=from_parent_id,
1514
to_rel=to_rel, to_tail=to_tail,
1515
to_parent_id=to_dir_id)
1516
rename_entries.append(rename_entry)
1518
# determine which move mode to use. checks also for movability
1519
rename_entries = self._determine_mv_mode(rename_entries, after)
1521
# check if the target changed directory and if the target directory is
1523
if to_dir_id is None:
1524
raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
errors.NotVersionedError(path=str(to_dir)))
1527
# all checks done. now we can continue with our actual work
1528
mutter('rename_one:\n'
1533
' to_dir_id {%s}\n',
1534
from_id, from_rel, to_rel, to_dir, to_dir_id)
1536
self._move(rename_entries)
691
if to_dir_id == None and to_dir != '':
692
raise BzrError("can't determine destination directory id for %r" % to_dir)
694
mutter("rename_one:")
695
mutter(" file_id {%s}" % file_id)
696
mutter(" from_rel %r" % from_rel)
697
mutter(" to_rel %r" % to_rel)
698
mutter(" to_dir %r" % to_dir)
699
mutter(" to_dir_id {%s}" % to_dir_id)
701
inv.rename(file_id, to_dir_id, to_tail)
703
from_abs = self.abspath(from_rel)
704
to_abs = self.abspath(to_rel)
706
rename(from_abs, to_abs)
708
inv.rename(file_id, from_parent, from_name)
709
raise BzrError("failed to rename %r to %r: %s"
710
% (from_abs, to_abs, e[1]),
711
["rename rolled back"])
1537
712
self._write_inventory(inv)
1539
class _RenameEntry(object):
1540
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1541
to_rel, to_tail, to_parent_id, only_change_inv=False):
1542
self.from_rel = from_rel
1543
self.from_id = from_id
1544
self.from_tail = from_tail
1545
self.from_parent_id = from_parent_id
1546
self.to_rel = to_rel
1547
self.to_tail = to_tail
1548
self.to_parent_id = to_parent_id
1549
self.only_change_inv = only_change_inv
1551
714
@needs_read_lock
1552
715
def unknowns(self):
1553
716
"""Return all unknown files.
1555
718
These are files in the working directory that are not versioned or
1556
719
control files or ignored.
1558
# force the extras method to be fully executed before returning, to
1559
# prevent race conditions with the lock
1561
[subp for subp in self.extras() if not self.is_ignored(subp)])
1563
@needs_tree_write_lock
1564
def unversion(self, file_ids):
1565
"""Remove the file ids in file_ids from the current versioned set.
1567
When a file_id is unversioned, all of its children are automatically
1570
:param file_ids: The file ids to stop versioning.
1571
:raises: NoSuchId if any fileid is not currently versioned.
1573
for file_id in file_ids:
1574
if file_id not in self._inventory:
1575
raise errors.NoSuchId(self, file_id)
1576
for file_id in file_ids:
1577
if self._inventory.has_id(file_id):
1578
self._inventory.remove_recursive_id(file_id)
1580
# in the future this should just set a dirty bit to wait for the
1581
# final unlock. However, until all methods of workingtree start
1582
# with the current in -memory inventory rather than triggering
1583
# a read, it is more complex - we need to teach read_inventory
1584
# to know when to read, and when to not read first... and possibly
1585
# to save first when the in memory one may be corrupted.
1586
# so for now, we just only write it if it is indeed dirty.
1588
self._write_inventory(self._inventory)
1590
def _iter_conflicts(self):
721
>>> from bzrlib.branch import ScratchBranch
722
>>> b = ScratchBranch(files=['foo', 'foo~'])
723
>>> tree = WorkingTree(b.base, b)
724
>>> map(str, tree.unknowns())
727
>>> list(b.unknowns())
729
>>> tree.remove('foo')
730
>>> list(b.unknowns())
733
for subp in self.extras():
734
if not self.is_ignored(subp):
737
def iter_conflicts(self):
1591
738
conflicted = set()
1592
for info in self.list_files():
739
for path in (s[0] for s in self.list_files()):
1594
740
stem = get_conflicted_stem(path)
1595
741
if stem is None:
1677
788
for subf in os.listdir(dirabs):
1678
if self.bzrdir.is_control_filename(subf):
1680
if subf not in dir_entry.children:
1683
can_access) = osutils.normalized_filename(subf)
1684
except UnicodeDecodeError:
1685
path_os_enc = path.encode(osutils._fs_enc)
1686
relpath = path_os_enc + '/' + subf
1687
raise errors.BadFilenameEncoding(relpath,
1689
if subf_norm != subf and can_access:
1690
if subf_norm not in dir_entry.children:
1691
fl.append(subf_norm)
790
and (subf not in dir_entry.children)):
1697
subp = pathjoin(path, subf)
795
subp = appendpath(path, subf)
1700
799
def ignored_files(self):
1701
800
"""Yield list of PATH, IGNORE_PATTERN"""
1702
801
for subp in self.extras():
1703
802
pat = self.is_ignored(subp)
1707
807
def get_ignore_list(self):
1708
808
"""Return list of ignore patterns.
1710
810
Cached in the Tree object after the first call.
1712
ignoreset = getattr(self, '_ignoreset', None)
1713
if ignoreset is not None:
812
if hasattr(self, '_ignorelist'):
813
return self._ignorelist
1716
ignore_globs = set()
1717
ignore_globs.update(ignores.get_runtime_ignores())
1718
ignore_globs.update(ignores.get_user_ignores())
815
l = bzrlib.DEFAULT_IGNORE[:]
1719
816
if self.has_filename(bzrlib.IGNORE_FILENAME):
1720
817
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1722
ignore_globs.update(ignores.parse_ignore_file(f))
1725
self._ignoreset = ignore_globs
818
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1728
def _flush_ignore_list_cache(self):
1729
"""Resets the cached ignore list to force a cache rebuild."""
1730
self._ignoreset = None
1731
self._ignoreglobster = None
1733
823
def is_ignored(self, filename):
1734
824
r"""Check whether the filename matches an ignore pattern.
1736
826
Patterns containing '/' or '\' need to match the whole path;
1737
others match against only the last component. Patterns starting
1738
with '!' are ignore exceptions. Exceptions take precedence
1739
over regular patterns and cause the filename to not be ignored.
827
others match against only the last component.
1741
829
If the file is ignored, returns the pattern which caused it to
1742
830
be ignored, otherwise None. So this can simply be used as a
1743
831
boolean if desired."""
1744
if getattr(self, '_ignoreglobster', None) is None:
1745
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1746
return self._ignoreglobster.match(filename)
833
# TODO: Use '**' to match directories, and other extended
834
# globbing stuff from cvs/rsync.
836
# XXX: fnmatch is actually not quite what we want: it's only
837
# approximately the same as real Unix fnmatch, and doesn't
838
# treat dotfiles correctly and allows * to match /.
839
# Eventually it should be replaced with something more
842
for pat in self.get_ignore_list():
843
if '/' in pat or '\\' in pat:
845
# as a special case, you can put ./ at the start of a
846
# pattern; this is good to match in the top-level
849
if (pat[:2] == './') or (pat[:2] == '.\\'):
853
if fnmatch.fnmatchcase(filename, newpat):
856
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1748
861
def kind(self, file_id):
1749
862
return file_kind(self.id2abspath(file_id))
1751
def stored_kind(self, file_id):
1752
"""See Tree.stored_kind"""
1753
return self.inventory[file_id].kind
1755
def _comparison_data(self, entry, path):
1756
abspath = self.abspath(path)
1758
stat_value = os.lstat(abspath)
1760
if getattr(e, 'errno', None) == errno.ENOENT:
1767
mode = stat_value.st_mode
1768
kind = osutils.file_kind_from_stat_mode(mode)
1769
if not supports_executable():
1770
executable = entry is not None and entry.executable
1772
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1773
return kind, executable, stat_value
1775
def _file_size(self, entry, stat_value):
1776
return stat_value.st_size
1778
def last_revision(self):
1779
"""Return the last revision of the branch for this tree.
1781
This format tree does not support a separate marker for last-revision
1782
compared to the branch.
1784
See MutableTree.last_revision
1786
return self._last_revision()
1789
def _last_revision(self):
1790
"""helper for get_parent_ids."""
1791
return _mod_revision.ensure_null(self.branch.last_revision())
1793
def is_locked(self):
1794
return self._control_files.is_locked()
1796
def _must_be_locked(self):
1797
if not self.is_locked():
1798
raise errors.ObjectNotLocked(self)
1800
864
def lock_read(self):
1801
"""Lock the tree for reading.
1803
This also locks the branch, and can be unlocked via self.unlock().
1805
:return: An object with an unlock method which will release the lock
1808
if not self.is_locked():
1810
self.branch.lock_read()
1812
self._control_files.lock_read()
1815
self.branch.unlock()
1818
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: An object with an unlock method which will release the lock
1824
if not self.is_locked():
1826
self.branch.lock_read()
1828
self._control_files.lock_write()
1831
self.branch.unlock()
865
"""See Branch.lock_read, and WorkingTree.unlock."""
866
return self.branch.lock_read()
1834
868
def lock_write(self):
1835
"""See MutableTree.lock_write, and WorkingTree.unlock.
1837
:return: An object with an unlock method which will release the lock
1840
if not self.is_locked():
1842
self.branch.lock_write()
1844
self._control_files.lock_write()
1847
self.branch.unlock()
1850
def get_physical_lock_status(self):
1851
return self._control_files.get_physical_lock_status()
1853
def _basis_inventory_name(self):
1854
return 'basis-inventory-cache'
1856
def _reset_data(self):
1857
"""Reset transient data that cannot be revalidated."""
1858
self._inventory_is_modified = False
1859
f = self._transport.get('inventory')
1861
result = self._deserialize(f)
1864
self._set_inventory(result, dirty=False)
1866
@needs_tree_write_lock
1867
def set_last_revision(self, new_revision):
1868
"""Change the last revision in the working tree."""
1869
if self._change_last_revision(new_revision):
1870
self._cache_basis_inventory(new_revision)
1872
def _change_last_revision(self, new_revision):
1873
"""Template method part of set_last_revision to perform the change.
1875
This is used to allow WorkingTree3 instances to not affect branch
1876
when their last revision is set.
1878
if _mod_revision.is_null(new_revision):
1879
self.branch.set_revision_history([])
1882
self.branch.generate_revision_history(new_revision)
1883
except errors.NoSuchRevision:
1884
# not present in the repo - dont try to set it deeper than the tip
1885
self.branch.set_revision_history([new_revision])
1888
def _write_basis_inventory(self, xml):
1889
"""Write the basis inventory XML to the basis-inventory file"""
1890
path = self._basis_inventory_name()
1892
self._transport.put_file(path, sio,
1893
mode=self.bzrdir._get_file_mode())
1895
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1896
"""Create the text that will be saved in basis-inventory"""
1897
inventory.revision_id = revision_id
1898
return xml7.serializer_v7.write_inventory_to_string(inventory)
1900
def _cache_basis_inventory(self, new_revision):
1901
"""Cache new_revision as the basis inventory."""
1902
# TODO: this should allow the ready-to-use inventory to be passed in,
1903
# as commit already has that ready-to-use [while the format is the
1906
# this double handles the inventory - unpack and repack -
1907
# but is easier to understand. We can/should put a conditional
1908
# in here based on whether the inventory is in the latest format
1909
# - perhaps we should repack all inventories on a repository
1911
# the fast path is to copy the raw xml from the repository. If the
1912
# xml contains 'revision_id="', then we assume the right
1913
# revision_id is set. We must check for this full string, because a
1914
# root node id can legitimately look like 'revision_id' but cannot
1916
xml = self.branch.repository._get_inventory_xml(new_revision)
1917
firstline = xml.split('\n', 1)[0]
1918
if (not 'revision_id="' in firstline or
1919
'format="7"' not in firstline):
1920
inv = self.branch.repository._serializer.read_inventory_from_string(
1922
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
self._write_basis_inventory(xml)
1924
except (errors.NoSuchRevision, errors.RevisionNotPresent):
869
"""See Branch.lock_write, and WorkingTree.unlock."""
870
return self.branch.lock_write()
872
def _basis_inventory_name(self, revision_id):
873
return 'basis-inventory.%s' % revision_id
875
def set_last_revision(self, new_revision, old_revision=None):
876
if old_revision is not None:
878
path = self._basis_inventory_name(old_revision)
879
path = self.branch.control_files._escape(path)
880
self.branch.control_files._transport.delete(path)
884
xml = self.branch.repository.get_inventory_xml(new_revision)
885
path = self._basis_inventory_name(new_revision)
886
self.branch.control_files.put_utf8(path, xml)
887
except WeaveRevisionNotPresent:
1927
def read_basis_inventory(self):
890
def read_basis_inventory(self, revision_id):
1928
891
"""Read the cached basis inventory."""
1929
path = self._basis_inventory_name()
1930
return self._transport.get_bytes(path)
892
path = self._basis_inventory_name(revision_id)
893
return self.branch.control_files.get_utf8(path).read()
1932
895
@needs_read_lock
1933
896
def read_working_inventory(self):
1934
"""Read the working inventory.
1936
:raises errors.InventoryModified: read_working_inventory will fail
1937
when the current in memory inventory has been modified.
1939
# conceptually this should be an implementation detail of the tree.
1940
# XXX: Deprecate this.
897
"""Read the working inventory."""
1941
898
# ElementTree does its own conversion from UTF-8, so open in
1943
if self._inventory_is_modified:
1944
raise errors.InventoryModified(self)
1945
f = self._transport.get('inventory')
1947
result = self._deserialize(f)
1950
self._set_inventory(result, dirty=False)
1953
@needs_tree_write_lock
1954
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1956
"""Remove nominated files from the working inventory.
1958
:files: File paths relative to the basedir.
1959
:keep_files: If true, the files will also be kept.
1960
:force: Delete files and directories, even if they are changed and
1961
even if the directories are not empty.
900
return bzrlib.xml5.serializer_v5.read_inventory(
901
self._control_files.get('inventory'))
904
def remove(self, files, verbose=False):
905
"""Remove nominated files from the working inventory..
907
This does not remove their text. This does not run on XXX on what? RBC
909
TODO: Refuse to remove modified files unless --force is given?
911
TODO: Do something useful with directories.
913
TODO: Should this remove the text or not? Tough call; not
914
removing may be useful and the user can just use use rm, and
915
is the opposite of add. Removing it is consistent with most
916
other tools. Maybe an option.
918
## TODO: Normalize names
919
## TODO: Remove nested loops; better scalability
1963
920
if isinstance(files, basestring):
1969
unknown_nested_files=set()
1971
to_file = sys.stdout
1973
def recurse_directory_to_add_files(directory):
1974
# Recurse directory and add all files
1975
# so we can check if they have changed.
1976
for parent_info, file_infos in\
1977
self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1979
# Is it versioned or ignored?
1980
if self.path2id(relpath) or self.is_ignored(relpath):
1981
# Add nested content for deletion.
1982
new_files.add(relpath)
1984
# Files which are not versioned and not ignored
1985
# should be treated as unknown.
1986
unknown_nested_files.add((relpath, None, kind))
1988
for filename in files:
1989
# Get file name into canonical form.
1990
abspath = self.abspath(filename)
1991
filename = self.relpath(abspath)
1992
if len(filename) > 0:
1993
new_files.add(filename)
1994
recurse_directory_to_add_files(filename)
1996
files = list(new_files)
1999
return # nothing to do
2001
# Sort needed to first handle directory content before the directory
2002
files.sort(reverse=True)
2004
# Bail out if we are going to delete files we shouldn't
2005
if not keep_files and not force:
2006
has_changed_files = len(unknown_nested_files) > 0
2007
if not has_changed_files:
2008
for (file_id, path, content_change, versioned, parent_id, name,
2009
kind, executable) in self.iter_changes(self.basis_tree(),
2010
include_unchanged=True, require_versioned=False,
2011
want_unversioned=True, specific_files=files):
2012
if versioned == (False, False):
2013
# The record is unknown ...
2014
if not self.is_ignored(path[1]):
2015
# ... but not ignored
2016
has_changed_files = True
2018
elif content_change and (kind[1] is not None):
2019
# Versioned and changed, but not deleted
2020
has_changed_files = True
2023
if has_changed_files:
2024
# Make delta show ALL applicable changes in error message.
2025
tree_delta = self.changes_from(self.basis_tree(),
2026
require_versioned=False, want_unversioned=True,
2027
specific_files=files)
2028
for unknown_file in unknown_nested_files:
2029
if unknown_file not in tree_delta.unversioned:
2030
tree_delta.unversioned.extend((unknown_file,))
2031
raise errors.BzrRemoveChangedFilesError(tree_delta)
2033
# Build inv_delta and delete files where applicable,
2034
# do this before any modifications to inventory.
925
# do this before any modifications
2036
fid = self.path2id(f)
2039
message = "%s is not versioned." % (f,)
2042
# having removed it, it must be either ignored or unknown
2043
if self.is_ignored(f):
2047
# XXX: Really should be a more abstract reporter interface
2048
kind_ch = osutils.kind_marker(self.kind(fid))
2049
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2051
inv_delta.append((f, None, fid, None))
2052
message = "removed %s" % (f,)
2055
abs_path = self.abspath(f)
2056
if osutils.lexists(abs_path):
2057
if (osutils.isdir(abs_path) and
2058
len(os.listdir(abs_path)) > 0):
2060
osutils.rmtree(abs_path)
2062
message = "%s is not an empty directory "\
2063
"and won't be deleted." % (f,)
2065
osutils.delete_any(abs_path)
2066
message = "deleted %s" % (f,)
2067
elif message is not None:
2068
# Only care if we haven't done anything yet.
2069
message = "%s does not exist." % (f,)
2071
# Print only one message (if any) per file.
2072
if message is not None:
2074
self.apply_inventory_delta(inv_delta)
2076
@needs_tree_write_lock
2077
def revert(self, filenames=None, old_tree=None, backups=True,
2078
pb=None, report_changes=False):
2079
from bzrlib.conflicts import resolve
2082
symbol_versioning.warn('Using [] to revert all files is deprecated'
2083
' as of bzr 0.91. Please use None (the default) instead.',
2084
DeprecationWarning, stacklevel=2)
929
# TODO: Perhaps make this just a warning, and continue?
930
# This tends to happen when
931
raise NotVersionedError(path=f)
932
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
934
# having remove it, it must be either ignored or unknown
935
if self.is_ignored(f):
939
show_status(new_status, inv[fid].kind, quotefn(f))
942
self._write_inventory(inv)
945
def revert(self, filenames, old_tree=None, backups=True):
946
from bzrlib.merge import merge_inner
2085
947
if old_tree is None:
2086
basis_tree = self.basis_tree()
2087
basis_tree.lock_read()
2088
old_tree = basis_tree
2092
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2094
if filenames is None and len(self.get_parent_ids()) > 1:
2096
last_revision = self.last_revision()
2097
if last_revision != _mod_revision.NULL_REVISION:
2098
if basis_tree is None:
2099
basis_tree = self.basis_tree()
2100
basis_tree.lock_read()
2101
parent_trees.append((last_revision, basis_tree))
2102
self.set_parent_trees(parent_trees)
2105
resolve(self, filenames, ignore_misses=True, recursive=True)
2107
if basis_tree is not None:
2111
def revision_tree(self, revision_id):
2112
"""See Tree.revision_tree.
2114
WorkingTree can supply revision_trees for the basis revision only
2115
because there is only one cached inventory in the bzr directory.
2117
if revision_id == self.last_revision():
2119
xml = self.read_basis_inventory()
2120
except errors.NoSuchFile:
2124
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2125
# dont use the repository revision_tree api because we want
2126
# to supply the inventory.
2127
if inv.revision_id == revision_id:
2128
return revisiontree.RevisionTree(self.branch.repository,
2130
except errors.BadInventoryFormat:
2132
# raise if there was no inventory, or if we read the wrong inventory.
2133
raise errors.NoSuchRevisionInTree(self, revision_id)
2135
# XXX: This method should be deprecated in favour of taking in a proper
2136
# new Inventory object.
2137
@needs_tree_write_lock
948
old_tree = self.branch.basis_tree()
949
merge_inner(self.branch, old_tree,
950
self, ignore_zero=True,
951
backup_files=backups,
952
interesting_files=filenames,
954
if not len(filenames):
955
self.set_pending_merges([])
2138
958
def set_inventory(self, new_inventory_list):
2139
959
from bzrlib.inventory import (Inventory,
2140
960
InventoryDirectory,
2143
964
inv = Inventory(self.get_root_id())
2153
974
elif kind == 'symlink':
2154
975
inv.add(InventoryLink(file_id, name, parent))
2156
raise errors.BzrError("unknown kind %r" % kind)
977
raise BzrError("unknown kind %r" % kind)
2157
978
self._write_inventory(inv)
2159
@needs_tree_write_lock
2160
981
def set_root_id(self, file_id):
2161
982
"""Set the root id for this tree."""
2165
'WorkingTree.set_root_id with fileid=None')
2166
file_id = osutils.safe_file_id(file_id)
2167
self._set_root_id(file_id)
2169
def _set_root_id(self, file_id):
2170
"""Set the root id for this tree, in a format specific manner.
2172
:param file_id: The file id to assign to the root. It must not be
2173
present in the current inventory or an error will occur. It must
2174
not be None, but rather a valid file id.
2176
inv = self._inventory
983
inv = self.read_working_inventory()
2177
984
orig_root_id = inv.root.file_id
2178
# TODO: it might be nice to exit early if there was nothing
2179
# to do, saving us from trigger a sync on unlock.
2180
self._inventory_is_modified = True
2181
# we preserve the root inventory entry object, but
2182
# unlinkit from the byid index
2183
985
del inv._byid[inv.root.file_id]
2184
986
inv.root.file_id = file_id
2185
# and link it into the index with the new changed id.
2186
987
inv._byid[inv.root.file_id] = inv.root
2187
# and finally update all children to reference the new id.
2188
# XXX: this should be safe to just look at the root.children
2189
# list, not the WHOLE INVENTORY.
2191
989
entry = inv[fid]
2192
if entry.parent_id == orig_root_id:
990
if entry.parent_id in (None, orig_root_id):
2193
991
entry.parent_id = inv.root.file_id
992
self._write_inventory(inv)
2195
994
def unlock(self):
2196
995
"""See Branch.unlock.
2198
997
WorkingTree locking just uses the Branch locking facilities.
2199
998
This is current because all working trees have an embedded branch
2200
999
within them. IF in the future, we were to make branch data shareable
2201
between multiple working trees, i.e. via shared storage, then we
1000
between multiple working trees, i.e. via shared storage, then we
2202
1001
would probably want to lock both the local tree, and the branch.
2204
raise NotImplementedError(self.unlock)
2208
def update(self, change_reporter=None, possible_transports=None,
2209
revision=None, old_tip=_marker):
2210
"""Update a working tree along its branch.
2212
This will update the branch if its bound too, which means we have
2213
multiple trees involved:
2215
- The new basis tree of the master.
2216
- The old basis tree of the branch.
2217
- The old basis tree of the working tree.
2218
- The current working tree state.
2220
Pathologically, all three may be different, and non-ancestors of each
2221
other. Conceptually we want to:
2223
- Preserve the wt.basis->wt.state changes
2224
- Transform the wt.basis to the new master basis.
2225
- Apply a merge of the old branch basis to get any 'local' changes from
2227
- Restore the wt.basis->wt.state changes.
2229
There isn't a single operation at the moment to do that, so we:
2230
- Merge current state -> basis tree of the master w.r.t. the old tree
2232
- Do a 'normal' merge of the old branch basis if it is relevant.
2234
:param revision: The target revision to update to. Must be in the
2236
:param old_tip: If branch.update() has already been run, the value it
2237
returned (old tip of the branch or None). _marker is used
2240
if self.branch.get_bound_location() is not None:
2242
update_branch = (old_tip is self._marker)
2244
self.lock_tree_write()
2245
update_branch = False
2248
old_tip = self.branch.update(possible_transports)
2250
if old_tip is self._marker:
2252
return self._update_tree(old_tip, change_reporter, revision)
2256
@needs_tree_write_lock
2257
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2258
"""Update a tree to the master branch.
2260
:param old_tip: if supplied, the previous tip revision the branch,
2261
before it was changed to the master branch's tip.
2263
# here if old_tip is not None, it is the old tip of the branch before
2264
# it was updated from the master branch. This should become a pending
2265
# merge in the working tree to preserve the user existing work. we
2266
# cant set that until we update the working trees last revision to be
2267
# one from the new branch, because it will just get absorbed by the
2268
# parent de-duplication logic.
2270
# We MUST save it even if an error occurs, because otherwise the users
2271
# local work is unreferenced and will appear to have been lost.
2275
last_rev = self.get_parent_ids()[0]
2277
last_rev = _mod_revision.NULL_REVISION
2278
if revision is None:
2279
revision = self.branch.last_revision()
2281
old_tip = old_tip or _mod_revision.NULL_REVISION
2283
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
# the branch we are bound to was updated
2285
# merge those changes in first
2286
base_tree = self.basis_tree()
2287
other_tree = self.branch.repository.revision_tree(old_tip)
2288
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
base_tree, this_tree=self,
2290
change_reporter=change_reporter)
2292
self.add_parent_tree((old_tip, other_tree))
2293
trace.note('Rerun update after fixing the conflicts.')
2296
if last_rev != _mod_revision.ensure_null(revision):
2297
# the working tree is up to date with the branch
2298
# we can merge the specified revision from master
2299
to_tree = self.branch.repository.revision_tree(revision)
2300
to_root_id = to_tree.get_root_id()
2302
basis = self.basis_tree()
2305
if (basis.inventory.root is None
2306
or basis.inventory.root.file_id != to_root_id):
2307
self.set_root_id(to_root_id)
2312
# determine the branch point
2313
graph = self.branch.repository.get_graph()
2314
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2316
base_tree = self.branch.repository.revision_tree(base_rev_id)
2318
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2320
change_reporter=change_reporter)
2321
self.set_last_revision(revision)
2322
# TODO - dedup parents list with things merged by pull ?
2323
# reuse the tree we've updated to to set the basis:
2324
parent_trees = [(revision, to_tree)]
2325
merges = self.get_parent_ids()[1:]
2326
# Ideally we ask the tree for the trees here, that way the working
2327
# tree can decide whether to give us the entire tree or give us a
2328
# lazy initialised tree. dirstate for instance will have the trees
2329
# in ram already, whereas a last-revision + basis-inventory tree
2330
# will not, but also does not need them when setting parents.
2331
for parent in merges:
2332
parent_trees.append(
2333
(parent, self.branch.repository.revision_tree(parent)))
2334
if not _mod_revision.is_null(old_tip):
2335
parent_trees.append(
2336
(old_tip, self.branch.repository.revision_tree(old_tip)))
2337
self.set_parent_trees(parent_trees)
2338
last_rev = parent_trees[0][0]
2341
def _write_hashcache_if_dirty(self):
2342
"""Write out the hashcache if it is dirty."""
2343
if self._hashcache.needs_write:
2345
self._hashcache.write()
2347
if e.errno not in (errno.EPERM, errno.EACCES):
2349
# TODO: jam 20061219 Should this be a warning? A single line
2350
# warning might be sufficient to let the user know what
2352
mutter('Could not write hashcache for %s\nError: %s',
2353
self._hashcache.cache_file_name(), e)
2355
@needs_tree_write_lock
1003
# FIXME: We want to write out the hashcache only when the last lock on
1004
# this working copy is released. Peeking at the lock count is a bit
1005
# of a nasty hack; probably it's better to have a transaction object,
1006
# which can do some finalization when it's either successfully or
1007
# unsuccessfully completed. (Denys's original patch did that.)
1008
if self._hashcache.needs_write and self.branch.control_files._lock_count==1:
1009
self._hashcache.write()
1010
return self.branch.unlock()
2356
1013
def _write_inventory(self, inv):
2357
1014
"""Write inventory as the current inventory."""
2358
self._set_inventory(inv, dirty=True)
2361
def set_conflicts(self, arg):
2362
raise errors.UnsupportedOperation(self.set_conflicts, self)
2364
def add_conflicts(self, arg):
2365
raise errors.UnsupportedOperation(self.add_conflicts, self)
2368
def conflicts(self):
2369
conflicts = _mod_conflicts.ConflictList()
2370
for conflicted in self._iter_conflicts():
2373
if file_kind(self.abspath(conflicted)) != "file":
2375
except errors.NoSuchFile:
2378
for suffix in ('.THIS', '.OTHER'):
2380
kind = file_kind(self.abspath(conflicted+suffix))
2383
except errors.NoSuchFile:
2387
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2388
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2390
file_id=self.path2id(conflicted)))
2393
def walkdirs(self, prefix=""):
2394
"""Walk the directories of this tree.
2396
returns a generator which yields items in the form:
2397
((curren_directory_path, fileid),
2398
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2401
This API returns a generator, which is only valid during the current
2402
tree transaction - within a single lock_read or lock_write duration.
2404
If the tree is not locked, it may cause an error to be raised,
2405
depending on the tree implementation.
2407
disk_top = self.abspath(prefix)
2408
if disk_top.endswith('/'):
2409
disk_top = disk_top[:-1]
2410
top_strip_len = len(disk_top) + 1
2411
inventory_iterator = self._walkdirs(prefix)
2412
disk_iterator = osutils.walkdirs(disk_top, prefix)
2414
current_disk = disk_iterator.next()
2415
disk_finished = False
2417
if not (e.errno == errno.ENOENT or
2418
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2421
disk_finished = True
2423
current_inv = inventory_iterator.next()
2424
inv_finished = False
2425
except StopIteration:
2428
while not inv_finished or not disk_finished:
2430
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2431
cur_disk_dir_content) = current_disk
2433
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2434
cur_disk_dir_content) = ((None, None), None)
2435
if not disk_finished:
2436
# strip out .bzr dirs
2437
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2438
len(cur_disk_dir_content) > 0):
2439
# osutils.walkdirs can be made nicer -
2440
# yield the path-from-prefix rather than the pathjoined
2442
bzrdir_loc = bisect_left(cur_disk_dir_content,
2444
if (bzrdir_loc < len(cur_disk_dir_content)
2445
and self.bzrdir.is_control_filename(
2446
cur_disk_dir_content[bzrdir_loc][0])):
2447
# we dont yield the contents of, or, .bzr itself.
2448
del cur_disk_dir_content[bzrdir_loc]
2450
# everything is unknown
2453
# everything is missing
2456
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2458
# disk is before inventory - unknown
2459
dirblock = [(relpath, basename, kind, stat, None, None) for
2460
relpath, basename, kind, stat, top_path in
2461
cur_disk_dir_content]
2462
yield (cur_disk_dir_relpath, None), dirblock
2464
current_disk = disk_iterator.next()
2465
except StopIteration:
2466
disk_finished = True
2468
# inventory is before disk - missing.
2469
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2470
for relpath, basename, dkind, stat, fileid, kind in
2472
yield (current_inv[0][0], current_inv[0][1]), dirblock
2474
current_inv = inventory_iterator.next()
2475
except StopIteration:
2478
# versioned present directory
2479
# merge the inventory and disk data together
2481
for relpath, subiterator in itertools.groupby(sorted(
2482
current_inv[1] + cur_disk_dir_content,
2483
key=operator.itemgetter(0)), operator.itemgetter(1)):
2484
path_elements = list(subiterator)
2485
if len(path_elements) == 2:
2486
inv_row, disk_row = path_elements
2487
# versioned, present file
2488
dirblock.append((inv_row[0],
2489
inv_row[1], disk_row[2],
2490
disk_row[3], inv_row[4],
2492
elif len(path_elements[0]) == 5:
2494
dirblock.append((path_elements[0][0],
2495
path_elements[0][1], path_elements[0][2],
2496
path_elements[0][3], None, None))
2497
elif len(path_elements[0]) == 6:
2498
# versioned, absent file.
2499
dirblock.append((path_elements[0][0],
2500
path_elements[0][1], 'unknown', None,
2501
path_elements[0][4], path_elements[0][5]))
2503
raise NotImplementedError('unreachable code')
2504
yield current_inv[0], dirblock
2506
current_inv = inventory_iterator.next()
2507
except StopIteration:
2510
current_disk = disk_iterator.next()
2511
except StopIteration:
2512
disk_finished = True
2514
def _walkdirs(self, prefix=""):
2515
"""Walk the directories of this tree.
2517
:prefix: is used as the directrory to start with.
2518
returns a generator which yields items in the form:
2519
((curren_directory_path, fileid),
2520
[(file1_path, file1_name, file1_kind, None, file1_id,
2523
_directory = 'directory'
2524
# get the root in the inventory
2525
inv = self.inventory
2526
top_id = inv.path2id(prefix)
2530
pending = [(prefix, '', _directory, None, top_id, None)]
2533
currentdir = pending.pop()
2534
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2535
top_id = currentdir[4]
2537
relroot = currentdir[0] + '/'
2540
# FIXME: stash the node in pending
2542
if entry.kind == 'directory':
2543
for name, child in entry.sorted_children():
2544
dirblock.append((relroot + name, name, child.kind, None,
2545
child.file_id, child.kind
2547
yield (currentdir[0], entry.file_id), dirblock
2548
# push the user specified dirs from dirblock
2549
for dir in reversed(dirblock):
2550
if dir[2] == _directory:
2553
@needs_tree_write_lock
2554
def auto_resolve(self):
2555
"""Automatically resolve text conflicts according to contents.
2557
Only text conflicts are auto_resolvable. Files with no conflict markers
2558
are considered 'resolved', because bzr always puts conflict markers
2559
into files that have text conflicts. The corresponding .THIS .BASE and
2560
.OTHER files are deleted, as per 'resolve'.
2561
:return: a tuple of ConflictLists: (un_resolved, resolved).
2563
un_resolved = _mod_conflicts.ConflictList()
2564
resolved = _mod_conflicts.ConflictList()
2565
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2566
for conflict in self.conflicts():
2567
if (conflict.typestring != 'text conflict' or
2568
self.kind(conflict.file_id) != 'file'):
2569
un_resolved.append(conflict)
2571
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2573
for line in my_file:
2574
if conflict_re.search(line):
2575
un_resolved.append(conflict)
2578
resolved.append(conflict)
2581
resolved.remove_files(self)
2582
self.set_conflicts(un_resolved)
2583
return un_resolved, resolved
2586
def _check(self, references):
2587
"""Check the tree for consistency.
2589
:param references: A dict with keys matching the items returned by
2590
self._get_check_refs(), and values from looking those keys up in
2593
tree_basis = self.basis_tree()
2594
tree_basis.lock_read()
2596
repo_basis = references[('trees', self.last_revision())]
2597
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2598
raise errors.BzrCheckError(
2599
"Mismatched basis inventory content.")
2604
def _validate(self):
2605
"""Validate internal structures.
2607
This is meant mostly for the test suite. To give it a chance to detect
2608
corruption after actions have occurred. The default implementation is a
2611
:return: None. An exception should be raised if there is an error.
2615
def _get_rules_searcher(self, default_searcher):
2616
"""See Tree._get_rules_searcher."""
2617
if self._rules_searcher is None:
2618
self._rules_searcher = super(WorkingTree,
2619
self)._get_rules_searcher(default_searcher)
2620
return self._rules_searcher
2622
def get_shelf_manager(self):
2623
"""Return the ShelfManager for this WorkingTree."""
2624
from bzrlib.shelf import ShelfManager
2625
return ShelfManager(self, self._transport)
2628
class WorkingTree2(WorkingTree):
2629
"""This is the Format 2 working tree.
2631
This was the first weave based working tree.
2632
- uses os locks for locking.
2633
- uses the branch last-revision.
2636
def __init__(self, *args, **kwargs):
2637
super(WorkingTree2, self).__init__(*args, **kwargs)
2638
# WorkingTree2 has more of a constraint that self._inventory must
2639
# exist. Because this is an older format, we don't mind the overhead
2640
# caused by the extra computation here.
2642
# Newer WorkingTree's should only have self._inventory set when they
2644
if self._inventory is None:
2645
self.read_working_inventory()
2647
def _get_check_refs(self):
2648
"""Return the references needed to perform a check of this tree."""
2649
return [('trees', self.last_revision())]
2651
def lock_tree_write(self):
2652
"""See WorkingTree.lock_tree_write().
2654
In Format2 WorkingTrees we have a single lock for the branch and tree
2655
so lock_tree_write() degrades to lock_write().
2657
:return: An object with an unlock method which will release the lock
2660
self.branch.lock_write()
2662
self._control_files.lock_write()
2665
self.branch.unlock()
2669
# do non-implementation specific cleanup
2672
# we share control files:
2673
if self._control_files._lock_count == 3:
2674
# _inventory_is_modified is always False during a read lock.
2675
if self._inventory_is_modified:
2677
self._write_hashcache_if_dirty()
2679
# reverse order of locking.
2681
return self._control_files.unlock()
2683
self.branch.unlock()
2686
class WorkingTree3(WorkingTree):
2687
"""This is the Format 3 working tree.
2689
This differs from the base WorkingTree by:
2690
- having its own file lock
2691
- having its own last-revision property.
2693
This is new in bzr 0.8
2697
def _last_revision(self):
2698
"""See Mutable.last_revision."""
2700
return self._transport.get_bytes('last-revision')
2701
except errors.NoSuchFile:
2702
return _mod_revision.NULL_REVISION
2704
def _change_last_revision(self, revision_id):
2705
"""See WorkingTree._change_last_revision."""
2706
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2708
self._transport.delete('last-revision')
2709
except errors.NoSuchFile:
2713
self._transport.put_bytes('last-revision', revision_id,
2714
mode=self.bzrdir._get_file_mode())
2717
def _get_check_refs(self):
2718
"""Return the references needed to perform a check of this tree."""
2719
return [('trees', self.last_revision())]
2721
@needs_tree_write_lock
2722
def set_conflicts(self, conflicts):
2723
self._put_rio('conflicts', conflicts.to_stanzas(),
2726
@needs_tree_write_lock
2727
def add_conflicts(self, new_conflicts):
2728
conflict_set = set(self.conflicts())
2729
conflict_set.update(set(list(new_conflicts)))
2730
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2731
key=_mod_conflicts.Conflict.sort_key)))
2734
def conflicts(self):
2736
confile = self._transport.get('conflicts')
2737
except errors.NoSuchFile:
2738
return _mod_conflicts.ConflictList()
2741
if confile.next() != CONFLICT_HEADER_1 + '\n':
2742
raise errors.ConflictFormatError()
2743
except StopIteration:
2744
raise errors.ConflictFormatError()
2745
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2750
# do non-implementation specific cleanup
2752
if self._control_files._lock_count == 1:
2753
# _inventory_is_modified is always False during a read lock.
2754
if self._inventory_is_modified:
2756
self._write_hashcache_if_dirty()
2757
# reverse order of locking.
2759
return self._control_files.unlock()
2761
self.branch.unlock()
1016
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1018
self._control_files.put('inventory', sio)
1019
self._set_inventory(inv)
1020
mutter('wrote working inventory')
1023
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
2764
1024
def get_conflicted_stem(path):
2765
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1025
for suffix in CONFLICT_SUFFIXES:
2766
1026
if path.endswith(suffix):
2767
1027
return path[:-len(suffix)]
2770
class WorkingTreeFormat(object):
2771
"""An encapsulation of the initialization and open routines for a format.
2773
Formats provide three things:
2774
* An initialization routine,
2778
Formats are placed in an dict by their format string for reference
2779
during workingtree opening. Its not required that these be instances, they
2780
can be classes themselves with class methods - it simply depends on
2781
whether state is needed for a given format or not.
2783
Once a format is deprecated, just deprecate the initialize and open
2784
methods on the format class. Do not deprecate the object, as the
2785
object will be created every time regardless.
2788
_default_format = None
2789
"""The default format used for new trees."""
2792
"""The known formats."""
2794
requires_rich_root = False
2796
upgrade_recommended = False
2799
def find_format(klass, a_bzrdir):
2800
"""Return the format for the working tree object in a_bzrdir."""
2802
transport = a_bzrdir.get_workingtree_transport(None)
2803
format_string = transport.get_bytes("format")
2804
return klass._formats[format_string]
2805
except errors.NoSuchFile:
2806
raise errors.NoWorkingTree(base=transport.base)
2808
raise errors.UnknownFormatError(format=format_string,
2809
kind="working tree")
2811
def __eq__(self, other):
2812
return self.__class__ is other.__class__
2814
def __ne__(self, other):
2815
return not (self == other)
2818
def get_default_format(klass):
2819
"""Return the current default format."""
2820
return klass._default_format
2822
def get_format_string(self):
2823
"""Return the ASCII format string that identifies this format."""
2824
raise NotImplementedError(self.get_format_string)
2826
def get_format_description(self):
2827
"""Return the short description for this format."""
2828
raise NotImplementedError(self.get_format_description)
2830
def is_supported(self):
2831
"""Is this format supported?
2833
Supported formats can be initialized and opened.
2834
Unsupported formats may not support initialization or committing or
2835
some other features depending on the reason for not being supported.
2839
def supports_content_filtering(self):
2840
"""True if this format supports content filtering."""
2843
def supports_views(self):
2844
"""True if this format supports stored views."""
2848
def register_format(klass, format):
2849
klass._formats[format.get_format_string()] = format
2852
def set_default_format(klass, format):
2853
klass._default_format = format
2856
def unregister_format(klass, format):
2857
del klass._formats[format.get_format_string()]
2860
class WorkingTreeFormat2(WorkingTreeFormat):
2861
"""The second working tree format.
2863
This format modified the hash cache from the format 1 hash cache.
2866
upgrade_recommended = True
2868
def get_format_description(self):
2869
"""See WorkingTreeFormat.get_format_description()."""
2870
return "Working tree format 2"
2872
def _stub_initialize_on_transport(self, transport, file_mode):
2873
"""Workaround: create control files for a remote working tree.
2875
This ensures that it can later be updated and dealt with locally,
2876
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2877
no working tree. (See bug #43064).
2880
inv = inventory.Inventory()
2881
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2883
transport.put_file('inventory', sio, file_mode)
2884
transport.put_bytes('pending-merges', '', file_mode)
2886
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2887
accelerator_tree=None, hardlink=False):
2888
"""See WorkingTreeFormat.initialize()."""
2889
if not isinstance(a_bzrdir.transport, LocalTransport):
2890
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2891
if from_branch is not None:
2892
branch = from_branch
2894
branch = a_bzrdir.open_branch()
2895
if revision_id is None:
2896
revision_id = _mod_revision.ensure_null(branch.last_revision())
2899
branch.generate_revision_history(revision_id)
2902
inv = inventory.Inventory()
2903
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2909
basis_tree = branch.repository.revision_tree(revision_id)
2910
if basis_tree.inventory.root is not None:
2911
wt.set_root_id(basis_tree.get_root_id())
2912
# set the parent list and cache the basis tree.
2913
if _mod_revision.is_null(revision_id):
2916
parent_trees = [(revision_id, basis_tree)]
2917
wt.set_parent_trees(parent_trees)
2918
transform.build_tree(basis_tree, wt)
2922
super(WorkingTreeFormat2, self).__init__()
2923
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2925
def open(self, a_bzrdir, _found=False):
2926
"""Return the WorkingTree object for a_bzrdir
2928
_found is a private parameter, do not use it. It is used to indicate
2929
if format probing has already been done.
2932
# we are being called directly and must probe.
2933
raise NotImplementedError
2934
if not isinstance(a_bzrdir.transport, LocalTransport):
2935
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2936
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2942
class WorkingTreeFormat3(WorkingTreeFormat):
2943
"""The second working tree format updated to record a format marker.
2946
- exists within a metadir controlling .bzr
2947
- includes an explicit version marker for the workingtree control
2948
files, separate from the BzrDir format
2949
- modifies the hash cache format
2951
- uses a LockDir to guard access for writes.
2954
upgrade_recommended = True
2956
def get_format_string(self):
2957
"""See WorkingTreeFormat.get_format_string()."""
2958
return "Bazaar-NG Working Tree format 3"
2960
def get_format_description(self):
2961
"""See WorkingTreeFormat.get_format_description()."""
2962
return "Working tree format 3"
2964
_lock_file_name = 'lock'
2965
_lock_class = LockDir
2967
_tree_class = WorkingTree3
2969
def __get_matchingbzrdir(self):
2970
return bzrdir.BzrDirMetaFormat1()
2972
_matchingbzrdir = property(__get_matchingbzrdir)
2974
def _open_control_files(self, a_bzrdir):
2975
transport = a_bzrdir.get_workingtree_transport(None)
2976
return LockableFiles(transport, self._lock_file_name,
2979
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
accelerator_tree=None, hardlink=False):
2981
"""See WorkingTreeFormat.initialize().
2983
:param revision_id: if supplied, create a working tree at a different
2984
revision than the branch is at.
2985
:param accelerator_tree: A tree which can be used for retrieving file
2986
contents more quickly than the revision tree, i.e. a workingtree.
2987
The revision tree will be used for cases where accelerator_tree's
2988
content is different.
2989
:param hardlink: If true, hard-link files from accelerator_tree,
2992
if not isinstance(a_bzrdir.transport, LocalTransport):
2993
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2994
transport = a_bzrdir.get_workingtree_transport(self)
2995
control_files = self._open_control_files(a_bzrdir)
2996
control_files.create_lock()
2997
control_files.lock_write()
2998
transport.put_bytes('format', self.get_format_string(),
2999
mode=a_bzrdir._get_file_mode())
3000
if from_branch is not None:
3001
branch = from_branch
3003
branch = a_bzrdir.open_branch()
3004
if revision_id is None:
3005
revision_id = _mod_revision.ensure_null(branch.last_revision())
3006
# WorkingTree3 can handle an inventory which has a unique root id.
3007
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3008
# those trees. And because there isn't a format bump inbetween, we
3009
# are maintaining compatibility with older clients.
3010
# inv = Inventory(root_id=gen_root_id())
3011
inv = self._initial_inventory()
3012
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3018
_control_files=control_files)
3019
wt.lock_tree_write()
3021
basis_tree = branch.repository.revision_tree(revision_id)
3022
# only set an explicit root id if there is one to set.
3023
if basis_tree.inventory.root is not None:
3024
wt.set_root_id(basis_tree.get_root_id())
3025
if revision_id == _mod_revision.NULL_REVISION:
3026
wt.set_parent_trees([])
3028
wt.set_parent_trees([(revision_id, basis_tree)])
3029
transform.build_tree(basis_tree, wt)
3031
# Unlock in this order so that the unlock-triggers-flush in
3032
# WorkingTree is given a chance to fire.
3033
control_files.unlock()
3037
def _initial_inventory(self):
3038
return inventory.Inventory()
3041
super(WorkingTreeFormat3, self).__init__()
3043
def open(self, a_bzrdir, _found=False):
3044
"""Return the WorkingTree object for a_bzrdir
3046
_found is a private parameter, do not use it. It is used to indicate
3047
if format probing has already been done.
3050
# we are being called directly and must probe.
3051
raise NotImplementedError
3052
if not isinstance(a_bzrdir.transport, LocalTransport):
3053
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3054
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3057
def _open(self, a_bzrdir, control_files):
3058
"""Open the tree itself.
3060
:param a_bzrdir: the dir for the tree.
3061
:param control_files: the control files for the tree.
3063
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3067
_control_files=control_files)
3070
return self.get_format_string()
3073
__default_format = WorkingTreeFormat6()
3074
WorkingTreeFormat.register_format(__default_format)
3075
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3077
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3078
WorkingTreeFormat.set_default_format(__default_format)
3079
# formats which have no format string are not discoverable
3080
# and not independently creatable, so are not registered.
3081
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
