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
38
from .lazy_import import lazy_import
39
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)
371
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
372
return (file_obj, stat_value)
374
def get_file_text(self, path, filtered=True):
375
with self.get_file(path, filtered=filtered) as my_file:
376
return my_file.read()
378
def get_file_lines(self, path, filtered=True):
379
"""See Tree.get_file_lines()"""
380
with self.get_file(path, filtered=filtered) as file:
381
return file.readlines()
383
def get_parent_ids(self):
384
"""See Tree.get_parent_ids.
386
This implementation reads the pending merges list and last_revision
387
value and uses that to decide what the parents list should be.
389
last_rev = _mod_revision.ensure_null(self._last_revision())
390
if _mod_revision.NULL_REVISION == last_rev:
395
merges_bytes = self._transport.get_bytes('pending-merges')
396
except errors.NoSuchFile:
399
for l in osutils.split_lines(merges_bytes):
400
revision_id = l.rstrip(b'\n')
401
parents.append(revision_id)
404
def clone(self, to_controldir, revision_id=None):
405
"""Duplicate this working tree into to_bzr, including all state.
407
Specifically modified files are kept as modified, but
408
ignored and unknown files are discarded.
410
If you want to make a new line of development, see ControlDir.sprout()
413
If not None, the cloned tree will have its last revision set to
414
revision, and difference between the source trees last revision
415
and this one merged in.
417
with self.lock_read():
418
# assumes the target bzr dir format is compatible.
419
result = to_controldir.create_workingtree()
420
self.copy_content_into(result, revision_id)
423
def copy_content_into(self, tree, revision_id=None):
424
"""Copy the current content and user files of this tree into tree."""
425
with self.lock_read():
426
tree.set_root_id(self.path2id(''))
427
if revision_id is None:
428
merge.transform_tree(tree, self)
430
# TODO now merge from tree.last_revision to revision (to
431
# preserve user local changes)
433
other_tree = self.revision_tree(revision_id)
434
except errors.NoSuchRevision:
435
other_tree = self.branch.repository.revision_tree(
438
merge.transform_tree(tree, other_tree)
439
if revision_id == _mod_revision.NULL_REVISION:
442
new_parents = [revision_id]
443
tree.set_parent_ids(new_parents)
445
def get_file_size(self, path):
446
"""See Tree.get_file_size"""
447
# XXX: this returns the on-disk size; it should probably return the
450
return os.path.getsize(self.abspath(path))
452
if e.errno != errno.ENOENT:
457
def _gather_kinds(self, files, kinds):
458
"""See MutableTree._gather_kinds."""
459
with self.lock_tree_write():
460
for pos, f in enumerate(files):
461
if kinds[pos] is None:
462
fullpath = osutils.normpath(self.abspath(f))
464
kinds[pos] = osutils.file_kind(fullpath)
466
if e.errno == errno.ENOENT:
467
raise errors.NoSuchFile(fullpath)
469
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
470
"""Add revision_id as a parent.
472
This is equivalent to retrieving the current list of parent ids
473
and setting the list to its value plus revision_id.
475
:param revision_id: The revision id to add to the parent list. It may
476
be a ghost revision as long as its not the first parent to be
477
added, or the allow_leftmost_as_ghost parameter is set True.
478
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
480
with self.lock_write():
481
parents = self.get_parent_ids() + [revision_id]
482
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
483
or allow_leftmost_as_ghost)
485
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
486
"""Add revision_id, tree tuple as a parent.
488
This is equivalent to retrieving the current list of parent trees
489
and setting the list to its value plus parent_tuple. See also
490
add_parent_tree_id - if you only have a parent id available it will be
491
simpler to use that api. If you have the parent already available, using
492
this api is preferred.
494
:param parent_tuple: The (revision id, tree) to add to the parent list.
495
If the revision_id is a ghost, pass None for the tree.
496
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
498
with self.lock_tree_write():
499
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
500
if len(parent_ids) > 1:
501
# the leftmost may have already been a ghost, preserve that if it
503
allow_leftmost_as_ghost = True
504
self.set_parent_ids(parent_ids,
505
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
507
def add_pending_merge(self, *revision_ids):
508
with self.lock_tree_write():
509
# TODO: Perhaps should check at this point that the
510
# history of the revision is actually present?
511
parents = self.get_parent_ids()
513
for rev_id in revision_ids:
514
if rev_id in parents:
516
parents.append(rev_id)
519
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
521
def path_content_summary(self, path, _lstat=os.lstat,
522
_mapper=osutils.file_kind_from_stat_mode):
523
"""See Tree.path_content_summary."""
524
abspath = self.abspath(path)
526
stat_result = _lstat(abspath)
528
if getattr(e, 'errno', None) == errno.ENOENT:
530
return ('missing', None, None, None)
531
# propagate other errors
533
kind = _mapper(stat_result.st_mode)
535
return self._file_content_summary(path, stat_result)
536
elif kind == 'directory':
537
# perhaps it looks like a plain directory, but it's really a
539
if self._directory_is_tree_reference(path):
540
kind = 'tree-reference'
541
return kind, None, None, None
542
elif kind == 'symlink':
543
target = osutils.readlink(abspath)
544
return ('symlink', None, None, target)
546
return (kind, None, None, None)
548
def _file_content_summary(self, path, stat_result):
549
size = stat_result.st_size
550
executable = self._is_executable_from_path_and_stat(path, stat_result)
551
# try for a stat cache lookup
552
return ('file', size, executable, self._sha_from_stat(
555
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
556
"""Common ghost checking functionality from set_parent_*.
558
This checks that the left hand-parent exists if there are any
561
if len(revision_ids) > 0:
562
leftmost_id = revision_ids[0]
563
if (not allow_leftmost_as_ghost and not
564
self.branch.repository.has_revision(leftmost_id)):
565
raise errors.GhostRevisionUnusableHere(leftmost_id)
567
def _set_merges_from_parent_ids(self, parent_ids):
568
merges = parent_ids[1:]
569
self._transport.put_bytes('pending-merges', b'\n'.join(merges),
570
mode=self.controldir._get_file_mode())
572
def _filter_parent_ids_by_ancestry(self, revision_ids):
573
"""Check that all merged revisions are proper 'heads'.
575
This will always return the first revision_id, and any merged revisions
578
if len(revision_ids) == 0:
580
graph = self.branch.repository.get_graph()
581
heads = graph.heads(revision_ids)
582
new_revision_ids = revision_ids[:1]
583
for revision_id in revision_ids[1:]:
584
if revision_id in heads and revision_id not in new_revision_ids:
585
new_revision_ids.append(revision_id)
586
if new_revision_ids != revision_ids:
587
mutter('requested to set revision_ids = %s,'
588
' but filtered to %s', revision_ids, new_revision_ids)
589
return new_revision_ids
591
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
592
"""Set the parent ids to revision_ids.
594
See also set_parent_trees. This api will try to retrieve the tree data
595
for each element of revision_ids from the trees repository. If you have
596
tree data already available, it is more efficient to use
597
set_parent_trees rather than set_parent_ids. set_parent_ids is however
598
an easier API to use.
600
:param revision_ids: The revision_ids to set as the parent ids of this
601
working tree. Any of these may be ghosts.
603
with self.lock_tree_write():
604
self._check_parents_for_ghosts(revision_ids,
605
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
606
for revision_id in revision_ids:
607
_mod_revision.check_not_reserved_id(revision_id)
609
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
611
if len(revision_ids) > 0:
612
self.set_last_revision(revision_ids[0])
614
self.set_last_revision(_mod_revision.NULL_REVISION)
616
self._set_merges_from_parent_ids(revision_ids)
618
def set_pending_merges(self, rev_list):
619
with self.lock_tree_write():
620
parents = self.get_parent_ids()
621
leftmost = parents[:1]
622
new_parents = leftmost + rev_list
623
self.set_parent_ids(new_parents)
625
def set_merge_modified(self, modified_hashes):
626
"""Set the merge modified hashes."""
627
raise NotImplementedError(self.set_merge_modified)
629
def _sha_from_stat(self, path, stat_result):
630
"""Get a sha digest from the tree's stat cache.
632
The default implementation assumes no stat cache is present.
634
:param path: The path.
635
:param stat_result: The stat result being looked up.
639
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
640
merge_type=None, force=False):
641
"""Merge from a branch into this working tree.
643
:param branch: The branch to merge from.
644
:param to_revision: If non-None, the merge will merge to to_revision,
645
but not beyond it. to_revision does not need to be in the history
646
of the branch when it is supplied. If None, to_revision defaults to
647
branch.last_revision().
649
from .merge import Merger, Merge3Merger
650
with self.lock_write():
651
merger = Merger(self.branch, this_tree=self)
652
# check that there are no local alterations
653
if not force and self.has_changes():
654
raise errors.UncommittedChanges(self)
655
if to_revision is None:
656
to_revision = _mod_revision.ensure_null(branch.last_revision())
657
merger.other_rev_id = to_revision
658
if _mod_revision.is_null(merger.other_rev_id):
659
raise errors.NoCommits(branch)
660
self.branch.fetch(branch, last_revision=merger.other_rev_id)
661
merger.other_basis = merger.other_rev_id
662
merger.other_tree = self.branch.repository.revision_tree(
664
merger.other_branch = branch
665
if from_revision is None:
668
merger.set_base_revision(from_revision, branch)
669
if merger.base_rev_id == merger.other_rev_id:
670
raise errors.PointlessMerge
671
merger.backup_files = False
672
if merge_type is None:
673
merger.merge_type = Merge3Merger
675
merger.merge_type = merge_type
676
merger.set_interesting_files(None)
677
merger.show_base = False
678
merger.reprocess = False
679
conflicts = merger.do_merge()
683
def merge_modified(self):
684
"""Return a dictionary of files modified by a merge.
686
The list is initialized by WorkingTree.set_merge_modified, which is
687
typically called after we make some automatic updates to the tree
690
This returns a map of file_id->sha1, containing only files which are
691
still in the working tree and have that text hash.
693
raise NotImplementedError(self.merge_modified)
695
def mkdir(self, path, file_id=None):
696
"""See MutableTree.mkdir()."""
698
if self.supports_setting_file_ids():
699
file_id = generate_ids.gen_file_id(os.path.basename(path))
701
if not self.supports_setting_file_ids():
702
raise SettingFileIdUnsupported()
703
with self.lock_write():
704
os.mkdir(self.abspath(path))
705
self.add(path, file_id, 'directory')
708
def get_symlink_target(self, path):
709
abspath = self.abspath(path)
710
target = osutils.readlink(abspath)
713
def subsume(self, other_tree):
714
raise NotImplementedError(self.subsume)
716
def _directory_is_tree_reference(self, relpath):
717
raise NotImplementedError(self._directory_is_tree_reference)
719
def extract(self, path, format=None):
720
"""Extract a subtree from this tree.
722
A new branch will be created, relative to the path for this tree.
724
raise NotImplementedError(self.extract)
727
"""Write the in memory meta data to disk."""
728
raise NotImplementedError(self.flush)
730
def kind(self, relpath):
731
return osutils.file_kind(self.abspath(relpath))
733
def list_files(self, include_root=False, from_dir=None, recursive=True,
734
recurse_nested=False):
735
"""List all files as (path, class, kind, id, entry).
737
Lists, but does not descend into unversioned directories.
738
This does not include files that have been deleted in this
739
tree. Skips the control directory.
741
:param include_root: if True, return an entry for the root
742
:param from_dir: start from this directory or None for the root
743
:param recursive: whether to recurse into subdirectories or not
745
raise NotImplementedError(self.list_files)
747
def move(self, from_paths, to_dir=None, after=False):
750
to_dir must be known to the working tree.
752
If to_dir exists and is a directory, the files are moved into
753
it, keeping their old names.
755
Note that to_dir is only the last component of the new name;
756
this doesn't change the directory.
758
For each entry in from_paths the move mode will be determined
761
The first mode moves the file in the filesystem and updates the
762
working tree metadata. The second mode only updates the working tree
763
metadata without touching the file on the filesystem.
765
move uses the second mode if 'after == True' and the target is not
766
versioned but present in the working tree.
768
move uses the second mode if 'after == False' and the source is
769
versioned but no longer in the working tree, and the target is not
770
versioned but present in the working tree.
772
move uses the first mode if 'after == False' and the source is
773
versioned and present in the working tree, and the target is not
774
versioned and not present in the working tree.
776
Everything else results in an error.
778
This returns a list of (from_path, to_path) pairs for each
781
raise NotImplementedError(self.move)
783
def copy_one(self, from_rel, to_rel):
784
"""Copy a file in the tree to a new location.
786
This default implementation just copies the file, then
789
:param from_rel: From location (relative to tree root)
790
:param to_rel: Target location (relative to tree root)
792
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
796
"""Return all unknown files.
798
These are files in the working directory that are not versioned or
799
control files or ignored.
801
with self.lock_read():
802
# force the extras method to be fully executed before returning, to
803
# prevent race conditions with the lock
805
[subp for subp in self.extras() if not self.is_ignored(subp)])
807
def unversion(self, paths):
808
"""Remove the path in pahs from the current versioned set.
810
When a path is unversioned, all of its children are automatically
813
:param paths: The paths to stop versioning.
814
:raises NoSuchFile: if any path is not currently versioned.
816
raise NotImplementedError(self.unversion)
818
def pull(self, source, overwrite=False, stop_revision=None,
819
change_reporter=None, possible_transports=None, local=False,
821
with self.lock_write(), source.lock_read():
822
old_revision_info = self.branch.last_revision_info()
823
basis_tree = self.basis_tree()
824
count = self.branch.pull(source, overwrite, stop_revision,
825
possible_transports=possible_transports,
827
new_revision_info = self.branch.last_revision_info()
828
if new_revision_info != old_revision_info:
829
repository = self.branch.repository
830
if repository._format.fast_deltas:
831
parent_ids = self.get_parent_ids()
833
basis_id = parent_ids[0]
834
basis_tree = repository.revision_tree(basis_id)
835
with basis_tree.lock_read():
836
new_basis_tree = self.branch.basis_tree()
842
change_reporter=change_reporter,
844
basis_root_id = basis_tree.path2id('')
845
new_root_id = new_basis_tree.path2id('')
846
if new_root_id is not None and basis_root_id != new_root_id:
847
self.set_root_id(new_root_id)
848
# TODO - dedup parents list with things merged by pull ?
849
# reuse the revisiontree we merged against to set the new
852
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
854
(self.branch.last_revision(), new_basis_tree))
855
# we have to pull the merge trees out again, because
856
# merge_inner has set the ids. - this corner is not yet
857
# layered well enough to prevent double handling.
858
# XXX TODO: Fix the double handling: telling the tree about
859
# the already known parent data is wasteful.
860
merges = self.get_parent_ids()[1:]
861
parent_trees.extend([
862
(parent, repository.revision_tree(parent)) for
864
self.set_parent_trees(parent_trees)
867
def put_file_bytes_non_atomic(self, path, bytes):
868
"""See MutableTree.put_file_bytes_non_atomic."""
869
with self.lock_write(), open(self.abspath(path), 'wb') as stream:
873
"""Yield all unversioned files in this WorkingTree.
875
If there are any unversioned directories and the file format
876
supports versioning directories, then only the directory is returned,
877
not all its children. But if there are unversioned files under a
878
versioned subdirectory, they are returned.
880
Currently returned depth-first, sorted by name within directories.
881
This is the same order used by 'osutils.walkdirs'.
883
raise NotImplementedError(self.extras)
885
def ignored_files(self):
886
"""Yield list of PATH, IGNORE_PATTERN"""
887
for subp in self.extras():
888
pat = self.is_ignored(subp)
892
def is_ignored(self, filename):
893
r"""Check whether the filename matches an ignore pattern.
895
raise NotImplementedError(self.is_ignored)
897
def stored_kind(self, path):
898
"""See Tree.stored_kind"""
899
raise NotImplementedError(self.stored_kind)
901
def _comparison_data(self, entry, path):
902
abspath = self.abspath(path)
904
stat_value = os.lstat(abspath)
906
if getattr(e, 'errno', None) == errno.ENOENT:
913
mode = stat_value.st_mode
914
kind = osutils.file_kind_from_stat_mode(mode)
915
if not self._supports_executable():
916
executable = entry is not None and entry.executable
918
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
919
return kind, executable, stat_value
921
def last_revision(self):
922
"""Return the last revision of the branch for this tree.
924
This format tree does not support a separate marker for last-revision
925
compared to the branch.
927
See MutableTree.last_revision
929
return self._last_revision()
931
def _last_revision(self):
932
"""helper for get_parent_ids."""
933
with self.lock_read():
934
return _mod_revision.ensure_null(self.branch.last_revision())
937
"""Check if this tree is locked."""
938
raise NotImplementedError(self.is_locked)
941
"""Lock the tree for reading.
943
This also locks the branch, and can be unlocked via self.unlock().
945
:return: A breezy.lock.LogicalLockResult.
947
raise NotImplementedError(self.lock_read)
949
def lock_tree_write(self):
950
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
952
:return: A breezy.lock.LogicalLockResult.
954
raise NotImplementedError(self.lock_tree_write)
956
def lock_write(self):
957
"""See MutableTree.lock_write, and WorkingTree.unlock.
959
:return: A breezy.lock.LogicalLockResult.
961
raise NotImplementedError(self.lock_write)
963
def get_physical_lock_status(self):
964
raise NotImplementedError(self.get_physical_lock_status)
966
def set_last_revision(self, new_revision):
967
"""Change the last revision in the working tree."""
968
raise NotImplementedError(self.set_last_revision)
970
def _change_last_revision(self, new_revision):
971
"""Template method part of set_last_revision to perform the change.
973
This is used to allow WorkingTree3 instances to not affect branch
974
when their last revision is set.
976
if _mod_revision.is_null(new_revision):
977
self.branch.set_last_revision_info(0, new_revision)
979
_mod_revision.check_not_reserved_id(new_revision)
981
self.branch.generate_revision_history(new_revision)
982
except errors.NoSuchRevision:
983
# not present in the repo - dont try to set it deeper than the tip
984
self.branch._set_revision_history([new_revision])
987
def remove(self, files, verbose=False, to_file=None, keep_files=True,
989
"""Remove nominated files from the working tree metadata.
991
:files: File paths relative to the basedir.
992
:keep_files: If true, the files will also be kept.
993
:force: Delete files and directories, even if they are changed and
994
even if the directories are not empty.
996
raise NotImplementedError(self.remove)
998
def revert(self, filenames=None, old_tree=None, backups=True,
999
pb=None, report_changes=False):
1000
from .conflicts import resolve
1001
with cleanup.ExitStack() as exit_stack:
1002
exit_stack.enter_context(self.lock_tree_write())
1003
if old_tree is None:
1004
basis_tree = self.basis_tree()
1005
exit_stack.enter_context(basis_tree.lock_read())
1006
old_tree = basis_tree
1009
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1011
if filenames is None and len(self.get_parent_ids()) > 1:
1013
last_revision = self.last_revision()
1014
if last_revision != _mod_revision.NULL_REVISION:
1015
if basis_tree is None:
1016
basis_tree = self.basis_tree()
1017
exit_stack.enter_context(basis_tree.lock_read())
1018
parent_trees.append((last_revision, basis_tree))
1019
self.set_parent_trees(parent_trees)
1022
resolve(self, filenames, ignore_misses=True, recursive=True)
1025
def store_uncommitted(self):
1026
"""Store uncommitted changes from the tree in the branch."""
1027
raise NotImplementedError(self.store_uncommitted)
1029
def restore_uncommitted(self):
1030
"""Restore uncommitted changes from the branch into the tree."""
1031
raise NotImplementedError(self.restore_uncommitted)
1033
def revision_tree(self, revision_id):
1034
"""See Tree.revision_tree.
1036
For trees that can be obtained from the working tree, this
1037
will do so. For other trees, it will fall back to the repository.
1039
raise NotImplementedError(self.revision_tree)
1041
def set_root_id(self, file_id):
1042
"""Set the root id for this tree."""
1043
if not self.supports_setting_file_ids():
1044
raise SettingFileIdUnsupported()
1045
with self.lock_tree_write():
1049
'WorkingTree.set_root_id with fileid=None')
1050
file_id = osutils.safe_file_id(file_id)
1051
self._set_root_id(file_id)
1053
def _set_root_id(self, file_id):
1054
"""Set the root id for this tree, in a format specific manner.
1056
:param file_id: The file id to assign to the root. It must not be
1057
present in the current inventory or an error will occur. It must
1058
not be None, but rather a valid file id.
1060
raise NotImplementedError(self._set_root_id)
1063
"""See Branch.unlock.
1065
WorkingTree locking just uses the Branch locking facilities.
1066
This is current because all working trees have an embedded branch
1067
within them. IF in the future, we were to make branch data shareable
1068
between multiple working trees, i.e. via shared storage, then we
1069
would probably want to lock both the local tree, and the branch.
1071
raise NotImplementedError(self.unlock)
1075
def update(self, change_reporter=None, possible_transports=None,
1076
revision=None, old_tip=_marker, show_base=False):
1077
"""Update a working tree along its branch.
1079
This will update the branch if its bound too, which means we have
1080
multiple trees involved:
1082
- The new basis tree of the master.
1083
- The old basis tree of the branch.
1084
- The old basis tree of the working tree.
1085
- The current working tree state.
1087
Pathologically, all three may be different, and non-ancestors of each
1088
other. Conceptually we want to:
1090
- Preserve the wt.basis->wt.state changes
1091
- Transform the wt.basis to the new master basis.
1092
- Apply a merge of the old branch basis to get any 'local' changes from
1094
- Restore the wt.basis->wt.state changes.
1096
There isn't a single operation at the moment to do that, so we:
1098
- Merge current state -> basis tree of the master w.r.t. the old tree
1100
- Do a 'normal' merge of the old branch basis if it is relevant.
1102
:param revision: The target revision to update to. Must be in the
1104
:param old_tip: If branch.update() has already been run, the value it
1105
returned (old tip of the branch or None). _marker is used
1108
if self.branch.get_bound_location() is not None:
1110
update_branch = (old_tip is self._marker)
1112
self.lock_tree_write()
1113
update_branch = False
1116
old_tip = self.branch.update(possible_transports)
1118
if old_tip is self._marker:
1120
return self._update_tree(old_tip, change_reporter, revision, show_base)
1124
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1126
"""Update a tree to the master branch.
1128
:param old_tip: if supplied, the previous tip revision the branch,
1129
before it was changed to the master branch's tip.
1131
# here if old_tip is not None, it is the old tip of the branch before
1132
# it was updated from the master branch. This should become a pending
1133
# merge in the working tree to preserve the user existing work. we
1134
# cant set that until we update the working trees last revision to be
1135
# one from the new branch, because it will just get absorbed by the
1136
# parent de-duplication logic.
1138
# We MUST save it even if an error occurs, because otherwise the users
1139
# local work is unreferenced and will appear to have been lost.
1141
with self.lock_tree_write():
1144
last_rev = self.get_parent_ids()[0]
1146
last_rev = _mod_revision.NULL_REVISION
1147
if revision is None:
1148
revision = self.branch.last_revision()
1150
old_tip = old_tip or _mod_revision.NULL_REVISION
1152
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1153
# the branch we are bound to was updated
1154
# merge those changes in first
1155
base_tree = self.basis_tree()
1156
other_tree = self.branch.repository.revision_tree(old_tip)
1157
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1158
base_tree, this_tree=self,
1159
change_reporter=change_reporter,
1160
show_base=show_base)
1162
self.add_parent_tree((old_tip, other_tree))
1163
note(gettext('Rerun update after fixing the conflicts.'))
1166
if last_rev != _mod_revision.ensure_null(revision):
1167
# the working tree is up to date with the branch
1168
# we can merge the specified revision from master
1169
to_tree = self.branch.repository.revision_tree(revision)
1170
to_root_id = to_tree.path2id('')
1172
basis = self.basis_tree()
1173
with basis.lock_read():
1174
if (basis.path2id('') is None or basis.path2id('') != to_root_id):
1175
self.set_root_id(to_root_id)
1178
# determine the branch point
1179
graph = self.branch.repository.get_graph()
1180
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1182
base_tree = self.branch.repository.revision_tree(base_rev_id)
1184
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1186
change_reporter=change_reporter,
1187
show_base=show_base)
1188
self.set_last_revision(revision)
1189
# TODO - dedup parents list with things merged by pull ?
1190
# reuse the tree we've updated to to set the basis:
1191
parent_trees = [(revision, to_tree)]
1192
merges = self.get_parent_ids()[1:]
1193
# Ideally we ask the tree for the trees here, that way the working
1194
# tree can decide whether to give us the entire tree or give us a
1195
# lazy initialised tree. dirstate for instance will have the trees
1196
# in ram already, whereas a last-revision + basis-inventory tree
1197
# will not, but also does not need them when setting parents.
1198
for parent in merges:
1199
parent_trees.append(
1200
(parent, self.branch.repository.revision_tree(parent)))
1201
if not _mod_revision.is_null(old_tip):
1202
parent_trees.append(
1203
(old_tip, self.branch.repository.revision_tree(old_tip)))
1204
self.set_parent_trees(parent_trees)
1205
last_rev = parent_trees[0][0]
1208
def set_conflicts(self, arg):
1209
raise errors.UnsupportedOperation(self.set_conflicts, self)
1211
def add_conflicts(self, arg):
1212
raise errors.UnsupportedOperation(self.add_conflicts, self)
1214
def conflicts(self):
1215
raise NotImplementedError(self.conflicts)
1217
def walkdirs(self, prefix=""):
1218
"""Walk the directories of this tree.
1220
returns a generator which yields items in the form:
1221
((curren_directory_path, fileid),
1222
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1225
This API returns a generator, which is only valid during the current
1226
tree transaction - within a single lock_read or lock_write duration.
1228
If the tree is not locked, it may cause an error to be raised,
1229
depending on the tree implementation.
1231
raise NotImplementedError(self.walkdirs)
1233
@deprecated_method(deprecated_in((3, 0, 1)))
1234
def auto_resolve(self):
1235
"""Automatically resolve text conflicts according to contents.
1237
Only text conflicts are auto_resolvable. Files with no conflict markers
1238
are considered 'resolved', because bzr always puts conflict markers
1239
into files that have text conflicts. The corresponding .THIS .BASE and
1240
.OTHER files are deleted, as per 'resolve'.
1242
:return: a tuple of ConflictLists: (un_resolved, resolved).
1244
with self.lock_tree_write():
1245
un_resolved = _mod_conflicts.ConflictList()
1246
resolved = _mod_conflicts.ConflictList()
1247
for conflict in self.conflicts():
1249
conflict.action_auto(self)
1250
except NotImplementedError:
1251
un_resolved.append(conflict)
1253
conflict.cleanup(self)
1254
resolved.append(conflict)
1255
self.set_conflicts(un_resolved)
1256
return un_resolved, resolved
1258
def _validate(self):
1259
"""Validate internal structures.
1261
This is meant mostly for the test suite. To give it a chance to detect
1262
corruption after actions have occurred. The default implementation is a
1265
:return: None. An exception should be raised if there is an error.
1269
def check_state(self):
1270
"""Check that the working state is/isn't valid."""
1271
raise NotImplementedError(self.check_state)
1273
def reset_state(self, revision_ids=None):
1274
"""Reset the state of the working tree.
1276
This does a hard-reset to a last-known-good state. This is a way to
1277
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1279
raise NotImplementedError(self.reset_state)
1281
def _get_rules_searcher(self, default_searcher):
1282
"""See Tree._get_rules_searcher."""
1283
if self._rules_searcher is None:
1284
self._rules_searcher = super(WorkingTree,
1285
self)._get_rules_searcher(default_searcher)
1286
return self._rules_searcher
1288
def get_shelf_manager(self):
1289
"""Return the ShelfManager for this WorkingTree."""
1290
raise NotImplementedError(self.get_shelf_manager)
1292
def get_canonical_paths(self, paths):
1293
"""Like get_canonical_path() but works on multiple items.
1295
:param paths: A sequence of paths relative to the root of the tree.
1296
:return: A list of paths, with each item the corresponding input path
1297
adjusted to account for existing elements that match case
1300
with self.lock_read():
1304
def get_canonical_path(self, path):
1305
"""Returns the first item in the tree that matches a path.
1307
This is meant to allow case-insensitive path lookups on e.g.
1310
If a path matches exactly, it is returned. If no path matches exactly
1311
but more than one path matches according to the underlying file system,
1312
it is implementation defined which is returned.
1314
If no path matches according to the file system, the input path is
1315
returned, but with as many path entries that do exist changed to their
1318
If you need to resolve many names from the same tree, you should
1319
use get_canonical_paths() to avoid O(N) behaviour.
1321
:param path: A paths relative to the root of the tree.
1322
:return: The input path adjusted to account for existing elements
1323
that match case insensitively.
1325
with self.lock_read():
1326
return next(self.get_canonical_paths([path]))
1329
class WorkingTreeFormatRegistry(ControlComponentFormatRegistry):
1330
"""Registry for working tree formats."""
1332
def __init__(self, other_registry=None):
1333
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1334
self._default_format = None
1335
self._default_format_key = None
1337
def get_default(self):
1338
"""Return the current default format."""
1339
if (self._default_format_key is not None and
1340
self._default_format is None):
1341
self._default_format = self.get(self._default_format_key)
1342
return self._default_format
1344
def set_default(self, format):
1345
"""Set the default format."""
1346
self._default_format = format
1347
self._default_format_key = None
1349
def set_default_key(self, format_string):
1350
"""Set the default format by its format string."""
1351
self._default_format_key = format_string
1352
self._default_format = None
1355
format_registry = WorkingTreeFormatRegistry()
1358
class WorkingTreeFormat(ControlComponentFormat):
1359
"""An encapsulation of the initialization and open routines for a format.
1361
Formats provide three things:
1362
* An initialization routine,
1366
Formats are placed in an dict by their format string for reference
1367
during workingtree opening. Its not required that these be instances, they
1368
can be classes themselves with class methods - it simply depends on
1369
whether state is needed for a given format or not.
1371
Once a format is deprecated, just deprecate the initialize and open
1372
methods on the format class. Do not deprecate the object, as the
1373
object will be created every time regardless.
1376
requires_rich_root = False
1378
upgrade_recommended = False
1380
requires_normalized_unicode_filenames = False
1382
case_sensitive_filename = "FoRMaT"
1384
missing_parent_conflicts = False
1385
"""If this format supports missing parent conflicts."""
1387
supports_versioned_directories = None
1389
supports_merge_modified = True
1390
"""If this format supports storing merge modified hashes."""
1392
supports_setting_file_ids = True
1393
"""If this format allows setting the file id."""
1395
supports_store_uncommitted = True
1396
"""If this format supports shelve-like functionality."""
1398
supports_leftmost_parent_id_as_ghost = True
1400
supports_righthand_parent_id_as_ghost = True
1402
ignore_filename = None
1403
"""Name of file with ignore patterns, if any. """
1405
def initialize(self, controldir, revision_id=None, from_branch=None,
1406
accelerator_tree=None, hardlink=False):
1407
"""Initialize a new working tree in controldir.
1409
:param controldir: ControlDir to initialize the working tree in.
1410
:param revision_id: allows creating a working tree at a different
1411
revision than the branch is at.
1412
:param from_branch: Branch to checkout
1413
:param accelerator_tree: A tree which can be used for retrieving file
1414
contents more quickly than the revision tree, i.e. a workingtree.
1415
The revision tree will be used for cases where accelerator_tree's
1416
content is different.
1417
:param hardlink: If true, hard-link files from accelerator_tree,
1420
raise NotImplementedError(self.initialize)
1422
def __eq__(self, other):
1423
return self.__class__ is other.__class__
1425
def __ne__(self, other):
1426
return not (self == other)
1428
def get_format_description(self):
1429
"""Return the short description for this format."""
1430
raise NotImplementedError(self.get_format_description)
1432
def is_supported(self):
1433
"""Is this format supported?
1435
Supported formats can be initialized and opened.
1436
Unsupported formats may not support initialization or committing or
1437
some other features depending on the reason for not being supported.
1441
def supports_content_filtering(self):
1442
"""True if this format supports content filtering."""
1445
def supports_views(self):
1446
"""True if this format supports stored views."""
1449
def get_controldir_for_branch(self):
1450
"""Get the control directory format for creating branches.
1452
This is to support testing of working tree formats that can not exist
1453
in the same control directory as a branch.
1455
return self._matchingcontroldir
1458
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1459
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1460
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1461
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1462
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1463
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1464
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1465
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1466
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
