161
class WorkingTree(bzrlib.mutabletree.MutableTree,
162
controldir.ControlComponent):
88
class WorkingTree(bzrlib.tree.Tree):
163
89
"""Working copy tree.
165
:ivar basedir: The root of the tree on disk. This is a unicode path object
166
(as opposed to a URL).
91
The inventory is held in the `Branch` working-inventory, and the
92
files are in a directory on disk.
94
It is possible for a `WorkingTree` to have a filename which is
95
not listed in the Inventory and vice versa.
169
# override this to set the strategy for storing views
170
def _make_views(self):
171
return views.DisabledViews(self)
173
def __init__(self, basedir='.',
174
branch=DEPRECATED_PARAMETER,
179
"""Construct a WorkingTree instance. This is not a public API.
181
:param branch: A branch to override probing for the branch.
97
def __init__(self, basedir, branch=None):
98
"""Construct a WorkingTree for basedir.
100
If the branch is not supplied, it is opened automatically.
101
If the branch is supplied, it must be the branch for this basedir.
102
(branch.base is not cross checked, because for remote branches that
103
would be meaningless).
183
self._format = _format
184
self.bzrdir = _bzrdir
186
raise errors.BzrError("Please use bzrdir.open_workingtree or "
187
"WorkingTree.open() to obtain a WorkingTree.")
188
basedir = safe_unicode(basedir)
189
mutter("opening working tree %r", basedir)
190
if deprecated_passed(branch):
191
self._branch = branch
193
self._branch = self.bzrdir.open_branch()
194
self.basedir = realpath(basedir)
195
self._control_files = _control_files
196
self._transport = self._control_files._transport
105
from bzrlib.hashcache import HashCache
106
from bzrlib.trace import note, mutter
109
branch = Branch.open(basedir)
110
self._inventory = branch.inventory
111
self.path2id = self._inventory.path2id
113
self.basedir = basedir
197
115
# update the whole cache up front and write to disk if anything changed;
198
116
# in the future we might want to do this more selectively
199
# two possible ways offer themselves : in self._unlock, write the cache
200
# if needed, or, when the cache sees a change, append it to the hash
201
# cache file, and have the parser take the most recent entry for a
203
wt_trans = self.bzrdir.get_workingtree_transport(None)
204
cache_filename = wt_trans.local_abspath('stat-cache')
205
self._hashcache = hashcache.HashCache(basedir, cache_filename,
206
self.bzrdir._get_file_mode(),
207
self._content_filter_stack_provider())
117
hc = self._hashcache = HashCache(basedir)
210
# is this scan needed ? it makes things kinda slow.
213
121
if hc.needs_write:
214
122
mutter("write hc")
217
self._detect_case_handling()
218
self._rules_searcher = None
219
self.views = self._make_views()
222
def user_transport(self):
223
return self.bzrdir.user_transport
226
def control_transport(self):
227
return self._transport
229
def is_control_filename(self, filename):
230
"""True if filename is the name of a control file in this tree.
232
:param filename: A filename within the tree. This is a relative path
233
from the root of this tree.
235
This is true IF and ONLY IF the filename is part of the meta data
236
that bzr controls in this tree. I.E. a random .bzr directory placed
237
on disk will not be a control file for this tree.
239
return self.bzrdir.is_control_filename(filename)
241
def _detect_case_handling(self):
242
wt_trans = self.bzrdir.get_workingtree_transport(None)
244
wt_trans.stat(self._format.case_sensitive_filename)
245
except errors.NoSuchFile:
246
self.case_sensitive = True
248
self.case_sensitive = False
250
self._setup_directory_is_tree_reference()
253
fget=lambda self: self._branch,
254
doc="""The branch this WorkingTree is connected to.
256
This cannot be set - it is reflective of the actual disk structure
257
the working tree has been constructed from.
260
def break_lock(self):
261
"""Break a lock if one is present from another instance.
263
Uses the ui factory to ask for confirmation if the lock may be from
266
This will probe the repository for its lock as well.
268
self._control_files.break_lock()
269
self.branch.break_lock()
271
def requires_rich_root(self):
272
return self._format.requires_rich_root
274
def supports_tree_reference(self):
277
def supports_content_filtering(self):
278
return self._format.supports_content_filtering()
280
def supports_views(self):
281
return self.views.supports_views()
284
def open(path=None, _unsupported=False):
285
"""Open an existing working tree at path.
289
path = osutils.getcwd()
290
control = bzrdir.BzrDir.open(path, _unsupported)
291
return control.open_workingtree(_unsupported)
294
def open_containing(path=None):
295
"""Open an existing working tree which has its root about path.
297
This probes for a working tree at path and searches upwards from there.
299
Basically we keep looking up until we find the control directory or
300
run into /. If there isn't one, raises NotBranchError.
301
TODO: give this a new exception.
302
If there is one, it is returned, along with the unused portion of path.
304
:return: The WorkingTree that contains 'path', and the rest of path
307
path = osutils.getcwd()
308
control, relpath = bzrdir.BzrDir.open_containing(path)
309
return control.open_workingtree(), relpath
312
def open_containing_paths(file_list, default_directory=None,
313
canonicalize=True, apply_view=True):
314
"""Open the WorkingTree that contains a set of paths.
316
Fail if the paths given are not all in a single tree.
318
This is used for the many command-line interfaces that take a list of
319
any number of files and that require they all be in the same tree.
321
if default_directory is None:
322
default_directory = u'.'
323
# recommended replacement for builtins.internal_tree_files
324
if file_list is None or len(file_list) == 0:
325
tree = WorkingTree.open_containing(default_directory)[0]
326
# XXX: doesn't really belong here, and seems to have the strange
327
# side effect of making it return a bunch of files, not the whole
328
# tree -- mbp 20100716
329
if tree.supports_views() and apply_view:
330
view_files = tree.views.lookup_view()
332
file_list = view_files
333
view_str = views.view_display_str(view_files)
334
note("Ignoring files outside view. View is %s" % view_str)
335
return tree, file_list
336
if default_directory == u'.':
339
seed = default_directory
340
file_list = [osutils.pathjoin(default_directory, f)
342
tree = WorkingTree.open_containing(seed)[0]
343
return tree, tree.safe_relpath_files(file_list, canonicalize,
344
apply_view=apply_view)
346
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
347
"""Convert file_list into a list of relpaths in tree.
349
:param self: A tree to operate on.
350
:param file_list: A list of user provided paths or None.
351
:param apply_view: if True and a view is set, apply it or check that
352
specified files are within it
353
:return: A list of relative paths.
354
:raises errors.PathNotChild: When a provided path is in a different self
357
if file_list is None:
359
if self.supports_views() and apply_view:
360
view_files = self.views.lookup_view()
364
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
365
# doesn't - fix that up here before we enter the loop.
367
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
370
for filename in file_list:
371
relpath = fixer(osutils.dereference_path(filename))
372
if view_files and not osutils.is_inside_any(view_files, relpath):
373
raise errors.FileOutsideView(filename, view_files)
374
new_list.append(relpath)
378
def open_downlevel(path=None):
379
"""Open an unsupported working tree.
381
Only intended for advanced situations like upgrading part of a bzrdir.
383
return WorkingTree.open(path, _unsupported=True)
386
def find_trees(location):
387
def list_current(transport):
388
return [d for d in transport.list_dir('') if d != '.bzr']
389
def evaluate(bzrdir):
391
tree = bzrdir.open_workingtree()
392
except errors.NoWorkingTree:
396
t = transport.get_transport(location)
397
iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
398
list_current=list_current)
399
return [tr for tr in iterator if tr is not None]
401
def all_file_ids(self):
402
"""See Tree.iter_all_file_ids"""
403
raise NotImplementedError(self.all_file_ids)
127
if self._hashcache.needs_write:
128
self._hashcache.write()
132
"""Iterate through file_ids for this tree.
134
file_ids are in a WorkingTree if they are in the working inventory
135
and the working file exists.
137
inv = self._inventory
138
for path, ie in inv.iter_entries():
139
if bzrlib.osutils.lexists(self.abspath(path)):
405
143
def __repr__(self):
406
144
return "<%s of %s>" % (self.__class__.__name__,
407
145
getattr(self, 'basedir', None))
409
149
def abspath(self, filename):
410
return pathjoin(self.basedir, filename)
412
def basis_tree(self):
413
"""Return RevisionTree for the current last revision.
415
If the left most parent is a ghost then the returned tree will be an
416
empty tree - one obtained by calling
417
repository.revision_tree(NULL_REVISION).
420
revision_id = self.get_parent_ids()[0]
422
# no parents, return an empty revision tree.
423
# in the future this should return the tree for
424
# 'empty:' - the implicit root empty tree.
425
return self.branch.repository.revision_tree(
426
_mod_revision.NULL_REVISION)
428
return self.revision_tree(revision_id)
429
except errors.NoSuchRevision:
431
# No cached copy available, retrieve from the repository.
432
# FIXME? RBC 20060403 should we cache the inventory locally
435
return self.branch.repository.revision_tree(revision_id)
436
except (errors.RevisionNotPresent, errors.NoSuchRevision):
437
# the basis tree *may* be a ghost or a low level error may have
438
# occurred. If the revision is present, its a problem, if its not
440
if self.branch.repository.has_revision(revision_id):
442
# the basis tree is a ghost so return an empty tree.
443
return self.branch.repository.revision_tree(
444
_mod_revision.NULL_REVISION)
447
self._flush_ignore_list_cache()
449
def relpath(self, path):
450
"""Return the local path portion from a given path.
452
The path may be absolute or relative. If its a relative path it is
453
interpreted relative to the python current working directory.
455
return osutils.relpath(self.basedir, path)
150
return os.path.join(self.basedir, filename)
152
def relpath(self, abspath):
153
"""Return the local path portion from a given absolute path."""
154
return relpath(self.basedir, abspath)
457
156
def has_filename(self, filename):
458
return osutils.lexists(self.abspath(filename))
460
def get_file(self, file_id, path=None, filtered=True):
461
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
463
def get_file_with_stat(self, file_id, path=None, filtered=True,
464
_fstat=osutils.fstat):
465
"""See Tree.get_file_with_stat."""
467
path = self.id2path(file_id)
468
file_obj = self.get_file_byname(path, filtered=False)
469
stat_value = _fstat(file_obj.fileno())
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(path)
472
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
473
return (file_obj, stat_value)
475
def get_file_text(self, file_id, path=None, filtered=True):
476
my_file = self.get_file(file_id, path=path, filtered=filtered)
478
return my_file.read()
482
def get_file_byname(self, filename, filtered=True):
483
path = self.abspath(filename)
485
if filtered and self.supports_content_filtering():
486
filters = self._content_filter_stack(filename)
487
return _mod_filters.filtered_input_file(f, filters)
491
def get_file_lines(self, file_id, path=None, filtered=True):
492
"""See Tree.get_file_lines()"""
493
file = self.get_file(file_id, path, filtered=filtered)
495
return file.readlines()
499
def get_parent_ids(self):
500
"""See Tree.get_parent_ids.
502
This implementation reads the pending merges list and last_revision
503
value and uses that to decide what the parents list should be.
505
last_rev = _mod_revision.ensure_null(self._last_revision())
506
if _mod_revision.NULL_REVISION == last_rev:
511
merges_bytes = self._transport.get_bytes('pending-merges')
512
except errors.NoSuchFile:
515
for l in osutils.split_lines(merges_bytes):
516
revision_id = l.rstrip('\n')
517
parents.append(revision_id)
520
def get_root_id(self):
521
"""Return the id of this trees root"""
522
raise NotImplementedError(self.get_root_id)
525
def clone(self, to_bzrdir, revision_id=None):
526
"""Duplicate this working tree into to_bzr, including all state.
528
Specifically modified files are kept as modified, but
529
ignored and unknown files are discarded.
531
If you want to make a new line of development, see bzrdir.sprout()
534
If not None, the cloned tree will have its last revision set to
535
revision, and difference between the source trees last revision
536
and this one merged in.
538
# assumes the target bzr dir format is compatible.
539
result = to_bzrdir.create_workingtree()
540
self.copy_content_into(result, revision_id)
544
def copy_content_into(self, tree, revision_id=None):
545
"""Copy the current content and user files of this tree into tree."""
546
tree.set_root_id(self.get_root_id())
547
if revision_id is None:
548
merge.transform_tree(tree, self)
550
# TODO now merge from tree.last_revision to revision (to preserve
551
# user local changes)
552
merge.transform_tree(tree, self)
553
tree.set_parent_ids([revision_id])
157
return bzrlib.osutils.lexists(self.abspath(filename))
159
def get_file(self, file_id):
160
return self.get_file_byname(self.id2path(file_id))
162
def get_file_byname(self, filename):
163
return file(self.abspath(filename), 'rb')
165
def _get_store_filename(self, file_id):
166
## XXX: badly named; this isn't in the store at all
167
return self.abspath(self.id2path(file_id))
555
170
def id2abspath(self, file_id):
556
171
return self.abspath(self.id2path(file_id))
558
def _check_for_tree_references(self, iterator):
559
"""See if directories have become tree-references."""
560
blocked_parent_ids = set()
561
for path, ie in iterator:
562
if ie.parent_id in blocked_parent_ids:
563
# This entry was pruned because one of its parents became a
564
# TreeReference. If this is a directory, mark it as blocked.
565
if ie.kind == 'directory':
566
blocked_parent_ids.add(ie.file_id)
568
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
569
# This InventoryDirectory needs to be a TreeReference
570
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
571
blocked_parent_ids.add(ie.file_id)
574
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
575
"""See Tree.iter_entries_by_dir()"""
576
# The only trick here is that if we supports_tree_reference then we
577
# need to detect if a directory becomes a tree-reference.
578
iterator = super(WorkingTree, self).iter_entries_by_dir(
579
specific_file_ids=specific_file_ids,
580
yield_parents=yield_parents)
581
if not self.supports_tree_reference():
584
return self._check_for_tree_references(iterator)
586
def get_file_size(self, file_id):
587
"""See Tree.get_file_size"""
588
# XXX: this returns the on-disk size; it should probably return the
591
return os.path.getsize(self.id2abspath(file_id))
593
if e.errno != errno.ENOENT:
598
@needs_tree_write_lock
599
def _gather_kinds(self, files, kinds):
600
"""See MutableTree._gather_kinds."""
601
for pos, f in enumerate(files):
602
if kinds[pos] is None:
603
fullpath = normpath(self.abspath(f))
605
kinds[pos] = file_kind(fullpath)
607
if e.errno == errno.ENOENT:
608
raise errors.NoSuchFile(fullpath)
611
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
612
"""Add revision_id as a parent.
614
This is equivalent to retrieving the current list of parent ids
615
and setting the list to its value plus revision_id.
617
:param revision_id: The revision id to add to the parent list. It may
618
be a ghost revision as long as its not the first parent to be
619
added, or the allow_leftmost_as_ghost parameter is set True.
620
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
622
parents = self.get_parent_ids() + [revision_id]
623
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
624
or allow_leftmost_as_ghost)
626
@needs_tree_write_lock
627
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
628
"""Add revision_id, tree tuple as a parent.
630
This is equivalent to retrieving the current list of parent trees
631
and setting the list to its value plus parent_tuple. See also
632
add_parent_tree_id - if you only have a parent id available it will be
633
simpler to use that api. If you have the parent already available, using
634
this api is preferred.
636
:param parent_tuple: The (revision id, tree) to add to the parent list.
637
If the revision_id is a ghost, pass None for the tree.
638
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
641
if len(parent_ids) > 1:
642
# the leftmost may have already been a ghost, preserve that if it
644
allow_leftmost_as_ghost = True
645
self.set_parent_ids(parent_ids,
646
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
648
@needs_tree_write_lock
649
def add_pending_merge(self, *revision_ids):
650
# TODO: Perhaps should check at this point that the
651
# history of the revision is actually present?
652
parents = self.get_parent_ids()
654
for rev_id in revision_ids:
655
if rev_id in parents:
657
parents.append(rev_id)
660
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
662
def path_content_summary(self, path, _lstat=os.lstat,
663
_mapper=osutils.file_kind_from_stat_mode):
664
"""See Tree.path_content_summary."""
665
abspath = self.abspath(path)
667
stat_result = _lstat(abspath)
669
if getattr(e, 'errno', None) == errno.ENOENT:
671
return ('missing', None, None, None)
672
# propagate other errors
674
kind = _mapper(stat_result.st_mode)
676
return self._file_content_summary(path, stat_result)
677
elif kind == 'directory':
678
# perhaps it looks like a plain directory, but it's really a
680
if self._directory_is_tree_reference(path):
681
kind = 'tree-reference'
682
return kind, None, None, None
683
elif kind == 'symlink':
684
target = osutils.readlink(abspath)
685
return ('symlink', None, None, target)
687
return (kind, None, None, None)
689
def _file_content_summary(self, path, stat_result):
690
size = stat_result.st_size
691
executable = self._is_executable_from_path_and_stat(path, stat_result)
692
# try for a stat cache lookup
693
return ('file', size, executable, self._sha_from_stat(
696
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
697
"""Common ghost checking functionality from set_parent_*.
699
This checks that the left hand-parent exists if there are any
702
if len(revision_ids) > 0:
703
leftmost_id = revision_ids[0]
704
if (not allow_leftmost_as_ghost and not
705
self.branch.repository.has_revision(leftmost_id)):
706
raise errors.GhostRevisionUnusableHere(leftmost_id)
708
def _set_merges_from_parent_ids(self, parent_ids):
709
merges = parent_ids[1:]
710
self._transport.put_bytes('pending-merges', '\n'.join(merges),
711
mode=self.bzrdir._get_file_mode())
713
def _filter_parent_ids_by_ancestry(self, revision_ids):
714
"""Check that all merged revisions are proper 'heads'.
716
This will always return the first revision_id, and any merged revisions
719
if len(revision_ids) == 0:
721
graph = self.branch.repository.get_graph()
722
heads = graph.heads(revision_ids)
723
new_revision_ids = revision_ids[:1]
724
for revision_id in revision_ids[1:]:
725
if revision_id in heads and revision_id not in new_revision_ids:
726
new_revision_ids.append(revision_id)
727
if new_revision_ids != revision_ids:
728
mutter('requested to set revision_ids = %s,'
729
' but filtered to %s', revision_ids, new_revision_ids)
730
return new_revision_ids
732
@needs_tree_write_lock
733
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
734
"""Set the parent ids to revision_ids.
736
See also set_parent_trees. This api will try to retrieve the tree data
737
for each element of revision_ids from the trees repository. If you have
738
tree data already available, it is more efficient to use
739
set_parent_trees rather than set_parent_ids. set_parent_ids is however
740
an easier API to use.
742
:param revision_ids: The revision_ids to set as the parent ids of this
743
working tree. Any of these may be ghosts.
745
self._check_parents_for_ghosts(revision_ids,
746
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
747
for revision_id in revision_ids:
748
_mod_revision.check_not_reserved_id(revision_id)
750
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
752
if len(revision_ids) > 0:
753
self.set_last_revision(revision_ids[0])
755
self.set_last_revision(_mod_revision.NULL_REVISION)
757
self._set_merges_from_parent_ids(revision_ids)
759
@needs_tree_write_lock
760
def set_pending_merges(self, rev_list):
761
parents = self.get_parent_ids()
762
leftmost = parents[:1]
763
new_parents = leftmost + rev_list
764
self.set_parent_ids(new_parents)
766
@needs_tree_write_lock
767
def set_merge_modified(self, modified_hashes):
769
for file_id, hash in modified_hashes.iteritems():
770
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
772
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
774
def _sha_from_stat(self, path, stat_result):
775
"""Get a sha digest from the tree's stat cache.
777
The default implementation assumes no stat cache is present.
779
:param path: The path.
780
:param stat_result: The stat result being looked up.
784
def _put_rio(self, filename, stanzas, header):
785
self._must_be_locked()
786
my_file = _mod_rio.rio_file(stanzas, header)
787
self._transport.put_file(filename, my_file,
788
mode=self.bzrdir._get_file_mode())
790
@needs_write_lock # because merge pulls data into the branch.
791
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
792
merge_type=None, force=False):
793
"""Merge from a branch into this working tree.
795
:param branch: The branch to merge from.
796
:param to_revision: If non-None, the merge will merge to to_revision,
797
but not beyond it. to_revision does not need to be in the history
798
of the branch when it is supplied. If None, to_revision defaults to
799
branch.last_revision().
801
from bzrlib.merge import Merger, Merge3Merger
802
merger = Merger(self.branch, this_tree=self)
803
# check that there are no local alterations
804
if not force and self.has_changes():
805
raise errors.UncommittedChanges(self)
806
if to_revision is None:
807
to_revision = _mod_revision.ensure_null(branch.last_revision())
808
merger.other_rev_id = to_revision
809
if _mod_revision.is_null(merger.other_rev_id):
810
raise errors.NoCommits(branch)
811
self.branch.fetch(branch, last_revision=merger.other_rev_id)
812
merger.other_basis = merger.other_rev_id
813
merger.other_tree = self.branch.repository.revision_tree(
815
merger.other_branch = branch
816
if from_revision is None:
819
merger.set_base_revision(from_revision, branch)
820
if merger.base_rev_id == merger.other_rev_id:
821
raise errors.PointlessMerge
822
merger.backup_files = False
823
if merge_type is None:
824
merger.merge_type = Merge3Merger
826
merger.merge_type = merge_type
827
merger.set_interesting_files(None)
828
merger.show_base = False
829
merger.reprocess = False
830
conflicts = merger.do_merge()
834
def merge_modified(self):
835
"""Return a dictionary of files modified by a merge.
837
The list is initialized by WorkingTree.set_merge_modified, which is
838
typically called after we make some automatic updates to the tree
841
This returns a map of file_id->sha1, containing only files which are
842
still in the working inventory and have that text hash.
844
raise NotImplementedError(self.merge_modified)
847
def mkdir(self, path, file_id=None):
848
"""See MutableTree.mkdir()."""
850
file_id = generate_ids.gen_file_id(os.path.basename(path))
851
os.mkdir(self.abspath(path))
852
self.add(path, file_id, 'directory')
855
def get_symlink_target(self, file_id, path=None):
857
abspath = self.abspath(path)
859
abspath = self.id2abspath(file_id)
860
target = osutils.readlink(abspath)
863
def subsume(self, other_tree):
864
raise NotImplementedError(self.subsume)
866
def _setup_directory_is_tree_reference(self):
867
if self._branch.repository._format.supports_tree_reference:
868
self._directory_is_tree_reference = \
869
self._directory_may_be_tree_reference
871
self._directory_is_tree_reference = \
872
self._directory_is_never_tree_reference
874
def _directory_is_never_tree_reference(self, relpath):
877
def _directory_may_be_tree_reference(self, relpath):
878
# as a special case, if a directory contains control files then
879
# it's a tree reference, except that the root of the tree is not
880
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
881
# TODO: We could ask all the control formats whether they
882
# recognize this directory, but at the moment there's no cheap api
883
# to do that. Since we probably can only nest bzr checkouts and
884
# they always use this name it's ok for now. -- mbp 20060306
886
# FIXME: There is an unhandled case here of a subdirectory
887
# containing .bzr but not a branch; that will probably blow up
888
# when you try to commit it. It might happen if there is a
889
# checkout in a subdirectory. This can be avoided by not adding
892
def extract(self, file_id, format=None):
893
"""Extract a subtree from this tree.
895
A new branch will be created, relative to the path for this tree.
897
raise NotImplementedError(self.extract)
900
"""Write the in memory meta data to disk."""
901
raise NotImplementedError(self.flush)
903
def _kind(self, relpath):
904
return osutils.file_kind(self.abspath(relpath))
906
def list_files(self, include_root=False, from_dir=None, recursive=True):
907
"""List all files as (path, class, kind, id, entry).
909
Lists, but does not descend into unversioned directories.
910
This does not include files that have been deleted in this
911
tree. Skips the control directory.
913
:param include_root: if True, return an entry for the root
914
:param from_dir: start from this directory or None for the root
915
:param recursive: whether to recurse into subdirectories or not
917
raise NotImplementedError(self.list_files)
919
def move(self, from_paths, to_dir=None, after=False):
922
to_dir must be known to the working tree.
924
If to_dir exists and is a directory, the files are moved into
925
it, keeping their old names.
927
Note that to_dir is only the last component of the new name;
928
this doesn't change the directory.
930
For each entry in from_paths the move mode will be determined
933
The first mode moves the file in the filesystem and updates the
934
working tree metadata. The second mode only updates the working tree
935
metadata without touching the file on the filesystem.
937
move uses the second mode if 'after == True' and the target is not
938
versioned but present in the working tree.
940
move uses the second mode if 'after == False' and the source is
941
versioned but no longer in the working tree, and the target is not
942
versioned but present in the working tree.
944
move uses the first mode if 'after == False' and the source is
945
versioned and present in the working tree, and the target is not
946
versioned and not present in the working tree.
948
Everything else results in an error.
950
This returns a list of (from_path, to_path) pairs for each
953
raise NotImplementedError(self.move)
955
@needs_tree_write_lock
956
def rename_one(self, from_rel, to_rel, after=False):
959
This can change the directory or the filename or both.
961
rename_one has several 'modes' to work. First, it can rename a physical
962
file and change the file_id. That is the normal mode. Second, it can
963
only change the file_id without touching any physical file.
965
rename_one uses the second mode if 'after == True' and 'to_rel' is
966
either not versioned or newly added, and present in the working tree.
968
rename_one uses the second mode if 'after == False' and 'from_rel' is
969
versioned but no longer in the working tree, and 'to_rel' is not
970
versioned but present in the working tree.
972
rename_one uses the first mode if 'after == False' and 'from_rel' is
973
versioned and present in the working tree, and 'to_rel' is not
974
versioned and not present in the working tree.
976
Everything else results in an error.
978
raise NotImplementedError(self.rename_one)
982
"""Return all unknown files.
984
These are files in the working directory that are not versioned or
985
control files or ignored.
987
# force the extras method to be fully executed before returning, to
988
# prevent race conditions with the lock
990
[subp for subp in self.extras() if not self.is_ignored(subp)])
992
def unversion(self, file_ids):
993
"""Remove the file ids in file_ids from the current versioned set.
995
When a file_id is unversioned, all of its children are automatically
998
:param file_ids: The file ids to stop versioning.
999
:raises: NoSuchId if any fileid is not currently versioned.
1001
raise NotImplementedError(self.unversion)
1004
def pull(self, source, overwrite=False, stop_revision=None,
1005
change_reporter=None, possible_transports=None, local=False,
1009
old_revision_info = self.branch.last_revision_info()
1010
basis_tree = self.basis_tree()
1011
count = self.branch.pull(source, overwrite, stop_revision,
1012
possible_transports=possible_transports,
1014
new_revision_info = self.branch.last_revision_info()
1015
if new_revision_info != old_revision_info:
1016
repository = self.branch.repository
1017
if repository._format.fast_deltas:
1018
parent_ids = self.get_parent_ids()
1020
basis_id = parent_ids[0]
1021
basis_tree = repository.revision_tree(basis_id)
1022
basis_tree.lock_read()
1024
new_basis_tree = self.branch.basis_tree()
1031
change_reporter=change_reporter,
1032
show_base=show_base)
1033
basis_root_id = basis_tree.get_root_id()
1034
new_root_id = new_basis_tree.get_root_id()
1035
if basis_root_id != new_root_id:
1036
self.set_root_id(new_root_id)
1039
# TODO - dedup parents list with things merged by pull ?
1040
# reuse the revisiontree we merged against to set the new
1042
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1043
# we have to pull the merge trees out again, because
1044
# merge_inner has set the ids. - this corner is not yet
1045
# layered well enough to prevent double handling.
1046
# XXX TODO: Fix the double handling: telling the tree about
1047
# the already known parent data is wasteful.
1048
merges = self.get_parent_ids()[1:]
1049
parent_trees.extend([
1050
(parent, repository.revision_tree(parent)) for
1052
self.set_parent_trees(parent_trees)
1058
def put_file_bytes_non_atomic(self, file_id, bytes):
1059
"""See MutableTree.put_file_bytes_non_atomic."""
1060
stream = file(self.id2abspath(file_id), 'wb')
1065
# TODO: update the hashcache here ?
1068
"""Yield all unversioned files in this WorkingTree.
1070
If there are any unversioned directories then only the directory is
1071
returned, not all its children. But if there are unversioned files
1072
under a versioned subdirectory, they are returned.
1074
Currently returned depth-first, sorted by name within directories.
1075
This is the same order used by 'osutils.walkdirs'.
1077
raise NotImplementedError(self.extras)
1079
def ignored_files(self):
1080
"""Yield list of PATH, IGNORE_PATTERN"""
1081
for subp in self.extras():
1082
pat = self.is_ignored(subp)
1086
def get_ignore_list(self):
1087
"""Return list of ignore patterns.
1089
Cached in the Tree object after the first call.
1091
ignoreset = getattr(self, '_ignoreset', None)
1092
if ignoreset is not None:
1095
ignore_globs = set()
1096
ignore_globs.update(ignores.get_runtime_ignores())
1097
ignore_globs.update(ignores.get_user_ignores())
1098
if self.has_filename(bzrlib.IGNORE_FILENAME):
1099
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1101
ignore_globs.update(ignores.parse_ignore_file(f))
1104
self._ignoreset = ignore_globs
1107
def _flush_ignore_list_cache(self):
1108
"""Resets the cached ignore list to force a cache rebuild."""
1109
self._ignoreset = None
1110
self._ignoreglobster = None
1112
def is_ignored(self, filename):
1113
r"""Check whether the filename matches an ignore pattern.
1115
Patterns containing '/' or '\' need to match the whole path;
1116
others match against only the last component. Patterns starting
1117
with '!' are ignore exceptions. Exceptions take precedence
1118
over regular patterns and cause the filename to not be ignored.
1120
If the file is ignored, returns the pattern which caused it to
1121
be ignored, otherwise None. So this can simply be used as a
1122
boolean if desired."""
1123
if getattr(self, '_ignoreglobster', None) is None:
1124
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1125
return self._ignoreglobster.match(filename)
1127
def kind(self, file_id):
1128
return file_kind(self.id2abspath(file_id))
1130
def stored_kind(self, file_id):
1131
"""See Tree.stored_kind"""
1132
raise NotImplementedError(self.stored_kind)
1134
def _comparison_data(self, entry, path):
1135
abspath = self.abspath(path)
1137
stat_value = os.lstat(abspath)
1139
if getattr(e, 'errno', None) == errno.ENOENT:
1146
mode = stat_value.st_mode
1147
kind = osutils.file_kind_from_stat_mode(mode)
1148
if not supports_executable():
1149
executable = entry is not None and entry.executable
1151
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1152
return kind, executable, stat_value
1154
def _file_size(self, entry, stat_value):
1155
return stat_value.st_size
1157
def last_revision(self):
1158
"""Return the last revision of the branch for this tree.
1160
This format tree does not support a separate marker for last-revision
1161
compared to the branch.
1163
See MutableTree.last_revision
1165
return self._last_revision()
1168
def _last_revision(self):
1169
"""helper for get_parent_ids."""
1170
return _mod_revision.ensure_null(self.branch.last_revision())
1172
def is_locked(self):
1173
return self._control_files.is_locked()
1175
def _must_be_locked(self):
1176
if not self.is_locked():
1177
raise errors.ObjectNotLocked(self)
1179
def lock_read(self):
1180
"""Lock the tree for reading.
1182
This also locks the branch, and can be unlocked via self.unlock().
1184
:return: A bzrlib.lock.LogicalLockResult.
1186
if not self.is_locked():
1188
self.branch.lock_read()
1190
self._control_files.lock_read()
1191
return LogicalLockResult(self.unlock)
1193
self.branch.unlock()
1196
def lock_tree_write(self):
1197
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1199
:return: A bzrlib.lock.LogicalLockResult.
1201
if not self.is_locked():
1203
self.branch.lock_read()
1205
self._control_files.lock_write()
1206
return LogicalLockResult(self.unlock)
1208
self.branch.unlock()
1211
def lock_write(self):
1212
"""See MutableTree.lock_write, and WorkingTree.unlock.
1214
:return: A bzrlib.lock.LogicalLockResult.
1216
if not self.is_locked():
1218
self.branch.lock_write()
1220
self._control_files.lock_write()
1221
return LogicalLockResult(self.unlock)
1223
self.branch.unlock()
1226
def get_physical_lock_status(self):
1227
return self._control_files.get_physical_lock_status()
1229
def _reset_data(self):
1230
"""Reset transient data that cannot be revalidated."""
1231
raise NotImplementedError(self._reset_data)
1233
def set_last_revision(self, new_revision):
1234
"""Change the last revision in the working tree."""
1235
raise NotImplementedError(self.set_last_revision)
1237
def _change_last_revision(self, new_revision):
1238
"""Template method part of set_last_revision to perform the change.
1240
This is used to allow WorkingTree3 instances to not affect branch
1241
when their last revision is set.
1243
if _mod_revision.is_null(new_revision):
1244
self.branch.set_last_revision_info(0, new_revision)
1246
_mod_revision.check_not_reserved_id(new_revision)
1248
self.branch.generate_revision_history(new_revision)
1249
except errors.NoSuchRevision:
1250
# not present in the repo - dont try to set it deeper than the tip
1251
self.branch._set_revision_history([new_revision])
1254
@needs_tree_write_lock
1255
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1257
"""Remove nominated files from the working tree metadata.
1259
:files: File paths relative to the basedir.
1260
:keep_files: If true, the files will also be kept.
1261
:force: Delete files and directories, even if they are changed and
1262
even if the directories are not empty.
1264
if isinstance(files, basestring):
1269
all_files = set() # specified and nested files
1270
unknown_nested_files=set()
1272
to_file = sys.stdout
1274
files_to_backup = []
1276
def recurse_directory_to_add_files(directory):
1277
# Recurse directory and add all files
1278
# so we can check if they have changed.
1279
for parent_info, file_infos in self.walkdirs(directory):
1280
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1281
# Is it versioned or ignored?
1282
if self.path2id(relpath):
1283
# Add nested content for deletion.
1284
all_files.add(relpath)
1286
# Files which are not versioned
1287
# should be treated as unknown.
1288
files_to_backup.append(relpath)
1290
for filename in files:
1291
# Get file name into canonical form.
1292
abspath = self.abspath(filename)
1293
filename = self.relpath(abspath)
1294
if len(filename) > 0:
1295
all_files.add(filename)
1296
recurse_directory_to_add_files(filename)
1298
files = list(all_files)
1301
return # nothing to do
1303
# Sort needed to first handle directory content before the directory
1304
files.sort(reverse=True)
1306
# Bail out if we are going to delete files we shouldn't
1307
if not keep_files and not force:
1308
for (file_id, path, content_change, versioned, parent_id, name,
1309
kind, executable) in self.iter_changes(self.basis_tree(),
1310
include_unchanged=True, require_versioned=False,
1311
want_unversioned=True, specific_files=files):
1312
if versioned[0] == False:
1313
# The record is unknown or newly added
1314
files_to_backup.append(path[1])
1315
elif (content_change and (kind[1] is not None) and
1316
osutils.is_inside_any(files, path[1])):
1317
# Versioned and changed, but not deleted, and still
1318
# in one of the dirs to be deleted.
1319
files_to_backup.append(path[1])
1321
def backup(file_to_backup):
1322
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1323
osutils.rename(abs_path, self.abspath(backup_name))
1324
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1327
# Build inv_delta and delete files where applicable,
1328
# do this before any modifications to meta data.
1330
fid = self.path2id(f)
1333
message = "%s is not versioned." % (f,)
1336
# having removed it, it must be either ignored or unknown
1337
if self.is_ignored(f):
1341
# XXX: Really should be a more abstract reporter interface
1342
kind_ch = osutils.kind_marker(self.kind(fid))
1343
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1345
inv_delta.append((f, None, fid, None))
1346
message = "removed %s" % (f,)
1349
abs_path = self.abspath(f)
1350
if osutils.lexists(abs_path):
1351
if (osutils.isdir(abs_path) and
1352
len(os.listdir(abs_path)) > 0):
1354
osutils.rmtree(abs_path)
1355
message = "deleted %s" % (f,)
1359
if f in files_to_backup:
1362
osutils.delete_any(abs_path)
1363
message = "deleted %s" % (f,)
1364
elif message is not None:
1365
# Only care if we haven't done anything yet.
1366
message = "%s does not exist." % (f,)
1368
# Print only one message (if any) per file.
1369
if message is not None:
1371
self.apply_inventory_delta(inv_delta)
1373
@needs_tree_write_lock
1374
def revert(self, filenames=None, old_tree=None, backups=True,
1375
pb=None, report_changes=False):
1376
from bzrlib.conflicts import resolve
1377
if old_tree is None:
1378
basis_tree = self.basis_tree()
1379
basis_tree.lock_read()
1380
old_tree = basis_tree
1384
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1386
if filenames is None and len(self.get_parent_ids()) > 1:
1388
last_revision = self.last_revision()
1389
if last_revision != _mod_revision.NULL_REVISION:
1390
if basis_tree is None:
1391
basis_tree = self.basis_tree()
1392
basis_tree.lock_read()
1393
parent_trees.append((last_revision, basis_tree))
1394
self.set_parent_trees(parent_trees)
1397
resolve(self, filenames, ignore_misses=True, recursive=True)
1399
if basis_tree is not None:
1403
def revision_tree(self, revision_id):
1404
"""See Tree.revision_tree.
1406
WorkingTree can supply revision_trees for the basis revision only
1407
because there is only one cached inventory in the bzr directory.
1409
raise NotImplementedError(self.revision_tree)
1411
@needs_tree_write_lock
1412
def set_root_id(self, file_id):
1413
"""Set the root id for this tree."""
1417
'WorkingTree.set_root_id with fileid=None')
1418
file_id = osutils.safe_file_id(file_id)
1419
self._set_root_id(file_id)
1421
def _set_root_id(self, file_id):
1422
"""Set the root id for this tree, in a format specific manner.
1424
:param file_id: The file id to assign to the root. It must not be
1425
present in the current inventory or an error will occur. It must
1426
not be None, but rather a valid file id.
1428
raise NotImplementedError(self._set_root_id)
1431
"""See Branch.unlock.
1433
WorkingTree locking just uses the Branch locking facilities.
1434
This is current because all working trees have an embedded branch
1435
within them. IF in the future, we were to make branch data shareable
1436
between multiple working trees, i.e. via shared storage, then we
1437
would probably want to lock both the local tree, and the branch.
1439
raise NotImplementedError(self.unlock)
1443
def update(self, change_reporter=None, possible_transports=None,
1444
revision=None, old_tip=_marker, show_base=False):
1445
"""Update a working tree along its branch.
1447
This will update the branch if its bound too, which means we have
1448
multiple trees involved:
1450
- The new basis tree of the master.
1451
- The old basis tree of the branch.
1452
- The old basis tree of the working tree.
1453
- The current working tree state.
1455
Pathologically, all three may be different, and non-ancestors of each
1456
other. Conceptually we want to:
1458
- Preserve the wt.basis->wt.state changes
1459
- Transform the wt.basis to the new master basis.
1460
- Apply a merge of the old branch basis to get any 'local' changes from
1462
- Restore the wt.basis->wt.state changes.
1464
There isn't a single operation at the moment to do that, so we:
1466
- Merge current state -> basis tree of the master w.r.t. the old tree
1468
- Do a 'normal' merge of the old branch basis if it is relevant.
1470
:param revision: The target revision to update to. Must be in the
1472
:param old_tip: If branch.update() has already been run, the value it
1473
returned (old tip of the branch or None). _marker is used
1476
if self.branch.get_bound_location() is not None:
1478
update_branch = (old_tip is self._marker)
1480
self.lock_tree_write()
1481
update_branch = False
1484
old_tip = self.branch.update(possible_transports)
1486
if old_tip is self._marker:
1488
return self._update_tree(old_tip, change_reporter, revision, show_base)
1492
@needs_tree_write_lock
1493
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1495
"""Update a tree to the master branch.
1497
:param old_tip: if supplied, the previous tip revision the branch,
1498
before it was changed to the master branch's tip.
1500
# here if old_tip is not None, it is the old tip of the branch before
1501
# it was updated from the master branch. This should become a pending
1502
# merge in the working tree to preserve the user existing work. we
1503
# cant set that until we update the working trees last revision to be
1504
# one from the new branch, because it will just get absorbed by the
1505
# parent de-duplication logic.
1507
# We MUST save it even if an error occurs, because otherwise the users
1508
# local work is unreferenced and will appear to have been lost.
1512
last_rev = self.get_parent_ids()[0]
1514
last_rev = _mod_revision.NULL_REVISION
1515
if revision is None:
1516
revision = self.branch.last_revision()
1518
old_tip = old_tip or _mod_revision.NULL_REVISION
1520
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1521
# the branch we are bound to was updated
1522
# merge those changes in first
1523
base_tree = self.basis_tree()
1524
other_tree = self.branch.repository.revision_tree(old_tip)
1525
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1526
base_tree, this_tree=self,
1527
change_reporter=change_reporter,
1528
show_base=show_base)
1530
self.add_parent_tree((old_tip, other_tree))
1531
note('Rerun update after fixing the conflicts.')
1534
if last_rev != _mod_revision.ensure_null(revision):
1535
# the working tree is up to date with the branch
1536
# we can merge the specified revision from master
1537
to_tree = self.branch.repository.revision_tree(revision)
1538
to_root_id = to_tree.get_root_id()
1540
basis = self.basis_tree()
1543
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1544
self.set_root_id(to_root_id)
1549
# determine the branch point
1550
graph = self.branch.repository.get_graph()
1551
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1553
base_tree = self.branch.repository.revision_tree(base_rev_id)
1555
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1557
change_reporter=change_reporter,
1558
show_base=show_base)
1559
self.set_last_revision(revision)
1560
# TODO - dedup parents list with things merged by pull ?
1561
# reuse the tree we've updated to to set the basis:
1562
parent_trees = [(revision, to_tree)]
1563
merges = self.get_parent_ids()[1:]
1564
# Ideally we ask the tree for the trees here, that way the working
1565
# tree can decide whether to give us the entire tree or give us a
1566
# lazy initialised tree. dirstate for instance will have the trees
1567
# in ram already, whereas a last-revision + basis-inventory tree
1568
# will not, but also does not need them when setting parents.
1569
for parent in merges:
1570
parent_trees.append(
1571
(parent, self.branch.repository.revision_tree(parent)))
1572
if not _mod_revision.is_null(old_tip):
1573
parent_trees.append(
1574
(old_tip, self.branch.repository.revision_tree(old_tip)))
1575
self.set_parent_trees(parent_trees)
1576
last_rev = parent_trees[0][0]
1579
def _write_hashcache_if_dirty(self):
1580
"""Write out the hashcache if it is dirty."""
1581
if self._hashcache.needs_write:
1583
self._hashcache.write()
1585
if e.errno not in (errno.EPERM, errno.EACCES):
1587
# TODO: jam 20061219 Should this be a warning? A single line
1588
# warning might be sufficient to let the user know what
1590
mutter('Could not write hashcache for %s\nError: %s',
1591
self._hashcache.cache_file_name(), e)
1593
def set_conflicts(self, arg):
1594
raise errors.UnsupportedOperation(self.set_conflicts, self)
1596
def add_conflicts(self, arg):
1597
raise errors.UnsupportedOperation(self.add_conflicts, self)
1599
def conflicts(self):
1600
raise NotImplementedError(self.conflicts)
1602
def walkdirs(self, prefix=""):
1603
"""Walk the directories of this tree.
1605
returns a generator which yields items in the form:
1606
((curren_directory_path, fileid),
1607
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1610
This API returns a generator, which is only valid during the current
1611
tree transaction - within a single lock_read or lock_write duration.
1613
If the tree is not locked, it may cause an error to be raised,
1614
depending on the tree implementation.
1616
disk_top = self.abspath(prefix)
1617
if disk_top.endswith('/'):
1618
disk_top = disk_top[:-1]
1619
top_strip_len = len(disk_top) + 1
1620
inventory_iterator = self._walkdirs(prefix)
1621
disk_iterator = osutils.walkdirs(disk_top, prefix)
1623
current_disk = disk_iterator.next()
1624
disk_finished = False
1626
if not (e.errno == errno.ENOENT or
1627
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1630
disk_finished = True
1632
current_inv = inventory_iterator.next()
1633
inv_finished = False
1634
except StopIteration:
1637
while not inv_finished or not disk_finished:
1639
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1640
cur_disk_dir_content) = current_disk
1642
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1643
cur_disk_dir_content) = ((None, None), None)
1644
if not disk_finished:
1645
# strip out .bzr dirs
1646
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1647
len(cur_disk_dir_content) > 0):
1648
# osutils.walkdirs can be made nicer -
1649
# yield the path-from-prefix rather than the pathjoined
1651
bzrdir_loc = bisect_left(cur_disk_dir_content,
1653
if (bzrdir_loc < len(cur_disk_dir_content)
1654
and self.bzrdir.is_control_filename(
1655
cur_disk_dir_content[bzrdir_loc][0])):
1656
# we dont yield the contents of, or, .bzr itself.
1657
del cur_disk_dir_content[bzrdir_loc]
1659
# everything is unknown
1662
# everything is missing
1665
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1667
# disk is before inventory - unknown
1668
dirblock = [(relpath, basename, kind, stat, None, None) for
1669
relpath, basename, kind, stat, top_path in
1670
cur_disk_dir_content]
1671
yield (cur_disk_dir_relpath, None), dirblock
1673
current_disk = disk_iterator.next()
1674
except StopIteration:
1675
disk_finished = True
1677
# inventory is before disk - missing.
1678
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1679
for relpath, basename, dkind, stat, fileid, kind in
1681
yield (current_inv[0][0], current_inv[0][1]), dirblock
1683
current_inv = inventory_iterator.next()
1684
except StopIteration:
1687
# versioned present directory
1688
# merge the inventory and disk data together
1690
for relpath, subiterator in itertools.groupby(sorted(
1691
current_inv[1] + cur_disk_dir_content,
1692
key=operator.itemgetter(0)), operator.itemgetter(1)):
1693
path_elements = list(subiterator)
1694
if len(path_elements) == 2:
1695
inv_row, disk_row = path_elements
1696
# versioned, present file
1697
dirblock.append((inv_row[0],
1698
inv_row[1], disk_row[2],
1699
disk_row[3], inv_row[4],
1701
elif len(path_elements[0]) == 5:
1703
dirblock.append((path_elements[0][0],
1704
path_elements[0][1], path_elements[0][2],
1705
path_elements[0][3], None, None))
1706
elif len(path_elements[0]) == 6:
1707
# versioned, absent file.
1708
dirblock.append((path_elements[0][0],
1709
path_elements[0][1], 'unknown', None,
1710
path_elements[0][4], path_elements[0][5]))
1712
raise NotImplementedError('unreachable code')
1713
yield current_inv[0], dirblock
1715
current_inv = inventory_iterator.next()
1716
except StopIteration:
1719
current_disk = disk_iterator.next()
1720
except StopIteration:
1721
disk_finished = True
1723
def _walkdirs(self, prefix=""):
1724
"""Walk the directories of this tree.
1726
:param prefix: is used as the directrory to start with.
1727
:returns: a generator which yields items in the form::
1729
((curren_directory_path, fileid),
1730
[(file1_path, file1_name, file1_kind, None, file1_id,
1733
raise NotImplementedError(self._walkdirs)
1735
@needs_tree_write_lock
1736
def auto_resolve(self):
1737
"""Automatically resolve text conflicts according to contents.
1739
Only text conflicts are auto_resolvable. Files with no conflict markers
1740
are considered 'resolved', because bzr always puts conflict markers
1741
into files that have text conflicts. The corresponding .THIS .BASE and
1742
.OTHER files are deleted, as per 'resolve'.
1744
:return: a tuple of ConflictLists: (un_resolved, resolved).
1746
un_resolved = _mod_conflicts.ConflictList()
1747
resolved = _mod_conflicts.ConflictList()
1748
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1749
for conflict in self.conflicts():
1750
if (conflict.typestring != 'text conflict' or
1751
self.kind(conflict.file_id) != 'file'):
1752
un_resolved.append(conflict)
1754
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1756
for line in my_file:
1757
if conflict_re.search(line):
1758
un_resolved.append(conflict)
1761
resolved.append(conflict)
1764
resolved.remove_files(self)
1765
self.set_conflicts(un_resolved)
1766
return un_resolved, resolved
1768
def _validate(self):
1769
"""Validate internal structures.
1771
This is meant mostly for the test suite. To give it a chance to detect
1772
corruption after actions have occurred. The default implementation is a
1775
:return: None. An exception should be raised if there is an error.
1779
def check_state(self):
1780
"""Check that the working state is/isn't valid."""
1781
raise NotImplementedError(self.check_state)
1783
def reset_state(self, revision_ids=None):
1784
"""Reset the state of the working tree.
1786
This does a hard-reset to a last-known-good state. This is a way to
1787
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1789
raise NotImplementedError(self.reset_state)
1791
def _get_rules_searcher(self, default_searcher):
1792
"""See Tree._get_rules_searcher."""
1793
if self._rules_searcher is None:
1794
self._rules_searcher = super(WorkingTree,
1795
self)._get_rules_searcher(default_searcher)
1796
return self._rules_searcher
1798
def get_shelf_manager(self):
1799
"""Return the ShelfManager for this WorkingTree."""
1800
from bzrlib.shelf import ShelfManager
1801
return ShelfManager(self, self._transport)
1804
class InventoryWorkingTree(WorkingTree,
1805
bzrlib.mutabletree.MutableInventoryTree):
1806
"""Base class for working trees that are inventory-oriented.
1808
The inventory is held in the `Branch` working-inventory, and the
1809
files are in a directory on disk.
1811
It is possible for a `WorkingTree` to have a filename which is
1812
not listed in the Inventory and vice versa.
1815
def __init__(self, basedir='.',
1816
branch=DEPRECATED_PARAMETER,
1818
_control_files=None,
1822
"""Construct a InventoryWorkingTree instance. This is not a public API.
1824
:param branch: A branch to override probing for the branch.
1826
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1827
branch=branch, _control_files=_control_files, _internal=_internal,
1828
_format=_format, _bzrdir=_bzrdir)
1830
if _inventory is None:
1831
# This will be acquired on lock_read() or lock_write()
1832
self._inventory_is_modified = False
1833
self._inventory = None
1835
# the caller of __init__ has provided an inventory,
1836
# we assume they know what they are doing - as its only
1837
# the Format factory and creation methods that are
1838
# permitted to do this.
1839
self._set_inventory(_inventory, dirty=False)
1841
def _set_inventory(self, inv, dirty):
1842
"""Set the internal cached inventory.
1844
:param inv: The inventory to set.
1845
:param dirty: A boolean indicating whether the inventory is the same
1846
logical inventory as whats on disk. If True the inventory is not
1847
the same and should be written to disk or data will be lost, if
1848
False then the inventory is the same as that on disk and any
1849
serialisation would be unneeded overhead.
1851
self._inventory = inv
1852
self._inventory_is_modified = dirty
1854
def _serialize(self, inventory, out_file):
1855
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1858
def _deserialize(selt, in_file):
1859
return xml5.serializer_v5.read_inventory(in_file)
1861
@needs_tree_write_lock
1862
def _write_inventory(self, inv):
1863
"""Write inventory as the current inventory."""
1864
self._set_inventory(inv, dirty=True)
1867
# XXX: This method should be deprecated in favour of taking in a proper
1868
# new Inventory object.
1869
@needs_tree_write_lock
1870
def set_inventory(self, new_inventory_list):
1871
from bzrlib.inventory import (Inventory,
1875
inv = Inventory(self.get_root_id())
1876
for path, file_id, parent, kind in new_inventory_list:
1877
name = os.path.basename(path)
1880
# fixme, there should be a factory function inv,add_??
1881
if kind == 'directory':
1882
inv.add(InventoryDirectory(file_id, name, parent))
1883
elif kind == 'file':
1884
inv.add(InventoryFile(file_id, name, parent))
1885
elif kind == 'symlink':
1886
inv.add(InventoryLink(file_id, name, parent))
1888
raise errors.BzrError("unknown kind %r" % kind)
1889
self._write_inventory(inv)
1891
def _write_basis_inventory(self, xml):
1892
"""Write the basis inventory XML to the basis-inventory file"""
1893
path = self._basis_inventory_name()
1895
self._transport.put_file(path, sio,
1896
mode=self.bzrdir._get_file_mode())
1898
def _reset_data(self):
1899
"""Reset transient data that cannot be revalidated."""
1900
self._inventory_is_modified = False
1901
f = self._transport.get('inventory')
1903
result = self._deserialize(f)
1906
self._set_inventory(result, dirty=False)
1908
def _set_root_id(self, file_id):
1909
"""Set the root id for this tree, in a format specific manner.
1911
:param file_id: The file id to assign to the root. It must not be
1912
present in the current inventory or an error will occur. It must
1913
not be None, but rather a valid file id.
1915
inv = self._inventory
1916
orig_root_id = inv.root.file_id
1917
# TODO: it might be nice to exit early if there was nothing
1918
# to do, saving us from trigger a sync on unlock.
1919
self._inventory_is_modified = True
1920
# we preserve the root inventory entry object, but
1921
# unlinkit from the byid index
1922
del inv._byid[inv.root.file_id]
1923
inv.root.file_id = file_id
1924
# and link it into the index with the new changed id.
1925
inv._byid[inv.root.file_id] = inv.root
1926
# and finally update all children to reference the new id.
1927
# XXX: this should be safe to just look at the root.children
1928
# list, not the WHOLE INVENTORY.
1931
if entry.parent_id == orig_root_id:
1932
entry.parent_id = inv.root.file_id
1934
def all_file_ids(self):
1935
"""See Tree.iter_all_file_ids"""
1936
return set(self.inventory)
1938
@needs_tree_write_lock
1939
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1940
"""See MutableTree.set_parent_trees."""
1941
parent_ids = [rev for (rev, tree) in parents_list]
1942
for revision_id in parent_ids:
1943
_mod_revision.check_not_reserved_id(revision_id)
1945
self._check_parents_for_ghosts(parent_ids,
1946
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1948
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1950
if len(parent_ids) == 0:
1951
leftmost_parent_id = _mod_revision.NULL_REVISION
1952
leftmost_parent_tree = None
1954
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1956
if self._change_last_revision(leftmost_parent_id):
1957
if leftmost_parent_tree is None:
1958
# If we don't have a tree, fall back to reading the
1959
# parent tree from the repository.
1960
self._cache_basis_inventory(leftmost_parent_id)
1962
inv = leftmost_parent_tree.inventory
1963
xml = self._create_basis_xml_from_inventory(
1964
leftmost_parent_id, inv)
1965
self._write_basis_inventory(xml)
1966
self._set_merges_from_parent_ids(parent_ids)
1968
def _cache_basis_inventory(self, new_revision):
1969
"""Cache new_revision as the basis inventory."""
1970
# TODO: this should allow the ready-to-use inventory to be passed in,
1971
# as commit already has that ready-to-use [while the format is the
1974
# this double handles the inventory - unpack and repack -
1975
# but is easier to understand. We can/should put a conditional
1976
# in here based on whether the inventory is in the latest format
1977
# - perhaps we should repack all inventories on a repository
1979
# the fast path is to copy the raw xml from the repository. If the
1980
# xml contains 'revision_id="', then we assume the right
1981
# revision_id is set. We must check for this full string, because a
1982
# root node id can legitimately look like 'revision_id' but cannot
1984
xml = self.branch.repository._get_inventory_xml(new_revision)
1985
firstline = xml.split('\n', 1)[0]
1986
if (not 'revision_id="' in firstline or
1987
'format="7"' not in firstline):
1988
inv = self.branch.repository._serializer.read_inventory_from_string(
1990
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1991
self._write_basis_inventory(xml)
1992
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1995
def _basis_inventory_name(self):
1996
return 'basis-inventory-cache'
1998
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1999
"""Create the text that will be saved in basis-inventory"""
2000
inventory.revision_id = revision_id
2001
return xml7.serializer_v7.write_inventory_to_string(inventory)
2003
@needs_tree_write_lock
2004
def set_conflicts(self, conflicts):
2005
self._put_rio('conflicts', conflicts.to_stanzas(),
2008
@needs_tree_write_lock
2009
def add_conflicts(self, new_conflicts):
2010
conflict_set = set(self.conflicts())
2011
conflict_set.update(set(list(new_conflicts)))
2012
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2013
key=_mod_conflicts.Conflict.sort_key)))
2016
def conflicts(self):
2018
confile = self._transport.get('conflicts')
2019
except errors.NoSuchFile:
2020
return _mod_conflicts.ConflictList()
2023
if confile.next() != CONFLICT_HEADER_1 + '\n':
2024
raise errors.ConflictFormatError()
2025
except StopIteration:
2026
raise errors.ConflictFormatError()
2027
reader = _mod_rio.RioReader(confile)
2028
return _mod_conflicts.ConflictList.from_stanzas(reader)
2032
def read_basis_inventory(self):
2033
"""Read the cached basis inventory."""
2034
path = self._basis_inventory_name()
2035
return self._transport.get_bytes(path)
2038
def read_working_inventory(self):
2039
"""Read the working inventory.
2041
:raises errors.InventoryModified: read_working_inventory will fail
2042
when the current in memory inventory has been modified.
2044
# conceptually this should be an implementation detail of the tree.
2045
# XXX: Deprecate this.
2046
# ElementTree does its own conversion from UTF-8, so open in
2048
if self._inventory_is_modified:
2049
raise errors.InventoryModified(self)
2050
f = self._transport.get('inventory')
2052
result = self._deserialize(f)
2055
self._set_inventory(result, dirty=False)
2059
def get_root_id(self):
2060
"""Return the id of this trees root"""
2061
return self._inventory.root.file_id
2063
174
def has_id(self, file_id):
2064
175
# files that have been deleted are excluded
2065
inv = self.inventory
176
inv = self._inventory
2066
177
if not inv.has_id(file_id):
2068
179
path = inv.id2path(file_id)
2069
return osutils.lexists(self.abspath(path))
2071
def has_or_had_id(self, file_id):
2072
if file_id == self.inventory.root.file_id:
2074
return self.inventory.has_id(file_id)
2076
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2078
"""Iterate through file_ids for this tree.
2080
file_ids are in a WorkingTree if they are in the working inventory
2081
and the working file exists.
2083
inv = self._inventory
2084
for path, ie in inv.iter_entries():
2085
if osutils.lexists(self.abspath(path)):
2088
@needs_tree_write_lock
2089
def set_last_revision(self, new_revision):
2090
"""Change the last revision in the working tree."""
2091
if self._change_last_revision(new_revision):
2092
self._cache_basis_inventory(new_revision)
2094
def _get_check_refs(self):
2095
"""Return the references needed to perform a check of this tree.
2097
The default implementation returns no refs, and is only suitable for
2098
trees that have no local caching and can commit on ghosts at any time.
2100
:seealso: bzrlib.check for details about check_refs.
2105
def _check(self, references):
2106
"""Check the tree for consistency.
2108
:param references: A dict with keys matching the items returned by
2109
self._get_check_refs(), and values from looking those keys up in
2112
tree_basis = self.basis_tree()
2113
tree_basis.lock_read()
2115
repo_basis = references[('trees', self.last_revision())]
2116
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2117
raise errors.BzrCheckError(
2118
"Mismatched basis inventory content.")
2124
def check_state(self):
2125
"""Check that the working state is/isn't valid."""
2126
check_refs = self._get_check_refs()
2128
for ref in check_refs:
2131
refs[ref] = self.branch.repository.revision_tree(value)
2134
@needs_tree_write_lock
2135
def reset_state(self, revision_ids=None):
2136
"""Reset the state of the working tree.
2138
This does a hard-reset to a last-known-good state. This is a way to
2139
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2141
if revision_ids is None:
2142
revision_ids = self.get_parent_ids()
2143
if not revision_ids:
2144
rt = self.branch.repository.revision_tree(
2145
_mod_revision.NULL_REVISION)
180
return bzrlib.osutils.lexists(self.abspath(path))
183
__contains__ = has_id
186
def get_file_size(self, file_id):
187
return os.path.getsize(self.id2abspath(file_id))
189
def get_file_sha1(self, file_id):
190
path = self._inventory.id2path(file_id)
191
return self._hashcache.get_sha1(path)
194
def is_executable(self, file_id):
196
return self._inventory[file_id].executable
2147
rt = self.branch.repository.revision_tree(revision_ids[0])
2148
self._write_inventory(rt.inventory)
2149
self.set_parent_ids(revision_ids)
2152
"""Write the in memory inventory to disk."""
2153
# TODO: Maybe this should only write on dirty ?
2154
if self._control_files._lock_mode != 'w':
2155
raise errors.NotWriteLocked(self)
2157
self._serialize(self._inventory, sio)
2159
self._transport.put_file('inventory', sio,
2160
mode=self.bzrdir._get_file_mode())
2161
self._inventory_is_modified = False
2164
def get_file_sha1(self, file_id, path=None, stat_value=None):
2166
198
path = self._inventory.id2path(file_id)
2167
return self._hashcache.get_sha1(path, stat_value)
2169
def get_file_mtime(self, file_id, path=None):
2170
"""See Tree.get_file_mtime."""
2172
path = self.inventory.id2path(file_id)
2173
return os.lstat(self.abspath(path)).st_mtime
2175
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2176
file_id = self.path2id(path)
2178
# For unversioned files on win32, we just assume they are not
2181
return self._inventory[file_id].executable
2183
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2184
mode = stat_result.st_mode
2185
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2187
if not supports_executable():
2188
def is_executable(self, file_id, path=None):
2189
return self._inventory[file_id].executable
2191
_is_executable_from_path_and_stat = \
2192
_is_executable_from_path_and_stat_from_basis
2194
def is_executable(self, file_id, path=None):
2196
path = self.id2path(file_id)
2197
199
mode = os.lstat(self.abspath(path)).st_mode
2198
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2200
_is_executable_from_path_and_stat = \
2201
_is_executable_from_path_and_stat_from_stat
2203
@needs_tree_write_lock
2204
def _add(self, files, ids, kinds):
2205
"""See MutableTree._add."""
2206
# TODO: Re-adding a file that is removed in the working copy
2207
# should probably put it back with the previous ID.
2208
# the read and write working inventory should not occur in this
2209
# function - they should be part of lock_write and unlock.
2210
inv = self.inventory
2211
for f, file_id, kind in zip(files, ids, kinds):
2213
inv.add_path(f, kind=kind)
2215
inv.add_path(f, kind=kind, file_id=file_id)
2216
self._inventory_is_modified = True
2218
def revision_tree(self, revision_id):
2219
"""See WorkingTree.revision_id."""
2220
if revision_id == self.last_revision():
2222
xml = self.read_basis_inventory()
2223
except errors.NoSuchFile:
2227
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2228
# dont use the repository revision_tree api because we want
2229
# to supply the inventory.
2230
if inv.revision_id == revision_id:
2231
return revisiontree.InventoryRevisionTree(
2232
self.branch.repository, inv, revision_id)
2233
except errors.BadInventoryFormat:
2235
# raise if there was no inventory, or if we read the wrong inventory.
2236
raise errors.NoSuchRevisionInTree(self, revision_id)
2239
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2240
"""See Tree.annotate_iter
2242
This implementation will use the basis tree implementation if possible.
2243
Lines not in the basis are attributed to CURRENT_REVISION
2245
If there are pending merges, lines added by those merges will be
2246
incorrectly attributed to CURRENT_REVISION (but after committing, the
2247
attribution will be correct).
2249
maybe_file_parent_keys = []
2250
for parent_id in self.get_parent_ids():
2252
parent_tree = self.revision_tree(parent_id)
2253
except errors.NoSuchRevisionInTree:
2254
parent_tree = self.branch.repository.revision_tree(parent_id)
2255
parent_tree.lock_read()
2257
if not parent_tree.has_id(file_id):
2259
ie = parent_tree.inventory[file_id]
2260
if ie.kind != 'file':
2261
# Note: this is slightly unnecessary, because symlinks and
2262
# directories have a "text" which is the empty text, and we
2263
# know that won't mess up annotations. But it seems cleaner
2265
parent_text_key = (file_id, ie.revision)
2266
if parent_text_key not in maybe_file_parent_keys:
2267
maybe_file_parent_keys.append(parent_text_key)
2269
parent_tree.unlock()
2270
graph = _mod_graph.Graph(self.branch.repository.texts)
2271
heads = graph.heads(maybe_file_parent_keys)
2272
file_parent_keys = []
2273
for key in maybe_file_parent_keys:
2275
file_parent_keys.append(key)
2277
# Now we have the parents of this content
2278
annotator = self.branch.repository.texts.get_annotator()
2279
text = self.get_file_text(file_id)
2280
this_key =(file_id, default_revision)
2281
annotator.add_special_text(this_key, file_parent_keys, text)
2282
annotations = [(key[-1], line)
2283
for key, line in annotator.annotate_flat(this_key)]
2287
def merge_modified(self):
2288
"""Return a dictionary of files modified by a merge.
2290
The list is initialized by WorkingTree.set_merge_modified, which is
2291
typically called after we make some automatic updates to the tree
2294
This returns a map of file_id->sha1, containing only files which are
2295
still in the working inventory and have that text hash.
2298
hashfile = self._transport.get('merge-hashes')
2299
except errors.NoSuchFile:
2304
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2305
raise errors.MergeModifiedFormatError()
2306
except StopIteration:
2307
raise errors.MergeModifiedFormatError()
2308
for s in _mod_rio.RioReader(hashfile):
2309
# RioReader reads in Unicode, so convert file_ids back to utf8
2310
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2311
if not self.inventory.has_id(file_id):
2313
text_hash = s.get("hash")
2314
if text_hash == self.get_file_sha1(file_id):
2315
merge_hashes[file_id] = text_hash
2321
def subsume(self, other_tree):
2322
def add_children(inventory, entry):
2323
for child_entry in entry.children.values():
2324
inventory._byid[child_entry.file_id] = child_entry
2325
if child_entry.kind == 'directory':
2326
add_children(inventory, child_entry)
2327
if other_tree.get_root_id() == self.get_root_id():
2328
raise errors.BadSubsumeSource(self, other_tree,
2329
'Trees have the same root')
2331
other_tree_path = self.relpath(other_tree.basedir)
2332
except errors.PathNotChild:
2333
raise errors.BadSubsumeSource(self, other_tree,
2334
'Tree is not contained by the other')
2335
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2336
if new_root_parent is None:
2337
raise errors.BadSubsumeSource(self, other_tree,
2338
'Parent directory is not versioned.')
2339
# We need to ensure that the result of a fetch will have a
2340
# versionedfile for the other_tree root, and only fetching into
2341
# RepositoryKnit2 guarantees that.
2342
if not self.branch.repository.supports_rich_root():
2343
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2344
other_tree.lock_tree_write()
2346
new_parents = other_tree.get_parent_ids()
2347
other_root = other_tree.inventory.root
2348
other_root.parent_id = new_root_parent
2349
other_root.name = osutils.basename(other_tree_path)
2350
self.inventory.add(other_root)
2351
add_children(self.inventory, other_root)
2352
self._write_inventory(self.inventory)
2353
# normally we don't want to fetch whole repositories, but i think
2354
# here we really do want to consolidate the whole thing.
2355
for parent_id in other_tree.get_parent_ids():
2356
self.branch.fetch(other_tree.branch, parent_id)
2357
self.add_parent_tree_id(parent_id)
2360
other_tree.bzrdir.retire_bzrdir()
2362
@needs_tree_write_lock
2363
def extract(self, file_id, format=None):
2364
"""Extract a subtree from this tree.
2366
A new branch will be created, relative to the path for this tree.
2370
segments = osutils.splitpath(path)
2371
transport = self.branch.bzrdir.root_transport
2372
for name in segments:
2373
transport = transport.clone(name)
2374
transport.ensure_base()
2377
sub_path = self.id2path(file_id)
2378
branch_transport = mkdirs(sub_path)
2380
format = self.bzrdir.cloning_metadir()
2381
branch_transport.ensure_base()
2382
branch_bzrdir = format.initialize_on_transport(branch_transport)
2384
repo = branch_bzrdir.find_repository()
2385
except errors.NoRepositoryPresent:
2386
repo = branch_bzrdir.create_repository()
2387
if not repo.supports_rich_root():
2388
raise errors.RootNotRich()
2389
new_branch = branch_bzrdir.create_branch()
2390
new_branch.pull(self.branch)
2391
for parent_id in self.get_parent_ids():
2392
new_branch.fetch(self.branch, parent_id)
2393
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2394
if tree_transport.base != branch_transport.base:
2395
tree_bzrdir = format.initialize_on_transport(tree_transport)
2396
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2397
target_branch=new_branch)
200
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
202
def get_symlink_target(self, file_id):
203
return os.readlink(self.id2abspath(file_id))
205
def file_class(self, filename):
206
if self.path2id(filename):
208
elif self.is_ignored(filename):
2399
tree_bzrdir = branch_bzrdir
2400
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2401
wt.set_parent_ids(self.get_parent_ids())
2402
my_inv = self.inventory
2403
child_inv = inventory.Inventory(root_id=None)
2404
new_root = my_inv[file_id]
2405
my_inv.remove_recursive_id(file_id)
2406
new_root.parent_id = None
2407
child_inv.add(new_root)
2408
self._write_inventory(my_inv)
2409
wt._write_inventory(child_inv)
2412
def list_files(self, include_root=False, from_dir=None, recursive=True):
2413
"""List all files as (path, class, kind, id, entry).
214
def list_files(self):
215
"""Recursively list all files as (path, class, kind, id).
2415
217
Lists, but does not descend into unversioned directories.
2416
219
This does not include files that have been deleted in this
2417
tree. Skips the control directory.
2419
:param include_root: if True, return an entry for the root
2420
:param from_dir: start from this directory or None for the root
2421
:param recursive: whether to recurse into subdirectories or not
222
Skips the control directory.
2423
# list_files is an iterator, so @needs_read_lock doesn't work properly
2424
# with it. So callers should be careful to always read_lock the tree.
2425
if not self.is_locked():
2426
raise errors.ObjectNotLocked(self)
2428
inv = self.inventory
2429
if from_dir is None and include_root is True:
2430
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2431
# Convert these into local objects to save lookup times
2432
pathjoin = osutils.pathjoin
2433
file_kind = self._kind
2435
# transport.base ends in a slash, we want the piece
2436
# between the last two slashes
2437
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2439
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2441
# directory file_id, relative path, absolute path, reverse sorted children
2442
if from_dir is not None:
2443
from_dir_id = inv.path2id(from_dir)
2444
if from_dir_id is None:
2445
# Directory not versioned
2447
from_dir_abspath = pathjoin(self.basedir, from_dir)
2449
from_dir_id = inv.root.file_id
2450
from_dir_abspath = self.basedir
2451
children = os.listdir(from_dir_abspath)
2453
# jam 20060527 The kernel sized tree seems equivalent whether we
2454
# use a deque and popleft to keep them sorted, or if we use a plain
2455
# list and just reverse() them.
2456
children = collections.deque(children)
2457
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2459
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2462
f = children.popleft()
224
inv = self._inventory
226
def descend(from_dir_relpath, from_dir_id, dp):
2463
230
## TODO: If we find a subdirectory with its own .bzr
2464
231
## directory, then that is a separate tree and we
2465
232
## should exclude it.
2467
# the bzrdir for this tree
2468
if transport_base_dir == f:
233
if bzrlib.BZRDIR == f:
2471
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2472
# and 'f' doesn't begin with one, we can do a string op, rather
2473
# than the checks of pathjoin(), all relative paths will have an extra slash
2475
fp = from_dir_relpath + '/' + f
237
fp = appendpath(from_dir_relpath, f)
2478
fap = from_dir_abspath + '/' + f
2480
dir_ie = inv[from_dir_id]
2481
if dir_ie.kind == 'directory':
2482
f_ie = dir_ie.children.get(f)
240
fap = appendpath(dp, f)
242
f_ie = inv.get_child(from_dir_id, f)
2487
elif self.is_ignored(fp[1:]):
245
elif self.is_ignored(fp):
2490
# we may not have found this file, because of a unicode
2491
# issue, or because the directory was actually a symlink.
2492
f_norm, can_access = osutils.normalized_filename(f)
2493
if f == f_norm or not can_access:
2494
# No change, so treat this file normally
2497
# this file can be accessed by a normalized path
2498
# check again if it is versioned
2499
# these lines are repeated here for performance
2501
fp = from_dir_relpath + '/' + f
2502
fap = from_dir_abspath + '/' + f
2503
f_ie = inv.get_child(from_dir_id, f)
2506
elif self.is_ignored(fp[1:]):
2511
250
fk = file_kind(fap)
254
raise BzrCheckError("file %r entered as kind %r id %r, "
256
% (fap, f_ie.kind, f_ie.file_id, fk))
2513
258
# make a last minute entry
2515
yield fp[1:], c, fk, f_ie.file_id, f_ie
2518
yield fp[1:], c, fk, None, fk_entries[fk]()
2520
yield fp[1:], c, fk, None, TreeEntry()
262
if fk == 'directory':
263
entry = TreeDirectory()
266
elif fk == 'symlink':
271
yield fp, c, fk, (f_ie and f_ie.file_id), entry
2523
273
if fk != 'directory':
2526
# But do this child first if recursing down
2528
new_children = os.listdir(fap)
2530
new_children = collections.deque(new_children)
2531
stack.append((f_ie.file_id, fp, fap, new_children))
2532
# Break out of inner loop,
2533
# so that we start outer loop with child
2536
# if we finished all children, pop it off the stack
2539
@needs_tree_write_lock
2540
def move(self, from_paths, to_dir=None, after=False):
2543
to_dir must exist in the inventory.
2545
If to_dir exists and is a directory, the files are moved into
2546
it, keeping their old names.
2548
Note that to_dir is only the last component of the new name;
2549
this doesn't change the directory.
2551
For each entry in from_paths the move mode will be determined
2554
The first mode moves the file in the filesystem and updates the
2555
inventory. The second mode only updates the inventory without
2556
touching the file on the filesystem.
2558
move uses the second mode if 'after == True' and the target is
2559
either not versioned or newly added, and present in the working tree.
2561
move uses the second mode if 'after == False' and the source is
2562
versioned but no longer in the working tree, and the target is not
2563
versioned but present in the working tree.
2565
move uses the first mode if 'after == False' and the source is
2566
versioned and present in the working tree, and the target is not
2567
versioned and not present in the working tree.
2569
Everything else results in an error.
2571
This returns a list of (from_path, to_path) pairs for each
2572
entry that is moved.
2577
# check for deprecated use of signature
2579
raise TypeError('You must supply a target directory')
2580
# check destination directory
2581
if isinstance(from_paths, basestring):
2583
inv = self.inventory
2584
to_abs = self.abspath(to_dir)
2585
if not isdir(to_abs):
2586
raise errors.BzrMoveFailedError('',to_dir,
2587
errors.NotADirectory(to_abs))
2588
if not self.has_filename(to_dir):
2589
raise errors.BzrMoveFailedError('',to_dir,
2590
errors.NotInWorkingDirectory(to_dir))
2591
to_dir_id = inv.path2id(to_dir)
2592
if to_dir_id is None:
2593
raise errors.BzrMoveFailedError('',to_dir,
2594
errors.NotVersionedError(path=to_dir))
2596
to_dir_ie = inv[to_dir_id]
2597
if to_dir_ie.kind != 'directory':
2598
raise errors.BzrMoveFailedError('',to_dir,
2599
errors.NotADirectory(to_abs))
2601
# create rename entries and tuples
2602
for from_rel in from_paths:
2603
from_tail = splitpath(from_rel)[-1]
2604
from_id = inv.path2id(from_rel)
2606
raise errors.BzrMoveFailedError(from_rel,to_dir,
2607
errors.NotVersionedError(path=from_rel))
2609
from_entry = inv[from_id]
2610
from_parent_id = from_entry.parent_id
2611
to_rel = pathjoin(to_dir, from_tail)
2612
rename_entry = InventoryWorkingTree._RenameEntry(
2615
from_tail=from_tail,
2616
from_parent_id=from_parent_id,
2617
to_rel=to_rel, to_tail=from_tail,
2618
to_parent_id=to_dir_id)
2619
rename_entries.append(rename_entry)
2620
rename_tuples.append((from_rel, to_rel))
2622
# determine which move mode to use. checks also for movability
2623
rename_entries = self._determine_mv_mode(rename_entries, after)
2625
original_modified = self._inventory_is_modified
2628
self._inventory_is_modified = True
2629
self._move(rename_entries)
2631
# restore the inventory on error
2632
self._inventory_is_modified = original_modified
2634
self._write_inventory(inv)
2635
return rename_tuples
2637
@needs_tree_write_lock
2638
def rename_one(self, from_rel, to_rel, after=False):
2641
This can change the directory or the filename or both.
2643
rename_one has several 'modes' to work. First, it can rename a physical
2644
file and change the file_id. That is the normal mode. Second, it can
2645
only change the file_id without touching any physical file.
2647
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2648
versioned but present in the working tree.
2650
rename_one uses the second mode if 'after == False' and 'from_rel' is
2651
versioned but no longer in the working tree, and 'to_rel' is not
2652
versioned but present in the working tree.
2654
rename_one uses the first mode if 'after == False' and 'from_rel' is
2655
versioned and present in the working tree, and 'to_rel' is not
2656
versioned and not present in the working tree.
2658
Everything else results in an error.
2660
inv = self.inventory
2663
# create rename entries and tuples
2664
from_tail = splitpath(from_rel)[-1]
2665
from_id = inv.path2id(from_rel)
2667
# if file is missing in the inventory maybe it's in the basis_tree
2668
basis_tree = self.branch.basis_tree()
2669
from_id = basis_tree.path2id(from_rel)
2671
raise errors.BzrRenameFailedError(from_rel,to_rel,
2672
errors.NotVersionedError(path=from_rel))
2673
# put entry back in the inventory so we can rename it
2674
from_entry = basis_tree.inventory[from_id].copy()
2677
from_entry = inv[from_id]
2678
from_parent_id = from_entry.parent_id
2679
to_dir, to_tail = os.path.split(to_rel)
2680
to_dir_id = inv.path2id(to_dir)
2681
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2683
from_tail=from_tail,
2684
from_parent_id=from_parent_id,
2685
to_rel=to_rel, to_tail=to_tail,
2686
to_parent_id=to_dir_id)
2687
rename_entries.append(rename_entry)
2689
# determine which move mode to use. checks also for movability
2690
rename_entries = self._determine_mv_mode(rename_entries, after)
2692
# check if the target changed directory and if the target directory is
2694
if to_dir_id is None:
2695
raise errors.BzrMoveFailedError(from_rel,to_rel,
2696
errors.NotVersionedError(path=to_dir))
2698
# all checks done. now we can continue with our actual work
2699
mutter('rename_one:\n'
2704
' to_dir_id {%s}\n',
2705
from_id, from_rel, to_rel, to_dir, to_dir_id)
2707
self._move(rename_entries)
2708
self._write_inventory(inv)
2710
class _RenameEntry(object):
2711
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2712
to_rel, to_tail, to_parent_id, only_change_inv=False,
2714
self.from_rel = from_rel
2715
self.from_id = from_id
2716
self.from_tail = from_tail
2717
self.from_parent_id = from_parent_id
2718
self.to_rel = to_rel
2719
self.to_tail = to_tail
2720
self.to_parent_id = to_parent_id
2721
self.change_id = change_id
2722
self.only_change_inv = only_change_inv
2724
def _determine_mv_mode(self, rename_entries, after=False):
2725
"""Determines for each from-to pair if both inventory and working tree
2726
or only the inventory has to be changed.
2728
Also does basic plausability tests.
2730
inv = self.inventory
2732
for rename_entry in rename_entries:
2733
# store to local variables for easier reference
2734
from_rel = rename_entry.from_rel
2735
from_id = rename_entry.from_id
2736
to_rel = rename_entry.to_rel
2737
to_id = inv.path2id(to_rel)
2738
only_change_inv = False
2741
# check the inventory for source and destination
2743
raise errors.BzrMoveFailedError(from_rel,to_rel,
2744
errors.NotVersionedError(path=from_rel))
2745
if to_id is not None:
2747
# allow it with --after but only if dest is newly added
2749
basis = self.basis_tree()
2752
if not basis.has_id(to_id):
2753
rename_entry.change_id = True
2758
raise errors.BzrMoveFailedError(from_rel,to_rel,
2759
errors.AlreadyVersionedError(path=to_rel))
2761
# try to determine the mode for rename (only change inv or change
2762
# inv and file system)
2764
if not self.has_filename(to_rel):
2765
raise errors.BzrMoveFailedError(from_id,to_rel,
2766
errors.NoSuchFile(path=to_rel,
2767
extra="New file has not been created yet"))
2768
only_change_inv = True
2769
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2770
only_change_inv = True
2771
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2772
only_change_inv = False
2773
elif (not self.case_sensitive
2774
and from_rel.lower() == to_rel.lower()
2775
and self.has_filename(from_rel)):
2776
only_change_inv = False
2778
# something is wrong, so lets determine what exactly
2779
if not self.has_filename(from_rel) and \
2780
not self.has_filename(to_rel):
2781
raise errors.BzrRenameFailedError(from_rel,to_rel,
2782
errors.PathsDoNotExist(paths=(str(from_rel),
2785
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2786
rename_entry.only_change_inv = only_change_inv
2787
return rename_entries
2789
def _move(self, rename_entries):
2790
"""Moves a list of files.
2792
Depending on the value of the flag 'only_change_inv', the
2793
file will be moved on the file system or not.
2795
inv = self.inventory
2798
for entry in rename_entries:
2800
self._move_entry(entry)
2802
self._rollback_move(moved)
2806
def _rollback_move(self, moved):
2807
"""Try to rollback a previous move in case of an filesystem error."""
2808
inv = self.inventory
2811
self._move_entry(WorkingTree._RenameEntry(
2812
entry.to_rel, entry.from_id,
2813
entry.to_tail, entry.to_parent_id, entry.from_rel,
2814
entry.from_tail, entry.from_parent_id,
2815
entry.only_change_inv))
2816
except errors.BzrMoveFailedError, e:
2817
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2818
" The working tree is in an inconsistent state."
2819
" Please consider doing a 'bzr revert'."
2820
" Error message is: %s" % e)
2822
def _move_entry(self, entry):
2823
inv = self.inventory
2824
from_rel_abs = self.abspath(entry.from_rel)
2825
to_rel_abs = self.abspath(entry.to_rel)
2826
if from_rel_abs == to_rel_abs:
2827
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2828
"Source and target are identical.")
2830
if not entry.only_change_inv:
2832
osutils.rename(from_rel_abs, to_rel_abs)
2834
raise errors.BzrMoveFailedError(entry.from_rel,
2837
to_id = inv.path2id(entry.to_rel)
2838
inv.remove_recursive_id(to_id)
2839
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2841
@needs_tree_write_lock
2842
def unversion(self, file_ids):
2843
"""Remove the file ids in file_ids from the current versioned set.
2845
When a file_id is unversioned, all of its children are automatically
2848
:param file_ids: The file ids to stop versioning.
2849
:raises: NoSuchId if any fileid is not currently versioned.
2851
for file_id in file_ids:
2852
if not self._inventory.has_id(file_id):
2853
raise errors.NoSuchId(self, file_id)
2854
for file_id in file_ids:
2855
if self._inventory.has_id(file_id):
2856
self._inventory.remove_recursive_id(file_id)
2858
# in the future this should just set a dirty bit to wait for the
2859
# final unlock. However, until all methods of workingtree start
2860
# with the current in -memory inventory rather than triggering
2861
# a read, it is more complex - we need to teach read_inventory
2862
# to know when to read, and when to not read first... and possibly
2863
# to save first when the in memory one may be corrupted.
2864
# so for now, we just only write it if it is indeed dirty.
2866
self._write_inventory(self._inventory)
2868
def stored_kind(self, file_id):
2869
"""See Tree.stored_kind"""
2870
return self.inventory[file_id].kind
277
# don't descend unversioned directories
280
for ff in descend(fp, f_ie.file_id, fap):
283
for f in descend('', inv.root.file_id, self.basedir):
289
for subp in self.extras():
290
if not self.is_ignored(subp):
293
def iter_conflicts(self):
295
for path in (s[0] for s in self.list_files()):
296
stem = get_conflicted_stem(path)
299
if stem not in conflicted:
2872
303
def extras(self):
2873
"""Yield all unversioned files in this WorkingTree.
304
"""Yield all unknown files in this WorkingTree.
2875
If there are any unversioned directories then only the directory is
2876
returned, not all its children. But if there are unversioned files
306
If there are any unknown directories then only the directory is
307
returned, not all its children. But if there are unknown files
2877
308
under a versioned subdirectory, they are returned.
2879
310
Currently returned depth-first, sorted by name within directories.
2880
This is the same order used by 'osutils.walkdirs'.
2882
312
## TODO: Work from given directory downwards
2883
313
for path, dir_entry in self.inventory.directories():
2884
# mutter("search for unknowns in %r", path)
314
mutter("search for unknowns in %r" % path)
2885
315
dirabs = self.abspath(path)
2886
316
if not isdir(dirabs):
2887
317
# e.g. directory deleted
added
removed
bzrlib/workingtree.py
