308
path = os.path.getcwdu()
309
control = bzrdir.BzrDir.open(path, _unsupported)
310
return control.open_workingtree(_unsupported)
253
path = osutils.getcwd()
254
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
255
return control.open_workingtree(unsupported=_unsupported)
313
258
def open_containing(path=None):
314
259
"""Open an existing working tree which has its root about path.
316
261
This probes for a working tree at path and searches upwards from there.
318
263
Basically we keep looking up until we find the control directory or
319
264
run into /. If there isn't one, raises NotBranchError.
320
265
TODO: give this a new exception.
321
266
If there is one, it is returned, along with the unused portion of path.
268
:return: The WorkingTree that contains 'path', and the rest of path
325
control, relpath = bzrdir.BzrDir.open_containing(path)
271
path = osutils.getcwd()
272
control, relpath = controldir.ControlDir.open_containing(path)
326
273
return control.open_workingtree(), relpath
276
def open_containing_paths(file_list, default_directory=None,
277
canonicalize=True, apply_view=True):
278
"""Open the WorkingTree that contains a set of paths.
280
Fail if the paths given are not all in a single tree.
282
This is used for the many command-line interfaces that take a list of
283
any number of files and that require they all be in the same tree.
285
if default_directory is None:
286
default_directory = u'.'
287
# recommended replacement for builtins.internal_tree_files
288
if file_list is None or len(file_list) == 0:
289
tree = WorkingTree.open_containing(default_directory)[0]
290
# XXX: doesn't really belong here, and seems to have the strange
291
# side effect of making it return a bunch of files, not the whole
292
# tree -- mbp 20100716
293
if tree.supports_views() and apply_view:
294
view_files = tree.views.lookup_view()
296
file_list = view_files
297
view_str = views.view_display_str(view_files)
298
note(gettext("Ignoring files outside view. View is %s") % view_str)
299
return tree, file_list
300
if default_directory == u'.':
303
seed = default_directory
304
file_list = [osutils.pathjoin(default_directory, f)
306
tree = WorkingTree.open_containing(seed)[0]
307
return tree, tree.safe_relpath_files(file_list, canonicalize,
308
apply_view=apply_view)
310
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
311
"""Convert file_list into a list of relpaths in tree.
313
:param self: A tree to operate on.
314
:param file_list: A list of user provided paths or None.
315
:param apply_view: if True and a view is set, apply it or check that
316
specified files are within it
317
:return: A list of relative paths.
318
:raises errors.PathNotChild: When a provided path is in a different self
321
if file_list is None:
323
if self.supports_views() and apply_view:
324
view_files = self.views.lookup_view()
328
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
329
# doesn't - fix that up here before we enter the loop.
331
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
334
for filename in file_list:
335
relpath = fixer(osutils.dereference_path(filename))
336
if view_files and not osutils.is_inside_any(view_files, relpath):
337
raise views.FileOutsideView(filename, view_files)
338
new_list.append(relpath)
329
342
def open_downlevel(path=None):
330
343
"""Open an unsupported working tree.
332
Only intended for advanced situations like upgrading part of a bzrdir.
345
Only intended for advanced situations like upgrading part of a controldir.
334
347
return WorkingTree.open(path, _unsupported=True)
337
"""Iterate through file_ids for this tree.
339
file_ids are in a WorkingTree if they are in the working inventory
340
and the working file exists.
342
inv = self._inventory
343
for path, ie in inv.iter_entries():
344
if bzrlib.osutils.lexists(self.abspath(path)):
350
def find_trees(location):
351
def list_current(transport):
352
return [d for d in transport.list_dir('')
353
if not controldir.is_control_filename(d)]
354
def evaluate(controldir):
356
tree = controldir.open_workingtree()
357
except errors.NoWorkingTree:
361
t = transport.get_transport(location)
362
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
363
list_current=list_current)
364
return [tr for tr in iterator if tr is not None]
347
366
def __repr__(self):
348
367
return "<%s of %s>" % (self.__class__.__name__,
349
368
getattr(self, 'basedir', None))
351
370
def abspath(self, filename):
352
return pathjoin(self.basedir, filename)
371
return osutils.pathjoin(self.basedir, filename)
354
373
def basis_tree(self):
355
"""Return RevisionTree for the current last revision."""
356
revision_id = self.last_revision()
357
if revision_id is not None:
359
xml = self.read_basis_inventory()
360
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
363
if inv is not None and inv.revision_id == revision_id:
364
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
366
# FIXME? RBC 20060403 should we cache the inventory here ?
367
return self.branch.repository.revision_tree(revision_id)
370
@deprecated_method(zero_eight)
371
def create(branch, directory):
372
"""Create a workingtree for branch at directory.
374
If existing_directory already exists it must have a .bzr directory.
375
If it does not exist, it will be created.
377
This returns a new WorkingTree object for the new checkout.
379
TODO FIXME RBC 20060124 when we have checkout formats in place this
380
should accept an optional revisionid to checkout [and reject this if
381
checking out into the same dir as a pre-checkout-aware branch format.]
383
XXX: When BzrDir is present, these should be created through that
386
warn('delete WorkingTree.create', stacklevel=3)
387
transport = get_transport(directory)
388
if branch.bzrdir.root_transport.base == transport.base:
390
return branch.bzrdir.create_workingtree()
391
# different directory,
392
# create a branch reference
393
# and now a working tree.
394
raise NotImplementedError
397
@deprecated_method(zero_eight)
398
def create_standalone(directory):
399
"""Create a checkout and a branch and a repo at directory.
401
Directory must exist and be empty.
403
please use BzrDir.create_standalone_workingtree
405
return bzrdir.BzrDir.create_standalone_workingtree(directory)
407
def relpath(self, abs):
408
"""Return the local path portion from a given absolute path."""
409
return relpath(self.basedir, abs)
374
"""Return RevisionTree for the current last revision.
376
If the left most parent is a ghost then the returned tree will be an
377
empty tree - one obtained by calling
378
repository.revision_tree(NULL_REVISION).
381
revision_id = self.get_parent_ids()[0]
383
# no parents, return an empty revision tree.
384
# in the future this should return the tree for
385
# 'empty:' - the implicit root empty tree.
386
return self.branch.repository.revision_tree(
387
_mod_revision.NULL_REVISION)
389
return self.revision_tree(revision_id)
390
except errors.NoSuchRevision:
392
# No cached copy available, retrieve from the repository.
393
# FIXME? RBC 20060403 should we cache the tree locally
396
return self.branch.repository.revision_tree(revision_id)
397
except (errors.RevisionNotPresent, errors.NoSuchRevision):
398
# the basis tree *may* be a ghost or a low level error may have
399
# occurred. If the revision is present, its a problem, if its not
401
if self.branch.repository.has_revision(revision_id):
403
# the basis tree is a ghost so return an empty tree.
404
return self.branch.repository.revision_tree(
405
_mod_revision.NULL_REVISION)
407
def relpath(self, path):
408
"""Return the local path portion from a given path.
410
The path may be absolute or relative. If its a relative path it is
411
interpreted relative to the python current working directory.
413
return osutils.relpath(self.basedir, path)
411
415
def has_filename(self, filename):
412
return bzrlib.osutils.lexists(self.abspath(filename))
414
def get_file(self, file_id):
415
return self.get_file_byname(self.id2path(file_id))
417
def get_file_byname(self, filename):
418
return file(self.abspath(filename), 'rb')
416
return osutils.lexists(self.abspath(filename))
418
def get_file(self, path, file_id=None, filtered=True):
419
return self.get_file_with_stat(path, file_id, filtered=filtered)[0]
421
def get_file_with_stat(self, path, file_id=None, filtered=True,
422
_fstat=osutils.fstat):
423
"""See Tree.get_file_with_stat."""
424
abspath = self.abspath(path)
425
file_obj = file(abspath, 'rb')
426
stat_value = _fstat(file_obj.fileno())
427
if filtered and self.supports_content_filtering():
428
filters = self._content_filter_stack(path)
429
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
430
return (file_obj, stat_value)
432
def get_file_text(self, path, file_id=None, filtered=True):
433
my_file = self.get_file(path, file_id, filtered=filtered)
435
return my_file.read()
439
def get_file_lines(self, path, file_id=None, filtered=True):
440
"""See Tree.get_file_lines()"""
441
file = self.get_file(path, file_id, filtered=filtered)
443
return file.readlines()
447
def get_parent_ids(self):
448
"""See Tree.get_parent_ids.
450
This implementation reads the pending merges list and last_revision
451
value and uses that to decide what the parents list should be.
453
last_rev = _mod_revision.ensure_null(self._last_revision())
454
if _mod_revision.NULL_REVISION == last_rev:
459
merges_bytes = self._transport.get_bytes('pending-merges')
460
except errors.NoSuchFile:
463
for l in osutils.split_lines(merges_bytes):
464
revision_id = l.rstrip('\n')
465
parents.append(revision_id)
420
468
def get_root_id(self):
421
469
"""Return the id of this trees root"""
422
inv = self.read_working_inventory()
423
return inv.root.file_id
425
def _get_store_filename(self, file_id):
426
## XXX: badly named; this is not in the store at all
427
return self.abspath(self.id2path(file_id))
470
raise NotImplementedError(self.get_root_id)
430
def clone(self, to_bzrdir, revision_id=None, basis=None):
472
def clone(self, to_controldir, revision_id=None):
431
473
"""Duplicate this working tree into to_bzr, including all state.
433
475
Specifically modified files are kept as modified, but
434
476
ignored and unknown files are discarded.
436
If you want to make a new line of development, see bzrdir.sprout()
478
If you want to make a new line of development, see ControlDir.sprout()
439
If not None, the cloned tree will have its last revision set to
440
revision, and and difference between the source trees last revision
481
If not None, the cloned tree will have its last revision set to
482
revision, and difference between the source trees last revision
441
483
and this one merged in.
444
If not None, a closer copy of a tree which may have some files in
445
common, and which file content should be preferentially copied from.
447
# assumes the target bzr dir format is compatible.
448
result = self._format.initialize(to_bzrdir)
449
self.copy_content_into(result, revision_id)
485
with self.lock_read():
486
# assumes the target bzr dir format is compatible.
487
result = to_controldir.create_workingtree()
488
self.copy_content_into(result, revision_id)
453
491
def copy_content_into(self, tree, revision_id=None):
454
492
"""Copy the current content and user files of this tree into tree."""
455
if revision_id is None:
456
transform_tree(tree, self)
458
# TODO now merge from tree.last_revision to revision
459
transform_tree(tree, self)
460
tree.set_last_revision(revision_id)
493
with self.lock_read():
494
tree.set_root_id(self.get_root_id())
495
if revision_id is None:
496
merge.transform_tree(tree, self)
498
# TODO now merge from tree.last_revision to revision (to
499
# preserve user local changes)
501
other_tree = self.revision_tree(revision_id)
502
except errors.NoSuchRevision:
503
other_tree = self.branch.repository.revision_tree(
463
def commit(self, message=None, revprops=None, *args, **kwargs):
464
# avoid circular imports
465
from bzrlib.commit import Commit
468
if not 'branch-nick' in revprops:
469
revprops['branch-nick'] = self.branch.nick
470
# args for wt.commit start at message from the Commit.commit method,
471
# but with branch a kwarg now, passing in args as is results in the
472
#message being used for the branch
473
args = (DEPRECATED_PARAMETER, message, ) + args
474
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
475
self._set_inventory(self.read_working_inventory())
506
merge.transform_tree(tree, other_tree)
507
if revision_id == _mod_revision.NULL_REVISION:
510
new_parents = [revision_id]
511
tree.set_parent_ids(new_parents)
477
513
def id2abspath(self, file_id):
478
514
return self.abspath(self.id2path(file_id))
480
def has_id(self, file_id):
481
# files that have been deleted are excluded
482
inv = self._inventory
483
if not inv.has_id(file_id):
485
path = inv.id2path(file_id)
486
return bzrlib.osutils.lexists(self.abspath(path))
488
def has_or_had_id(self, file_id):
489
if file_id == self.inventory.root.file_id:
491
return self.inventory.has_id(file_id)
493
__contains__ = has_id
495
def get_file_size(self, file_id):
496
return os.path.getsize(self.id2abspath(file_id))
499
def get_file_sha1(self, file_id):
500
path = self._inventory.id2path(file_id)
501
return self._hashcache.get_sha1(path)
503
def is_executable(self, file_id):
504
if not supports_executable():
505
return self._inventory[file_id].executable
507
path = self._inventory.id2path(file_id)
508
mode = os.lstat(self.abspath(path)).st_mode
509
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
512
def add(self, files, ids=None):
513
"""Make files versioned.
515
Note that the command line normally calls smart_add instead,
516
which can automatically recurse.
518
This adds the files to the inventory, so that they will be
519
recorded by the next commit.
522
List of paths to add, relative to the base of the tree.
525
If set, use these instead of automatically generated ids.
526
Must be the same length as the list of files, but may
527
contain None for ids that are to be autogenerated.
529
TODO: Perhaps have an option to add the ids even if the files do
532
TODO: Perhaps callback with the ids and paths as they're added.
534
# TODO: Re-adding a file that is removed in the working copy
535
# should probably put it back with the previous ID.
536
if isinstance(files, basestring):
537
assert(ids is None or isinstance(ids, basestring))
543
ids = [None] * len(files)
545
assert(len(ids) == len(files))
547
inv = self.read_working_inventory()
548
for f,file_id in zip(files, ids):
549
if self.is_control_filename(f):
550
raise BzrError("cannot add control file %s" % quotefn(f))
555
raise BzrError("cannot add top-level %r" % f)
557
fullpath = normpath(self.abspath(f))
560
kind = file_kind(fullpath)
562
if e.errno == errno.ENOENT:
563
raise NoSuchFile(fullpath)
564
# maybe something better?
565
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
567
if not InventoryEntry.versionable_kind(kind):
568
raise BzrError('cannot add: not a versionable file ('
569
'i.e. regular file, symlink or directory): %s' % quotefn(f))
572
file_id = gen_file_id(f)
573
inv.add_path(f, kind=kind, file_id=file_id)
575
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
self._write_inventory(inv)
516
def get_file_size(self, path, file_id=None):
517
"""See Tree.get_file_size"""
518
# XXX: this returns the on-disk size; it should probably return the
521
return os.path.getsize(self.abspath(path))
523
if e.errno != errno.ENOENT:
528
def _gather_kinds(self, files, kinds):
529
"""See MutableTree._gather_kinds."""
530
with self.lock_tree_write():
531
for pos, f in enumerate(files):
532
if kinds[pos] is None:
533
fullpath = osutils.normpath(self.abspath(f))
535
kinds[pos] = osutils.file_kind(fullpath)
537
if e.errno == errno.ENOENT:
538
raise errors.NoSuchFile(fullpath)
540
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
541
"""Add revision_id as a parent.
543
This is equivalent to retrieving the current list of parent ids
544
and setting the list to its value plus revision_id.
546
:param revision_id: The revision id to add to the parent list. It may
547
be a ghost revision as long as its not the first parent to be
548
added, or the allow_leftmost_as_ghost parameter is set True.
549
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
551
with self.lock_write():
552
parents = self.get_parent_ids() + [revision_id]
553
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
554
or allow_leftmost_as_ghost)
556
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
557
"""Add revision_id, tree tuple as a parent.
559
This is equivalent to retrieving the current list of parent trees
560
and setting the list to its value plus parent_tuple. See also
561
add_parent_tree_id - if you only have a parent id available it will be
562
simpler to use that api. If you have the parent already available, using
563
this api is preferred.
565
:param parent_tuple: The (revision id, tree) to add to the parent list.
566
If the revision_id is a ghost, pass None for the tree.
567
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
569
with self.lock_tree_write():
570
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
571
if len(parent_ids) > 1:
572
# the leftmost may have already been a ghost, preserve that if it
574
allow_leftmost_as_ghost = True
575
self.set_parent_ids(parent_ids,
576
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
579
578
def add_pending_merge(self, *revision_ids):
580
# TODO: Perhaps should check at this point that the
581
# history of the revision is actually present?
582
p = self.pending_merges()
584
for rev_id in revision_ids:
590
self.set_pending_merges(p)
593
def pending_merges(self):
594
"""Return a list of pending merges.
596
These are revisions that have been merged into the working
597
directory but not yet committed.
579
with self.lock_tree_write():
580
# TODO: Perhaps should check at this point that the
581
# history of the revision is actually present?
582
parents = self.get_parent_ids()
584
for rev_id in revision_ids:
585
if rev_id in parents:
587
parents.append(rev_id)
590
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
592
def path_content_summary(self, path, _lstat=os.lstat,
593
_mapper=osutils.file_kind_from_stat_mode):
594
"""See Tree.path_content_summary."""
595
abspath = self.abspath(path)
600
merges_file = self._control_files.get_utf8('pending-merges')
602
if e.errno != errno.ENOENT:
606
for l in merges_file.readlines():
607
p.append(l.rstrip('\n'))
597
stat_result = _lstat(abspath)
599
if getattr(e, 'errno', None) == errno.ENOENT:
601
return ('missing', None, None, None)
602
# propagate other errors
604
kind = _mapper(stat_result.st_mode)
606
return self._file_content_summary(path, stat_result)
607
elif kind == 'directory':
608
# perhaps it looks like a plain directory, but it's really a
610
if self._directory_is_tree_reference(path):
611
kind = 'tree-reference'
612
return kind, None, None, None
613
elif kind == 'symlink':
614
target = osutils.readlink(abspath)
615
return ('symlink', None, None, target)
617
return (kind, None, None, None)
619
def _file_content_summary(self, path, stat_result):
620
size = stat_result.st_size
621
executable = self._is_executable_from_path_and_stat(path, stat_result)
622
# try for a stat cache lookup
623
return ('file', size, executable, self._sha_from_stat(
626
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
627
"""Common ghost checking functionality from set_parent_*.
629
This checks that the left hand-parent exists if there are any
632
if len(revision_ids) > 0:
633
leftmost_id = revision_ids[0]
634
if (not allow_leftmost_as_ghost and not
635
self.branch.repository.has_revision(leftmost_id)):
636
raise errors.GhostRevisionUnusableHere(leftmost_id)
638
def _set_merges_from_parent_ids(self, parent_ids):
639
merges = parent_ids[1:]
640
self._transport.put_bytes('pending-merges', '\n'.join(merges),
641
mode=self.controldir._get_file_mode())
643
def _filter_parent_ids_by_ancestry(self, revision_ids):
644
"""Check that all merged revisions are proper 'heads'.
646
This will always return the first revision_id, and any merged revisions
649
if len(revision_ids) == 0:
651
graph = self.branch.repository.get_graph()
652
heads = graph.heads(revision_ids)
653
new_revision_ids = revision_ids[:1]
654
for revision_id in revision_ids[1:]:
655
if revision_id in heads and revision_id not in new_revision_ids:
656
new_revision_ids.append(revision_id)
657
if new_revision_ids != revision_ids:
658
mutter('requested to set revision_ids = %s,'
659
' but filtered to %s', revision_ids, new_revision_ids)
660
return new_revision_ids
662
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
663
"""Set the parent ids to revision_ids.
665
See also set_parent_trees. This api will try to retrieve the tree data
666
for each element of revision_ids from the trees repository. If you have
667
tree data already available, it is more efficient to use
668
set_parent_trees rather than set_parent_ids. set_parent_ids is however
669
an easier API to use.
671
:param revision_ids: The revision_ids to set as the parent ids of this
672
working tree. Any of these may be ghosts.
674
with self.lock_tree_write():
675
self._check_parents_for_ghosts(revision_ids,
676
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
677
for revision_id in revision_ids:
678
_mod_revision.check_not_reserved_id(revision_id)
680
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
682
if len(revision_ids) > 0:
683
self.set_last_revision(revision_ids[0])
685
self.set_last_revision(_mod_revision.NULL_REVISION)
687
self._set_merges_from_parent_ids(revision_ids)
611
689
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
690
with self.lock_tree_write():
691
parents = self.get_parent_ids()
692
leftmost = parents[:1]
693
new_parents = leftmost + rev_list
694
self.set_parent_ids(new_parents)
615
696
def set_merge_modified(self, modified_hashes):
617
for file_id, hash in modified_hashes.iteritems():
618
yield Stanza(file_id=file_id, hash=hash)
619
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
622
def _put_rio(self, filename, stanzas, header):
623
my_file = rio_file(stanzas, header)
624
self._control_files.put(filename, my_file)
697
"""Set the merge modified hashes."""
698
raise NotImplementedError(self.set_merge_modified)
700
def _sha_from_stat(self, path, stat_result):
701
"""Get a sha digest from the tree's stat cache.
703
The default implementation assumes no stat cache is present.
705
:param path: The path.
706
:param stat_result: The stat result being looked up.
710
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
711
merge_type=None, force=False):
712
"""Merge from a branch into this working tree.
714
:param branch: The branch to merge from.
715
:param to_revision: If non-None, the merge will merge to to_revision,
716
but not beyond it. to_revision does not need to be in the history
717
of the branch when it is supplied. If None, to_revision defaults to
718
branch.last_revision().
720
from .merge import Merger, Merge3Merger
721
with self.lock_write():
722
merger = Merger(self.branch, this_tree=self)
723
# check that there are no local alterations
724
if not force and self.has_changes():
725
raise errors.UncommittedChanges(self)
726
if to_revision is None:
727
to_revision = _mod_revision.ensure_null(branch.last_revision())
728
merger.other_rev_id = to_revision
729
if _mod_revision.is_null(merger.other_rev_id):
730
raise errors.NoCommits(branch)
731
self.branch.fetch(branch, last_revision=merger.other_rev_id)
732
merger.other_basis = merger.other_rev_id
733
merger.other_tree = self.branch.repository.revision_tree(
735
merger.other_branch = branch
736
if from_revision is None:
739
merger.set_base_revision(from_revision, branch)
740
if merger.base_rev_id == merger.other_rev_id:
741
raise errors.PointlessMerge
742
merger.backup_files = False
743
if merge_type is None:
744
merger.merge_type = Merge3Merger
746
merger.merge_type = merge_type
747
merger.set_interesting_files(None)
748
merger.show_base = False
749
merger.reprocess = False
750
conflicts = merger.do_merge()
627
754
def merge_modified(self):
629
hashfile = self._control_files.get('merge-hashes')
634
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
raise MergeModifiedFormatError()
636
except StopIteration:
637
raise MergeModifiedFormatError()
638
for s in RioReader(hashfile):
639
file_id = s.get("file_id")
640
if file_id not in self.inventory:
643
if hash == self.get_file_sha1(file_id):
644
merge_hashes[file_id] = hash
647
def get_symlink_target(self, file_id):
648
return os.readlink(self.id2abspath(file_id))
650
def file_class(self, filename):
651
if self.path2id(filename):
653
elif self.is_ignored(filename):
658
def list_files(self):
659
"""Recursively list all files as (path, class, kind, id).
755
"""Return a dictionary of files modified by a merge.
757
The list is initialized by WorkingTree.set_merge_modified, which is
758
typically called after we make some automatic updates to the tree
761
This returns a map of file_id->sha1, containing only files which are
762
still in the working tree and have that text hash.
764
raise NotImplementedError(self.merge_modified)
766
def mkdir(self, path, file_id=None):
767
"""See MutableTree.mkdir()."""
769
if self.supports_setting_file_ids():
770
file_id = generate_ids.gen_file_id(os.path.basename(path))
772
if not self.supports_setting_file_ids():
773
raise SettingFileIdUnsupported()
774
with self.lock_write():
775
os.mkdir(self.abspath(path))
776
self.add(path, file_id, 'directory')
779
def get_symlink_target(self, path, file_id=None):
781
abspath = self.abspath(path)
783
abspath = self.id2abspath(file_id)
784
target = osutils.readlink(abspath)
787
def subsume(self, other_tree):
788
raise NotImplementedError(self.subsume)
790
def _setup_directory_is_tree_reference(self):
791
if self._branch.repository._format.supports_tree_reference:
792
self._directory_is_tree_reference = \
793
self._directory_may_be_tree_reference
795
self._directory_is_tree_reference = \
796
self._directory_is_never_tree_reference
798
def _directory_is_never_tree_reference(self, relpath):
801
def _directory_may_be_tree_reference(self, relpath):
802
# as a special case, if a directory contains control files then
803
# it's a tree reference, except that the root of the tree is not
804
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
805
# TODO: We could ask all the control formats whether they
806
# recognize this directory, but at the moment there's no cheap api
807
# to do that. Since we probably can only nest bzr checkouts and
808
# they always use this name it's ok for now. -- mbp 20060306
810
# FIXME: There is an unhandled case here of a subdirectory
811
# containing .bzr but not a branch; that will probably blow up
812
# when you try to commit it. It might happen if there is a
813
# checkout in a subdirectory. This can be avoided by not adding
816
def extract(self, file_id, format=None):
817
"""Extract a subtree from this tree.
819
A new branch will be created, relative to the path for this tree.
821
raise NotImplementedError(self.extract)
824
"""Write the in memory meta data to disk."""
825
raise NotImplementedError(self.flush)
827
def kind(self, relpath, file_id=None):
828
if file_id is not None:
829
return osutils.file_kind(self.id2abspath(file_id))
830
return osutils.file_kind(self.abspath(relpath))
832
def list_files(self, include_root=False, from_dir=None, recursive=True):
833
"""List all files as (path, class, kind, id, entry).
661
835
Lists, but does not descend into unversioned directories.
663
836
This does not include files that have been deleted in this
837
tree. Skips the control directory.
666
Skips the control directory.
839
:param include_root: if True, return an entry for the root
840
:param from_dir: start from this directory or None for the root
841
:param recursive: whether to recurse into subdirectories or not
668
inv = self._inventory
670
def descend(from_dir_relpath, from_dir_id, dp):
674
## TODO: If we find a subdirectory with its own .bzr
675
## directory, then that is a separate tree and we
676
## should exclude it.
678
# the bzrdir for this tree
679
if self.bzrdir.transport.base.endswith(f + '/'):
683
fp = appendpath(from_dir_relpath, f)
686
fap = appendpath(dp, f)
688
f_ie = inv.get_child(from_dir_id, f)
691
elif self.is_ignored(fp):
700
raise BzrCheckError("file %r entered as kind %r id %r, "
702
% (fap, f_ie.kind, f_ie.file_id, fk))
704
# make a last minute entry
708
if fk == 'directory':
709
entry = TreeDirectory()
712
elif fk == 'symlink':
717
yield fp, c, fk, (f_ie and f_ie.file_id), entry
719
if fk != 'directory':
723
# don't descend unversioned directories
726
for ff in descend(fp, f_ie.file_id, fap):
729
for f in descend(u'', inv.root.file_id, self.basedir):
733
def move(self, from_paths, to_name):
843
raise NotImplementedError(self.list_files)
845
def move(self, from_paths, to_dir=None, after=False):
736
to_name must exist in the inventory.
738
If to_name exists and is a directory, the files are moved into
739
it, keeping their old names.
741
Note that to_name is only the last component of the new name;
848
to_dir must be known to the working tree.
850
If to_dir exists and is a directory, the files are moved into
851
it, keeping their old names.
853
Note that to_dir is only the last component of the new name;
742
854
this doesn't change the directory.
856
For each entry in from_paths the move mode will be determined
859
The first mode moves the file in the filesystem and updates the
860
working tree metadata. The second mode only updates the working tree
861
metadata without touching the file on the filesystem.
863
move uses the second mode if 'after == True' and the target is not
864
versioned but present in the working tree.
866
move uses the second mode if 'after == False' and the source is
867
versioned but no longer in the working tree, and the target is not
868
versioned but present in the working tree.
870
move uses the first mode if 'after == False' and the source is
871
versioned and present in the working tree, and the target is not
872
versioned and not present in the working tree.
874
Everything else results in an error.
744
876
This returns a list of (from_path, to_path) pairs for each
745
877
entry that is moved.
748
## TODO: Option to move IDs only
749
assert not isinstance(from_paths, basestring)
751
to_abs = self.abspath(to_name)
752
if not isdir(to_abs):
753
raise BzrError("destination %r is not a directory" % to_abs)
754
if not self.has_filename(to_name):
755
raise BzrError("destination %r not in working directory" % to_abs)
756
to_dir_id = inv.path2id(to_name)
757
if to_dir_id == None and to_name != '':
758
raise BzrError("destination %r is not a versioned directory" % to_name)
759
to_dir_ie = inv[to_dir_id]
760
if to_dir_ie.kind not in ('directory', 'root_directory'):
761
raise BzrError("destination %r is not a directory" % to_abs)
763
to_idpath = inv.get_idpath(to_dir_id)
766
if not self.has_filename(f):
767
raise BzrError("%r does not exist in working tree" % f)
768
f_id = inv.path2id(f)
770
raise BzrError("%r is not versioned" % f)
771
name_tail = splitpath(f)[-1]
772
dest_path = appendpath(to_name, name_tail)
773
if self.has_filename(dest_path):
774
raise BzrError("destination %r already exists" % dest_path)
775
if f_id in to_idpath:
776
raise BzrError("can't move %r to a subdirectory of itself" % f)
778
# OK, so there's a race here, it's possible that someone will
779
# create a file in this interval and then the rename might be
780
# left half-done. But we should have caught most problems.
781
orig_inv = deepcopy(self.inventory)
784
name_tail = splitpath(f)[-1]
785
dest_path = appendpath(to_name, name_tail)
786
result.append((f, dest_path))
787
inv.rename(inv.path2id(f), to_dir_id, name_tail)
789
rename(self.abspath(f), self.abspath(dest_path))
791
raise BzrError("failed to rename %r to %r: %s" %
792
(f, dest_path, e[1]),
793
["rename rolled back"])
795
# restore the inventory on error
796
self._set_inventory(orig_inv)
798
self._write_inventory(inv)
802
def rename_one(self, from_rel, to_rel):
879
raise NotImplementedError(self.move)
881
def rename_one(self, from_rel, to_rel, after=False):
803
882
"""Rename one file.
805
884
This can change the directory or the filename or both.
886
rename_one has several 'modes' to work. First, it can rename a physical
887
file and change the file_id. That is the normal mode. Second, it can
888
only change the file_id without touching any physical file.
890
rename_one uses the second mode if 'after == True' and 'to_rel' is
891
either not versioned or newly added, and present in the working tree.
893
rename_one uses the second mode if 'after == False' and 'from_rel' is
894
versioned but no longer in the working tree, and 'to_rel' is not
895
versioned but present in the working tree.
897
rename_one uses the first mode if 'after == False' and 'from_rel' is
898
versioned and present in the working tree, and 'to_rel' is not
899
versioned and not present in the working tree.
901
Everything else results in an error.
808
if not self.has_filename(from_rel):
809
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
810
if self.has_filename(to_rel):
811
raise BzrError("can't rename: new working file %r already exists" % to_rel)
813
file_id = inv.path2id(from_rel)
815
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
818
from_parent = entry.parent_id
819
from_name = entry.name
821
if inv.path2id(to_rel):
822
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
824
to_dir, to_tail = os.path.split(to_rel)
825
to_dir_id = inv.path2id(to_dir)
826
if to_dir_id == None and to_dir != '':
827
raise BzrError("can't determine destination directory id for %r" % to_dir)
829
mutter("rename_one:")
830
mutter(" file_id {%s}" % file_id)
831
mutter(" from_rel %r" % from_rel)
832
mutter(" to_rel %r" % to_rel)
833
mutter(" to_dir %r" % to_dir)
834
mutter(" to_dir_id {%s}" % to_dir_id)
836
inv.rename(file_id, to_dir_id, to_tail)
838
from_abs = self.abspath(from_rel)
839
to_abs = self.abspath(to_rel)
841
rename(from_abs, to_abs)
843
inv.rename(file_id, from_parent, from_name)
844
raise BzrError("failed to rename %r to %r: %s"
845
% (from_abs, to_abs, e[1]),
846
["rename rolled back"])
847
self._write_inventory(inv)
903
raise NotImplementedError(self.rename_one)
850
905
def unknowns(self):
851
906
"""Return all unknown files.
853
908
These are files in the working directory that are not versioned or
854
909
control files or ignored.
856
>>> from bzrlib.bzrdir import ScratchDir
857
>>> d = ScratchDir(files=['foo', 'foo~'])
858
>>> b = d.open_branch()
859
>>> tree = d.open_workingtree()
860
>>> map(str, tree.unknowns())
863
>>> list(b.unknowns())
865
>>> tree.remove('foo')
866
>>> list(b.unknowns())
869
for subp in self.extras():
870
if not self.is_ignored(subp):
873
@deprecated_method(zero_eight)
874
def iter_conflicts(self):
875
"""List all files in the tree that have text or content conflicts.
876
DEPRECATED. Use conflicts instead."""
877
return self._iter_conflicts()
879
def _iter_conflicts(self):
881
for path in (s[0] for s in self.list_files()):
882
stem = get_conflicted_stem(path)
885
if stem not in conflicted:
890
def pull(self, source, overwrite=False, stop_revision=None):
891
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
894
pp = ProgressPhase("Pull phase", 2, top_pb)
896
old_revision_history = self.branch.revision_history()
911
with self.lock_read():
912
# force the extras method to be fully executed before returning, to
913
# prevent race conditions with the lock
915
[subp for subp in self.extras() if not self.is_ignored(subp)])
917
def unversion(self, paths):
918
"""Remove the path in pahs from the current versioned set.
920
When a path is unversioned, all of its children are automatically
923
:param paths: The file ids to stop versioning.
924
:raises: NoSuchFile if any fileid is not currently versioned.
926
raise NotImplementedError(self.unversion)
928
def pull(self, source, overwrite=False, stop_revision=None,
929
change_reporter=None, possible_transports=None, local=False,
931
with self.lock_write(), source.lock_read():
932
old_revision_info = self.branch.last_revision_info()
897
933
basis_tree = self.basis_tree()
898
count = self.branch.pull(source, overwrite, stop_revision)
899
new_revision_history = self.branch.revision_history()
900
if new_revision_history != old_revision_history:
902
if len(old_revision_history):
903
other_revision = old_revision_history[-1]
905
other_revision = None
934
count = self.branch.pull(source, overwrite, stop_revision,
935
possible_transports=possible_transports,
937
new_revision_info = self.branch.last_revision_info()
938
if new_revision_info != old_revision_info:
906
939
repository = self.branch.repository
907
pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
merge_inner(self.branch,
910
self.branch.basis_tree(),
916
self.set_last_revision(self.branch.last_revision())
940
if repository._format.fast_deltas:
941
parent_ids = self.get_parent_ids()
943
basis_id = parent_ids[0]
944
basis_tree = repository.revision_tree(basis_id)
945
with basis_tree.lock_read():
946
new_basis_tree = self.branch.basis_tree()
952
change_reporter=change_reporter,
954
basis_root_id = basis_tree.get_root_id()
955
new_root_id = new_basis_tree.get_root_id()
956
if new_root_id is not None and basis_root_id != new_root_id:
957
self.set_root_id(new_root_id)
958
# TODO - dedup parents list with things merged by pull ?
959
# reuse the revisiontree we merged against to set the new
962
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
964
(self.branch.last_revision(), new_basis_tree))
965
# we have to pull the merge trees out again, because
966
# merge_inner has set the ids. - this corner is not yet
967
# layered well enough to prevent double handling.
968
# XXX TODO: Fix the double handling: telling the tree about
969
# the already known parent data is wasteful.
970
merges = self.get_parent_ids()[1:]
971
parent_trees.extend([
972
(parent, repository.revision_tree(parent)) for
974
self.set_parent_trees(parent_trees)
977
def put_file_bytes_non_atomic(self, path, bytes, file_id=None):
978
"""See MutableTree.put_file_bytes_non_atomic."""
979
with self.lock_write():
980
stream = file(self.abspath(path), 'wb')
922
986
def extras(self):
923
"""Yield all unknown files in this WorkingTree.
987
"""Yield all unversioned files in this WorkingTree.
925
If there are any unknown directories then only the directory is
926
returned, not all its children. But if there are unknown files
989
If there are any unversioned directories then only the directory is
990
returned, not all its children. But if there are unversioned files
927
991
under a versioned subdirectory, they are returned.
929
993
Currently returned depth-first, sorted by name within directories.
994
This is the same order used by 'osutils.walkdirs'.
931
## TODO: Work from given directory downwards
932
for path, dir_entry in self.inventory.directories():
933
mutter("search for unknowns in %r", path)
934
dirabs = self.abspath(path)
935
if not isdir(dirabs):
936
# e.g. directory deleted
940
for subf in os.listdir(dirabs):
942
and (subf not in dir_entry.children)):
947
subp = appendpath(path, subf)
996
raise NotImplementedError(self.extras)
951
998
def ignored_files(self):
952
999
"""Yield list of PATH, IGNORE_PATTERN"""
953
1000
for subp in self.extras():
954
1001
pat = self.is_ignored(subp)
959
def get_ignore_list(self):
960
"""Return list of ignore patterns.
962
Cached in the Tree object after the first call.
964
if hasattr(self, '_ignorelist'):
965
return self._ignorelist
967
l = bzrlib.DEFAULT_IGNORE[:]
968
if self.has_filename(bzrlib.IGNORE_FILENAME):
969
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
970
l.extend([line.rstrip("\n\r") for line in f.readlines()])
975
1005
def is_ignored(self, filename):
976
1006
r"""Check whether the filename matches an ignore pattern.
978
Patterns containing '/' or '\' need to match the whole path;
979
others match against only the last component.
981
If the file is ignored, returns the pattern which caused it to
982
be ignored, otherwise None. So this can simply be used as a
983
boolean if desired."""
985
# TODO: Use '**' to match directories, and other extended
986
# globbing stuff from cvs/rsync.
988
# XXX: fnmatch is actually not quite what we want: it's only
989
# approximately the same as real Unix fnmatch, and doesn't
990
# treat dotfiles correctly and allows * to match /.
991
# Eventually it should be replaced with something more
994
for pat in self.get_ignore_list():
995
if '/' in pat or '\\' in pat:
997
# as a special case, you can put ./ at the start of a
998
# pattern; this is good to match in the top-level
1001
if (pat[:2] == './') or (pat[:2] == '.\\'):
1005
if fnmatch.fnmatchcase(filename, newpat):
1008
raise NotImplementedError(self.is_ignored)
1010
def stored_kind(self, path, file_id=None):
1011
"""See Tree.stored_kind"""
1012
raise NotImplementedError(self.stored_kind)
1014
def _comparison_data(self, entry, path):
1015
abspath = self.abspath(path)
1017
stat_value = os.lstat(abspath)
1018
except OSError as e:
1019
if getattr(e, 'errno', None) == errno.ENOENT:
1008
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1013
def kind(self, file_id):
1014
return file_kind(self.id2abspath(file_id))
1026
mode = stat_value.st_mode
1027
kind = osutils.file_kind_from_stat_mode(mode)
1028
if not self._supports_executable():
1029
executable = entry is not None and entry.executable
1031
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1032
return kind, executable, stat_value
1034
def _file_size(self, entry, stat_value):
1035
return stat_value.st_size
1017
1037
def last_revision(self):
1018
"""Return the last revision id of this working tree.
1020
In early branch formats this was == the branch last_revision,
1021
but that cannot be relied upon - for working tree operations,
1022
always use tree.last_revision().
1038
"""Return the last revision of the branch for this tree.
1040
This format tree does not support a separate marker for last-revision
1041
compared to the branch.
1043
See MutableTree.last_revision
1024
return self.branch.last_revision()
1045
return self._last_revision()
1047
def _last_revision(self):
1048
"""helper for get_parent_ids."""
1049
with self.lock_read():
1050
return _mod_revision.ensure_null(self.branch.last_revision())
1052
def is_locked(self):
1053
"""Check if this tree is locked."""
1054
raise NotImplementedError(self.is_locked)
1026
1056
def lock_read(self):
1027
"""See Branch.lock_read, and WorkingTree.unlock."""
1028
self.branch.lock_read()
1030
return self._control_files.lock_read()
1032
self.branch.unlock()
1057
"""Lock the tree for reading.
1059
This also locks the branch, and can be unlocked via self.unlock().
1061
:return: A breezy.lock.LogicalLockResult.
1063
raise NotImplementedError(self.lock_read)
1065
def lock_tree_write(self):
1066
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1068
:return: A breezy.lock.LogicalLockResult.
1070
raise NotImplementedError(self.lock_tree_write)
1035
1072
def lock_write(self):
1036
"""See Branch.lock_write, and WorkingTree.unlock."""
1037
self.branch.lock_write()
1039
return self._control_files.lock_write()
1041
self.branch.unlock()
1044
def _basis_inventory_name(self):
1045
return 'basis-inventory'
1073
"""See MutableTree.lock_write, and WorkingTree.unlock.
1075
:return: A breezy.lock.LogicalLockResult.
1077
raise NotImplementedError(self.lock_write)
1079
def get_physical_lock_status(self):
1080
raise NotImplementedError(self.get_physical_lock_status)
1048
1082
def set_last_revision(self, new_revision):
1049
1083
"""Change the last revision in the working tree."""
1050
if self._change_last_revision(new_revision):
1051
self._cache_basis_inventory(new_revision)
1084
raise NotImplementedError(self.set_last_revision)
1053
1086
def _change_last_revision(self, new_revision):
1054
1087
"""Template method part of set_last_revision to perform the change.
1056
1089
This is used to allow WorkingTree3 instances to not affect branch
1057
1090
when their last revision is set.
1059
if new_revision is None:
1060
self.branch.set_revision_history([])
1092
if _mod_revision.is_null(new_revision):
1093
self.branch.set_last_revision_info(0, new_revision)
1062
# current format is locked in with the branch
1063
revision_history = self.branch.revision_history()
1095
_mod_revision.check_not_reserved_id(new_revision)
1065
position = revision_history.index(new_revision)
1067
raise errors.NoSuchRevision(self.branch, new_revision)
1068
self.branch.set_revision_history(revision_history[:position + 1])
1097
self.branch.generate_revision_history(new_revision)
1098
except errors.NoSuchRevision:
1099
# not present in the repo - dont try to set it deeper than the tip
1100
self.branch._set_revision_history([new_revision])
1071
def _cache_basis_inventory(self, new_revision):
1072
"""Cache new_revision as the basis inventory."""
1074
# this double handles the inventory - unpack and repack -
1075
# but is easier to understand. We can/should put a conditional
1076
# in here based on whether the inventory is in the latest format
1077
# - perhaps we should repack all inventories on a repository
1079
inv = self.branch.repository.get_inventory(new_revision)
1080
inv.revision_id = new_revision
1081
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1083
path = self._basis_inventory_name()
1084
self._control_files.put_utf8(path, xml)
1085
except WeaveRevisionNotPresent:
1088
def read_basis_inventory(self):
1089
"""Read the cached basis inventory."""
1090
path = self._basis_inventory_name()
1091
return self._control_files.get_utf8(path).read()
1094
def read_working_inventory(self):
1095
"""Read the working inventory."""
1096
# ElementTree does its own conversion from UTF-8, so open in
1098
result = bzrlib.xml5.serializer_v5.read_inventory(
1099
self._control_files.get('inventory'))
1100
self._set_inventory(result)
1104
def remove(self, files, verbose=False):
1105
"""Remove nominated files from the working inventory..
1107
This does not remove their text. This does not run on XXX on what? RBC
1109
TODO: Refuse to remove modified files unless --force is given?
1111
TODO: Do something useful with directories.
1113
TODO: Should this remove the text or not? Tough call; not
1114
removing may be useful and the user can just use use rm, and
1115
is the opposite of add. Removing it is consistent with most
1116
other tools. Maybe an option.
1103
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1105
"""Remove nominated files from the working tree metadata.
1107
:files: File paths relative to the basedir.
1108
:keep_files: If true, the files will also be kept.
1109
:force: Delete files and directories, even if they are changed and
1110
even if the directories are not empty.
1118
## TODO: Normalize names
1119
## TODO: Remove nested loops; better scalability
1120
if isinstance(files, basestring):
1123
inv = self.inventory
1125
# do this before any modifications
1127
fid = inv.path2id(f)
1129
# TODO: Perhaps make this just a warning, and continue?
1130
# This tends to happen when
1131
raise NotVersionedError(path=f)
1132
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1134
# having remove it, it must be either ignored or unknown
1135
if self.is_ignored(f):
1112
raise NotImplementedError(self.remove)
1114
def revert(self, filenames=None, old_tree=None, backups=True,
1115
pb=None, report_changes=False):
1116
from .conflicts import resolve
1117
with self.lock_tree_write():
1118
if old_tree is None:
1119
basis_tree = self.basis_tree()
1120
basis_tree.lock_read()
1121
old_tree = basis_tree
1125
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1127
if filenames is None and len(self.get_parent_ids()) > 1:
1129
last_revision = self.last_revision()
1130
if last_revision != _mod_revision.NULL_REVISION:
1131
if basis_tree is None:
1132
basis_tree = self.basis_tree()
1133
basis_tree.lock_read()
1134
parent_trees.append((last_revision, basis_tree))
1135
self.set_parent_trees(parent_trees)
1139
show_status(new_status, inv[fid].kind, quotefn(f))
1142
self._write_inventory(inv)
1145
def revert(self, filenames, old_tree=None, backups=True,
1146
pb=DummyProgress()):
1147
from transform import revert
1148
from conflicts import resolve
1149
if old_tree is None:
1150
old_tree = self.basis_tree()
1151
conflicts = revert(self, old_tree, filenames, backups, pb)
1152
if not len(filenames):
1153
self.set_pending_merges([])
1156
resolve(self, filenames, ignore_misses=True)
1159
# XXX: This method should be deprecated in favour of taking in a proper
1160
# new Inventory object.
1162
def set_inventory(self, new_inventory_list):
1163
from bzrlib.inventory import (Inventory,
1168
inv = Inventory(self.get_root_id())
1169
for path, file_id, parent, kind in new_inventory_list:
1170
name = os.path.basename(path)
1173
# fixme, there should be a factory function inv,add_??
1174
if kind == 'directory':
1175
inv.add(InventoryDirectory(file_id, name, parent))
1176
elif kind == 'file':
1177
inv.add(InventoryFile(file_id, name, parent))
1178
elif kind == 'symlink':
1179
inv.add(InventoryLink(file_id, name, parent))
1181
raise BzrError("unknown kind %r" % kind)
1182
self._write_inventory(inv)
1138
resolve(self, filenames, ignore_misses=True, recursive=True)
1140
if basis_tree is not None:
1144
def store_uncommitted(self):
1145
"""Store uncommitted changes from the tree in the branch."""
1146
raise NotImplementedError(self.store_uncommitted)
1148
def restore_uncommitted(self):
1149
"""Restore uncommitted changes from the branch into the tree."""
1150
raise NotImplementedError(self.restore_uncommitted)
1152
def revision_tree(self, revision_id):
1153
"""See Tree.revision_tree.
1155
For trees that can be obtained from the working tree, this
1156
will do so. For other trees, it will fall back to the repository.
1158
raise NotImplementedError(self.revision_tree)
1185
1160
def set_root_id(self, file_id):
1186
1161
"""Set the root id for this tree."""
1187
inv = self.read_working_inventory()
1188
orig_root_id = inv.root.file_id
1189
del inv._byid[inv.root.file_id]
1190
inv.root.file_id = file_id
1191
inv._byid[inv.root.file_id] = inv.root
1194
if entry.parent_id == orig_root_id:
1195
entry.parent_id = inv.root.file_id
1196
self._write_inventory(inv)
1162
if not self.supports_setting_file_ids():
1163
raise SettingFileIdUnsupported()
1164
with self.lock_tree_write():
1168
'WorkingTree.set_root_id with fileid=None')
1169
file_id = osutils.safe_file_id(file_id)
1170
self._set_root_id(file_id)
1172
def _set_root_id(self, file_id):
1173
"""Set the root id for this tree, in a format specific manner.
1175
:param file_id: The file id to assign to the root. It must not be
1176
present in the current inventory or an error will occur. It must
1177
not be None, but rather a valid file id.
1179
raise NotImplementedError(self._set_root_id)
1198
1181
def unlock(self):
1199
1182
"""See Branch.unlock.
1201
1184
WorkingTree locking just uses the Branch locking facilities.
1202
1185
This is current because all working trees have an embedded branch
1203
1186
within them. IF in the future, we were to make branch data shareable
1204
between multiple working trees, i.e. via shared storage, then we
1187
between multiple working trees, i.e. via shared storage, then we
1205
1188
would probably want to lock both the local tree, and the branch.
1207
# FIXME: We want to write out the hashcache only when the last lock on
1208
# this working copy is released. Peeking at the lock count is a bit
1209
# of a nasty hack; probably it's better to have a transaction object,
1210
# which can do some finalization when it's either successfully or
1211
# unsuccessfully completed. (Denys's original patch did that.)
1212
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1213
# wrongly. Hookinh into unllock on the control files object is fine though.
1215
# TODO: split this per format so there is no ugly if block
1216
if self._hashcache.needs_write and (
1217
# dedicated lock files
1218
self._control_files._lock_count==1 or
1220
(self._control_files is self.branch.control_files and
1221
self._control_files._lock_count==3)):
1222
self._hashcache.write()
1223
# reverse order of locking.
1224
result = self._control_files.unlock()
1226
self.branch.unlock()
1190
raise NotImplementedError(self.unlock)
1194
def update(self, change_reporter=None, possible_transports=None,
1195
revision=None, old_tip=_marker, show_base=False):
1232
1196
"""Update a working tree along its branch.
1234
This will update the branch if its bound too, which means we have multiple trees involved:
1235
The new basis tree of the master.
1236
The old basis tree of the branch.
1237
The old basis tree of the working tree.
1238
The current working tree state.
1239
pathologically all three may be different, and non ancestors of each other.
1240
Conceptually we want to:
1241
Preserve the wt.basis->wt.state changes
1242
Transform the wt.basis to the new master basis.
1243
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1244
Restore the wt.basis->wt.state changes.
1198
This will update the branch if its bound too, which means we have
1199
multiple trees involved:
1201
- The new basis tree of the master.
1202
- The old basis tree of the branch.
1203
- The old basis tree of the working tree.
1204
- The current working tree state.
1206
Pathologically, all three may be different, and non-ancestors of each
1207
other. Conceptually we want to:
1209
- Preserve the wt.basis->wt.state changes
1210
- Transform the wt.basis to the new master basis.
1211
- Apply a merge of the old branch basis to get any 'local' changes from
1213
- Restore the wt.basis->wt.state changes.
1246
1215
There isn't a single operation at the moment to do that, so we:
1247
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1248
Do a 'normal' merge of the old branch basis if it is relevant.
1217
- Merge current state -> basis tree of the master w.r.t. the old tree
1219
- Do a 'normal' merge of the old branch basis if it is relevant.
1221
:param revision: The target revision to update to. Must be in the
1223
:param old_tip: If branch.update() has already been run, the value it
1224
returned (old tip of the branch or None). _marker is used
1250
old_tip = self.branch.update()
1251
if old_tip is not None:
1252
self.add_pending_merge(old_tip)
1253
self.branch.lock_read()
1227
if self.branch.get_bound_location() is not None:
1229
update_branch = (old_tip is self._marker)
1231
self.lock_tree_write()
1232
update_branch = False
1256
if self.last_revision() != self.branch.last_revision():
1257
# merge tree state up to new branch tip.
1235
old_tip = self.branch.update(possible_transports)
1237
if old_tip is self._marker:
1239
return self._update_tree(old_tip, change_reporter, revision, show_base)
1243
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1245
"""Update a tree to the master branch.
1247
:param old_tip: if supplied, the previous tip revision the branch,
1248
before it was changed to the master branch's tip.
1250
# here if old_tip is not None, it is the old tip of the branch before
1251
# it was updated from the master branch. This should become a pending
1252
# merge in the working tree to preserve the user existing work. we
1253
# cant set that until we update the working trees last revision to be
1254
# one from the new branch, because it will just get absorbed by the
1255
# parent de-duplication logic.
1257
# We MUST save it even if an error occurs, because otherwise the users
1258
# local work is unreferenced and will appear to have been lost.
1260
with self.lock_tree_write():
1263
last_rev = self.get_parent_ids()[0]
1265
last_rev = _mod_revision.NULL_REVISION
1266
if revision is None:
1267
revision = self.branch.last_revision()
1269
old_tip = old_tip or _mod_revision.NULL_REVISION
1271
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1272
# the branch we are bound to was updated
1273
# merge those changes in first
1274
base_tree = self.basis_tree()
1275
other_tree = self.branch.repository.revision_tree(old_tip)
1276
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1277
base_tree, this_tree=self,
1278
change_reporter=change_reporter,
1279
show_base=show_base)
1281
self.add_parent_tree((old_tip, other_tree))
1282
note(gettext('Rerun update after fixing the conflicts.'))
1285
if last_rev != _mod_revision.ensure_null(revision):
1286
# the working tree is up to date with the branch
1287
# we can merge the specified revision from master
1288
to_tree = self.branch.repository.revision_tree(revision)
1289
to_root_id = to_tree.get_root_id()
1258
1291
basis = self.basis_tree()
1259
to_tree = self.branch.basis_tree()
1260
result += merge_inner(self.branch,
1264
self.set_last_revision(self.branch.last_revision())
1265
if old_tip and old_tip != self.last_revision():
1266
# our last revision was not the prior branch last reivison
1267
# and we have converted that last revision to a pending merge.
1268
# base is somewhere between the branch tip now
1269
# and the now pending merge
1270
from bzrlib.revision import common_ancestor
1272
base_rev_id = common_ancestor(self.branch.last_revision(),
1274
self.branch.repository)
1275
except errors.NoCommonAncestor:
1292
with basis.lock_read():
1293
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1294
self.set_root_id(to_root_id)
1297
# determine the branch point
1298
graph = self.branch.repository.get_graph()
1299
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1277
1301
base_tree = self.branch.repository.revision_tree(base_rev_id)
1278
other_tree = self.branch.repository.revision_tree(old_tip)
1279
result += merge_inner(self.branch,
1285
self.branch.unlock()
1288
def _write_inventory(self, inv):
1289
"""Write inventory as the current inventory."""
1291
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1293
self._control_files.put('inventory', sio)
1294
self._set_inventory(inv)
1295
mutter('wrote working inventory')
1303
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1305
change_reporter=change_reporter,
1306
show_base=show_base)
1307
self.set_last_revision(revision)
1308
# TODO - dedup parents list with things merged by pull ?
1309
# reuse the tree we've updated to to set the basis:
1310
parent_trees = [(revision, to_tree)]
1311
merges = self.get_parent_ids()[1:]
1312
# Ideally we ask the tree for the trees here, that way the working
1313
# tree can decide whether to give us the entire tree or give us a
1314
# lazy initialised tree. dirstate for instance will have the trees
1315
# in ram already, whereas a last-revision + basis-inventory tree
1316
# will not, but also does not need them when setting parents.
1317
for parent in merges:
1318
parent_trees.append(
1319
(parent, self.branch.repository.revision_tree(parent)))
1320
if not _mod_revision.is_null(old_tip):
1321
parent_trees.append(
1322
(old_tip, self.branch.repository.revision_tree(old_tip)))
1323
self.set_parent_trees(parent_trees)
1324
last_rev = parent_trees[0][0]
1297
1327
def set_conflicts(self, arg):
1298
raise UnsupportedOperation(self.set_conflicts, self)
1328
raise errors.UnsupportedOperation(self.set_conflicts, self)
1330
def add_conflicts(self, arg):
1331
raise errors.UnsupportedOperation(self.add_conflicts, self)
1301
1333
def conflicts(self):
1302
conflicts = ConflictList()
1303
for conflicted in self._iter_conflicts():
1306
if file_kind(self.abspath(conflicted)) != "file":
1309
if e.errno == errno.ENOENT:
1314
for suffix in ('.THIS', '.OTHER'):
1316
kind = file_kind(self.abspath(conflicted+suffix))
1318
if e.errno == errno.ENOENT:
1334
raise NotImplementedError(self.conflicts)
1336
def walkdirs(self, prefix=""):
1337
"""Walk the directories of this tree.
1339
returns a generator which yields items in the form:
1340
((curren_directory_path, fileid),
1341
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1344
This API returns a generator, which is only valid during the current
1345
tree transaction - within a single lock_read or lock_write duration.
1347
If the tree is not locked, it may cause an error to be raised,
1348
depending on the tree implementation.
1350
raise NotImplementedError(self.walkdirs)
1352
def auto_resolve(self):
1353
"""Automatically resolve text conflicts according to contents.
1355
Only text conflicts are auto_resolvable. Files with no conflict markers
1356
are considered 'resolved', because bzr always puts conflict markers
1357
into files that have text conflicts. The corresponding .THIS .BASE and
1358
.OTHER files are deleted, as per 'resolve'.
1360
:return: a tuple of ConflictLists: (un_resolved, resolved).
1362
with self.lock_tree_write():
1363
un_resolved = _mod_conflicts.ConflictList()
1364
resolved = _mod_conflicts.ConflictList()
1365
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1366
for conflict in self.conflicts():
1367
if (conflict.typestring != 'text conflict' or
1368
self.kind(self.id2path(conflict.file_id), conflict.file_id) != 'file'):
1369
un_resolved.append(conflict)
1371
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1373
for line in my_file:
1374
if conflict_re.search(line):
1375
un_resolved.append(conflict)
1326
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
conflicts.append(Conflict.factory(ctype, path=conflicted,
1328
file_id=self.path2id(conflicted)))
1332
class WorkingTree3(WorkingTree):
1333
"""This is the Format 3 working tree.
1335
This differs from the base WorkingTree by:
1336
- having its own file lock
1337
- having its own last-revision property.
1339
This is new in bzr 0.8
1343
def last_revision(self):
1344
"""See WorkingTree.last_revision."""
1346
return self._control_files.get_utf8('last-revision').read()
1350
def _change_last_revision(self, revision_id):
1351
"""See WorkingTree._change_last_revision."""
1352
if revision_id is None or revision_id == NULL_REVISION:
1354
self._control_files._transport.delete('last-revision')
1355
except errors.NoSuchFile:
1360
self.branch.revision_history().index(revision_id)
1362
raise errors.NoSuchRevision(self.branch, revision_id)
1363
self._control_files.put_utf8('last-revision', revision_id)
1367
def set_conflicts(self, conflicts):
1368
self._put_rio('conflicts', conflicts.to_stanzas(),
1372
def conflicts(self):
1374
confile = self._control_files.get('conflicts')
1376
return ConflictList()
1378
if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
raise ConflictFormatError()
1380
except StopIteration:
1381
raise ConflictFormatError()
1382
return ConflictList.from_stanzas(RioReader(confile))
1385
def get_conflicted_stem(path):
1386
for suffix in CONFLICT_SUFFIXES:
1387
if path.endswith(suffix):
1388
return path[:-len(suffix)]
1390
@deprecated_function(zero_eight)
1391
def is_control_file(filename):
1392
"""See WorkingTree.is_control_filename(filename)."""
1393
## FIXME: better check
1394
filename = normpath(filename)
1395
while filename != '':
1396
head, tail = os.path.split(filename)
1397
## mutter('check %r for control file' % ((head, tail),))
1400
if filename == head:
1406
class WorkingTreeFormat(object):
1378
resolved.append(conflict)
1381
resolved.remove_files(self)
1382
self.set_conflicts(un_resolved)
1383
return un_resolved, resolved
1385
def _validate(self):
1386
"""Validate internal structures.
1388
This is meant mostly for the test suite. To give it a chance to detect
1389
corruption after actions have occurred. The default implementation is a
1392
:return: None. An exception should be raised if there is an error.
1396
def check_state(self):
1397
"""Check that the working state is/isn't valid."""
1398
raise NotImplementedError(self.check_state)
1400
def reset_state(self, revision_ids=None):
1401
"""Reset the state of the working tree.
1403
This does a hard-reset to a last-known-good state. This is a way to
1404
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1406
raise NotImplementedError(self.reset_state)
1408
def _get_rules_searcher(self, default_searcher):
1409
"""See Tree._get_rules_searcher."""
1410
if self._rules_searcher is None:
1411
self._rules_searcher = super(WorkingTree,
1412
self)._get_rules_searcher(default_searcher)
1413
return self._rules_searcher
1415
def get_shelf_manager(self):
1416
"""Return the ShelfManager for this WorkingTree."""
1417
raise NotImplementedError(self.get_shelf_manager)
1420
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
1421
"""Registry for working tree formats."""
1423
def __init__(self, other_registry=None):
1424
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1425
self._default_format = None
1426
self._default_format_key = None
1428
def get_default(self):
1429
"""Return the current default format."""
1430
if (self._default_format_key is not None and
1431
self._default_format is None):
1432
self._default_format = self.get(self._default_format_key)
1433
return self._default_format
1435
def set_default(self, format):
1436
"""Set the default format."""
1437
self._default_format = format
1438
self._default_format_key = None
1440
def set_default_key(self, format_string):
1441
"""Set the default format by its format string."""
1442
self._default_format_key = format_string
1443
self._default_format = None
1446
format_registry = WorkingTreeFormatRegistry()
1449
class WorkingTreeFormat(controldir.ControlComponentFormat):
1407
1450
"""An encapsulation of the initialization and open routines for a format.
1409
1452
Formats provide three things:
added
removed
breezy/workingtree.py
