308
path = os.path.getcwdu()
309
control = bzrdir.BzrDir.open(path, _unsupported)
310
return control.open_workingtree(_unsupported)
198
path = osutils.getcwd()
199
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
200
return control.open_workingtree(unsupported=_unsupported)
313
203
def open_containing(path=None):
314
204
"""Open an existing working tree which has its root about path.
316
206
This probes for a working tree at path and searches upwards from there.
318
208
Basically we keep looking up until we find the control directory or
319
209
run into /. If there isn't one, raises NotBranchError.
320
210
TODO: give this a new exception.
321
211
If there is one, it is returned, along with the unused portion of path.
213
:return: The WorkingTree that contains 'path', and the rest of path
325
control, relpath = bzrdir.BzrDir.open_containing(path)
216
path = osutils.getcwd()
217
control, relpath = controldir.ControlDir.open_containing(path)
326
218
return control.open_workingtree(), relpath
221
def open_containing_paths(file_list, default_directory=None,
222
canonicalize=True, apply_view=True):
223
"""Open the WorkingTree that contains a set of paths.
225
Fail if the paths given are not all in a single tree.
227
This is used for the many command-line interfaces that take a list of
228
any number of files and that require they all be in the same tree.
230
if default_directory is None:
231
default_directory = u'.'
232
# recommended replacement for builtins.internal_tree_files
233
if file_list is None or len(file_list) == 0:
234
tree = WorkingTree.open_containing(default_directory)[0]
235
# XXX: doesn't really belong here, and seems to have the strange
236
# side effect of making it return a bunch of files, not the whole
237
# tree -- mbp 20100716
238
if tree.supports_views() and apply_view:
239
view_files = tree.views.lookup_view()
241
file_list = view_files
242
view_str = views.view_display_str(view_files)
243
note(gettext("Ignoring files outside view. View is %s") % view_str)
244
return tree, file_list
245
if default_directory == u'.':
248
seed = default_directory
249
file_list = [osutils.pathjoin(default_directory, f)
251
tree = WorkingTree.open_containing(seed)[0]
252
return tree, tree.safe_relpath_files(file_list, canonicalize,
253
apply_view=apply_view)
255
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
256
"""Convert file_list into a list of relpaths in tree.
258
:param self: A tree to operate on.
259
:param file_list: A list of user provided paths or None.
260
:param apply_view: if True and a view is set, apply it or check that
261
specified files are within it
262
:return: A list of relative paths.
263
:raises errors.PathNotChild: When a provided path is in a different self
266
if file_list is None:
268
if self.supports_views() and apply_view:
269
view_files = self.views.lookup_view()
273
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
274
# doesn't - fix that up here before we enter the loop.
277
return osutils.canonical_relpath(self.basedir, p)
280
for filename in file_list:
281
relpath = fixer(osutils.dereference_path(filename))
282
if view_files and not osutils.is_inside_any(view_files, relpath):
283
raise views.FileOutsideView(filename, view_files)
284
new_list.append(relpath)
329
288
def open_downlevel(path=None):
330
289
"""Open an unsupported working tree.
332
Only intended for advanced situations like upgrading part of a bzrdir.
291
Only intended for advanced situations like upgrading part of a controldir.
334
293
return WorkingTree.open(path, _unsupported=True)
337
"""Iterate through file_ids for this tree.
296
def find_trees(location):
297
def list_current(transport):
298
return [d for d in transport.list_dir('')
299
if not controldir.is_control_filename(d)]
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)):
301
def evaluate(controldir):
303
tree = controldir.open_workingtree()
304
except errors.NoWorkingTree:
308
t = transport.get_transport(location)
309
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
310
list_current=list_current)
311
return [tr for tr in iterator if tr is not None]
347
313
def __repr__(self):
348
314
return "<%s of %s>" % (self.__class__.__name__,
349
315
getattr(self, 'basedir', None))
351
317
def abspath(self, filename):
352
return pathjoin(self.basedir, filename)
318
return osutils.pathjoin(self.basedir, filename)
354
320
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)
321
"""Return RevisionTree for the current last revision.
323
If the left most parent is a ghost then the returned tree will be an
324
empty tree - one obtained by calling
325
repository.revision_tree(NULL_REVISION).
328
revision_id = self.get_parent_ids()[0]
330
# no parents, return an empty revision tree.
331
# in the future this should return the tree for
332
# 'empty:' - the implicit root empty tree.
333
return self.branch.repository.revision_tree(
334
_mod_revision.NULL_REVISION)
336
return self.revision_tree(revision_id)
337
except errors.NoSuchRevision:
339
# No cached copy available, retrieve from the repository.
340
# FIXME? RBC 20060403 should we cache the tree locally
343
return self.branch.repository.revision_tree(revision_id)
344
except (errors.RevisionNotPresent, errors.NoSuchRevision):
345
# the basis tree *may* be a ghost or a low level error may have
346
# occurred. If the revision is present, its a problem, if its not
348
if self.branch.repository.has_revision(revision_id):
350
# the basis tree is a ghost so return an empty tree.
351
return self.branch.repository.revision_tree(
352
_mod_revision.NULL_REVISION)
354
def relpath(self, path):
355
"""Return the local path portion from a given path.
357
The path may be absolute or relative. If its a relative path it is
358
interpreted relative to the python current working directory.
360
return osutils.relpath(self.basedir, path)
411
362
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')
363
return osutils.lexists(self.abspath(filename))
365
def get_file(self, path, file_id=None, filtered=True):
366
return self.get_file_with_stat(path, file_id, filtered=filtered)[0]
368
def get_file_with_stat(self, path, file_id=None, filtered=True,
369
_fstat=osutils.fstat):
370
"""See Tree.get_file_with_stat."""
371
abspath = self.abspath(path)
373
file_obj = open(abspath, 'rb')
374
except EnvironmentError as e:
375
if e.errno == errno.ENOENT:
376
raise errors.NoSuchFile(path)
378
stat_value = _fstat(file_obj.fileno())
379
if filtered and self.supports_content_filtering():
380
filters = self._content_filter_stack(path)
381
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
382
return (file_obj, stat_value)
384
def get_file_text(self, path, file_id=None, filtered=True):
385
with self.get_file(path, file_id, filtered=filtered) as my_file:
386
return my_file.read()
388
def get_file_lines(self, path, file_id=None, filtered=True):
389
"""See Tree.get_file_lines()"""
390
with self.get_file(path, file_id, filtered=filtered) as file:
391
return file.readlines()
393
def get_parent_ids(self):
394
"""See Tree.get_parent_ids.
396
This implementation reads the pending merges list and last_revision
397
value and uses that to decide what the parents list should be.
399
last_rev = _mod_revision.ensure_null(self._last_revision())
400
if _mod_revision.NULL_REVISION == last_rev:
405
merges_bytes = self._transport.get_bytes('pending-merges')
406
except errors.NoSuchFile:
409
for l in osutils.split_lines(merges_bytes):
410
revision_id = l.rstrip(b'\n')
411
parents.append(revision_id)
420
414
def get_root_id(self):
421
415
"""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))
416
raise NotImplementedError(self.get_root_id)
430
def clone(self, to_bzrdir, revision_id=None, basis=None):
418
def clone(self, to_controldir, revision_id=None):
431
419
"""Duplicate this working tree into to_bzr, including all state.
433
421
Specifically modified files are kept as modified, but
434
422
ignored and unknown files are discarded.
436
If you want to make a new line of development, see bzrdir.sprout()
424
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
427
If not None, the cloned tree will have its last revision set to
428
revision, and difference between the source trees last revision
441
429
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)
431
with self.lock_read():
432
# assumes the target bzr dir format is compatible.
433
result = to_controldir.create_workingtree()
434
self.copy_content_into(result, revision_id)
453
437
def copy_content_into(self, tree, revision_id=None):
454
438
"""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)
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())
477
def id2abspath(self, file_id):
478
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)
439
with self.lock_read():
440
tree.set_root_id(self.get_root_id())
441
if revision_id is None:
442
merge.transform_tree(tree, self)
444
# TODO now merge from tree.last_revision to revision (to
445
# preserve user local changes)
447
other_tree = self.revision_tree(revision_id)
448
except errors.NoSuchRevision:
449
other_tree = self.branch.repository.revision_tree(
452
merge.transform_tree(tree, other_tree)
453
if revision_id == _mod_revision.NULL_REVISION:
456
new_parents = [revision_id]
457
tree.set_parent_ids(new_parents)
459
def get_file_size(self, path, file_id=None):
460
"""See Tree.get_file_size"""
461
# XXX: this returns the on-disk size; it should probably return the
464
return os.path.getsize(self.abspath(path))
466
if e.errno != errno.ENOENT:
471
def _gather_kinds(self, files, kinds):
472
"""See MutableTree._gather_kinds."""
473
with self.lock_tree_write():
474
for pos, f in enumerate(files):
475
if kinds[pos] is None:
476
fullpath = osutils.normpath(self.abspath(f))
478
kinds[pos] = osutils.file_kind(fullpath)
480
if e.errno == errno.ENOENT:
481
raise errors.NoSuchFile(fullpath)
483
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
484
"""Add revision_id as a parent.
486
This is equivalent to retrieving the current list of parent ids
487
and setting the list to its value plus revision_id.
489
:param revision_id: The revision id to add to the parent list. It may
490
be a ghost revision as long as its not the first parent to be
491
added, or the allow_leftmost_as_ghost parameter is set True.
492
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
494
with self.lock_write():
495
parents = self.get_parent_ids() + [revision_id]
496
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
497
or allow_leftmost_as_ghost)
499
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
500
"""Add revision_id, tree tuple as a parent.
502
This is equivalent to retrieving the current list of parent trees
503
and setting the list to its value plus parent_tuple. See also
504
add_parent_tree_id - if you only have a parent id available it will be
505
simpler to use that api. If you have the parent already available, using
506
this api is preferred.
508
:param parent_tuple: The (revision id, tree) to add to the parent list.
509
If the revision_id is a ghost, pass None for the tree.
510
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
512
with self.lock_tree_write():
513
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
514
if len(parent_ids) > 1:
515
# the leftmost may have already been a ghost, preserve that if it
517
allow_leftmost_as_ghost = True
518
self.set_parent_ids(parent_ids,
519
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
579
521
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.
522
with self.lock_tree_write():
523
# TODO: Perhaps should check at this point that the
524
# history of the revision is actually present?
525
parents = self.get_parent_ids()
527
for rev_id in revision_ids:
528
if rev_id in parents:
530
parents.append(rev_id)
533
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
535
def path_content_summary(self, path, _lstat=os.lstat,
536
_mapper=osutils.file_kind_from_stat_mode):
537
"""See Tree.path_content_summary."""
538
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'))
540
stat_result = _lstat(abspath)
542
if getattr(e, 'errno', None) == errno.ENOENT:
544
return ('missing', None, None, None)
545
# propagate other errors
547
kind = _mapper(stat_result.st_mode)
549
return self._file_content_summary(path, stat_result)
550
elif kind == 'directory':
551
# perhaps it looks like a plain directory, but it's really a
553
if self._directory_is_tree_reference(path):
554
kind = 'tree-reference'
555
return kind, None, None, None
556
elif kind == 'symlink':
557
target = osutils.readlink(abspath)
558
return ('symlink', None, None, target)
560
return (kind, None, None, None)
562
def _file_content_summary(self, path, stat_result):
563
size = stat_result.st_size
564
executable = self._is_executable_from_path_and_stat(path, stat_result)
565
# try for a stat cache lookup
566
return ('file', size, executable, self._sha_from_stat(
569
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
570
"""Common ghost checking functionality from set_parent_*.
572
This checks that the left hand-parent exists if there are any
575
if len(revision_ids) > 0:
576
leftmost_id = revision_ids[0]
577
if (not allow_leftmost_as_ghost and not
578
self.branch.repository.has_revision(leftmost_id)):
579
raise errors.GhostRevisionUnusableHere(leftmost_id)
581
def _set_merges_from_parent_ids(self, parent_ids):
582
merges = parent_ids[1:]
583
self._transport.put_bytes('pending-merges', b'\n'.join(merges),
584
mode=self.controldir._get_file_mode())
586
def _filter_parent_ids_by_ancestry(self, revision_ids):
587
"""Check that all merged revisions are proper 'heads'.
589
This will always return the first revision_id, and any merged revisions
592
if len(revision_ids) == 0:
594
graph = self.branch.repository.get_graph()
595
heads = graph.heads(revision_ids)
596
new_revision_ids = revision_ids[:1]
597
for revision_id in revision_ids[1:]:
598
if revision_id in heads and revision_id not in new_revision_ids:
599
new_revision_ids.append(revision_id)
600
if new_revision_ids != revision_ids:
601
mutter('requested to set revision_ids = %s,'
602
' but filtered to %s', revision_ids, new_revision_ids)
603
return new_revision_ids
605
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
606
"""Set the parent ids to revision_ids.
608
See also set_parent_trees. This api will try to retrieve the tree data
609
for each element of revision_ids from the trees repository. If you have
610
tree data already available, it is more efficient to use
611
set_parent_trees rather than set_parent_ids. set_parent_ids is however
612
an easier API to use.
614
:param revision_ids: The revision_ids to set as the parent ids of this
615
working tree. Any of these may be ghosts.
617
with self.lock_tree_write():
618
self._check_parents_for_ghosts(revision_ids,
619
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
620
for revision_id in revision_ids:
621
_mod_revision.check_not_reserved_id(revision_id)
623
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
625
if len(revision_ids) > 0:
626
self.set_last_revision(revision_ids[0])
628
self.set_last_revision(_mod_revision.NULL_REVISION)
630
self._set_merges_from_parent_ids(revision_ids)
611
632
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
633
with self.lock_tree_write():
634
parents = self.get_parent_ids()
635
leftmost = parents[:1]
636
new_parents = leftmost + rev_list
637
self.set_parent_ids(new_parents)
615
639
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)
640
"""Set the merge modified hashes."""
641
raise NotImplementedError(self.set_merge_modified)
643
def _sha_from_stat(self, path, stat_result):
644
"""Get a sha digest from the tree's stat cache.
646
The default implementation assumes no stat cache is present.
648
:param path: The path.
649
:param stat_result: The stat result being looked up.
653
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
654
merge_type=None, force=False):
655
"""Merge from a branch into this working tree.
657
:param branch: The branch to merge from.
658
:param to_revision: If non-None, the merge will merge to to_revision,
659
but not beyond it. to_revision does not need to be in the history
660
of the branch when it is supplied. If None, to_revision defaults to
661
branch.last_revision().
663
from .merge import Merger, Merge3Merger
664
with self.lock_write():
665
merger = Merger(self.branch, this_tree=self)
666
# check that there are no local alterations
667
if not force and self.has_changes():
668
raise errors.UncommittedChanges(self)
669
if to_revision is None:
670
to_revision = _mod_revision.ensure_null(branch.last_revision())
671
merger.other_rev_id = to_revision
672
if _mod_revision.is_null(merger.other_rev_id):
673
raise errors.NoCommits(branch)
674
self.branch.fetch(branch, last_revision=merger.other_rev_id)
675
merger.other_basis = merger.other_rev_id
676
merger.other_tree = self.branch.repository.revision_tree(
678
merger.other_branch = branch
679
if from_revision is None:
682
merger.set_base_revision(from_revision, branch)
683
if merger.base_rev_id == merger.other_rev_id:
684
raise errors.PointlessMerge
685
merger.backup_files = False
686
if merge_type is None:
687
merger.merge_type = Merge3Merger
689
merger.merge_type = merge_type
690
merger.set_interesting_files(None)
691
merger.show_base = False
692
merger.reprocess = False
693
conflicts = merger.do_merge()
627
697
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).
698
"""Return a dictionary of files modified by a merge.
700
The list is initialized by WorkingTree.set_merge_modified, which is
701
typically called after we make some automatic updates to the tree
704
This returns a map of file_id->sha1, containing only files which are
705
still in the working tree and have that text hash.
707
raise NotImplementedError(self.merge_modified)
709
def mkdir(self, path, file_id=None):
710
"""See MutableTree.mkdir()."""
712
if self.supports_setting_file_ids():
713
file_id = generate_ids.gen_file_id(os.path.basename(path))
715
if not self.supports_setting_file_ids():
716
raise SettingFileIdUnsupported()
717
with self.lock_write():
718
os.mkdir(self.abspath(path))
719
self.add(path, file_id, 'directory')
722
def get_symlink_target(self, path, file_id=None):
723
abspath = self.abspath(path)
724
target = osutils.readlink(abspath)
727
def subsume(self, other_tree):
728
raise NotImplementedError(self.subsume)
730
def _setup_directory_is_tree_reference(self):
731
if self._branch.repository._format.supports_tree_reference:
732
self._directory_is_tree_reference = \
733
self._directory_may_be_tree_reference
735
self._directory_is_tree_reference = \
736
self._directory_is_never_tree_reference
738
def _directory_is_never_tree_reference(self, relpath):
741
def _directory_may_be_tree_reference(self, relpath):
742
# as a special case, if a directory contains control files then
743
# it's a tree reference, except that the root of the tree is not
744
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
745
# TODO: We could ask all the control formats whether they
746
# recognize this directory, but at the moment there's no cheap api
747
# to do that. Since we probably can only nest bzr checkouts and
748
# they always use this name it's ok for now. -- mbp 20060306
750
# FIXME: There is an unhandled case here of a subdirectory
751
# containing .bzr but not a branch; that will probably blow up
752
# when you try to commit it. It might happen if there is a
753
# checkout in a subdirectory. This can be avoided by not adding
756
def extract(self, path, file_id=None, format=None):
757
"""Extract a subtree from this tree.
759
A new branch will be created, relative to the path for this tree.
761
raise NotImplementedError(self.extract)
764
"""Write the in memory meta data to disk."""
765
raise NotImplementedError(self.flush)
767
def kind(self, relpath, file_id=None):
768
return osutils.file_kind(self.abspath(relpath))
770
def list_files(self, include_root=False, from_dir=None, recursive=True):
771
"""List all files as (path, class, kind, id, entry).
661
773
Lists, but does not descend into unversioned directories.
663
774
This does not include files that have been deleted in this
775
tree. Skips the control directory.
666
Skips the control directory.
777
:param include_root: if True, return an entry for the root
778
:param from_dir: start from this directory or None for the root
779
: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):
781
raise NotImplementedError(self.list_files)
783
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;
786
to_dir must be known to the working tree.
788
If to_dir exists and is a directory, the files are moved into
789
it, keeping their old names.
791
Note that to_dir is only the last component of the new name;
742
792
this doesn't change the directory.
794
For each entry in from_paths the move mode will be determined
797
The first mode moves the file in the filesystem and updates the
798
working tree metadata. The second mode only updates the working tree
799
metadata without touching the file on the filesystem.
801
move uses the second mode if 'after == True' and the target is not
802
versioned but present in the working tree.
804
move uses the second mode if 'after == False' and the source is
805
versioned but no longer in the working tree, and the target is not
806
versioned but present in the working tree.
808
move uses the first mode if 'after == False' and the source is
809
versioned and present in the working tree, and the target is not
810
versioned and not present in the working tree.
812
Everything else results in an error.
744
814
This returns a list of (from_path, to_path) pairs for each
745
815
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):
805
This can change the directory or the filename or both.
817
raise NotImplementedError(self.move)
819
def copy_one(self, from_rel, to_rel):
820
"""Copy a file in the tree to a new location.
822
This default implementation just copies the file, then
825
:param from_rel: From location (relative to tree root)
826
:param to_rel: Target location (relative to tree root)
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)
828
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
850
831
def unknowns(self):
851
832
"""Return all unknown files.
853
834
These are files in the working directory that are not versioned or
854
835
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()
837
with self.lock_read():
838
# force the extras method to be fully executed before returning, to
839
# prevent race conditions with the lock
841
[subp for subp in self.extras() if not self.is_ignored(subp)])
843
def unversion(self, paths):
844
"""Remove the path in pahs from the current versioned set.
846
When a path is unversioned, all of its children are automatically
849
:param paths: The paths to stop versioning.
850
:raises NoSuchFile: if any path is not currently versioned.
852
raise NotImplementedError(self.unversion)
854
def pull(self, source, overwrite=False, stop_revision=None,
855
change_reporter=None, possible_transports=None, local=False,
857
with self.lock_write(), source.lock_read():
858
old_revision_info = self.branch.last_revision_info()
897
859
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
860
count = self.branch.pull(source, overwrite, stop_revision,
861
possible_transports=possible_transports,
863
new_revision_info = self.branch.last_revision_info()
864
if new_revision_info != old_revision_info:
906
865
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())
866
if repository._format.fast_deltas:
867
parent_ids = self.get_parent_ids()
869
basis_id = parent_ids[0]
870
basis_tree = repository.revision_tree(basis_id)
871
with basis_tree.lock_read():
872
new_basis_tree = self.branch.basis_tree()
878
change_reporter=change_reporter,
880
basis_root_id = basis_tree.get_root_id()
881
new_root_id = new_basis_tree.get_root_id()
882
if new_root_id is not None and basis_root_id != new_root_id:
883
self.set_root_id(new_root_id)
884
# TODO - dedup parents list with things merged by pull ?
885
# reuse the revisiontree we merged against to set the new
888
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
890
(self.branch.last_revision(), new_basis_tree))
891
# we have to pull the merge trees out again, because
892
# merge_inner has set the ids. - this corner is not yet
893
# layered well enough to prevent double handling.
894
# XXX TODO: Fix the double handling: telling the tree about
895
# the already known parent data is wasteful.
896
merges = self.get_parent_ids()[1:]
897
parent_trees.extend([
898
(parent, repository.revision_tree(parent)) for
900
self.set_parent_trees(parent_trees)
903
def put_file_bytes_non_atomic(self, path, bytes, file_id=None):
904
"""See MutableTree.put_file_bytes_non_atomic."""
905
with self.lock_write(), open(self.abspath(path), 'wb') as stream:
922
908
def extras(self):
923
"""Yield all unknown files in this WorkingTree.
909
"""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
927
under a versioned subdirectory, they are returned.
911
If there are any unversioned directories and the file format
912
supports versioning directories, then only the directory is returned,
913
not all its children. But if there are unversioned files under a
914
versioned subdirectory, they are returned.
929
916
Currently returned depth-first, sorted by name within directories.
917
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)
919
raise NotImplementedError(self.extras)
951
921
def ignored_files(self):
952
922
"""Yield list of PATH, IGNORE_PATTERN"""
953
923
for subp in self.extras():
954
924
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
928
def is_ignored(self, filename):
976
929
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):
931
raise NotImplementedError(self.is_ignored)
933
def stored_kind(self, path, file_id=None):
934
"""See Tree.stored_kind"""
935
raise NotImplementedError(self.stored_kind)
937
def _comparison_data(self, entry, path):
938
abspath = self.abspath(path)
940
stat_value = os.lstat(abspath)
942
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))
949
mode = stat_value.st_mode
950
kind = osutils.file_kind_from_stat_mode(mode)
951
if not self._supports_executable():
952
executable = entry is not None and entry.executable
954
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
955
return kind, executable, stat_value
1017
957
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().
958
"""Return the last revision of the branch for this tree.
960
This format tree does not support a separate marker for last-revision
961
compared to the branch.
963
See MutableTree.last_revision
1024
return self.branch.last_revision()
965
return self._last_revision()
967
def _last_revision(self):
968
"""helper for get_parent_ids."""
969
with self.lock_read():
970
return _mod_revision.ensure_null(self.branch.last_revision())
973
"""Check if this tree is locked."""
974
raise NotImplementedError(self.is_locked)
1026
976
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()
977
"""Lock the tree for reading.
979
This also locks the branch, and can be unlocked via self.unlock().
981
:return: A breezy.lock.LogicalLockResult.
983
raise NotImplementedError(self.lock_read)
985
def lock_tree_write(self):
986
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
988
:return: A breezy.lock.LogicalLockResult.
990
raise NotImplementedError(self.lock_tree_write)
1035
992
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'
993
"""See MutableTree.lock_write, and WorkingTree.unlock.
995
:return: A breezy.lock.LogicalLockResult.
997
raise NotImplementedError(self.lock_write)
999
def get_physical_lock_status(self):
1000
raise NotImplementedError(self.get_physical_lock_status)
1048
1002
def set_last_revision(self, new_revision):
1049
1003
"""Change the last revision in the working tree."""
1050
if self._change_last_revision(new_revision):
1051
self._cache_basis_inventory(new_revision)
1004
raise NotImplementedError(self.set_last_revision)
1053
1006
def _change_last_revision(self, new_revision):
1054
1007
"""Template method part of set_last_revision to perform the change.
1056
1009
This is used to allow WorkingTree3 instances to not affect branch
1057
1010
when their last revision is set.
1059
if new_revision is None:
1060
self.branch.set_revision_history([])
1012
if _mod_revision.is_null(new_revision):
1013
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()
1015
_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])
1017
self.branch.generate_revision_history(new_revision)
1018
except errors.NoSuchRevision:
1019
# not present in the repo - dont try to set it deeper than the tip
1020
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.
1023
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1025
"""Remove nominated files from the working tree metadata.
1027
:files: File paths relative to the basedir.
1028
:keep_files: If true, the files will also be kept.
1029
:force: Delete files and directories, even if they are changed and
1030
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):
1032
raise NotImplementedError(self.remove)
1034
def revert(self, filenames=None, old_tree=None, backups=True,
1035
pb=None, report_changes=False):
1036
from .conflicts import resolve
1037
with self.lock_tree_write():
1038
if old_tree is None:
1039
basis_tree = self.basis_tree()
1040
basis_tree.lock_read()
1041
old_tree = basis_tree
1045
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1047
if filenames is None and len(self.get_parent_ids()) > 1:
1049
last_revision = self.last_revision()
1050
if last_revision != _mod_revision.NULL_REVISION:
1051
if basis_tree is None:
1052
basis_tree = self.basis_tree()
1053
basis_tree.lock_read()
1054
parent_trees.append((last_revision, basis_tree))
1055
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)
1058
resolve(self, filenames, ignore_misses=True, recursive=True)
1060
if basis_tree is not None:
1064
def store_uncommitted(self):
1065
"""Store uncommitted changes from the tree in the branch."""
1066
raise NotImplementedError(self.store_uncommitted)
1068
def restore_uncommitted(self):
1069
"""Restore uncommitted changes from the branch into the tree."""
1070
raise NotImplementedError(self.restore_uncommitted)
1072
def revision_tree(self, revision_id):
1073
"""See Tree.revision_tree.
1075
For trees that can be obtained from the working tree, this
1076
will do so. For other trees, it will fall back to the repository.
1078
raise NotImplementedError(self.revision_tree)
1185
1080
def set_root_id(self, file_id):
1186
1081
"""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)
1082
if not self.supports_setting_file_ids():
1083
raise SettingFileIdUnsupported()
1084
with self.lock_tree_write():
1088
'WorkingTree.set_root_id with fileid=None')
1089
file_id = osutils.safe_file_id(file_id)
1090
self._set_root_id(file_id)
1092
def _set_root_id(self, file_id):
1093
"""Set the root id for this tree, in a format specific manner.
1095
:param file_id: The file id to assign to the root. It must not be
1096
present in the current inventory or an error will occur. It must
1097
not be None, but rather a valid file id.
1099
raise NotImplementedError(self._set_root_id)
1198
1101
def unlock(self):
1199
1102
"""See Branch.unlock.
1201
1104
WorkingTree locking just uses the Branch locking facilities.
1202
1105
This is current because all working trees have an embedded branch
1203
1106
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
1107
between multiple working trees, i.e. via shared storage, then we
1205
1108
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()
1110
raise NotImplementedError(self.unlock)
1114
def update(self, change_reporter=None, possible_transports=None,
1115
revision=None, old_tip=_marker, show_base=False):
1232
1116
"""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.
1118
This will update the branch if its bound too, which means we have
1119
multiple trees involved:
1121
- The new basis tree of the master.
1122
- The old basis tree of the branch.
1123
- The old basis tree of the working tree.
1124
- The current working tree state.
1126
Pathologically, all three may be different, and non-ancestors of each
1127
other. Conceptually we want to:
1129
- Preserve the wt.basis->wt.state changes
1130
- Transform the wt.basis to the new master basis.
1131
- Apply a merge of the old branch basis to get any 'local' changes from
1133
- Restore the wt.basis->wt.state changes.
1246
1135
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.
1137
- Merge current state -> basis tree of the master w.r.t. the old tree
1139
- Do a 'normal' merge of the old branch basis if it is relevant.
1141
:param revision: The target revision to update to. Must be in the
1143
:param old_tip: If branch.update() has already been run, the value it
1144
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()
1147
if self.branch.get_bound_location() is not None:
1149
update_branch = (old_tip is self._marker)
1151
self.lock_tree_write()
1152
update_branch = False
1256
if self.last_revision() != self.branch.last_revision():
1257
# merge tree state up to new branch tip.
1155
old_tip = self.branch.update(possible_transports)
1157
if old_tip is self._marker:
1159
return self._update_tree(old_tip, change_reporter, revision, show_base)
1163
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1165
"""Update a tree to the master branch.
1167
:param old_tip: if supplied, the previous tip revision the branch,
1168
before it was changed to the master branch's tip.
1170
# here if old_tip is not None, it is the old tip of the branch before
1171
# it was updated from the master branch. This should become a pending
1172
# merge in the working tree to preserve the user existing work. we
1173
# cant set that until we update the working trees last revision to be
1174
# one from the new branch, because it will just get absorbed by the
1175
# parent de-duplication logic.
1177
# We MUST save it even if an error occurs, because otherwise the users
1178
# local work is unreferenced and will appear to have been lost.
1180
with self.lock_tree_write():
1183
last_rev = self.get_parent_ids()[0]
1185
last_rev = _mod_revision.NULL_REVISION
1186
if revision is None:
1187
revision = self.branch.last_revision()
1189
old_tip = old_tip or _mod_revision.NULL_REVISION
1191
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1192
# the branch we are bound to was updated
1193
# merge those changes in first
1194
base_tree = self.basis_tree()
1195
other_tree = self.branch.repository.revision_tree(old_tip)
1196
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1197
base_tree, this_tree=self,
1198
change_reporter=change_reporter,
1199
show_base=show_base)
1201
self.add_parent_tree((old_tip, other_tree))
1202
note(gettext('Rerun update after fixing the conflicts.'))
1205
if last_rev != _mod_revision.ensure_null(revision):
1206
# the working tree is up to date with the branch
1207
# we can merge the specified revision from master
1208
to_tree = self.branch.repository.revision_tree(revision)
1209
to_root_id = to_tree.get_root_id()
1258
1211
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:
1212
with basis.lock_read():
1213
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1214
self.set_root_id(to_root_id)
1217
# determine the branch point
1218
graph = self.branch.repository.get_graph()
1219
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1277
1221
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')
1223
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1225
change_reporter=change_reporter,
1226
show_base=show_base)
1227
self.set_last_revision(revision)
1228
# TODO - dedup parents list with things merged by pull ?
1229
# reuse the tree we've updated to to set the basis:
1230
parent_trees = [(revision, to_tree)]
1231
merges = self.get_parent_ids()[1:]
1232
# Ideally we ask the tree for the trees here, that way the working
1233
# tree can decide whether to give us the entire tree or give us a
1234
# lazy initialised tree. dirstate for instance will have the trees
1235
# in ram already, whereas a last-revision + basis-inventory tree
1236
# will not, but also does not need them when setting parents.
1237
for parent in merges:
1238
parent_trees.append(
1239
(parent, self.branch.repository.revision_tree(parent)))
1240
if not _mod_revision.is_null(old_tip):
1241
parent_trees.append(
1242
(old_tip, self.branch.repository.revision_tree(old_tip)))
1243
self.set_parent_trees(parent_trees)
1244
last_rev = parent_trees[0][0]
1297
1247
def set_conflicts(self, arg):
1298
raise UnsupportedOperation(self.set_conflicts, self)
1248
raise errors.UnsupportedOperation(self.set_conflicts, self)
1250
def add_conflicts(self, arg):
1251
raise errors.UnsupportedOperation(self.add_conflicts, self)
1301
1253
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:
1254
raise NotImplementedError(self.conflicts)
1256
def walkdirs(self, prefix=""):
1257
"""Walk the directories of this tree.
1259
returns a generator which yields items in the form:
1260
((curren_directory_path, fileid),
1261
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1264
This API returns a generator, which is only valid during the current
1265
tree transaction - within a single lock_read or lock_write duration.
1267
If the tree is not locked, it may cause an error to be raised,
1268
depending on the tree implementation.
1270
raise NotImplementedError(self.walkdirs)
1272
def auto_resolve(self):
1273
"""Automatically resolve text conflicts according to contents.
1275
Only text conflicts are auto_resolvable. Files with no conflict markers
1276
are considered 'resolved', because bzr always puts conflict markers
1277
into files that have text conflicts. The corresponding .THIS .BASE and
1278
.OTHER files are deleted, as per 'resolve'.
1280
:return: a tuple of ConflictLists: (un_resolved, resolved).
1282
with self.lock_tree_write():
1283
un_resolved = _mod_conflicts.ConflictList()
1284
resolved = _mod_conflicts.ConflictList()
1285
conflict_re = re.compile(b'^(<{7}|={7}|>{7})')
1286
for conflict in self.conflicts():
1287
path = self.id2path(conflict.file_id)
1288
if (conflict.typestring != 'text conflict' or
1289
self.kind(path) != 'file'):
1290
un_resolved.append(conflict)
1292
with open(self.abspath(path), 'rb') as my_file:
1293
for line in my_file:
1294
if conflict_re.search(line):
1295
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):
1298
resolved.append(conflict)
1299
resolved.remove_files(self)
1300
self.set_conflicts(un_resolved)
1301
return un_resolved, resolved
1303
def _validate(self):
1304
"""Validate internal structures.
1306
This is meant mostly for the test suite. To give it a chance to detect
1307
corruption after actions have occurred. The default implementation is a
1310
:return: None. An exception should be raised if there is an error.
1314
def check_state(self):
1315
"""Check that the working state is/isn't valid."""
1316
raise NotImplementedError(self.check_state)
1318
def reset_state(self, revision_ids=None):
1319
"""Reset the state of the working tree.
1321
This does a hard-reset to a last-known-good state. This is a way to
1322
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1324
raise NotImplementedError(self.reset_state)
1326
def _get_rules_searcher(self, default_searcher):
1327
"""See Tree._get_rules_searcher."""
1328
if self._rules_searcher is None:
1329
self._rules_searcher = super(WorkingTree,
1330
self)._get_rules_searcher(default_searcher)
1331
return self._rules_searcher
1333
def get_shelf_manager(self):
1334
"""Return the ShelfManager for this WorkingTree."""
1335
raise NotImplementedError(self.get_shelf_manager)
1337
def get_canonical_paths(self, paths):
1338
"""Like get_canonical_path() but works on multiple items.
1340
:param paths: A sequence of paths relative to the root of the tree.
1341
:return: A list of paths, with each item the corresponding input path
1342
adjusted to account for existing elements that match case
1345
with self.lock_read():
1349
def get_canonical_path(self, path):
1350
"""Returns the first item in the tree that matches a path.
1352
This is meant to allow case-insensitive path lookups on e.g.
1355
If a path matches exactly, it is returned. If no path matches exactly
1356
but more than one path matches according to the underlying file system,
1357
it is implementation defined which is returned.
1359
If no path matches according to the file system, the input path is
1360
returned, but with as many path entries that do exist changed to their
1363
If you need to resolve many names from the same tree, you should
1364
use get_canonical_paths() to avoid O(N) behaviour.
1366
:param path: A paths relative to the root of the tree.
1367
:return: The input path adjusted to account for existing elements
1368
that match case insensitively.
1370
with self.lock_read():
1371
return next(self.get_canonical_paths([path]))
1374
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
1375
"""Registry for working tree formats."""
1377
def __init__(self, other_registry=None):
1378
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1379
self._default_format = None
1380
self._default_format_key = None
1382
def get_default(self):
1383
"""Return the current default format."""
1384
if (self._default_format_key is not None and
1385
self._default_format is None):
1386
self._default_format = self.get(self._default_format_key)
1387
return self._default_format
1389
def set_default(self, format):
1390
"""Set the default format."""
1391
self._default_format = format
1392
self._default_format_key = None
1394
def set_default_key(self, format_string):
1395
"""Set the default format by its format string."""
1396
self._default_format_key = format_string
1397
self._default_format = None
1400
format_registry = WorkingTreeFormatRegistry()
1403
class WorkingTreeFormat(controldir.ControlComponentFormat):
1407
1404
"""An encapsulation of the initialization and open routines for a format.
1409
1406
Formats provide three things:
added
removed
breezy/workingtree.py
