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).
37
from .lazy_import import lazy_import
38
lazy_import(globals(), """
43
conflicts as _mod_conflicts,
44
filters as _mod_filters,
46
revision as _mod_revision,
51
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)
370
file_obj, size = _mod_filters.filtered_input_file(
372
stat_value = _mod_filters.FilteredStat(
373
stat_value, st_size=size)
374
return (file_obj, stat_value)
376
def get_file_text(self, path, filtered=True):
377
with self.get_file(path, filtered=filtered) as my_file:
378
return my_file.read()
380
def get_file_lines(self, path, filtered=True):
381
"""See Tree.get_file_lines()"""
382
with self.get_file(path, filtered=filtered) as file:
383
return file.readlines()
385
def get_parent_ids(self):
386
"""See Tree.get_parent_ids.
388
This implementation reads the pending merges list and last_revision
389
value and uses that to decide what the parents list should be.
391
last_rev = _mod_revision.ensure_null(self._last_revision())
392
if _mod_revision.NULL_REVISION == last_rev:
397
merges_bytes = self._transport.get_bytes('pending-merges')
398
except errors.NoSuchFile:
401
for l in osutils.split_lines(merges_bytes):
402
revision_id = l.rstrip(b'\n')
403
parents.append(revision_id)
406
def clone(self, to_controldir, revision_id=None):
407
"""Duplicate this working tree into to_bzr, including all state.
409
Specifically modified files are kept as modified, but
410
ignored and unknown files are discarded.
412
If you want to make a new line of development, see ControlDir.sprout()
415
If not None, the cloned tree will have its last revision set to
416
revision, and difference between the source trees last revision
417
and this one merged in.
419
with self.lock_read():
420
# assumes the target bzr dir format is compatible.
421
result = to_controldir.create_workingtree()
422
self.copy_content_into(result, revision_id)
425
def copy_content_into(self, tree, revision_id=None):
426
"""Copy the current content and user files of this tree into tree."""
427
with self.lock_read():
428
tree.set_root_id(self.path2id(''))
429
if revision_id is None:
430
merge.transform_tree(tree, self)
432
# TODO now merge from tree.last_revision to revision (to
433
# preserve user local changes)
435
other_tree = self.revision_tree(revision_id)
436
except errors.NoSuchRevision:
437
other_tree = self.branch.repository.revision_tree(
440
merge.transform_tree(tree, other_tree)
441
if revision_id == _mod_revision.NULL_REVISION:
444
new_parents = [revision_id]
445
tree.set_parent_ids(new_parents)
447
def get_file_size(self, path):
448
"""See Tree.get_file_size"""
449
# XXX: this returns the on-disk size; it should probably return the
452
return os.path.getsize(self.abspath(path))
454
if e.errno != errno.ENOENT:
459
def _gather_kinds(self, files, kinds):
460
"""See MutableTree._gather_kinds."""
461
with self.lock_tree_write():
462
for pos, f in enumerate(files):
463
if kinds[pos] is None:
464
fullpath = osutils.normpath(self.abspath(f))
466
kinds[pos] = osutils.file_kind(fullpath)
468
if e.errno == errno.ENOENT:
469
raise errors.NoSuchFile(fullpath)
471
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
472
"""Add revision_id as a parent.
474
This is equivalent to retrieving the current list of parent ids
475
and setting the list to its value plus revision_id.
477
:param revision_id: The revision id to add to the parent list. It may
478
be a ghost revision as long as its not the first parent to be
479
added, or the allow_leftmost_as_ghost parameter is set True.
480
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
482
with self.lock_write():
483
parents = self.get_parent_ids() + [revision_id]
484
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
485
or allow_leftmost_as_ghost)
487
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
488
"""Add revision_id, tree tuple as a parent.
490
This is equivalent to retrieving the current list of parent trees
491
and setting the list to its value plus parent_tuple. See also
492
add_parent_tree_id - if you only have a parent id available it will be
493
simpler to use that api. If you have the parent already available, using
494
this api is preferred.
496
:param parent_tuple: The (revision id, tree) to add to the parent list.
497
If the revision_id is a ghost, pass None for the tree.
498
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
500
with self.lock_tree_write():
501
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
502
if len(parent_ids) > 1:
503
# the leftmost may have already been a ghost, preserve that if it
505
allow_leftmost_as_ghost = True
506
self.set_parent_ids(parent_ids,
507
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
509
def add_pending_merge(self, *revision_ids):
510
with self.lock_tree_write():
511
# TODO: Perhaps should check at this point that the
512
# history of the revision is actually present?
513
parents = self.get_parent_ids()
515
for rev_id in revision_ids:
516
if rev_id in parents:
518
parents.append(rev_id)
521
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
523
def path_content_summary(self, path, _lstat=os.lstat,
524
_mapper=osutils.file_kind_from_stat_mode):
525
"""See Tree.path_content_summary."""
526
abspath = self.abspath(path)
528
stat_result = _lstat(abspath)
530
if getattr(e, 'errno', None) == errno.ENOENT:
532
return ('missing', None, None, None)
533
# propagate other errors
535
kind = _mapper(stat_result.st_mode)
537
return self._file_content_summary(path, stat_result)
538
elif kind == 'directory':
539
# perhaps it looks like a plain directory, but it's really a
541
if self._directory_is_tree_reference(path):
542
kind = 'tree-reference'
543
return kind, None, None, None
544
elif kind == 'symlink':
545
target = osutils.readlink(abspath)
546
return ('symlink', None, None, target)
548
return (kind, None, None, None)
550
def _file_content_summary(self, path, stat_result):
551
size = stat_result.st_size
552
executable = self._is_executable_from_path_and_stat(path, stat_result)
553
# try for a stat cache lookup
554
return ('file', size, executable, self._sha_from_stat(
557
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
558
"""Common ghost checking functionality from set_parent_*.
560
This checks that the left hand-parent exists if there are any
563
if len(revision_ids) > 0:
564
leftmost_id = revision_ids[0]
565
if (not allow_leftmost_as_ghost and not
566
self.branch.repository.has_revision(leftmost_id)):
567
raise errors.GhostRevisionUnusableHere(leftmost_id)
569
def _set_merges_from_parent_ids(self, parent_ids):
570
merges = parent_ids[1:]
571
self._transport.put_bytes('pending-merges', b'\n'.join(merges),
572
mode=self.controldir._get_file_mode())
574
def _filter_parent_ids_by_ancestry(self, revision_ids):
575
"""Check that all merged revisions are proper 'heads'.
577
This will always return the first revision_id, and any merged revisions
580
if len(revision_ids) == 0:
582
graph = self.branch.repository.get_graph()
583
heads = graph.heads(revision_ids)
584
new_revision_ids = revision_ids[:1]
585
for revision_id in revision_ids[1:]:
586
if revision_id in heads and revision_id not in new_revision_ids:
587
new_revision_ids.append(revision_id)
588
if new_revision_ids != revision_ids:
589
mutter('requested to set revision_ids = %s,'
590
' but filtered to %s', revision_ids, new_revision_ids)
591
return new_revision_ids
593
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
594
"""Set the parent ids to revision_ids.
596
See also set_parent_trees. This api will try to retrieve the tree data
597
for each element of revision_ids from the trees repository. If you have
598
tree data already available, it is more efficient to use
599
set_parent_trees rather than set_parent_ids. set_parent_ids is however
600
an easier API to use.
602
:param revision_ids: The revision_ids to set as the parent ids of this
603
working tree. Any of these may be ghosts.
605
with self.lock_tree_write():
606
self._check_parents_for_ghosts(revision_ids,
607
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
608
for revision_id in revision_ids:
609
_mod_revision.check_not_reserved_id(revision_id)
611
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
613
if len(revision_ids) > 0:
614
self.set_last_revision(revision_ids[0])
616
self.set_last_revision(_mod_revision.NULL_REVISION)
618
self._set_merges_from_parent_ids(revision_ids)
620
def set_pending_merges(self, rev_list):
621
with self.lock_tree_write():
622
parents = self.get_parent_ids()
623
leftmost = parents[:1]
624
new_parents = leftmost + rev_list
625
self.set_parent_ids(new_parents)
627
def set_merge_modified(self, modified_hashes):
628
"""Set the merge modified hashes."""
629
raise NotImplementedError(self.set_merge_modified)
631
def _sha_from_stat(self, path, stat_result):
632
"""Get a sha digest from the tree's stat cache.
634
The default implementation assumes no stat cache is present.
636
:param path: The path.
637
:param stat_result: The stat result being looked up.
641
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
642
merge_type=None, force=False):
643
"""Merge from a branch into this working tree.
645
:param branch: The branch to merge from.
646
:param to_revision: If non-None, the merge will merge to to_revision,
647
but not beyond it. to_revision does not need to be in the history
648
of the branch when it is supplied. If None, to_revision defaults to
649
branch.last_revision().
651
from .merge import Merger, Merge3Merger
652
with self.lock_write():
653
merger = Merger(self.branch, this_tree=self)
654
# check that there are no local alterations
655
if not force and self.has_changes():
656
raise errors.UncommittedChanges(self)
657
if to_revision is None:
658
to_revision = _mod_revision.ensure_null(branch.last_revision())
659
merger.other_rev_id = to_revision
660
if _mod_revision.is_null(merger.other_rev_id):
661
raise errors.NoCommits(branch)
662
self.branch.fetch(branch, stop_revision=merger.other_rev_id)
663
merger.other_basis = merger.other_rev_id
664
merger.other_tree = self.branch.repository.revision_tree(
666
merger.other_branch = branch
667
if from_revision is None:
670
merger.set_base_revision(from_revision, branch)
671
if merger.base_rev_id == merger.other_rev_id:
672
raise errors.PointlessMerge
673
merger.backup_files = False
674
if merge_type is None:
675
merger.merge_type = Merge3Merger
677
merger.merge_type = merge_type
678
merger.set_interesting_files(None)
679
merger.show_base = False
680
merger.reprocess = False
681
conflicts = merger.do_merge()
685
def merge_modified(self):
686
"""Return a dictionary of files modified by a merge.
688
The list is initialized by WorkingTree.set_merge_modified, which is
689
typically called after we make some automatic updates to the tree
692
This returns a map of file_id->sha1, containing only files which are
693
still in the working tree and have that text hash.
695
raise NotImplementedError(self.merge_modified)
697
def mkdir(self, path, file_id=None):
698
"""See MutableTree.mkdir()."""
700
if self.supports_setting_file_ids():
701
file_id = generate_ids.gen_file_id(os.path.basename(path))
703
if not self.supports_setting_file_ids():
704
raise SettingFileIdUnsupported()
705
with self.lock_write():
706
os.mkdir(self.abspath(path))
707
self.add(path, file_id, 'directory')
710
def get_symlink_target(self, path):
711
abspath = self.abspath(path)
713
return osutils.readlink(abspath)
715
if getattr(e, 'errno', None) == errno.ENOENT:
716
raise errors.NoSuchFile(path)
719
def subsume(self, other_tree):
720
raise NotImplementedError(self.subsume)
722
def _directory_is_tree_reference(self, relpath):
723
raise NotImplementedError(self._directory_is_tree_reference)
725
def extract(self, path, format=None):
726
"""Extract a subtree from this tree.
728
A new branch will be created, relative to the path for this tree.
730
raise NotImplementedError(self.extract)
733
"""Write the in memory meta data to disk."""
734
raise NotImplementedError(self.flush)
736
def kind(self, relpath):
737
return osutils.file_kind(self.abspath(relpath))
739
def list_files(self, include_root=False, from_dir=None, recursive=True,
740
recurse_nested=False):
741
"""List all files as (path, class, kind, id, entry).
743
Lists, but does not descend into unversioned directories.
744
This does not include files that have been deleted in this
745
tree. Skips the control directory.
747
:param include_root: if True, return an entry for the root
748
:param from_dir: start from this directory or None for the root
749
:param recursive: whether to recurse into subdirectories or not
751
raise NotImplementedError(self.list_files)
753
def move(self, from_paths, to_dir=None, after=False):
756
to_dir must be known to the working tree.
758
If to_dir exists and is a directory, the files are moved into
759
it, keeping their old names.
761
Note that to_dir is only the last component of the new name;
762
this doesn't change the directory.
764
For each entry in from_paths the move mode will be determined
767
The first mode moves the file in the filesystem and updates the
768
working tree metadata. The second mode only updates the working tree
769
metadata without touching the file on the filesystem.
771
move uses the second mode if 'after == True' and the target is not
772
versioned but present in the working tree.
774
move uses the second mode if 'after == False' and the source is
775
versioned but no longer in the working tree, and the target is not
776
versioned but present in the working tree.
778
move uses the first mode if 'after == False' and the source is
779
versioned and present in the working tree, and the target is not
780
versioned and not present in the working tree.
782
Everything else results in an error.
784
This returns a list of (from_path, to_path) pairs for each
787
raise NotImplementedError(self.move)
789
def copy_one(self, from_rel, to_rel):
790
"""Copy a file in the tree to a new location.
792
This default implementation just copies the file, then
795
:param from_rel: From location (relative to tree root)
796
:param to_rel: Target location (relative to tree root)
798
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
802
"""Return all unknown files.
804
These are files in the working directory that are not versioned or
805
control files or ignored.
807
with self.lock_read():
808
# force the extras method to be fully executed before returning, to
809
# prevent race conditions with the lock
811
[subp for subp in self.extras() if not self.is_ignored(subp)])
813
def unversion(self, paths):
814
"""Remove the path in pahs from the current versioned set.
816
When a path is unversioned, all of its children are automatically
819
:param paths: The paths to stop versioning.
820
:raises NoSuchFile: if any path is not currently versioned.
822
raise NotImplementedError(self.unversion)
824
def pull(self, source, overwrite=False, stop_revision=None,
825
change_reporter=None, possible_transports=None, local=False,
826
show_base=False, tag_selector=None):
827
with self.lock_write(), source.lock_read():
828
old_revision_info = self.branch.last_revision_info()
829
basis_tree = self.basis_tree()
830
count = self.branch.pull(source, overwrite, stop_revision,
831
possible_transports=possible_transports,
832
local=local, tag_selector=tag_selector)
833
new_revision_info = self.branch.last_revision_info()
834
if new_revision_info != old_revision_info:
835
repository = self.branch.repository
836
if repository._format.fast_deltas:
837
parent_ids = self.get_parent_ids()
839
basis_id = parent_ids[0]
840
basis_tree = repository.revision_tree(basis_id)
841
with basis_tree.lock_read():
842
new_basis_tree = self.branch.basis_tree()
848
change_reporter=change_reporter,
850
basis_root_id = basis_tree.path2id('')
851
new_root_id = new_basis_tree.path2id('')
852
if new_root_id is not None and basis_root_id != new_root_id:
853
self.set_root_id(new_root_id)
854
# TODO - dedup parents list with things merged by pull ?
855
# reuse the revisiontree we merged against to set the new
858
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
860
(self.branch.last_revision(), new_basis_tree))
861
# we have to pull the merge trees out again, because
862
# merge_inner has set the ids. - this corner is not yet
863
# layered well enough to prevent double handling.
864
# XXX TODO: Fix the double handling: telling the tree about
865
# the already known parent data is wasteful.
866
merges = self.get_parent_ids()[1:]
867
parent_trees.extend([
868
(parent, repository.revision_tree(parent)) for
870
self.set_parent_trees(parent_trees)
873
def put_file_bytes_non_atomic(self, path, bytes):
874
"""See MutableTree.put_file_bytes_non_atomic."""
875
with self.lock_write(), open(self.abspath(path), 'wb') as stream:
879
"""Yield all unversioned files in this WorkingTree.
881
If there are any unversioned directories and the file format
882
supports versioning directories, then only the directory is returned,
883
not all its children. But if there are unversioned files under a
884
versioned subdirectory, they are returned.
886
Currently returned depth-first, sorted by name within directories.
887
This is the same order used by 'osutils.walkdirs'.
889
raise NotImplementedError(self.extras)
891
def ignored_files(self):
892
"""Yield list of PATH, IGNORE_PATTERN"""
893
for subp in self.extras():
894
pat = self.is_ignored(subp)
898
def is_ignored(self, filename):
899
r"""Check whether the filename matches an ignore pattern.
901
raise NotImplementedError(self.is_ignored)
903
def stored_kind(self, path):
904
"""See Tree.stored_kind"""
905
raise NotImplementedError(self.stored_kind)
907
def _comparison_data(self, entry, path):
908
abspath = self.abspath(path)
910
stat_value = os.lstat(abspath)
912
if getattr(e, 'errno', None) == errno.ENOENT:
919
mode = stat_value.st_mode
920
kind = osutils.file_kind_from_stat_mode(mode)
921
if not self._supports_executable():
922
executable = entry is not None and entry.executable
924
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
925
return kind, executable, stat_value
927
def last_revision(self):
928
"""Return the last revision of the branch for this tree.
930
This format tree does not support a separate marker for last-revision
931
compared to the branch.
933
See MutableTree.last_revision
935
return self._last_revision()
937
def _last_revision(self):
938
"""helper for get_parent_ids."""
939
with self.lock_read():
940
return _mod_revision.ensure_null(self.branch.last_revision())
943
"""Check if this tree is locked."""
944
raise NotImplementedError(self.is_locked)
947
"""Lock the tree for reading.
949
This also locks the branch, and can be unlocked via self.unlock().
951
:return: A breezy.lock.LogicalLockResult.
953
raise NotImplementedError(self.lock_read)
955
def lock_tree_write(self):
956
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
958
:return: A breezy.lock.LogicalLockResult.
960
raise NotImplementedError(self.lock_tree_write)
962
def lock_write(self):
963
"""See MutableTree.lock_write, and WorkingTree.unlock.
965
:return: A breezy.lock.LogicalLockResult.
967
raise NotImplementedError(self.lock_write)
969
def get_physical_lock_status(self):
970
raise NotImplementedError(self.get_physical_lock_status)
972
def set_last_revision(self, new_revision):
973
"""Change the last revision in the working tree."""
974
raise NotImplementedError(self.set_last_revision)
976
def _change_last_revision(self, new_revision):
977
"""Template method part of set_last_revision to perform the change.
979
This is used to allow WorkingTree3 instances to not affect branch
980
when their last revision is set.
982
if _mod_revision.is_null(new_revision):
983
self.branch.set_last_revision_info(0, new_revision)
985
_mod_revision.check_not_reserved_id(new_revision)
987
self.branch.generate_revision_history(new_revision)
988
except errors.NoSuchRevision:
989
# not present in the repo - dont try to set it deeper than the tip
990
self.branch._set_revision_history([new_revision])
993
def remove(self, files, verbose=False, to_file=None, keep_files=True,
995
"""Remove nominated files from the working tree metadata.
997
:files: File paths relative to the basedir.
998
:keep_files: If true, the files will also be kept.
999
:force: Delete files and directories, even if they are changed and
1000
even if the directories are not empty.
1002
raise NotImplementedError(self.remove)
1004
def revert(self, filenames=None, old_tree=None, backups=True,
1005
pb=None, report_changes=False):
1006
from .conflicts import resolve
1007
with contextlib.ExitStack() as exit_stack:
1008
exit_stack.enter_context(self.lock_tree_write())
1009
if old_tree is None:
1010
basis_tree = self.basis_tree()
1011
exit_stack.enter_context(basis_tree.lock_read())
1012
old_tree = basis_tree
1015
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1017
if filenames is None and len(self.get_parent_ids()) > 1:
1019
last_revision = self.last_revision()
1020
if last_revision != _mod_revision.NULL_REVISION:
1021
if basis_tree is None:
1022
basis_tree = self.basis_tree()
1023
exit_stack.enter_context(basis_tree.lock_read())
1024
parent_trees.append((last_revision, basis_tree))
1025
self.set_parent_trees(parent_trees)
1028
resolve(self, filenames, ignore_misses=True, recursive=True)
1031
def store_uncommitted(self):
1032
"""Store uncommitted changes from the tree in the branch."""
1033
raise NotImplementedError(self.store_uncommitted)
1035
def restore_uncommitted(self):
1036
"""Restore uncommitted changes from the branch into the tree."""
1037
raise NotImplementedError(self.restore_uncommitted)
1039
def revision_tree(self, revision_id):
1040
"""See Tree.revision_tree.
1042
For trees that can be obtained from the working tree, this
1043
will do so. For other trees, it will fall back to the repository.
1045
raise NotImplementedError(self.revision_tree)
1047
def set_root_id(self, file_id):
1048
"""Set the root id for this tree."""
1049
if not self.supports_setting_file_ids():
1050
raise SettingFileIdUnsupported()
1051
with self.lock_tree_write():
1055
'WorkingTree.set_root_id with fileid=None')
1056
self._set_root_id(file_id)
1058
def _set_root_id(self, file_id):
1059
"""Set the root id for this tree, in a format specific manner.
1061
:param file_id: The file id to assign to the root. It must not be
1062
present in the current inventory or an error will occur. It must
1063
not be None, but rather a valid file id.
1065
raise NotImplementedError(self._set_root_id)
1068
"""See Branch.unlock.
1070
WorkingTree locking just uses the Branch locking facilities.
1071
This is current because all working trees have an embedded branch
1072
within them. IF in the future, we were to make branch data shareable
1073
between multiple working trees, i.e. via shared storage, then we
1074
would probably want to lock both the local tree, and the branch.
1076
raise NotImplementedError(self.unlock)
1080
def update(self, change_reporter=None, possible_transports=None,
1081
revision=None, old_tip=_marker, show_base=False):
1082
"""Update a working tree along its branch.
1084
This will update the branch if its bound too, which means we have
1085
multiple trees involved:
1087
- The new basis tree of the master.
1088
- The old basis tree of the branch.
1089
- The old basis tree of the working tree.
1090
- The current working tree state.
1092
Pathologically, all three may be different, and non-ancestors of each
1093
other. Conceptually we want to:
1095
- Preserve the wt.basis->wt.state changes
1096
- Transform the wt.basis to the new master basis.
1097
- Apply a merge of the old branch basis to get any 'local' changes from
1099
- Restore the wt.basis->wt.state changes.
1101
There isn't a single operation at the moment to do that, so we:
1103
- Merge current state -> basis tree of the master w.r.t. the old tree
1105
- Do a 'normal' merge of the old branch basis if it is relevant.
1107
:param revision: The target revision to update to. Must be in the
1109
:param old_tip: If branch.update() has already been run, the value it
1110
returned (old tip of the branch or None). _marker is used
1113
if self.branch.get_bound_location() is not None:
1115
update_branch = (old_tip is self._marker)
1117
self.lock_tree_write()
1118
update_branch = False
1121
old_tip = self.branch.update(possible_transports)
1123
if old_tip is self._marker:
1125
return self._update_tree(old_tip, change_reporter, revision, show_base)
1129
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1131
"""Update a tree to the master branch.
1133
:param old_tip: if supplied, the previous tip revision the branch,
1134
before it was changed to the master branch's tip.
1136
# here if old_tip is not None, it is the old tip of the branch before
1137
# it was updated from the master branch. This should become a pending
1138
# merge in the working tree to preserve the user existing work. we
1139
# cant set that until we update the working trees last revision to be
1140
# one from the new branch, because it will just get absorbed by the
1141
# parent de-duplication logic.
1143
# We MUST save it even if an error occurs, because otherwise the users
1144
# local work is unreferenced and will appear to have been lost.
1146
with self.lock_tree_write():
1149
last_rev = self.get_parent_ids()[0]
1151
last_rev = _mod_revision.NULL_REVISION
1152
if revision is None:
1153
revision = self.branch.last_revision()
1155
old_tip = old_tip or _mod_revision.NULL_REVISION
1157
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1158
# the branch we are bound to was updated
1159
# merge those changes in first
1160
base_tree = self.basis_tree()
1161
other_tree = self.branch.repository.revision_tree(old_tip)
1162
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1163
base_tree, this_tree=self,
1164
change_reporter=change_reporter,
1165
show_base=show_base)
1167
self.add_parent_tree((old_tip, other_tree))
1168
note(gettext('Rerun update after fixing the conflicts.'))
1171
if last_rev != _mod_revision.ensure_null(revision):
1172
# the working tree is up to date with the branch
1173
# we can merge the specified revision from master
1174
to_tree = self.branch.repository.revision_tree(revision)
1175
to_root_id = to_tree.path2id('')
1177
basis = self.basis_tree()
1178
with basis.lock_read():
1179
if (basis.path2id('') is None or basis.path2id('') != to_root_id):
1180
self.set_root_id(to_root_id)
1183
# determine the branch point
1184
graph = self.branch.repository.get_graph()
1185
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1187
base_tree = self.branch.repository.revision_tree(base_rev_id)
1189
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1191
change_reporter=change_reporter,
1192
show_base=show_base)
1193
self.set_last_revision(revision)
1194
# TODO - dedup parents list with things merged by pull ?
1195
# reuse the tree we've updated to to set the basis:
1196
parent_trees = [(revision, to_tree)]
1197
merges = self.get_parent_ids()[1:]
1198
# Ideally we ask the tree for the trees here, that way the working
1199
# tree can decide whether to give us the entire tree or give us a
1200
# lazy initialised tree. dirstate for instance will have the trees
1201
# in ram already, whereas a last-revision + basis-inventory tree
1202
# will not, but also does not need them when setting parents.
1203
for parent in merges:
1204
parent_trees.append(
1205
(parent, self.branch.repository.revision_tree(parent)))
1206
if not _mod_revision.is_null(old_tip):
1207
parent_trees.append(
1208
(old_tip, self.branch.repository.revision_tree(old_tip)))
1209
self.set_parent_trees(parent_trees)
1210
last_rev = parent_trees[0][0]
1213
def set_conflicts(self, arg):
1214
raise errors.UnsupportedOperation(self.set_conflicts, self)
1216
def add_conflicts(self, arg):
1217
raise errors.UnsupportedOperation(self.add_conflicts, self)
1219
def conflicts(self):
1220
raise NotImplementedError(self.conflicts)
1222
def walkdirs(self, prefix=""):
1223
"""Walk the directories of this tree.
1225
returns a generator which yields items in the form:
1226
(current_directory_path,
1227
[(file1_path, file1_name, file1_kind, (lstat),
1230
This API returns a generator, which is only valid during the current
1231
tree transaction - within a single lock_read or lock_write duration.
1233
If the tree is not locked, it may cause an error to be raised,
1234
depending on the tree implementation.
1236
raise NotImplementedError(self.walkdirs)
1238
@deprecated_method(deprecated_in((3, 0, 1)))
1239
def auto_resolve(self):
1240
"""Automatically resolve text conflicts according to contents.
1242
Only text conflicts are auto_resolvable. Files with no conflict markers
1243
are considered 'resolved', because bzr always puts conflict markers
1244
into files that have text conflicts. The corresponding .THIS .BASE and
1245
.OTHER files are deleted, as per 'resolve'.
1247
:return: a tuple of lists: (un_resolved, resolved).
1249
with self.lock_tree_write():
1252
for conflict in self.conflicts():
1254
conflict.action_auto(self)
1255
except NotImplementedError:
1256
un_resolved.append(conflict)
1258
conflict.cleanup(self)
1259
resolved.append(conflict)
1260
self.set_conflicts(un_resolved)
1261
return un_resolved, resolved
1263
def _validate(self):
1264
"""Validate internal structures.
1266
This is meant mostly for the test suite. To give it a chance to detect
1267
corruption after actions have occurred. The default implementation is a
1270
:return: None. An exception should be raised if there is an error.
1274
def check_state(self):
1275
"""Check that the working state is/isn't valid."""
1276
raise NotImplementedError(self.check_state)
1278
def reset_state(self, revision_ids=None):
1279
"""Reset the state of the working tree.
1281
This does a hard-reset to a last-known-good state. This is a way to
1282
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1284
raise NotImplementedError(self.reset_state)
1286
def _get_rules_searcher(self, default_searcher):
1287
"""See Tree._get_rules_searcher."""
1288
if self._rules_searcher is None:
1289
self._rules_searcher = super(WorkingTree,
1290
self)._get_rules_searcher(default_searcher)
1291
return self._rules_searcher
1293
def get_shelf_manager(self):
1294
"""Return the ShelfManager for this WorkingTree."""
1295
raise NotImplementedError(self.get_shelf_manager)
1297
def get_canonical_paths(self, paths):
1298
"""Like get_canonical_path() but works on multiple items.
1300
:param paths: A sequence of paths relative to the root of the tree.
1301
:return: A list of paths, with each item the corresponding input path
1302
adjusted to account for existing elements that match case
1305
with self.lock_read():
1309
def get_canonical_path(self, path):
1310
"""Returns the first item in the tree that matches a path.
1312
This is meant to allow case-insensitive path lookups on e.g.
1315
If a path matches exactly, it is returned. If no path matches exactly
1316
but more than one path matches according to the underlying file system,
1317
it is implementation defined which is returned.
1319
If no path matches according to the file system, the input path is
1320
returned, but with as many path entries that do exist changed to their
1323
If you need to resolve many names from the same tree, you should
1324
use get_canonical_paths() to avoid O(N) behaviour.
1326
:param path: A paths relative to the root of the tree.
1327
:return: The input path adjusted to account for existing elements
1328
that match case insensitively.
1330
with self.lock_read():
1331
return next(self.get_canonical_paths([path]))
1333
def reference_parent(self, path, branch=None, possible_transports=None):
1334
raise errors.UnsupportedOperation(self.reference_parent, self)
1336
def get_reference_info(self, path, branch=None):
1337
raise errors.UnsupportedOperation(self.get_reference_info, self)
1339
def set_reference_info(self, tree_path, branch_location):
1340
raise errors.UnsupportedOperation(self.set_reference_info, self)
1343
class WorkingTreeFormatRegistry(ControlComponentFormatRegistry):
1344
"""Registry for working tree formats."""
1346
def __init__(self, other_registry=None):
1347
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1348
self._default_format = None
1349
self._default_format_key = None
1351
def get_default(self):
1352
"""Return the current default format."""
1353
if (self._default_format_key is not None and
1354
self._default_format is None):
1355
self._default_format = self.get(self._default_format_key)
1356
return self._default_format
1358
def set_default(self, format):
1359
"""Set the default format."""
1360
self._default_format = format
1361
self._default_format_key = None
1363
def set_default_key(self, format_string):
1364
"""Set the default format by its format string."""
1365
self._default_format_key = format_string
1366
self._default_format = None
1369
format_registry = WorkingTreeFormatRegistry()
1372
class WorkingTreeFormat(ControlComponentFormat):
1373
"""An encapsulation of the initialization and open routines for a format.
1375
Formats provide three things:
1376
* An initialization routine,
1380
Formats are placed in an dict by their format string for reference
1381
during workingtree opening. Its not required that these be instances, they
1382
can be classes themselves with class methods - it simply depends on
1383
whether state is needed for a given format or not.
1385
Once a format is deprecated, just deprecate the initialize and open
1386
methods on the format class. Do not deprecate the object, as the
1387
object will be created every time regardless.
1390
requires_rich_root = False
1392
upgrade_recommended = False
1394
requires_normalized_unicode_filenames = False
1396
case_sensitive_filename = "FoRMaT"
1398
missing_parent_conflicts = False
1399
"""If this format supports missing parent conflicts."""
1401
supports_versioned_directories = None
1403
supports_merge_modified = True
1404
"""If this format supports storing merge modified hashes."""
1406
supports_setting_file_ids = True
1407
"""If this format allows setting the file id."""
1409
supports_store_uncommitted = True
1410
"""If this format supports shelve-like functionality."""
1412
supports_leftmost_parent_id_as_ghost = True
1414
supports_righthand_parent_id_as_ghost = True
1416
ignore_filename = None
1417
"""Name of file with ignore patterns, if any. """
1419
def initialize(self, controldir, revision_id=None, from_branch=None,
1420
accelerator_tree=None, hardlink=False):
1421
"""Initialize a new working tree in controldir.
1423
:param controldir: ControlDir to initialize the working tree in.
1424
:param revision_id: allows creating a working tree at a different
1425
revision than the branch is at.
1426
:param from_branch: Branch to checkout
1427
:param accelerator_tree: A tree which can be used for retrieving file
1428
contents more quickly than the revision tree, i.e. a workingtree.
1429
The revision tree will be used for cases where accelerator_tree's
1430
content is different.
1431
:param hardlink: If true, hard-link files from accelerator_tree,
1434
raise NotImplementedError(self.initialize)
1436
def __eq__(self, other):
1437
return self.__class__ is other.__class__
1439
def __ne__(self, other):
1440
return not (self == other)
1442
def get_format_description(self):
1443
"""Return the short description for this format."""
1444
raise NotImplementedError(self.get_format_description)
1446
def is_supported(self):
1447
"""Is this format supported?
1449
Supported formats can be initialized and opened.
1450
Unsupported formats may not support initialization or committing or
1451
some other features depending on the reason for not being supported.
1455
def supports_content_filtering(self):
1456
"""True if this format supports content filtering."""
1459
def supports_views(self):
1460
"""True if this format supports stored views."""
1463
def get_controldir_for_branch(self):
1464
"""Get the control directory format for creating branches.
1466
This is to support testing of working tree formats that can not exist
1467
in the same control directory as a branch.
1469
return self._matchingcontroldir
1472
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1473
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1474
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1475
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1476
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1477
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1478
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1479
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1480
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
