1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files.
23
At the moment every WorkingTree has its own branch. Remote
24
WorkingTrees aren't supported.
26
To get a WorkingTree, call controldir.open_workingtree() or
27
WorkingTree.open(dir).
30
from __future__ import absolute_import
39
from .lazy_import import lazy_import
40
lazy_import(globals(), """
45
conflicts as _mod_conflicts,
46
filters as _mod_filters,
48
revision as _mod_revision,
53
from breezy.bzr import (
61
from .controldir import (
63
ControlComponentFormatRegistry,
64
ControlComponentFormat,
71
from .i18n import gettext
72
from . import mutabletree
73
from .symbol_versioning import deprecated_method, deprecated_in
74
from .trace import mutter, note
77
class SettingFileIdUnsupported(errors.BzrError):
79
_fmt = "This format does not support setting file ids."
82
class ShelvingUnsupported(errors.BzrError):
84
_fmt = "This format does not support shelving changes."
87
class WorkingTree(mutabletree.MutableTree, ControlComponent):
90
:ivar basedir: The root of the tree on disk. This is a unicode path object
91
(as opposed to a URL).
94
# override this to set the strategy for storing views
95
def _make_views(self):
96
return views.DisabledViews(self)
98
def __init__(self, basedir='.',
104
"""Construct a WorkingTree instance. This is not a public API.
106
:param branch: A branch to override probing for the branch.
108
self._format = _format
109
self.controldir = _controldir
111
raise errors.BzrError("Please use controldir.open_workingtree or "
112
"WorkingTree.open() to obtain a WorkingTree.")
113
basedir = osutils.safe_unicode(basedir)
114
mutter("opening working tree %r", basedir)
115
if branch is not None:
116
self._branch = branch
118
self._branch = self.controldir.open_branch()
119
self.basedir = osutils.realpath(basedir)
120
self._transport = _transport
121
self._rules_searcher = None
122
self.views = self._make_views()
125
def user_transport(self):
126
return self.controldir.user_transport
129
def control_transport(self):
130
return self._transport
132
def supports_symlinks(self):
133
return osutils.supports_symlinks(self.basedir)
135
def is_control_filename(self, filename):
136
"""True if filename is the name of a control file in this tree.
138
:param filename: A filename within the tree. This is a relative path
139
from the root of this tree.
141
This is true IF and ONLY IF the filename is part of the meta data
142
that bzr controls in this tree. I.E. a random .bzr directory placed
143
on disk will not be a control file for this tree.
145
return self.controldir.is_control_filename(filename)
148
fget=lambda self: self._branch,
149
doc="""The branch this WorkingTree is connected to.
151
This cannot be set - it is reflective of the actual disk structure
152
the working tree has been constructed from.
155
def has_versioned_directories(self):
156
"""See `Tree.has_versioned_directories`."""
157
return self._format.supports_versioned_directories
159
def supports_merge_modified(self):
160
"""Indicate whether this workingtree supports storing merge_modified.
162
return self._format.supports_merge_modified
164
def _supports_executable(self):
165
return osutils.supports_executable(self.basedir)
167
def break_lock(self):
168
"""Break a lock if one is present from another instance.
170
Uses the ui factory to ask for confirmation if the lock may be from
173
This will probe the repository for its lock as well.
175
raise NotImplementedError(self.break_lock)
177
def requires_rich_root(self):
178
return self._format.requires_rich_root
180
def supports_tree_reference(self):
183
def supports_content_filtering(self):
184
return self._format.supports_content_filtering()
186
def supports_views(self):
187
return self.views.supports_views()
189
def supports_setting_file_ids(self):
190
return self._format.supports_setting_file_ids
192
def get_config_stack(self):
193
"""Retrieve the config stack for this tree.
195
:return: A ``breezy.config.Stack``
197
# For the moment, just provide the branch config stack.
198
return self.branch.get_config_stack()
201
def open(path=None, _unsupported=False):
202
"""Open an existing working tree at path.
206
path = osutils.getcwd()
207
control = ControlDir.open(path, _unsupported=_unsupported)
208
return control.open_workingtree(unsupported=_unsupported)
211
def open_containing(path=None):
212
"""Open an existing working tree which has its root about path.
214
This probes for a working tree at path and searches upwards from there.
216
Basically we keep looking up until we find the control directory or
217
run into /. If there isn't one, raises NotBranchError.
218
TODO: give this a new exception.
219
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)
226
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
def open_downlevel(path=None):
297
"""Open an unsupported working tree.
299
Only intended for advanced situations like upgrading part of a controldir.
301
return WorkingTree.open(path, _unsupported=True)
304
return "<%s of %s>" % (self.__class__.__name__,
305
getattr(self, 'basedir', None))
307
def abspath(self, filename):
308
return osutils.pathjoin(self.basedir, filename)
310
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)
352
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):
409
"""Duplicate this working tree into to_bzr, including all state.
411
Specifically modified files are kept as modified, but
412
ignored and unknown files are discarded.
414
If you want to make a new line of development, see ControlDir.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
419
and this one merged in.
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)
427
def copy_content_into(self, tree, revision_id=None):
428
"""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
454
return os.path.getsize(self.abspath(path))
456
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)
622
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)
629
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()
687
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))
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).
741
Lists, but does not descend into unversioned directories.
742
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
749
raise NotImplementedError(self.list_files)
751
def move(self, from_paths, to_dir=None, after=False):
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
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
This returns a list of (from_path, to_path) pairs for each
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)
796
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
800
"""Return all unknown files.
802
These are files in the working directory that are not versioned or
803
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,
825
with self.lock_write(), source.lock_read():
826
old_revision_info = self.branch.last_revision_info()
827
basis_tree = self.basis_tree()
828
count = self.branch.pull(source, overwrite, stop_revision,
829
possible_transports=possible_transports,
831
new_revision_info = self.branch.last_revision_info()
832
if new_revision_info != old_revision_info:
833
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)
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:
877
"""Yield all unversioned 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.
884
Currently returned depth-first, sorted by name within directories.
885
This is the same order used by 'osutils.walkdirs'.
887
raise NotImplementedError(self.extras)
889
def ignored_files(self):
890
"""Yield list of PATH, IGNORE_PATTERN"""
891
for subp in self.extras():
892
pat = self.is_ignored(subp)
896
def is_ignored(self, filename):
897
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:
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
925
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
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)
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)
960
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)
970
def set_last_revision(self, new_revision):
971
"""Change the last revision in the working tree."""
972
raise NotImplementedError(self.set_last_revision)
974
def _change_last_revision(self, new_revision):
975
"""Template method part of set_last_revision to perform the change.
977
This is used to allow WorkingTree3 instances to not affect branch
978
when their last revision is set.
980
if _mod_revision.is_null(new_revision):
981
self.branch.set_last_revision_info(0, new_revision)
983
_mod_revision.check_not_reserved_id(new_revision)
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])
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 contextlib.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)
1045
def set_root_id(self, file_id):
1046
"""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)
1067
"""See Branch.unlock.
1069
WorkingTree locking just uses the Branch locking facilities.
1070
This is current because all working trees have an embedded branch
1071
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
1073
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):
1081
"""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.
1100
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
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
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('')
1176
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(),
1186
base_tree = self.branch.repository.revision_tree(base_rev_id)
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]
1212
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)
1218
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)
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):
1372
"""An encapsulation of the initialization and open routines for a format.
1374
Formats provide three things:
1375
* An initialization routine,
1379
Formats are placed in an dict by their format string for reference
1380
during workingtree opening. Its not required that these be instances, they
1381
can be classes themselves with class methods - it simply depends on
1382
whether state is needed for a given format or not.
1384
Once a format is deprecated, just deprecate the initialize and open
1385
methods on the format class. Do not deprecate the object, as the
1386
object will be created every time regardless.
1389
requires_rich_root = False
1391
upgrade_recommended = False
1393
requires_normalized_unicode_filenames = False
1395
case_sensitive_filename = "FoRMaT"
1397
missing_parent_conflicts = False
1398
"""If this format supports missing parent conflicts."""
1400
supports_versioned_directories = None
1402
supports_merge_modified = True
1403
"""If this format supports storing merge modified hashes."""
1405
supports_setting_file_ids = True
1406
"""If this format allows setting the file id."""
1408
supports_store_uncommitted = True
1409
"""If this format supports shelve-like functionality."""
1411
supports_leftmost_parent_id_as_ghost = True
1413
supports_righthand_parent_id_as_ghost = True
1415
ignore_filename = None
1416
"""Name of file with ignore patterns, if any. """
1418
def initialize(self, controldir, revision_id=None, from_branch=None,
1419
accelerator_tree=None, hardlink=False):
1420
"""Initialize a new working tree in controldir.
1422
:param controldir: ControlDir to initialize the working tree in.
1423
:param revision_id: allows creating a working tree at a different
1424
revision than the branch is at.
1425
:param from_branch: Branch to checkout
1426
:param accelerator_tree: A tree which can be used for retrieving file
1427
contents more quickly than the revision tree, i.e. a workingtree.
1428
The revision tree will be used for cases where accelerator_tree's
1429
content is different.
1430
:param hardlink: If true, hard-link files from accelerator_tree,
1433
raise NotImplementedError(self.initialize)
1435
def __eq__(self, other):
1436
return self.__class__ is other.__class__
1438
def __ne__(self, other):
1439
return not (self == other)
1441
def get_format_description(self):
1442
"""Return the short description for this format."""
1443
raise NotImplementedError(self.get_format_description)
1445
def is_supported(self):
1446
"""Is this format supported?
1448
Supported formats can be initialized and opened.
1449
Unsupported formats may not support initialization or committing or
1450
some other features depending on the reason for not being supported.
1454
def supports_content_filtering(self):
1455
"""True if this format supports content filtering."""
1458
def supports_views(self):
1459
"""True if this format supports stored views."""
1462
def get_controldir_for_branch(self):
1463
"""Get the control directory format for creating branches.
1465
This is to support testing of working tree formats that can not exist
1466
in the same control directory as a branch.
1468
return self._matchingcontroldir
1471
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1472
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1473
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1474
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1475
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1476
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1477
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1478
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1479
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
