207
125
(branch.base is not cross checked, because for remote branches that
208
126
would be meaningless).
210
self._format = _format
211
self.bzrdir = _bzrdir
213
# not created via open etc.
214
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
215
"Please use bzrdir.open_workingtree or WorkingTree.open().",
218
wt = WorkingTree.open(basedir)
219
self._branch = wt.branch
220
self.basedir = wt.basedir
221
self._control_files = wt._control_files
222
self._hashcache = wt._hashcache
223
self._set_inventory(wt._inventory, dirty=False)
224
self._format = wt._format
225
self.bzrdir = wt.bzrdir
128
from bzrlib.hashcache import HashCache
129
from bzrlib.trace import note, mutter
226
130
assert isinstance(basedir, basestring), \
227
131
"base directory %r is not a string" % basedir
228
basedir = safe_unicode(basedir)
229
mutter("opening working tree %r", basedir)
230
if deprecated_passed(branch):
232
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
233
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
234
" WorkingTree.open().",
238
self._branch = branch
240
self._branch = self.bzrdir.open_branch()
241
self.basedir = realpath(basedir)
242
# if branch is at our basedir and is a format 6 or less
243
if isinstance(self._format, WorkingTreeFormat2):
244
# share control object
245
self._control_files = self.branch.control_files
247
# assume all other formats have their own control files.
248
assert isinstance(_control_files, LockableFiles), \
249
"_control_files must be a LockableFiles, not %r" \
251
self._control_files = _control_files
133
branch = Branch.open(basedir)
134
assert isinstance(branch, Branch), \
135
"branch %r is not a Branch" % branch
136
self._inventory = branch.inventory
137
self.path2id = self._inventory.path2id
139
self.basedir = basedir
252
141
# update the whole cache up front and write to disk if anything changed;
253
142
# in the future we might want to do this more selectively
254
# two possible ways offer themselves : in self._unlock, write the cache
255
# if needed, or, when the cache sees a change, append it to the hash
256
# cache file, and have the parser take the most recent entry for a
258
wt_trans = self.bzrdir.get_workingtree_transport(None)
259
cache_filename = wt_trans.local_abspath('stat-cache')
260
self._hashcache = hashcache.HashCache(basedir, cache_filename,
261
self._control_files._file_mode)
143
hc = self._hashcache = HashCache(basedir)
264
# is this scan needed ? it makes things kinda slow.
267
147
if hc.needs_write:
268
148
mutter("write hc")
271
if _inventory is None:
272
self._inventory_is_modified = False
273
self.read_working_inventory()
275
# the caller of __init__ has provided an inventory,
276
# we assume they know what they are doing - as its only
277
# the Format factory and creation methods that are
278
# permitted to do this.
279
self._set_inventory(_inventory, dirty=False)
282
fget=lambda self: self._branch,
283
doc="""The branch this WorkingTree is connected to.
285
This cannot be set - it is reflective of the actual disk structure
286
the working tree has been constructed from.
289
def break_lock(self):
290
"""Break a lock if one is present from another instance.
292
Uses the ui factory to ask for confirmation if the lock may be from
295
This will probe the repository for its lock as well.
297
self._control_files.break_lock()
298
self.branch.break_lock()
300
def _set_inventory(self, inv, dirty):
301
"""Set the internal cached inventory.
303
:param inv: The inventory to set.
304
:param dirty: A boolean indicating whether the inventory is the same
305
logical inventory as whats on disk. If True the inventory is not
306
the same and should be written to disk or data will be lost, if
307
False then the inventory is the same as that on disk and any
308
serialisation would be unneeded overhead.
310
assert inv.root is not None
311
self._inventory = inv
312
self._inventory_is_modified = dirty
315
def open(path=None, _unsupported=False):
316
"""Open an existing working tree at path.
320
path = os.path.getcwdu()
321
control = bzrdir.BzrDir.open(path, _unsupported)
322
return control.open_workingtree(_unsupported)
325
def open_containing(path=None):
326
"""Open an existing working tree which has its root about path.
328
This probes for a working tree at path and searches upwards from there.
330
Basically we keep looking up until we find the control directory or
331
run into /. If there isn't one, raises NotBranchError.
332
TODO: give this a new exception.
333
If there is one, it is returned, along with the unused portion of path.
335
:return: The WorkingTree that contains 'path', and the rest of path
338
path = osutils.getcwd()
339
control, relpath = bzrdir.BzrDir.open_containing(path)
341
return control.open_workingtree(), relpath
344
def open_downlevel(path=None):
345
"""Open an unsupported working tree.
347
Only intended for advanced situations like upgrading part of a bzrdir.
349
return WorkingTree.open(path, _unsupported=True)
153
if self._hashcache.needs_write:
154
self._hashcache.write()
351
157
def __iter__(self):
352
158
"""Iterate through file_ids for this tree.
357
163
inv = self._inventory
358
164
for path, ie in inv.iter_entries():
359
if osutils.lexists(self.abspath(path)):
165
if bzrlib.osutils.lexists(self.abspath(path)):
362
169
def __repr__(self):
363
170
return "<%s of %s>" % (self.__class__.__name__,
364
171
getattr(self, 'basedir', None))
366
175
def abspath(self, filename):
367
return pathjoin(self.basedir, filename)
369
def basis_tree(self):
370
"""Return RevisionTree for the current last revision.
372
If the left most parent is a ghost then the returned tree will be an
373
empty tree - one obtained by calling repository.revision_tree(None).
376
revision_id = self.get_parent_ids()[0]
378
# no parents, return an empty revision tree.
379
# in the future this should return the tree for
380
# 'empty:' - the implicit root empty tree.
381
return self.branch.repository.revision_tree(None)
384
xml = self.read_basis_inventory()
385
inv = xml6.serializer_v6.read_inventory_from_string(xml)
386
if inv is not None and inv.revision_id == revision_id:
387
return bzrlib.revisiontree.RevisionTree(
388
self.branch.repository, inv, revision_id)
389
except (errors.NoSuchFile, errors.BadInventoryFormat):
391
# No cached copy available, retrieve from the repository.
392
# FIXME? RBC 20060403 should we cache the inventory locally
395
return self.branch.repository.revision_tree(revision_id)
396
except errors.RevisionNotPresent:
397
# the basis tree *may* be a ghost or a low level error may have
398
# occured. If the revision is present, its a problem, if its not
400
if self.branch.repository.has_revision(revision_id):
402
# the basis tree is a ghost so return an empty tree.
403
return self.branch.repository.revision_tree(None)
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
176
return os.path.join(self.basedir, filename)
178
def relpath(self, abspath):
179
"""Return the local path portion from a given absolute path."""
180
return relpath(self.basedir, abspath)
451
182
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
183
return bzrlib.osutils.lexists(self.abspath(filename))
454
185
def get_file(self, file_id):
455
186
return self.get_file_byname(self.id2path(file_id))
457
def get_file_text(self, file_id):
458
return self.get_file(file_id).read()
460
188
def get_file_byname(self, filename):
461
189
return file(self.abspath(filename), 'rb')
463
def annotate_iter(self, file_id):
464
"""See Tree.annotate_iter
466
This implementation will use the basis tree implementation if possible.
467
Lines not in the basis are attributed to CURRENT_REVISION
469
If there are pending merges, lines added by those merges will be
470
incorrectly attributed to CURRENT_REVISION (but after committing, the
471
attribution will be correct).
473
basis = self.basis_tree()
474
changes = self._iter_changes(basis, True, [file_id]).next()
475
changed_content, kind = changes[2], changes[6]
476
if not changed_content:
477
return basis.annotate_iter(file_id)
481
if kind[0] != 'file':
484
old_lines = list(basis.annotate_iter(file_id))
486
for tree in self.branch.repository.revision_trees(
487
self.get_parent_ids()[1:]):
488
if file_id not in tree:
490
old.append(list(tree.annotate_iter(file_id)))
491
return annotate.reannotate(old, self.get_file(file_id).readlines(),
494
def get_parent_ids(self):
495
"""See Tree.get_parent_ids.
497
This implementation reads the pending merges list and last_revision
498
value and uses that to decide what the parents list should be.
500
last_rev = self._last_revision()
506
merges_file = self._control_files.get('pending-merges')
507
except errors.NoSuchFile:
510
for l in merges_file.readlines():
511
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
512
parents.append(revision_id)
516
def get_root_id(self):
517
"""Return the id of this trees root"""
518
return self._inventory.root.file_id
520
191
def _get_store_filename(self, file_id):
521
## XXX: badly named; this is not in the store at all
192
## XXX: badly named; this isn't in the store at all
522
193
return self.abspath(self.id2path(file_id))
525
def clone(self, to_bzrdir, revision_id=None, basis=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 and difference between the source trees last revision
536
and this one merged in.
539
If not None, a closer copy of a tree which may have some files in
540
common, and which file content should be preferentially copied from.
542
# assumes the target bzr dir format is compatible.
543
result = self._format.initialize(to_bzrdir)
544
self.copy_content_into(result, revision_id)
548
def copy_content_into(self, tree, revision_id=None):
549
"""Copy the current content and user files of this tree into tree."""
550
tree.set_root_id(self.get_root_id())
551
if revision_id is None:
552
merge.transform_tree(tree, self)
554
# TODO now merge from tree.last_revision to revision (to preserve
555
# user local changes)
556
merge.transform_tree(tree, self)
557
tree.set_parent_ids([revision_id])
559
196
def id2abspath(self, file_id):
560
197
return self.abspath(self.id2path(file_id))
562
200
def has_id(self, file_id):
563
201
# files that have been deleted are excluded
564
202
inv = self._inventory
565
203
if not inv.has_id(file_id):
567
205
path = inv.id2path(file_id)
568
return osutils.lexists(self.abspath(path))
206
return bzrlib.osutils.lexists(self.abspath(path))
570
208
def has_or_had_id(self, file_id):
571
209
if file_id == self.inventory.root.file_id:
573
211
return self.inventory.has_id(file_id)
575
213
__contains__ = has_id
577
216
def get_file_size(self, file_id):
578
217
return os.path.getsize(self.id2abspath(file_id))
581
def get_file_sha1(self, file_id, path=None, stat_value=None):
583
path = self._inventory.id2path(file_id)
584
return self._hashcache.get_sha1(path, stat_value)
586
def get_file_mtime(self, file_id, path=None):
588
path = self._inventory.id2path(file_id)
589
return os.lstat(self.abspath(path)).st_mtime
591
if not supports_executable():
592
def is_executable(self, file_id, path=None):
219
def get_file_sha1(self, file_id):
220
path = self._inventory.id2path(file_id)
221
return self._hashcache.get_sha1(path)
224
def is_executable(self, file_id):
593
226
return self._inventory[file_id].executable
595
def is_executable(self, file_id, path=None):
597
path = self._inventory.id2path(file_id)
228
path = self._inventory.id2path(file_id)
598
229
mode = os.lstat(self.abspath(path)).st_mode
599
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
602
def _add(self, files, ids, kinds):
603
"""See MutableTree._add."""
604
# TODO: Re-adding a file that is removed in the working copy
605
# should probably put it back with the previous ID.
606
# the read and write working inventory should not occur in this
607
# function - they should be part of lock_write and unlock.
608
inv = self.read_working_inventory()
609
for f, file_id, kind in zip(files, ids, kinds):
610
assert kind is not None
612
inv.add_path(f, kind=kind)
614
inv.add_path(f, kind=kind, file_id=file_id)
615
self._write_inventory(inv)
617
@needs_tree_write_lock
618
def _gather_kinds(self, files, kinds):
619
"""See MutableTree._gather_kinds."""
620
for pos, f in enumerate(files):
621
if kinds[pos] is None:
622
fullpath = normpath(self.abspath(f))
624
kinds[pos] = file_kind(fullpath)
626
if e.errno == errno.ENOENT:
627
raise errors.NoSuchFile(fullpath)
630
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
631
"""Add revision_id as a parent.
633
This is equivalent to retrieving the current list of parent ids
634
and setting the list to its value plus revision_id.
636
:param revision_id: The revision id to add to the parent list. It may
637
be a ghost revision as long as its not the first parent to be added,
638
or the allow_leftmost_as_ghost parameter is set True.
639
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
641
parents = self.get_parent_ids() + [revision_id]
642
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
643
or allow_leftmost_as_ghost)
645
@needs_tree_write_lock
646
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
647
"""Add revision_id, tree tuple as a parent.
649
This is equivalent to retrieving the current list of parent trees
650
and setting the list to its value plus parent_tuple. See also
651
add_parent_tree_id - if you only have a parent id available it will be
652
simpler to use that api. If you have the parent already available, using
653
this api is preferred.
655
:param parent_tuple: The (revision id, tree) to add to the parent list.
656
If the revision_id is a ghost, pass None for the tree.
657
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
659
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
660
if len(parent_ids) > 1:
661
# the leftmost may have already been a ghost, preserve that if it
663
allow_leftmost_as_ghost = True
664
self.set_parent_ids(parent_ids,
665
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
667
@needs_tree_write_lock
668
def add_pending_merge(self, *revision_ids):
669
# TODO: Perhaps should check at this point that the
670
# history of the revision is actually present?
671
parents = self.get_parent_ids()
673
for rev_id in revision_ids:
674
if rev_id in parents:
676
parents.append(rev_id)
679
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
681
@deprecated_method(zero_eleven)
683
def pending_merges(self):
684
"""Return a list of pending merges.
686
These are revisions that have been merged into the working
687
directory but not yet committed.
689
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
690
instead - which is available on all tree objects.
692
return self.get_parent_ids()[1:]
694
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
695
"""Common ghost checking functionality from set_parent_*.
697
This checks that the left hand-parent exists if there are any
700
if len(revision_ids) > 0:
701
leftmost_id = revision_ids[0]
702
if (not allow_leftmost_as_ghost and not
703
self.branch.repository.has_revision(leftmost_id)):
704
raise errors.GhostRevisionUnusableHere(leftmost_id)
706
def _set_merges_from_parent_ids(self, parent_ids):
707
merges = parent_ids[1:]
708
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
710
@needs_tree_write_lock
711
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
712
"""Set the parent ids to revision_ids.
714
See also set_parent_trees. This api will try to retrieve the tree data
715
for each element of revision_ids from the trees repository. If you have
716
tree data already available, it is more efficient to use
717
set_parent_trees rather than set_parent_ids. set_parent_ids is however
718
an easier API to use.
720
:param revision_ids: The revision_ids to set as the parent ids of this
721
working tree. Any of these may be ghosts.
723
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
724
self._check_parents_for_ghosts(revision_ids,
725
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
727
if len(revision_ids) > 0:
728
self.set_last_revision(revision_ids[0])
730
self.set_last_revision(None)
732
self._set_merges_from_parent_ids(revision_ids)
734
@needs_tree_write_lock
735
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
736
"""See MutableTree.set_parent_trees."""
737
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
739
self._check_parents_for_ghosts(parent_ids,
740
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
742
if len(parent_ids) == 0:
743
leftmost_parent_id = None
744
leftmost_parent_tree = None
746
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
748
if self._change_last_revision(leftmost_parent_id):
749
if leftmost_parent_tree is None:
750
# If we don't have a tree, fall back to reading the
751
# parent tree from the repository.
752
self._cache_basis_inventory(leftmost_parent_id)
754
inv = leftmost_parent_tree.inventory
755
xml = self._create_basis_xml_from_inventory(
756
leftmost_parent_id, inv)
757
self._write_basis_inventory(xml)
758
self._set_merges_from_parent_ids(parent_ids)
760
@needs_tree_write_lock
761
def set_pending_merges(self, rev_list):
762
parents = self.get_parent_ids()
763
leftmost = parents[:1]
764
new_parents = leftmost + rev_list
765
self.set_parent_ids(new_parents)
767
@needs_tree_write_lock
768
def set_merge_modified(self, modified_hashes):
770
for file_id, hash in modified_hashes.iteritems():
771
yield Stanza(file_id=file_id, hash=hash)
772
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
774
@needs_tree_write_lock
775
def _put_rio(self, filename, stanzas, header):
776
my_file = rio_file(stanzas, header)
777
self._control_files.put(filename, my_file)
779
@needs_write_lock # because merge pulls data into the branch.
780
def merge_from_branch(self, branch, to_revision=None):
781
"""Merge from a branch into this working tree.
783
:param branch: The branch to merge from.
784
:param to_revision: If non-None, the merge will merge to to_revision,
785
but not beyond it. to_revision does not need to be in the history
786
of the branch when it is supplied. If None, to_revision defaults to
787
branch.last_revision().
789
from bzrlib.merge import Merger, Merge3Merger
790
pb = bzrlib.ui.ui_factory.nested_progress_bar()
792
merger = Merger(self.branch, this_tree=self, pb=pb)
793
merger.pp = ProgressPhase("Merge phase", 5, pb)
794
merger.pp.next_phase()
795
# check that there are no
797
merger.check_basis(check_clean=True, require_commits=False)
798
if to_revision is None:
799
to_revision = branch.last_revision()
801
to_revision = osutils.safe_revision_id(to_revision)
802
merger.other_rev_id = to_revision
803
if merger.other_rev_id is None:
804
raise error.NoCommits(branch)
805
self.branch.fetch(branch, last_revision=merger.other_rev_id)
806
merger.other_basis = merger.other_rev_id
807
merger.other_tree = self.branch.repository.revision_tree(
809
merger.pp.next_phase()
811
if merger.base_rev_id == merger.other_rev_id:
812
raise errors.PointlessMerge
813
merger.backup_files = False
814
merger.merge_type = Merge3Merger
815
merger.set_interesting_files(None)
816
merger.show_base = False
817
merger.reprocess = False
818
conflicts = merger.do_merge()
825
def merge_modified(self):
827
hashfile = self._control_files.get('merge-hashes')
828
except errors.NoSuchFile:
832
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
833
raise errors.MergeModifiedFormatError()
834
except StopIteration:
835
raise errors.MergeModifiedFormatError()
836
for s in RioReader(hashfile):
837
file_id = s.get("file_id")
838
if file_id not in self.inventory:
841
if hash == self.get_file_sha1(file_id):
842
merge_hashes[file_id] = hash
846
def mkdir(self, path, file_id=None):
847
"""See MutableTree.mkdir()."""
849
file_id = generate_ids.gen_file_id(os.path.basename(path))
850
os.mkdir(self.abspath(path))
851
self.add(path, file_id, 'directory')
230
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
854
232
def get_symlink_target(self, file_id):
855
233
return os.readlink(self.id2abspath(file_id))
884
252
Skips the control directory.
886
254
inv = self._inventory
887
if include_root is True:
888
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
889
# Convert these into local objects to save lookup times
890
pathjoin = osutils.pathjoin
891
file_kind = osutils.file_kind
893
# transport.base ends in a slash, we want the piece
894
# between the last two slashes
895
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
897
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
899
# directory file_id, relative path, absolute path, reverse sorted children
900
children = os.listdir(self.basedir)
902
# jam 20060527 The kernel sized tree seems equivalent whether we
903
# use a deque and popleft to keep them sorted, or if we use a plain
904
# list and just reverse() them.
905
children = collections.deque(children)
906
stack = [(inv.root.file_id, u'', self.basedir, children)]
908
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
911
f = children.popleft()
256
def descend(from_dir_relpath, from_dir_id, dp):
912
260
## TODO: If we find a subdirectory with its own .bzr
913
261
## directory, then that is a separate tree and we
914
262
## should exclude it.
916
# the bzrdir for this tree
917
if transport_base_dir == f:
263
if bzrlib.BZRDIR == f:
920
# we know that from_dir_relpath and from_dir_abspath never end in a slash
921
# and 'f' doesn't begin with one, we can do a string op, rather
922
# than the checks of pathjoin(), all relative paths will have an extra slash
924
fp = from_dir_relpath + '/' + f
267
fp = appendpath(from_dir_relpath, f)
927
fap = from_dir_abspath + '/' + f
270
fap = appendpath(dp, f)
929
272
f_ie = inv.get_child(from_dir_id, f)
932
elif self.is_ignored(fp[1:]):
275
elif self.is_ignored(fp):
935
# we may not have found this file, because of a unicode issue
936
f_norm, can_access = osutils.normalized_filename(f)
937
if f == f_norm or not can_access:
938
# No change, so treat this file normally
941
# this file can be accessed by a normalized path
942
# check again if it is versioned
943
# these lines are repeated here for performance
945
fp = from_dir_relpath + '/' + f
946
fap = from_dir_abspath + '/' + f
947
f_ie = inv.get_child(from_dir_id, f)
950
elif self.is_ignored(fp[1:]):
955
280
fk = file_kind(fap)
958
283
if f_ie.kind != fk:
959
raise errors.BzrCheckError(
960
"file %r entered as kind %r id %r, now of kind %r"
961
% (fap, f_ie.kind, f_ie.file_id, fk))
284
raise BzrCheckError("file %r entered as kind %r id %r, "
286
% (fap, f_ie.kind, f_ie.file_id, fk))
963
288
# make a last minute entry
965
yield fp[1:], c, fk, f_ie.file_id, f_ie
968
yield fp[1:], c, fk, None, fk_entries[fk]()
970
yield fp[1:], c, fk, None, TreeEntry()
292
if fk == 'directory':
293
entry = TreeDirectory()
296
elif fk == 'symlink':
301
yield fp, c, fk, (f_ie and f_ie.file_id), entry
973
303
if fk != 'directory':
976
# But do this child first
977
new_children = os.listdir(fap)
979
new_children = collections.deque(new_children)
980
stack.append((f_ie.file_id, fp, fap, new_children))
981
# Break out of inner loop,
982
# so that we start outer loop with child
985
# if we finished all children, pop it off the stack
988
@needs_tree_write_lock
989
def move(self, from_paths, to_dir=None, after=False, **kwargs):
992
to_dir must exist in the inventory.
994
If to_dir exists and is a directory, the files are moved into
995
it, keeping their old names.
997
Note that to_dir is only the last component of the new name;
998
this doesn't change the directory.
1000
For each entry in from_paths the move mode will be determined
1003
The first mode moves the file in the filesystem and updates the
1004
inventory. The second mode only updates the inventory without
1005
touching the file on the filesystem. This is the new mode introduced
1008
move uses the second mode if 'after == True' and the target is not
1009
versioned but present in the working tree.
1011
move uses the second mode if 'after == False' and the source is
1012
versioned but no longer in the working tree, and the target is not
1013
versioned but present in the working tree.
1015
move uses the first mode if 'after == False' and the source is
1016
versioned and present in the working tree, and the target is not
1017
versioned and not present in the working tree.
1019
Everything else results in an error.
1021
This returns a list of (from_path, to_path) pairs for each
1022
entry that is moved.
1027
# check for deprecated use of signature
1029
to_dir = kwargs.get('to_name', None)
1031
raise TypeError('You must supply a target directory')
1033
symbol_versioning.warn('The parameter to_name was deprecated'
1034
' in version 0.13. Use to_dir instead',
1037
# check destination directory
1038
assert not isinstance(from_paths, basestring)
1039
inv = self.inventory
1040
to_abs = self.abspath(to_dir)
1041
if not isdir(to_abs):
1042
raise errors.BzrMoveFailedError('',to_dir,
1043
errors.NotADirectory(to_abs))
1044
if not self.has_filename(to_dir):
1045
raise errors.BzrMoveFailedError('',to_dir,
1046
errors.NotInWorkingDirectory(to_dir))
1047
to_dir_id = inv.path2id(to_dir)
1048
if to_dir_id is None:
1049
raise errors.BzrMoveFailedError('',to_dir,
1050
errors.NotVersionedError(path=str(to_dir)))
1052
to_dir_ie = inv[to_dir_id]
1053
if to_dir_ie.kind != 'directory':
1054
raise errors.BzrMoveFailedError('',to_dir,
1055
errors.NotADirectory(to_abs))
1057
# create rename entries and tuples
1058
for from_rel in from_paths:
1059
from_tail = splitpath(from_rel)[-1]
1060
from_id = inv.path2id(from_rel)
1062
raise errors.BzrMoveFailedError(from_rel,to_dir,
1063
errors.NotVersionedError(path=str(from_rel)))
1065
from_entry = inv[from_id]
1066
from_parent_id = from_entry.parent_id
1067
to_rel = pathjoin(to_dir, from_tail)
1068
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1070
from_tail=from_tail,
1071
from_parent_id=from_parent_id,
1072
to_rel=to_rel, to_tail=from_tail,
1073
to_parent_id=to_dir_id)
1074
rename_entries.append(rename_entry)
1075
rename_tuples.append((from_rel, to_rel))
1077
# determine which move mode to use. checks also for movability
1078
rename_entries = self._determine_mv_mode(rename_entries, after)
1080
original_modified = self._inventory_is_modified
1083
self._inventory_is_modified = True
1084
self._move(rename_entries)
1086
# restore the inventory on error
1087
self._inventory_is_modified = original_modified
1089
self._write_inventory(inv)
1090
return rename_tuples
1092
def _determine_mv_mode(self, rename_entries, after=False):
1093
"""Determines for each from-to pair if both inventory and working tree
1094
or only the inventory has to be changed.
1096
Also does basic plausability tests.
1098
inv = self.inventory
1100
for rename_entry in rename_entries:
1101
# store to local variables for easier reference
1102
from_rel = rename_entry.from_rel
1103
from_id = rename_entry.from_id
1104
to_rel = rename_entry.to_rel
1105
to_id = inv.path2id(to_rel)
1106
only_change_inv = False
1108
# check the inventory for source and destination
1110
raise errors.BzrMoveFailedError(from_rel,to_rel,
1111
errors.NotVersionedError(path=str(from_rel)))
1112
if to_id is not None:
1113
raise errors.BzrMoveFailedError(from_rel,to_rel,
1114
errors.AlreadyVersionedError(path=str(to_rel)))
1116
# try to determine the mode for rename (only change inv or change
1117
# inv and file system)
1119
if not self.has_filename(to_rel):
1120
raise errors.BzrMoveFailedError(from_id,to_rel,
1121
errors.NoSuchFile(path=str(to_rel),
1122
extra="New file has not been created yet"))
1123
only_change_inv = True
1124
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1125
only_change_inv = True
1126
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1127
only_change_inv = False
1129
# something is wrong, so lets determine what exactly
1130
if not self.has_filename(from_rel) and \
1131
not self.has_filename(to_rel):
1132
raise errors.BzrRenameFailedError(from_rel,to_rel,
1133
errors.PathsDoNotExist(paths=(str(from_rel),
1136
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1137
extra="(Use --after to update the Bazaar id)")
1138
rename_entry.only_change_inv = only_change_inv
1139
return rename_entries
1141
def _move(self, rename_entries):
1142
"""Moves a list of files.
1144
Depending on the value of the flag 'only_change_inv', the
1145
file will be moved on the file system or not.
1147
inv = self.inventory
1150
for entry in rename_entries:
1152
self._move_entry(entry)
1154
self._rollback_move(moved)
1158
def _rollback_move(self, moved):
1159
"""Try to rollback a previous move in case of an filesystem error."""
1160
inv = self.inventory
1163
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1164
entry.to_tail, entry.to_parent_id, entry.from_rel,
1165
entry.from_tail, entry.from_parent_id,
1166
entry.only_change_inv))
1167
except errors.BzrMoveFailedError, e:
1168
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1169
" The working tree is in an inconsistent state."
1170
" Please consider doing a 'bzr revert'."
1171
" Error message is: %s" % e)
1173
def _move_entry(self, entry):
1174
inv = self.inventory
1175
from_rel_abs = self.abspath(entry.from_rel)
1176
to_rel_abs = self.abspath(entry.to_rel)
1177
if from_rel_abs == to_rel_abs:
1178
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1179
"Source and target are identical.")
1181
if not entry.only_change_inv:
1183
osutils.rename(from_rel_abs, to_rel_abs)
1185
raise errors.BzrMoveFailedError(entry.from_rel,
1187
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1189
@needs_tree_write_lock
1190
def rename_one(self, from_rel, to_rel, after=False):
1193
This can change the directory or the filename or both.
1195
rename_one has several 'modes' to work. First, it can rename a physical
1196
file and change the file_id. That is the normal mode. Second, it can
1197
only change the file_id without touching any physical file. This is
1198
the new mode introduced in version 0.15.
1200
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1201
versioned but present in the working tree.
1203
rename_one uses the second mode if 'after == False' and 'from_rel' is
1204
versioned but no longer in the working tree, and 'to_rel' is not
1205
versioned but present in the working tree.
1207
rename_one uses the first mode if 'after == False' and 'from_rel' is
1208
versioned and present in the working tree, and 'to_rel' is not
1209
versioned and not present in the working tree.
1211
Everything else results in an error.
1213
inv = self.inventory
1216
# create rename entries and tuples
1217
from_tail = splitpath(from_rel)[-1]
1218
from_id = inv.path2id(from_rel)
1220
raise errors.BzrRenameFailedError(from_rel,to_rel,
1221
errors.NotVersionedError(path=str(from_rel)))
1222
from_entry = inv[from_id]
1223
from_parent_id = from_entry.parent_id
1224
to_dir, to_tail = os.path.split(to_rel)
1225
to_dir_id = inv.path2id(to_dir)
1226
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1228
from_tail=from_tail,
1229
from_parent_id=from_parent_id,
1230
to_rel=to_rel, to_tail=to_tail,
1231
to_parent_id=to_dir_id)
1232
rename_entries.append(rename_entry)
1234
# determine which move mode to use. checks also for movability
1235
rename_entries = self._determine_mv_mode(rename_entries, after)
1237
# check if the target changed directory and if the target directory is
1239
if to_dir_id is None:
1240
raise errors.BzrMoveFailedError(from_rel,to_rel,
1241
errors.NotVersionedError(path=str(to_dir)))
1243
# all checks done. now we can continue with our actual work
1244
mutter('rename_one:\n'
1249
' to_dir_id {%s}\n',
1250
from_id, from_rel, to_rel, to_dir, to_dir_id)
1252
self._move(rename_entries)
1253
self._write_inventory(inv)
1255
class _RenameEntry(object):
1256
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1257
to_rel, to_tail, to_parent_id, only_change_inv=False):
1258
self.from_rel = from_rel
1259
self.from_id = from_id
1260
self.from_tail = from_tail
1261
self.from_parent_id = from_parent_id
1262
self.to_rel = to_rel
1263
self.to_tail = to_tail
1264
self.to_parent_id = to_parent_id
1265
self.only_change_inv = only_change_inv
307
# don't descend unversioned directories
310
for ff in descend(fp, f_ie.file_id, fap):
313
for f in descend('', inv.root.file_id, self.basedir):
1268
318
def unknowns(self):
1269
"""Return all unknown files.
1271
These are files in the working directory that are not versioned or
1272
control files or ignored.
1274
319
for subp in self.extras():
1275
320
if not self.is_ignored(subp):
1278
@needs_tree_write_lock
1279
def unversion(self, file_ids):
1280
"""Remove the file ids in file_ids from the current versioned set.
1282
When a file_id is unversioned, all of its children are automatically
1285
:param file_ids: The file ids to stop versioning.
1286
:raises: NoSuchId if any fileid is not currently versioned.
1288
for file_id in file_ids:
1289
if self._inventory.has_id(file_id):
1290
self._inventory.remove_recursive_id(file_id)
1292
raise errors.NoSuchId(self, file_id)
1294
# in the future this should just set a dirty bit to wait for the
1295
# final unlock. However, until all methods of workingtree start
1296
# with the current in -memory inventory rather than triggering
1297
# a read, it is more complex - we need to teach read_inventory
1298
# to know when to read, and when to not read first... and possibly
1299
# to save first when the in memory one may be corrupted.
1300
# so for now, we just only write it if it is indeed dirty.
1302
self._write_inventory(self._inventory)
1304
@deprecated_method(zero_eight)
1305
323
def iter_conflicts(self):
1306
"""List all files in the tree that have text or content conflicts.
1307
DEPRECATED. Use conflicts instead."""
1308
return self._iter_conflicts()
1310
def _iter_conflicts(self):
1311
324
conflicted = set()
1312
for info in self.list_files():
325
for path in (s[0] for s in self.list_files()):
1314
326
stem = get_conflicted_stem(path)
1315
327
if stem is None:
1454
413
If the file is ignored, returns the pattern which caused it to
1455
414
be ignored, otherwise None. So this can simply be used as a
1456
415
boolean if desired."""
1457
if getattr(self, '_ignoreglobster', None) is None:
1458
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1459
return self._ignoreglobster.match(filename)
417
# TODO: Use '**' to match directories, and other extended
418
# globbing stuff from cvs/rsync.
420
# XXX: fnmatch is actually not quite what we want: it's only
421
# approximately the same as real Unix fnmatch, and doesn't
422
# treat dotfiles correctly and allows * to match /.
423
# Eventually it should be replaced with something more
426
for pat in self.get_ignore_list():
427
if '/' in pat or '\\' in pat:
429
# as a special case, you can put ./ at the start of a
430
# pattern; this is good to match in the top-level
433
if (pat[:2] == './') or (pat[:2] == '.\\'):
437
if fnmatch.fnmatchcase(filename, newpat):
440
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1461
445
def kind(self, file_id):
1462
446
return file_kind(self.id2abspath(file_id))
1464
def _comparison_data(self, entry, path):
1465
abspath = self.abspath(path)
1467
stat_value = os.lstat(abspath)
1469
if getattr(e, 'errno', None) == errno.ENOENT:
1476
mode = stat_value.st_mode
1477
kind = osutils.file_kind_from_stat_mode(mode)
1478
if not supports_executable():
1479
executable = entry.executable
1481
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1482
return kind, executable, stat_value
1484
def _file_size(self, entry, stat_value):
1485
return stat_value.st_size
1487
def last_revision(self):
1488
"""Return the last revision of the branch for this tree.
1490
This format tree does not support a separate marker for last-revision
1491
compared to the branch.
1493
See MutableTree.last_revision
1495
return self._last_revision()
1498
def _last_revision(self):
1499
"""helper for get_parent_ids."""
1500
return self.branch.last_revision()
1502
def is_locked(self):
1503
return self._control_files.is_locked()
1505
448
def lock_read(self):
1506
449
"""See Branch.lock_read, and WorkingTree.unlock."""
1507
self.branch.lock_read()
1509
return self._control_files.lock_read()
1511
self.branch.unlock()
1514
def lock_tree_write(self):
1515
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1516
self.branch.lock_read()
1518
return self._control_files.lock_write()
1520
self.branch.unlock()
450
return self.branch.lock_read()
1523
452
def lock_write(self):
1524
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1525
self.branch.lock_write()
1527
return self._control_files.lock_write()
1529
self.branch.unlock()
1532
def get_physical_lock_status(self):
1533
return self._control_files.get_physical_lock_status()
1535
def _basis_inventory_name(self):
1536
return 'basis-inventory-cache'
1538
@needs_tree_write_lock
1539
def set_last_revision(self, new_revision):
1540
"""Change the last revision in the working tree."""
1541
new_revision = osutils.safe_revision_id(new_revision)
1542
if self._change_last_revision(new_revision):
1543
self._cache_basis_inventory(new_revision)
1545
def _change_last_revision(self, new_revision):
1546
"""Template method part of set_last_revision to perform the change.
1548
This is used to allow WorkingTree3 instances to not affect branch
1549
when their last revision is set.
1551
if new_revision is None:
1552
self.branch.set_revision_history([])
1555
self.branch.generate_revision_history(new_revision)
1556
except errors.NoSuchRevision:
1557
# not present in the repo - dont try to set it deeper than the tip
1558
self.branch.set_revision_history([new_revision])
1561
def _write_basis_inventory(self, xml):
1562
"""Write the basis inventory XML to the basis-inventory file"""
1563
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1564
path = self._basis_inventory_name()
1566
self._control_files.put(path, sio)
1568
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1569
"""Create the text that will be saved in basis-inventory"""
1570
# TODO: jam 20070209 This should be redundant, as the revision_id
1571
# as all callers should have already converted the revision_id to
1573
inventory.revision_id = osutils.safe_revision_id(revision_id)
1574
return xml6.serializer_v6.write_inventory_to_string(inventory)
1576
def _cache_basis_inventory(self, new_revision):
1577
"""Cache new_revision as the basis inventory."""
1578
# TODO: this should allow the ready-to-use inventory to be passed in,
1579
# as commit already has that ready-to-use [while the format is the
1582
# this double handles the inventory - unpack and repack -
1583
# but is easier to understand. We can/should put a conditional
1584
# in here based on whether the inventory is in the latest format
1585
# - perhaps we should repack all inventories on a repository
1587
# the fast path is to copy the raw xml from the repository. If the
1588
# xml contains 'revision_id="', then we assume the right
1589
# revision_id is set. We must check for this full string, because a
1590
# root node id can legitimately look like 'revision_id' but cannot
1592
xml = self.branch.repository.get_inventory_xml(new_revision)
1593
firstline = xml.split('\n', 1)[0]
1594
if (not 'revision_id="' in firstline or
1595
'format="6"' not in firstline):
1596
inv = self.branch.repository.deserialise_inventory(
1598
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1599
self._write_basis_inventory(xml)
1600
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1603
def read_basis_inventory(self):
1604
"""Read the cached basis inventory."""
1605
path = self._basis_inventory_name()
1606
return self._control_files.get(path).read()
1609
def read_working_inventory(self):
1610
"""Read the working inventory.
1612
:raises errors.InventoryModified: read_working_inventory will fail
1613
when the current in memory inventory has been modified.
1615
# conceptually this should be an implementation detail of the tree.
1616
# XXX: Deprecate this.
1617
# ElementTree does its own conversion from UTF-8, so open in
1619
if self._inventory_is_modified:
1620
raise errors.InventoryModified(self)
1621
result = xml5.serializer_v5.read_inventory(
1622
self._control_files.get('inventory'))
1623
self._set_inventory(result, dirty=False)
1626
@needs_tree_write_lock
1627
def remove(self, files, verbose=False, to_file=None):
453
"""See Branch.lock_write, and WorkingTree.unlock."""
454
return self.branch.lock_write()
457
def remove(self, files, verbose=False):
1628
458
"""Remove nominated files from the working inventory..
1630
460
This does not remove their text. This does not run on XXX on what? RBC
1741
503
between multiple working trees, i.e. via shared storage, then we
1742
504
would probably want to lock both the local tree, and the branch.
1744
raise NotImplementedError(self.unlock)
1747
"""Update a working tree along its branch.
1749
This will update the branch if its bound too, which means we have
1750
multiple trees involved:
1752
- The new basis tree of the master.
1753
- The old basis tree of the branch.
1754
- The old basis tree of the working tree.
1755
- The current working tree state.
1757
Pathologically, all three may be different, and non-ancestors of each
1758
other. Conceptually we want to:
1760
- Preserve the wt.basis->wt.state changes
1761
- Transform the wt.basis to the new master basis.
1762
- Apply a merge of the old branch basis to get any 'local' changes from
1764
- Restore the wt.basis->wt.state changes.
1766
There isn't a single operation at the moment to do that, so we:
1767
- Merge current state -> basis tree of the master w.r.t. the old tree
1769
- Do a 'normal' merge of the old branch basis if it is relevant.
1771
if self.branch.get_master_branch() is not None:
1773
update_branch = True
1775
self.lock_tree_write()
1776
update_branch = False
1779
old_tip = self.branch.update()
1782
return self._update_tree(old_tip)
1786
@needs_tree_write_lock
1787
def _update_tree(self, old_tip=None):
1788
"""Update a tree to the master branch.
1790
:param old_tip: if supplied, the previous tip revision the branch,
1791
before it was changed to the master branch's tip.
1793
# here if old_tip is not None, it is the old tip of the branch before
1794
# it was updated from the master branch. This should become a pending
1795
# merge in the working tree to preserve the user existing work. we
1796
# cant set that until we update the working trees last revision to be
1797
# one from the new branch, because it will just get absorbed by the
1798
# parent de-duplication logic.
1800
# We MUST save it even if an error occurs, because otherwise the users
1801
# local work is unreferenced and will appear to have been lost.
1805
last_rev = self.get_parent_ids()[0]
1808
if last_rev != self.branch.last_revision():
1809
# merge tree state up to new branch tip.
1810
basis = self.basis_tree()
1811
to_tree = self.branch.basis_tree()
1812
if basis.inventory.root is None:
1813
self.set_root_id(to_tree.inventory.root.file_id)
1814
result += merge.merge_inner(
1819
# TODO - dedup parents list with things merged by pull ?
1820
# reuse the tree we've updated to to set the basis:
1821
parent_trees = [(self.branch.last_revision(), to_tree)]
1822
merges = self.get_parent_ids()[1:]
1823
# Ideally we ask the tree for the trees here, that way the working
1824
# tree can decide whether to give us teh entire tree or give us a
1825
# lazy initialised tree. dirstate for instance will have the trees
1826
# in ram already, whereas a last-revision + basis-inventory tree
1827
# will not, but also does not need them when setting parents.
1828
for parent in merges:
1829
parent_trees.append(
1830
(parent, self.branch.repository.revision_tree(parent)))
1831
if old_tip is not None:
1832
parent_trees.append(
1833
(old_tip, self.branch.repository.revision_tree(old_tip)))
1834
self.set_parent_trees(parent_trees)
1835
last_rev = parent_trees[0][0]
1837
# the working tree had the same last-revision as the master
1838
# branch did. We may still have pivot local work from the local
1839
# branch into old_tip:
1840
if old_tip is not None:
1841
self.add_parent_tree_id(old_tip)
1842
if old_tip and old_tip != last_rev:
1843
# our last revision was not the prior branch last revision
1844
# and we have converted that last revision to a pending merge.
1845
# base is somewhere between the branch tip now
1846
# and the now pending merge
1847
from bzrlib.revision import common_ancestor
1849
base_rev_id = common_ancestor(self.branch.last_revision(),
1851
self.branch.repository)
1852
except errors.NoCommonAncestor:
1854
base_tree = self.branch.repository.revision_tree(base_rev_id)
1855
other_tree = self.branch.repository.revision_tree(old_tip)
1856
result += merge.merge_inner(
1863
def _write_hashcache_if_dirty(self):
1864
"""Write out the hashcache if it is dirty."""
1865
if self._hashcache.needs_write:
1867
self._hashcache.write()
1869
if e.errno not in (errno.EPERM, errno.EACCES):
1871
# TODO: jam 20061219 Should this be a warning? A single line
1872
# warning might be sufficient to let the user know what
1874
mutter('Could not write hashcache for %s\nError: %s',
1875
self._hashcache.cache_file_name(), e)
1877
@needs_tree_write_lock
1878
def _write_inventory(self, inv):
1879
"""Write inventory as the current inventory."""
1880
self._set_inventory(inv, dirty=True)
1883
def set_conflicts(self, arg):
1884
raise errors.UnsupportedOperation(self.set_conflicts, self)
1886
def add_conflicts(self, arg):
1887
raise errors.UnsupportedOperation(self.add_conflicts, self)
1890
def conflicts(self):
1891
conflicts = _mod_conflicts.ConflictList()
1892
for conflicted in self._iter_conflicts():
1895
if file_kind(self.abspath(conflicted)) != "file":
1897
except errors.NoSuchFile:
1900
for suffix in ('.THIS', '.OTHER'):
1902
kind = file_kind(self.abspath(conflicted+suffix))
1905
except errors.NoSuchFile:
1909
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1910
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1912
file_id=self.path2id(conflicted)))
1916
class WorkingTree2(WorkingTree):
1917
"""This is the Format 2 working tree.
1919
This was the first weave based working tree.
1920
- uses os locks for locking.
1921
- uses the branch last-revision.
1924
def lock_tree_write(self):
1925
"""See WorkingTree.lock_tree_write().
1927
In Format2 WorkingTrees we have a single lock for the branch and tree
1928
so lock_tree_write() degrades to lock_write().
1930
self.branch.lock_write()
1932
return self._control_files.lock_write()
1934
self.branch.unlock()
1938
# we share control files:
1939
if self._control_files._lock_count == 3:
1940
# _inventory_is_modified is always False during a read lock.
1941
if self._inventory_is_modified:
1943
self._write_hashcache_if_dirty()
1945
# reverse order of locking.
1947
return self._control_files.unlock()
1949
self.branch.unlock()
1952
class WorkingTree3(WorkingTree):
1953
"""This is the Format 3 working tree.
1955
This differs from the base WorkingTree by:
1956
- having its own file lock
1957
- having its own last-revision property.
1959
This is new in bzr 0.8
1963
def _last_revision(self):
1964
"""See Mutable.last_revision."""
1966
return osutils.safe_revision_id(
1967
self._control_files.get('last-revision').read())
1968
except errors.NoSuchFile:
1971
def _change_last_revision(self, revision_id):
1972
"""See WorkingTree._change_last_revision."""
1973
if revision_id is None or revision_id == NULL_REVISION:
1975
self._control_files._transport.delete('last-revision')
1976
except errors.NoSuchFile:
1980
self._control_files.put_utf8('last-revision', revision_id)
1983
@needs_tree_write_lock
1984
def set_conflicts(self, conflicts):
1985
self._put_rio('conflicts', conflicts.to_stanzas(),
1988
@needs_tree_write_lock
1989
def add_conflicts(self, new_conflicts):
1990
conflict_set = set(self.conflicts())
1991
conflict_set.update(set(list(new_conflicts)))
1992
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1993
key=_mod_conflicts.Conflict.sort_key)))
1996
def conflicts(self):
1998
confile = self._control_files.get('conflicts')
1999
except errors.NoSuchFile:
2000
return _mod_conflicts.ConflictList()
2002
if confile.next() != CONFLICT_HEADER_1 + '\n':
2003
raise errors.ConflictFormatError()
2004
except StopIteration:
2005
raise errors.ConflictFormatError()
2006
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2009
if self._control_files._lock_count == 1:
2010
# _inventory_is_modified is always False during a read lock.
2011
if self._inventory_is_modified:
2013
self._write_hashcache_if_dirty()
2014
# reverse order of locking.
2016
return self._control_files.unlock()
2018
self.branch.unlock()
506
return self.branch.unlock()
509
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
2021
510
def get_conflicted_stem(path):
2022
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
511
for suffix in CONFLICT_SUFFIXES:
2023
512
if path.endswith(suffix):
2024
513
return path[:-len(suffix)]
2026
@deprecated_function(zero_eight)
2027
def is_control_file(filename):
2028
"""See WorkingTree.is_control_filename(filename)."""
2029
## FIXME: better check
2030
filename = normpath(filename)
2031
while filename != '':
2032
head, tail = os.path.split(filename)
2033
## mutter('check %r for control file' % ((head, tail),))
2036
if filename == head:
2042
class WorkingTreeFormat(object):
2043
"""An encapsulation of the initialization and open routines for a format.
2045
Formats provide three things:
2046
* An initialization routine,
2050
Formats are placed in an dict by their format string for reference
2051
during workingtree opening. Its not required that these be instances, they
2052
can be classes themselves with class methods - it simply depends on
2053
whether state is needed for a given format or not.
2055
Once a format is deprecated, just deprecate the initialize and open
2056
methods on the format class. Do not deprecate the object, as the
2057
object will be created every time regardless.
2060
_default_format = None
2061
"""The default format used for new trees."""
2064
"""The known formats."""
2067
def find_format(klass, a_bzrdir):
2068
"""Return the format for the working tree object in a_bzrdir."""
2070
transport = a_bzrdir.get_workingtree_transport(None)
2071
format_string = transport.get("format").read()
2072
return klass._formats[format_string]
2073
except errors.NoSuchFile:
2074
raise errors.NoWorkingTree(base=transport.base)
2076
raise errors.UnknownFormatError(format=format_string)
2079
def get_default_format(klass):
2080
"""Return the current default format."""
2081
return klass._default_format
2083
def get_format_string(self):
2084
"""Return the ASCII format string that identifies this format."""
2085
raise NotImplementedError(self.get_format_string)
2087
def get_format_description(self):
2088
"""Return the short description for this format."""
2089
raise NotImplementedError(self.get_format_description)
2091
def is_supported(self):
2092
"""Is this format supported?
2094
Supported formats can be initialized and opened.
2095
Unsupported formats may not support initialization or committing or
2096
some other features depending on the reason for not being supported.
2101
def register_format(klass, format):
2102
klass._formats[format.get_format_string()] = format
2105
def set_default_format(klass, format):
2106
klass._default_format = format
2109
def unregister_format(klass, format):
2110
assert klass._formats[format.get_format_string()] is format
2111
del klass._formats[format.get_format_string()]
2115
class WorkingTreeFormat2(WorkingTreeFormat):
2116
"""The second working tree format.
2118
This format modified the hash cache from the format 1 hash cache.
2121
def get_format_description(self):
2122
"""See WorkingTreeFormat.get_format_description()."""
2123
return "Working tree format 2"
2125
def stub_initialize_remote(self, control_files):
2126
"""As a special workaround create critical control files for a remote working tree
2128
This ensures that it can later be updated and dealt with locally,
2129
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2130
no working tree. (See bug #43064).
2134
xml5.serializer_v5.write_inventory(inv, sio)
2136
control_files.put('inventory', sio)
2138
control_files.put_utf8('pending-merges', '')
2141
def initialize(self, a_bzrdir, revision_id=None):
2142
"""See WorkingTreeFormat.initialize()."""
2143
if not isinstance(a_bzrdir.transport, LocalTransport):
2144
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2145
branch = a_bzrdir.open_branch()
2146
if revision_id is not None:
2147
revision_id = osutils.safe_revision_id(revision_id)
2150
revision_history = branch.revision_history()
2152
position = revision_history.index(revision_id)
2154
raise errors.NoSuchRevision(branch, revision_id)
2155
branch.set_revision_history(revision_history[:position + 1])
2158
revision = branch.last_revision()
2160
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2166
basis_tree = branch.repository.revision_tree(revision)
2167
if basis_tree.inventory.root is not None:
2168
wt.set_root_id(basis_tree.inventory.root.file_id)
2169
# set the parent list and cache the basis tree.
2170
wt.set_parent_trees([(revision, basis_tree)])
2171
transform.build_tree(basis_tree, wt)
2175
super(WorkingTreeFormat2, self).__init__()
2176
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2178
def open(self, a_bzrdir, _found=False):
2179
"""Return the WorkingTree object for a_bzrdir
2181
_found is a private parameter, do not use it. It is used to indicate
2182
if format probing has already been done.
2185
# we are being called directly and must probe.
2186
raise NotImplementedError
2187
if not isinstance(a_bzrdir.transport, LocalTransport):
2188
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2189
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2195
class WorkingTreeFormat3(WorkingTreeFormat):
2196
"""The second working tree format updated to record a format marker.
2199
- exists within a metadir controlling .bzr
2200
- includes an explicit version marker for the workingtree control
2201
files, separate from the BzrDir format
2202
- modifies the hash cache format
2204
- uses a LockDir to guard access for writes.
2207
def get_format_string(self):
2208
"""See WorkingTreeFormat.get_format_string()."""
2209
return "Bazaar-NG Working Tree format 3"
2211
def get_format_description(self):
2212
"""See WorkingTreeFormat.get_format_description()."""
2213
return "Working tree format 3"
2215
_lock_file_name = 'lock'
2216
_lock_class = LockDir
2218
def _open_control_files(self, a_bzrdir):
2219
transport = a_bzrdir.get_workingtree_transport(None)
2220
return LockableFiles(transport, self._lock_file_name,
2223
def initialize(self, a_bzrdir, revision_id=None):
2224
"""See WorkingTreeFormat.initialize().
2226
revision_id allows creating a working tree at a different
2227
revision than the branch is at.
2229
if not isinstance(a_bzrdir.transport, LocalTransport):
2230
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2231
transport = a_bzrdir.get_workingtree_transport(self)
2232
control_files = self._open_control_files(a_bzrdir)
2233
control_files.create_lock()
2234
control_files.lock_write()
2235
control_files.put_utf8('format', self.get_format_string())
2236
branch = a_bzrdir.open_branch()
2237
if revision_id is None:
2238
revision_id = branch.last_revision()
2240
revision_id = osutils.safe_revision_id(revision_id)
2241
# WorkingTree3 can handle an inventory which has a unique root id.
2242
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2243
# those trees. And because there isn't a format bump inbetween, we
2244
# are maintaining compatibility with older clients.
2245
# inv = Inventory(root_id=gen_root_id())
2247
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2253
_control_files=control_files)
2254
wt.lock_tree_write()
2256
basis_tree = branch.repository.revision_tree(revision_id)
2257
# only set an explicit root id if there is one to set.
2258
if basis_tree.inventory.root is not None:
2259
wt.set_root_id(basis_tree.inventory.root.file_id)
2260
if revision_id == NULL_REVISION:
2261
wt.set_parent_trees([])
2263
wt.set_parent_trees([(revision_id, basis_tree)])
2264
transform.build_tree(basis_tree, wt)
2266
# Unlock in this order so that the unlock-triggers-flush in
2267
# WorkingTree is given a chance to fire.
2268
control_files.unlock()
2273
super(WorkingTreeFormat3, self).__init__()
2274
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2276
def open(self, a_bzrdir, _found=False):
2277
"""Return the WorkingTree object for a_bzrdir
2279
_found is a private parameter, do not use it. It is used to indicate
2280
if format probing has already been done.
2283
# we are being called directly and must probe.
2284
raise NotImplementedError
2285
if not isinstance(a_bzrdir.transport, LocalTransport):
2286
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2287
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2289
def _open(self, a_bzrdir, control_files):
2290
"""Open the tree itself.
2292
:param a_bzrdir: the dir for the tree.
2293
:param control_files: the control files for the tree.
2295
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2299
_control_files=control_files)
2302
return self.get_format_string()
2305
# formats which have no format string are not discoverable
2306
# and not independently creatable, so are not registered.
2307
__default_format = WorkingTreeFormat3()
2308
WorkingTreeFormat.register_format(__default_format)
2309
WorkingTreeFormat.set_default_format(__default_format)
2310
_legacy_formats = [WorkingTreeFormat2(),
2314
class WorkingTreeTestProviderAdapter(object):
2315
"""A tool to generate a suite testing multiple workingtree formats at once.
2317
This is done by copying the test once for each transport and injecting
2318
the transport_server, transport_readonly_server, and workingtree_format
2319
classes into each copy. Each copy is also given a new id() to make it
2323
def __init__(self, transport_server, transport_readonly_server, formats):
2324
self._transport_server = transport_server
2325
self._transport_readonly_server = transport_readonly_server
2326
self._formats = formats
2328
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2329
"""Clone test for adaption."""
2330
new_test = deepcopy(test)
2331
new_test.transport_server = self._transport_server
2332
new_test.transport_readonly_server = self._transport_readonly_server
2333
new_test.bzrdir_format = bzrdir_format
2334
new_test.workingtree_format = workingtree_format
2335
def make_new_test_id():
2336
new_id = "%s(%s)" % (test.id(), variation)
2337
return lambda: new_id
2338
new_test.id = make_new_test_id()
2341
def adapt(self, test):
2342
from bzrlib.tests import TestSuite
2343
result = TestSuite()
2344
for workingtree_format, bzrdir_format in self._formats:
2345
new_test = self._clone_test(
2348
workingtree_format, workingtree_format.__class__.__name__)
2349
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
