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,
47
filters as _mod_filters,
49
revision as _mod_revision,
54
from breezy.bzr import (
59
from .controldir import (
61
ControlComponentFormatRegistry,
62
ControlComponentFormat,
69
from .i18n import gettext
70
from . import mutabletree
71
from .symbol_versioning import deprecated_method, deprecated_in
72
from .trace import mutter, note
75
class SettingFileIdUnsupported(errors.BzrError):
77
_fmt = "This format does not support setting file ids."
80
class ShelvingUnsupported(errors.BzrError):
82
_fmt = "This format does not support shelving changes."
85
class WorkingTree(mutabletree.MutableTree, ControlComponent):
88
:ivar basedir: The root of the tree on disk. This is a unicode path object
89
(as opposed to a URL).
92
# override this to set the strategy for storing views
93
def _make_views(self):
94
return views.DisabledViews(self)
96
def __init__(self, basedir='.',
102
"""Construct a WorkingTree instance. This is not a public API.
104
:param branch: A branch to override probing for the branch.
106
self._format = _format
107
self.controldir = _controldir
109
raise errors.BzrError("Please use controldir.open_workingtree or "
110
"WorkingTree.open() to obtain a WorkingTree.")
111
basedir = osutils.safe_unicode(basedir)
112
mutter("opening working tree %r", basedir)
113
if branch is not None:
114
self._branch = branch
116
self._branch = self.controldir.open_branch()
117
self.basedir = osutils.realpath(basedir)
118
self._transport = _transport
119
self._rules_searcher = None
120
self.views = self._make_views()
123
def user_transport(self):
124
return self.controldir.user_transport
127
def control_transport(self):
128
return self._transport
130
def supports_symlinks(self):
131
return osutils.supports_symlinks(self.basedir)
133
def is_control_filename(self, filename):
134
"""True if filename is the name of a control file in this tree.
136
:param filename: A filename within the tree. This is a relative path
137
from the root of this tree.
139
This is true IF and ONLY IF the filename is part of the meta data
140
that bzr controls in this tree. I.E. a random .bzr directory placed
141
on disk will not be a control file for this tree.
143
return self.controldir.is_control_filename(filename)
146
fget=lambda self: self._branch,
147
doc="""The branch this WorkingTree is connected to.
149
This cannot be set - it is reflective of the actual disk structure
150
the working tree has been constructed from.
153
def has_versioned_directories(self):
154
"""See `Tree.has_versioned_directories`."""
155
return self._format.supports_versioned_directories
157
def supports_merge_modified(self):
158
"""Indicate whether this workingtree supports storing merge_modified.
160
return self._format.supports_merge_modified
162
def _supports_executable(self):
163
return osutils.supports_executable(self.basedir)
165
def break_lock(self):
166
"""Break a lock if one is present from another instance.
168
Uses the ui factory to ask for confirmation if the lock may be from
171
This will probe the repository for its lock as well.
173
raise NotImplementedError(self.break_lock)
175
def requires_rich_root(self):
176
return self._format.requires_rich_root
178
def supports_tree_reference(self):
181
def supports_content_filtering(self):
182
return self._format.supports_content_filtering()
184
def supports_views(self):
185
return self.views.supports_views()
187
def supports_setting_file_ids(self):
188
return self._format.supports_setting_file_ids
190
def get_config_stack(self):
191
"""Retrieve the config stack for this tree.
193
:return: A ``breezy.config.Stack``
195
# For the moment, just provide the branch config stack.
196
return self.branch.get_config_stack()
199
def open(path=None, _unsupported=False):
200
"""Open an existing working tree at path.
204
path = osutils.getcwd()
205
control = ControlDir.open(path, _unsupported=_unsupported)
206
return control.open_workingtree(unsupported=_unsupported)
209
def open_containing(path=None):
210
"""Open an existing working tree which has its root about path.
212
This probes for a working tree at path and searches upwards from there.
214
Basically we keep looking up until we find the control directory or
215
run into /. If there isn't one, raises NotBranchError.
216
TODO: give this a new exception.
217
If there is one, it is returned, along with the unused portion of path.
219
:return: The WorkingTree that contains 'path', and the rest of path
222
path = osutils.getcwd()
223
control, relpath = ControlDir.open_containing(path)
224
return control.open_workingtree(), relpath
227
def open_containing_paths(file_list, default_directory=None,
228
canonicalize=True, apply_view=True):
229
"""Open the WorkingTree that contains a set of paths.
231
Fail if the paths given are not all in a single tree.
233
This is used for the many command-line interfaces that take a list of
234
any number of files and that require they all be in the same tree.
236
if default_directory is None:
237
default_directory = u'.'
238
# recommended replacement for builtins.internal_tree_files
239
if file_list is None or len(file_list) == 0:
240
tree = WorkingTree.open_containing(default_directory)[0]
241
# XXX: doesn't really belong here, and seems to have the strange
242
# side effect of making it return a bunch of files, not the whole
243
# tree -- mbp 20100716
244
if tree.supports_views() and apply_view:
245
view_files = tree.views.lookup_view()
247
file_list = view_files
248
view_str = views.view_display_str(view_files)
249
note(gettext("Ignoring files outside view. View is %s") % view_str)
250
return tree, file_list
251
if default_directory == u'.':
254
seed = default_directory
255
file_list = [osutils.pathjoin(default_directory, f)
257
tree = WorkingTree.open_containing(seed)[0]
258
return tree, tree.safe_relpath_files(file_list, canonicalize,
259
apply_view=apply_view)
261
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
262
"""Convert file_list into a list of relpaths in tree.
264
:param self: A tree to operate on.
265
:param file_list: A list of user provided paths or None.
266
:param apply_view: if True and a view is set, apply it or check that
267
specified files are within it
268
:return: A list of relative paths.
269
:raises errors.PathNotChild: When a provided path is in a different self
272
if file_list is None:
274
if self.supports_views() and apply_view:
275
view_files = self.views.lookup_view()
279
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
280
# doesn't - fix that up here before we enter the loop.
283
return osutils.canonical_relpath(self.basedir, p)
286
for filename in file_list:
287
relpath = fixer(osutils.dereference_path(filename))
288
if view_files and not osutils.is_inside_any(view_files, relpath):
289
raise views.FileOutsideView(filename, view_files)
290
new_list.append(relpath)
294
def open_downlevel(path=None):
295
"""Open an unsupported working tree.
297
Only intended for advanced situations like upgrading part of a controldir.
299
return WorkingTree.open(path, _unsupported=True)
302
return "<%s of %s>" % (self.__class__.__name__,
303
getattr(self, 'basedir', None))
305
def abspath(self, filename):
306
return osutils.pathjoin(self.basedir, filename)
308
def basis_tree(self):
309
"""Return RevisionTree for the current last revision.
311
If the left most parent is a ghost then the returned tree will be an
312
empty tree - one obtained by calling
313
repository.revision_tree(NULL_REVISION).
316
revision_id = self.get_parent_ids()[0]
318
# no parents, return an empty revision tree.
319
# in the future this should return the tree for
320
# 'empty:' - the implicit root empty tree.
321
return self.branch.repository.revision_tree(
322
_mod_revision.NULL_REVISION)
324
return self.revision_tree(revision_id)
325
except errors.NoSuchRevision:
327
# No cached copy available, retrieve from the repository.
328
# FIXME? RBC 20060403 should we cache the tree locally
331
return self.branch.repository.revision_tree(revision_id)
332
except (errors.RevisionNotPresent, errors.NoSuchRevision):
333
# the basis tree *may* be a ghost or a low level error may have
334
# occurred. If the revision is present, its a problem, if its not
336
if self.branch.repository.has_revision(revision_id):
338
# the basis tree is a ghost so return an empty tree.
339
return self.branch.repository.revision_tree(
340
_mod_revision.NULL_REVISION)
342
def relpath(self, path):
343
"""Return the local path portion from a given path.
345
The path may be absolute or relative. If its a relative path it is
346
interpreted relative to the python current working directory.
348
return osutils.relpath(self.basedir, path)
350
def has_filename(self, filename):
351
return osutils.lexists(self.abspath(filename))
353
def get_file(self, path, filtered=True):
354
return self.get_file_with_stat(path, filtered=filtered)[0]
356
def get_file_with_stat(self, path, filtered=True,
357
_fstat=osutils.fstat):
358
"""See Tree.get_file_with_stat."""
359
abspath = self.abspath(path)
361
file_obj = open(abspath, 'rb')
362
except EnvironmentError as e:
363
if e.errno == errno.ENOENT:
364
raise errors.NoSuchFile(path)
366
stat_value = _fstat(file_obj.fileno())
367
if filtered and self.supports_content_filtering():
368
filters = self._content_filter_stack(path)
369
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
370
return (file_obj, stat_value)
372
def get_file_text(self, path, filtered=True):
373
with self.get_file(path, filtered=filtered) as my_file:
374
return my_file.read()
376
def get_file_lines(self, path, filtered=True):
377
"""See Tree.get_file_lines()"""
378
with self.get_file(path, filtered=filtered) as file:
379
return file.readlines()
381
def get_parent_ids(self):
382
"""See Tree.get_parent_ids.
384
This implementation reads the pending merges list and last_revision
385
value and uses that to decide what the parents list should be.
387
last_rev = _mod_revision.ensure_null(self._last_revision())
388
if _mod_revision.NULL_REVISION == last_rev:
393
merges_bytes = self._transport.get_bytes('pending-merges')
394
except errors.NoSuchFile:
397
for l in osutils.split_lines(merges_bytes):
398
revision_id = l.rstrip(b'\n')
399
parents.append(revision_id)
402
def clone(self, to_controldir, revision_id=None):
403
"""Duplicate this working tree into to_bzr, including all state.
405
Specifically modified files are kept as modified, but
406
ignored and unknown files are discarded.
408
If you want to make a new line of development, see ControlDir.sprout()
411
If not None, the cloned tree will have its last revision set to
412
revision, and difference between the source trees last revision
413
and this one merged in.
415
with self.lock_read():
416
# assumes the target bzr dir format is compatible.
417
result = to_controldir.create_workingtree()
418
self.copy_content_into(result, revision_id)
421
def copy_content_into(self, tree, revision_id=None):
422
"""Copy the current content and user files of this tree into tree."""
423
with self.lock_read():
424
tree.set_root_id(self.path2id(''))
425
if revision_id is None:
426
merge.transform_tree(tree, self)
428
# TODO now merge from tree.last_revision to revision (to
429
# preserve user local changes)
431
other_tree = self.revision_tree(revision_id)
432
except errors.NoSuchRevision:
433
other_tree = self.branch.repository.revision_tree(
436
merge.transform_tree(tree, other_tree)
437
if revision_id == _mod_revision.NULL_REVISION:
440
new_parents = [revision_id]
441
tree.set_parent_ids(new_parents)
443
def get_file_size(self, path):
444
"""See Tree.get_file_size"""
445
# XXX: this returns the on-disk size; it should probably return the
448
return os.path.getsize(self.abspath(path))
450
if e.errno != errno.ENOENT:
455
def _gather_kinds(self, files, kinds):
456
"""See MutableTree._gather_kinds."""
457
with self.lock_tree_write():
458
for pos, f in enumerate(files):
459
if kinds[pos] is None:
460
fullpath = osutils.normpath(self.abspath(f))
462
kinds[pos] = osutils.file_kind(fullpath)
464
if e.errno == errno.ENOENT:
465
raise errors.NoSuchFile(fullpath)
467
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
468
"""Add revision_id as a parent.
470
This is equivalent to retrieving the current list of parent ids
471
and setting the list to its value plus revision_id.
473
:param revision_id: The revision id to add to the parent list. It may
474
be a ghost revision as long as its not the first parent to be
475
added, or the allow_leftmost_as_ghost parameter is set True.
476
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
478
with self.lock_write():
479
parents = self.get_parent_ids() + [revision_id]
480
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
481
or allow_leftmost_as_ghost)
483
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
484
"""Add revision_id, tree tuple as a parent.
486
This is equivalent to retrieving the current list of parent trees
487
and setting the list to its value plus parent_tuple. See also
488
add_parent_tree_id - if you only have a parent id available it will be
489
simpler to use that api. If you have the parent already available, using
490
this api is preferred.
492
:param parent_tuple: The (revision id, tree) to add to the parent list.
493
If the revision_id is a ghost, pass None for the tree.
494
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
496
with self.lock_tree_write():
497
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
498
if len(parent_ids) > 1:
499
# the leftmost may have already been a ghost, preserve that if it
501
allow_leftmost_as_ghost = True
502
self.set_parent_ids(parent_ids,
503
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
505
def add_pending_merge(self, *revision_ids):
506
with self.lock_tree_write():
507
# TODO: Perhaps should check at this point that the
508
# history of the revision is actually present?
509
parents = self.get_parent_ids()
511
for rev_id in revision_ids:
512
if rev_id in parents:
514
parents.append(rev_id)
517
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
519
def path_content_summary(self, path, _lstat=os.lstat,
520
_mapper=osutils.file_kind_from_stat_mode):
521
"""See Tree.path_content_summary."""
522
abspath = self.abspath(path)
524
stat_result = _lstat(abspath)
526
if getattr(e, 'errno', None) == errno.ENOENT:
528
return ('missing', None, None, None)
529
# propagate other errors
531
kind = _mapper(stat_result.st_mode)
533
return self._file_content_summary(path, stat_result)
534
elif kind == 'directory':
535
# perhaps it looks like a plain directory, but it's really a
537
if self._directory_is_tree_reference(path):
538
kind = 'tree-reference'
539
return kind, None, None, None
540
elif kind == 'symlink':
541
target = osutils.readlink(abspath)
542
return ('symlink', None, None, target)
544
return (kind, None, None, None)
546
def _file_content_summary(self, path, stat_result):
547
size = stat_result.st_size
548
executable = self._is_executable_from_path_and_stat(path, stat_result)
549
# try for a stat cache lookup
550
return ('file', size, executable, self._sha_from_stat(
553
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
554
"""Common ghost checking functionality from set_parent_*.
556
This checks that the left hand-parent exists if there are any
559
if len(revision_ids) > 0:
560
leftmost_id = revision_ids[0]
561
if (not allow_leftmost_as_ghost and not
562
self.branch.repository.has_revision(leftmost_id)):
563
raise errors.GhostRevisionUnusableHere(leftmost_id)
565
def _set_merges_from_parent_ids(self, parent_ids):
566
merges = parent_ids[1:]
567
self._transport.put_bytes('pending-merges', b'\n'.join(merges),
568
mode=self.controldir._get_file_mode())
570
def _filter_parent_ids_by_ancestry(self, revision_ids):
571
"""Check that all merged revisions are proper 'heads'.
573
This will always return the first revision_id, and any merged revisions
576
if len(revision_ids) == 0:
578
graph = self.branch.repository.get_graph()
579
heads = graph.heads(revision_ids)
580
new_revision_ids = revision_ids[:1]
581
for revision_id in revision_ids[1:]:
582
if revision_id in heads and revision_id not in new_revision_ids:
583
new_revision_ids.append(revision_id)
584
if new_revision_ids != revision_ids:
585
mutter('requested to set revision_ids = %s,'
586
' but filtered to %s', revision_ids, new_revision_ids)
587
return new_revision_ids
589
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
590
"""Set the parent ids to revision_ids.
592
See also set_parent_trees. This api will try to retrieve the tree data
593
for each element of revision_ids from the trees repository. If you have
594
tree data already available, it is more efficient to use
595
set_parent_trees rather than set_parent_ids. set_parent_ids is however
596
an easier API to use.
598
:param revision_ids: The revision_ids to set as the parent ids of this
599
working tree. Any of these may be ghosts.
601
with self.lock_tree_write():
602
self._check_parents_for_ghosts(revision_ids,
603
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
604
for revision_id in revision_ids:
605
_mod_revision.check_not_reserved_id(revision_id)
607
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
609
if len(revision_ids) > 0:
610
self.set_last_revision(revision_ids[0])
612
self.set_last_revision(_mod_revision.NULL_REVISION)
614
self._set_merges_from_parent_ids(revision_ids)
616
def set_pending_merges(self, rev_list):
617
with self.lock_tree_write():
618
parents = self.get_parent_ids()
619
leftmost = parents[:1]
620
new_parents = leftmost + rev_list
621
self.set_parent_ids(new_parents)
623
def set_merge_modified(self, modified_hashes):
624
"""Set the merge modified hashes."""
625
raise NotImplementedError(self.set_merge_modified)
627
def _sha_from_stat(self, path, stat_result):
628
"""Get a sha digest from the tree's stat cache.
630
The default implementation assumes no stat cache is present.
632
:param path: The path.
633
:param stat_result: The stat result being looked up.
637
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
638
merge_type=None, force=False):
639
"""Merge from a branch into this working tree.
641
:param branch: The branch to merge from.
642
:param to_revision: If non-None, the merge will merge to to_revision,
643
but not beyond it. to_revision does not need to be in the history
644
of the branch when it is supplied. If None, to_revision defaults to
645
branch.last_revision().
647
from .merge import Merger, Merge3Merger
648
with self.lock_write():
649
merger = Merger(self.branch, this_tree=self)
650
# check that there are no local alterations
651
if not force and self.has_changes():
652
raise errors.UncommittedChanges(self)
653
if to_revision is None:
654
to_revision = _mod_revision.ensure_null(branch.last_revision())
655
merger.other_rev_id = to_revision
656
if _mod_revision.is_null(merger.other_rev_id):
657
raise errors.NoCommits(branch)
658
self.branch.fetch(branch, last_revision=merger.other_rev_id)
659
merger.other_basis = merger.other_rev_id
660
merger.other_tree = self.branch.repository.revision_tree(
662
merger.other_branch = branch
663
if from_revision is None:
666
merger.set_base_revision(from_revision, branch)
667
if merger.base_rev_id == merger.other_rev_id:
668
raise errors.PointlessMerge
669
merger.backup_files = False
670
if merge_type is None:
671
merger.merge_type = Merge3Merger
673
merger.merge_type = merge_type
674
merger.set_interesting_files(None)
675
merger.show_base = False
676
merger.reprocess = False
677
conflicts = merger.do_merge()
681
def merge_modified(self):
682
"""Return a dictionary of files modified by a merge.
684
The list is initialized by WorkingTree.set_merge_modified, which is
685
typically called after we make some automatic updates to the tree
688
This returns a map of file_id->sha1, containing only files which are
689
still in the working tree and have that text hash.
691
raise NotImplementedError(self.merge_modified)
693
def mkdir(self, path, file_id=None):
694
"""See MutableTree.mkdir()."""
696
if self.supports_setting_file_ids():
697
file_id = generate_ids.gen_file_id(os.path.basename(path))
699
if not self.supports_setting_file_ids():
700
raise SettingFileIdUnsupported()
701
with self.lock_write():
702
os.mkdir(self.abspath(path))
703
self.add(path, file_id, 'directory')
706
def get_symlink_target(self, path):
707
abspath = self.abspath(path)
708
target = osutils.readlink(abspath)
711
def subsume(self, other_tree):
712
raise NotImplementedError(self.subsume)
714
def _directory_is_tree_reference(self, relpath):
715
raise NotImplementedError(self._directory_is_tree_reference)
717
def extract(self, path, format=None):
718
"""Extract a subtree from this tree.
720
A new branch will be created, relative to the path for this tree.
722
raise NotImplementedError(self.extract)
725
"""Write the in memory meta data to disk."""
726
raise NotImplementedError(self.flush)
728
def kind(self, relpath):
729
return osutils.file_kind(self.abspath(relpath))
731
def list_files(self, include_root=False, from_dir=None, recursive=True):
732
"""List all files as (path, class, kind, id, entry).
734
Lists, but does not descend into unversioned directories.
735
This does not include files that have been deleted in this
736
tree. Skips the control directory.
738
:param include_root: if True, return an entry for the root
739
:param from_dir: start from this directory or None for the root
740
:param recursive: whether to recurse into subdirectories or not
742
raise NotImplementedError(self.list_files)
744
def move(self, from_paths, to_dir=None, after=False):
747
to_dir must be known to the working tree.
749
If to_dir exists and is a directory, the files are moved into
750
it, keeping their old names.
752
Note that to_dir is only the last component of the new name;
753
this doesn't change the directory.
755
For each entry in from_paths the move mode will be determined
758
The first mode moves the file in the filesystem and updates the
759
working tree metadata. The second mode only updates the working tree
760
metadata without touching the file on the filesystem.
762
move uses the second mode if 'after == True' and the target is not
763
versioned but present in the working tree.
765
move uses the second mode if 'after == False' and the source is
766
versioned but no longer in the working tree, and the target is not
767
versioned but present in the working tree.
769
move uses the first mode if 'after == False' and the source is
770
versioned and present in the working tree, and the target is not
771
versioned and not present in the working tree.
773
Everything else results in an error.
775
This returns a list of (from_path, to_path) pairs for each
778
raise NotImplementedError(self.move)
780
def copy_one(self, from_rel, to_rel):
781
"""Copy a file in the tree to a new location.
783
This default implementation just copies the file, then
786
:param from_rel: From location (relative to tree root)
787
:param to_rel: Target location (relative to tree root)
789
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
793
"""Return all unknown files.
795
These are files in the working directory that are not versioned or
796
control files or ignored.
798
with self.lock_read():
799
# force the extras method to be fully executed before returning, to
800
# prevent race conditions with the lock
802
[subp for subp in self.extras() if not self.is_ignored(subp)])
804
def unversion(self, paths):
805
"""Remove the path in pahs from the current versioned set.
807
When a path is unversioned, all of its children are automatically
810
:param paths: The paths to stop versioning.
811
:raises NoSuchFile: if any path is not currently versioned.
813
raise NotImplementedError(self.unversion)
815
def pull(self, source, overwrite=False, stop_revision=None,
816
change_reporter=None, possible_transports=None, local=False,
818
with self.lock_write(), source.lock_read():
819
old_revision_info = self.branch.last_revision_info()
820
basis_tree = self.basis_tree()
821
count = self.branch.pull(source, overwrite, stop_revision,
822
possible_transports=possible_transports,
824
new_revision_info = self.branch.last_revision_info()
825
if new_revision_info != old_revision_info:
826
repository = self.branch.repository
827
if repository._format.fast_deltas:
828
parent_ids = self.get_parent_ids()
830
basis_id = parent_ids[0]
831
basis_tree = repository.revision_tree(basis_id)
832
with basis_tree.lock_read():
833
new_basis_tree = self.branch.basis_tree()
839
change_reporter=change_reporter,
841
basis_root_id = basis_tree.path2id('')
842
new_root_id = new_basis_tree.path2id('')
843
if new_root_id is not None and basis_root_id != new_root_id:
844
self.set_root_id(new_root_id)
845
# TODO - dedup parents list with things merged by pull ?
846
# reuse the revisiontree we merged against to set the new
849
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
851
(self.branch.last_revision(), new_basis_tree))
852
# we have to pull the merge trees out again, because
853
# merge_inner has set the ids. - this corner is not yet
854
# layered well enough to prevent double handling.
855
# XXX TODO: Fix the double handling: telling the tree about
856
# the already known parent data is wasteful.
857
merges = self.get_parent_ids()[1:]
858
parent_trees.extend([
859
(parent, repository.revision_tree(parent)) for
861
self.set_parent_trees(parent_trees)
864
def put_file_bytes_non_atomic(self, path, bytes):
865
"""See MutableTree.put_file_bytes_non_atomic."""
866
with self.lock_write(), open(self.abspath(path), 'wb') as stream:
870
"""Yield all unversioned files in this WorkingTree.
872
If there are any unversioned directories and the file format
873
supports versioning directories, then only the directory is returned,
874
not all its children. But if there are unversioned files under a
875
versioned subdirectory, they are returned.
877
Currently returned depth-first, sorted by name within directories.
878
This is the same order used by 'osutils.walkdirs'.
880
raise NotImplementedError(self.extras)
882
def ignored_files(self):
883
"""Yield list of PATH, IGNORE_PATTERN"""
884
for subp in self.extras():
885
pat = self.is_ignored(subp)
889
def is_ignored(self, filename):
890
r"""Check whether the filename matches an ignore pattern.
892
raise NotImplementedError(self.is_ignored)
894
def stored_kind(self, path):
895
"""See Tree.stored_kind"""
896
raise NotImplementedError(self.stored_kind)
898
def _comparison_data(self, entry, path):
899
abspath = self.abspath(path)
901
stat_value = os.lstat(abspath)
903
if getattr(e, 'errno', None) == errno.ENOENT:
910
mode = stat_value.st_mode
911
kind = osutils.file_kind_from_stat_mode(mode)
912
if not self._supports_executable():
913
executable = entry is not None and entry.executable
915
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
916
return kind, executable, stat_value
918
def last_revision(self):
919
"""Return the last revision of the branch for this tree.
921
This format tree does not support a separate marker for last-revision
922
compared to the branch.
924
See MutableTree.last_revision
926
return self._last_revision()
928
def _last_revision(self):
929
"""helper for get_parent_ids."""
930
with self.lock_read():
931
return _mod_revision.ensure_null(self.branch.last_revision())
934
"""Check if this tree is locked."""
935
raise NotImplementedError(self.is_locked)
938
"""Lock the tree for reading.
940
This also locks the branch, and can be unlocked via self.unlock().
942
:return: A breezy.lock.LogicalLockResult.
944
raise NotImplementedError(self.lock_read)
946
def lock_tree_write(self):
947
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
949
:return: A breezy.lock.LogicalLockResult.
951
raise NotImplementedError(self.lock_tree_write)
953
def lock_write(self):
954
"""See MutableTree.lock_write, and WorkingTree.unlock.
956
:return: A breezy.lock.LogicalLockResult.
958
raise NotImplementedError(self.lock_write)
960
def get_physical_lock_status(self):
961
raise NotImplementedError(self.get_physical_lock_status)
963
def set_last_revision(self, new_revision):
964
"""Change the last revision in the working tree."""
965
raise NotImplementedError(self.set_last_revision)
967
def _change_last_revision(self, new_revision):
968
"""Template method part of set_last_revision to perform the change.
970
This is used to allow WorkingTree3 instances to not affect branch
971
when their last revision is set.
973
if _mod_revision.is_null(new_revision):
974
self.branch.set_last_revision_info(0, new_revision)
976
_mod_revision.check_not_reserved_id(new_revision)
978
self.branch.generate_revision_history(new_revision)
979
except errors.NoSuchRevision:
980
# not present in the repo - dont try to set it deeper than the tip
981
self.branch._set_revision_history([new_revision])
984
def remove(self, files, verbose=False, to_file=None, keep_files=True,
986
"""Remove nominated files from the working tree metadata.
988
:files: File paths relative to the basedir.
989
:keep_files: If true, the files will also be kept.
990
:force: Delete files and directories, even if they are changed and
991
even if the directories are not empty.
993
raise NotImplementedError(self.remove)
995
def revert(self, filenames=None, old_tree=None, backups=True,
996
pb=None, report_changes=False):
997
from .conflicts import resolve
998
with cleanup.ExitStack() as exit_stack:
999
exit_stack.enter_context(self.lock_tree_write())
1000
if old_tree is None:
1001
basis_tree = self.basis_tree()
1002
exit_stack.enter_context(basis_tree.lock_read())
1003
old_tree = basis_tree
1006
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1008
if filenames is None and len(self.get_parent_ids()) > 1:
1010
last_revision = self.last_revision()
1011
if last_revision != _mod_revision.NULL_REVISION:
1012
if basis_tree is None:
1013
basis_tree = self.basis_tree()
1014
exit_stack.enter_context(basis_tree.lock_read())
1015
parent_trees.append((last_revision, basis_tree))
1016
self.set_parent_trees(parent_trees)
1019
resolve(self, filenames, ignore_misses=True, recursive=True)
1022
def store_uncommitted(self):
1023
"""Store uncommitted changes from the tree in the branch."""
1024
raise NotImplementedError(self.store_uncommitted)
1026
def restore_uncommitted(self):
1027
"""Restore uncommitted changes from the branch into the tree."""
1028
raise NotImplementedError(self.restore_uncommitted)
1030
def revision_tree(self, revision_id):
1031
"""See Tree.revision_tree.
1033
For trees that can be obtained from the working tree, this
1034
will do so. For other trees, it will fall back to the repository.
1036
raise NotImplementedError(self.revision_tree)
1038
def set_root_id(self, file_id):
1039
"""Set the root id for this tree."""
1040
if not self.supports_setting_file_ids():
1041
raise SettingFileIdUnsupported()
1042
with self.lock_tree_write():
1046
'WorkingTree.set_root_id with fileid=None')
1047
file_id = osutils.safe_file_id(file_id)
1048
self._set_root_id(file_id)
1050
def _set_root_id(self, file_id):
1051
"""Set the root id for this tree, in a format specific manner.
1053
:param file_id: The file id to assign to the root. It must not be
1054
present in the current inventory or an error will occur. It must
1055
not be None, but rather a valid file id.
1057
raise NotImplementedError(self._set_root_id)
1060
"""See Branch.unlock.
1062
WorkingTree locking just uses the Branch locking facilities.
1063
This is current because all working trees have an embedded branch
1064
within them. IF in the future, we were to make branch data shareable
1065
between multiple working trees, i.e. via shared storage, then we
1066
would probably want to lock both the local tree, and the branch.
1068
raise NotImplementedError(self.unlock)
1072
def update(self, change_reporter=None, possible_transports=None,
1073
revision=None, old_tip=_marker, show_base=False):
1074
"""Update a working tree along its branch.
1076
This will update the branch if its bound too, which means we have
1077
multiple trees involved:
1079
- The new basis tree of the master.
1080
- The old basis tree of the branch.
1081
- The old basis tree of the working tree.
1082
- The current working tree state.
1084
Pathologically, all three may be different, and non-ancestors of each
1085
other. Conceptually we want to:
1087
- Preserve the wt.basis->wt.state changes
1088
- Transform the wt.basis to the new master basis.
1089
- Apply a merge of the old branch basis to get any 'local' changes from
1091
- Restore the wt.basis->wt.state changes.
1093
There isn't a single operation at the moment to do that, so we:
1095
- Merge current state -> basis tree of the master w.r.t. the old tree
1097
- Do a 'normal' merge of the old branch basis if it is relevant.
1099
:param revision: The target revision to update to. Must be in the
1101
:param old_tip: If branch.update() has already been run, the value it
1102
returned (old tip of the branch or None). _marker is used
1105
if self.branch.get_bound_location() is not None:
1107
update_branch = (old_tip is self._marker)
1109
self.lock_tree_write()
1110
update_branch = False
1113
old_tip = self.branch.update(possible_transports)
1115
if old_tip is self._marker:
1117
return self._update_tree(old_tip, change_reporter, revision, show_base)
1121
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1123
"""Update a tree to the master branch.
1125
:param old_tip: if supplied, the previous tip revision the branch,
1126
before it was changed to the master branch's tip.
1128
# here if old_tip is not None, it is the old tip of the branch before
1129
# it was updated from the master branch. This should become a pending
1130
# merge in the working tree to preserve the user existing work. we
1131
# cant set that until we update the working trees last revision to be
1132
# one from the new branch, because it will just get absorbed by the
1133
# parent de-duplication logic.
1135
# We MUST save it even if an error occurs, because otherwise the users
1136
# local work is unreferenced and will appear to have been lost.
1138
with self.lock_tree_write():
1141
last_rev = self.get_parent_ids()[0]
1143
last_rev = _mod_revision.NULL_REVISION
1144
if revision is None:
1145
revision = self.branch.last_revision()
1147
old_tip = old_tip or _mod_revision.NULL_REVISION
1149
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1150
# the branch we are bound to was updated
1151
# merge those changes in first
1152
base_tree = self.basis_tree()
1153
other_tree = self.branch.repository.revision_tree(old_tip)
1154
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1155
base_tree, this_tree=self,
1156
change_reporter=change_reporter,
1157
show_base=show_base)
1159
self.add_parent_tree((old_tip, other_tree))
1160
note(gettext('Rerun update after fixing the conflicts.'))
1163
if last_rev != _mod_revision.ensure_null(revision):
1164
# the working tree is up to date with the branch
1165
# we can merge the specified revision from master
1166
to_tree = self.branch.repository.revision_tree(revision)
1167
to_root_id = to_tree.path2id('')
1169
basis = self.basis_tree()
1170
with basis.lock_read():
1171
if (basis.path2id('') is None or basis.path2id('') != to_root_id):
1172
self.set_root_id(to_root_id)
1175
# determine the branch point
1176
graph = self.branch.repository.get_graph()
1177
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1179
base_tree = self.branch.repository.revision_tree(base_rev_id)
1181
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1183
change_reporter=change_reporter,
1184
show_base=show_base)
1185
self.set_last_revision(revision)
1186
# TODO - dedup parents list with things merged by pull ?
1187
# reuse the tree we've updated to to set the basis:
1188
parent_trees = [(revision, to_tree)]
1189
merges = self.get_parent_ids()[1:]
1190
# Ideally we ask the tree for the trees here, that way the working
1191
# tree can decide whether to give us the entire tree or give us a
1192
# lazy initialised tree. dirstate for instance will have the trees
1193
# in ram already, whereas a last-revision + basis-inventory tree
1194
# will not, but also does not need them when setting parents.
1195
for parent in merges:
1196
parent_trees.append(
1197
(parent, self.branch.repository.revision_tree(parent)))
1198
if not _mod_revision.is_null(old_tip):
1199
parent_trees.append(
1200
(old_tip, self.branch.repository.revision_tree(old_tip)))
1201
self.set_parent_trees(parent_trees)
1202
last_rev = parent_trees[0][0]
1205
def set_conflicts(self, arg):
1206
raise errors.UnsupportedOperation(self.set_conflicts, self)
1208
def add_conflicts(self, arg):
1209
raise errors.UnsupportedOperation(self.add_conflicts, self)
1211
def conflicts(self):
1212
raise NotImplementedError(self.conflicts)
1214
def walkdirs(self, prefix=""):
1215
"""Walk the directories of this tree.
1217
returns a generator which yields items in the form:
1218
((curren_directory_path, fileid),
1219
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1222
This API returns a generator, which is only valid during the current
1223
tree transaction - within a single lock_read or lock_write duration.
1225
If the tree is not locked, it may cause an error to be raised,
1226
depending on the tree implementation.
1228
raise NotImplementedError(self.walkdirs)
1230
@deprecated_method(deprecated_in((3, 0, 1)))
1231
def auto_resolve(self):
1232
"""Automatically resolve text conflicts according to contents.
1234
Only text conflicts are auto_resolvable. Files with no conflict markers
1235
are considered 'resolved', because bzr always puts conflict markers
1236
into files that have text conflicts. The corresponding .THIS .BASE and
1237
.OTHER files are deleted, as per 'resolve'.
1239
:return: a tuple of ConflictLists: (un_resolved, resolved).
1241
with self.lock_tree_write():
1242
un_resolved = _mod_conflicts.ConflictList()
1243
resolved = _mod_conflicts.ConflictList()
1244
for conflict in self.conflicts():
1246
conflict.action_auto(self)
1247
except NotImplementedError:
1248
un_resolved.append(conflict)
1250
conflict.cleanup(self)
1251
resolved.append(conflict)
1252
self.set_conflicts(un_resolved)
1253
return un_resolved, resolved
1255
def _validate(self):
1256
"""Validate internal structures.
1258
This is meant mostly for the test suite. To give it a chance to detect
1259
corruption after actions have occurred. The default implementation is a
1262
:return: None. An exception should be raised if there is an error.
1266
def check_state(self):
1267
"""Check that the working state is/isn't valid."""
1268
raise NotImplementedError(self.check_state)
1270
def reset_state(self, revision_ids=None):
1271
"""Reset the state of the working tree.
1273
This does a hard-reset to a last-known-good state. This is a way to
1274
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1276
raise NotImplementedError(self.reset_state)
1278
def _get_rules_searcher(self, default_searcher):
1279
"""See Tree._get_rules_searcher."""
1280
if self._rules_searcher is None:
1281
self._rules_searcher = super(WorkingTree,
1282
self)._get_rules_searcher(default_searcher)
1283
return self._rules_searcher
1285
def get_shelf_manager(self):
1286
"""Return the ShelfManager for this WorkingTree."""
1287
raise NotImplementedError(self.get_shelf_manager)
1289
def get_canonical_paths(self, paths):
1290
"""Like get_canonical_path() but works on multiple items.
1292
:param paths: A sequence of paths relative to the root of the tree.
1293
:return: A list of paths, with each item the corresponding input path
1294
adjusted to account for existing elements that match case
1297
with self.lock_read():
1301
def get_canonical_path(self, path):
1302
"""Returns the first item in the tree that matches a path.
1304
This is meant to allow case-insensitive path lookups on e.g.
1307
If a path matches exactly, it is returned. If no path matches exactly
1308
but more than one path matches according to the underlying file system,
1309
it is implementation defined which is returned.
1311
If no path matches according to the file system, the input path is
1312
returned, but with as many path entries that do exist changed to their
1315
If you need to resolve many names from the same tree, you should
1316
use get_canonical_paths() to avoid O(N) behaviour.
1318
:param path: A paths relative to the root of the tree.
1319
:return: The input path adjusted to account for existing elements
1320
that match case insensitively.
1322
with self.lock_read():
1323
return next(self.get_canonical_paths([path]))
1326
class WorkingTreeFormatRegistry(ControlComponentFormatRegistry):
1327
"""Registry for working tree formats."""
1329
def __init__(self, other_registry=None):
1330
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1331
self._default_format = None
1332
self._default_format_key = None
1334
def get_default(self):
1335
"""Return the current default format."""
1336
if (self._default_format_key is not None and
1337
self._default_format is None):
1338
self._default_format = self.get(self._default_format_key)
1339
return self._default_format
1341
def set_default(self, format):
1342
"""Set the default format."""
1343
self._default_format = format
1344
self._default_format_key = None
1346
def set_default_key(self, format_string):
1347
"""Set the default format by its format string."""
1348
self._default_format_key = format_string
1349
self._default_format = None
1352
format_registry = WorkingTreeFormatRegistry()
1355
class WorkingTreeFormat(ControlComponentFormat):
1356
"""An encapsulation of the initialization and open routines for a format.
1358
Formats provide three things:
1359
* An initialization routine,
1363
Formats are placed in an dict by their format string for reference
1364
during workingtree opening. Its not required that these be instances, they
1365
can be classes themselves with class methods - it simply depends on
1366
whether state is needed for a given format or not.
1368
Once a format is deprecated, just deprecate the initialize and open
1369
methods on the format class. Do not deprecate the object, as the
1370
object will be created every time regardless.
1373
requires_rich_root = False
1375
upgrade_recommended = False
1377
requires_normalized_unicode_filenames = False
1379
case_sensitive_filename = "FoRMaT"
1381
missing_parent_conflicts = False
1382
"""If this format supports missing parent conflicts."""
1384
supports_versioned_directories = None
1386
supports_merge_modified = True
1387
"""If this format supports storing merge modified hashes."""
1389
supports_setting_file_ids = True
1390
"""If this format allows setting the file id."""
1392
supports_store_uncommitted = True
1393
"""If this format supports shelve-like functionality."""
1395
supports_leftmost_parent_id_as_ghost = True
1397
supports_righthand_parent_id_as_ghost = True
1399
ignore_filename = None
1400
"""Name of file with ignore patterns, if any. """
1402
def initialize(self, controldir, revision_id=None, from_branch=None,
1403
accelerator_tree=None, hardlink=False):
1404
"""Initialize a new working tree in controldir.
1406
:param controldir: ControlDir to initialize the working tree in.
1407
:param revision_id: allows creating a working tree at a different
1408
revision than the branch is at.
1409
:param from_branch: Branch to checkout
1410
:param accelerator_tree: A tree which can be used for retrieving file
1411
contents more quickly than the revision tree, i.e. a workingtree.
1412
The revision tree will be used for cases where accelerator_tree's
1413
content is different.
1414
:param hardlink: If true, hard-link files from accelerator_tree,
1417
raise NotImplementedError(self.initialize)
1419
def __eq__(self, other):
1420
return self.__class__ is other.__class__
1422
def __ne__(self, other):
1423
return not (self == other)
1425
def get_format_description(self):
1426
"""Return the short description for this format."""
1427
raise NotImplementedError(self.get_format_description)
1429
def is_supported(self):
1430
"""Is this format supported?
1432
Supported formats can be initialized and opened.
1433
Unsupported formats may not support initialization or committing or
1434
some other features depending on the reason for not being supported.
1438
def supports_content_filtering(self):
1439
"""True if this format supports content filtering."""
1442
def supports_views(self):
1443
"""True if this format supports stored views."""
1446
def get_controldir_for_branch(self):
1447
"""Get the control directory format for creating branches.
1449
This is to support testing of working tree formats that can not exist
1450
in the same control directory as a branch.
1452
return self._matchingcontroldir
1455
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1456
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1457
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1458
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1459
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1460
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1461
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1462
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1463
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
