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
40
from .lazy_import import lazy_import
41
lazy_import(globals(), """
46
conflicts as _mod_conflicts,
49
filters as _mod_filters,
52
revision as _mod_revision,
63
from .i18n import gettext
64
from . import mutabletree
68
from .trace import mutter, note
71
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
74
class SettingFileIdUnsupported(errors.BzrError):
76
_fmt = "This format does not support setting file ids."
79
class ShelvingUnsupported(errors.BzrError):
81
_fmt = "This format does not support shelving changes."
84
class WorkingTree(mutabletree.MutableTree,
85
controldir.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 is_control_filename(self, filename):
131
"""True if filename is the name of a control file in this tree.
133
:param filename: A filename within the tree. This is a relative path
134
from the root of this tree.
136
This is true IF and ONLY IF the filename is part of the meta data
137
that bzr controls in this tree. I.E. a random .bzr directory placed
138
on disk will not be a control file for this tree.
140
return self.controldir.is_control_filename(filename)
143
fget=lambda self: self._branch,
144
doc="""The branch this WorkingTree is connected to.
146
This cannot be set - it is reflective of the actual disk structure
147
the working tree has been constructed from.
150
def has_versioned_directories(self):
151
"""See `Tree.has_versioned_directories`."""
152
return self._format.supports_versioned_directories
154
def _supports_executable(self):
155
if sys.platform == 'win32':
157
# FIXME: Ideally this should check the file system
160
def break_lock(self):
161
"""Break a lock if one is present from another instance.
163
Uses the ui factory to ask for confirmation if the lock may be from
166
This will probe the repository for its lock as well.
168
raise NotImplementedError(self.break_lock)
170
def requires_rich_root(self):
171
return self._format.requires_rich_root
173
def supports_tree_reference(self):
176
def supports_content_filtering(self):
177
return self._format.supports_content_filtering()
179
def supports_views(self):
180
return self.views.supports_views()
182
def supports_setting_file_ids(self):
183
return self._format.supports_setting_file_ids
185
def get_config_stack(self):
186
"""Retrieve the config stack for this tree.
188
:return: A ``breezy.config.Stack``
190
# For the moment, just provide the branch config stack.
191
return self.branch.get_config_stack()
194
def open(path=None, _unsupported=False):
195
"""Open an existing working tree at path.
199
path = osutils.getcwd()
200
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
201
return control.open_workingtree(unsupported=_unsupported)
204
def open_containing(path=None):
205
"""Open an existing working tree which has its root about path.
207
This probes for a working tree at path and searches upwards from there.
209
Basically we keep looking up until we find the control directory or
210
run into /. If there isn't one, raises NotBranchError.
211
TODO: give this a new exception.
212
If there is one, it is returned, along with the unused portion of path.
214
:return: The WorkingTree that contains 'path', and the rest of path
217
path = osutils.getcwd()
218
control, relpath = controldir.ControlDir.open_containing(path)
219
return control.open_workingtree(), relpath
222
def open_containing_paths(file_list, default_directory=None,
223
canonicalize=True, apply_view=True):
224
"""Open the WorkingTree that contains a set of paths.
226
Fail if the paths given are not all in a single tree.
228
This is used for the many command-line interfaces that take a list of
229
any number of files and that require they all be in the same tree.
231
if default_directory is None:
232
default_directory = u'.'
233
# recommended replacement for builtins.internal_tree_files
234
if file_list is None or len(file_list) == 0:
235
tree = WorkingTree.open_containing(default_directory)[0]
236
# XXX: doesn't really belong here, and seems to have the strange
237
# side effect of making it return a bunch of files, not the whole
238
# tree -- mbp 20100716
239
if tree.supports_views() and apply_view:
240
view_files = tree.views.lookup_view()
242
file_list = view_files
243
view_str = views.view_display_str(view_files)
244
note(gettext("Ignoring files outside view. View is %s") % view_str)
245
return tree, file_list
246
if default_directory == u'.':
249
seed = default_directory
250
file_list = [osutils.pathjoin(default_directory, f)
252
tree = WorkingTree.open_containing(seed)[0]
253
return tree, tree.safe_relpath_files(file_list, canonicalize,
254
apply_view=apply_view)
256
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
257
"""Convert file_list into a list of relpaths in tree.
259
:param self: A tree to operate on.
260
:param file_list: A list of user provided paths or None.
261
:param apply_view: if True and a view is set, apply it or check that
262
specified files are within it
263
:return: A list of relative paths.
264
:raises errors.PathNotChild: When a provided path is in a different self
267
if file_list is None:
269
if self.supports_views() and apply_view:
270
view_files = self.views.lookup_view()
274
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
275
# doesn't - fix that up here before we enter the loop.
277
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
280
for filename in file_list:
281
relpath = fixer(osutils.dereference_path(filename))
282
if view_files and not osutils.is_inside_any(view_files, relpath):
283
raise views.FileOutsideView(filename, view_files)
284
new_list.append(relpath)
288
def open_downlevel(path=None):
289
"""Open an unsupported working tree.
291
Only intended for advanced situations like upgrading part of a controldir.
293
return WorkingTree.open(path, _unsupported=True)
296
def find_trees(location):
297
def list_current(transport):
298
return [d for d in transport.list_dir('')
299
if not controldir.is_control_filename(d)]
300
def evaluate(controldir):
302
tree = controldir.open_workingtree()
303
except errors.NoWorkingTree:
307
t = transport.get_transport(location)
308
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
309
list_current=list_current)
310
return [tr for tr in iterator if tr is not None]
313
return "<%s of %s>" % (self.__class__.__name__,
314
getattr(self, 'basedir', None))
316
def abspath(self, filename):
317
return osutils.pathjoin(self.basedir, filename)
319
def basis_tree(self):
320
"""Return RevisionTree for the current last revision.
322
If the left most parent is a ghost then the returned tree will be an
323
empty tree - one obtained by calling
324
repository.revision_tree(NULL_REVISION).
327
revision_id = self.get_parent_ids()[0]
329
# no parents, return an empty revision tree.
330
# in the future this should return the tree for
331
# 'empty:' - the implicit root empty tree.
332
return self.branch.repository.revision_tree(
333
_mod_revision.NULL_REVISION)
335
return self.revision_tree(revision_id)
336
except errors.NoSuchRevision:
338
# No cached copy available, retrieve from the repository.
339
# FIXME? RBC 20060403 should we cache the tree locally
342
return self.branch.repository.revision_tree(revision_id)
343
except (errors.RevisionNotPresent, errors.NoSuchRevision):
344
# the basis tree *may* be a ghost or a low level error may have
345
# occurred. If the revision is present, its a problem, if its not
347
if self.branch.repository.has_revision(revision_id):
349
# the basis tree is a ghost so return an empty tree.
350
return self.branch.repository.revision_tree(
351
_mod_revision.NULL_REVISION)
353
def relpath(self, path):
354
"""Return the local path portion from a given path.
356
The path may be absolute or relative. If its a relative path it is
357
interpreted relative to the python current working directory.
359
return osutils.relpath(self.basedir, path)
361
def has_filename(self, filename):
362
return osutils.lexists(self.abspath(filename))
364
def get_file(self, path, file_id=None, filtered=True):
365
return self.get_file_with_stat(path, file_id, filtered=filtered)[0]
367
def get_file_with_stat(self, path, file_id=None, filtered=True,
368
_fstat=osutils.fstat):
369
"""See Tree.get_file_with_stat."""
370
abspath = self.abspath(path)
371
file_obj = file(abspath, 'rb')
372
stat_value = _fstat(file_obj.fileno())
373
if filtered and self.supports_content_filtering():
374
filters = self._content_filter_stack(path)
375
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
376
return (file_obj, stat_value)
378
def get_file_text(self, path, file_id=None, filtered=True):
379
my_file = self.get_file(path, file_id, filtered=filtered)
381
return my_file.read()
385
def get_file_lines(self, path, file_id=None, filtered=True):
386
"""See Tree.get_file_lines()"""
387
file = self.get_file(path, file_id, filtered=filtered)
389
return file.readlines()
393
def get_parent_ids(self):
394
"""See Tree.get_parent_ids.
396
This implementation reads the pending merges list and last_revision
397
value and uses that to decide what the parents list should be.
399
last_rev = _mod_revision.ensure_null(self._last_revision())
400
if _mod_revision.NULL_REVISION == last_rev:
405
merges_bytes = self._transport.get_bytes('pending-merges')
406
except errors.NoSuchFile:
409
for l in osutils.split_lines(merges_bytes):
410
revision_id = l.rstrip('\n')
411
parents.append(revision_id)
414
def get_root_id(self):
415
"""Return the id of this trees root"""
416
raise NotImplementedError(self.get_root_id)
418
def clone(self, to_controldir, revision_id=None):
419
"""Duplicate this working tree into to_bzr, including all state.
421
Specifically modified files are kept as modified, but
422
ignored and unknown files are discarded.
424
If you want to make a new line of development, see ControlDir.sprout()
427
If not None, the cloned tree will have its last revision set to
428
revision, and difference between the source trees last revision
429
and this one merged in.
431
with self.lock_read():
432
# assumes the target bzr dir format is compatible.
433
result = to_controldir.create_workingtree()
434
self.copy_content_into(result, revision_id)
437
def copy_content_into(self, tree, revision_id=None):
438
"""Copy the current content and user files of this tree into tree."""
439
with self.lock_read():
440
tree.set_root_id(self.get_root_id())
441
if revision_id is None:
442
merge.transform_tree(tree, self)
444
# TODO now merge from tree.last_revision to revision (to
445
# preserve user local changes)
447
other_tree = self.revision_tree(revision_id)
448
except errors.NoSuchRevision:
449
other_tree = self.branch.repository.revision_tree(
452
merge.transform_tree(tree, other_tree)
453
if revision_id == _mod_revision.NULL_REVISION:
456
new_parents = [revision_id]
457
tree.set_parent_ids(new_parents)
459
def id2abspath(self, file_id):
460
return self.abspath(self.id2path(file_id))
462
def get_file_size(self, path, file_id=None):
463
"""See Tree.get_file_size"""
464
# XXX: this returns the on-disk size; it should probably return the
467
return os.path.getsize(self.abspath(path))
469
if e.errno != errno.ENOENT:
474
def _gather_kinds(self, files, kinds):
475
"""See MutableTree._gather_kinds."""
476
with self.lock_tree_write():
477
for pos, f in enumerate(files):
478
if kinds[pos] is None:
479
fullpath = osutils.normpath(self.abspath(f))
481
kinds[pos] = osutils.file_kind(fullpath)
483
if e.errno == errno.ENOENT:
484
raise errors.NoSuchFile(fullpath)
486
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
487
"""Add revision_id as a parent.
489
This is equivalent to retrieving the current list of parent ids
490
and setting the list to its value plus revision_id.
492
:param revision_id: The revision id to add to the parent list. It may
493
be a ghost revision as long as its not the first parent to be
494
added, or the allow_leftmost_as_ghost parameter is set True.
495
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
497
with self.lock_write():
498
parents = self.get_parent_ids() + [revision_id]
499
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
500
or allow_leftmost_as_ghost)
502
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
503
"""Add revision_id, tree tuple as a parent.
505
This is equivalent to retrieving the current list of parent trees
506
and setting the list to its value plus parent_tuple. See also
507
add_parent_tree_id - if you only have a parent id available it will be
508
simpler to use that api. If you have the parent already available, using
509
this api is preferred.
511
:param parent_tuple: The (revision id, tree) to add to the parent list.
512
If the revision_id is a ghost, pass None for the tree.
513
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
515
with self.lock_tree_write():
516
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
517
if len(parent_ids) > 1:
518
# the leftmost may have already been a ghost, preserve that if it
520
allow_leftmost_as_ghost = True
521
self.set_parent_ids(parent_ids,
522
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
524
def add_pending_merge(self, *revision_ids):
525
with self.lock_tree_write():
526
# TODO: Perhaps should check at this point that the
527
# history of the revision is actually present?
528
parents = self.get_parent_ids()
530
for rev_id in revision_ids:
531
if rev_id in parents:
533
parents.append(rev_id)
536
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
538
def path_content_summary(self, path, _lstat=os.lstat,
539
_mapper=osutils.file_kind_from_stat_mode):
540
"""See Tree.path_content_summary."""
541
abspath = self.abspath(path)
543
stat_result = _lstat(abspath)
545
if getattr(e, 'errno', None) == errno.ENOENT:
547
return ('missing', None, None, None)
548
# propagate other errors
550
kind = _mapper(stat_result.st_mode)
552
return self._file_content_summary(path, stat_result)
553
elif kind == 'directory':
554
# perhaps it looks like a plain directory, but it's really a
556
if self._directory_is_tree_reference(path):
557
kind = 'tree-reference'
558
return kind, None, None, None
559
elif kind == 'symlink':
560
target = osutils.readlink(abspath)
561
return ('symlink', None, None, target)
563
return (kind, None, None, None)
565
def _file_content_summary(self, path, stat_result):
566
size = stat_result.st_size
567
executable = self._is_executable_from_path_and_stat(path, stat_result)
568
# try for a stat cache lookup
569
return ('file', size, executable, self._sha_from_stat(
572
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
573
"""Common ghost checking functionality from set_parent_*.
575
This checks that the left hand-parent exists if there are any
578
if len(revision_ids) > 0:
579
leftmost_id = revision_ids[0]
580
if (not allow_leftmost_as_ghost and not
581
self.branch.repository.has_revision(leftmost_id)):
582
raise errors.GhostRevisionUnusableHere(leftmost_id)
584
def _set_merges_from_parent_ids(self, parent_ids):
585
merges = parent_ids[1:]
586
self._transport.put_bytes('pending-merges', '\n'.join(merges),
587
mode=self.controldir._get_file_mode())
589
def _filter_parent_ids_by_ancestry(self, revision_ids):
590
"""Check that all merged revisions are proper 'heads'.
592
This will always return the first revision_id, and any merged revisions
595
if len(revision_ids) == 0:
597
graph = self.branch.repository.get_graph()
598
heads = graph.heads(revision_ids)
599
new_revision_ids = revision_ids[:1]
600
for revision_id in revision_ids[1:]:
601
if revision_id in heads and revision_id not in new_revision_ids:
602
new_revision_ids.append(revision_id)
603
if new_revision_ids != revision_ids:
604
mutter('requested to set revision_ids = %s,'
605
' but filtered to %s', revision_ids, new_revision_ids)
606
return new_revision_ids
608
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
609
"""Set the parent ids to revision_ids.
611
See also set_parent_trees. This api will try to retrieve the tree data
612
for each element of revision_ids from the trees repository. If you have
613
tree data already available, it is more efficient to use
614
set_parent_trees rather than set_parent_ids. set_parent_ids is however
615
an easier API to use.
617
:param revision_ids: The revision_ids to set as the parent ids of this
618
working tree. Any of these may be ghosts.
620
with self.lock_tree_write():
621
self._check_parents_for_ghosts(revision_ids,
622
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
623
for revision_id in revision_ids:
624
_mod_revision.check_not_reserved_id(revision_id)
626
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
628
if len(revision_ids) > 0:
629
self.set_last_revision(revision_ids[0])
631
self.set_last_revision(_mod_revision.NULL_REVISION)
633
self._set_merges_from_parent_ids(revision_ids)
635
def set_pending_merges(self, rev_list):
636
with self.lock_tree_write():
637
parents = self.get_parent_ids()
638
leftmost = parents[:1]
639
new_parents = leftmost + rev_list
640
self.set_parent_ids(new_parents)
642
def set_merge_modified(self, modified_hashes):
643
"""Set the merge modified hashes."""
644
raise NotImplementedError(self.set_merge_modified)
646
def _sha_from_stat(self, path, stat_result):
647
"""Get a sha digest from the tree's stat cache.
649
The default implementation assumes no stat cache is present.
651
:param path: The path.
652
:param stat_result: The stat result being looked up.
656
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
657
merge_type=None, force=False):
658
"""Merge from a branch into this working tree.
660
:param branch: The branch to merge from.
661
:param to_revision: If non-None, the merge will merge to to_revision,
662
but not beyond it. to_revision does not need to be in the history
663
of the branch when it is supplied. If None, to_revision defaults to
664
branch.last_revision().
666
from .merge import Merger, Merge3Merger
667
with self.lock_write():
668
merger = Merger(self.branch, this_tree=self)
669
# check that there are no local alterations
670
if not force and self.has_changes():
671
raise errors.UncommittedChanges(self)
672
if to_revision is None:
673
to_revision = _mod_revision.ensure_null(branch.last_revision())
674
merger.other_rev_id = to_revision
675
if _mod_revision.is_null(merger.other_rev_id):
676
raise errors.NoCommits(branch)
677
self.branch.fetch(branch, last_revision=merger.other_rev_id)
678
merger.other_basis = merger.other_rev_id
679
merger.other_tree = self.branch.repository.revision_tree(
681
merger.other_branch = branch
682
if from_revision is None:
685
merger.set_base_revision(from_revision, branch)
686
if merger.base_rev_id == merger.other_rev_id:
687
raise errors.PointlessMerge
688
merger.backup_files = False
689
if merge_type is None:
690
merger.merge_type = Merge3Merger
692
merger.merge_type = merge_type
693
merger.set_interesting_files(None)
694
merger.show_base = False
695
merger.reprocess = False
696
conflicts = merger.do_merge()
700
def merge_modified(self):
701
"""Return a dictionary of files modified by a merge.
703
The list is initialized by WorkingTree.set_merge_modified, which is
704
typically called after we make some automatic updates to the tree
707
This returns a map of file_id->sha1, containing only files which are
708
still in the working tree and have that text hash.
710
raise NotImplementedError(self.merge_modified)
712
def mkdir(self, path, file_id=None):
713
"""See MutableTree.mkdir()."""
715
if self.supports_setting_file_ids():
716
file_id = generate_ids.gen_file_id(os.path.basename(path))
718
if not self.supports_setting_file_ids():
719
raise SettingFileIdUnsupported()
720
with self.lock_write():
721
os.mkdir(self.abspath(path))
722
self.add(path, file_id, 'directory')
725
def get_symlink_target(self, path, file_id=None):
727
abspath = self.abspath(path)
729
abspath = self.id2abspath(file_id)
730
target = osutils.readlink(abspath)
733
def subsume(self, other_tree):
734
raise NotImplementedError(self.subsume)
736
def _setup_directory_is_tree_reference(self):
737
if self._branch.repository._format.supports_tree_reference:
738
self._directory_is_tree_reference = \
739
self._directory_may_be_tree_reference
741
self._directory_is_tree_reference = \
742
self._directory_is_never_tree_reference
744
def _directory_is_never_tree_reference(self, relpath):
747
def _directory_may_be_tree_reference(self, relpath):
748
# as a special case, if a directory contains control files then
749
# it's a tree reference, except that the root of the tree is not
750
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
751
# TODO: We could ask all the control formats whether they
752
# recognize this directory, but at the moment there's no cheap api
753
# to do that. Since we probably can only nest bzr checkouts and
754
# they always use this name it's ok for now. -- mbp 20060306
756
# FIXME: There is an unhandled case here of a subdirectory
757
# containing .bzr but not a branch; that will probably blow up
758
# when you try to commit it. It might happen if there is a
759
# checkout in a subdirectory. This can be avoided by not adding
762
def extract(self, path, file_id=None, format=None):
763
"""Extract a subtree from this tree.
765
A new branch will be created, relative to the path for this tree.
767
raise NotImplementedError(self.extract)
770
"""Write the in memory meta data to disk."""
771
raise NotImplementedError(self.flush)
773
def kind(self, relpath, file_id=None):
774
if file_id is not None:
775
return osutils.file_kind(self.id2abspath(file_id))
776
return osutils.file_kind(self.abspath(relpath))
778
def list_files(self, include_root=False, from_dir=None, recursive=True):
779
"""List all files as (path, class, kind, id, entry).
781
Lists, but does not descend into unversioned directories.
782
This does not include files that have been deleted in this
783
tree. Skips the control directory.
785
:param include_root: if True, return an entry for the root
786
:param from_dir: start from this directory or None for the root
787
:param recursive: whether to recurse into subdirectories or not
789
raise NotImplementedError(self.list_files)
791
def move(self, from_paths, to_dir=None, after=False):
794
to_dir must be known to the working tree.
796
If to_dir exists and is a directory, the files are moved into
797
it, keeping their old names.
799
Note that to_dir is only the last component of the new name;
800
this doesn't change the directory.
802
For each entry in from_paths the move mode will be determined
805
The first mode moves the file in the filesystem and updates the
806
working tree metadata. The second mode only updates the working tree
807
metadata without touching the file on the filesystem.
809
move uses the second mode if 'after == True' and the target is not
810
versioned but present in the working tree.
812
move uses the second mode if 'after == False' and the source is
813
versioned but no longer in the working tree, and the target is not
814
versioned but present in the working tree.
816
move uses the first mode if 'after == False' and the source is
817
versioned and present in the working tree, and the target is not
818
versioned and not present in the working tree.
820
Everything else results in an error.
822
This returns a list of (from_path, to_path) pairs for each
825
raise NotImplementedError(self.move)
827
def copy_one(self, from_rel, to_rel):
828
"""Copy a file in the tree to a new location.
830
This default implementation just copies the file, then
833
:param from_rel: From location (relative to tree root)
834
:param to_rel: Target location (relative to tree root)
836
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
840
"""Return all unknown files.
842
These are files in the working directory that are not versioned or
843
control files or ignored.
845
with self.lock_read():
846
# force the extras method to be fully executed before returning, to
847
# prevent race conditions with the lock
849
[subp for subp in self.extras() if not self.is_ignored(subp)])
851
def unversion(self, paths):
852
"""Remove the path in pahs from the current versioned set.
854
When a path is unversioned, all of its children are automatically
857
:param paths: The paths to stop versioning.
858
:raises NoSuchFile: if any path is not currently versioned.
860
raise NotImplementedError(self.unversion)
862
def pull(self, source, overwrite=False, stop_revision=None,
863
change_reporter=None, possible_transports=None, local=False,
865
with self.lock_write(), source.lock_read():
866
old_revision_info = self.branch.last_revision_info()
867
basis_tree = self.basis_tree()
868
count = self.branch.pull(source, overwrite, stop_revision,
869
possible_transports=possible_transports,
871
new_revision_info = self.branch.last_revision_info()
872
if new_revision_info != old_revision_info:
873
repository = self.branch.repository
874
if repository._format.fast_deltas:
875
parent_ids = self.get_parent_ids()
877
basis_id = parent_ids[0]
878
basis_tree = repository.revision_tree(basis_id)
879
with basis_tree.lock_read():
880
new_basis_tree = self.branch.basis_tree()
886
change_reporter=change_reporter,
888
basis_root_id = basis_tree.get_root_id()
889
new_root_id = new_basis_tree.get_root_id()
890
if new_root_id is not None and basis_root_id != new_root_id:
891
self.set_root_id(new_root_id)
892
# TODO - dedup parents list with things merged by pull ?
893
# reuse the revisiontree we merged against to set the new
896
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
898
(self.branch.last_revision(), new_basis_tree))
899
# we have to pull the merge trees out again, because
900
# merge_inner has set the ids. - this corner is not yet
901
# layered well enough to prevent double handling.
902
# XXX TODO: Fix the double handling: telling the tree about
903
# the already known parent data is wasteful.
904
merges = self.get_parent_ids()[1:]
905
parent_trees.extend([
906
(parent, repository.revision_tree(parent)) for
908
self.set_parent_trees(parent_trees)
911
def put_file_bytes_non_atomic(self, path, bytes, file_id=None):
912
"""See MutableTree.put_file_bytes_non_atomic."""
913
with self.lock_write():
914
stream = file(self.abspath(path), 'wb')
921
"""Yield all unversioned files in this WorkingTree.
923
If there are any unversioned directories then only the directory is
924
returned, not all its children. But if there are unversioned files
925
under a versioned subdirectory, they are returned.
927
Currently returned depth-first, sorted by name within directories.
928
This is the same order used by 'osutils.walkdirs'.
930
raise NotImplementedError(self.extras)
932
def ignored_files(self):
933
"""Yield list of PATH, IGNORE_PATTERN"""
934
for subp in self.extras():
935
pat = self.is_ignored(subp)
939
def is_ignored(self, filename):
940
r"""Check whether the filename matches an ignore pattern.
942
raise NotImplementedError(self.is_ignored)
944
def stored_kind(self, path, file_id=None):
945
"""See Tree.stored_kind"""
946
raise NotImplementedError(self.stored_kind)
948
def _comparison_data(self, entry, path):
949
abspath = self.abspath(path)
951
stat_value = os.lstat(abspath)
953
if getattr(e, 'errno', None) == errno.ENOENT:
960
mode = stat_value.st_mode
961
kind = osutils.file_kind_from_stat_mode(mode)
962
if not self._supports_executable():
963
executable = entry is not None and entry.executable
965
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
966
return kind, executable, stat_value
968
def _file_size(self, entry, stat_value):
969
return stat_value.st_size
971
def last_revision(self):
972
"""Return the last revision of the branch for this tree.
974
This format tree does not support a separate marker for last-revision
975
compared to the branch.
977
See MutableTree.last_revision
979
return self._last_revision()
981
def _last_revision(self):
982
"""helper for get_parent_ids."""
983
with self.lock_read():
984
return _mod_revision.ensure_null(self.branch.last_revision())
987
"""Check if this tree is locked."""
988
raise NotImplementedError(self.is_locked)
991
"""Lock the tree for reading.
993
This also locks the branch, and can be unlocked via self.unlock().
995
:return: A breezy.lock.LogicalLockResult.
997
raise NotImplementedError(self.lock_read)
999
def lock_tree_write(self):
1000
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1002
:return: A breezy.lock.LogicalLockResult.
1004
raise NotImplementedError(self.lock_tree_write)
1006
def lock_write(self):
1007
"""See MutableTree.lock_write, and WorkingTree.unlock.
1009
:return: A breezy.lock.LogicalLockResult.
1011
raise NotImplementedError(self.lock_write)
1013
def get_physical_lock_status(self):
1014
raise NotImplementedError(self.get_physical_lock_status)
1016
def set_last_revision(self, new_revision):
1017
"""Change the last revision in the working tree."""
1018
raise NotImplementedError(self.set_last_revision)
1020
def _change_last_revision(self, new_revision):
1021
"""Template method part of set_last_revision to perform the change.
1023
This is used to allow WorkingTree3 instances to not affect branch
1024
when their last revision is set.
1026
if _mod_revision.is_null(new_revision):
1027
self.branch.set_last_revision_info(0, new_revision)
1029
_mod_revision.check_not_reserved_id(new_revision)
1031
self.branch.generate_revision_history(new_revision)
1032
except errors.NoSuchRevision:
1033
# not present in the repo - dont try to set it deeper than the tip
1034
self.branch._set_revision_history([new_revision])
1037
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1039
"""Remove nominated files from the working tree metadata.
1041
:files: File paths relative to the basedir.
1042
:keep_files: If true, the files will also be kept.
1043
:force: Delete files and directories, even if they are changed and
1044
even if the directories are not empty.
1046
raise NotImplementedError(self.remove)
1048
def revert(self, filenames=None, old_tree=None, backups=True,
1049
pb=None, report_changes=False):
1050
from .conflicts import resolve
1051
with self.lock_tree_write():
1052
if old_tree is None:
1053
basis_tree = self.basis_tree()
1054
basis_tree.lock_read()
1055
old_tree = basis_tree
1059
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1061
if filenames is None and len(self.get_parent_ids()) > 1:
1063
last_revision = self.last_revision()
1064
if last_revision != _mod_revision.NULL_REVISION:
1065
if basis_tree is None:
1066
basis_tree = self.basis_tree()
1067
basis_tree.lock_read()
1068
parent_trees.append((last_revision, basis_tree))
1069
self.set_parent_trees(parent_trees)
1072
resolve(self, filenames, ignore_misses=True, recursive=True)
1074
if basis_tree is not None:
1078
def store_uncommitted(self):
1079
"""Store uncommitted changes from the tree in the branch."""
1080
raise NotImplementedError(self.store_uncommitted)
1082
def restore_uncommitted(self):
1083
"""Restore uncommitted changes from the branch into the tree."""
1084
raise NotImplementedError(self.restore_uncommitted)
1086
def revision_tree(self, revision_id):
1087
"""See Tree.revision_tree.
1089
For trees that can be obtained from the working tree, this
1090
will do so. For other trees, it will fall back to the repository.
1092
raise NotImplementedError(self.revision_tree)
1094
def set_root_id(self, file_id):
1095
"""Set the root id for this tree."""
1096
if not self.supports_setting_file_ids():
1097
raise SettingFileIdUnsupported()
1098
with self.lock_tree_write():
1102
'WorkingTree.set_root_id with fileid=None')
1103
file_id = osutils.safe_file_id(file_id)
1104
self._set_root_id(file_id)
1106
def _set_root_id(self, file_id):
1107
"""Set the root id for this tree, in a format specific manner.
1109
:param file_id: The file id to assign to the root. It must not be
1110
present in the current inventory or an error will occur. It must
1111
not be None, but rather a valid file id.
1113
raise NotImplementedError(self._set_root_id)
1116
"""See Branch.unlock.
1118
WorkingTree locking just uses the Branch locking facilities.
1119
This is current because all working trees have an embedded branch
1120
within them. IF in the future, we were to make branch data shareable
1121
between multiple working trees, i.e. via shared storage, then we
1122
would probably want to lock both the local tree, and the branch.
1124
raise NotImplementedError(self.unlock)
1128
def update(self, change_reporter=None, possible_transports=None,
1129
revision=None, old_tip=_marker, show_base=False):
1130
"""Update a working tree along its branch.
1132
This will update the branch if its bound too, which means we have
1133
multiple trees involved:
1135
- The new basis tree of the master.
1136
- The old basis tree of the branch.
1137
- The old basis tree of the working tree.
1138
- The current working tree state.
1140
Pathologically, all three may be different, and non-ancestors of each
1141
other. Conceptually we want to:
1143
- Preserve the wt.basis->wt.state changes
1144
- Transform the wt.basis to the new master basis.
1145
- Apply a merge of the old branch basis to get any 'local' changes from
1147
- Restore the wt.basis->wt.state changes.
1149
There isn't a single operation at the moment to do that, so we:
1151
- Merge current state -> basis tree of the master w.r.t. the old tree
1153
- Do a 'normal' merge of the old branch basis if it is relevant.
1155
:param revision: The target revision to update to. Must be in the
1157
:param old_tip: If branch.update() has already been run, the value it
1158
returned (old tip of the branch or None). _marker is used
1161
if self.branch.get_bound_location() is not None:
1163
update_branch = (old_tip is self._marker)
1165
self.lock_tree_write()
1166
update_branch = False
1169
old_tip = self.branch.update(possible_transports)
1171
if old_tip is self._marker:
1173
return self._update_tree(old_tip, change_reporter, revision, show_base)
1177
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1179
"""Update a tree to the master branch.
1181
:param old_tip: if supplied, the previous tip revision the branch,
1182
before it was changed to the master branch's tip.
1184
# here if old_tip is not None, it is the old tip of the branch before
1185
# it was updated from the master branch. This should become a pending
1186
# merge in the working tree to preserve the user existing work. we
1187
# cant set that until we update the working trees last revision to be
1188
# one from the new branch, because it will just get absorbed by the
1189
# parent de-duplication logic.
1191
# We MUST save it even if an error occurs, because otherwise the users
1192
# local work is unreferenced and will appear to have been lost.
1194
with self.lock_tree_write():
1197
last_rev = self.get_parent_ids()[0]
1199
last_rev = _mod_revision.NULL_REVISION
1200
if revision is None:
1201
revision = self.branch.last_revision()
1203
old_tip = old_tip or _mod_revision.NULL_REVISION
1205
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1206
# the branch we are bound to was updated
1207
# merge those changes in first
1208
base_tree = self.basis_tree()
1209
other_tree = self.branch.repository.revision_tree(old_tip)
1210
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1211
base_tree, this_tree=self,
1212
change_reporter=change_reporter,
1213
show_base=show_base)
1215
self.add_parent_tree((old_tip, other_tree))
1216
note(gettext('Rerun update after fixing the conflicts.'))
1219
if last_rev != _mod_revision.ensure_null(revision):
1220
# the working tree is up to date with the branch
1221
# we can merge the specified revision from master
1222
to_tree = self.branch.repository.revision_tree(revision)
1223
to_root_id = to_tree.get_root_id()
1225
basis = self.basis_tree()
1226
with basis.lock_read():
1227
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1228
self.set_root_id(to_root_id)
1231
# determine the branch point
1232
graph = self.branch.repository.get_graph()
1233
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1235
base_tree = self.branch.repository.revision_tree(base_rev_id)
1237
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1239
change_reporter=change_reporter,
1240
show_base=show_base)
1241
self.set_last_revision(revision)
1242
# TODO - dedup parents list with things merged by pull ?
1243
# reuse the tree we've updated to to set the basis:
1244
parent_trees = [(revision, to_tree)]
1245
merges = self.get_parent_ids()[1:]
1246
# Ideally we ask the tree for the trees here, that way the working
1247
# tree can decide whether to give us the entire tree or give us a
1248
# lazy initialised tree. dirstate for instance will have the trees
1249
# in ram already, whereas a last-revision + basis-inventory tree
1250
# will not, but also does not need them when setting parents.
1251
for parent in merges:
1252
parent_trees.append(
1253
(parent, self.branch.repository.revision_tree(parent)))
1254
if not _mod_revision.is_null(old_tip):
1255
parent_trees.append(
1256
(old_tip, self.branch.repository.revision_tree(old_tip)))
1257
self.set_parent_trees(parent_trees)
1258
last_rev = parent_trees[0][0]
1261
def set_conflicts(self, arg):
1262
raise errors.UnsupportedOperation(self.set_conflicts, self)
1264
def add_conflicts(self, arg):
1265
raise errors.UnsupportedOperation(self.add_conflicts, self)
1267
def conflicts(self):
1268
raise NotImplementedError(self.conflicts)
1270
def walkdirs(self, prefix=""):
1271
"""Walk the directories of this tree.
1273
returns a generator which yields items in the form:
1274
((curren_directory_path, fileid),
1275
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1278
This API returns a generator, which is only valid during the current
1279
tree transaction - within a single lock_read or lock_write duration.
1281
If the tree is not locked, it may cause an error to be raised,
1282
depending on the tree implementation.
1284
raise NotImplementedError(self.walkdirs)
1286
def auto_resolve(self):
1287
"""Automatically resolve text conflicts according to contents.
1289
Only text conflicts are auto_resolvable. Files with no conflict markers
1290
are considered 'resolved', because bzr always puts conflict markers
1291
into files that have text conflicts. The corresponding .THIS .BASE and
1292
.OTHER files are deleted, as per 'resolve'.
1294
:return: a tuple of ConflictLists: (un_resolved, resolved).
1296
with self.lock_tree_write():
1297
un_resolved = _mod_conflicts.ConflictList()
1298
resolved = _mod_conflicts.ConflictList()
1299
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1300
for conflict in self.conflicts():
1301
if (conflict.typestring != 'text conflict' or
1302
self.kind(self.id2path(conflict.file_id), conflict.file_id) != 'file'):
1303
un_resolved.append(conflict)
1305
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1307
for line in my_file:
1308
if conflict_re.search(line):
1309
un_resolved.append(conflict)
1312
resolved.append(conflict)
1315
resolved.remove_files(self)
1316
self.set_conflicts(un_resolved)
1317
return un_resolved, resolved
1319
def _validate(self):
1320
"""Validate internal structures.
1322
This is meant mostly for the test suite. To give it a chance to detect
1323
corruption after actions have occurred. The default implementation is a
1326
:return: None. An exception should be raised if there is an error.
1330
def check_state(self):
1331
"""Check that the working state is/isn't valid."""
1332
raise NotImplementedError(self.check_state)
1334
def reset_state(self, revision_ids=None):
1335
"""Reset the state of the working tree.
1337
This does a hard-reset to a last-known-good state. This is a way to
1338
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1340
raise NotImplementedError(self.reset_state)
1342
def _get_rules_searcher(self, default_searcher):
1343
"""See Tree._get_rules_searcher."""
1344
if self._rules_searcher is None:
1345
self._rules_searcher = super(WorkingTree,
1346
self)._get_rules_searcher(default_searcher)
1347
return self._rules_searcher
1349
def get_shelf_manager(self):
1350
"""Return the ShelfManager for this WorkingTree."""
1351
raise NotImplementedError(self.get_shelf_manager)
1354
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
1355
"""Registry for working tree formats."""
1357
def __init__(self, other_registry=None):
1358
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1359
self._default_format = None
1360
self._default_format_key = None
1362
def get_default(self):
1363
"""Return the current default format."""
1364
if (self._default_format_key is not None and
1365
self._default_format is None):
1366
self._default_format = self.get(self._default_format_key)
1367
return self._default_format
1369
def set_default(self, format):
1370
"""Set the default format."""
1371
self._default_format = format
1372
self._default_format_key = None
1374
def set_default_key(self, format_string):
1375
"""Set the default format by its format string."""
1376
self._default_format_key = format_string
1377
self._default_format = None
1380
format_registry = WorkingTreeFormatRegistry()
1383
class WorkingTreeFormat(controldir.ControlComponentFormat):
1384
"""An encapsulation of the initialization and open routines for a format.
1386
Formats provide three things:
1387
* An initialization routine,
1391
Formats are placed in an dict by their format string for reference
1392
during workingtree opening. Its not required that these be instances, they
1393
can be classes themselves with class methods - it simply depends on
1394
whether state is needed for a given format or not.
1396
Once a format is deprecated, just deprecate the initialize and open
1397
methods on the format class. Do not deprecate the object, as the
1398
object will be created every time regardless.
1401
requires_rich_root = False
1403
upgrade_recommended = False
1405
requires_normalized_unicode_filenames = False
1407
case_sensitive_filename = "FoRMaT"
1409
missing_parent_conflicts = False
1410
"""If this format supports missing parent conflicts."""
1412
supports_versioned_directories = None
1414
supports_setting_file_ids = True
1415
"""If this format allows setting the file id."""
1417
supports_store_uncommitted = True
1418
"""If this format supports shelve-like functionality."""
1420
supports_leftmost_parent_id_as_ghost = True
1422
def initialize(self, controldir, revision_id=None, from_branch=None,
1423
accelerator_tree=None, hardlink=False):
1424
"""Initialize a new working tree in controldir.
1426
:param controldir: ControlDir to initialize the working tree in.
1427
:param revision_id: allows creating a working tree at a different
1428
revision than the branch is at.
1429
:param from_branch: Branch to checkout
1430
:param accelerator_tree: A tree which can be used for retrieving file
1431
contents more quickly than the revision tree, i.e. a workingtree.
1432
The revision tree will be used for cases where accelerator_tree's
1433
content is different.
1434
:param hardlink: If true, hard-link files from accelerator_tree,
1437
raise NotImplementedError(self.initialize)
1439
def __eq__(self, other):
1440
return self.__class__ is other.__class__
1442
def __ne__(self, other):
1443
return not (self == other)
1445
def get_format_description(self):
1446
"""Return the short description for this format."""
1447
raise NotImplementedError(self.get_format_description)
1449
def is_supported(self):
1450
"""Is this format supported?
1452
Supported formats can be initialized and opened.
1453
Unsupported formats may not support initialization or committing or
1454
some other features depending on the reason for not being supported.
1458
def supports_content_filtering(self):
1459
"""True if this format supports content filtering."""
1462
def supports_views(self):
1463
"""True if this format supports stored views."""
1466
def get_controldir_for_branch(self):
1467
"""Get the control directory format for creating branches.
1469
This is to support testing of working tree formats that can not exist
1470
in the same control directory as a branch.
1472
return self._matchingcontroldir
1475
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
1476
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1477
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
1478
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1479
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
1480
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1481
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
1482
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1483
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
