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. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
33
from cStringIO import StringIO
37
from bzrlib.lazy_import import lazy_import
38
lazy_import(globals(), """
39
from bisect import bisect_left
50
conflicts as _mod_conflicts,
53
filters as _mod_filters,
60
revision as _mod_revision,
72
from bzrlib import symbol_versioning
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
from bzrlib.lock import LogicalLockResult
75
import bzrlib.mutabletree
76
from bzrlib.mutabletree import needs_tree_write_lock
77
from bzrlib import osutils
78
from bzrlib.osutils import (
88
from bzrlib.trace import mutter, note
89
from bzrlib.revision import CURRENT_REVISION
90
from bzrlib.symbol_versioning import (
96
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
97
# TODO: Modifying the conflict objects or their type is currently nearly
98
# impossible as there is no clear relationship between the working tree format
99
# and the conflict list file format.
100
CONFLICT_HEADER_1 = "BZR conflict list format 1"
102
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
105
class TreeEntry(object):
106
"""An entry that implements the minimum interface used by commands.
108
This needs further inspection, it may be better to have
109
InventoryEntries without ids - though that seems wrong. For now,
110
this is a parallel hierarchy to InventoryEntry, and needs to become
111
one of several things: decorates to that hierarchy, children of, or
113
Another note is that these objects are currently only used when there is
114
no InventoryEntry available - i.e. for unversioned objects.
115
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
118
def __eq__(self, other):
119
# yes, this us ugly, TODO: best practice __eq__ style.
120
return (isinstance(other, TreeEntry)
121
and other.__class__ == self.__class__)
123
def kind_character(self):
127
class TreeDirectory(TreeEntry):
128
"""See TreeEntry. This is a directory in a working tree."""
130
def __eq__(self, other):
131
return (isinstance(other, TreeDirectory)
132
and other.__class__ == self.__class__)
134
def kind_character(self):
138
class TreeFile(TreeEntry):
139
"""See TreeEntry. This is a regular file in a working tree."""
141
def __eq__(self, other):
142
return (isinstance(other, TreeFile)
143
and other.__class__ == self.__class__)
145
def kind_character(self):
149
class TreeLink(TreeEntry):
150
"""See TreeEntry. This is a symlink in a working tree."""
152
def __eq__(self, other):
153
return (isinstance(other, TreeLink)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class WorkingTree(bzrlib.mutabletree.MutableTree,
161
controldir.ControlComponent):
162
"""Working copy tree.
164
:ivar basedir: The root of the tree on disk. This is a unicode path object
165
(as opposed to a URL).
168
# override this to set the strategy for storing views
169
def _make_views(self):
170
return views.DisabledViews(self)
172
def __init__(self, basedir='.',
173
branch=DEPRECATED_PARAMETER,
178
"""Construct a WorkingTree instance. This is not a public API.
180
:param branch: A branch to override probing for the branch.
182
self._format = _format
183
self.bzrdir = _bzrdir
185
raise errors.BzrError("Please use bzrdir.open_workingtree or "
186
"WorkingTree.open() to obtain a WorkingTree.")
187
basedir = safe_unicode(basedir)
188
mutter("opening working tree %r", basedir)
189
if deprecated_passed(branch):
190
self._branch = branch
192
self._branch = self.bzrdir.open_branch()
193
self.basedir = realpath(basedir)
194
self._control_files = _control_files
195
self._transport = self._control_files._transport
196
self._rules_searcher = None
197
self.views = self._make_views()
200
def user_transport(self):
201
return self.bzrdir.user_transport
204
def control_transport(self):
205
return self._transport
207
def is_control_filename(self, filename):
208
"""True if filename is the name of a control file in this tree.
210
:param filename: A filename within the tree. This is a relative path
211
from the root of this tree.
213
This is true IF and ONLY IF the filename is part of the meta data
214
that bzr controls in this tree. I.E. a random .bzr directory placed
215
on disk will not be a control file for this tree.
217
return self.bzrdir.is_control_filename(filename)
220
fget=lambda self: self._branch,
221
doc="""The branch this WorkingTree is connected to.
223
This cannot be set - it is reflective of the actual disk structure
224
the working tree has been constructed from.
227
def has_versioned_directories(self):
228
"""See `Tree.has_versioned_directories`."""
229
return self._format.supports_versioned_directories
231
def break_lock(self):
232
"""Break a lock if one is present from another instance.
234
Uses the ui factory to ask for confirmation if the lock may be from
237
This will probe the repository for its lock as well.
239
self._control_files.break_lock()
240
self.branch.break_lock()
242
def requires_rich_root(self):
243
return self._format.requires_rich_root
245
def supports_tree_reference(self):
248
def supports_content_filtering(self):
249
return self._format.supports_content_filtering()
251
def supports_views(self):
252
return self.views.supports_views()
255
def open(path=None, _unsupported=False):
256
"""Open an existing working tree at path.
260
path = osutils.getcwd()
261
control = bzrdir.BzrDir.open(path, _unsupported)
262
return control.open_workingtree(_unsupported)
265
def open_containing(path=None):
266
"""Open an existing working tree which has its root about path.
268
This probes for a working tree at path and searches upwards from there.
270
Basically we keep looking up until we find the control directory or
271
run into /. If there isn't one, raises NotBranchError.
272
TODO: give this a new exception.
273
If there is one, it is returned, along with the unused portion of path.
275
:return: The WorkingTree that contains 'path', and the rest of path
278
path = osutils.getcwd()
279
control, relpath = bzrdir.BzrDir.open_containing(path)
280
return control.open_workingtree(), relpath
283
def open_containing_paths(file_list, default_directory=None,
284
canonicalize=True, apply_view=True):
285
"""Open the WorkingTree that contains a set of paths.
287
Fail if the paths given are not all in a single tree.
289
This is used for the many command-line interfaces that take a list of
290
any number of files and that require they all be in the same tree.
292
if default_directory is None:
293
default_directory = u'.'
294
# recommended replacement for builtins.internal_tree_files
295
if file_list is None or len(file_list) == 0:
296
tree = WorkingTree.open_containing(default_directory)[0]
297
# XXX: doesn't really belong here, and seems to have the strange
298
# side effect of making it return a bunch of files, not the whole
299
# tree -- mbp 20100716
300
if tree.supports_views() and apply_view:
301
view_files = tree.views.lookup_view()
303
file_list = view_files
304
view_str = views.view_display_str(view_files)
305
note("Ignoring files outside view. View is %s" % view_str)
306
return tree, file_list
307
if default_directory == u'.':
310
seed = default_directory
311
file_list = [osutils.pathjoin(default_directory, f)
313
tree = WorkingTree.open_containing(seed)[0]
314
return tree, tree.safe_relpath_files(file_list, canonicalize,
315
apply_view=apply_view)
317
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
318
"""Convert file_list into a list of relpaths in tree.
320
:param self: A tree to operate on.
321
:param file_list: A list of user provided paths or None.
322
:param apply_view: if True and a view is set, apply it or check that
323
specified files are within it
324
:return: A list of relative paths.
325
:raises errors.PathNotChild: When a provided path is in a different self
328
if file_list is None:
330
if self.supports_views() and apply_view:
331
view_files = self.views.lookup_view()
335
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
336
# doesn't - fix that up here before we enter the loop.
338
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
341
for filename in file_list:
342
relpath = fixer(osutils.dereference_path(filename))
343
if view_files and not osutils.is_inside_any(view_files, relpath):
344
raise errors.FileOutsideView(filename, view_files)
345
new_list.append(relpath)
349
def open_downlevel(path=None):
350
"""Open an unsupported working tree.
352
Only intended for advanced situations like upgrading part of a bzrdir.
354
return WorkingTree.open(path, _unsupported=True)
357
def find_trees(location):
358
def list_current(transport):
359
return [d for d in transport.list_dir('') if d != '.bzr']
360
def evaluate(bzrdir):
362
tree = bzrdir.open_workingtree()
363
except errors.NoWorkingTree:
367
t = transport.get_transport(location)
368
iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
369
list_current=list_current)
370
return [tr for tr in iterator if tr is not None]
372
def all_file_ids(self):
373
"""See Tree.iter_all_file_ids"""
374
raise NotImplementedError(self.all_file_ids)
377
return "<%s of %s>" % (self.__class__.__name__,
378
getattr(self, 'basedir', None))
380
def abspath(self, filename):
381
return pathjoin(self.basedir, filename)
383
def basis_tree(self):
384
"""Return RevisionTree for the current last revision.
386
If the left most parent is a ghost then the returned tree will be an
387
empty tree - one obtained by calling
388
repository.revision_tree(NULL_REVISION).
391
revision_id = self.get_parent_ids()[0]
393
# no parents, return an empty revision tree.
394
# in the future this should return the tree for
395
# 'empty:' - the implicit root empty tree.
396
return self.branch.repository.revision_tree(
397
_mod_revision.NULL_REVISION)
399
return self.revision_tree(revision_id)
400
except errors.NoSuchRevision:
402
# No cached copy available, retrieve from the repository.
403
# FIXME? RBC 20060403 should we cache the inventory locally
406
return self.branch.repository.revision_tree(revision_id)
407
except (errors.RevisionNotPresent, errors.NoSuchRevision):
408
# the basis tree *may* be a ghost or a low level error may have
409
# occurred. If the revision is present, its a problem, if its not
411
if self.branch.repository.has_revision(revision_id):
413
# the basis tree is a ghost so return an empty tree.
414
return self.branch.repository.revision_tree(
415
_mod_revision.NULL_REVISION)
418
self._flush_ignore_list_cache()
420
def relpath(self, path):
421
"""Return the local path portion from a given path.
423
The path may be absolute or relative. If its a relative path it is
424
interpreted relative to the python current working directory.
426
return osutils.relpath(self.basedir, path)
428
def has_filename(self, filename):
429
return osutils.lexists(self.abspath(filename))
431
def get_file(self, file_id, path=None, filtered=True):
432
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
434
def get_file_with_stat(self, file_id, path=None, filtered=True,
435
_fstat=osutils.fstat):
436
"""See Tree.get_file_with_stat."""
438
path = self.id2path(file_id)
439
file_obj = self.get_file_byname(path, filtered=False)
440
stat_value = _fstat(file_obj.fileno())
441
if filtered and self.supports_content_filtering():
442
filters = self._content_filter_stack(path)
443
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
444
return (file_obj, stat_value)
446
def get_file_text(self, file_id, path=None, filtered=True):
447
my_file = self.get_file(file_id, path=path, filtered=filtered)
449
return my_file.read()
453
def get_file_byname(self, filename, filtered=True):
454
path = self.abspath(filename)
456
if filtered and self.supports_content_filtering():
457
filters = self._content_filter_stack(filename)
458
return _mod_filters.filtered_input_file(f, filters)
462
def get_file_lines(self, file_id, path=None, filtered=True):
463
"""See Tree.get_file_lines()"""
464
file = self.get_file(file_id, path, filtered=filtered)
466
return file.readlines()
470
def get_parent_ids(self):
471
"""See Tree.get_parent_ids.
473
This implementation reads the pending merges list and last_revision
474
value and uses that to decide what the parents list should be.
476
last_rev = _mod_revision.ensure_null(self._last_revision())
477
if _mod_revision.NULL_REVISION == last_rev:
482
merges_bytes = self._transport.get_bytes('pending-merges')
483
except errors.NoSuchFile:
486
for l in osutils.split_lines(merges_bytes):
487
revision_id = l.rstrip('\n')
488
parents.append(revision_id)
491
def get_root_id(self):
492
"""Return the id of this trees root"""
493
raise NotImplementedError(self.get_root_id)
496
def clone(self, to_bzrdir, revision_id=None):
497
"""Duplicate this working tree into to_bzr, including all state.
499
Specifically modified files are kept as modified, but
500
ignored and unknown files are discarded.
502
If you want to make a new line of development, see bzrdir.sprout()
505
If not None, the cloned tree will have its last revision set to
506
revision, and difference between the source trees last revision
507
and this one merged in.
509
# assumes the target bzr dir format is compatible.
510
result = to_bzrdir.create_workingtree()
511
self.copy_content_into(result, revision_id)
515
def copy_content_into(self, tree, revision_id=None):
516
"""Copy the current content and user files of this tree into tree."""
517
tree.set_root_id(self.get_root_id())
518
if revision_id is None:
519
merge.transform_tree(tree, self)
521
# TODO now merge from tree.last_revision to revision (to preserve
522
# user local changes)
523
merge.transform_tree(tree, self)
524
tree.set_parent_ids([revision_id])
526
def id2abspath(self, file_id):
527
return self.abspath(self.id2path(file_id))
529
def _check_for_tree_references(self, iterator):
530
"""See if directories have become tree-references."""
531
blocked_parent_ids = set()
532
for path, ie in iterator:
533
if ie.parent_id in blocked_parent_ids:
534
# This entry was pruned because one of its parents became a
535
# TreeReference. If this is a directory, mark it as blocked.
536
if ie.kind == 'directory':
537
blocked_parent_ids.add(ie.file_id)
539
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
540
# This InventoryDirectory needs to be a TreeReference
541
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
542
blocked_parent_ids.add(ie.file_id)
545
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
546
"""See Tree.iter_entries_by_dir()"""
547
# The only trick here is that if we supports_tree_reference then we
548
# need to detect if a directory becomes a tree-reference.
549
iterator = super(WorkingTree, self).iter_entries_by_dir(
550
specific_file_ids=specific_file_ids,
551
yield_parents=yield_parents)
552
if not self.supports_tree_reference():
555
return self._check_for_tree_references(iterator)
557
def get_file_size(self, file_id):
558
"""See Tree.get_file_size"""
559
# XXX: this returns the on-disk size; it should probably return the
562
return os.path.getsize(self.id2abspath(file_id))
564
if e.errno != errno.ENOENT:
569
@needs_tree_write_lock
570
def _gather_kinds(self, files, kinds):
571
"""See MutableTree._gather_kinds."""
572
for pos, f in enumerate(files):
573
if kinds[pos] is None:
574
fullpath = normpath(self.abspath(f))
576
kinds[pos] = file_kind(fullpath)
578
if e.errno == errno.ENOENT:
579
raise errors.NoSuchFile(fullpath)
582
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
583
"""Add revision_id as a parent.
585
This is equivalent to retrieving the current list of parent ids
586
and setting the list to its value plus revision_id.
588
:param revision_id: The revision id to add to the parent list. It may
589
be a ghost revision as long as its not the first parent to be
590
added, or the allow_leftmost_as_ghost parameter is set True.
591
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
593
parents = self.get_parent_ids() + [revision_id]
594
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
595
or allow_leftmost_as_ghost)
597
@needs_tree_write_lock
598
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
599
"""Add revision_id, tree tuple as a parent.
601
This is equivalent to retrieving the current list of parent trees
602
and setting the list to its value plus parent_tuple. See also
603
add_parent_tree_id - if you only have a parent id available it will be
604
simpler to use that api. If you have the parent already available, using
605
this api is preferred.
607
:param parent_tuple: The (revision id, tree) to add to the parent list.
608
If the revision_id is a ghost, pass None for the tree.
609
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
611
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
612
if len(parent_ids) > 1:
613
# the leftmost may have already been a ghost, preserve that if it
615
allow_leftmost_as_ghost = True
616
self.set_parent_ids(parent_ids,
617
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
619
@needs_tree_write_lock
620
def add_pending_merge(self, *revision_ids):
621
# TODO: Perhaps should check at this point that the
622
# history of the revision is actually present?
623
parents = self.get_parent_ids()
625
for rev_id in revision_ids:
626
if rev_id in parents:
628
parents.append(rev_id)
631
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
633
def path_content_summary(self, path, _lstat=os.lstat,
634
_mapper=osutils.file_kind_from_stat_mode):
635
"""See Tree.path_content_summary."""
636
abspath = self.abspath(path)
638
stat_result = _lstat(abspath)
640
if getattr(e, 'errno', None) == errno.ENOENT:
642
return ('missing', None, None, None)
643
# propagate other errors
645
kind = _mapper(stat_result.st_mode)
647
return self._file_content_summary(path, stat_result)
648
elif kind == 'directory':
649
# perhaps it looks like a plain directory, but it's really a
651
if self._directory_is_tree_reference(path):
652
kind = 'tree-reference'
653
return kind, None, None, None
654
elif kind == 'symlink':
655
target = osutils.readlink(abspath)
656
return ('symlink', None, None, target)
658
return (kind, None, None, None)
660
def _file_content_summary(self, path, stat_result):
661
size = stat_result.st_size
662
executable = self._is_executable_from_path_and_stat(path, stat_result)
663
# try for a stat cache lookup
664
return ('file', size, executable, self._sha_from_stat(
667
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
668
"""Common ghost checking functionality from set_parent_*.
670
This checks that the left hand-parent exists if there are any
673
if len(revision_ids) > 0:
674
leftmost_id = revision_ids[0]
675
if (not allow_leftmost_as_ghost and not
676
self.branch.repository.has_revision(leftmost_id)):
677
raise errors.GhostRevisionUnusableHere(leftmost_id)
679
def _set_merges_from_parent_ids(self, parent_ids):
680
merges = parent_ids[1:]
681
self._transport.put_bytes('pending-merges', '\n'.join(merges),
682
mode=self.bzrdir._get_file_mode())
684
def _filter_parent_ids_by_ancestry(self, revision_ids):
685
"""Check that all merged revisions are proper 'heads'.
687
This will always return the first revision_id, and any merged revisions
690
if len(revision_ids) == 0:
692
graph = self.branch.repository.get_graph()
693
heads = graph.heads(revision_ids)
694
new_revision_ids = revision_ids[:1]
695
for revision_id in revision_ids[1:]:
696
if revision_id in heads and revision_id not in new_revision_ids:
697
new_revision_ids.append(revision_id)
698
if new_revision_ids != revision_ids:
699
mutter('requested to set revision_ids = %s,'
700
' but filtered to %s', revision_ids, new_revision_ids)
701
return new_revision_ids
703
@needs_tree_write_lock
704
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
705
"""Set the parent ids to revision_ids.
707
See also set_parent_trees. This api will try to retrieve the tree data
708
for each element of revision_ids from the trees repository. If you have
709
tree data already available, it is more efficient to use
710
set_parent_trees rather than set_parent_ids. set_parent_ids is however
711
an easier API to use.
713
:param revision_ids: The revision_ids to set as the parent ids of this
714
working tree. Any of these may be ghosts.
716
self._check_parents_for_ghosts(revision_ids,
717
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
718
for revision_id in revision_ids:
719
_mod_revision.check_not_reserved_id(revision_id)
721
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
723
if len(revision_ids) > 0:
724
self.set_last_revision(revision_ids[0])
726
self.set_last_revision(_mod_revision.NULL_REVISION)
728
self._set_merges_from_parent_ids(revision_ids)
730
@needs_tree_write_lock
731
def set_pending_merges(self, rev_list):
732
parents = self.get_parent_ids()
733
leftmost = parents[:1]
734
new_parents = leftmost + rev_list
735
self.set_parent_ids(new_parents)
737
@needs_tree_write_lock
738
def set_merge_modified(self, modified_hashes):
740
for file_id, hash in modified_hashes.iteritems():
741
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
743
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
745
def _sha_from_stat(self, path, stat_result):
746
"""Get a sha digest from the tree's stat cache.
748
The default implementation assumes no stat cache is present.
750
:param path: The path.
751
:param stat_result: The stat result being looked up.
755
def _put_rio(self, filename, stanzas, header):
756
self._must_be_locked()
757
my_file = _mod_rio.rio_file(stanzas, header)
758
self._transport.put_file(filename, my_file,
759
mode=self.bzrdir._get_file_mode())
761
@needs_write_lock # because merge pulls data into the branch.
762
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
763
merge_type=None, force=False):
764
"""Merge from a branch into this working tree.
766
:param branch: The branch to merge from.
767
:param to_revision: If non-None, the merge will merge to to_revision,
768
but not beyond it. to_revision does not need to be in the history
769
of the branch when it is supplied. If None, to_revision defaults to
770
branch.last_revision().
772
from bzrlib.merge import Merger, Merge3Merger
773
merger = Merger(self.branch, this_tree=self)
774
# check that there are no local alterations
775
if not force and self.has_changes():
776
raise errors.UncommittedChanges(self)
777
if to_revision is None:
778
to_revision = _mod_revision.ensure_null(branch.last_revision())
779
merger.other_rev_id = to_revision
780
if _mod_revision.is_null(merger.other_rev_id):
781
raise errors.NoCommits(branch)
782
self.branch.fetch(branch, last_revision=merger.other_rev_id)
783
merger.other_basis = merger.other_rev_id
784
merger.other_tree = self.branch.repository.revision_tree(
786
merger.other_branch = branch
787
if from_revision is None:
790
merger.set_base_revision(from_revision, branch)
791
if merger.base_rev_id == merger.other_rev_id:
792
raise errors.PointlessMerge
793
merger.backup_files = False
794
if merge_type is None:
795
merger.merge_type = Merge3Merger
797
merger.merge_type = merge_type
798
merger.set_interesting_files(None)
799
merger.show_base = False
800
merger.reprocess = False
801
conflicts = merger.do_merge()
805
def merge_modified(self):
806
"""Return a dictionary of files modified by a merge.
808
The list is initialized by WorkingTree.set_merge_modified, which is
809
typically called after we make some automatic updates to the tree
812
This returns a map of file_id->sha1, containing only files which are
813
still in the working inventory and have that text hash.
815
raise NotImplementedError(self.merge_modified)
818
def mkdir(self, path, file_id=None):
819
"""See MutableTree.mkdir()."""
821
file_id = generate_ids.gen_file_id(os.path.basename(path))
822
os.mkdir(self.abspath(path))
823
self.add(path, file_id, 'directory')
826
def get_symlink_target(self, file_id, path=None):
828
abspath = self.abspath(path)
830
abspath = self.id2abspath(file_id)
831
target = osutils.readlink(abspath)
834
def subsume(self, other_tree):
835
raise NotImplementedError(self.subsume)
837
def _setup_directory_is_tree_reference(self):
838
if self._branch.repository._format.supports_tree_reference:
839
self._directory_is_tree_reference = \
840
self._directory_may_be_tree_reference
842
self._directory_is_tree_reference = \
843
self._directory_is_never_tree_reference
845
def _directory_is_never_tree_reference(self, relpath):
848
def _directory_may_be_tree_reference(self, relpath):
849
# as a special case, if a directory contains control files then
850
# it's a tree reference, except that the root of the tree is not
851
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
852
# TODO: We could ask all the control formats whether they
853
# recognize this directory, but at the moment there's no cheap api
854
# to do that. Since we probably can only nest bzr checkouts and
855
# they always use this name it's ok for now. -- mbp 20060306
857
# FIXME: There is an unhandled case here of a subdirectory
858
# containing .bzr but not a branch; that will probably blow up
859
# when you try to commit it. It might happen if there is a
860
# checkout in a subdirectory. This can be avoided by not adding
863
def extract(self, file_id, format=None):
864
"""Extract a subtree from this tree.
866
A new branch will be created, relative to the path for this tree.
868
raise NotImplementedError(self.extract)
871
"""Write the in memory meta data to disk."""
872
raise NotImplementedError(self.flush)
874
def _kind(self, relpath):
875
return osutils.file_kind(self.abspath(relpath))
877
def list_files(self, include_root=False, from_dir=None, recursive=True):
878
"""List all files as (path, class, kind, id, entry).
880
Lists, but does not descend into unversioned directories.
881
This does not include files that have been deleted in this
882
tree. Skips the control directory.
884
:param include_root: if True, return an entry for the root
885
:param from_dir: start from this directory or None for the root
886
:param recursive: whether to recurse into subdirectories or not
888
raise NotImplementedError(self.list_files)
890
def move(self, from_paths, to_dir=None, after=False):
893
to_dir must be known to the working tree.
895
If to_dir exists and is a directory, the files are moved into
896
it, keeping their old names.
898
Note that to_dir is only the last component of the new name;
899
this doesn't change the directory.
901
For each entry in from_paths the move mode will be determined
904
The first mode moves the file in the filesystem and updates the
905
working tree metadata. The second mode only updates the working tree
906
metadata without touching the file on the filesystem.
908
move uses the second mode if 'after == True' and the target is not
909
versioned but present in the working tree.
911
move uses the second mode if 'after == False' and the source is
912
versioned but no longer in the working tree, and the target is not
913
versioned but present in the working tree.
915
move uses the first mode if 'after == False' and the source is
916
versioned and present in the working tree, and the target is not
917
versioned and not present in the working tree.
919
Everything else results in an error.
921
This returns a list of (from_path, to_path) pairs for each
924
raise NotImplementedError(self.move)
926
@needs_tree_write_lock
927
def rename_one(self, from_rel, to_rel, after=False):
930
This can change the directory or the filename or both.
932
rename_one has several 'modes' to work. First, it can rename a physical
933
file and change the file_id. That is the normal mode. Second, it can
934
only change the file_id without touching any physical file.
936
rename_one uses the second mode if 'after == True' and 'to_rel' is
937
either not versioned or newly added, and present in the working tree.
939
rename_one uses the second mode if 'after == False' and 'from_rel' is
940
versioned but no longer in the working tree, and 'to_rel' is not
941
versioned but present in the working tree.
943
rename_one uses the first mode if 'after == False' and 'from_rel' is
944
versioned and present in the working tree, and 'to_rel' is not
945
versioned and not present in the working tree.
947
Everything else results in an error.
949
raise NotImplementedError(self.rename_one)
953
"""Return all unknown files.
955
These are files in the working directory that are not versioned or
956
control files or ignored.
958
# force the extras method to be fully executed before returning, to
959
# prevent race conditions with the lock
961
[subp for subp in self.extras() if not self.is_ignored(subp)])
963
def unversion(self, file_ids):
964
"""Remove the file ids in file_ids from the current versioned set.
966
When a file_id is unversioned, all of its children are automatically
969
:param file_ids: The file ids to stop versioning.
970
:raises: NoSuchId if any fileid is not currently versioned.
972
raise NotImplementedError(self.unversion)
975
def pull(self, source, overwrite=False, stop_revision=None,
976
change_reporter=None, possible_transports=None, local=False,
980
old_revision_info = self.branch.last_revision_info()
981
basis_tree = self.basis_tree()
982
count = self.branch.pull(source, overwrite, stop_revision,
983
possible_transports=possible_transports,
985
new_revision_info = self.branch.last_revision_info()
986
if new_revision_info != old_revision_info:
987
repository = self.branch.repository
988
if repository._format.fast_deltas:
989
parent_ids = self.get_parent_ids()
991
basis_id = parent_ids[0]
992
basis_tree = repository.revision_tree(basis_id)
993
basis_tree.lock_read()
995
new_basis_tree = self.branch.basis_tree()
1002
change_reporter=change_reporter,
1003
show_base=show_base)
1004
basis_root_id = basis_tree.get_root_id()
1005
new_root_id = new_basis_tree.get_root_id()
1006
if basis_root_id != new_root_id:
1007
self.set_root_id(new_root_id)
1010
# TODO - dedup parents list with things merged by pull ?
1011
# reuse the revisiontree we merged against to set the new
1013
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1014
# we have to pull the merge trees out again, because
1015
# merge_inner has set the ids. - this corner is not yet
1016
# layered well enough to prevent double handling.
1017
# XXX TODO: Fix the double handling: telling the tree about
1018
# the already known parent data is wasteful.
1019
merges = self.get_parent_ids()[1:]
1020
parent_trees.extend([
1021
(parent, repository.revision_tree(parent)) for
1023
self.set_parent_trees(parent_trees)
1029
def put_file_bytes_non_atomic(self, file_id, bytes):
1030
"""See MutableTree.put_file_bytes_non_atomic."""
1031
stream = file(self.id2abspath(file_id), 'wb')
1038
"""Yield all unversioned files in this WorkingTree.
1040
If there are any unversioned directories then only the directory is
1041
returned, not all its children. But if there are unversioned files
1042
under a versioned subdirectory, they are returned.
1044
Currently returned depth-first, sorted by name within directories.
1045
This is the same order used by 'osutils.walkdirs'.
1047
raise NotImplementedError(self.extras)
1049
def ignored_files(self):
1050
"""Yield list of PATH, IGNORE_PATTERN"""
1051
for subp in self.extras():
1052
pat = self.is_ignored(subp)
1056
def get_ignore_list(self):
1057
"""Return list of ignore patterns.
1059
Cached in the Tree object after the first call.
1061
ignoreset = getattr(self, '_ignoreset', None)
1062
if ignoreset is not None:
1065
ignore_globs = set()
1066
ignore_globs.update(ignores.get_runtime_ignores())
1067
ignore_globs.update(ignores.get_user_ignores())
1068
if self.has_filename(bzrlib.IGNORE_FILENAME):
1069
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1071
ignore_globs.update(ignores.parse_ignore_file(f))
1074
self._ignoreset = ignore_globs
1077
def _flush_ignore_list_cache(self):
1078
"""Resets the cached ignore list to force a cache rebuild."""
1079
self._ignoreset = None
1080
self._ignoreglobster = None
1082
def is_ignored(self, filename):
1083
r"""Check whether the filename matches an ignore pattern.
1085
Patterns containing '/' or '\' need to match the whole path;
1086
others match against only the last component. Patterns starting
1087
with '!' are ignore exceptions. Exceptions take precedence
1088
over regular patterns and cause the filename to not be ignored.
1090
If the file is ignored, returns the pattern which caused it to
1091
be ignored, otherwise None. So this can simply be used as a
1092
boolean if desired."""
1093
if getattr(self, '_ignoreglobster', None) is None:
1094
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1095
return self._ignoreglobster.match(filename)
1097
def kind(self, file_id):
1098
return file_kind(self.id2abspath(file_id))
1100
def stored_kind(self, file_id):
1101
"""See Tree.stored_kind"""
1102
raise NotImplementedError(self.stored_kind)
1104
def _comparison_data(self, entry, path):
1105
abspath = self.abspath(path)
1107
stat_value = os.lstat(abspath)
1109
if getattr(e, 'errno', None) == errno.ENOENT:
1116
mode = stat_value.st_mode
1117
kind = osutils.file_kind_from_stat_mode(mode)
1118
if not supports_executable():
1119
executable = entry is not None and entry.executable
1121
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1122
return kind, executable, stat_value
1124
def _file_size(self, entry, stat_value):
1125
return stat_value.st_size
1127
def last_revision(self):
1128
"""Return the last revision of the branch for this tree.
1130
This format tree does not support a separate marker for last-revision
1131
compared to the branch.
1133
See MutableTree.last_revision
1135
return self._last_revision()
1138
def _last_revision(self):
1139
"""helper for get_parent_ids."""
1140
return _mod_revision.ensure_null(self.branch.last_revision())
1142
def is_locked(self):
1143
return self._control_files.is_locked()
1145
def _must_be_locked(self):
1146
if not self.is_locked():
1147
raise errors.ObjectNotLocked(self)
1149
def lock_read(self):
1150
"""Lock the tree for reading.
1152
This also locks the branch, and can be unlocked via self.unlock().
1154
:return: A bzrlib.lock.LogicalLockResult.
1156
if not self.is_locked():
1158
self.branch.lock_read()
1160
self._control_files.lock_read()
1161
return LogicalLockResult(self.unlock)
1163
self.branch.unlock()
1166
def lock_tree_write(self):
1167
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1169
:return: A bzrlib.lock.LogicalLockResult.
1171
if not self.is_locked():
1173
self.branch.lock_read()
1175
self._control_files.lock_write()
1176
return LogicalLockResult(self.unlock)
1178
self.branch.unlock()
1181
def lock_write(self):
1182
"""See MutableTree.lock_write, and WorkingTree.unlock.
1184
:return: A bzrlib.lock.LogicalLockResult.
1186
if not self.is_locked():
1188
self.branch.lock_write()
1190
self._control_files.lock_write()
1191
return LogicalLockResult(self.unlock)
1193
self.branch.unlock()
1196
def get_physical_lock_status(self):
1197
return self._control_files.get_physical_lock_status()
1199
def _reset_data(self):
1200
"""Reset transient data that cannot be revalidated."""
1201
raise NotImplementedError(self._reset_data)
1203
def set_last_revision(self, new_revision):
1204
"""Change the last revision in the working tree."""
1205
raise NotImplementedError(self.set_last_revision)
1207
def _change_last_revision(self, new_revision):
1208
"""Template method part of set_last_revision to perform the change.
1210
This is used to allow WorkingTree3 instances to not affect branch
1211
when their last revision is set.
1213
if _mod_revision.is_null(new_revision):
1214
self.branch.set_last_revision_info(0, new_revision)
1216
_mod_revision.check_not_reserved_id(new_revision)
1218
self.branch.generate_revision_history(new_revision)
1219
except errors.NoSuchRevision:
1220
# not present in the repo - dont try to set it deeper than the tip
1221
self.branch._set_revision_history([new_revision])
1224
@needs_tree_write_lock
1225
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1227
"""Remove nominated files from the working tree metadata.
1229
:files: File paths relative to the basedir.
1230
:keep_files: If true, the files will also be kept.
1231
:force: Delete files and directories, even if they are changed and
1232
even if the directories are not empty.
1234
if isinstance(files, basestring):
1239
all_files = set() # specified and nested files
1240
unknown_nested_files=set()
1242
to_file = sys.stdout
1244
files_to_backup = []
1246
def recurse_directory_to_add_files(directory):
1247
# Recurse directory and add all files
1248
# so we can check if they have changed.
1249
for parent_info, file_infos in self.walkdirs(directory):
1250
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1251
# Is it versioned or ignored?
1252
if self.path2id(relpath):
1253
# Add nested content for deletion.
1254
all_files.add(relpath)
1256
# Files which are not versioned
1257
# should be treated as unknown.
1258
files_to_backup.append(relpath)
1260
for filename in files:
1261
# Get file name into canonical form.
1262
abspath = self.abspath(filename)
1263
filename = self.relpath(abspath)
1264
if len(filename) > 0:
1265
all_files.add(filename)
1266
recurse_directory_to_add_files(filename)
1268
files = list(all_files)
1271
return # nothing to do
1273
# Sort needed to first handle directory content before the directory
1274
files.sort(reverse=True)
1276
# Bail out if we are going to delete files we shouldn't
1277
if not keep_files and not force:
1278
for (file_id, path, content_change, versioned, parent_id, name,
1279
kind, executable) in self.iter_changes(self.basis_tree(),
1280
include_unchanged=True, require_versioned=False,
1281
want_unversioned=True, specific_files=files):
1282
if versioned[0] == False:
1283
# The record is unknown or newly added
1284
files_to_backup.append(path[1])
1285
elif (content_change and (kind[1] is not None) and
1286
osutils.is_inside_any(files, path[1])):
1287
# Versioned and changed, but not deleted, and still
1288
# in one of the dirs to be deleted.
1289
files_to_backup.append(path[1])
1291
def backup(file_to_backup):
1292
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1293
osutils.rename(abs_path, self.abspath(backup_name))
1294
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1297
# Build inv_delta and delete files where applicable,
1298
# do this before any modifications to meta data.
1300
fid = self.path2id(f)
1303
message = "%s is not versioned." % (f,)
1306
# having removed it, it must be either ignored or unknown
1307
if self.is_ignored(f):
1311
# XXX: Really should be a more abstract reporter interface
1312
kind_ch = osutils.kind_marker(self.kind(fid))
1313
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1315
inv_delta.append((f, None, fid, None))
1316
message = "removed %s" % (f,)
1319
abs_path = self.abspath(f)
1320
if osutils.lexists(abs_path):
1321
if (osutils.isdir(abs_path) and
1322
len(os.listdir(abs_path)) > 0):
1324
osutils.rmtree(abs_path)
1325
message = "deleted %s" % (f,)
1329
if f in files_to_backup:
1332
osutils.delete_any(abs_path)
1333
message = "deleted %s" % (f,)
1334
elif message is not None:
1335
# Only care if we haven't done anything yet.
1336
message = "%s does not exist." % (f,)
1338
# Print only one message (if any) per file.
1339
if message is not None:
1341
self.apply_inventory_delta(inv_delta)
1343
@needs_tree_write_lock
1344
def revert(self, filenames=None, old_tree=None, backups=True,
1345
pb=None, report_changes=False):
1346
from bzrlib.conflicts import resolve
1347
if old_tree is None:
1348
basis_tree = self.basis_tree()
1349
basis_tree.lock_read()
1350
old_tree = basis_tree
1354
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1356
if filenames is None and len(self.get_parent_ids()) > 1:
1358
last_revision = self.last_revision()
1359
if last_revision != _mod_revision.NULL_REVISION:
1360
if basis_tree is None:
1361
basis_tree = self.basis_tree()
1362
basis_tree.lock_read()
1363
parent_trees.append((last_revision, basis_tree))
1364
self.set_parent_trees(parent_trees)
1367
resolve(self, filenames, ignore_misses=True, recursive=True)
1369
if basis_tree is not None:
1373
def revision_tree(self, revision_id):
1374
"""See Tree.revision_tree.
1376
WorkingTree can supply revision_trees for the basis revision only
1377
because there is only one cached inventory in the bzr directory.
1379
raise NotImplementedError(self.revision_tree)
1381
@needs_tree_write_lock
1382
def set_root_id(self, file_id):
1383
"""Set the root id for this tree."""
1387
'WorkingTree.set_root_id with fileid=None')
1388
file_id = osutils.safe_file_id(file_id)
1389
self._set_root_id(file_id)
1391
def _set_root_id(self, file_id):
1392
"""Set the root id for this tree, in a format specific manner.
1394
:param file_id: The file id to assign to the root. It must not be
1395
present in the current inventory or an error will occur. It must
1396
not be None, but rather a valid file id.
1398
raise NotImplementedError(self._set_root_id)
1401
"""See Branch.unlock.
1403
WorkingTree locking just uses the Branch locking facilities.
1404
This is current because all working trees have an embedded branch
1405
within them. IF in the future, we were to make branch data shareable
1406
between multiple working trees, i.e. via shared storage, then we
1407
would probably want to lock both the local tree, and the branch.
1409
raise NotImplementedError(self.unlock)
1413
def update(self, change_reporter=None, possible_transports=None,
1414
revision=None, old_tip=_marker, show_base=False):
1415
"""Update a working tree along its branch.
1417
This will update the branch if its bound too, which means we have
1418
multiple trees involved:
1420
- The new basis tree of the master.
1421
- The old basis tree of the branch.
1422
- The old basis tree of the working tree.
1423
- The current working tree state.
1425
Pathologically, all three may be different, and non-ancestors of each
1426
other. Conceptually we want to:
1428
- Preserve the wt.basis->wt.state changes
1429
- Transform the wt.basis to the new master basis.
1430
- Apply a merge of the old branch basis to get any 'local' changes from
1432
- Restore the wt.basis->wt.state changes.
1434
There isn't a single operation at the moment to do that, so we:
1436
- Merge current state -> basis tree of the master w.r.t. the old tree
1438
- Do a 'normal' merge of the old branch basis if it is relevant.
1440
:param revision: The target revision to update to. Must be in the
1442
:param old_tip: If branch.update() has already been run, the value it
1443
returned (old tip of the branch or None). _marker is used
1446
if self.branch.get_bound_location() is not None:
1448
update_branch = (old_tip is self._marker)
1450
self.lock_tree_write()
1451
update_branch = False
1454
old_tip = self.branch.update(possible_transports)
1456
if old_tip is self._marker:
1458
return self._update_tree(old_tip, change_reporter, revision, show_base)
1462
@needs_tree_write_lock
1463
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1465
"""Update a tree to the master branch.
1467
:param old_tip: if supplied, the previous tip revision the branch,
1468
before it was changed to the master branch's tip.
1470
# here if old_tip is not None, it is the old tip of the branch before
1471
# it was updated from the master branch. This should become a pending
1472
# merge in the working tree to preserve the user existing work. we
1473
# cant set that until we update the working trees last revision to be
1474
# one from the new branch, because it will just get absorbed by the
1475
# parent de-duplication logic.
1477
# We MUST save it even if an error occurs, because otherwise the users
1478
# local work is unreferenced and will appear to have been lost.
1482
last_rev = self.get_parent_ids()[0]
1484
last_rev = _mod_revision.NULL_REVISION
1485
if revision is None:
1486
revision = self.branch.last_revision()
1488
old_tip = old_tip or _mod_revision.NULL_REVISION
1490
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1491
# the branch we are bound to was updated
1492
# merge those changes in first
1493
base_tree = self.basis_tree()
1494
other_tree = self.branch.repository.revision_tree(old_tip)
1495
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1496
base_tree, this_tree=self,
1497
change_reporter=change_reporter,
1498
show_base=show_base)
1500
self.add_parent_tree((old_tip, other_tree))
1501
note('Rerun update after fixing the conflicts.')
1504
if last_rev != _mod_revision.ensure_null(revision):
1505
# the working tree is up to date with the branch
1506
# we can merge the specified revision from master
1507
to_tree = self.branch.repository.revision_tree(revision)
1508
to_root_id = to_tree.get_root_id()
1510
basis = self.basis_tree()
1513
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1514
self.set_root_id(to_root_id)
1519
# determine the branch point
1520
graph = self.branch.repository.get_graph()
1521
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1523
base_tree = self.branch.repository.revision_tree(base_rev_id)
1525
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1527
change_reporter=change_reporter,
1528
show_base=show_base)
1529
self.set_last_revision(revision)
1530
# TODO - dedup parents list with things merged by pull ?
1531
# reuse the tree we've updated to to set the basis:
1532
parent_trees = [(revision, to_tree)]
1533
merges = self.get_parent_ids()[1:]
1534
# Ideally we ask the tree for the trees here, that way the working
1535
# tree can decide whether to give us the entire tree or give us a
1536
# lazy initialised tree. dirstate for instance will have the trees
1537
# in ram already, whereas a last-revision + basis-inventory tree
1538
# will not, but also does not need them when setting parents.
1539
for parent in merges:
1540
parent_trees.append(
1541
(parent, self.branch.repository.revision_tree(parent)))
1542
if not _mod_revision.is_null(old_tip):
1543
parent_trees.append(
1544
(old_tip, self.branch.repository.revision_tree(old_tip)))
1545
self.set_parent_trees(parent_trees)
1546
last_rev = parent_trees[0][0]
1549
def set_conflicts(self, arg):
1550
raise errors.UnsupportedOperation(self.set_conflicts, self)
1552
def add_conflicts(self, arg):
1553
raise errors.UnsupportedOperation(self.add_conflicts, self)
1555
def conflicts(self):
1556
raise NotImplementedError(self.conflicts)
1558
def walkdirs(self, prefix=""):
1559
"""Walk the directories of this tree.
1561
returns a generator which yields items in the form:
1562
((curren_directory_path, fileid),
1563
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1566
This API returns a generator, which is only valid during the current
1567
tree transaction - within a single lock_read or lock_write duration.
1569
If the tree is not locked, it may cause an error to be raised,
1570
depending on the tree implementation.
1572
disk_top = self.abspath(prefix)
1573
if disk_top.endswith('/'):
1574
disk_top = disk_top[:-1]
1575
top_strip_len = len(disk_top) + 1
1576
inventory_iterator = self._walkdirs(prefix)
1577
disk_iterator = osutils.walkdirs(disk_top, prefix)
1579
current_disk = disk_iterator.next()
1580
disk_finished = False
1582
if not (e.errno == errno.ENOENT or
1583
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1586
disk_finished = True
1588
current_inv = inventory_iterator.next()
1589
inv_finished = False
1590
except StopIteration:
1593
while not inv_finished or not disk_finished:
1595
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1596
cur_disk_dir_content) = current_disk
1598
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1599
cur_disk_dir_content) = ((None, None), None)
1600
if not disk_finished:
1601
# strip out .bzr dirs
1602
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1603
len(cur_disk_dir_content) > 0):
1604
# osutils.walkdirs can be made nicer -
1605
# yield the path-from-prefix rather than the pathjoined
1607
bzrdir_loc = bisect_left(cur_disk_dir_content,
1609
if (bzrdir_loc < len(cur_disk_dir_content)
1610
and self.bzrdir.is_control_filename(
1611
cur_disk_dir_content[bzrdir_loc][0])):
1612
# we dont yield the contents of, or, .bzr itself.
1613
del cur_disk_dir_content[bzrdir_loc]
1615
# everything is unknown
1618
# everything is missing
1621
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1623
# disk is before inventory - unknown
1624
dirblock = [(relpath, basename, kind, stat, None, None) for
1625
relpath, basename, kind, stat, top_path in
1626
cur_disk_dir_content]
1627
yield (cur_disk_dir_relpath, None), dirblock
1629
current_disk = disk_iterator.next()
1630
except StopIteration:
1631
disk_finished = True
1633
# inventory is before disk - missing.
1634
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1635
for relpath, basename, dkind, stat, fileid, kind in
1637
yield (current_inv[0][0], current_inv[0][1]), dirblock
1639
current_inv = inventory_iterator.next()
1640
except StopIteration:
1643
# versioned present directory
1644
# merge the inventory and disk data together
1646
for relpath, subiterator in itertools.groupby(sorted(
1647
current_inv[1] + cur_disk_dir_content,
1648
key=operator.itemgetter(0)), operator.itemgetter(1)):
1649
path_elements = list(subiterator)
1650
if len(path_elements) == 2:
1651
inv_row, disk_row = path_elements
1652
# versioned, present file
1653
dirblock.append((inv_row[0],
1654
inv_row[1], disk_row[2],
1655
disk_row[3], inv_row[4],
1657
elif len(path_elements[0]) == 5:
1659
dirblock.append((path_elements[0][0],
1660
path_elements[0][1], path_elements[0][2],
1661
path_elements[0][3], None, None))
1662
elif len(path_elements[0]) == 6:
1663
# versioned, absent file.
1664
dirblock.append((path_elements[0][0],
1665
path_elements[0][1], 'unknown', None,
1666
path_elements[0][4], path_elements[0][5]))
1668
raise NotImplementedError('unreachable code')
1669
yield current_inv[0], dirblock
1671
current_inv = inventory_iterator.next()
1672
except StopIteration:
1675
current_disk = disk_iterator.next()
1676
except StopIteration:
1677
disk_finished = True
1679
def _walkdirs(self, prefix=""):
1680
"""Walk the directories of this tree.
1682
:param prefix: is used as the directrory to start with.
1683
:returns: a generator which yields items in the form::
1685
((curren_directory_path, fileid),
1686
[(file1_path, file1_name, file1_kind, None, file1_id,
1689
raise NotImplementedError(self._walkdirs)
1691
@needs_tree_write_lock
1692
def auto_resolve(self):
1693
"""Automatically resolve text conflicts according to contents.
1695
Only text conflicts are auto_resolvable. Files with no conflict markers
1696
are considered 'resolved', because bzr always puts conflict markers
1697
into files that have text conflicts. The corresponding .THIS .BASE and
1698
.OTHER files are deleted, as per 'resolve'.
1700
:return: a tuple of ConflictLists: (un_resolved, resolved).
1702
un_resolved = _mod_conflicts.ConflictList()
1703
resolved = _mod_conflicts.ConflictList()
1704
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1705
for conflict in self.conflicts():
1706
if (conflict.typestring != 'text conflict' or
1707
self.kind(conflict.file_id) != 'file'):
1708
un_resolved.append(conflict)
1710
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1712
for line in my_file:
1713
if conflict_re.search(line):
1714
un_resolved.append(conflict)
1717
resolved.append(conflict)
1720
resolved.remove_files(self)
1721
self.set_conflicts(un_resolved)
1722
return un_resolved, resolved
1724
def _validate(self):
1725
"""Validate internal structures.
1727
This is meant mostly for the test suite. To give it a chance to detect
1728
corruption after actions have occurred. The default implementation is a
1731
:return: None. An exception should be raised if there is an error.
1735
def check_state(self):
1736
"""Check that the working state is/isn't valid."""
1737
raise NotImplementedError(self.check_state)
1739
def reset_state(self, revision_ids=None):
1740
"""Reset the state of the working tree.
1742
This does a hard-reset to a last-known-good state. This is a way to
1743
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1745
raise NotImplementedError(self.reset_state)
1747
def _get_rules_searcher(self, default_searcher):
1748
"""See Tree._get_rules_searcher."""
1749
if self._rules_searcher is None:
1750
self._rules_searcher = super(WorkingTree,
1751
self)._get_rules_searcher(default_searcher)
1752
return self._rules_searcher
1754
def get_shelf_manager(self):
1755
"""Return the ShelfManager for this WorkingTree."""
1756
from bzrlib.shelf import ShelfManager
1757
return ShelfManager(self, self._transport)
1760
class InventoryWorkingTree(WorkingTree,
1761
bzrlib.mutabletree.MutableInventoryTree):
1762
"""Base class for working trees that are inventory-oriented.
1764
The inventory is held in the `Branch` working-inventory, and the
1765
files are in a directory on disk.
1767
It is possible for a `WorkingTree` to have a filename which is
1768
not listed in the Inventory and vice versa.
1771
def __init__(self, basedir='.',
1772
branch=DEPRECATED_PARAMETER,
1774
_control_files=None,
1778
"""Construct a InventoryWorkingTree instance. This is not a public API.
1780
:param branch: A branch to override probing for the branch.
1782
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1783
branch=branch, _control_files=_control_files, _internal=_internal,
1784
_format=_format, _bzrdir=_bzrdir)
1786
self._detect_case_handling()
1788
if _inventory is None:
1789
# This will be acquired on lock_read() or lock_write()
1790
self._inventory_is_modified = False
1791
self._inventory = None
1793
# the caller of __init__ has provided an inventory,
1794
# we assume they know what they are doing - as its only
1795
# the Format factory and creation methods that are
1796
# permitted to do this.
1797
self._set_inventory(_inventory, dirty=False)
1799
def _set_inventory(self, inv, dirty):
1800
"""Set the internal cached inventory.
1802
:param inv: The inventory to set.
1803
:param dirty: A boolean indicating whether the inventory is the same
1804
logical inventory as whats on disk. If True the inventory is not
1805
the same and should be written to disk or data will be lost, if
1806
False then the inventory is the same as that on disk and any
1807
serialisation would be unneeded overhead.
1809
self._inventory = inv
1810
self._inventory_is_modified = dirty
1812
def _detect_case_handling(self):
1813
wt_trans = self.bzrdir.get_workingtree_transport(None)
1815
wt_trans.stat(self._format.case_sensitive_filename)
1816
except errors.NoSuchFile:
1817
self.case_sensitive = True
1819
self.case_sensitive = False
1821
self._setup_directory_is_tree_reference()
1823
def _serialize(self, inventory, out_file):
1824
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1827
def _deserialize(selt, in_file):
1828
return xml5.serializer_v5.read_inventory(in_file)
1830
@needs_tree_write_lock
1831
def _write_inventory(self, inv):
1832
"""Write inventory as the current inventory."""
1833
self._set_inventory(inv, dirty=True)
1836
# XXX: This method should be deprecated in favour of taking in a proper
1837
# new Inventory object.
1838
@needs_tree_write_lock
1839
def set_inventory(self, new_inventory_list):
1840
from bzrlib.inventory import (Inventory,
1844
inv = Inventory(self.get_root_id())
1845
for path, file_id, parent, kind in new_inventory_list:
1846
name = os.path.basename(path)
1849
# fixme, there should be a factory function inv,add_??
1850
if kind == 'directory':
1851
inv.add(InventoryDirectory(file_id, name, parent))
1852
elif kind == 'file':
1853
inv.add(InventoryFile(file_id, name, parent))
1854
elif kind == 'symlink':
1855
inv.add(InventoryLink(file_id, name, parent))
1857
raise errors.BzrError("unknown kind %r" % kind)
1858
self._write_inventory(inv)
1860
def _write_basis_inventory(self, xml):
1861
"""Write the basis inventory XML to the basis-inventory file"""
1862
path = self._basis_inventory_name()
1864
self._transport.put_file(path, sio,
1865
mode=self.bzrdir._get_file_mode())
1867
def _reset_data(self):
1868
"""Reset transient data that cannot be revalidated."""
1869
self._inventory_is_modified = False
1870
f = self._transport.get('inventory')
1872
result = self._deserialize(f)
1875
self._set_inventory(result, dirty=False)
1877
def _set_root_id(self, file_id):
1878
"""Set the root id for this tree, in a format specific manner.
1880
:param file_id: The file id to assign to the root. It must not be
1881
present in the current inventory or an error will occur. It must
1882
not be None, but rather a valid file id.
1884
inv = self._inventory
1885
orig_root_id = inv.root.file_id
1886
# TODO: it might be nice to exit early if there was nothing
1887
# to do, saving us from trigger a sync on unlock.
1888
self._inventory_is_modified = True
1889
# we preserve the root inventory entry object, but
1890
# unlinkit from the byid index
1891
del inv._byid[inv.root.file_id]
1892
inv.root.file_id = file_id
1893
# and link it into the index with the new changed id.
1894
inv._byid[inv.root.file_id] = inv.root
1895
# and finally update all children to reference the new id.
1896
# XXX: this should be safe to just look at the root.children
1897
# list, not the WHOLE INVENTORY.
1900
if entry.parent_id == orig_root_id:
1901
entry.parent_id = inv.root.file_id
1903
def all_file_ids(self):
1904
"""See Tree.iter_all_file_ids"""
1905
return set(self.inventory)
1907
@needs_tree_write_lock
1908
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1909
"""See MutableTree.set_parent_trees."""
1910
parent_ids = [rev for (rev, tree) in parents_list]
1911
for revision_id in parent_ids:
1912
_mod_revision.check_not_reserved_id(revision_id)
1914
self._check_parents_for_ghosts(parent_ids,
1915
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1917
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1919
if len(parent_ids) == 0:
1920
leftmost_parent_id = _mod_revision.NULL_REVISION
1921
leftmost_parent_tree = None
1923
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1925
if self._change_last_revision(leftmost_parent_id):
1926
if leftmost_parent_tree is None:
1927
# If we don't have a tree, fall back to reading the
1928
# parent tree from the repository.
1929
self._cache_basis_inventory(leftmost_parent_id)
1931
inv = leftmost_parent_tree.inventory
1932
xml = self._create_basis_xml_from_inventory(
1933
leftmost_parent_id, inv)
1934
self._write_basis_inventory(xml)
1935
self._set_merges_from_parent_ids(parent_ids)
1937
def _cache_basis_inventory(self, new_revision):
1938
"""Cache new_revision as the basis inventory."""
1939
# TODO: this should allow the ready-to-use inventory to be passed in,
1940
# as commit already has that ready-to-use [while the format is the
1943
# this double handles the inventory - unpack and repack -
1944
# but is easier to understand. We can/should put a conditional
1945
# in here based on whether the inventory is in the latest format
1946
# - perhaps we should repack all inventories on a repository
1948
# the fast path is to copy the raw xml from the repository. If the
1949
# xml contains 'revision_id="', then we assume the right
1950
# revision_id is set. We must check for this full string, because a
1951
# root node id can legitimately look like 'revision_id' but cannot
1953
xml = self.branch.repository._get_inventory_xml(new_revision)
1954
firstline = xml.split('\n', 1)[0]
1955
if (not 'revision_id="' in firstline or
1956
'format="7"' not in firstline):
1957
inv = self.branch.repository._serializer.read_inventory_from_string(
1959
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1960
self._write_basis_inventory(xml)
1961
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1964
def _basis_inventory_name(self):
1965
return 'basis-inventory-cache'
1967
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1968
"""Create the text that will be saved in basis-inventory"""
1969
inventory.revision_id = revision_id
1970
return xml7.serializer_v7.write_inventory_to_string(inventory)
1972
@needs_tree_write_lock
1973
def set_conflicts(self, conflicts):
1974
self._put_rio('conflicts', conflicts.to_stanzas(),
1977
@needs_tree_write_lock
1978
def add_conflicts(self, new_conflicts):
1979
conflict_set = set(self.conflicts())
1980
conflict_set.update(set(list(new_conflicts)))
1981
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1982
key=_mod_conflicts.Conflict.sort_key)))
1985
def conflicts(self):
1987
confile = self._transport.get('conflicts')
1988
except errors.NoSuchFile:
1989
return _mod_conflicts.ConflictList()
1992
if confile.next() != CONFLICT_HEADER_1 + '\n':
1993
raise errors.ConflictFormatError()
1994
except StopIteration:
1995
raise errors.ConflictFormatError()
1996
reader = _mod_rio.RioReader(confile)
1997
return _mod_conflicts.ConflictList.from_stanzas(reader)
2001
def read_basis_inventory(self):
2002
"""Read the cached basis inventory."""
2003
path = self._basis_inventory_name()
2004
return self._transport.get_bytes(path)
2007
def read_working_inventory(self):
2008
"""Read the working inventory.
2010
:raises errors.InventoryModified: read_working_inventory will fail
2011
when the current in memory inventory has been modified.
2013
# conceptually this should be an implementation detail of the tree.
2014
# XXX: Deprecate this.
2015
# ElementTree does its own conversion from UTF-8, so open in
2017
if self._inventory_is_modified:
2018
raise errors.InventoryModified(self)
2019
f = self._transport.get('inventory')
2021
result = self._deserialize(f)
2024
self._set_inventory(result, dirty=False)
2028
def get_root_id(self):
2029
"""Return the id of this trees root"""
2030
return self._inventory.root.file_id
2032
def has_id(self, file_id):
2033
# files that have been deleted are excluded
2034
inv = self.inventory
2035
if not inv.has_id(file_id):
2037
path = inv.id2path(file_id)
2038
return osutils.lexists(self.abspath(path))
2040
def has_or_had_id(self, file_id):
2041
if file_id == self.inventory.root.file_id:
2043
return self.inventory.has_id(file_id)
2045
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2047
"""Iterate through file_ids for this tree.
2049
file_ids are in a WorkingTree if they are in the working inventory
2050
and the working file exists.
2052
inv = self._inventory
2053
for path, ie in inv.iter_entries():
2054
if osutils.lexists(self.abspath(path)):
2057
@needs_tree_write_lock
2058
def set_last_revision(self, new_revision):
2059
"""Change the last revision in the working tree."""
2060
if self._change_last_revision(new_revision):
2061
self._cache_basis_inventory(new_revision)
2063
def _get_check_refs(self):
2064
"""Return the references needed to perform a check of this tree.
2066
The default implementation returns no refs, and is only suitable for
2067
trees that have no local caching and can commit on ghosts at any time.
2069
:seealso: bzrlib.check for details about check_refs.
2074
def _check(self, references):
2075
"""Check the tree for consistency.
2077
:param references: A dict with keys matching the items returned by
2078
self._get_check_refs(), and values from looking those keys up in
2081
tree_basis = self.basis_tree()
2082
tree_basis.lock_read()
2084
repo_basis = references[('trees', self.last_revision())]
2085
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2086
raise errors.BzrCheckError(
2087
"Mismatched basis inventory content.")
2093
def check_state(self):
2094
"""Check that the working state is/isn't valid."""
2095
check_refs = self._get_check_refs()
2097
for ref in check_refs:
2100
refs[ref] = self.branch.repository.revision_tree(value)
2103
@needs_tree_write_lock
2104
def reset_state(self, revision_ids=None):
2105
"""Reset the state of the working tree.
2107
This does a hard-reset to a last-known-good state. This is a way to
2108
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2110
if revision_ids is None:
2111
revision_ids = self.get_parent_ids()
2112
if not revision_ids:
2113
rt = self.branch.repository.revision_tree(
2114
_mod_revision.NULL_REVISION)
2116
rt = self.branch.repository.revision_tree(revision_ids[0])
2117
self._write_inventory(rt.inventory)
2118
self.set_parent_ids(revision_ids)
2121
"""Write the in memory inventory to disk."""
2122
# TODO: Maybe this should only write on dirty ?
2123
if self._control_files._lock_mode != 'w':
2124
raise errors.NotWriteLocked(self)
2126
self._serialize(self._inventory, sio)
2128
self._transport.put_file('inventory', sio,
2129
mode=self.bzrdir._get_file_mode())
2130
self._inventory_is_modified = False
2132
def get_file_mtime(self, file_id, path=None):
2133
"""See Tree.get_file_mtime."""
2135
path = self.inventory.id2path(file_id)
2136
return os.lstat(self.abspath(path)).st_mtime
2138
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2139
file_id = self.path2id(path)
2141
# For unversioned files on win32, we just assume they are not
2144
return self._inventory[file_id].executable
2146
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2147
mode = stat_result.st_mode
2148
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2150
if not supports_executable():
2151
def is_executable(self, file_id, path=None):
2152
return self._inventory[file_id].executable
2154
_is_executable_from_path_and_stat = \
2155
_is_executable_from_path_and_stat_from_basis
2157
def is_executable(self, file_id, path=None):
2159
path = self.id2path(file_id)
2160
mode = os.lstat(self.abspath(path)).st_mode
2161
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2163
_is_executable_from_path_and_stat = \
2164
_is_executable_from_path_and_stat_from_stat
2166
@needs_tree_write_lock
2167
def _add(self, files, ids, kinds):
2168
"""See MutableTree._add."""
2169
# TODO: Re-adding a file that is removed in the working copy
2170
# should probably put it back with the previous ID.
2171
# the read and write working inventory should not occur in this
2172
# function - they should be part of lock_write and unlock.
2173
inv = self.inventory
2174
for f, file_id, kind in zip(files, ids, kinds):
2176
inv.add_path(f, kind=kind)
2178
inv.add_path(f, kind=kind, file_id=file_id)
2179
self._inventory_is_modified = True
2181
def revision_tree(self, revision_id):
2182
"""See WorkingTree.revision_id."""
2183
if revision_id == self.last_revision():
2185
xml = self.read_basis_inventory()
2186
except errors.NoSuchFile:
2190
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2191
# dont use the repository revision_tree api because we want
2192
# to supply the inventory.
2193
if inv.revision_id == revision_id:
2194
return revisiontree.InventoryRevisionTree(
2195
self.branch.repository, inv, revision_id)
2196
except errors.BadInventoryFormat:
2198
# raise if there was no inventory, or if we read the wrong inventory.
2199
raise errors.NoSuchRevisionInTree(self, revision_id)
2202
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2203
"""See Tree.annotate_iter
2205
This implementation will use the basis tree implementation if possible.
2206
Lines not in the basis are attributed to CURRENT_REVISION
2208
If there are pending merges, lines added by those merges will be
2209
incorrectly attributed to CURRENT_REVISION (but after committing, the
2210
attribution will be correct).
2212
maybe_file_parent_keys = []
2213
for parent_id in self.get_parent_ids():
2215
parent_tree = self.revision_tree(parent_id)
2216
except errors.NoSuchRevisionInTree:
2217
parent_tree = self.branch.repository.revision_tree(parent_id)
2218
parent_tree.lock_read()
2220
if not parent_tree.has_id(file_id):
2222
ie = parent_tree.inventory[file_id]
2223
if ie.kind != 'file':
2224
# Note: this is slightly unnecessary, because symlinks and
2225
# directories have a "text" which is the empty text, and we
2226
# know that won't mess up annotations. But it seems cleaner
2228
parent_text_key = (file_id, ie.revision)
2229
if parent_text_key not in maybe_file_parent_keys:
2230
maybe_file_parent_keys.append(parent_text_key)
2232
parent_tree.unlock()
2233
graph = _mod_graph.Graph(self.branch.repository.texts)
2234
heads = graph.heads(maybe_file_parent_keys)
2235
file_parent_keys = []
2236
for key in maybe_file_parent_keys:
2238
file_parent_keys.append(key)
2240
# Now we have the parents of this content
2241
annotator = self.branch.repository.texts.get_annotator()
2242
text = self.get_file_text(file_id)
2243
this_key =(file_id, default_revision)
2244
annotator.add_special_text(this_key, file_parent_keys, text)
2245
annotations = [(key[-1], line)
2246
for key, line in annotator.annotate_flat(this_key)]
2250
def merge_modified(self):
2251
"""Return a dictionary of files modified by a merge.
2253
The list is initialized by WorkingTree.set_merge_modified, which is
2254
typically called after we make some automatic updates to the tree
2257
This returns a map of file_id->sha1, containing only files which are
2258
still in the working inventory and have that text hash.
2261
hashfile = self._transport.get('merge-hashes')
2262
except errors.NoSuchFile:
2267
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2268
raise errors.MergeModifiedFormatError()
2269
except StopIteration:
2270
raise errors.MergeModifiedFormatError()
2271
for s in _mod_rio.RioReader(hashfile):
2272
# RioReader reads in Unicode, so convert file_ids back to utf8
2273
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2274
if not self.inventory.has_id(file_id):
2276
text_hash = s.get("hash")
2277
if text_hash == self.get_file_sha1(file_id):
2278
merge_hashes[file_id] = text_hash
2284
def subsume(self, other_tree):
2285
def add_children(inventory, entry):
2286
for child_entry in entry.children.values():
2287
inventory._byid[child_entry.file_id] = child_entry
2288
if child_entry.kind == 'directory':
2289
add_children(inventory, child_entry)
2290
if other_tree.get_root_id() == self.get_root_id():
2291
raise errors.BadSubsumeSource(self, other_tree,
2292
'Trees have the same root')
2294
other_tree_path = self.relpath(other_tree.basedir)
2295
except errors.PathNotChild:
2296
raise errors.BadSubsumeSource(self, other_tree,
2297
'Tree is not contained by the other')
2298
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2299
if new_root_parent is None:
2300
raise errors.BadSubsumeSource(self, other_tree,
2301
'Parent directory is not versioned.')
2302
# We need to ensure that the result of a fetch will have a
2303
# versionedfile for the other_tree root, and only fetching into
2304
# RepositoryKnit2 guarantees that.
2305
if not self.branch.repository.supports_rich_root():
2306
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2307
other_tree.lock_tree_write()
2309
new_parents = other_tree.get_parent_ids()
2310
other_root = other_tree.inventory.root
2311
other_root.parent_id = new_root_parent
2312
other_root.name = osutils.basename(other_tree_path)
2313
self.inventory.add(other_root)
2314
add_children(self.inventory, other_root)
2315
self._write_inventory(self.inventory)
2316
# normally we don't want to fetch whole repositories, but i think
2317
# here we really do want to consolidate the whole thing.
2318
for parent_id in other_tree.get_parent_ids():
2319
self.branch.fetch(other_tree.branch, parent_id)
2320
self.add_parent_tree_id(parent_id)
2323
other_tree.bzrdir.retire_bzrdir()
2325
@needs_tree_write_lock
2326
def extract(self, file_id, format=None):
2327
"""Extract a subtree from this tree.
2329
A new branch will be created, relative to the path for this tree.
2333
segments = osutils.splitpath(path)
2334
transport = self.branch.bzrdir.root_transport
2335
for name in segments:
2336
transport = transport.clone(name)
2337
transport.ensure_base()
2340
sub_path = self.id2path(file_id)
2341
branch_transport = mkdirs(sub_path)
2343
format = self.bzrdir.cloning_metadir()
2344
branch_transport.ensure_base()
2345
branch_bzrdir = format.initialize_on_transport(branch_transport)
2347
repo = branch_bzrdir.find_repository()
2348
except errors.NoRepositoryPresent:
2349
repo = branch_bzrdir.create_repository()
2350
if not repo.supports_rich_root():
2351
raise errors.RootNotRich()
2352
new_branch = branch_bzrdir.create_branch()
2353
new_branch.pull(self.branch)
2354
for parent_id in self.get_parent_ids():
2355
new_branch.fetch(self.branch, parent_id)
2356
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2357
if tree_transport.base != branch_transport.base:
2358
tree_bzrdir = format.initialize_on_transport(tree_transport)
2359
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2360
target_branch=new_branch)
2362
tree_bzrdir = branch_bzrdir
2363
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2364
wt.set_parent_ids(self.get_parent_ids())
2365
my_inv = self.inventory
2366
child_inv = inventory.Inventory(root_id=None)
2367
new_root = my_inv[file_id]
2368
my_inv.remove_recursive_id(file_id)
2369
new_root.parent_id = None
2370
child_inv.add(new_root)
2371
self._write_inventory(my_inv)
2372
wt._write_inventory(child_inv)
2375
def list_files(self, include_root=False, from_dir=None, recursive=True):
2376
"""List all files as (path, class, kind, id, entry).
2378
Lists, but does not descend into unversioned directories.
2379
This does not include files that have been deleted in this
2380
tree. Skips the control directory.
2382
:param include_root: if True, return an entry for the root
2383
:param from_dir: start from this directory or None for the root
2384
:param recursive: whether to recurse into subdirectories or not
2386
# list_files is an iterator, so @needs_read_lock doesn't work properly
2387
# with it. So callers should be careful to always read_lock the tree.
2388
if not self.is_locked():
2389
raise errors.ObjectNotLocked(self)
2391
inv = self.inventory
2392
if from_dir is None and include_root is True:
2393
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2394
# Convert these into local objects to save lookup times
2395
pathjoin = osutils.pathjoin
2396
file_kind = self._kind
2398
# transport.base ends in a slash, we want the piece
2399
# between the last two slashes
2400
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2402
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2404
# directory file_id, relative path, absolute path, reverse sorted children
2405
if from_dir is not None:
2406
from_dir_id = inv.path2id(from_dir)
2407
if from_dir_id is None:
2408
# Directory not versioned
2410
from_dir_abspath = pathjoin(self.basedir, from_dir)
2412
from_dir_id = inv.root.file_id
2413
from_dir_abspath = self.basedir
2414
children = os.listdir(from_dir_abspath)
2416
# jam 20060527 The kernel sized tree seems equivalent whether we
2417
# use a deque and popleft to keep them sorted, or if we use a plain
2418
# list and just reverse() them.
2419
children = collections.deque(children)
2420
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2422
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2425
f = children.popleft()
2426
## TODO: If we find a subdirectory with its own .bzr
2427
## directory, then that is a separate tree and we
2428
## should exclude it.
2430
# the bzrdir for this tree
2431
if transport_base_dir == f:
2434
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2435
# and 'f' doesn't begin with one, we can do a string op, rather
2436
# than the checks of pathjoin(), all relative paths will have an extra slash
2438
fp = from_dir_relpath + '/' + f
2441
fap = from_dir_abspath + '/' + f
2443
dir_ie = inv[from_dir_id]
2444
if dir_ie.kind == 'directory':
2445
f_ie = dir_ie.children.get(f)
2450
elif self.is_ignored(fp[1:]):
2453
# we may not have found this file, because of a unicode
2454
# issue, or because the directory was actually a symlink.
2455
f_norm, can_access = osutils.normalized_filename(f)
2456
if f == f_norm or not can_access:
2457
# No change, so treat this file normally
2460
# this file can be accessed by a normalized path
2461
# check again if it is versioned
2462
# these lines are repeated here for performance
2464
fp = from_dir_relpath + '/' + f
2465
fap = from_dir_abspath + '/' + f
2466
f_ie = inv.get_child(from_dir_id, f)
2469
elif self.is_ignored(fp[1:]):
2476
# make a last minute entry
2478
yield fp[1:], c, fk, f_ie.file_id, f_ie
2481
yield fp[1:], c, fk, None, fk_entries[fk]()
2483
yield fp[1:], c, fk, None, TreeEntry()
2486
if fk != 'directory':
2489
# But do this child first if recursing down
2491
new_children = os.listdir(fap)
2493
new_children = collections.deque(new_children)
2494
stack.append((f_ie.file_id, fp, fap, new_children))
2495
# Break out of inner loop,
2496
# so that we start outer loop with child
2499
# if we finished all children, pop it off the stack
2502
@needs_tree_write_lock
2503
def move(self, from_paths, to_dir=None, after=False):
2506
to_dir must exist in the inventory.
2508
If to_dir exists and is a directory, the files are moved into
2509
it, keeping their old names.
2511
Note that to_dir is only the last component of the new name;
2512
this doesn't change the directory.
2514
For each entry in from_paths the move mode will be determined
2517
The first mode moves the file in the filesystem and updates the
2518
inventory. The second mode only updates the inventory without
2519
touching the file on the filesystem.
2521
move uses the second mode if 'after == True' and the target is
2522
either not versioned or newly added, and present in the working tree.
2524
move uses the second mode if 'after == False' and the source is
2525
versioned but no longer in the working tree, and the target is not
2526
versioned but present in the working tree.
2528
move uses the first mode if 'after == False' and the source is
2529
versioned and present in the working tree, and the target is not
2530
versioned and not present in the working tree.
2532
Everything else results in an error.
2534
This returns a list of (from_path, to_path) pairs for each
2535
entry that is moved.
2540
# check for deprecated use of signature
2542
raise TypeError('You must supply a target directory')
2543
# check destination directory
2544
if isinstance(from_paths, basestring):
2546
inv = self.inventory
2547
to_abs = self.abspath(to_dir)
2548
if not isdir(to_abs):
2549
raise errors.BzrMoveFailedError('',to_dir,
2550
errors.NotADirectory(to_abs))
2551
if not self.has_filename(to_dir):
2552
raise errors.BzrMoveFailedError('',to_dir,
2553
errors.NotInWorkingDirectory(to_dir))
2554
to_dir_id = inv.path2id(to_dir)
2555
if to_dir_id is None:
2556
raise errors.BzrMoveFailedError('',to_dir,
2557
errors.NotVersionedError(path=to_dir))
2559
to_dir_ie = inv[to_dir_id]
2560
if to_dir_ie.kind != 'directory':
2561
raise errors.BzrMoveFailedError('',to_dir,
2562
errors.NotADirectory(to_abs))
2564
# create rename entries and tuples
2565
for from_rel in from_paths:
2566
from_tail = splitpath(from_rel)[-1]
2567
from_id = inv.path2id(from_rel)
2569
raise errors.BzrMoveFailedError(from_rel,to_dir,
2570
errors.NotVersionedError(path=from_rel))
2572
from_entry = inv[from_id]
2573
from_parent_id = from_entry.parent_id
2574
to_rel = pathjoin(to_dir, from_tail)
2575
rename_entry = InventoryWorkingTree._RenameEntry(
2578
from_tail=from_tail,
2579
from_parent_id=from_parent_id,
2580
to_rel=to_rel, to_tail=from_tail,
2581
to_parent_id=to_dir_id)
2582
rename_entries.append(rename_entry)
2583
rename_tuples.append((from_rel, to_rel))
2585
# determine which move mode to use. checks also for movability
2586
rename_entries = self._determine_mv_mode(rename_entries, after)
2588
original_modified = self._inventory_is_modified
2591
self._inventory_is_modified = True
2592
self._move(rename_entries)
2594
# restore the inventory on error
2595
self._inventory_is_modified = original_modified
2597
self._write_inventory(inv)
2598
return rename_tuples
2600
@needs_tree_write_lock
2601
def rename_one(self, from_rel, to_rel, after=False):
2604
This can change the directory or the filename or both.
2606
rename_one has several 'modes' to work. First, it can rename a physical
2607
file and change the file_id. That is the normal mode. Second, it can
2608
only change the file_id without touching any physical file.
2610
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2611
versioned but present in the working tree.
2613
rename_one uses the second mode if 'after == False' and 'from_rel' is
2614
versioned but no longer in the working tree, and 'to_rel' is not
2615
versioned but present in the working tree.
2617
rename_one uses the first mode if 'after == False' and 'from_rel' is
2618
versioned and present in the working tree, and 'to_rel' is not
2619
versioned and not present in the working tree.
2621
Everything else results in an error.
2623
inv = self.inventory
2626
# create rename entries and tuples
2627
from_tail = splitpath(from_rel)[-1]
2628
from_id = inv.path2id(from_rel)
2630
# if file is missing in the inventory maybe it's in the basis_tree
2631
basis_tree = self.branch.basis_tree()
2632
from_id = basis_tree.path2id(from_rel)
2634
raise errors.BzrRenameFailedError(from_rel,to_rel,
2635
errors.NotVersionedError(path=from_rel))
2636
# put entry back in the inventory so we can rename it
2637
from_entry = basis_tree.inventory[from_id].copy()
2640
from_entry = inv[from_id]
2641
from_parent_id = from_entry.parent_id
2642
to_dir, to_tail = os.path.split(to_rel)
2643
to_dir_id = inv.path2id(to_dir)
2644
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2646
from_tail=from_tail,
2647
from_parent_id=from_parent_id,
2648
to_rel=to_rel, to_tail=to_tail,
2649
to_parent_id=to_dir_id)
2650
rename_entries.append(rename_entry)
2652
# determine which move mode to use. checks also for movability
2653
rename_entries = self._determine_mv_mode(rename_entries, after)
2655
# check if the target changed directory and if the target directory is
2657
if to_dir_id is None:
2658
raise errors.BzrMoveFailedError(from_rel,to_rel,
2659
errors.NotVersionedError(path=to_dir))
2661
# all checks done. now we can continue with our actual work
2662
mutter('rename_one:\n'
2667
' to_dir_id {%s}\n',
2668
from_id, from_rel, to_rel, to_dir, to_dir_id)
2670
self._move(rename_entries)
2671
self._write_inventory(inv)
2673
class _RenameEntry(object):
2674
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2675
to_rel, to_tail, to_parent_id, only_change_inv=False,
2677
self.from_rel = from_rel
2678
self.from_id = from_id
2679
self.from_tail = from_tail
2680
self.from_parent_id = from_parent_id
2681
self.to_rel = to_rel
2682
self.to_tail = to_tail
2683
self.to_parent_id = to_parent_id
2684
self.change_id = change_id
2685
self.only_change_inv = only_change_inv
2687
def _determine_mv_mode(self, rename_entries, after=False):
2688
"""Determines for each from-to pair if both inventory and working tree
2689
or only the inventory has to be changed.
2691
Also does basic plausability tests.
2693
inv = self.inventory
2695
for rename_entry in rename_entries:
2696
# store to local variables for easier reference
2697
from_rel = rename_entry.from_rel
2698
from_id = rename_entry.from_id
2699
to_rel = rename_entry.to_rel
2700
to_id = inv.path2id(to_rel)
2701
only_change_inv = False
2704
# check the inventory for source and destination
2706
raise errors.BzrMoveFailedError(from_rel,to_rel,
2707
errors.NotVersionedError(path=from_rel))
2708
if to_id is not None:
2710
# allow it with --after but only if dest is newly added
2712
basis = self.basis_tree()
2715
if not basis.has_id(to_id):
2716
rename_entry.change_id = True
2721
raise errors.BzrMoveFailedError(from_rel,to_rel,
2722
errors.AlreadyVersionedError(path=to_rel))
2724
# try to determine the mode for rename (only change inv or change
2725
# inv and file system)
2727
if not self.has_filename(to_rel):
2728
raise errors.BzrMoveFailedError(from_id,to_rel,
2729
errors.NoSuchFile(path=to_rel,
2730
extra="New file has not been created yet"))
2731
only_change_inv = True
2732
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2733
only_change_inv = True
2734
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2735
only_change_inv = False
2736
elif (not self.case_sensitive
2737
and from_rel.lower() == to_rel.lower()
2738
and self.has_filename(from_rel)):
2739
only_change_inv = False
2741
# something is wrong, so lets determine what exactly
2742
if not self.has_filename(from_rel) and \
2743
not self.has_filename(to_rel):
2744
raise errors.BzrRenameFailedError(from_rel,to_rel,
2745
errors.PathsDoNotExist(paths=(str(from_rel),
2748
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2749
rename_entry.only_change_inv = only_change_inv
2750
return rename_entries
2752
def _move(self, rename_entries):
2753
"""Moves a list of files.
2755
Depending on the value of the flag 'only_change_inv', the
2756
file will be moved on the file system or not.
2758
inv = self.inventory
2761
for entry in rename_entries:
2763
self._move_entry(entry)
2765
self._rollback_move(moved)
2769
def _rollback_move(self, moved):
2770
"""Try to rollback a previous move in case of an filesystem error."""
2771
inv = self.inventory
2774
self._move_entry(WorkingTree._RenameEntry(
2775
entry.to_rel, entry.from_id,
2776
entry.to_tail, entry.to_parent_id, entry.from_rel,
2777
entry.from_tail, entry.from_parent_id,
2778
entry.only_change_inv))
2779
except errors.BzrMoveFailedError, e:
2780
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2781
" The working tree is in an inconsistent state."
2782
" Please consider doing a 'bzr revert'."
2783
" Error message is: %s" % e)
2785
def _move_entry(self, entry):
2786
inv = self.inventory
2787
from_rel_abs = self.abspath(entry.from_rel)
2788
to_rel_abs = self.abspath(entry.to_rel)
2789
if from_rel_abs == to_rel_abs:
2790
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2791
"Source and target are identical.")
2793
if not entry.only_change_inv:
2795
osutils.rename(from_rel_abs, to_rel_abs)
2797
raise errors.BzrMoveFailedError(entry.from_rel,
2800
to_id = inv.path2id(entry.to_rel)
2801
inv.remove_recursive_id(to_id)
2802
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2804
@needs_tree_write_lock
2805
def unversion(self, file_ids):
2806
"""Remove the file ids in file_ids from the current versioned set.
2808
When a file_id is unversioned, all of its children are automatically
2811
:param file_ids: The file ids to stop versioning.
2812
:raises: NoSuchId if any fileid is not currently versioned.
2814
for file_id in file_ids:
2815
if not self._inventory.has_id(file_id):
2816
raise errors.NoSuchId(self, file_id)
2817
for file_id in file_ids:
2818
if self._inventory.has_id(file_id):
2819
self._inventory.remove_recursive_id(file_id)
2821
# in the future this should just set a dirty bit to wait for the
2822
# final unlock. However, until all methods of workingtree start
2823
# with the current in -memory inventory rather than triggering
2824
# a read, it is more complex - we need to teach read_inventory
2825
# to know when to read, and when to not read first... and possibly
2826
# to save first when the in memory one may be corrupted.
2827
# so for now, we just only write it if it is indeed dirty.
2829
self._write_inventory(self._inventory)
2831
def stored_kind(self, file_id):
2832
"""See Tree.stored_kind"""
2833
return self.inventory[file_id].kind
2836
"""Yield all unversioned files in this WorkingTree.
2838
If there are any unversioned directories then only the directory is
2839
returned, not all its children. But if there are unversioned files
2840
under a versioned subdirectory, they are returned.
2842
Currently returned depth-first, sorted by name within directories.
2843
This is the same order used by 'osutils.walkdirs'.
2845
## TODO: Work from given directory downwards
2846
for path, dir_entry in self.inventory.directories():
2847
# mutter("search for unknowns in %r", path)
2848
dirabs = self.abspath(path)
2849
if not isdir(dirabs):
2850
# e.g. directory deleted
2854
for subf in os.listdir(dirabs):
2855
if self.bzrdir.is_control_filename(subf):
2857
if subf not in dir_entry.children:
2860
can_access) = osutils.normalized_filename(subf)
2861
except UnicodeDecodeError:
2862
path_os_enc = path.encode(osutils._fs_enc)
2863
relpath = path_os_enc + '/' + subf
2864
raise errors.BadFilenameEncoding(relpath,
2866
if subf_norm != subf and can_access:
2867
if subf_norm not in dir_entry.children:
2868
fl.append(subf_norm)
2874
subp = pathjoin(path, subf)
2877
def _walkdirs(self, prefix=""):
2878
"""Walk the directories of this tree.
2880
:param prefix: is used as the directrory to start with.
2881
:returns: a generator which yields items in the form::
2883
((curren_directory_path, fileid),
2884
[(file1_path, file1_name, file1_kind, None, file1_id,
2887
_directory = 'directory'
2888
# get the root in the inventory
2889
inv = self.inventory
2890
top_id = inv.path2id(prefix)
2894
pending = [(prefix, '', _directory, None, top_id, None)]
2897
currentdir = pending.pop()
2898
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2899
top_id = currentdir[4]
2901
relroot = currentdir[0] + '/'
2904
# FIXME: stash the node in pending
2906
if entry.kind == 'directory':
2907
for name, child in entry.sorted_children():
2908
dirblock.append((relroot + name, name, child.kind, None,
2909
child.file_id, child.kind
2911
yield (currentdir[0], entry.file_id), dirblock
2912
# push the user specified dirs from dirblock
2913
for dir in reversed(dirblock):
2914
if dir[2] == _directory:
2918
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2919
"""Registry for working tree formats."""
2921
def __init__(self, other_registry=None):
2922
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2923
self._default_format = None
2924
self._default_format_key = None
2926
def get_default(self):
2927
"""Return the current default format."""
2928
if (self._default_format_key is not None and
2929
self._default_format is None):
2930
self._default_format = self.get(self._default_format_key)
2931
return self._default_format
2933
def set_default(self, format):
2934
"""Set the default format."""
2935
self._default_format = format
2936
self._default_format_key = None
2938
def set_default_key(self, format_string):
2939
"""Set the default format by its format string."""
2940
self._default_format_key = format_string
2941
self._default_format = None
2944
format_registry = WorkingTreeFormatRegistry()
2947
class WorkingTreeFormat(controldir.ControlComponentFormat):
2948
"""An encapsulation of the initialization and open routines for a format.
2950
Formats provide three things:
2951
* An initialization routine,
2955
Formats are placed in an dict by their format string for reference
2956
during workingtree opening. Its not required that these be instances, they
2957
can be classes themselves with class methods - it simply depends on
2958
whether state is needed for a given format or not.
2960
Once a format is deprecated, just deprecate the initialize and open
2961
methods on the format class. Do not deprecate the object, as the
2962
object will be created every time regardless.
2965
requires_rich_root = False
2967
upgrade_recommended = False
2969
requires_normalized_unicode_filenames = False
2971
case_sensitive_filename = "FoRMaT"
2973
missing_parent_conflicts = False
2974
"""If this format supports missing parent conflicts."""
2976
supports_versioned_directories = None
2979
def find_format_string(klass, a_bzrdir):
2980
"""Return format name for the working tree object in a_bzrdir."""
2982
transport = a_bzrdir.get_workingtree_transport(None)
2983
return transport.get_bytes("format")
2984
except errors.NoSuchFile:
2985
raise errors.NoWorkingTree(base=transport.base)
2988
def find_format(klass, a_bzrdir):
2989
"""Return the format for the working tree object in a_bzrdir."""
2991
format_string = klass.find_format_string(a_bzrdir)
2992
return format_registry.get(format_string)
2994
raise errors.UnknownFormatError(format=format_string,
2995
kind="working tree")
2997
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2998
accelerator_tree=None, hardlink=False):
2999
"""Initialize a new working tree in a_bzrdir.
3001
:param a_bzrdir: BzrDir to initialize the working tree in.
3002
:param revision_id: allows creating a working tree at a different
3003
revision than the branch is at.
3004
:param from_branch: Branch to checkout
3005
:param accelerator_tree: A tree which can be used for retrieving file
3006
contents more quickly than the revision tree, i.e. a workingtree.
3007
The revision tree will be used for cases where accelerator_tree's
3008
content is different.
3009
:param hardlink: If true, hard-link files from accelerator_tree,
3012
raise NotImplementedError(self.initialize)
3014
def __eq__(self, other):
3015
return self.__class__ is other.__class__
3017
def __ne__(self, other):
3018
return not (self == other)
3021
@symbol_versioning.deprecated_method(
3022
symbol_versioning.deprecated_in((2, 4, 0)))
3023
def get_default_format(klass):
3024
"""Return the current default format."""
3025
return format_registry.get_default()
3027
def get_format_string(self):
3028
"""Return the ASCII format string that identifies this format."""
3029
raise NotImplementedError(self.get_format_string)
3031
def get_format_description(self):
3032
"""Return the short description for this format."""
3033
raise NotImplementedError(self.get_format_description)
3035
def is_supported(self):
3036
"""Is this format supported?
3038
Supported formats can be initialized and opened.
3039
Unsupported formats may not support initialization or committing or
3040
some other features depending on the reason for not being supported.
3044
def supports_content_filtering(self):
3045
"""True if this format supports content filtering."""
3048
def supports_views(self):
3049
"""True if this format supports stored views."""
3053
@symbol_versioning.deprecated_method(
3054
symbol_versioning.deprecated_in((2, 4, 0)))
3055
def register_format(klass, format):
3056
format_registry.register(format)
3059
@symbol_versioning.deprecated_method(
3060
symbol_versioning.deprecated_in((2, 4, 0)))
3061
def register_extra_format(klass, format):
3062
format_registry.register_extra(format)
3065
@symbol_versioning.deprecated_method(
3066
symbol_versioning.deprecated_in((2, 4, 0)))
3067
def unregister_extra_format(klass, format):
3068
format_registry.unregister_extra(format)
3071
@symbol_versioning.deprecated_method(
3072
symbol_versioning.deprecated_in((2, 4, 0)))
3073
def get_formats(klass):
3074
return format_registry._get_all()
3077
@symbol_versioning.deprecated_method(
3078
symbol_versioning.deprecated_in((2, 4, 0)))
3079
def set_default_format(klass, format):
3080
format_registry.set_default(format)
3083
@symbol_versioning.deprecated_method(
3084
symbol_versioning.deprecated_in((2, 4, 0)))
3085
def unregister_format(klass, format):
3086
format_registry.remove(format)
3089
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3090
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3091
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3092
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3093
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3094
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3095
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3096
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3097
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
