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