51
59
conflicts as _mod_conflicts,
61
revision as _mod_revision,
71
from bzrlib.workingtree_4 import (
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
92
from bzrlib.osutils import (
94
102
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
104
from bzrlib.trace import mutter, note
98
105
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
106
from bzrlib.progress import DummyProgress, ProgressPhase
107
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
108
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
109
from bzrlib.symbol_versioning import (deprecated_passed,
112
DEPRECATED_PARAMETER,
107
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
123
@deprecated_function(zero_thirteen)
124
def gen_file_id(name):
125
"""Return new file id for the basename 'name'.
127
Use bzrlib.generate_ids.gen_file_id() instead
129
return generate_ids.gen_file_id(name)
132
@deprecated_function(zero_thirteen)
134
"""Return a new tree-root file id.
136
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
138
return generate_ids.gen_root_id()
116
141
class TreeEntry(object):
117
142
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
144
This needs further inspection, it may be better to have
120
145
InventoryEntries without ids - though that seems wrong. For now,
121
146
this is a parallel hierarchy to InventoryEntry, and needs to become
122
147
one of several things: decorates to that hierarchy, children of, or
351
334
path = osutils.getcwd()
352
335
control, relpath = bzrdir.BzrDir.open_containing(path)
353
337
return control.open_workingtree(), relpath
356
def open_containing_paths(file_list, default_directory='.',
357
canonicalize=True, apply_view=True):
358
"""Open the WorkingTree that contains a set of paths.
360
Fail if the paths given are not all in a single tree.
362
This is used for the many command-line interfaces that take a list of
363
any number of files and that require they all be in the same tree.
365
# recommended replacement for builtins.internal_tree_files
366
if file_list is None or len(file_list) == 0:
367
tree = WorkingTree.open_containing(default_directory)[0]
368
# XXX: doesn't really belong here, and seems to have the strange
369
# side effect of making it return a bunch of files, not the whole
370
# tree -- mbp 20100716
371
if tree.supports_views() and apply_view:
372
view_files = tree.views.lookup_view()
374
file_list = view_files
375
view_str = views.view_display_str(view_files)
376
note("Ignoring files outside view. View is %s" % view_str)
377
return tree, file_list
378
tree = WorkingTree.open_containing(file_list[0])[0]
379
return tree, tree.safe_relpath_files(file_list, canonicalize,
380
apply_view=apply_view)
382
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
383
"""Convert file_list into a list of relpaths in tree.
385
:param self: A tree to operate on.
386
:param file_list: A list of user provided paths or None.
387
:param apply_view: if True and a view is set, apply it or check that
388
specified files are within it
389
:return: A list of relative paths.
390
:raises errors.PathNotChild: When a provided path is in a different self
393
if file_list is None:
395
if self.supports_views() and apply_view:
396
view_files = self.views.lookup_view()
400
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
401
# doesn't - fix that up here before we enter the loop.
403
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
406
for filename in file_list:
407
relpath = fixer(osutils.dereference_path(filename))
408
if view_files and not osutils.is_inside_any(view_files, relpath):
409
raise errors.FileOutsideView(filename, view_files)
410
new_list.append(relpath)
414
340
def open_downlevel(path=None):
415
341
"""Open an unsupported working tree.
483
387
# at this point ?
485
389
return self.branch.repository.revision_tree(revision_id)
486
except (errors.RevisionNotPresent, errors.NoSuchRevision):
390
except errors.RevisionNotPresent:
487
391
# the basis tree *may* be a ghost or a low level error may have
488
# occurred. If the revision is present, its a problem, if its not
392
# occured. If the revision is present, its a problem, if its not
490
394
if self.branch.repository.has_revision(revision_id):
492
396
# the basis tree is a ghost so return an empty tree.
493
return self.branch.repository.revision_tree(
494
_mod_revision.NULL_REVISION)
497
self._flush_ignore_list_cache()
397
return self.branch.repository.revision_tree(None)
400
@deprecated_method(zero_eight)
401
def create(branch, directory):
402
"""Create a workingtree for branch at directory.
404
If existing_directory already exists it must have a .bzr directory.
405
If it does not exist, it will be created.
407
This returns a new WorkingTree object for the new checkout.
409
TODO FIXME RBC 20060124 when we have checkout formats in place this
410
should accept an optional revisionid to checkout [and reject this if
411
checking out into the same dir as a pre-checkout-aware branch format.]
413
XXX: When BzrDir is present, these should be created through that
416
warnings.warn('delete WorkingTree.create', stacklevel=3)
417
transport = get_transport(directory)
418
if branch.bzrdir.root_transport.base == transport.base:
420
return branch.bzrdir.create_workingtree()
421
# different directory,
422
# create a branch reference
423
# and now a working tree.
424
raise NotImplementedError
427
@deprecated_method(zero_eight)
428
def create_standalone(directory):
429
"""Create a checkout and a branch and a repo at directory.
431
Directory must exist and be empty.
433
please use BzrDir.create_standalone_workingtree
435
return bzrdir.BzrDir.create_standalone_workingtree(directory)
499
437
def relpath(self, path):
500
438
"""Return the local path portion from a given path.
502
The path may be absolute or relative. If its a relative path it is
440
The path may be absolute or relative. If its a relative path it is
503
441
interpreted relative to the python current working directory.
505
443
return osutils.relpath(self.basedir, path)
507
445
def has_filename(self, filename):
508
446
return osutils.lexists(self.abspath(filename))
510
def get_file(self, file_id, path=None, filtered=True):
511
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
513
def get_file_with_stat(self, file_id, path=None, filtered=True,
515
"""See Tree.get_file_with_stat."""
517
path = self.id2path(file_id)
518
file_obj = self.get_file_byname(path, filtered=False)
519
stat_value = _fstat(file_obj.fileno())
520
if filtered and self.supports_content_filtering():
521
filters = self._content_filter_stack(path)
522
file_obj = filtered_input_file(file_obj, filters)
523
return (file_obj, stat_value)
525
def get_file_text(self, file_id, path=None, filtered=True):
526
my_file = self.get_file(file_id, path=path, filtered=filtered)
528
return my_file.read()
532
def get_file_byname(self, filename, filtered=True):
533
path = self.abspath(filename)
535
if filtered and self.supports_content_filtering():
536
filters = self._content_filter_stack(filename)
537
return filtered_input_file(f, filters)
541
def get_file_lines(self, file_id, path=None, filtered=True):
542
"""See Tree.get_file_lines()"""
543
file = self.get_file(file_id, path, filtered=filtered)
545
return file.readlines()
448
def get_file(self, file_id):
449
file_id = osutils.safe_file_id(file_id)
450
return self.get_file_byname(self.id2path(file_id))
452
def get_file_text(self, file_id):
453
file_id = osutils.safe_file_id(file_id)
454
return self.get_file(file_id).read()
456
def get_file_byname(self, filename):
457
return file(self.abspath(filename), 'rb')
550
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
460
def annotate_iter(self, file_id):
551
461
"""See Tree.annotate_iter
553
463
This implementation will use the basis tree implementation if possible.
557
467
incorrectly attributed to CURRENT_REVISION (but after committing, the
558
468
attribution will be correct).
560
maybe_file_parent_keys = []
561
for parent_id in self.get_parent_ids():
563
parent_tree = self.revision_tree(parent_id)
564
except errors.NoSuchRevisionInTree:
565
parent_tree = self.branch.repository.revision_tree(parent_id)
566
parent_tree.lock_read()
568
if file_id not in parent_tree:
570
ie = parent_tree.inventory[file_id]
571
if ie.kind != 'file':
572
# Note: this is slightly unnecessary, because symlinks and
573
# directories have a "text" which is the empty text, and we
574
# know that won't mess up annotations. But it seems cleaner
576
parent_text_key = (file_id, ie.revision)
577
if parent_text_key not in maybe_file_parent_keys:
578
maybe_file_parent_keys.append(parent_text_key)
581
graph = _mod_graph.Graph(self.branch.repository.texts)
582
heads = graph.heads(maybe_file_parent_keys)
583
file_parent_keys = []
584
for key in maybe_file_parent_keys:
586
file_parent_keys.append(key)
588
# Now we have the parents of this content
589
annotator = self.branch.repository.texts.get_annotator()
590
text = self.get_file_text(file_id)
591
this_key =(file_id, default_revision)
592
annotator.add_special_text(this_key, file_parent_keys, text)
593
annotations = [(key[-1], line)
594
for key, line in annotator.annotate_flat(this_key)]
597
def _get_ancestors(self, default_revision):
598
ancestors = set([default_revision])
599
for parent_id in self.get_parent_ids():
600
ancestors.update(self.branch.repository.get_ancestry(
601
parent_id, topo_sorted=False))
470
file_id = osutils.safe_file_id(file_id)
471
basis = self.basis_tree()
474
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
475
require_versioned=True).next()
476
changed_content, kind = changes[2], changes[6]
477
if not changed_content:
478
return basis.annotate_iter(file_id)
482
if kind[0] != 'file':
485
old_lines = list(basis.annotate_iter(file_id))
487
for tree in self.branch.repository.revision_trees(
488
self.get_parent_ids()[1:]):
489
if file_id not in tree:
491
old.append(list(tree.annotate_iter(file_id)))
492
return annotate.reannotate(old, self.get_file(file_id).readlines(),
604
497
def get_parent_ids(self):
605
498
"""See Tree.get_parent_ids.
607
500
This implementation reads the pending merges list and last_revision
608
501
value and uses that to decide what the parents list should be.
610
last_rev = _mod_revision.ensure_null(self._last_revision())
611
if _mod_revision.NULL_REVISION == last_rev:
503
last_rev = self._last_revision()
614
507
parents = [last_rev]
616
merges_bytes = self._transport.get_bytes('pending-merges')
509
merges_file = self._control_files.get('pending-merges')
617
510
except errors.NoSuchFile:
620
for l in osutils.split_lines(merges_bytes):
621
revision_id = l.rstrip('\n')
513
for l in merges_file.readlines():
514
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
622
515
parents.append(revision_id)
681
578
__contains__ = has_id
683
580
def get_file_size(self, file_id):
684
"""See Tree.get_file_size"""
685
# XXX: this returns the on-disk size; it should probably return the
688
return os.path.getsize(self.id2abspath(file_id))
690
if e.errno != errno.ENOENT:
581
file_id = osutils.safe_file_id(file_id)
582
return os.path.getsize(self.id2abspath(file_id))
696
585
def get_file_sha1(self, file_id, path=None, stat_value=None):
586
file_id = osutils.safe_file_id(file_id)
698
588
path = self._inventory.id2path(file_id)
699
589
return self._hashcache.get_sha1(path, stat_value)
701
591
def get_file_mtime(self, file_id, path=None):
592
file_id = osutils.safe_file_id(file_id)
703
594
path = self.inventory.id2path(file_id)
704
595
return os.lstat(self.abspath(path)).st_mtime
706
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
707
file_id = self.path2id(path)
709
# For unversioned files on win32, we just assume they are not
712
return self._inventory[file_id].executable
714
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
715
mode = stat_result.st_mode
716
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
718
597
if not supports_executable():
719
598
def is_executable(self, file_id, path=None):
599
file_id = osutils.safe_file_id(file_id)
720
600
return self._inventory[file_id].executable
722
_is_executable_from_path_and_stat = \
723
_is_executable_from_path_and_stat_from_basis
725
602
def is_executable(self, file_id, path=None):
604
file_id = osutils.safe_file_id(file_id)
727
605
path = self.id2path(file_id)
728
606
mode = os.lstat(self.abspath(path)).st_mode
729
607
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
731
_is_executable_from_path_and_stat = \
732
_is_executable_from_path_and_stat_from_stat
734
609
@needs_tree_write_lock
735
610
def _add(self, files, ids, kinds):
736
611
"""See MutableTree._add."""
737
612
# TODO: Re-adding a file that is removed in the working copy
738
613
# should probably put it back with the previous ID.
739
# the read and write working inventory should not occur in this
614
# the read and write working inventory should not occur in this
740
615
# function - they should be part of lock_write and unlock.
616
inv = self.read_working_inventory()
742
617
for f, file_id, kind in zip(files, ids, kinds):
618
assert kind is not None
743
619
if file_id is None:
744
620
inv.add_path(f, kind=kind)
622
file_id = osutils.safe_file_id(file_id)
746
623
inv.add_path(f, kind=kind, file_id=file_id)
747
self._inventory_is_modified = True
624
self._write_inventory(inv)
749
626
@needs_tree_write_lock
750
627
def _gather_kinds(self, files, kinds):
811
688
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
813
def path_content_summary(self, path, _lstat=os.lstat,
814
_mapper=osutils.file_kind_from_stat_mode):
815
"""See Tree.path_content_summary."""
816
abspath = self.abspath(path)
818
stat_result = _lstat(abspath)
820
if getattr(e, 'errno', None) == errno.ENOENT:
822
return ('missing', None, None, None)
823
# propagate other errors
825
kind = _mapper(stat_result.st_mode)
827
return self._file_content_summary(path, stat_result)
828
elif kind == 'directory':
829
# perhaps it looks like a plain directory, but it's really a
831
if self._directory_is_tree_reference(path):
832
kind = 'tree-reference'
833
return kind, None, None, None
834
elif kind == 'symlink':
835
target = osutils.readlink(abspath)
836
return ('symlink', None, None, target)
838
return (kind, None, None, None)
840
def _file_content_summary(self, path, stat_result):
841
size = stat_result.st_size
842
executable = self._is_executable_from_path_and_stat(path, stat_result)
843
# try for a stat cache lookup
844
return ('file', size, executable, self._sha_from_stat(
690
@deprecated_method(zero_eleven)
692
def pending_merges(self):
693
"""Return a list of pending merges.
695
These are revisions that have been merged into the working
696
directory but not yet committed.
698
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
699
instead - which is available on all tree objects.
701
return self.get_parent_ids()[1:]
847
703
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
848
704
"""Common ghost checking functionality from set_parent_*.
859
715
def _set_merges_from_parent_ids(self, parent_ids):
860
716
merges = parent_ids[1:]
861
self._transport.put_bytes('pending-merges', '\n'.join(merges),
862
mode=self.bzrdir._get_file_mode())
864
def _filter_parent_ids_by_ancestry(self, revision_ids):
865
"""Check that all merged revisions are proper 'heads'.
867
This will always return the first revision_id, and any merged revisions
870
if len(revision_ids) == 0:
872
graph = self.branch.repository.get_graph()
873
heads = graph.heads(revision_ids)
874
new_revision_ids = revision_ids[:1]
875
for revision_id in revision_ids[1:]:
876
if revision_id in heads and revision_id not in new_revision_ids:
877
new_revision_ids.append(revision_id)
878
if new_revision_ids != revision_ids:
879
trace.mutter('requested to set revision_ids = %s,'
880
' but filtered to %s', revision_ids, new_revision_ids)
881
return new_revision_ids
717
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
883
719
@needs_tree_write_lock
884
720
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
885
721
"""Set the parent ids to revision_ids.
887
723
See also set_parent_trees. This api will try to retrieve the tree data
888
724
for each element of revision_ids from the trees repository. If you have
889
725
tree data already available, it is more efficient to use
893
729
:param revision_ids: The revision_ids to set as the parent ids of this
894
730
working tree. Any of these may be ghosts.
732
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
896
733
self._check_parents_for_ghosts(revision_ids,
897
734
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
898
for revision_id in revision_ids:
899
_mod_revision.check_not_reserved_id(revision_id)
901
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
903
736
if len(revision_ids) > 0:
904
737
self.set_last_revision(revision_ids[0])
906
self.set_last_revision(_mod_revision.NULL_REVISION)
739
self.set_last_revision(None)
908
741
self._set_merges_from_parent_ids(revision_ids)
910
743
@needs_tree_write_lock
911
744
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
912
745
"""See MutableTree.set_parent_trees."""
913
parent_ids = [rev for (rev, tree) in parents_list]
914
for revision_id in parent_ids:
915
_mod_revision.check_not_reserved_id(revision_id)
746
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
917
748
self._check_parents_for_ghosts(parent_ids,
918
749
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
920
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
922
751
if len(parent_ids) == 0:
923
leftmost_parent_id = _mod_revision.NULL_REVISION
752
leftmost_parent_id = None
924
753
leftmost_parent_tree = None
926
755
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
979
796
branch.last_revision().
981
798
from bzrlib.merge import Merger, Merge3Merger
982
merger = Merger(self.branch, this_tree=self)
983
# check that there are no local alterations
984
if not force and self.has_changes():
985
raise errors.UncommittedChanges(self)
986
if to_revision is None:
987
to_revision = _mod_revision.ensure_null(branch.last_revision())
988
merger.other_rev_id = to_revision
989
if _mod_revision.is_null(merger.other_rev_id):
990
raise errors.NoCommits(branch)
991
self.branch.fetch(branch, last_revision=merger.other_rev_id)
992
merger.other_basis = merger.other_rev_id
993
merger.other_tree = self.branch.repository.revision_tree(
995
merger.other_branch = branch
996
if from_revision is None:
799
pb = bzrlib.ui.ui_factory.nested_progress_bar()
801
merger = Merger(self.branch, this_tree=self, pb=pb)
802
merger.pp = ProgressPhase("Merge phase", 5, pb)
803
merger.pp.next_phase()
804
# check that there are no
806
merger.check_basis(check_clean=True, require_commits=False)
807
if to_revision is None:
808
to_revision = branch.last_revision()
810
to_revision = osutils.safe_revision_id(to_revision)
811
merger.other_rev_id = to_revision
812
if merger.other_rev_id is None:
813
raise error.NoCommits(branch)
814
self.branch.fetch(branch, last_revision=merger.other_rev_id)
815
merger.other_basis = merger.other_rev_id
816
merger.other_tree = self.branch.repository.revision_tree(
818
merger.other_branch = branch
819
merger.pp.next_phase()
997
820
merger.find_base()
999
merger.set_base_revision(from_revision, branch)
1000
if merger.base_rev_id == merger.other_rev_id:
1001
raise errors.PointlessMerge
1002
merger.backup_files = False
1003
if merge_type is None:
821
if merger.base_rev_id == merger.other_rev_id:
822
raise errors.PointlessMerge
823
merger.backup_files = False
1004
824
merger.merge_type = Merge3Merger
1006
merger.merge_type = merge_type
1007
merger.set_interesting_files(None)
1008
merger.show_base = False
1009
merger.reprocess = False
1010
conflicts = merger.do_merge()
1011
merger.set_pending()
825
merger.set_interesting_files(None)
826
merger.show_base = False
827
merger.reprocess = False
828
conflicts = merger.do_merge()
1012
832
return conflicts
1014
834
@needs_read_lock
1015
835
def merge_modified(self):
1016
836
"""Return a dictionary of files modified by a merge.
1018
The list is initialized by WorkingTree.set_merge_modified, which is
838
The list is initialized by WorkingTree.set_merge_modified, which is
1019
839
typically called after we make some automatic updates to the tree
1020
840
because of a merge.
1192
988
sio = StringIO()
1193
989
self._serialize(self._inventory, sio)
1195
self._transport.put_file('inventory', sio,
1196
mode=self.bzrdir._get_file_mode())
991
self._control_files.put('inventory', sio)
1197
992
self._inventory_is_modified = False
1199
994
def _kind(self, relpath):
1200
995
return osutils.file_kind(self.abspath(relpath))
1202
def list_files(self, include_root=False, from_dir=None, recursive=True):
1203
"""List all files as (path, class, kind, id, entry).
997
def list_files(self, include_root=False):
998
"""Recursively list all files as (path, class, kind, id, entry).
1205
1000
Lists, but does not descend into unversioned directories.
1206
1002
This does not include files that have been deleted in this
1207
tree. Skips the control directory.
1209
:param include_root: if True, return an entry for the root
1210
:param from_dir: start from this directory or None for the root
1211
:param recursive: whether to recurse into subdirectories or not
1005
Skips the control directory.
1213
1007
# list_files is an iterator, so @needs_read_lock doesn't work properly
1214
1008
# with it. So callers should be careful to always read_lock the tree.
1309
1089
except KeyError:
1310
1090
yield fp[1:], c, fk, None, TreeEntry()
1313
1093
if fk != 'directory':
1316
# But do this child first if recursing down
1318
new_children = os.listdir(fap)
1320
new_children = collections.deque(new_children)
1321
stack.append((f_ie.file_id, fp, fap, new_children))
1322
# Break out of inner loop,
1323
# so that we start outer loop with child
1096
# But do this child first
1097
new_children = os.listdir(fap)
1099
new_children = collections.deque(new_children)
1100
stack.append((f_ie.file_id, fp, fap, new_children))
1101
# Break out of inner loop,
1102
# so that we start outer loop with child
1326
1105
# if we finished all children, pop it off the stack
1329
1108
@needs_tree_write_lock
1330
def move(self, from_paths, to_dir=None, after=False):
1109
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1331
1110
"""Rename files.
1333
1112
to_dir must exist in the inventory.
1335
1114
If to_dir exists and is a directory, the files are moved into
1336
it, keeping their old names.
1115
it, keeping their old names.
1338
1117
Note that to_dir is only the last component of the new name;
1339
1118
this doesn't change the directory.
1987
1744
def read_basis_inventory(self):
1988
1745
"""Read the cached basis inventory."""
1989
1746
path = self._basis_inventory_name()
1990
return self._transport.get_bytes(path)
1747
return self._control_files.get(path).read()
1992
1749
@needs_read_lock
1993
1750
def read_working_inventory(self):
1994
1751
"""Read the working inventory.
1996
1753
:raises errors.InventoryModified: read_working_inventory will fail
1997
1754
when the current in memory inventory has been modified.
1999
# conceptually this should be an implementation detail of the tree.
1756
# conceptually this should be an implementation detail of the tree.
2000
1757
# XXX: Deprecate this.
2001
1758
# ElementTree does its own conversion from UTF-8, so open in
2003
1760
if self._inventory_is_modified:
2004
1761
raise errors.InventoryModified(self)
2005
f = self._transport.get('inventory')
2007
result = self._deserialize(f)
1762
result = self._deserialize(self._control_files.get('inventory'))
2010
1763
self._set_inventory(result, dirty=False)
2013
1766
@needs_tree_write_lock
2014
def remove(self, files, verbose=False, to_file=None, keep_files=True,
2016
"""Remove nominated files from the working inventory.
2018
:files: File paths relative to the basedir.
2019
:keep_files: If true, the files will also be kept.
2020
:force: Delete files and directories, even if they are changed and
2021
even if the directories are not empty.
1767
def remove(self, files, verbose=False, to_file=None):
1768
"""Remove nominated files from the working inventory..
1770
This does not remove their text. This does not run on XXX on what? RBC
1772
TODO: Refuse to remove modified files unless --force is given?
1774
TODO: Do something useful with directories.
1776
TODO: Should this remove the text or not? Tough call; not
1777
removing may be useful and the user can just use use rm, and
1778
is the opposite of add. Removing it is consistent with most
1779
other tools. Maybe an option.
1781
## TODO: Normalize names
1782
## TODO: Remove nested loops; better scalability
2023
1783
if isinstance(files, basestring):
2024
1784
files = [files]
2028
all_files = set() # specified and nested files
2029
unknown_nested_files=set()
2031
to_file = sys.stdout
2033
files_to_backup = []
2035
def recurse_directory_to_add_files(directory):
2036
# Recurse directory and add all files
2037
# so we can check if they have changed.
2038
for parent_info, file_infos in self.walkdirs(directory):
2039
for relpath, basename, kind, lstat, fileid, kind in file_infos:
2040
# Is it versioned or ignored?
2041
if self.path2id(relpath):
2042
# Add nested content for deletion.
2043
all_files.add(relpath)
2045
# Files which are not versioned
2046
# should be treated as unknown.
2047
files_to_backup.append(relpath)
2049
for filename in files:
2050
# Get file name into canonical form.
2051
abspath = self.abspath(filename)
2052
filename = self.relpath(abspath)
2053
if len(filename) > 0:
2054
all_files.add(filename)
2055
recurse_directory_to_add_files(filename)
2057
files = list(all_files)
2060
return # nothing to do
2062
# Sort needed to first handle directory content before the directory
2063
files.sort(reverse=True)
2065
# Bail out if we are going to delete files we shouldn't
2066
if not keep_files and not force:
2067
for (file_id, path, content_change, versioned, parent_id, name,
2068
kind, executable) in self.iter_changes(self.basis_tree(),
2069
include_unchanged=True, require_versioned=False,
2070
want_unversioned=True, specific_files=files):
2071
if versioned[0] == False:
2072
# The record is unknown or newly added
2073
files_to_backup.append(path[1])
2074
elif (content_change and (kind[1] is not None) and
2075
osutils.is_inside_any(files, path[1])):
2076
# Versioned and changed, but not deleted, and still
2077
# in one of the dirs to be deleted.
2078
files_to_backup.append(path[1])
2080
def backup(file_to_backup):
2081
backup_name = self.bzrdir.generate_backup_name(file_to_backup)
2082
osutils.rename(abs_path, self.abspath(backup_name))
2083
return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
2085
# Build inv_delta and delete files where applicable,
2086
# do this before any modifications to inventory.
1786
inv = self.inventory
1788
# do this before any modifications
2087
1789
for f in files:
2088
fid = self.path2id(f)
1790
fid = inv.path2id(f)
2091
message = "%s is not versioned." % (f,)
1792
note("%s is not versioned."%f)
2094
# having removed it, it must be either ignored or unknown
1795
# having remove it, it must be either ignored or unknown
2095
1796
if self.is_ignored(f):
2096
1797
new_status = 'I'
2098
1799
new_status = '?'
2099
# XXX: Really should be a more abstract reporter interface
2100
kind_ch = osutils.kind_marker(self.kind(fid))
2101
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2103
inv_delta.append((f, None, fid, None))
2104
message = "removed %s" % (f,)
2107
abs_path = self.abspath(f)
2108
if osutils.lexists(abs_path):
2109
if (osutils.isdir(abs_path) and
2110
len(os.listdir(abs_path)) > 0):
2112
osutils.rmtree(abs_path)
2113
message = "deleted %s" % (f,)
2117
if f in files_to_backup:
2120
osutils.delete_any(abs_path)
2121
message = "deleted %s" % (f,)
2122
elif message is not None:
2123
# Only care if we haven't done anything yet.
2124
message = "%s does not exist." % (f,)
2126
# Print only one message (if any) per file.
2127
if message is not None:
2129
self.apply_inventory_delta(inv_delta)
1800
textui.show_status(new_status, inv[fid].kind, f,
1804
self._write_inventory(inv)
2131
1806
@needs_tree_write_lock
2132
def revert(self, filenames=None, old_tree=None, backups=True,
2133
pb=None, report_changes=False):
1807
def revert(self, filenames, old_tree=None, backups=True,
1808
pb=DummyProgress(), report_changes=False):
2134
1809
from bzrlib.conflicts import resolve
2137
symbol_versioning.warn('Using [] to revert all files is deprecated'
2138
' as of bzr 0.91. Please use None (the default) instead.',
2139
DeprecationWarning, stacklevel=2)
2140
1810
if old_tree is None:
2141
basis_tree = self.basis_tree()
2142
basis_tree.lock_read()
2143
old_tree = basis_tree
1811
old_tree = self.basis_tree()
1812
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1814
if not len(filenames):
1815
self.set_parent_ids(self.get_parent_ids()[:1])
2147
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2149
if filenames is None and len(self.get_parent_ids()) > 1:
2151
last_revision = self.last_revision()
2152
if last_revision != _mod_revision.NULL_REVISION:
2153
if basis_tree is None:
2154
basis_tree = self.basis_tree()
2155
basis_tree.lock_read()
2156
parent_trees.append((last_revision, basis_tree))
2157
self.set_parent_trees(parent_trees)
2160
resolve(self, filenames, ignore_misses=True, recursive=True)
2162
if basis_tree is not None:
1818
resolve(self, filenames, ignore_misses=True)
2164
1819
return conflicts
2166
1821
def revision_tree(self, revision_id):
2321
1971
# cant set that until we update the working trees last revision to be
2322
1972
# one from the new branch, because it will just get absorbed by the
2323
1973
# parent de-duplication logic.
2325
1975
# We MUST save it even if an error occurs, because otherwise the users
2326
1976
# local work is unreferenced and will appear to have been lost.
2330
1980
last_rev = self.get_parent_ids()[0]
2331
1981
except IndexError:
2332
last_rev = _mod_revision.NULL_REVISION
2333
if revision is None:
2334
revision = self.branch.last_revision()
2336
old_tip = old_tip or _mod_revision.NULL_REVISION
2338
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2339
# the branch we are bound to was updated
2340
# merge those changes in first
2341
base_tree = self.basis_tree()
2342
other_tree = self.branch.repository.revision_tree(old_tip)
2343
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2344
base_tree, this_tree=self,
2345
change_reporter=change_reporter)
2347
self.add_parent_tree((old_tip, other_tree))
2348
trace.note('Rerun update after fixing the conflicts.')
2351
if last_rev != _mod_revision.ensure_null(revision):
2352
# the working tree is up to date with the branch
2353
# we can merge the specified revision from master
2354
to_tree = self.branch.repository.revision_tree(revision)
2355
to_root_id = to_tree.get_root_id()
1983
if last_rev != self.branch.last_revision():
1984
# merge tree state up to new branch tip.
2357
1985
basis = self.basis_tree()
2358
1986
basis.lock_read()
2360
if (basis.inventory.root is None
2361
or basis.inventory.root.file_id != to_root_id):
2362
self.set_root_id(to_root_id)
1988
to_tree = self.branch.basis_tree()
1989
if basis.inventory.root is None:
1990
self.set_root_id(to_tree.inventory.root.file_id)
1992
result += merge.merge_inner(
2367
# determine the branch point
2368
graph = self.branch.repository.get_graph()
2369
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2371
base_tree = self.branch.repository.revision_tree(base_rev_id)
2373
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2375
change_reporter=change_reporter)
2376
self.set_last_revision(revision)
2377
1999
# TODO - dedup parents list with things merged by pull ?
2378
2000
# reuse the tree we've updated to to set the basis:
2379
parent_trees = [(revision, to_tree)]
2001
parent_trees = [(self.branch.last_revision(), to_tree)]
2380
2002
merges = self.get_parent_ids()[1:]
2381
2003
# Ideally we ask the tree for the trees here, that way the working
2382
# tree can decide whether to give us the entire tree or give us a
2004
# tree can decide whether to give us teh entire tree or give us a
2383
2005
# lazy initialised tree. dirstate for instance will have the trees
2384
2006
# in ram already, whereas a last-revision + basis-inventory tree
2385
2007
# will not, but also does not need them when setting parents.
2386
2008
for parent in merges:
2387
2009
parent_trees.append(
2388
2010
(parent, self.branch.repository.revision_tree(parent)))
2389
if not _mod_revision.is_null(old_tip):
2011
if old_tip is not None:
2390
2012
parent_trees.append(
2391
2013
(old_tip, self.branch.repository.revision_tree(old_tip)))
2392
2014
self.set_parent_trees(parent_trees)
2393
2015
last_rev = parent_trees[0][0]
2017
# the working tree had the same last-revision as the master
2018
# branch did. We may still have pivot local work from the local
2019
# branch into old_tip:
2020
if old_tip is not None:
2021
self.add_parent_tree_id(old_tip)
2022
if old_tip and old_tip != last_rev:
2023
# our last revision was not the prior branch last revision
2024
# and we have converted that last revision to a pending merge.
2025
# base is somewhere between the branch tip now
2026
# and the now pending merge
2028
# Since we just modified the working tree and inventory, flush out
2029
# the current state, before we modify it again.
2030
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2031
# requires it only because TreeTransform directly munges the
2032
# inventory and calls tree._write_inventory(). Ultimately we
2033
# should be able to remove this extra flush.
2035
from bzrlib.revision import common_ancestor
2037
base_rev_id = common_ancestor(self.branch.last_revision(),
2039
self.branch.repository)
2040
except errors.NoCommonAncestor:
2042
base_tree = self.branch.repository.revision_tree(base_rev_id)
2043
other_tree = self.branch.repository.revision_tree(old_tip)
2044
result += merge.merge_inner(
2396
2051
def _write_hashcache_if_dirty(self):
2397
2052
"""Write out the hashcache if it is dirty."""
2924
2509
"""See WorkingTreeFormat.get_format_description()."""
2925
2510
return "Working tree format 2"
2927
def _stub_initialize_on_transport(self, transport, file_mode):
2928
"""Workaround: create control files for a remote working tree.
2512
def stub_initialize_remote(self, control_files):
2513
"""As a special workaround create critical control files for a remote working tree
2930
2515
This ensures that it can later be updated and dealt with locally,
2931
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2516
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2932
2517
no working tree. (See bug #43064).
2934
2519
sio = StringIO()
2935
inv = inventory.Inventory()
2936
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2521
xml5.serializer_v5.write_inventory(inv, sio)
2938
transport.put_file('inventory', sio, file_mode)
2939
transport.put_bytes('pending-merges', '', file_mode)
2941
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2942
accelerator_tree=None, hardlink=False):
2523
control_files.put('inventory', sio)
2525
control_files.put_bytes('pending-merges', '')
2528
def initialize(self, a_bzrdir, revision_id=None):
2943
2529
"""See WorkingTreeFormat.initialize()."""
2944
2530
if not isinstance(a_bzrdir.transport, LocalTransport):
2945
2531
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2946
if from_branch is not None:
2947
branch = from_branch
2949
branch = a_bzrdir.open_branch()
2950
if revision_id is None:
2951
revision_id = _mod_revision.ensure_null(branch.last_revision())
2954
branch.generate_revision_history(revision_id)
2957
inv = inventory.Inventory()
2532
branch = a_bzrdir.open_branch()
2533
if revision_id is not None:
2534
revision_id = osutils.safe_revision_id(revision_id)
2537
revision_history = branch.revision_history()
2539
position = revision_history.index(revision_id)
2541
raise errors.NoSuchRevision(branch, revision_id)
2542
branch.set_revision_history(revision_history[:position + 1])
2545
revision = branch.last_revision()
2958
2547
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2961
2550
_internal=True,
2963
2552
_bzrdir=a_bzrdir)
2964
basis_tree = branch.repository.revision_tree(revision_id)
2553
basis_tree = branch.repository.revision_tree(revision)
2965
2554
if basis_tree.inventory.root is not None:
2966
wt.set_root_id(basis_tree.get_root_id())
2555
wt.set_root_id(basis_tree.inventory.root.file_id)
2967
2556
# set the parent list and cache the basis tree.
2968
if _mod_revision.is_null(revision_id):
2971
parent_trees = [(revision_id, basis_tree)]
2972
wt.set_parent_trees(parent_trees)
2557
wt.set_parent_trees([(revision, basis_tree)])
2973
2558
transform.build_tree(basis_tree, wt)
3125
2701
return self.get_format_string()
3128
__default_format = WorkingTreeFormat6()
2704
__default_format = WorkingTreeFormat4()
3129
2705
WorkingTreeFormat.register_format(__default_format)
3130
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3131
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3132
2706
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3133
2707
WorkingTreeFormat.set_default_format(__default_format)
3134
2708
# formats which have no format string are not discoverable
3135
2709
# and not independently creatable, so are not registered.
3136
2710
_legacy_formats = [WorkingTreeFormat2(),
2714
class WorkingTreeTestProviderAdapter(object):
2715
"""A tool to generate a suite testing multiple workingtree formats at once.
2717
This is done by copying the test once for each transport and injecting
2718
the transport_server, transport_readonly_server, and workingtree_format
2719
classes into each copy. Each copy is also given a new id() to make it
2723
def __init__(self, transport_server, transport_readonly_server, formats):
2724
self._transport_server = transport_server
2725
self._transport_readonly_server = transport_readonly_server
2726
self._formats = formats
2728
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2729
"""Clone test for adaption."""
2730
new_test = deepcopy(test)
2731
new_test.transport_server = self._transport_server
2732
new_test.transport_readonly_server = self._transport_readonly_server
2733
new_test.bzrdir_format = bzrdir_format
2734
new_test.workingtree_format = workingtree_format
2735
def make_new_test_id():
2736
new_id = "%s(%s)" % (test.id(), variation)
2737
return lambda: new_id
2738
new_test.id = make_new_test_id()
2741
def adapt(self, test):
2742
from bzrlib.tests import TestSuite
2743
result = TestSuite()
2744
for workingtree_format, bzrdir_format in self._formats:
2745
new_test = self._clone_test(
2748
workingtree_format, workingtree_format.__class__.__name__)
2749
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
