117
179
It is possible for a `WorkingTree` to have a filename which is
118
180
not listed in the Inventory and vice versa.
182
:ivar basedir: The root of the tree on disk. This is a unicode path object
183
(as opposed to a URL).
121
def __init__(self, basedir, branch=None):
122
"""Construct a WorkingTree for basedir.
124
If the branch is not supplied, it is opened automatically.
125
If the branch is supplied, it must be the branch for this basedir.
126
(branch.base is not cross checked, because for remote branches that
127
would be meaningless).
186
# override this to set the strategy for storing views
187
def _make_views(self):
188
return views.DisabledViews(self)
190
def __init__(self, basedir='.',
191
branch=DEPRECATED_PARAMETER,
197
"""Construct a WorkingTree instance. This is not a public API.
199
:param branch: A branch to override probing for the branch.
129
from bzrlib.hashcache import HashCache
130
from bzrlib.trace import note, mutter
131
assert isinstance(basedir, basestring), \
132
"base directory %r is not a string" % basedir
134
branch = Branch.open(basedir)
135
assert isinstance(branch, Branch), \
136
"branch %r is not a Branch" % branch
137
self._inventory = branch.inventory
138
self.path2id = self._inventory.path2id
140
self.basedir = basedir
201
self._format = _format
202
self.bzrdir = _bzrdir
204
raise errors.BzrError("Please use bzrdir.open_workingtree or "
205
"WorkingTree.open() to obtain a WorkingTree.")
206
basedir = safe_unicode(basedir)
207
mutter("opening working tree %r", basedir)
208
if deprecated_passed(branch):
209
self._branch = branch
211
self._branch = self.bzrdir.open_branch()
212
self.basedir = realpath(basedir)
213
self._control_files = _control_files
214
self._transport = self._control_files._transport
142
215
# update the whole cache up front and write to disk if anything changed;
143
216
# in the future we might want to do this more selectively
144
217
# two possible ways offer themselves : in self._unlock, write the cache
145
218
# if needed, or, when the cache sees a change, append it to the hash
146
219
# cache file, and have the parser take the most recent entry for a
147
220
# given path only.
148
hc = self._hashcache = HashCache(basedir)
221
wt_trans = self.bzrdir.get_workingtree_transport(None)
222
cache_filename = wt_trans.local_abspath('stat-cache')
223
self._hashcache = hashcache.HashCache(basedir, cache_filename,
224
self.bzrdir._get_file_mode(),
225
self._content_filter_stack_provider())
228
# is this scan needed ? it makes things kinda slow.
152
231
if hc.needs_write:
153
232
mutter("write hc")
235
if _inventory is None:
236
# This will be acquired on lock_read() or lock_write()
237
self._inventory_is_modified = False
238
self._inventory = None
240
# the caller of __init__ has provided an inventory,
241
# we assume they know what they are doing - as its only
242
# the Format factory and creation methods that are
243
# permitted to do this.
244
self._set_inventory(_inventory, dirty=False)
245
self._detect_case_handling()
246
self._rules_searcher = None
247
self.views = self._make_views()
250
def user_transport(self):
251
return self.bzrdir.user_transport
254
def control_transport(self):
255
return self._transport
257
def is_control_filename(self, filename):
258
"""True if filename is the name of a control file in this tree.
260
:param filename: A filename within the tree. This is a relative path
261
from the root of this tree.
263
This is true IF and ONLY IF the filename is part of the meta data
264
that bzr controls in this tree. I.E. a random .bzr directory placed
265
on disk will not be a control file for this tree.
267
return self.bzrdir.is_control_filename(filename)
269
def _detect_case_handling(self):
270
wt_trans = self.bzrdir.get_workingtree_transport(None)
272
wt_trans.stat(self._format.case_sensitive_filename)
273
except errors.NoSuchFile:
274
self.case_sensitive = True
276
self.case_sensitive = False
278
self._setup_directory_is_tree_reference()
281
fget=lambda self: self._branch,
282
doc="""The branch this WorkingTree is connected to.
284
This cannot be set - it is reflective of the actual disk structure
285
the working tree has been constructed from.
288
def break_lock(self):
289
"""Break a lock if one is present from another instance.
291
Uses the ui factory to ask for confirmation if the lock may be from
294
This will probe the repository for its lock as well.
296
self._control_files.break_lock()
297
self.branch.break_lock()
299
def _get_check_refs(self):
300
"""Return the references needed to perform a check of this tree.
302
The default implementation returns no refs, and is only suitable for
303
trees that have no local caching and can commit on ghosts at any time.
305
:seealso: bzrlib.check for details about check_refs.
309
def requires_rich_root(self):
310
return self._format.requires_rich_root
312
def supports_tree_reference(self):
315
def supports_content_filtering(self):
316
return self._format.supports_content_filtering()
318
def supports_views(self):
319
return self.views.supports_views()
321
def _set_inventory(self, inv, dirty):
322
"""Set the internal cached inventory.
324
:param inv: The inventory to set.
325
:param dirty: A boolean indicating whether the inventory is the same
326
logical inventory as whats on disk. If True the inventory is not
327
the same and should be written to disk or data will be lost, if
328
False then the inventory is the same as that on disk and any
329
serialisation would be unneeded overhead.
331
self._inventory = inv
332
self._inventory_is_modified = dirty
335
def open(path=None, _unsupported=False):
336
"""Open an existing working tree at path.
340
path = osutils.getcwd()
341
control = bzrdir.BzrDir.open(path, _unsupported)
342
return control.open_workingtree(_unsupported)
345
def open_containing(path=None):
346
"""Open an existing working tree which has its root about path.
348
This probes for a working tree at path and searches upwards from there.
350
Basically we keep looking up until we find the control directory or
351
run into /. If there isn't one, raises NotBranchError.
352
TODO: give this a new exception.
353
If there is one, it is returned, along with the unused portion of path.
355
:return: The WorkingTree that contains 'path', and the rest of path
358
path = osutils.getcwd()
359
control, relpath = bzrdir.BzrDir.open_containing(path)
360
return control.open_workingtree(), relpath
363
def open_containing_paths(file_list, default_directory=None,
364
canonicalize=True, apply_view=True):
365
"""Open the WorkingTree that contains a set of paths.
367
Fail if the paths given are not all in a single tree.
369
This is used for the many command-line interfaces that take a list of
370
any number of files and that require they all be in the same tree.
372
if default_directory is None:
373
default_directory = u'.'
374
# recommended replacement for builtins.internal_tree_files
375
if file_list is None or len(file_list) == 0:
376
tree = WorkingTree.open_containing(default_directory)[0]
377
# XXX: doesn't really belong here, and seems to have the strange
378
# side effect of making it return a bunch of files, not the whole
379
# tree -- mbp 20100716
380
if tree.supports_views() and apply_view:
381
view_files = tree.views.lookup_view()
383
file_list = view_files
384
view_str = views.view_display_str(view_files)
385
note("Ignoring files outside view. View is %s" % view_str)
386
return tree, file_list
387
if default_directory == u'.':
390
seed = default_directory
391
file_list = [osutils.pathjoin(default_directory, f)
393
tree = WorkingTree.open_containing(seed)[0]
394
return tree, tree.safe_relpath_files(file_list, canonicalize,
395
apply_view=apply_view)
397
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
398
"""Convert file_list into a list of relpaths in tree.
400
:param self: A tree to operate on.
401
:param file_list: A list of user provided paths or None.
402
:param apply_view: if True and a view is set, apply it or check that
403
specified files are within it
404
:return: A list of relative paths.
405
:raises errors.PathNotChild: When a provided path is in a different self
408
if file_list is None:
410
if self.supports_views() and apply_view:
411
view_files = self.views.lookup_view()
415
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
416
# doesn't - fix that up here before we enter the loop.
418
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
421
for filename in file_list:
422
relpath = fixer(osutils.dereference_path(filename))
423
if view_files and not osutils.is_inside_any(view_files, relpath):
424
raise errors.FileOutsideView(filename, view_files)
425
new_list.append(relpath)
429
def open_downlevel(path=None):
430
"""Open an unsupported working tree.
432
Only intended for advanced situations like upgrading part of a bzrdir.
434
return WorkingTree.open(path, _unsupported=True)
437
def find_trees(location):
438
def list_current(transport):
439
return [d for d in transport.list_dir('') if d != '.bzr']
440
def evaluate(bzrdir):
442
tree = bzrdir.open_workingtree()
443
except errors.NoWorkingTree:
447
t = transport.get_transport(location)
448
iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
449
list_current=list_current)
450
return [tr for tr in iterator if tr is not None]
452
# should be deprecated - this is slow and in any case treating them as a
453
# container is (we now know) bad style -- mbp 20070302
454
## @deprecated_method(zero_fifteen)
156
455
def __iter__(self):
157
456
"""Iterate through file_ids for this tree.
210
694
return self.inventory.has_id(file_id)
212
696
__contains__ = has_id
215
698
def get_file_size(self, file_id):
216
return os.path.getsize(self.id2abspath(file_id))
218
def get_file_sha1(self, file_id):
219
path = self._inventory.id2path(file_id)
220
return self._hashcache.get_sha1(path)
223
def is_executable(self, file_id):
699
"""See Tree.get_file_size"""
700
# XXX: this returns the on-disk size; it should probably return the
703
return os.path.getsize(self.id2abspath(file_id))
705
if e.errno != errno.ENOENT:
711
def get_file_sha1(self, file_id, path=None, stat_value=None):
713
path = self._inventory.id2path(file_id)
714
return self._hashcache.get_sha1(path, stat_value)
716
def get_file_mtime(self, file_id, path=None):
718
path = self.inventory.id2path(file_id)
719
return os.lstat(self.abspath(path)).st_mtime
721
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
722
file_id = self.path2id(path)
724
# For unversioned files on win32, we just assume they are not
727
return self._inventory[file_id].executable
729
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
730
mode = stat_result.st_mode
731
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
733
if not supports_executable():
734
def is_executable(self, file_id, path=None):
225
735
return self._inventory[file_id].executable
227
path = self._inventory.id2path(file_id)
737
_is_executable_from_path_and_stat = \
738
_is_executable_from_path_and_stat_from_basis
740
def is_executable(self, file_id, path=None):
742
path = self.id2path(file_id)
228
743
mode = os.lstat(self.abspath(path)).st_mode
229
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
744
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
746
_is_executable_from_path_and_stat = \
747
_is_executable_from_path_and_stat_from_stat
749
@needs_tree_write_lock
750
def _add(self, files, ids, kinds):
751
"""See MutableTree._add."""
752
# TODO: Re-adding a file that is removed in the working copy
753
# should probably put it back with the previous ID.
754
# the read and write working inventory should not occur in this
755
# function - they should be part of lock_write and unlock.
757
for f, file_id, kind in zip(files, ids, kinds):
759
inv.add_path(f, kind=kind)
761
inv.add_path(f, kind=kind, file_id=file_id)
762
self._inventory_is_modified = True
764
@needs_tree_write_lock
765
def _gather_kinds(self, files, kinds):
766
"""See MutableTree._gather_kinds."""
767
for pos, f in enumerate(files):
768
if kinds[pos] is None:
769
fullpath = normpath(self.abspath(f))
771
kinds[pos] = file_kind(fullpath)
773
if e.errno == errno.ENOENT:
774
raise errors.NoSuchFile(fullpath)
777
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
778
"""Add revision_id as a parent.
780
This is equivalent to retrieving the current list of parent ids
781
and setting the list to its value plus revision_id.
783
:param revision_id: The revision id to add to the parent list. It may
784
be a ghost revision as long as its not the first parent to be added,
785
or the allow_leftmost_as_ghost parameter is set True.
786
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
788
parents = self.get_parent_ids() + [revision_id]
789
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
790
or allow_leftmost_as_ghost)
792
@needs_tree_write_lock
793
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
794
"""Add revision_id, tree tuple as a parent.
796
This is equivalent to retrieving the current list of parent trees
797
and setting the list to its value plus parent_tuple. See also
798
add_parent_tree_id - if you only have a parent id available it will be
799
simpler to use that api. If you have the parent already available, using
800
this api is preferred.
802
:param parent_tuple: The (revision id, tree) to add to the parent list.
803
If the revision_id is a ghost, pass None for the tree.
804
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
806
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
807
if len(parent_ids) > 1:
808
# the leftmost may have already been a ghost, preserve that if it
810
allow_leftmost_as_ghost = True
811
self.set_parent_ids(parent_ids,
812
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
814
@needs_tree_write_lock
815
def add_pending_merge(self, *revision_ids):
816
# TODO: Perhaps should check at this point that the
817
# history of the revision is actually present?
818
parents = self.get_parent_ids()
820
for rev_id in revision_ids:
821
if rev_id in parents:
823
parents.append(rev_id)
826
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
828
def path_content_summary(self, path, _lstat=os.lstat,
829
_mapper=osutils.file_kind_from_stat_mode):
830
"""See Tree.path_content_summary."""
831
abspath = self.abspath(path)
833
stat_result = _lstat(abspath)
835
if getattr(e, 'errno', None) == errno.ENOENT:
837
return ('missing', None, None, None)
838
# propagate other errors
840
kind = _mapper(stat_result.st_mode)
842
return self._file_content_summary(path, stat_result)
843
elif kind == 'directory':
844
# perhaps it looks like a plain directory, but it's really a
846
if self._directory_is_tree_reference(path):
847
kind = 'tree-reference'
848
return kind, None, None, None
849
elif kind == 'symlink':
850
target = osutils.readlink(abspath)
851
return ('symlink', None, None, target)
853
return (kind, None, None, None)
855
def _file_content_summary(self, path, stat_result):
856
size = stat_result.st_size
857
executable = self._is_executable_from_path_and_stat(path, stat_result)
858
# try for a stat cache lookup
859
return ('file', size, executable, self._sha_from_stat(
862
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
863
"""Common ghost checking functionality from set_parent_*.
865
This checks that the left hand-parent exists if there are any
868
if len(revision_ids) > 0:
869
leftmost_id = revision_ids[0]
870
if (not allow_leftmost_as_ghost and not
871
self.branch.repository.has_revision(leftmost_id)):
872
raise errors.GhostRevisionUnusableHere(leftmost_id)
874
def _set_merges_from_parent_ids(self, parent_ids):
875
merges = parent_ids[1:]
876
self._transport.put_bytes('pending-merges', '\n'.join(merges),
877
mode=self.bzrdir._get_file_mode())
879
def _filter_parent_ids_by_ancestry(self, revision_ids):
880
"""Check that all merged revisions are proper 'heads'.
882
This will always return the first revision_id, and any merged revisions
885
if len(revision_ids) == 0:
887
graph = self.branch.repository.get_graph()
888
heads = graph.heads(revision_ids)
889
new_revision_ids = revision_ids[:1]
890
for revision_id in revision_ids[1:]:
891
if revision_id in heads and revision_id not in new_revision_ids:
892
new_revision_ids.append(revision_id)
893
if new_revision_ids != revision_ids:
894
trace.mutter('requested to set revision_ids = %s,'
895
' but filtered to %s', revision_ids, new_revision_ids)
896
return new_revision_ids
898
@needs_tree_write_lock
899
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
900
"""Set the parent ids to revision_ids.
902
See also set_parent_trees. This api will try to retrieve the tree data
903
for each element of revision_ids from the trees repository. If you have
904
tree data already available, it is more efficient to use
905
set_parent_trees rather than set_parent_ids. set_parent_ids is however
906
an easier API to use.
908
:param revision_ids: The revision_ids to set as the parent ids of this
909
working tree. Any of these may be ghosts.
911
self._check_parents_for_ghosts(revision_ids,
912
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
913
for revision_id in revision_ids:
914
_mod_revision.check_not_reserved_id(revision_id)
916
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
918
if len(revision_ids) > 0:
919
self.set_last_revision(revision_ids[0])
921
self.set_last_revision(_mod_revision.NULL_REVISION)
923
self._set_merges_from_parent_ids(revision_ids)
925
@needs_tree_write_lock
926
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
927
"""See MutableTree.set_parent_trees."""
928
parent_ids = [rev for (rev, tree) in parents_list]
929
for revision_id in parent_ids:
930
_mod_revision.check_not_reserved_id(revision_id)
932
self._check_parents_for_ghosts(parent_ids,
933
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
935
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
937
if len(parent_ids) == 0:
938
leftmost_parent_id = _mod_revision.NULL_REVISION
939
leftmost_parent_tree = None
941
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
943
if self._change_last_revision(leftmost_parent_id):
944
if leftmost_parent_tree is None:
945
# If we don't have a tree, fall back to reading the
946
# parent tree from the repository.
947
self._cache_basis_inventory(leftmost_parent_id)
949
inv = leftmost_parent_tree.inventory
950
xml = self._create_basis_xml_from_inventory(
951
leftmost_parent_id, inv)
952
self._write_basis_inventory(xml)
953
self._set_merges_from_parent_ids(parent_ids)
955
@needs_tree_write_lock
956
def set_pending_merges(self, rev_list):
957
parents = self.get_parent_ids()
958
leftmost = parents[:1]
959
new_parents = leftmost + rev_list
960
self.set_parent_ids(new_parents)
962
@needs_tree_write_lock
963
def set_merge_modified(self, modified_hashes):
965
for file_id, hash in modified_hashes.iteritems():
966
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
967
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
969
def _sha_from_stat(self, path, stat_result):
970
"""Get a sha digest from the tree's stat cache.
972
The default implementation assumes no stat cache is present.
974
:param path: The path.
975
:param stat_result: The stat result being looked up.
979
def _put_rio(self, filename, stanzas, header):
980
self._must_be_locked()
981
my_file = rio_file(stanzas, header)
982
self._transport.put_file(filename, my_file,
983
mode=self.bzrdir._get_file_mode())
985
@needs_write_lock # because merge pulls data into the branch.
986
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
987
merge_type=None, force=False):
988
"""Merge from a branch into this working tree.
990
:param branch: The branch to merge from.
991
:param to_revision: If non-None, the merge will merge to to_revision,
992
but not beyond it. to_revision does not need to be in the history
993
of the branch when it is supplied. If None, to_revision defaults to
994
branch.last_revision().
996
from bzrlib.merge import Merger, Merge3Merger
997
merger = Merger(self.branch, this_tree=self)
998
# check that there are no local alterations
999
if not force and self.has_changes():
1000
raise errors.UncommittedChanges(self)
1001
if to_revision is None:
1002
to_revision = _mod_revision.ensure_null(branch.last_revision())
1003
merger.other_rev_id = to_revision
1004
if _mod_revision.is_null(merger.other_rev_id):
1005
raise errors.NoCommits(branch)
1006
self.branch.fetch(branch, last_revision=merger.other_rev_id)
1007
merger.other_basis = merger.other_rev_id
1008
merger.other_tree = self.branch.repository.revision_tree(
1009
merger.other_rev_id)
1010
merger.other_branch = branch
1011
if from_revision is None:
1014
merger.set_base_revision(from_revision, branch)
1015
if merger.base_rev_id == merger.other_rev_id:
1016
raise errors.PointlessMerge
1017
merger.backup_files = False
1018
if merge_type is None:
1019
merger.merge_type = Merge3Merger
1021
merger.merge_type = merge_type
1022
merger.set_interesting_files(None)
1023
merger.show_base = False
1024
merger.reprocess = False
1025
conflicts = merger.do_merge()
1026
merger.set_pending()
1030
def merge_modified(self):
1031
"""Return a dictionary of files modified by a merge.
1033
The list is initialized by WorkingTree.set_merge_modified, which is
1034
typically called after we make some automatic updates to the tree
1037
This returns a map of file_id->sha1, containing only files which are
1038
still in the working inventory and have that text hash.
1041
hashfile = self._transport.get('merge-hashes')
1042
except errors.NoSuchFile:
1047
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
1048
raise errors.MergeModifiedFormatError()
1049
except StopIteration:
1050
raise errors.MergeModifiedFormatError()
1051
for s in RioReader(hashfile):
1052
# RioReader reads in Unicode, so convert file_ids back to utf8
1053
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
1054
if file_id not in self.inventory:
1056
text_hash = s.get("hash")
1057
if text_hash == self.get_file_sha1(file_id):
1058
merge_hashes[file_id] = text_hash
1064
def mkdir(self, path, file_id=None):
1065
"""See MutableTree.mkdir()."""
1067
file_id = generate_ids.gen_file_id(os.path.basename(path))
1068
os.mkdir(self.abspath(path))
1069
self.add(path, file_id, 'directory')
231
1072
def get_symlink_target(self, file_id):
232
return os.readlink(self.id2abspath(file_id))
234
def file_class(self, filename):
235
if self.path2id(filename):
237
elif self.is_ignored(filename):
243
def list_files(self):
244
"""Recursively list all files as (path, class, kind, id).
1073
abspath = self.id2abspath(file_id)
1074
target = osutils.readlink(abspath)
1078
def subsume(self, other_tree):
1079
def add_children(inventory, entry):
1080
for child_entry in entry.children.values():
1081
inventory._byid[child_entry.file_id] = child_entry
1082
if child_entry.kind == 'directory':
1083
add_children(inventory, child_entry)
1084
if other_tree.get_root_id() == self.get_root_id():
1085
raise errors.BadSubsumeSource(self, other_tree,
1086
'Trees have the same root')
1088
other_tree_path = self.relpath(other_tree.basedir)
1089
except errors.PathNotChild:
1090
raise errors.BadSubsumeSource(self, other_tree,
1091
'Tree is not contained by the other')
1092
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1093
if new_root_parent is None:
1094
raise errors.BadSubsumeSource(self, other_tree,
1095
'Parent directory is not versioned.')
1096
# We need to ensure that the result of a fetch will have a
1097
# versionedfile for the other_tree root, and only fetching into
1098
# RepositoryKnit2 guarantees that.
1099
if not self.branch.repository.supports_rich_root():
1100
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1101
other_tree.lock_tree_write()
1103
new_parents = other_tree.get_parent_ids()
1104
other_root = other_tree.inventory.root
1105
other_root.parent_id = new_root_parent
1106
other_root.name = osutils.basename(other_tree_path)
1107
self.inventory.add(other_root)
1108
add_children(self.inventory, other_root)
1109
self._write_inventory(self.inventory)
1110
# normally we don't want to fetch whole repositories, but i think
1111
# here we really do want to consolidate the whole thing.
1112
for parent_id in other_tree.get_parent_ids():
1113
self.branch.fetch(other_tree.branch, parent_id)
1114
self.add_parent_tree_id(parent_id)
1117
other_tree.bzrdir.retire_bzrdir()
1119
def _setup_directory_is_tree_reference(self):
1120
if self._branch.repository._format.supports_tree_reference:
1121
self._directory_is_tree_reference = \
1122
self._directory_may_be_tree_reference
1124
self._directory_is_tree_reference = \
1125
self._directory_is_never_tree_reference
1127
def _directory_is_never_tree_reference(self, relpath):
1130
def _directory_may_be_tree_reference(self, relpath):
1131
# as a special case, if a directory contains control files then
1132
# it's a tree reference, except that the root of the tree is not
1133
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1134
# TODO: We could ask all the control formats whether they
1135
# recognize this directory, but at the moment there's no cheap api
1136
# to do that. Since we probably can only nest bzr checkouts and
1137
# they always use this name it's ok for now. -- mbp 20060306
1139
# FIXME: There is an unhandled case here of a subdirectory
1140
# containing .bzr but not a branch; that will probably blow up
1141
# when you try to commit it. It might happen if there is a
1142
# checkout in a subdirectory. This can be avoided by not adding
1145
@needs_tree_write_lock
1146
def extract(self, file_id, format=None):
1147
"""Extract a subtree from this tree.
1149
A new branch will be created, relative to the path for this tree.
1153
segments = osutils.splitpath(path)
1154
transport = self.branch.bzrdir.root_transport
1155
for name in segments:
1156
transport = transport.clone(name)
1157
transport.ensure_base()
1160
sub_path = self.id2path(file_id)
1161
branch_transport = mkdirs(sub_path)
1163
format = self.bzrdir.cloning_metadir()
1164
branch_transport.ensure_base()
1165
branch_bzrdir = format.initialize_on_transport(branch_transport)
1167
repo = branch_bzrdir.find_repository()
1168
except errors.NoRepositoryPresent:
1169
repo = branch_bzrdir.create_repository()
1170
if not repo.supports_rich_root():
1171
raise errors.RootNotRich()
1172
new_branch = branch_bzrdir.create_branch()
1173
new_branch.pull(self.branch)
1174
for parent_id in self.get_parent_ids():
1175
new_branch.fetch(self.branch, parent_id)
1176
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1177
if tree_transport.base != branch_transport.base:
1178
tree_bzrdir = format.initialize_on_transport(tree_transport)
1179
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1180
target_branch=new_branch)
1182
tree_bzrdir = branch_bzrdir
1183
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1184
wt.set_parent_ids(self.get_parent_ids())
1185
my_inv = self.inventory
1186
child_inv = inventory.Inventory(root_id=None)
1187
new_root = my_inv[file_id]
1188
my_inv.remove_recursive_id(file_id)
1189
new_root.parent_id = None
1190
child_inv.add(new_root)
1191
self._write_inventory(my_inv)
1192
wt._write_inventory(child_inv)
1195
def _serialize(self, inventory, out_file):
1196
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1199
def _deserialize(selt, in_file):
1200
return xml5.serializer_v5.read_inventory(in_file)
1203
"""Write the in memory inventory to disk."""
1204
# TODO: Maybe this should only write on dirty ?
1205
if self._control_files._lock_mode != 'w':
1206
raise errors.NotWriteLocked(self)
1208
self._serialize(self._inventory, sio)
1210
self._transport.put_file('inventory', sio,
1211
mode=self.bzrdir._get_file_mode())
1212
self._inventory_is_modified = False
1214
def _kind(self, relpath):
1215
return osutils.file_kind(self.abspath(relpath))
1217
def list_files(self, include_root=False, from_dir=None, recursive=True):
1218
"""List all files as (path, class, kind, id, entry).
246
1220
Lists, but does not descend into unversioned directories.
248
1221
This does not include files that have been deleted in this
1222
tree. Skips the control directory.
251
Skips the control directory.
1224
:param include_root: if True, return an entry for the root
1225
:param from_dir: start from this directory or None for the root
1226
:param recursive: whether to recurse into subdirectories or not
253
inv = self._inventory
255
def descend(from_dir_relpath, from_dir_id, dp):
1228
# list_files is an iterator, so @needs_read_lock doesn't work properly
1229
# with it. So callers should be careful to always read_lock the tree.
1230
if not self.is_locked():
1231
raise errors.ObjectNotLocked(self)
1233
inv = self.inventory
1234
if from_dir is None and include_root is True:
1235
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1236
# Convert these into local objects to save lookup times
1237
pathjoin = osutils.pathjoin
1238
file_kind = self._kind
1240
# transport.base ends in a slash, we want the piece
1241
# between the last two slashes
1242
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1244
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1246
# directory file_id, relative path, absolute path, reverse sorted children
1247
if from_dir is not None:
1248
from_dir_id = inv.path2id(from_dir)
1249
if from_dir_id is None:
1250
# Directory not versioned
1252
from_dir_abspath = pathjoin(self.basedir, from_dir)
1254
from_dir_id = inv.root.file_id
1255
from_dir_abspath = self.basedir
1256
children = os.listdir(from_dir_abspath)
1258
# jam 20060527 The kernel sized tree seems equivalent whether we
1259
# use a deque and popleft to keep them sorted, or if we use a plain
1260
# list and just reverse() them.
1261
children = collections.deque(children)
1262
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1264
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1267
f = children.popleft()
259
1268
## TODO: If we find a subdirectory with its own .bzr
260
1269
## directory, then that is a separate tree and we
261
1270
## should exclude it.
262
if bzrlib.BZRDIR == f:
1272
# the bzrdir for this tree
1273
if transport_base_dir == f:
266
fp = appendpath(from_dir_relpath, f)
1276
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1277
# and 'f' doesn't begin with one, we can do a string op, rather
1278
# than the checks of pathjoin(), all relative paths will have an extra slash
1280
fp = from_dir_relpath + '/' + f
269
fap = appendpath(dp, f)
271
f_ie = inv.get_child(from_dir_id, f)
1283
fap = from_dir_abspath + '/' + f
1285
dir_ie = inv[from_dir_id]
1286
if dir_ie.kind == 'directory':
1287
f_ie = dir_ie.children.get(f)
274
elif self.is_ignored(fp):
1292
elif self.is_ignored(fp[1:]):
1295
# we may not have found this file, because of a unicode
1296
# issue, or because the directory was actually a symlink.
1297
f_norm, can_access = osutils.normalized_filename(f)
1298
if f == f_norm or not can_access:
1299
# No change, so treat this file normally
1302
# this file can be accessed by a normalized path
1303
# check again if it is versioned
1304
# these lines are repeated here for performance
1306
fp = from_dir_relpath + '/' + f
1307
fap = from_dir_abspath + '/' + f
1308
f_ie = inv.get_child(from_dir_id, f)
1311
elif self.is_ignored(fp[1:]):
279
1316
fk = file_kind(fap)
283
raise BzrCheckError("file %r entered as kind %r id %r, "
285
% (fap, f_ie.kind, f_ie.file_id, fk))
287
1318
# make a last minute entry
1320
yield fp[1:], c, fk, f_ie.file_id, f_ie
291
if fk == 'directory':
292
entry = TreeDirectory()
295
elif fk == 'symlink':
300
yield fp, c, fk, (f_ie and f_ie.file_id), entry
1323
yield fp[1:], c, fk, None, fk_entries[fk]()
1325
yield fp[1:], c, fk, None, TreeEntry()
302
1328
if fk != 'directory':
306
# don't descend unversioned directories
309
for ff in descend(fp, f_ie.file_id, fap):
312
for f in descend('', inv.root.file_id, self.basedir):
1331
# But do this child first if recursing down
1333
new_children = os.listdir(fap)
1335
new_children = collections.deque(new_children)
1336
stack.append((f_ie.file_id, fp, fap, new_children))
1337
# Break out of inner loop,
1338
# so that we start outer loop with child
1341
# if we finished all children, pop it off the stack
1344
@needs_tree_write_lock
1345
def move(self, from_paths, to_dir=None, after=False):
1348
to_dir must exist in the inventory.
1350
If to_dir exists and is a directory, the files are moved into
1351
it, keeping their old names.
1353
Note that to_dir is only the last component of the new name;
1354
this doesn't change the directory.
1356
For each entry in from_paths the move mode will be determined
1359
The first mode moves the file in the filesystem and updates the
1360
inventory. The second mode only updates the inventory without
1361
touching the file on the filesystem. This is the new mode introduced
1364
move uses the second mode if 'after == True' and the target is not
1365
versioned but present in the working tree.
1367
move uses the second mode if 'after == False' and the source is
1368
versioned but no longer in the working tree, and the target is not
1369
versioned but present in the working tree.
1371
move uses the first mode if 'after == False' and the source is
1372
versioned and present in the working tree, and the target is not
1373
versioned and not present in the working tree.
1375
Everything else results in an error.
1377
This returns a list of (from_path, to_path) pairs for each
1378
entry that is moved.
1383
# check for deprecated use of signature
1385
raise TypeError('You must supply a target directory')
1386
# check destination directory
1387
if isinstance(from_paths, basestring):
1389
inv = self.inventory
1390
to_abs = self.abspath(to_dir)
1391
if not isdir(to_abs):
1392
raise errors.BzrMoveFailedError('',to_dir,
1393
errors.NotADirectory(to_abs))
1394
if not self.has_filename(to_dir):
1395
raise errors.BzrMoveFailedError('',to_dir,
1396
errors.NotInWorkingDirectory(to_dir))
1397
to_dir_id = inv.path2id(to_dir)
1398
if to_dir_id is None:
1399
raise errors.BzrMoveFailedError('',to_dir,
1400
errors.NotVersionedError(path=to_dir))
1402
to_dir_ie = inv[to_dir_id]
1403
if to_dir_ie.kind != 'directory':
1404
raise errors.BzrMoveFailedError('',to_dir,
1405
errors.NotADirectory(to_abs))
1407
# create rename entries and tuples
1408
for from_rel in from_paths:
1409
from_tail = splitpath(from_rel)[-1]
1410
from_id = inv.path2id(from_rel)
1412
raise errors.BzrMoveFailedError(from_rel,to_dir,
1413
errors.NotVersionedError(path=from_rel))
1415
from_entry = inv[from_id]
1416
from_parent_id = from_entry.parent_id
1417
to_rel = pathjoin(to_dir, from_tail)
1418
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1420
from_tail=from_tail,
1421
from_parent_id=from_parent_id,
1422
to_rel=to_rel, to_tail=from_tail,
1423
to_parent_id=to_dir_id)
1424
rename_entries.append(rename_entry)
1425
rename_tuples.append((from_rel, to_rel))
1427
# determine which move mode to use. checks also for movability
1428
rename_entries = self._determine_mv_mode(rename_entries, after)
1430
original_modified = self._inventory_is_modified
1433
self._inventory_is_modified = True
1434
self._move(rename_entries)
1436
# restore the inventory on error
1437
self._inventory_is_modified = original_modified
1439
self._write_inventory(inv)
1440
return rename_tuples
1442
def _determine_mv_mode(self, rename_entries, after=False):
1443
"""Determines for each from-to pair if both inventory and working tree
1444
or only the inventory has to be changed.
1446
Also does basic plausability tests.
1448
inv = self.inventory
1450
for rename_entry in rename_entries:
1451
# store to local variables for easier reference
1452
from_rel = rename_entry.from_rel
1453
from_id = rename_entry.from_id
1454
to_rel = rename_entry.to_rel
1455
to_id = inv.path2id(to_rel)
1456
only_change_inv = False
1458
# check the inventory for source and destination
1460
raise errors.BzrMoveFailedError(from_rel,to_rel,
1461
errors.NotVersionedError(path=from_rel))
1462
if to_id is not None:
1463
raise errors.BzrMoveFailedError(from_rel,to_rel,
1464
errors.AlreadyVersionedError(path=to_rel))
1466
# try to determine the mode for rename (only change inv or change
1467
# inv and file system)
1469
if not self.has_filename(to_rel):
1470
raise errors.BzrMoveFailedError(from_id,to_rel,
1471
errors.NoSuchFile(path=to_rel,
1472
extra="New file has not been created yet"))
1473
only_change_inv = True
1474
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1475
only_change_inv = True
1476
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1477
only_change_inv = False
1478
elif (not self.case_sensitive
1479
and from_rel.lower() == to_rel.lower()
1480
and self.has_filename(from_rel)):
1481
only_change_inv = False
1483
# something is wrong, so lets determine what exactly
1484
if not self.has_filename(from_rel) and \
1485
not self.has_filename(to_rel):
1486
raise errors.BzrRenameFailedError(from_rel,to_rel,
1487
errors.PathsDoNotExist(paths=(str(from_rel),
1490
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1491
rename_entry.only_change_inv = only_change_inv
1492
return rename_entries
1494
def _move(self, rename_entries):
1495
"""Moves a list of files.
1497
Depending on the value of the flag 'only_change_inv', the
1498
file will be moved on the file system or not.
1500
inv = self.inventory
1503
for entry in rename_entries:
1505
self._move_entry(entry)
1507
self._rollback_move(moved)
1511
def _rollback_move(self, moved):
1512
"""Try to rollback a previous move in case of an filesystem error."""
1513
inv = self.inventory
1516
self._move_entry(WorkingTree._RenameEntry(
1517
entry.to_rel, entry.from_id,
1518
entry.to_tail, entry.to_parent_id, entry.from_rel,
1519
entry.from_tail, entry.from_parent_id,
1520
entry.only_change_inv))
1521
except errors.BzrMoveFailedError, e:
1522
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1523
" The working tree is in an inconsistent state."
1524
" Please consider doing a 'bzr revert'."
1525
" Error message is: %s" % e)
1527
def _move_entry(self, entry):
1528
inv = self.inventory
1529
from_rel_abs = self.abspath(entry.from_rel)
1530
to_rel_abs = self.abspath(entry.to_rel)
1531
if from_rel_abs == to_rel_abs:
1532
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1533
"Source and target are identical.")
1535
if not entry.only_change_inv:
1537
osutils.rename(from_rel_abs, to_rel_abs)
1539
raise errors.BzrMoveFailedError(entry.from_rel,
1541
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1543
@needs_tree_write_lock
1544
def rename_one(self, from_rel, to_rel, after=False):
1547
This can change the directory or the filename or both.
1549
rename_one has several 'modes' to work. First, it can rename a physical
1550
file and change the file_id. That is the normal mode. Second, it can
1551
only change the file_id without touching any physical file. This is
1552
the new mode introduced in version 0.15.
1554
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1555
versioned but present in the working tree.
1557
rename_one uses the second mode if 'after == False' and 'from_rel' is
1558
versioned but no longer in the working tree, and 'to_rel' is not
1559
versioned but present in the working tree.
1561
rename_one uses the first mode if 'after == False' and 'from_rel' is
1562
versioned and present in the working tree, and 'to_rel' is not
1563
versioned and not present in the working tree.
1565
Everything else results in an error.
1567
inv = self.inventory
1570
# create rename entries and tuples
1571
from_tail = splitpath(from_rel)[-1]
1572
from_id = inv.path2id(from_rel)
1574
# if file is missing in the inventory maybe it's in the basis_tree
1575
basis_tree = self.branch.basis_tree()
1576
from_id = basis_tree.path2id(from_rel)
1578
raise errors.BzrRenameFailedError(from_rel,to_rel,
1579
errors.NotVersionedError(path=from_rel))
1580
# put entry back in the inventory so we can rename it
1581
from_entry = basis_tree.inventory[from_id].copy()
1584
from_entry = inv[from_id]
1585
from_parent_id = from_entry.parent_id
1586
to_dir, to_tail = os.path.split(to_rel)
1587
to_dir_id = inv.path2id(to_dir)
1588
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1590
from_tail=from_tail,
1591
from_parent_id=from_parent_id,
1592
to_rel=to_rel, to_tail=to_tail,
1593
to_parent_id=to_dir_id)
1594
rename_entries.append(rename_entry)
1596
# determine which move mode to use. checks also for movability
1597
rename_entries = self._determine_mv_mode(rename_entries, after)
1599
# check if the target changed directory and if the target directory is
1601
if to_dir_id is None:
1602
raise errors.BzrMoveFailedError(from_rel,to_rel,
1603
errors.NotVersionedError(path=to_dir))
1605
# all checks done. now we can continue with our actual work
1606
mutter('rename_one:\n'
1611
' to_dir_id {%s}\n',
1612
from_id, from_rel, to_rel, to_dir, to_dir_id)
1614
self._move(rename_entries)
1615
self._write_inventory(inv)
1617
class _RenameEntry(object):
1618
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1619
to_rel, to_tail, to_parent_id, only_change_inv=False):
1620
self.from_rel = from_rel
1621
self.from_id = from_id
1622
self.from_tail = from_tail
1623
self.from_parent_id = from_parent_id
1624
self.to_rel = to_rel
1625
self.to_tail = to_tail
1626
self.to_parent_id = to_parent_id
1627
self.only_change_inv = only_change_inv
317
1630
def unknowns(self):
318
for subp in self.extras():
319
if not self.is_ignored(subp):
322
def iter_conflicts(self):
324
for path in (s[0] for s in self.list_files()):
325
stem = get_conflicted_stem(path)
328
if stem not in conflicted:
1631
"""Return all unknown files.
1633
These are files in the working directory that are not versioned or
1634
control files or ignored.
1636
# force the extras method to be fully executed before returning, to
1637
# prevent race conditions with the lock
1639
[subp for subp in self.extras() if not self.is_ignored(subp)])
1641
@needs_tree_write_lock
1642
def unversion(self, file_ids):
1643
"""Remove the file ids in file_ids from the current versioned set.
1645
When a file_id is unversioned, all of its children are automatically
1648
:param file_ids: The file ids to stop versioning.
1649
:raises: NoSuchId if any fileid is not currently versioned.
1651
for file_id in file_ids:
1652
if file_id not in self._inventory:
1653
raise errors.NoSuchId(self, file_id)
1654
for file_id in file_ids:
1655
if self._inventory.has_id(file_id):
1656
self._inventory.remove_recursive_id(file_id)
1658
# in the future this should just set a dirty bit to wait for the
1659
# final unlock. However, until all methods of workingtree start
1660
# with the current in -memory inventory rather than triggering
1661
# a read, it is more complex - we need to teach read_inventory
1662
# to know when to read, and when to not read first... and possibly
1663
# to save first when the in memory one may be corrupted.
1664
# so for now, we just only write it if it is indeed dirty.
1666
self._write_inventory(self._inventory)
332
1668
@needs_write_lock
333
def pull(self, source, remember=False, clobber=False):
334
from bzrlib.merge import merge_inner
1669
def pull(self, source, overwrite=False, stop_revision=None,
1670
change_reporter=None, possible_transports=None, local=False,
335
1672
source.lock_read()
337
old_revision_history = self.branch.revision_history()
339
self.branch.update_revisions(source)
340
except DivergedBranches:
343
self.branch.set_revision_history(source.revision_history())
344
new_revision_history = self.branch.revision_history()
345
if new_revision_history != old_revision_history:
346
if len(old_revision_history):
347
other_revision = old_revision_history[-1]
349
other_revision = None
350
merge_inner(self.branch,
351
self.branch.basis_tree(),
352
self.branch.revision_tree(other_revision))
353
if self.branch.get_parent() is None or remember:
354
self.branch.set_parent(source.base)
1674
old_revision_info = self.branch.last_revision_info()
1675
basis_tree = self.basis_tree()
1676
count = self.branch.pull(source, overwrite, stop_revision,
1677
possible_transports=possible_transports,
1679
new_revision_info = self.branch.last_revision_info()
1680
if new_revision_info != old_revision_info:
1681
repository = self.branch.repository
1682
basis_tree.lock_read()
1684
new_basis_tree = self.branch.basis_tree()
1691
change_reporter=change_reporter,
1692
show_base=show_base)
1693
basis_root_id = basis_tree.get_root_id()
1694
new_root_id = new_basis_tree.get_root_id()
1695
if basis_root_id != new_root_id:
1696
self.set_root_id(new_root_id)
1699
# TODO - dedup parents list with things merged by pull ?
1700
# reuse the revisiontree we merged against to set the new
1702
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1703
# we have to pull the merge trees out again, because
1704
# merge_inner has set the ids. - this corner is not yet
1705
# layered well enough to prevent double handling.
1706
# XXX TODO: Fix the double handling: telling the tree about
1707
# the already known parent data is wasteful.
1708
merges = self.get_parent_ids()[1:]
1709
parent_trees.extend([
1710
(parent, repository.revision_tree(parent)) for
1712
self.set_parent_trees(parent_trees)
1718
def put_file_bytes_non_atomic(self, file_id, bytes):
1719
"""See MutableTree.put_file_bytes_non_atomic."""
1720
stream = file(self.id2abspath(file_id), 'wb')
1725
# TODO: update the hashcache here ?
358
1727
def extras(self):
359
"""Yield all unknown files in this WorkingTree.
1728
"""Yield all unversioned files in this WorkingTree.
361
If there are any unknown directories then only the directory is
362
returned, not all its children. But if there are unknown files
1730
If there are any unversioned directories then only the directory is
1731
returned, not all its children. But if there are unversioned files
363
1732
under a versioned subdirectory, they are returned.
365
1734
Currently returned depth-first, sorted by name within directories.
1735
This is the same order used by 'osutils.walkdirs'.
367
1737
## TODO: Work from given directory downwards
368
1738
for path, dir_entry in self.inventory.directories():
369
mutter("search for unknowns in %r" % path)
1739
# mutter("search for unknowns in %r", path)
370
1740
dirabs = self.abspath(path)
371
1741
if not isdir(dirabs):
372
1742
# e.g. directory deleted
376
1746
for subf in os.listdir(dirabs):
378
and (subf not in dir_entry.children)):
1747
if self.bzrdir.is_control_filename(subf):
1749
if subf not in dir_entry.children:
1752
can_access) = osutils.normalized_filename(subf)
1753
except UnicodeDecodeError:
1754
path_os_enc = path.encode(osutils._fs_enc)
1755
relpath = path_os_enc + '/' + subf
1756
raise errors.BadFilenameEncoding(relpath,
1758
if subf_norm != subf and can_access:
1759
if subf_norm not in dir_entry.children:
1760
fl.append(subf_norm)
383
subp = appendpath(path, subf)
1766
subp = pathjoin(path, subf)
387
1769
def ignored_files(self):
388
1770
"""Yield list of PATH, IGNORE_PATTERN"""
389
1771
for subp in self.extras():
390
1772
pat = self.is_ignored(subp)
395
1776
def get_ignore_list(self):
396
1777
"""Return list of ignore patterns.
398
1779
Cached in the Tree object after the first call.
400
if hasattr(self, '_ignorelist'):
401
return self._ignorelist
1781
ignoreset = getattr(self, '_ignoreset', None)
1782
if ignoreset is not None:
403
l = bzrlib.DEFAULT_IGNORE[:]
1785
ignore_globs = set()
1786
ignore_globs.update(ignores.get_runtime_ignores())
1787
ignore_globs.update(ignores.get_user_ignores())
404
1788
if self.has_filename(bzrlib.IGNORE_FILENAME):
405
1789
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
406
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1791
ignore_globs.update(ignores.parse_ignore_file(f))
1794
self._ignoreset = ignore_globs
1797
def _flush_ignore_list_cache(self):
1798
"""Resets the cached ignore list to force a cache rebuild."""
1799
self._ignoreset = None
1800
self._ignoreglobster = None
411
1802
def is_ignored(self, filename):
412
1803
r"""Check whether the filename matches an ignore pattern.
414
1805
Patterns containing '/' or '\' need to match the whole path;
415
others match against only the last component.
1806
others match against only the last component. Patterns starting
1807
with '!' are ignore exceptions. Exceptions take precedence
1808
over regular patterns and cause the filename to not be ignored.
417
1810
If the file is ignored, returns the pattern which caused it to
418
1811
be ignored, otherwise None. So this can simply be used as a
419
1812
boolean if desired."""
421
# TODO: Use '**' to match directories, and other extended
422
# globbing stuff from cvs/rsync.
424
# XXX: fnmatch is actually not quite what we want: it's only
425
# approximately the same as real Unix fnmatch, and doesn't
426
# treat dotfiles correctly and allows * to match /.
427
# Eventually it should be replaced with something more
430
for pat in self.get_ignore_list():
431
if '/' in pat or '\\' in pat:
433
# as a special case, you can put ./ at the start of a
434
# pattern; this is good to match in the top-level
437
if (pat[:2] == './') or (pat[:2] == '.\\'):
441
if fnmatch.fnmatchcase(filename, newpat):
444
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1813
if getattr(self, '_ignoreglobster', None) is None:
1814
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1815
return self._ignoreglobster.match(filename)
449
1817
def kind(self, file_id):
450
1818
return file_kind(self.id2abspath(file_id))
1820
def stored_kind(self, file_id):
1821
"""See Tree.stored_kind"""
1822
return self.inventory[file_id].kind
1824
def _comparison_data(self, entry, path):
1825
abspath = self.abspath(path)
1827
stat_value = os.lstat(abspath)
1829
if getattr(e, 'errno', None) == errno.ENOENT:
1836
mode = stat_value.st_mode
1837
kind = osutils.file_kind_from_stat_mode(mode)
1838
if not supports_executable():
1839
executable = entry is not None and entry.executable
1841
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1842
return kind, executable, stat_value
1844
def _file_size(self, entry, stat_value):
1845
return stat_value.st_size
1847
def last_revision(self):
1848
"""Return the last revision of the branch for this tree.
1850
This format tree does not support a separate marker for last-revision
1851
compared to the branch.
1853
See MutableTree.last_revision
1855
return self._last_revision()
1858
def _last_revision(self):
1859
"""helper for get_parent_ids."""
1860
return _mod_revision.ensure_null(self.branch.last_revision())
1862
def is_locked(self):
1863
return self._control_files.is_locked()
1865
def _must_be_locked(self):
1866
if not self.is_locked():
1867
raise errors.ObjectNotLocked(self)
452
1869
def lock_read(self):
453
"""See Branch.lock_read, and WorkingTree.unlock."""
454
return self.branch.lock_read()
1870
"""Lock the tree for reading.
1872
This also locks the branch, and can be unlocked via self.unlock().
1874
:return: A bzrlib.lock.LogicalLockResult.
1876
if not self.is_locked():
1878
self.branch.lock_read()
1880
self._control_files.lock_read()
1881
return LogicalLockResult(self.unlock)
1883
self.branch.unlock()
1886
def lock_tree_write(self):
1887
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1889
:return: A bzrlib.lock.LogicalLockResult.
1891
if not self.is_locked():
1893
self.branch.lock_read()
1895
self._control_files.lock_write()
1896
return LogicalLockResult(self.unlock)
1898
self.branch.unlock()
456
1901
def lock_write(self):
457
"""See Branch.lock_write, and WorkingTree.unlock."""
458
return self.branch.lock_write()
461
def remove(self, files, verbose=False):
462
"""Remove nominated files from the working inventory..
464
This does not remove their text. This does not run on XXX on what? RBC
466
TODO: Refuse to remove modified files unless --force is given?
468
TODO: Do something useful with directories.
470
TODO: Should this remove the text or not? Tough call; not
471
removing may be useful and the user can just use use rm, and
472
is the opposite of add. Removing it is consistent with most
473
other tools. Maybe an option.
475
## TODO: Normalize names
476
## TODO: Remove nested loops; better scalability
1902
"""See MutableTree.lock_write, and WorkingTree.unlock.
1904
:return: A bzrlib.lock.LogicalLockResult.
1906
if not self.is_locked():
1908
self.branch.lock_write()
1910
self._control_files.lock_write()
1911
return LogicalLockResult(self.unlock)
1913
self.branch.unlock()
1916
def get_physical_lock_status(self):
1917
return self._control_files.get_physical_lock_status()
1919
def _basis_inventory_name(self):
1920
return 'basis-inventory-cache'
1922
def _reset_data(self):
1923
"""Reset transient data that cannot be revalidated."""
1924
self._inventory_is_modified = False
1925
f = self._transport.get('inventory')
1927
result = self._deserialize(f)
1930
self._set_inventory(result, dirty=False)
1932
@needs_tree_write_lock
1933
def set_last_revision(self, new_revision):
1934
"""Change the last revision in the working tree."""
1935
if self._change_last_revision(new_revision):
1936
self._cache_basis_inventory(new_revision)
1938
def _change_last_revision(self, new_revision):
1939
"""Template method part of set_last_revision to perform the change.
1941
This is used to allow WorkingTree3 instances to not affect branch
1942
when their last revision is set.
1944
if _mod_revision.is_null(new_revision):
1945
self.branch.set_revision_history([])
1948
self.branch.generate_revision_history(new_revision)
1949
except errors.NoSuchRevision:
1950
# not present in the repo - dont try to set it deeper than the tip
1951
self.branch.set_revision_history([new_revision])
1954
def _write_basis_inventory(self, xml):
1955
"""Write the basis inventory XML to the basis-inventory file"""
1956
path = self._basis_inventory_name()
1958
self._transport.put_file(path, sio,
1959
mode=self.bzrdir._get_file_mode())
1961
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1962
"""Create the text that will be saved in basis-inventory"""
1963
inventory.revision_id = revision_id
1964
return xml7.serializer_v7.write_inventory_to_string(inventory)
1966
def _cache_basis_inventory(self, new_revision):
1967
"""Cache new_revision as the basis inventory."""
1968
# TODO: this should allow the ready-to-use inventory to be passed in,
1969
# as commit already has that ready-to-use [while the format is the
1972
# this double handles the inventory - unpack and repack -
1973
# but is easier to understand. We can/should put a conditional
1974
# in here based on whether the inventory is in the latest format
1975
# - perhaps we should repack all inventories on a repository
1977
# the fast path is to copy the raw xml from the repository. If the
1978
# xml contains 'revision_id="', then we assume the right
1979
# revision_id is set. We must check for this full string, because a
1980
# root node id can legitimately look like 'revision_id' but cannot
1982
xml = self.branch.repository._get_inventory_xml(new_revision)
1983
firstline = xml.split('\n', 1)[0]
1984
if (not 'revision_id="' in firstline or
1985
'format="7"' not in firstline):
1986
inv = self.branch.repository._serializer.read_inventory_from_string(
1988
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1989
self._write_basis_inventory(xml)
1990
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1993
def read_basis_inventory(self):
1994
"""Read the cached basis inventory."""
1995
path = self._basis_inventory_name()
1996
return self._transport.get_bytes(path)
1999
def read_working_inventory(self):
2000
"""Read the working inventory.
2002
:raises errors.InventoryModified: read_working_inventory will fail
2003
when the current in memory inventory has been modified.
2005
# conceptually this should be an implementation detail of the tree.
2006
# XXX: Deprecate this.
2007
# ElementTree does its own conversion from UTF-8, so open in
2009
if self._inventory_is_modified:
2010
raise errors.InventoryModified(self)
2011
f = self._transport.get('inventory')
2013
result = self._deserialize(f)
2016
self._set_inventory(result, dirty=False)
2019
@needs_tree_write_lock
2020
def remove(self, files, verbose=False, to_file=None, keep_files=True,
2022
"""Remove nominated files from the working inventory.
2024
:files: File paths relative to the basedir.
2025
:keep_files: If true, the files will also be kept.
2026
:force: Delete files and directories, even if they are changed and
2027
even if the directories are not empty.
477
2029
if isinstance(files, basestring):
482
# do this before any modifications
2034
all_files = set() # specified and nested files
2035
unknown_nested_files=set()
2037
to_file = sys.stdout
2039
files_to_backup = []
2041
def recurse_directory_to_add_files(directory):
2042
# Recurse directory and add all files
2043
# so we can check if they have changed.
2044
for parent_info, file_infos in self.walkdirs(directory):
2045
for relpath, basename, kind, lstat, fileid, kind in file_infos:
2046
# Is it versioned or ignored?
2047
if self.path2id(relpath):
2048
# Add nested content for deletion.
2049
all_files.add(relpath)
2051
# Files which are not versioned
2052
# should be treated as unknown.
2053
files_to_backup.append(relpath)
2055
for filename in files:
2056
# Get file name into canonical form.
2057
abspath = self.abspath(filename)
2058
filename = self.relpath(abspath)
2059
if len(filename) > 0:
2060
all_files.add(filename)
2061
recurse_directory_to_add_files(filename)
2063
files = list(all_files)
2066
return # nothing to do
2068
# Sort needed to first handle directory content before the directory
2069
files.sort(reverse=True)
2071
# Bail out if we are going to delete files we shouldn't
2072
if not keep_files and not force:
2073
for (file_id, path, content_change, versioned, parent_id, name,
2074
kind, executable) in self.iter_changes(self.basis_tree(),
2075
include_unchanged=True, require_versioned=False,
2076
want_unversioned=True, specific_files=files):
2077
if versioned[0] == False:
2078
# The record is unknown or newly added
2079
files_to_backup.append(path[1])
2080
elif (content_change and (kind[1] is not None) and
2081
osutils.is_inside_any(files, path[1])):
2082
# Versioned and changed, but not deleted, and still
2083
# in one of the dirs to be deleted.
2084
files_to_backup.append(path[1])
2086
def backup(file_to_backup):
2087
backup_name = self.bzrdir._available_backup_name(file_to_backup)
2088
osutils.rename(abs_path, self.abspath(backup_name))
2089
return "removed %s (but kept a copy: %s)" % (file_to_backup,
2092
# Build inv_delta and delete files where applicable,
2093
# do this before any modifications to inventory.
2095
fid = self.path2id(f)
486
# TODO: Perhaps make this just a warning, and continue?
487
# This tends to happen when
488
raise NotVersionedError(path=f)
489
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
491
# having remove it, it must be either ignored or unknown
492
if self.is_ignored(f):
496
show_status(new_status, inv[fid].kind, quotefn(f))
499
self.branch._write_inventory(inv)
2098
message = "%s is not versioned." % (f,)
2101
# having removed it, it must be either ignored or unknown
2102
if self.is_ignored(f):
2106
# XXX: Really should be a more abstract reporter interface
2107
kind_ch = osutils.kind_marker(self.kind(fid))
2108
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2110
inv_delta.append((f, None, fid, None))
2111
message = "removed %s" % (f,)
2114
abs_path = self.abspath(f)
2115
if osutils.lexists(abs_path):
2116
if (osutils.isdir(abs_path) and
2117
len(os.listdir(abs_path)) > 0):
2119
osutils.rmtree(abs_path)
2120
message = "deleted %s" % (f,)
2124
if f in files_to_backup:
2127
osutils.delete_any(abs_path)
2128
message = "deleted %s" % (f,)
2129
elif message is not None:
2130
# Only care if we haven't done anything yet.
2131
message = "%s does not exist." % (f,)
2133
# Print only one message (if any) per file.
2134
if message is not None:
2136
self.apply_inventory_delta(inv_delta)
2138
@needs_tree_write_lock
2139
def revert(self, filenames=None, old_tree=None, backups=True,
2140
pb=None, report_changes=False):
2141
from bzrlib.conflicts import resolve
2144
symbol_versioning.warn('Using [] to revert all files is deprecated'
2145
' as of bzr 0.91. Please use None (the default) instead.',
2146
DeprecationWarning, stacklevel=2)
2147
if old_tree is None:
2148
basis_tree = self.basis_tree()
2149
basis_tree.lock_read()
2150
old_tree = basis_tree
2154
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2156
if filenames is None and len(self.get_parent_ids()) > 1:
2158
last_revision = self.last_revision()
2159
if last_revision != _mod_revision.NULL_REVISION:
2160
if basis_tree is None:
2161
basis_tree = self.basis_tree()
2162
basis_tree.lock_read()
2163
parent_trees.append((last_revision, basis_tree))
2164
self.set_parent_trees(parent_trees)
2167
resolve(self, filenames, ignore_misses=True, recursive=True)
2169
if basis_tree is not None:
2173
def revision_tree(self, revision_id):
2174
"""See Tree.revision_tree.
2176
WorkingTree can supply revision_trees for the basis revision only
2177
because there is only one cached inventory in the bzr directory.
2179
if revision_id == self.last_revision():
2181
xml = self.read_basis_inventory()
2182
except errors.NoSuchFile:
2186
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2187
# dont use the repository revision_tree api because we want
2188
# to supply the inventory.
2189
if inv.revision_id == revision_id:
2190
return revisiontree.RevisionTree(self.branch.repository,
2192
except errors.BadInventoryFormat:
2194
# raise if there was no inventory, or if we read the wrong inventory.
2195
raise errors.NoSuchRevisionInTree(self, revision_id)
2197
# XXX: This method should be deprecated in favour of taking in a proper
2198
# new Inventory object.
2199
@needs_tree_write_lock
2200
def set_inventory(self, new_inventory_list):
2201
from bzrlib.inventory import (Inventory,
2205
inv = Inventory(self.get_root_id())
2206
for path, file_id, parent, kind in new_inventory_list:
2207
name = os.path.basename(path)
2210
# fixme, there should be a factory function inv,add_??
2211
if kind == 'directory':
2212
inv.add(InventoryDirectory(file_id, name, parent))
2213
elif kind == 'file':
2214
inv.add(InventoryFile(file_id, name, parent))
2215
elif kind == 'symlink':
2216
inv.add(InventoryLink(file_id, name, parent))
2218
raise errors.BzrError("unknown kind %r" % kind)
2219
self._write_inventory(inv)
2221
@needs_tree_write_lock
2222
def set_root_id(self, file_id):
2223
"""Set the root id for this tree."""
2227
'WorkingTree.set_root_id with fileid=None')
2228
file_id = osutils.safe_file_id(file_id)
2229
self._set_root_id(file_id)
2231
def _set_root_id(self, file_id):
2232
"""Set the root id for this tree, in a format specific manner.
2234
:param file_id: The file id to assign to the root. It must not be
2235
present in the current inventory or an error will occur. It must
2236
not be None, but rather a valid file id.
2238
inv = self._inventory
2239
orig_root_id = inv.root.file_id
2240
# TODO: it might be nice to exit early if there was nothing
2241
# to do, saving us from trigger a sync on unlock.
2242
self._inventory_is_modified = True
2243
# we preserve the root inventory entry object, but
2244
# unlinkit from the byid index
2245
del inv._byid[inv.root.file_id]
2246
inv.root.file_id = file_id
2247
# and link it into the index with the new changed id.
2248
inv._byid[inv.root.file_id] = inv.root
2249
# and finally update all children to reference the new id.
2250
# XXX: this should be safe to just look at the root.children
2251
# list, not the WHOLE INVENTORY.
2254
if entry.parent_id == orig_root_id:
2255
entry.parent_id = inv.root.file_id
501
2257
def unlock(self):
502
2258
"""See Branch.unlock.
504
2260
WorkingTree locking just uses the Branch locking facilities.
505
2261
This is current because all working trees have an embedded branch
506
2262
within them. IF in the future, we were to make branch data shareable
507
between multiple working trees, i.e. via shared storage, then we
2263
between multiple working trees, i.e. via shared storage, then we
508
2264
would probably want to lock both the local tree, and the branch.
510
return self.branch.unlock()
513
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
514
def get_conflicted_stem(path):
515
for suffix in CONFLICT_SUFFIXES:
516
if path.endswith(suffix):
517
return path[:-len(suffix)]
2266
raise NotImplementedError(self.unlock)
2270
def update(self, change_reporter=None, possible_transports=None,
2271
revision=None, old_tip=_marker, show_base=False):
2272
"""Update a working tree along its branch.
2274
This will update the branch if its bound too, which means we have
2275
multiple trees involved:
2277
- The new basis tree of the master.
2278
- The old basis tree of the branch.
2279
- The old basis tree of the working tree.
2280
- The current working tree state.
2282
Pathologically, all three may be different, and non-ancestors of each
2283
other. Conceptually we want to:
2285
- Preserve the wt.basis->wt.state changes
2286
- Transform the wt.basis to the new master basis.
2287
- Apply a merge of the old branch basis to get any 'local' changes from
2289
- Restore the wt.basis->wt.state changes.
2291
There isn't a single operation at the moment to do that, so we:
2292
- Merge current state -> basis tree of the master w.r.t. the old tree
2294
- Do a 'normal' merge of the old branch basis if it is relevant.
2296
:param revision: The target revision to update to. Must be in the
2298
:param old_tip: If branch.update() has already been run, the value it
2299
returned (old tip of the branch or None). _marker is used
2302
if self.branch.get_bound_location() is not None:
2304
update_branch = (old_tip is self._marker)
2306
self.lock_tree_write()
2307
update_branch = False
2310
old_tip = self.branch.update(possible_transports)
2312
if old_tip is self._marker:
2314
return self._update_tree(old_tip, change_reporter, revision, show_base)
2318
@needs_tree_write_lock
2319
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
2321
"""Update a tree to the master branch.
2323
:param old_tip: if supplied, the previous tip revision the branch,
2324
before it was changed to the master branch's tip.
2326
# here if old_tip is not None, it is the old tip of the branch before
2327
# it was updated from the master branch. This should become a pending
2328
# merge in the working tree to preserve the user existing work. we
2329
# cant set that until we update the working trees last revision to be
2330
# one from the new branch, because it will just get absorbed by the
2331
# parent de-duplication logic.
2333
# We MUST save it even if an error occurs, because otherwise the users
2334
# local work is unreferenced and will appear to have been lost.
2338
last_rev = self.get_parent_ids()[0]
2340
last_rev = _mod_revision.NULL_REVISION
2341
if revision is None:
2342
revision = self.branch.last_revision()
2344
old_tip = old_tip or _mod_revision.NULL_REVISION
2346
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2347
# the branch we are bound to was updated
2348
# merge those changes in first
2349
base_tree = self.basis_tree()
2350
other_tree = self.branch.repository.revision_tree(old_tip)
2351
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2352
base_tree, this_tree=self,
2353
change_reporter=change_reporter,
2354
show_base=show_base)
2356
self.add_parent_tree((old_tip, other_tree))
2357
trace.note('Rerun update after fixing the conflicts.')
2360
if last_rev != _mod_revision.ensure_null(revision):
2361
# the working tree is up to date with the branch
2362
# we can merge the specified revision from master
2363
to_tree = self.branch.repository.revision_tree(revision)
2364
to_root_id = to_tree.get_root_id()
2366
basis = self.basis_tree()
2369
if (basis.inventory.root is None
2370
or basis.inventory.root.file_id != to_root_id):
2371
self.set_root_id(to_root_id)
2376
# determine the branch point
2377
graph = self.branch.repository.get_graph()
2378
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2380
base_tree = self.branch.repository.revision_tree(base_rev_id)
2382
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2384
change_reporter=change_reporter,
2385
show_base=show_base)
2386
self.set_last_revision(revision)
2387
# TODO - dedup parents list with things merged by pull ?
2388
# reuse the tree we've updated to to set the basis:
2389
parent_trees = [(revision, to_tree)]
2390
merges = self.get_parent_ids()[1:]
2391
# Ideally we ask the tree for the trees here, that way the working
2392
# tree can decide whether to give us the entire tree or give us a
2393
# lazy initialised tree. dirstate for instance will have the trees
2394
# in ram already, whereas a last-revision + basis-inventory tree
2395
# will not, but also does not need them when setting parents.
2396
for parent in merges:
2397
parent_trees.append(
2398
(parent, self.branch.repository.revision_tree(parent)))
2399
if not _mod_revision.is_null(old_tip):
2400
parent_trees.append(
2401
(old_tip, self.branch.repository.revision_tree(old_tip)))
2402
self.set_parent_trees(parent_trees)
2403
last_rev = parent_trees[0][0]
2406
def _write_hashcache_if_dirty(self):
2407
"""Write out the hashcache if it is dirty."""
2408
if self._hashcache.needs_write:
2410
self._hashcache.write()
2412
if e.errno not in (errno.EPERM, errno.EACCES):
2414
# TODO: jam 20061219 Should this be a warning? A single line
2415
# warning might be sufficient to let the user know what
2417
mutter('Could not write hashcache for %s\nError: %s',
2418
self._hashcache.cache_file_name(), e)
2420
@needs_tree_write_lock
2421
def _write_inventory(self, inv):
2422
"""Write inventory as the current inventory."""
2423
self._set_inventory(inv, dirty=True)
2426
def set_conflicts(self, arg):
2427
raise errors.UnsupportedOperation(self.set_conflicts, self)
2429
def add_conflicts(self, arg):
2430
raise errors.UnsupportedOperation(self.add_conflicts, self)
2432
def conflicts(self):
2433
raise NotImplementedError(self.conflicts)
2435
def walkdirs(self, prefix=""):
2436
"""Walk the directories of this tree.
2438
returns a generator which yields items in the form:
2439
((curren_directory_path, fileid),
2440
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2443
This API returns a generator, which is only valid during the current
2444
tree transaction - within a single lock_read or lock_write duration.
2446
If the tree is not locked, it may cause an error to be raised,
2447
depending on the tree implementation.
2449
disk_top = self.abspath(prefix)
2450
if disk_top.endswith('/'):
2451
disk_top = disk_top[:-1]
2452
top_strip_len = len(disk_top) + 1
2453
inventory_iterator = self._walkdirs(prefix)
2454
disk_iterator = osutils.walkdirs(disk_top, prefix)
2456
current_disk = disk_iterator.next()
2457
disk_finished = False
2459
if not (e.errno == errno.ENOENT or
2460
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2463
disk_finished = True
2465
current_inv = inventory_iterator.next()
2466
inv_finished = False
2467
except StopIteration:
2470
while not inv_finished or not disk_finished:
2472
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2473
cur_disk_dir_content) = current_disk
2475
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2476
cur_disk_dir_content) = ((None, None), None)
2477
if not disk_finished:
2478
# strip out .bzr dirs
2479
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2480
len(cur_disk_dir_content) > 0):
2481
# osutils.walkdirs can be made nicer -
2482
# yield the path-from-prefix rather than the pathjoined
2484
bzrdir_loc = bisect_left(cur_disk_dir_content,
2486
if (bzrdir_loc < len(cur_disk_dir_content)
2487
and self.bzrdir.is_control_filename(
2488
cur_disk_dir_content[bzrdir_loc][0])):
2489
# we dont yield the contents of, or, .bzr itself.
2490
del cur_disk_dir_content[bzrdir_loc]
2492
# everything is unknown
2495
# everything is missing
2498
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2500
# disk is before inventory - unknown
2501
dirblock = [(relpath, basename, kind, stat, None, None) for
2502
relpath, basename, kind, stat, top_path in
2503
cur_disk_dir_content]
2504
yield (cur_disk_dir_relpath, None), dirblock
2506
current_disk = disk_iterator.next()
2507
except StopIteration:
2508
disk_finished = True
2510
# inventory is before disk - missing.
2511
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2512
for relpath, basename, dkind, stat, fileid, kind in
2514
yield (current_inv[0][0], current_inv[0][1]), dirblock
2516
current_inv = inventory_iterator.next()
2517
except StopIteration:
2520
# versioned present directory
2521
# merge the inventory and disk data together
2523
for relpath, subiterator in itertools.groupby(sorted(
2524
current_inv[1] + cur_disk_dir_content,
2525
key=operator.itemgetter(0)), operator.itemgetter(1)):
2526
path_elements = list(subiterator)
2527
if len(path_elements) == 2:
2528
inv_row, disk_row = path_elements
2529
# versioned, present file
2530
dirblock.append((inv_row[0],
2531
inv_row[1], disk_row[2],
2532
disk_row[3], inv_row[4],
2534
elif len(path_elements[0]) == 5:
2536
dirblock.append((path_elements[0][0],
2537
path_elements[0][1], path_elements[0][2],
2538
path_elements[0][3], None, None))
2539
elif len(path_elements[0]) == 6:
2540
# versioned, absent file.
2541
dirblock.append((path_elements[0][0],
2542
path_elements[0][1], 'unknown', None,
2543
path_elements[0][4], path_elements[0][5]))
2545
raise NotImplementedError('unreachable code')
2546
yield current_inv[0], dirblock
2548
current_inv = inventory_iterator.next()
2549
except StopIteration:
2552
current_disk = disk_iterator.next()
2553
except StopIteration:
2554
disk_finished = True
2556
def _walkdirs(self, prefix=""):
2557
"""Walk the directories of this tree.
2559
:prefix: is used as the directrory to start with.
2560
returns a generator which yields items in the form:
2561
((curren_directory_path, fileid),
2562
[(file1_path, file1_name, file1_kind, None, file1_id,
2565
_directory = 'directory'
2566
# get the root in the inventory
2567
inv = self.inventory
2568
top_id = inv.path2id(prefix)
2572
pending = [(prefix, '', _directory, None, top_id, None)]
2575
currentdir = pending.pop()
2576
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2577
top_id = currentdir[4]
2579
relroot = currentdir[0] + '/'
2582
# FIXME: stash the node in pending
2584
if entry.kind == 'directory':
2585
for name, child in entry.sorted_children():
2586
dirblock.append((relroot + name, name, child.kind, None,
2587
child.file_id, child.kind
2589
yield (currentdir[0], entry.file_id), dirblock
2590
# push the user specified dirs from dirblock
2591
for dir in reversed(dirblock):
2592
if dir[2] == _directory:
2595
@needs_tree_write_lock
2596
def auto_resolve(self):
2597
"""Automatically resolve text conflicts according to contents.
2599
Only text conflicts are auto_resolvable. Files with no conflict markers
2600
are considered 'resolved', because bzr always puts conflict markers
2601
into files that have text conflicts. The corresponding .THIS .BASE and
2602
.OTHER files are deleted, as per 'resolve'.
2603
:return: a tuple of ConflictLists: (un_resolved, resolved).
2605
un_resolved = _mod_conflicts.ConflictList()
2606
resolved = _mod_conflicts.ConflictList()
2607
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2608
for conflict in self.conflicts():
2609
if (conflict.typestring != 'text conflict' or
2610
self.kind(conflict.file_id) != 'file'):
2611
un_resolved.append(conflict)
2613
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2615
for line in my_file:
2616
if conflict_re.search(line):
2617
un_resolved.append(conflict)
2620
resolved.append(conflict)
2623
resolved.remove_files(self)
2624
self.set_conflicts(un_resolved)
2625
return un_resolved, resolved
2628
def _check(self, references):
2629
"""Check the tree for consistency.
2631
:param references: A dict with keys matching the items returned by
2632
self._get_check_refs(), and values from looking those keys up in
2635
tree_basis = self.basis_tree()
2636
tree_basis.lock_read()
2638
repo_basis = references[('trees', self.last_revision())]
2639
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2640
raise errors.BzrCheckError(
2641
"Mismatched basis inventory content.")
2646
def _validate(self):
2647
"""Validate internal structures.
2649
This is meant mostly for the test suite. To give it a chance to detect
2650
corruption after actions have occurred. The default implementation is a
2653
:return: None. An exception should be raised if there is an error.
2658
def check_state(self):
2659
"""Check that the working state is/isn't valid."""
2660
check_refs = self._get_check_refs()
2662
for ref in check_refs:
2665
refs[ref] = self.branch.repository.revision_tree(value)
2668
@needs_tree_write_lock
2669
def reset_state(self, revision_ids=None):
2670
"""Reset the state of the working tree.
2672
This does a hard-reset to a last-known-good state. This is a way to
2673
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2675
if revision_ids is None:
2676
revision_ids = self.get_parent_ids()
2677
if not revision_ids:
2678
rt = self.branch.repository.revision_tree(
2679
_mod_revision.NULL_REVISION)
2681
rt = self.branch.repository.revision_tree(revision_ids[0])
2682
self._write_inventory(rt.inventory)
2683
self.set_parent_ids(revision_ids)
2685
def _get_rules_searcher(self, default_searcher):
2686
"""See Tree._get_rules_searcher."""
2687
if self._rules_searcher is None:
2688
self._rules_searcher = super(WorkingTree,
2689
self)._get_rules_searcher(default_searcher)
2690
return self._rules_searcher
2692
def get_shelf_manager(self):
2693
"""Return the ShelfManager for this WorkingTree."""
2694
from bzrlib.shelf import ShelfManager
2695
return ShelfManager(self, self._transport)
2698
class WorkingTree3(WorkingTree):
2699
"""This is the Format 3 working tree.
2701
This differs from the base WorkingTree by:
2702
- having its own file lock
2703
- having its own last-revision property.
2705
This is new in bzr 0.8
2709
def _last_revision(self):
2710
"""See Mutable.last_revision."""
2712
return self._transport.get_bytes('last-revision')
2713
except errors.NoSuchFile:
2714
return _mod_revision.NULL_REVISION
2716
def _change_last_revision(self, revision_id):
2717
"""See WorkingTree._change_last_revision."""
2718
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2720
self._transport.delete('last-revision')
2721
except errors.NoSuchFile:
2725
self._transport.put_bytes('last-revision', revision_id,
2726
mode=self.bzrdir._get_file_mode())
2729
def _get_check_refs(self):
2730
"""Return the references needed to perform a check of this tree."""
2731
return [('trees', self.last_revision())]
2733
@needs_tree_write_lock
2734
def set_conflicts(self, conflicts):
2735
self._put_rio('conflicts', conflicts.to_stanzas(),
2738
@needs_tree_write_lock
2739
def add_conflicts(self, new_conflicts):
2740
conflict_set = set(self.conflicts())
2741
conflict_set.update(set(list(new_conflicts)))
2742
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2743
key=_mod_conflicts.Conflict.sort_key)))
2746
def conflicts(self):
2748
confile = self._transport.get('conflicts')
2749
except errors.NoSuchFile:
2750
return _mod_conflicts.ConflictList()
2753
if confile.next() != CONFLICT_HEADER_1 + '\n':
2754
raise errors.ConflictFormatError()
2755
except StopIteration:
2756
raise errors.ConflictFormatError()
2757
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2762
# do non-implementation specific cleanup
2764
if self._control_files._lock_count == 1:
2765
# _inventory_is_modified is always False during a read lock.
2766
if self._inventory_is_modified:
2768
self._write_hashcache_if_dirty()
2769
# reverse order of locking.
2771
return self._control_files.unlock()
2773
self.branch.unlock()
2776
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2777
"""Registry for working tree formats."""
2779
def __init__(self, other_registry=None):
2780
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2781
self._default_format = None
2783
def get_default(self):
2784
"""Return the current default format."""
2785
return self._default_format
2787
def set_default(self, format):
2788
self._default_format = format
2791
format_registry = WorkingTreeFormatRegistry()
2794
class WorkingTreeFormat(controldir.ControlComponentFormat):
2795
"""An encapsulation of the initialization and open routines for a format.
2797
Formats provide three things:
2798
* An initialization routine,
2802
Formats are placed in an dict by their format string for reference
2803
during workingtree opening. Its not required that these be instances, they
2804
can be classes themselves with class methods - it simply depends on
2805
whether state is needed for a given format or not.
2807
Once a format is deprecated, just deprecate the initialize and open
2808
methods on the format class. Do not deprecate the object, as the
2809
object will be created every time regardless.
2812
requires_rich_root = False
2814
upgrade_recommended = False
2816
requires_normalized_unicode_filenames = False
2818
case_sensitive_filename = "FoRMaT"
2820
missing_parent_conflicts = False
2821
"""If this format supports missing parent conflicts."""
2824
def find_format(klass, a_bzrdir):
2825
"""Return the format for the working tree object in a_bzrdir."""
2827
transport = a_bzrdir.get_workingtree_transport(None)
2828
format_string = transport.get_bytes("format")
2829
return format_registry.get(format_string)
2830
except errors.NoSuchFile:
2831
raise errors.NoWorkingTree(base=transport.base)
2833
raise errors.UnknownFormatError(format=format_string,
2834
kind="working tree")
2836
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2837
accelerator_tree=None, hardlink=False):
2838
"""Initialize a new working tree in a_bzrdir.
2840
:param a_bzrdir: BzrDir to initialize the working tree in.
2841
:param revision_id: allows creating a working tree at a different
2842
revision than the branch is at.
2843
:param from_branch: Branch to checkout
2844
:param accelerator_tree: A tree which can be used for retrieving file
2845
contents more quickly than the revision tree, i.e. a workingtree.
2846
The revision tree will be used for cases where accelerator_tree's
2847
content is different.
2848
:param hardlink: If true, hard-link files from accelerator_tree,
2851
raise NotImplementedError(self.initialize)
2853
def __eq__(self, other):
2854
return self.__class__ is other.__class__
2856
def __ne__(self, other):
2857
return not (self == other)
2860
@symbol_versioning.deprecated_method(
2861
symbol_versioning.deprecated_in((2, 4, 0)))
2862
def get_default_format(klass):
2863
"""Return the current default format."""
2864
return format_registry.get_default()
2866
def get_format_string(self):
2867
"""Return the ASCII format string that identifies this format."""
2868
raise NotImplementedError(self.get_format_string)
2870
def get_format_description(self):
2871
"""Return the short description for this format."""
2872
raise NotImplementedError(self.get_format_description)
2874
def is_supported(self):
2875
"""Is this format supported?
2877
Supported formats can be initialized and opened.
2878
Unsupported formats may not support initialization or committing or
2879
some other features depending on the reason for not being supported.
2883
def supports_content_filtering(self):
2884
"""True if this format supports content filtering."""
2887
def supports_views(self):
2888
"""True if this format supports stored views."""
2892
@symbol_versioning.deprecated_method(
2893
symbol_versioning.deprecated_in((2, 4, 0)))
2894
def register_format(klass, format):
2895
format_registry.register(format)
2898
@symbol_versioning.deprecated_method(
2899
symbol_versioning.deprecated_in((2, 4, 0)))
2900
def register_extra_format(klass, format):
2901
format_registry.register_extra(format)
2904
@symbol_versioning.deprecated_method(
2905
symbol_versioning.deprecated_in((2, 4, 0)))
2906
def unregister_extra_format(klass, format):
2907
format_registry.unregister_extra(format)
2910
@symbol_versioning.deprecated_method(
2911
symbol_versioning.deprecated_in((2, 4, 0)))
2912
def get_formats(klass):
2913
return format_registry._get_all()
2916
@symbol_versioning.deprecated_method(
2917
symbol_versioning.deprecated_in((2, 4, 0)))
2918
def set_default_format(klass, format):
2919
format_registry.set_default(format)
2922
@symbol_versioning.deprecated_method(
2923
symbol_versioning.deprecated_in((2, 4, 0)))
2924
def unregister_format(klass, format):
2925
format_registry.remove(format)
2928
class WorkingTreeFormat3(WorkingTreeFormat):
2929
"""The second working tree format updated to record a format marker.
2932
- exists within a metadir controlling .bzr
2933
- includes an explicit version marker for the workingtree control
2934
files, separate from the BzrDir format
2935
- modifies the hash cache format
2937
- uses a LockDir to guard access for writes.
2940
upgrade_recommended = True
2942
missing_parent_conflicts = True
2944
def get_format_string(self):
2945
"""See WorkingTreeFormat.get_format_string()."""
2946
return "Bazaar-NG Working Tree format 3"
2948
def get_format_description(self):
2949
"""See WorkingTreeFormat.get_format_description()."""
2950
return "Working tree format 3"
2952
_lock_file_name = 'lock'
2953
_lock_class = LockDir
2955
_tree_class = WorkingTree3
2957
def __get_matchingbzrdir(self):
2958
return bzrdir.BzrDirMetaFormat1()
2960
_matchingbzrdir = property(__get_matchingbzrdir)
2962
def _open_control_files(self, a_bzrdir):
2963
transport = a_bzrdir.get_workingtree_transport(None)
2964
return LockableFiles(transport, self._lock_file_name,
2967
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2968
accelerator_tree=None, hardlink=False):
2969
"""See WorkingTreeFormat.initialize().
2971
:param revision_id: if supplied, create a working tree at a different
2972
revision than the branch is at.
2973
:param accelerator_tree: A tree which can be used for retrieving file
2974
contents more quickly than the revision tree, i.e. a workingtree.
2975
The revision tree will be used for cases where accelerator_tree's
2976
content is different.
2977
:param hardlink: If true, hard-link files from accelerator_tree,
2980
if not isinstance(a_bzrdir.transport, LocalTransport):
2981
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2982
transport = a_bzrdir.get_workingtree_transport(self)
2983
control_files = self._open_control_files(a_bzrdir)
2984
control_files.create_lock()
2985
control_files.lock_write()
2986
transport.put_bytes('format', self.get_format_string(),
2987
mode=a_bzrdir._get_file_mode())
2988
if from_branch is not None:
2989
branch = from_branch
2991
branch = a_bzrdir.open_branch()
2992
if revision_id is None:
2993
revision_id = _mod_revision.ensure_null(branch.last_revision())
2994
# WorkingTree3 can handle an inventory which has a unique root id.
2995
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2996
# those trees. And because there isn't a format bump inbetween, we
2997
# are maintaining compatibility with older clients.
2998
# inv = Inventory(root_id=gen_root_id())
2999
inv = self._initial_inventory()
3000
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3006
_control_files=control_files)
3007
wt.lock_tree_write()
3009
basis_tree = branch.repository.revision_tree(revision_id)
3010
# only set an explicit root id if there is one to set.
3011
if basis_tree.inventory.root is not None:
3012
wt.set_root_id(basis_tree.get_root_id())
3013
if revision_id == _mod_revision.NULL_REVISION:
3014
wt.set_parent_trees([])
3016
wt.set_parent_trees([(revision_id, basis_tree)])
3017
transform.build_tree(basis_tree, wt)
3019
# Unlock in this order so that the unlock-triggers-flush in
3020
# WorkingTree is given a chance to fire.
3021
control_files.unlock()
3025
def _initial_inventory(self):
3026
return inventory.Inventory()
3029
super(WorkingTreeFormat3, self).__init__()
3031
def open(self, a_bzrdir, _found=False):
3032
"""Return the WorkingTree object for a_bzrdir
3034
_found is a private parameter, do not use it. It is used to indicate
3035
if format probing has already been done.
3038
# we are being called directly and must probe.
3039
raise NotImplementedError
3040
if not isinstance(a_bzrdir.transport, LocalTransport):
3041
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3042
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3045
def _open(self, a_bzrdir, control_files):
3046
"""Open the tree itself.
3048
:param a_bzrdir: the dir for the tree.
3049
:param control_files: the control files for the tree.
3051
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3055
_control_files=control_files)
3058
return self.get_format_string()
3061
__default_format = WorkingTreeFormat6()
3062
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3063
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3064
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3065
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3066
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3067
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3068
format_registry.register(WorkingTreeFormat3())
3069
format_registry.set_default(__default_format)
added
removed
bzrlib/workingtree.py
