1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
57
conflicts as _mod_conflicts,
66
revision as _mod_revision,
76
from bzrlib.transport import get_transport
77
from bzrlib.workingtree_4 import (
84
from bzrlib import symbol_versioning
85
from bzrlib.decorators import needs_read_lock, needs_write_lock
86
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib import osutils
91
from bzrlib.osutils import (
101
from bzrlib.filters import filtered_input_file
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import CURRENT_REVISION
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (
109
DEPRECATED_PARAMETER,
113
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
114
# TODO: Modifying the conflict objects or their type is currently nearly
115
# impossible as there is no clear relationship between the working tree format
116
# and the conflict list file format.
117
CONFLICT_HEADER_1 = "BZR conflict list format 1"
119
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
122
class TreeEntry(object):
123
"""An entry that implements the minimum interface used by commands.
125
This needs further inspection, it may be better to have
126
InventoryEntries without ids - though that seems wrong. For now,
127
this is a parallel hierarchy to InventoryEntry, and needs to become
128
one of several things: decorates to that hierarchy, children of, or
130
Another note is that these objects are currently only used when there is
131
no InventoryEntry available - i.e. for unversioned objects.
132
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
135
def __eq__(self, other):
136
# yes, this us ugly, TODO: best practice __eq__ style.
137
return (isinstance(other, TreeEntry)
138
and other.__class__ == self.__class__)
140
def kind_character(self):
144
class TreeDirectory(TreeEntry):
145
"""See TreeEntry. This is a directory in a working tree."""
147
def __eq__(self, other):
148
return (isinstance(other, TreeDirectory)
149
and other.__class__ == self.__class__)
151
def kind_character(self):
155
class TreeFile(TreeEntry):
156
"""See TreeEntry. This is a regular file in a working tree."""
158
def __eq__(self, other):
159
return (isinstance(other, TreeFile)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeLink(TreeEntry):
167
"""See TreeEntry. This is a symlink in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeLink)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class WorkingTree(bzrlib.mutabletree.MutableTree):
178
"""Working copy tree.
180
The inventory is held in the `Branch` working-inventory, and the
181
files are in a directory on disk.
183
It is possible for a `WorkingTree` to have a filename which is
184
not listed in the Inventory and vice versa.
187
# override this to set the strategy for storing views
188
def _make_views(self):
189
return views.DisabledViews(self)
191
def __init__(self, basedir='.',
192
branch=DEPRECATED_PARAMETER,
198
"""Construct a WorkingTree instance. This is not a public API.
200
:param branch: A branch to override probing for the branch.
202
self._format = _format
203
self.bzrdir = _bzrdir
205
raise errors.BzrError("Please use bzrdir.open_workingtree or "
206
"WorkingTree.open() to obtain a WorkingTree.")
207
basedir = safe_unicode(basedir)
208
mutter("opening working tree %r", basedir)
209
if deprecated_passed(branch):
210
self._branch = branch
212
self._branch = self.bzrdir.open_branch()
213
self.basedir = realpath(basedir)
214
# if branch is at our basedir and is a format 6 or less
215
if isinstance(self._format, WorkingTreeFormat2):
216
# share control object
217
self._control_files = self.branch.control_files
219
# assume all other formats have their own control files.
220
self._control_files = _control_files
221
self._transport = self._control_files._transport
222
# update the whole cache up front and write to disk if anything changed;
223
# in the future we might want to do this more selectively
224
# two possible ways offer themselves : in self._unlock, write the cache
225
# if needed, or, when the cache sees a change, append it to the hash
226
# cache file, and have the parser take the most recent entry for a
228
wt_trans = self.bzrdir.get_workingtree_transport(None)
229
cache_filename = wt_trans.local_abspath('stat-cache')
230
self._hashcache = hashcache.HashCache(basedir, cache_filename,
231
self.bzrdir._get_file_mode(),
232
self._content_filter_stack_provider())
235
# is this scan needed ? it makes things kinda slow.
242
if _inventory is None:
243
# This will be acquired on lock_read() or lock_write()
244
self._inventory_is_modified = False
245
self._inventory = None
247
# the caller of __init__ has provided an inventory,
248
# we assume they know what they are doing - as its only
249
# the Format factory and creation methods that are
250
# permitted to do this.
251
self._set_inventory(_inventory, dirty=False)
252
self._detect_case_handling()
253
self._rules_searcher = None
254
self.views = self._make_views()
256
def _detect_case_handling(self):
257
wt_trans = self.bzrdir.get_workingtree_transport(None)
259
wt_trans.stat("FoRMaT")
260
except errors.NoSuchFile:
261
self.case_sensitive = True
263
self.case_sensitive = False
265
self._setup_directory_is_tree_reference()
268
fget=lambda self: self._branch,
269
doc="""The branch this WorkingTree is connected to.
271
This cannot be set - it is reflective of the actual disk structure
272
the working tree has been constructed from.
275
def break_lock(self):
276
"""Break a lock if one is present from another instance.
278
Uses the ui factory to ask for confirmation if the lock may be from
281
This will probe the repository for its lock as well.
283
self._control_files.break_lock()
284
self.branch.break_lock()
286
def _get_check_refs(self):
287
"""Return the references needed to perform a check of this tree.
289
The default implementation returns no refs, and is only suitable for
290
trees that have no local caching and can commit on ghosts at any time.
292
:seealso: bzrlib.check for details about check_refs.
296
def requires_rich_root(self):
297
return self._format.requires_rich_root
299
def supports_tree_reference(self):
302
def supports_content_filtering(self):
303
return self._format.supports_content_filtering()
305
def supports_views(self):
306
return self.views.supports_views()
308
def _set_inventory(self, inv, dirty):
309
"""Set the internal cached inventory.
311
:param inv: The inventory to set.
312
:param dirty: A boolean indicating whether the inventory is the same
313
logical inventory as whats on disk. If True the inventory is not
314
the same and should be written to disk or data will be lost, if
315
False then the inventory is the same as that on disk and any
316
serialisation would be unneeded overhead.
318
self._inventory = inv
319
self._inventory_is_modified = dirty
322
def open(path=None, _unsupported=False):
323
"""Open an existing working tree at path.
327
path = osutils.getcwd()
328
control = bzrdir.BzrDir.open(path, _unsupported)
329
return control.open_workingtree(_unsupported)
332
def open_containing(path=None):
333
"""Open an existing working tree which has its root about path.
335
This probes for a working tree at path and searches upwards from there.
337
Basically we keep looking up until we find the control directory or
338
run into /. If there isn't one, raises NotBranchError.
339
TODO: give this a new exception.
340
If there is one, it is returned, along with the unused portion of path.
342
:return: The WorkingTree that contains 'path', and the rest of path
345
path = osutils.getcwd()
346
control, relpath = bzrdir.BzrDir.open_containing(path)
348
return control.open_workingtree(), relpath
351
def open_downlevel(path=None):
352
"""Open an unsupported working tree.
354
Only intended for advanced situations like upgrading part of a bzrdir.
356
return WorkingTree.open(path, _unsupported=True)
359
def find_trees(location):
360
def list_current(transport):
361
return [d for d in transport.list_dir('') if d != '.bzr']
362
def evaluate(bzrdir):
364
tree = bzrdir.open_workingtree()
365
except errors.NoWorkingTree:
369
transport = get_transport(location)
370
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
371
list_current=list_current)
372
return [t for t in iterator if t is not None]
374
# should be deprecated - this is slow and in any case treating them as a
375
# container is (we now know) bad style -- mbp 20070302
376
## @deprecated_method(zero_fifteen)
378
"""Iterate through file_ids for this tree.
380
file_ids are in a WorkingTree if they are in the working inventory
381
and the working file exists.
383
inv = self._inventory
384
for path, ie in inv.iter_entries():
385
if osutils.lexists(self.abspath(path)):
388
def all_file_ids(self):
389
"""See Tree.iter_all_file_ids"""
390
return set(self.inventory)
393
return "<%s of %s>" % (self.__class__.__name__,
394
getattr(self, 'basedir', None))
396
def abspath(self, filename):
397
return pathjoin(self.basedir, filename)
399
def basis_tree(self):
400
"""Return RevisionTree for the current last revision.
402
If the left most parent is a ghost then the returned tree will be an
403
empty tree - one obtained by calling
404
repository.revision_tree(NULL_REVISION).
407
revision_id = self.get_parent_ids()[0]
409
# no parents, return an empty revision tree.
410
# in the future this should return the tree for
411
# 'empty:' - the implicit root empty tree.
412
return self.branch.repository.revision_tree(
413
_mod_revision.NULL_REVISION)
415
return self.revision_tree(revision_id)
416
except errors.NoSuchRevision:
418
# No cached copy available, retrieve from the repository.
419
# FIXME? RBC 20060403 should we cache the inventory locally
422
return self.branch.repository.revision_tree(revision_id)
423
except (errors.RevisionNotPresent, errors.NoSuchRevision):
424
# the basis tree *may* be a ghost or a low level error may have
425
# occurred. If the revision is present, its a problem, if its not
427
if self.branch.repository.has_revision(revision_id):
429
# the basis tree is a ghost so return an empty tree.
430
return self.branch.repository.revision_tree(
431
_mod_revision.NULL_REVISION)
434
self._flush_ignore_list_cache()
436
def relpath(self, path):
437
"""Return the local path portion from a given path.
439
The path may be absolute or relative. If its a relative path it is
440
interpreted relative to the python current working directory.
442
return osutils.relpath(self.basedir, path)
444
def has_filename(self, filename):
445
return osutils.lexists(self.abspath(filename))
447
def get_file(self, file_id, path=None, filtered=True):
448
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
450
def get_file_with_stat(self, file_id, path=None, filtered=True,
452
"""See Tree.get_file_with_stat."""
454
path = self.id2path(file_id)
455
file_obj = self.get_file_byname(path, filtered=False)
456
stat_value = _fstat(file_obj.fileno())
457
if filtered and self.supports_content_filtering():
458
filters = self._content_filter_stack(path)
459
file_obj = filtered_input_file(file_obj, filters)
460
return (file_obj, stat_value)
462
def get_file_text(self, file_id, path=None, filtered=True):
463
return self.get_file(file_id, path=path, filtered=filtered).read()
465
def get_file_byname(self, filename, filtered=True):
466
path = self.abspath(filename)
468
if filtered and self.supports_content_filtering():
469
filters = self._content_filter_stack(filename)
470
return filtered_input_file(f, filters)
474
def get_file_lines(self, file_id, path=None, filtered=True):
475
"""See Tree.get_file_lines()"""
476
file = self.get_file(file_id, path, filtered=filtered)
478
return file.readlines()
483
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
484
"""See Tree.annotate_iter
486
This implementation will use the basis tree implementation if possible.
487
Lines not in the basis are attributed to CURRENT_REVISION
489
If there are pending merges, lines added by those merges will be
490
incorrectly attributed to CURRENT_REVISION (but after committing, the
491
attribution will be correct).
493
maybe_file_parent_keys = []
494
for parent_id in self.get_parent_ids():
496
parent_tree = self.revision_tree(parent_id)
497
except errors.NoSuchRevisionInTree:
498
parent_tree = self.branch.repository.revision_tree(parent_id)
499
parent_tree.lock_read()
501
if file_id not in parent_tree:
503
ie = parent_tree.inventory[file_id]
504
if ie.kind != 'file':
505
# Note: this is slightly unnecessary, because symlinks and
506
# directories have a "text" which is the empty text, and we
507
# know that won't mess up annotations. But it seems cleaner
509
parent_text_key = (file_id, ie.revision)
510
if parent_text_key not in maybe_file_parent_keys:
511
maybe_file_parent_keys.append(parent_text_key)
514
graph = _mod_graph.Graph(self.branch.repository.texts)
515
heads = graph.heads(maybe_file_parent_keys)
516
file_parent_keys = []
517
for key in maybe_file_parent_keys:
519
file_parent_keys.append(key)
521
# Now we have the parents of this content
522
annotator = self.branch.repository.texts.get_annotator()
523
text = self.get_file(file_id).read()
524
this_key =(file_id, default_revision)
525
annotator.add_special_text(this_key, file_parent_keys, text)
526
annotations = [(key[-1], line)
527
for key, line in annotator.annotate_flat(this_key)]
530
def _get_ancestors(self, default_revision):
531
ancestors = set([default_revision])
532
for parent_id in self.get_parent_ids():
533
ancestors.update(self.branch.repository.get_ancestry(
534
parent_id, topo_sorted=False))
537
def get_parent_ids(self):
538
"""See Tree.get_parent_ids.
540
This implementation reads the pending merges list and last_revision
541
value and uses that to decide what the parents list should be.
543
last_rev = _mod_revision.ensure_null(self._last_revision())
544
if _mod_revision.NULL_REVISION == last_rev:
549
merges_bytes = self._transport.get_bytes('pending-merges')
550
except errors.NoSuchFile:
553
for l in osutils.split_lines(merges_bytes):
554
revision_id = l.rstrip('\n')
555
parents.append(revision_id)
559
def get_root_id(self):
560
"""Return the id of this trees root"""
561
return self._inventory.root.file_id
563
def _get_store_filename(self, file_id):
564
## XXX: badly named; this is not in the store at all
565
return self.abspath(self.id2path(file_id))
568
def clone(self, to_bzrdir, revision_id=None):
569
"""Duplicate this working tree into to_bzr, including all state.
571
Specifically modified files are kept as modified, but
572
ignored and unknown files are discarded.
574
If you want to make a new line of development, see bzrdir.sprout()
577
If not None, the cloned tree will have its last revision set to
578
revision, and difference between the source trees last revision
579
and this one merged in.
581
# assumes the target bzr dir format is compatible.
582
result = to_bzrdir.create_workingtree()
583
self.copy_content_into(result, revision_id)
587
def copy_content_into(self, tree, revision_id=None):
588
"""Copy the current content and user files of this tree into tree."""
589
tree.set_root_id(self.get_root_id())
590
if revision_id is None:
591
merge.transform_tree(tree, self)
593
# TODO now merge from tree.last_revision to revision (to preserve
594
# user local changes)
595
merge.transform_tree(tree, self)
596
tree.set_parent_ids([revision_id])
598
def id2abspath(self, file_id):
599
return self.abspath(self.id2path(file_id))
601
def has_id(self, file_id):
602
# files that have been deleted are excluded
604
if not inv.has_id(file_id):
606
path = inv.id2path(file_id)
607
return osutils.lexists(self.abspath(path))
609
def has_or_had_id(self, file_id):
610
if file_id == self.inventory.root.file_id:
612
return self.inventory.has_id(file_id)
614
__contains__ = has_id
616
def get_file_size(self, file_id):
617
"""See Tree.get_file_size"""
618
# XXX: this returns the on-disk size; it should probably return the
621
return os.path.getsize(self.id2abspath(file_id))
623
if e.errno != errno.ENOENT:
629
def get_file_sha1(self, file_id, path=None, stat_value=None):
631
path = self._inventory.id2path(file_id)
632
return self._hashcache.get_sha1(path, stat_value)
634
def get_file_mtime(self, file_id, path=None):
636
path = self.inventory.id2path(file_id)
637
return os.lstat(self.abspath(path)).st_mtime
639
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
640
file_id = self.path2id(path)
642
# For unversioned files on win32, we just assume they are not
645
return self._inventory[file_id].executable
647
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
648
mode = stat_result.st_mode
649
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
651
if not supports_executable():
652
def is_executable(self, file_id, path=None):
653
return self._inventory[file_id].executable
655
_is_executable_from_path_and_stat = \
656
_is_executable_from_path_and_stat_from_basis
658
def is_executable(self, file_id, path=None):
660
path = self.id2path(file_id)
661
mode = os.lstat(self.abspath(path)).st_mode
662
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
664
_is_executable_from_path_and_stat = \
665
_is_executable_from_path_and_stat_from_stat
667
@needs_tree_write_lock
668
def _add(self, files, ids, kinds):
669
"""See MutableTree._add."""
670
# TODO: Re-adding a file that is removed in the working copy
671
# should probably put it back with the previous ID.
672
# the read and write working inventory should not occur in this
673
# function - they should be part of lock_write and unlock.
675
for f, file_id, kind in zip(files, ids, kinds):
677
inv.add_path(f, kind=kind)
679
inv.add_path(f, kind=kind, file_id=file_id)
680
self._inventory_is_modified = True
682
@needs_tree_write_lock
683
def _gather_kinds(self, files, kinds):
684
"""See MutableTree._gather_kinds."""
685
for pos, f in enumerate(files):
686
if kinds[pos] is None:
687
fullpath = normpath(self.abspath(f))
689
kinds[pos] = file_kind(fullpath)
691
if e.errno == errno.ENOENT:
692
raise errors.NoSuchFile(fullpath)
695
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
696
"""Add revision_id as a parent.
698
This is equivalent to retrieving the current list of parent ids
699
and setting the list to its value plus revision_id.
701
:param revision_id: The revision id to add to the parent list. It may
702
be a ghost revision as long as its not the first parent to be added,
703
or the allow_leftmost_as_ghost parameter is set True.
704
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
706
parents = self.get_parent_ids() + [revision_id]
707
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
708
or allow_leftmost_as_ghost)
710
@needs_tree_write_lock
711
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
712
"""Add revision_id, tree tuple as a parent.
714
This is equivalent to retrieving the current list of parent trees
715
and setting the list to its value plus parent_tuple. See also
716
add_parent_tree_id - if you only have a parent id available it will be
717
simpler to use that api. If you have the parent already available, using
718
this api is preferred.
720
:param parent_tuple: The (revision id, tree) to add to the parent list.
721
If the revision_id is a ghost, pass None for the tree.
722
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
724
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
725
if len(parent_ids) > 1:
726
# the leftmost may have already been a ghost, preserve that if it
728
allow_leftmost_as_ghost = True
729
self.set_parent_ids(parent_ids,
730
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
732
@needs_tree_write_lock
733
def add_pending_merge(self, *revision_ids):
734
# TODO: Perhaps should check at this point that the
735
# history of the revision is actually present?
736
parents = self.get_parent_ids()
738
for rev_id in revision_ids:
739
if rev_id in parents:
741
parents.append(rev_id)
744
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
746
def path_content_summary(self, path, _lstat=os.lstat,
747
_mapper=osutils.file_kind_from_stat_mode):
748
"""See Tree.path_content_summary."""
749
abspath = self.abspath(path)
751
stat_result = _lstat(abspath)
753
if getattr(e, 'errno', None) == errno.ENOENT:
755
return ('missing', None, None, None)
756
# propagate other errors
758
kind = _mapper(stat_result.st_mode)
760
return self._file_content_summary(path, stat_result)
761
elif kind == 'directory':
762
# perhaps it looks like a plain directory, but it's really a
764
if self._directory_is_tree_reference(path):
765
kind = 'tree-reference'
766
return kind, None, None, None
767
elif kind == 'symlink':
768
target = osutils.readlink(abspath)
769
return ('symlink', None, None, target)
771
return (kind, None, None, None)
773
def _file_content_summary(self, path, stat_result):
774
size = stat_result.st_size
775
executable = self._is_executable_from_path_and_stat(path, stat_result)
776
# try for a stat cache lookup
777
return ('file', size, executable, self._sha_from_stat(
780
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
781
"""Common ghost checking functionality from set_parent_*.
783
This checks that the left hand-parent exists if there are any
786
if len(revision_ids) > 0:
787
leftmost_id = revision_ids[0]
788
if (not allow_leftmost_as_ghost and not
789
self.branch.repository.has_revision(leftmost_id)):
790
raise errors.GhostRevisionUnusableHere(leftmost_id)
792
def _set_merges_from_parent_ids(self, parent_ids):
793
merges = parent_ids[1:]
794
self._transport.put_bytes('pending-merges', '\n'.join(merges),
795
mode=self.bzrdir._get_file_mode())
797
def _filter_parent_ids_by_ancestry(self, revision_ids):
798
"""Check that all merged revisions are proper 'heads'.
800
This will always return the first revision_id, and any merged revisions
803
if len(revision_ids) == 0:
805
graph = self.branch.repository.get_graph()
806
heads = graph.heads(revision_ids)
807
new_revision_ids = revision_ids[:1]
808
for revision_id in revision_ids[1:]:
809
if revision_id in heads and revision_id not in new_revision_ids:
810
new_revision_ids.append(revision_id)
811
if new_revision_ids != revision_ids:
812
trace.mutter('requested to set revision_ids = %s,'
813
' but filtered to %s', revision_ids, new_revision_ids)
814
return new_revision_ids
816
@needs_tree_write_lock
817
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
818
"""Set the parent ids to revision_ids.
820
See also set_parent_trees. This api will try to retrieve the tree data
821
for each element of revision_ids from the trees repository. If you have
822
tree data already available, it is more efficient to use
823
set_parent_trees rather than set_parent_ids. set_parent_ids is however
824
an easier API to use.
826
:param revision_ids: The revision_ids to set as the parent ids of this
827
working tree. Any of these may be ghosts.
829
self._check_parents_for_ghosts(revision_ids,
830
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
831
for revision_id in revision_ids:
832
_mod_revision.check_not_reserved_id(revision_id)
834
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
836
if len(revision_ids) > 0:
837
self.set_last_revision(revision_ids[0])
839
self.set_last_revision(_mod_revision.NULL_REVISION)
841
self._set_merges_from_parent_ids(revision_ids)
843
@needs_tree_write_lock
844
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
845
"""See MutableTree.set_parent_trees."""
846
parent_ids = [rev for (rev, tree) in parents_list]
847
for revision_id in parent_ids:
848
_mod_revision.check_not_reserved_id(revision_id)
850
self._check_parents_for_ghosts(parent_ids,
851
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
853
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
855
if len(parent_ids) == 0:
856
leftmost_parent_id = _mod_revision.NULL_REVISION
857
leftmost_parent_tree = None
859
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
861
if self._change_last_revision(leftmost_parent_id):
862
if leftmost_parent_tree is None:
863
# If we don't have a tree, fall back to reading the
864
# parent tree from the repository.
865
self._cache_basis_inventory(leftmost_parent_id)
867
inv = leftmost_parent_tree.inventory
868
xml = self._create_basis_xml_from_inventory(
869
leftmost_parent_id, inv)
870
self._write_basis_inventory(xml)
871
self._set_merges_from_parent_ids(parent_ids)
873
@needs_tree_write_lock
874
def set_pending_merges(self, rev_list):
875
parents = self.get_parent_ids()
876
leftmost = parents[:1]
877
new_parents = leftmost + rev_list
878
self.set_parent_ids(new_parents)
880
@needs_tree_write_lock
881
def set_merge_modified(self, modified_hashes):
883
for file_id, hash in modified_hashes.iteritems():
884
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
885
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
887
def _sha_from_stat(self, path, stat_result):
888
"""Get a sha digest from the tree's stat cache.
890
The default implementation assumes no stat cache is present.
892
:param path: The path.
893
:param stat_result: The stat result being looked up.
897
def _put_rio(self, filename, stanzas, header):
898
self._must_be_locked()
899
my_file = rio_file(stanzas, header)
900
self._transport.put_file(filename, my_file,
901
mode=self.bzrdir._get_file_mode())
903
@needs_write_lock # because merge pulls data into the branch.
904
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
905
merge_type=None, force=False):
906
"""Merge from a branch into this working tree.
908
:param branch: The branch to merge from.
909
:param to_revision: If non-None, the merge will merge to to_revision,
910
but not beyond it. to_revision does not need to be in the history
911
of the branch when it is supplied. If None, to_revision defaults to
912
branch.last_revision().
914
from bzrlib.merge import Merger, Merge3Merger
915
pb = ui.ui_factory.nested_progress_bar()
917
merger = Merger(self.branch, this_tree=self, pb=pb)
918
merger.pp = ProgressPhase("Merge phase", 5, pb)
919
merger.pp.next_phase()
920
# check that there are no local alterations
921
if not force and self.has_changes():
922
raise errors.UncommittedChanges(self)
923
if to_revision is None:
924
to_revision = _mod_revision.ensure_null(branch.last_revision())
925
merger.other_rev_id = to_revision
926
if _mod_revision.is_null(merger.other_rev_id):
927
raise errors.NoCommits(branch)
928
self.branch.fetch(branch, last_revision=merger.other_rev_id)
929
merger.other_basis = merger.other_rev_id
930
merger.other_tree = self.branch.repository.revision_tree(
932
merger.other_branch = branch
933
merger.pp.next_phase()
934
if from_revision is None:
937
merger.set_base_revision(from_revision, branch)
938
if merger.base_rev_id == merger.other_rev_id:
939
raise errors.PointlessMerge
940
merger.backup_files = False
941
if merge_type is None:
942
merger.merge_type = Merge3Merger
944
merger.merge_type = merge_type
945
merger.set_interesting_files(None)
946
merger.show_base = False
947
merger.reprocess = False
948
conflicts = merger.do_merge()
955
def merge_modified(self):
956
"""Return a dictionary of files modified by a merge.
958
The list is initialized by WorkingTree.set_merge_modified, which is
959
typically called after we make some automatic updates to the tree
962
This returns a map of file_id->sha1, containing only files which are
963
still in the working inventory and have that text hash.
966
hashfile = self._transport.get('merge-hashes')
967
except errors.NoSuchFile:
972
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
973
raise errors.MergeModifiedFormatError()
974
except StopIteration:
975
raise errors.MergeModifiedFormatError()
976
for s in RioReader(hashfile):
977
# RioReader reads in Unicode, so convert file_ids back to utf8
978
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
979
if file_id not in self.inventory:
981
text_hash = s.get("hash")
982
if text_hash == self.get_file_sha1(file_id):
983
merge_hashes[file_id] = text_hash
989
def mkdir(self, path, file_id=None):
990
"""See MutableTree.mkdir()."""
992
file_id = generate_ids.gen_file_id(os.path.basename(path))
993
os.mkdir(self.abspath(path))
994
self.add(path, file_id, 'directory')
997
def get_symlink_target(self, file_id):
998
abspath = self.id2abspath(file_id)
999
target = osutils.readlink(abspath)
1003
def subsume(self, other_tree):
1004
def add_children(inventory, entry):
1005
for child_entry in entry.children.values():
1006
inventory._byid[child_entry.file_id] = child_entry
1007
if child_entry.kind == 'directory':
1008
add_children(inventory, child_entry)
1009
if other_tree.get_root_id() == self.get_root_id():
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Trees have the same root')
1013
other_tree_path = self.relpath(other_tree.basedir)
1014
except errors.PathNotChild:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Tree is not contained by the other')
1017
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1018
if new_root_parent is None:
1019
raise errors.BadSubsumeSource(self, other_tree,
1020
'Parent directory is not versioned.')
1021
# We need to ensure that the result of a fetch will have a
1022
# versionedfile for the other_tree root, and only fetching into
1023
# RepositoryKnit2 guarantees that.
1024
if not self.branch.repository.supports_rich_root():
1025
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1026
other_tree.lock_tree_write()
1028
new_parents = other_tree.get_parent_ids()
1029
other_root = other_tree.inventory.root
1030
other_root.parent_id = new_root_parent
1031
other_root.name = osutils.basename(other_tree_path)
1032
self.inventory.add(other_root)
1033
add_children(self.inventory, other_root)
1034
self._write_inventory(self.inventory)
1035
# normally we don't want to fetch whole repositories, but i think
1036
# here we really do want to consolidate the whole thing.
1037
for parent_id in other_tree.get_parent_ids():
1038
self.branch.fetch(other_tree.branch, parent_id)
1039
self.add_parent_tree_id(parent_id)
1042
other_tree.bzrdir.retire_bzrdir()
1044
def _setup_directory_is_tree_reference(self):
1045
if self._branch.repository._format.supports_tree_reference:
1046
self._directory_is_tree_reference = \
1047
self._directory_may_be_tree_reference
1049
self._directory_is_tree_reference = \
1050
self._directory_is_never_tree_reference
1052
def _directory_is_never_tree_reference(self, relpath):
1055
def _directory_may_be_tree_reference(self, relpath):
1056
# as a special case, if a directory contains control files then
1057
# it's a tree reference, except that the root of the tree is not
1058
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1059
# TODO: We could ask all the control formats whether they
1060
# recognize this directory, but at the moment there's no cheap api
1061
# to do that. Since we probably can only nest bzr checkouts and
1062
# they always use this name it's ok for now. -- mbp 20060306
1064
# FIXME: There is an unhandled case here of a subdirectory
1065
# containing .bzr but not a branch; that will probably blow up
1066
# when you try to commit it. It might happen if there is a
1067
# checkout in a subdirectory. This can be avoided by not adding
1070
@needs_tree_write_lock
1071
def extract(self, file_id, format=None):
1072
"""Extract a subtree from this tree.
1074
A new branch will be created, relative to the path for this tree.
1078
segments = osutils.splitpath(path)
1079
transport = self.branch.bzrdir.root_transport
1080
for name in segments:
1081
transport = transport.clone(name)
1082
transport.ensure_base()
1085
sub_path = self.id2path(file_id)
1086
branch_transport = mkdirs(sub_path)
1088
format = self.bzrdir.cloning_metadir()
1089
branch_transport.ensure_base()
1090
branch_bzrdir = format.initialize_on_transport(branch_transport)
1092
repo = branch_bzrdir.find_repository()
1093
except errors.NoRepositoryPresent:
1094
repo = branch_bzrdir.create_repository()
1095
if not repo.supports_rich_root():
1096
raise errors.RootNotRich()
1097
new_branch = branch_bzrdir.create_branch()
1098
new_branch.pull(self.branch)
1099
for parent_id in self.get_parent_ids():
1100
new_branch.fetch(self.branch, parent_id)
1101
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1102
if tree_transport.base != branch_transport.base:
1103
tree_bzrdir = format.initialize_on_transport(tree_transport)
1104
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1106
tree_bzrdir = branch_bzrdir
1107
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1108
wt.set_parent_ids(self.get_parent_ids())
1109
my_inv = self.inventory
1110
child_inv = inventory.Inventory(root_id=None)
1111
new_root = my_inv[file_id]
1112
my_inv.remove_recursive_id(file_id)
1113
new_root.parent_id = None
1114
child_inv.add(new_root)
1115
self._write_inventory(my_inv)
1116
wt._write_inventory(child_inv)
1119
def _serialize(self, inventory, out_file):
1120
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1123
def _deserialize(selt, in_file):
1124
return xml5.serializer_v5.read_inventory(in_file)
1127
"""Write the in memory inventory to disk."""
1128
# TODO: Maybe this should only write on dirty ?
1129
if self._control_files._lock_mode != 'w':
1130
raise errors.NotWriteLocked(self)
1132
self._serialize(self._inventory, sio)
1134
self._transport.put_file('inventory', sio,
1135
mode=self.bzrdir._get_file_mode())
1136
self._inventory_is_modified = False
1138
def _kind(self, relpath):
1139
return osutils.file_kind(self.abspath(relpath))
1141
def list_files(self, include_root=False, from_dir=None, recursive=True):
1142
"""List all files as (path, class, kind, id, entry).
1144
Lists, but does not descend into unversioned directories.
1145
This does not include files that have been deleted in this
1146
tree. Skips the control directory.
1148
:param include_root: if True, do not return an entry for the root
1149
:param from_dir: start from this directory or None for the root
1150
:param recursive: whether to recurse into subdirectories or not
1152
# list_files is an iterator, so @needs_read_lock doesn't work properly
1153
# with it. So callers should be careful to always read_lock the tree.
1154
if not self.is_locked():
1155
raise errors.ObjectNotLocked(self)
1157
inv = self.inventory
1158
if from_dir is None and include_root is True:
1159
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1160
# Convert these into local objects to save lookup times
1161
pathjoin = osutils.pathjoin
1162
file_kind = self._kind
1164
# transport.base ends in a slash, we want the piece
1165
# between the last two slashes
1166
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1168
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1170
# directory file_id, relative path, absolute path, reverse sorted children
1171
if from_dir is not None:
1172
from_dir_id = inv.path2id(from_dir)
1173
if from_dir_id is None:
1174
# Directory not versioned
1176
from_dir_abspath = pathjoin(self.basedir, from_dir)
1178
from_dir_id = inv.root.file_id
1179
from_dir_abspath = self.basedir
1180
children = os.listdir(from_dir_abspath)
1182
# jam 20060527 The kernel sized tree seems equivalent whether we
1183
# use a deque and popleft to keep them sorted, or if we use a plain
1184
# list and just reverse() them.
1185
children = collections.deque(children)
1186
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1188
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1191
f = children.popleft()
1192
## TODO: If we find a subdirectory with its own .bzr
1193
## directory, then that is a separate tree and we
1194
## should exclude it.
1196
# the bzrdir for this tree
1197
if transport_base_dir == f:
1200
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1201
# and 'f' doesn't begin with one, we can do a string op, rather
1202
# than the checks of pathjoin(), all relative paths will have an extra slash
1204
fp = from_dir_relpath + '/' + f
1207
fap = from_dir_abspath + '/' + f
1209
f_ie = inv.get_child(from_dir_id, f)
1212
elif self.is_ignored(fp[1:]):
1215
# we may not have found this file, because of a unicode issue
1216
f_norm, can_access = osutils.normalized_filename(f)
1217
if f == f_norm or not can_access:
1218
# No change, so treat this file normally
1221
# this file can be accessed by a normalized path
1222
# check again if it is versioned
1223
# these lines are repeated here for performance
1225
fp = from_dir_relpath + '/' + f
1226
fap = from_dir_abspath + '/' + f
1227
f_ie = inv.get_child(from_dir_id, f)
1230
elif self.is_ignored(fp[1:]):
1237
# make a last minute entry
1239
yield fp[1:], c, fk, f_ie.file_id, f_ie
1242
yield fp[1:], c, fk, None, fk_entries[fk]()
1244
yield fp[1:], c, fk, None, TreeEntry()
1247
if fk != 'directory':
1250
# But do this child first if recursing down
1252
new_children = os.listdir(fap)
1254
new_children = collections.deque(new_children)
1255
stack.append((f_ie.file_id, fp, fap, new_children))
1256
# Break out of inner loop,
1257
# so that we start outer loop with child
1260
# if we finished all children, pop it off the stack
1263
@needs_tree_write_lock
1264
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1267
to_dir must exist in the inventory.
1269
If to_dir exists and is a directory, the files are moved into
1270
it, keeping their old names.
1272
Note that to_dir is only the last component of the new name;
1273
this doesn't change the directory.
1275
For each entry in from_paths the move mode will be determined
1278
The first mode moves the file in the filesystem and updates the
1279
inventory. The second mode only updates the inventory without
1280
touching the file on the filesystem. This is the new mode introduced
1283
move uses the second mode if 'after == True' and the target is not
1284
versioned but present in the working tree.
1286
move uses the second mode if 'after == False' and the source is
1287
versioned but no longer in the working tree, and the target is not
1288
versioned but present in the working tree.
1290
move uses the first mode if 'after == False' and the source is
1291
versioned and present in the working tree, and the target is not
1292
versioned and not present in the working tree.
1294
Everything else results in an error.
1296
This returns a list of (from_path, to_path) pairs for each
1297
entry that is moved.
1302
# check for deprecated use of signature
1304
to_dir = kwargs.get('to_name', None)
1306
raise TypeError('You must supply a target directory')
1308
symbol_versioning.warn('The parameter to_name was deprecated'
1309
' in version 0.13. Use to_dir instead',
1312
# check destination directory
1313
if isinstance(from_paths, basestring):
1315
inv = self.inventory
1316
to_abs = self.abspath(to_dir)
1317
if not isdir(to_abs):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotADirectory(to_abs))
1320
if not self.has_filename(to_dir):
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotInWorkingDirectory(to_dir))
1323
to_dir_id = inv.path2id(to_dir)
1324
if to_dir_id is None:
1325
raise errors.BzrMoveFailedError('',to_dir,
1326
errors.NotVersionedError(path=str(to_dir)))
1328
to_dir_ie = inv[to_dir_id]
1329
if to_dir_ie.kind != 'directory':
1330
raise errors.BzrMoveFailedError('',to_dir,
1331
errors.NotADirectory(to_abs))
1333
# create rename entries and tuples
1334
for from_rel in from_paths:
1335
from_tail = splitpath(from_rel)[-1]
1336
from_id = inv.path2id(from_rel)
1338
raise errors.BzrMoveFailedError(from_rel,to_dir,
1339
errors.NotVersionedError(path=str(from_rel)))
1341
from_entry = inv[from_id]
1342
from_parent_id = from_entry.parent_id
1343
to_rel = pathjoin(to_dir, from_tail)
1344
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1346
from_tail=from_tail,
1347
from_parent_id=from_parent_id,
1348
to_rel=to_rel, to_tail=from_tail,
1349
to_parent_id=to_dir_id)
1350
rename_entries.append(rename_entry)
1351
rename_tuples.append((from_rel, to_rel))
1353
# determine which move mode to use. checks also for movability
1354
rename_entries = self._determine_mv_mode(rename_entries, after)
1356
original_modified = self._inventory_is_modified
1359
self._inventory_is_modified = True
1360
self._move(rename_entries)
1362
# restore the inventory on error
1363
self._inventory_is_modified = original_modified
1365
self._write_inventory(inv)
1366
return rename_tuples
1368
def _determine_mv_mode(self, rename_entries, after=False):
1369
"""Determines for each from-to pair if both inventory and working tree
1370
or only the inventory has to be changed.
1372
Also does basic plausability tests.
1374
inv = self.inventory
1376
for rename_entry in rename_entries:
1377
# store to local variables for easier reference
1378
from_rel = rename_entry.from_rel
1379
from_id = rename_entry.from_id
1380
to_rel = rename_entry.to_rel
1381
to_id = inv.path2id(to_rel)
1382
only_change_inv = False
1384
# check the inventory for source and destination
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.NotVersionedError(path=str(from_rel)))
1388
if to_id is not None:
1389
raise errors.BzrMoveFailedError(from_rel,to_rel,
1390
errors.AlreadyVersionedError(path=str(to_rel)))
1392
# try to determine the mode for rename (only change inv or change
1393
# inv and file system)
1395
if not self.has_filename(to_rel):
1396
raise errors.BzrMoveFailedError(from_id,to_rel,
1397
errors.NoSuchFile(path=str(to_rel),
1398
extra="New file has not been created yet"))
1399
only_change_inv = True
1400
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1401
only_change_inv = True
1402
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1403
only_change_inv = False
1404
elif (not self.case_sensitive
1405
and from_rel.lower() == to_rel.lower()
1406
and self.has_filename(from_rel)):
1407
only_change_inv = False
1409
# something is wrong, so lets determine what exactly
1410
if not self.has_filename(from_rel) and \
1411
not self.has_filename(to_rel):
1412
raise errors.BzrRenameFailedError(from_rel,to_rel,
1413
errors.PathsDoNotExist(paths=(str(from_rel),
1416
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1417
rename_entry.only_change_inv = only_change_inv
1418
return rename_entries
1420
def _move(self, rename_entries):
1421
"""Moves a list of files.
1423
Depending on the value of the flag 'only_change_inv', the
1424
file will be moved on the file system or not.
1426
inv = self.inventory
1429
for entry in rename_entries:
1431
self._move_entry(entry)
1433
self._rollback_move(moved)
1437
def _rollback_move(self, moved):
1438
"""Try to rollback a previous move in case of an filesystem error."""
1439
inv = self.inventory
1442
self._move_entry(WorkingTree._RenameEntry(
1443
entry.to_rel, entry.from_id,
1444
entry.to_tail, entry.to_parent_id, entry.from_rel,
1445
entry.from_tail, entry.from_parent_id,
1446
entry.only_change_inv))
1447
except errors.BzrMoveFailedError, e:
1448
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1449
" The working tree is in an inconsistent state."
1450
" Please consider doing a 'bzr revert'."
1451
" Error message is: %s" % e)
1453
def _move_entry(self, entry):
1454
inv = self.inventory
1455
from_rel_abs = self.abspath(entry.from_rel)
1456
to_rel_abs = self.abspath(entry.to_rel)
1457
if from_rel_abs == to_rel_abs:
1458
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1459
"Source and target are identical.")
1461
if not entry.only_change_inv:
1463
osutils.rename(from_rel_abs, to_rel_abs)
1465
raise errors.BzrMoveFailedError(entry.from_rel,
1467
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1469
@needs_tree_write_lock
1470
def rename_one(self, from_rel, to_rel, after=False):
1473
This can change the directory or the filename or both.
1475
rename_one has several 'modes' to work. First, it can rename a physical
1476
file and change the file_id. That is the normal mode. Second, it can
1477
only change the file_id without touching any physical file. This is
1478
the new mode introduced in version 0.15.
1480
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1481
versioned but present in the working tree.
1483
rename_one uses the second mode if 'after == False' and 'from_rel' is
1484
versioned but no longer in the working tree, and 'to_rel' is not
1485
versioned but present in the working tree.
1487
rename_one uses the first mode if 'after == False' and 'from_rel' is
1488
versioned and present in the working tree, and 'to_rel' is not
1489
versioned and not present in the working tree.
1491
Everything else results in an error.
1493
inv = self.inventory
1496
# create rename entries and tuples
1497
from_tail = splitpath(from_rel)[-1]
1498
from_id = inv.path2id(from_rel)
1500
# if file is missing in the inventory maybe it's in the basis_tree
1501
basis_tree = self.branch.basis_tree()
1502
from_id = basis_tree.path2id(from_rel)
1504
raise errors.BzrRenameFailedError(from_rel,to_rel,
1505
errors.NotVersionedError(path=str(from_rel)))
1506
# put entry back in the inventory so we can rename it
1507
from_entry = basis_tree.inventory[from_id].copy()
1510
from_entry = inv[from_id]
1511
from_parent_id = from_entry.parent_id
1512
to_dir, to_tail = os.path.split(to_rel)
1513
to_dir_id = inv.path2id(to_dir)
1514
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1516
from_tail=from_tail,
1517
from_parent_id=from_parent_id,
1518
to_rel=to_rel, to_tail=to_tail,
1519
to_parent_id=to_dir_id)
1520
rename_entries.append(rename_entry)
1522
# determine which move mode to use. checks also for movability
1523
rename_entries = self._determine_mv_mode(rename_entries, after)
1525
# check if the target changed directory and if the target directory is
1527
if to_dir_id is None:
1528
raise errors.BzrMoveFailedError(from_rel,to_rel,
1529
errors.NotVersionedError(path=str(to_dir)))
1531
# all checks done. now we can continue with our actual work
1532
mutter('rename_one:\n'
1537
' to_dir_id {%s}\n',
1538
from_id, from_rel, to_rel, to_dir, to_dir_id)
1540
self._move(rename_entries)
1541
self._write_inventory(inv)
1543
class _RenameEntry(object):
1544
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1545
to_rel, to_tail, to_parent_id, only_change_inv=False):
1546
self.from_rel = from_rel
1547
self.from_id = from_id
1548
self.from_tail = from_tail
1549
self.from_parent_id = from_parent_id
1550
self.to_rel = to_rel
1551
self.to_tail = to_tail
1552
self.to_parent_id = to_parent_id
1553
self.only_change_inv = only_change_inv
1557
"""Return all unknown files.
1559
These are files in the working directory that are not versioned or
1560
control files or ignored.
1562
# force the extras method to be fully executed before returning, to
1563
# prevent race conditions with the lock
1565
[subp for subp in self.extras() if not self.is_ignored(subp)])
1567
@needs_tree_write_lock
1568
def unversion(self, file_ids):
1569
"""Remove the file ids in file_ids from the current versioned set.
1571
When a file_id is unversioned, all of its children are automatically
1574
:param file_ids: The file ids to stop versioning.
1575
:raises: NoSuchId if any fileid is not currently versioned.
1577
for file_id in file_ids:
1578
if file_id not in self._inventory:
1579
raise errors.NoSuchId(self, file_id)
1580
for file_id in file_ids:
1581
if self._inventory.has_id(file_id):
1582
self._inventory.remove_recursive_id(file_id)
1584
# in the future this should just set a dirty bit to wait for the
1585
# final unlock. However, until all methods of workingtree start
1586
# with the current in -memory inventory rather than triggering
1587
# a read, it is more complex - we need to teach read_inventory
1588
# to know when to read, and when to not read first... and possibly
1589
# to save first when the in memory one may be corrupted.
1590
# so for now, we just only write it if it is indeed dirty.
1592
self._write_inventory(self._inventory)
1594
def _iter_conflicts(self):
1596
for info in self.list_files():
1598
stem = get_conflicted_stem(path)
1601
if stem not in conflicted:
1602
conflicted.add(stem)
1606
def pull(self, source, overwrite=False, stop_revision=None,
1607
change_reporter=None, possible_transports=None, local=False):
1608
top_pb = ui.ui_factory.nested_progress_bar()
1611
pp = ProgressPhase("Pull phase", 2, top_pb)
1613
old_revision_info = self.branch.last_revision_info()
1614
basis_tree = self.basis_tree()
1615
count = self.branch.pull(source, overwrite, stop_revision,
1616
possible_transports=possible_transports,
1618
new_revision_info = self.branch.last_revision_info()
1619
if new_revision_info != old_revision_info:
1621
repository = self.branch.repository
1622
pb = ui.ui_factory.nested_progress_bar()
1623
basis_tree.lock_read()
1625
new_basis_tree = self.branch.basis_tree()
1632
change_reporter=change_reporter)
1633
if (basis_tree.inventory.root is None and
1634
new_basis_tree.inventory.root is not None):
1635
self.set_root_id(new_basis_tree.get_root_id())
1639
# TODO - dedup parents list with things merged by pull ?
1640
# reuse the revisiontree we merged against to set the new
1642
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1643
# we have to pull the merge trees out again, because
1644
# merge_inner has set the ids. - this corner is not yet
1645
# layered well enough to prevent double handling.
1646
# XXX TODO: Fix the double handling: telling the tree about
1647
# the already known parent data is wasteful.
1648
merges = self.get_parent_ids()[1:]
1649
parent_trees.extend([
1650
(parent, repository.revision_tree(parent)) for
1652
self.set_parent_trees(parent_trees)
1659
def put_file_bytes_non_atomic(self, file_id, bytes):
1660
"""See MutableTree.put_file_bytes_non_atomic."""
1661
stream = file(self.id2abspath(file_id), 'wb')
1666
# TODO: update the hashcache here ?
1669
"""Yield all unversioned files in this WorkingTree.
1671
If there are any unversioned directories then only the directory is
1672
returned, not all its children. But if there are unversioned files
1673
under a versioned subdirectory, they are returned.
1675
Currently returned depth-first, sorted by name within directories.
1676
This is the same order used by 'osutils.walkdirs'.
1678
## TODO: Work from given directory downwards
1679
for path, dir_entry in self.inventory.directories():
1680
# mutter("search for unknowns in %r", path)
1681
dirabs = self.abspath(path)
1682
if not isdir(dirabs):
1683
# e.g. directory deleted
1687
for subf in os.listdir(dirabs):
1688
if self.bzrdir.is_control_filename(subf):
1690
if subf not in dir_entry.children:
1693
can_access) = osutils.normalized_filename(subf)
1694
except UnicodeDecodeError:
1695
path_os_enc = path.encode(osutils._fs_enc)
1696
relpath = path_os_enc + '/' + subf
1697
raise errors.BadFilenameEncoding(relpath,
1699
if subf_norm != subf and can_access:
1700
if subf_norm not in dir_entry.children:
1701
fl.append(subf_norm)
1707
subp = pathjoin(path, subf)
1710
def ignored_files(self):
1711
"""Yield list of PATH, IGNORE_PATTERN"""
1712
for subp in self.extras():
1713
pat = self.is_ignored(subp)
1717
def get_ignore_list(self):
1718
"""Return list of ignore patterns.
1720
Cached in the Tree object after the first call.
1722
ignoreset = getattr(self, '_ignoreset', None)
1723
if ignoreset is not None:
1726
ignore_globs = set()
1727
ignore_globs.update(ignores.get_runtime_ignores())
1728
ignore_globs.update(ignores.get_user_ignores())
1729
if self.has_filename(bzrlib.IGNORE_FILENAME):
1730
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1732
ignore_globs.update(ignores.parse_ignore_file(f))
1735
self._ignoreset = ignore_globs
1738
def _flush_ignore_list_cache(self):
1739
"""Resets the cached ignore list to force a cache rebuild."""
1740
self._ignoreset = None
1741
self._ignoreglobster = None
1743
def is_ignored(self, filename):
1744
r"""Check whether the filename matches an ignore pattern.
1746
Patterns containing '/' or '\' need to match the whole path;
1747
others match against only the last component.
1749
If the file is ignored, returns the pattern which caused it to
1750
be ignored, otherwise None. So this can simply be used as a
1751
boolean if desired."""
1752
if getattr(self, '_ignoreglobster', None) is None:
1753
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1754
return self._ignoreglobster.match(filename)
1756
def kind(self, file_id):
1757
return file_kind(self.id2abspath(file_id))
1759
def stored_kind(self, file_id):
1760
"""See Tree.stored_kind"""
1761
return self.inventory[file_id].kind
1763
def _comparison_data(self, entry, path):
1764
abspath = self.abspath(path)
1766
stat_value = os.lstat(abspath)
1768
if getattr(e, 'errno', None) == errno.ENOENT:
1775
mode = stat_value.st_mode
1776
kind = osutils.file_kind_from_stat_mode(mode)
1777
if not supports_executable():
1778
executable = entry is not None and entry.executable
1780
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1781
return kind, executable, stat_value
1783
def _file_size(self, entry, stat_value):
1784
return stat_value.st_size
1786
def last_revision(self):
1787
"""Return the last revision of the branch for this tree.
1789
This format tree does not support a separate marker for last-revision
1790
compared to the branch.
1792
See MutableTree.last_revision
1794
return self._last_revision()
1797
def _last_revision(self):
1798
"""helper for get_parent_ids."""
1799
return _mod_revision.ensure_null(self.branch.last_revision())
1801
def is_locked(self):
1802
return self._control_files.is_locked()
1804
def _must_be_locked(self):
1805
if not self.is_locked():
1806
raise errors.ObjectNotLocked(self)
1808
def lock_read(self):
1809
"""See Branch.lock_read, and WorkingTree.unlock."""
1810
if not self.is_locked():
1812
self.branch.lock_read()
1814
return self._control_files.lock_read()
1816
self.branch.unlock()
1819
def lock_tree_write(self):
1820
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1821
if not self.is_locked():
1823
self.branch.lock_read()
1825
return self._control_files.lock_write()
1827
self.branch.unlock()
1830
def lock_write(self):
1831
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1832
if not self.is_locked():
1834
self.branch.lock_write()
1836
return self._control_files.lock_write()
1838
self.branch.unlock()
1841
def get_physical_lock_status(self):
1842
return self._control_files.get_physical_lock_status()
1844
def _basis_inventory_name(self):
1845
return 'basis-inventory-cache'
1847
def _reset_data(self):
1848
"""Reset transient data that cannot be revalidated."""
1849
self._inventory_is_modified = False
1850
f = self._transport.get('inventory')
1852
result = self._deserialize(f)
1855
self._set_inventory(result, dirty=False)
1857
@needs_tree_write_lock
1858
def set_last_revision(self, new_revision):
1859
"""Change the last revision in the working tree."""
1860
if self._change_last_revision(new_revision):
1861
self._cache_basis_inventory(new_revision)
1863
def _change_last_revision(self, new_revision):
1864
"""Template method part of set_last_revision to perform the change.
1866
This is used to allow WorkingTree3 instances to not affect branch
1867
when their last revision is set.
1869
if _mod_revision.is_null(new_revision):
1870
self.branch.set_revision_history([])
1873
self.branch.generate_revision_history(new_revision)
1874
except errors.NoSuchRevision:
1875
# not present in the repo - dont try to set it deeper than the tip
1876
self.branch.set_revision_history([new_revision])
1879
def _write_basis_inventory(self, xml):
1880
"""Write the basis inventory XML to the basis-inventory file"""
1881
path = self._basis_inventory_name()
1883
self._transport.put_file(path, sio,
1884
mode=self.bzrdir._get_file_mode())
1886
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1887
"""Create the text that will be saved in basis-inventory"""
1888
inventory.revision_id = revision_id
1889
return xml7.serializer_v7.write_inventory_to_string(inventory)
1891
def _cache_basis_inventory(self, new_revision):
1892
"""Cache new_revision as the basis inventory."""
1893
# TODO: this should allow the ready-to-use inventory to be passed in,
1894
# as commit already has that ready-to-use [while the format is the
1897
# this double handles the inventory - unpack and repack -
1898
# but is easier to understand. We can/should put a conditional
1899
# in here based on whether the inventory is in the latest format
1900
# - perhaps we should repack all inventories on a repository
1902
# the fast path is to copy the raw xml from the repository. If the
1903
# xml contains 'revision_id="', then we assume the right
1904
# revision_id is set. We must check for this full string, because a
1905
# root node id can legitimately look like 'revision_id' but cannot
1907
xml = self.branch.repository.get_inventory_xml(new_revision)
1908
firstline = xml.split('\n', 1)[0]
1909
if (not 'revision_id="' in firstline or
1910
'format="7"' not in firstline):
1911
inv = self.branch.repository._serializer.read_inventory_from_string(
1913
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1914
self._write_basis_inventory(xml)
1915
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1918
def read_basis_inventory(self):
1919
"""Read the cached basis inventory."""
1920
path = self._basis_inventory_name()
1921
return self._transport.get_bytes(path)
1924
def read_working_inventory(self):
1925
"""Read the working inventory.
1927
:raises errors.InventoryModified: read_working_inventory will fail
1928
when the current in memory inventory has been modified.
1930
# conceptually this should be an implementation detail of the tree.
1931
# XXX: Deprecate this.
1932
# ElementTree does its own conversion from UTF-8, so open in
1934
if self._inventory_is_modified:
1935
raise errors.InventoryModified(self)
1936
f = self._transport.get('inventory')
1938
result = self._deserialize(f)
1941
self._set_inventory(result, dirty=False)
1944
@needs_tree_write_lock
1945
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1947
"""Remove nominated files from the working inventory.
1949
:files: File paths relative to the basedir.
1950
:keep_files: If true, the files will also be kept.
1951
:force: Delete files and directories, even if they are changed and
1952
even if the directories are not empty.
1954
if isinstance(files, basestring):
1960
unknown_nested_files=set()
1962
to_file = sys.stdout
1964
def recurse_directory_to_add_files(directory):
1965
# Recurse directory and add all files
1966
# so we can check if they have changed.
1967
for parent_info, file_infos in\
1968
self.walkdirs(directory):
1969
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1970
# Is it versioned or ignored?
1971
if self.path2id(relpath) or self.is_ignored(relpath):
1972
# Add nested content for deletion.
1973
new_files.add(relpath)
1975
# Files which are not versioned and not ignored
1976
# should be treated as unknown.
1977
unknown_nested_files.add((relpath, None, kind))
1979
for filename in files:
1980
# Get file name into canonical form.
1981
abspath = self.abspath(filename)
1982
filename = self.relpath(abspath)
1983
if len(filename) > 0:
1984
new_files.add(filename)
1985
recurse_directory_to_add_files(filename)
1987
files = list(new_files)
1990
return # nothing to do
1992
# Sort needed to first handle directory content before the directory
1993
files.sort(reverse=True)
1995
# Bail out if we are going to delete files we shouldn't
1996
if not keep_files and not force:
1997
has_changed_files = len(unknown_nested_files) > 0
1998
if not has_changed_files:
1999
for (file_id, path, content_change, versioned, parent_id, name,
2000
kind, executable) in self.iter_changes(self.basis_tree(),
2001
include_unchanged=True, require_versioned=False,
2002
want_unversioned=True, specific_files=files):
2003
if versioned == (False, False):
2004
# The record is unknown ...
2005
if not self.is_ignored(path[1]):
2006
# ... but not ignored
2007
has_changed_files = True
2009
elif content_change and (kind[1] is not None):
2010
# Versioned and changed, but not deleted
2011
has_changed_files = True
2014
if has_changed_files:
2015
# Make delta show ALL applicable changes in error message.
2016
tree_delta = self.changes_from(self.basis_tree(),
2017
require_versioned=False, want_unversioned=True,
2018
specific_files=files)
2019
for unknown_file in unknown_nested_files:
2020
if unknown_file not in tree_delta.unversioned:
2021
tree_delta.unversioned.extend((unknown_file,))
2022
raise errors.BzrRemoveChangedFilesError(tree_delta)
2024
# Build inv_delta and delete files where applicable,
2025
# do this before any modifications to inventory.
2027
fid = self.path2id(f)
2030
message = "%s is not versioned." % (f,)
2033
# having removed it, it must be either ignored or unknown
2034
if self.is_ignored(f):
2038
# XXX: Really should be a more abstract reporter interface
2039
kind_ch = osutils.kind_marker(self.kind(fid))
2040
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2042
inv_delta.append((f, None, fid, None))
2043
message = "removed %s" % (f,)
2046
abs_path = self.abspath(f)
2047
if osutils.lexists(abs_path):
2048
if (osutils.isdir(abs_path) and
2049
len(os.listdir(abs_path)) > 0):
2051
osutils.rmtree(abs_path)
2053
message = "%s is not an empty directory "\
2054
"and won't be deleted." % (f,)
2056
osutils.delete_any(abs_path)
2057
message = "deleted %s" % (f,)
2058
elif message is not None:
2059
# Only care if we haven't done anything yet.
2060
message = "%s does not exist." % (f,)
2062
# Print only one message (if any) per file.
2063
if message is not None:
2065
self.apply_inventory_delta(inv_delta)
2067
@needs_tree_write_lock
2068
def revert(self, filenames=None, old_tree=None, backups=True,
2069
pb=DummyProgress(), report_changes=False):
2070
from bzrlib.conflicts import resolve
2073
symbol_versioning.warn('Using [] to revert all files is deprecated'
2074
' as of bzr 0.91. Please use None (the default) instead.',
2075
DeprecationWarning, stacklevel=2)
2076
if old_tree is None:
2077
basis_tree = self.basis_tree()
2078
basis_tree.lock_read()
2079
old_tree = basis_tree
2083
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2085
if filenames is None and len(self.get_parent_ids()) > 1:
2087
last_revision = self.last_revision()
2088
if last_revision != _mod_revision.NULL_REVISION:
2089
if basis_tree is None:
2090
basis_tree = self.basis_tree()
2091
basis_tree.lock_read()
2092
parent_trees.append((last_revision, basis_tree))
2093
self.set_parent_trees(parent_trees)
2096
resolve(self, filenames, ignore_misses=True, recursive=True)
2098
if basis_tree is not None:
2102
def revision_tree(self, revision_id):
2103
"""See Tree.revision_tree.
2105
WorkingTree can supply revision_trees for the basis revision only
2106
because there is only one cached inventory in the bzr directory.
2108
if revision_id == self.last_revision():
2110
xml = self.read_basis_inventory()
2111
except errors.NoSuchFile:
2115
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2116
# dont use the repository revision_tree api because we want
2117
# to supply the inventory.
2118
if inv.revision_id == revision_id:
2119
return revisiontree.RevisionTree(self.branch.repository,
2121
except errors.BadInventoryFormat:
2123
# raise if there was no inventory, or if we read the wrong inventory.
2124
raise errors.NoSuchRevisionInTree(self, revision_id)
2126
# XXX: This method should be deprecated in favour of taking in a proper
2127
# new Inventory object.
2128
@needs_tree_write_lock
2129
def set_inventory(self, new_inventory_list):
2130
from bzrlib.inventory import (Inventory,
2134
inv = Inventory(self.get_root_id())
2135
for path, file_id, parent, kind in new_inventory_list:
2136
name = os.path.basename(path)
2139
# fixme, there should be a factory function inv,add_??
2140
if kind == 'directory':
2141
inv.add(InventoryDirectory(file_id, name, parent))
2142
elif kind == 'file':
2143
inv.add(InventoryFile(file_id, name, parent))
2144
elif kind == 'symlink':
2145
inv.add(InventoryLink(file_id, name, parent))
2147
raise errors.BzrError("unknown kind %r" % kind)
2148
self._write_inventory(inv)
2150
@needs_tree_write_lock
2151
def set_root_id(self, file_id):
2152
"""Set the root id for this tree."""
2156
'WorkingTree.set_root_id with fileid=None')
2157
file_id = osutils.safe_file_id(file_id)
2158
self._set_root_id(file_id)
2160
def _set_root_id(self, file_id):
2161
"""Set the root id for this tree, in a format specific manner.
2163
:param file_id: The file id to assign to the root. It must not be
2164
present in the current inventory or an error will occur. It must
2165
not be None, but rather a valid file id.
2167
inv = self._inventory
2168
orig_root_id = inv.root.file_id
2169
# TODO: it might be nice to exit early if there was nothing
2170
# to do, saving us from trigger a sync on unlock.
2171
self._inventory_is_modified = True
2172
# we preserve the root inventory entry object, but
2173
# unlinkit from the byid index
2174
del inv._byid[inv.root.file_id]
2175
inv.root.file_id = file_id
2176
# and link it into the index with the new changed id.
2177
inv._byid[inv.root.file_id] = inv.root
2178
# and finally update all children to reference the new id.
2179
# XXX: this should be safe to just look at the root.children
2180
# list, not the WHOLE INVENTORY.
2183
if entry.parent_id == orig_root_id:
2184
entry.parent_id = inv.root.file_id
2187
"""See Branch.unlock.
2189
WorkingTree locking just uses the Branch locking facilities.
2190
This is current because all working trees have an embedded branch
2191
within them. IF in the future, we were to make branch data shareable
2192
between multiple working trees, i.e. via shared storage, then we
2193
would probably want to lock both the local tree, and the branch.
2195
raise NotImplementedError(self.unlock)
2197
def update(self, change_reporter=None, possible_transports=None):
2198
"""Update a working tree along its branch.
2200
This will update the branch if its bound too, which means we have
2201
multiple trees involved:
2203
- The new basis tree of the master.
2204
- The old basis tree of the branch.
2205
- The old basis tree of the working tree.
2206
- The current working tree state.
2208
Pathologically, all three may be different, and non-ancestors of each
2209
other. Conceptually we want to:
2211
- Preserve the wt.basis->wt.state changes
2212
- Transform the wt.basis to the new master basis.
2213
- Apply a merge of the old branch basis to get any 'local' changes from
2215
- Restore the wt.basis->wt.state changes.
2217
There isn't a single operation at the moment to do that, so we:
2218
- Merge current state -> basis tree of the master w.r.t. the old tree
2220
- Do a 'normal' merge of the old branch basis if it is relevant.
2222
if self.branch.get_bound_location() is not None:
2224
update_branch = True
2226
self.lock_tree_write()
2227
update_branch = False
2230
old_tip = self.branch.update(possible_transports)
2233
return self._update_tree(old_tip, change_reporter)
2237
@needs_tree_write_lock
2238
def _update_tree(self, old_tip=None, change_reporter=None):
2239
"""Update a tree to the master branch.
2241
:param old_tip: if supplied, the previous tip revision the branch,
2242
before it was changed to the master branch's tip.
2244
# here if old_tip is not None, it is the old tip of the branch before
2245
# it was updated from the master branch. This should become a pending
2246
# merge in the working tree to preserve the user existing work. we
2247
# cant set that until we update the working trees last revision to be
2248
# one from the new branch, because it will just get absorbed by the
2249
# parent de-duplication logic.
2251
# We MUST save it even if an error occurs, because otherwise the users
2252
# local work is unreferenced and will appear to have been lost.
2256
last_rev = self.get_parent_ids()[0]
2258
last_rev = _mod_revision.NULL_REVISION
2259
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2260
# merge tree state up to new branch tip.
2261
basis = self.basis_tree()
2264
to_tree = self.branch.basis_tree()
2265
if basis.inventory.root is None:
2266
self.set_root_id(to_tree.get_root_id())
2268
result += merge.merge_inner(
2273
change_reporter=change_reporter)
2276
# TODO - dedup parents list with things merged by pull ?
2277
# reuse the tree we've updated to to set the basis:
2278
parent_trees = [(self.branch.last_revision(), to_tree)]
2279
merges = self.get_parent_ids()[1:]
2280
# Ideally we ask the tree for the trees here, that way the working
2281
# tree can decide whether to give us the entire tree or give us a
2282
# lazy initialised tree. dirstate for instance will have the trees
2283
# in ram already, whereas a last-revision + basis-inventory tree
2284
# will not, but also does not need them when setting parents.
2285
for parent in merges:
2286
parent_trees.append(
2287
(parent, self.branch.repository.revision_tree(parent)))
2288
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2289
parent_trees.append(
2290
(old_tip, self.branch.repository.revision_tree(old_tip)))
2291
self.set_parent_trees(parent_trees)
2292
last_rev = parent_trees[0][0]
2294
# the working tree had the same last-revision as the master
2295
# branch did. We may still have pivot local work from the local
2296
# branch into old_tip:
2297
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2298
self.add_parent_tree_id(old_tip)
2299
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2300
and old_tip != last_rev):
2301
# our last revision was not the prior branch last revision
2302
# and we have converted that last revision to a pending merge.
2303
# base is somewhere between the branch tip now
2304
# and the now pending merge
2306
# Since we just modified the working tree and inventory, flush out
2307
# the current state, before we modify it again.
2308
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2309
# requires it only because TreeTransform directly munges the
2310
# inventory and calls tree._write_inventory(). Ultimately we
2311
# should be able to remove this extra flush.
2313
graph = self.branch.repository.get_graph()
2314
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2316
base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
other_tree = self.branch.repository.revision_tree(old_tip)
2318
result += merge.merge_inner(
2323
change_reporter=change_reporter)
2326
def _write_hashcache_if_dirty(self):
2327
"""Write out the hashcache if it is dirty."""
2328
if self._hashcache.needs_write:
2330
self._hashcache.write()
2332
if e.errno not in (errno.EPERM, errno.EACCES):
2334
# TODO: jam 20061219 Should this be a warning? A single line
2335
# warning might be sufficient to let the user know what
2337
mutter('Could not write hashcache for %s\nError: %s',
2338
self._hashcache.cache_file_name(), e)
2340
@needs_tree_write_lock
2341
def _write_inventory(self, inv):
2342
"""Write inventory as the current inventory."""
2343
self._set_inventory(inv, dirty=True)
2346
def set_conflicts(self, arg):
2347
raise errors.UnsupportedOperation(self.set_conflicts, self)
2349
def add_conflicts(self, arg):
2350
raise errors.UnsupportedOperation(self.add_conflicts, self)
2353
def conflicts(self):
2354
conflicts = _mod_conflicts.ConflictList()
2355
for conflicted in self._iter_conflicts():
2358
if file_kind(self.abspath(conflicted)) != "file":
2360
except errors.NoSuchFile:
2363
for suffix in ('.THIS', '.OTHER'):
2365
kind = file_kind(self.abspath(conflicted+suffix))
2368
except errors.NoSuchFile:
2372
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2373
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2375
file_id=self.path2id(conflicted)))
2378
def walkdirs(self, prefix=""):
2379
"""Walk the directories of this tree.
2381
returns a generator which yields items in the form:
2382
((curren_directory_path, fileid),
2383
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2386
This API returns a generator, which is only valid during the current
2387
tree transaction - within a single lock_read or lock_write duration.
2389
If the tree is not locked, it may cause an error to be raised,
2390
depending on the tree implementation.
2392
disk_top = self.abspath(prefix)
2393
if disk_top.endswith('/'):
2394
disk_top = disk_top[:-1]
2395
top_strip_len = len(disk_top) + 1
2396
inventory_iterator = self._walkdirs(prefix)
2397
disk_iterator = osutils.walkdirs(disk_top, prefix)
2399
current_disk = disk_iterator.next()
2400
disk_finished = False
2402
if not (e.errno == errno.ENOENT or
2403
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2406
disk_finished = True
2408
current_inv = inventory_iterator.next()
2409
inv_finished = False
2410
except StopIteration:
2413
while not inv_finished or not disk_finished:
2415
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2416
cur_disk_dir_content) = current_disk
2418
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2419
cur_disk_dir_content) = ((None, None), None)
2420
if not disk_finished:
2421
# strip out .bzr dirs
2422
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2423
len(cur_disk_dir_content) > 0):
2424
# osutils.walkdirs can be made nicer -
2425
# yield the path-from-prefix rather than the pathjoined
2427
bzrdir_loc = bisect_left(cur_disk_dir_content,
2429
if (bzrdir_loc < len(cur_disk_dir_content)
2430
and self.bzrdir.is_control_filename(
2431
cur_disk_dir_content[bzrdir_loc][0])):
2432
# we dont yield the contents of, or, .bzr itself.
2433
del cur_disk_dir_content[bzrdir_loc]
2435
# everything is unknown
2438
# everything is missing
2441
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2443
# disk is before inventory - unknown
2444
dirblock = [(relpath, basename, kind, stat, None, None) for
2445
relpath, basename, kind, stat, top_path in
2446
cur_disk_dir_content]
2447
yield (cur_disk_dir_relpath, None), dirblock
2449
current_disk = disk_iterator.next()
2450
except StopIteration:
2451
disk_finished = True
2453
# inventory is before disk - missing.
2454
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2455
for relpath, basename, dkind, stat, fileid, kind in
2457
yield (current_inv[0][0], current_inv[0][1]), dirblock
2459
current_inv = inventory_iterator.next()
2460
except StopIteration:
2463
# versioned present directory
2464
# merge the inventory and disk data together
2466
for relpath, subiterator in itertools.groupby(sorted(
2467
current_inv[1] + cur_disk_dir_content,
2468
key=operator.itemgetter(0)), operator.itemgetter(1)):
2469
path_elements = list(subiterator)
2470
if len(path_elements) == 2:
2471
inv_row, disk_row = path_elements
2472
# versioned, present file
2473
dirblock.append((inv_row[0],
2474
inv_row[1], disk_row[2],
2475
disk_row[3], inv_row[4],
2477
elif len(path_elements[0]) == 5:
2479
dirblock.append((path_elements[0][0],
2480
path_elements[0][1], path_elements[0][2],
2481
path_elements[0][3], None, None))
2482
elif len(path_elements[0]) == 6:
2483
# versioned, absent file.
2484
dirblock.append((path_elements[0][0],
2485
path_elements[0][1], 'unknown', None,
2486
path_elements[0][4], path_elements[0][5]))
2488
raise NotImplementedError('unreachable code')
2489
yield current_inv[0], dirblock
2491
current_inv = inventory_iterator.next()
2492
except StopIteration:
2495
current_disk = disk_iterator.next()
2496
except StopIteration:
2497
disk_finished = True
2499
def _walkdirs(self, prefix=""):
2500
"""Walk the directories of this tree.
2502
:prefix: is used as the directrory to start with.
2503
returns a generator which yields items in the form:
2504
((curren_directory_path, fileid),
2505
[(file1_path, file1_name, file1_kind, None, file1_id,
2508
_directory = 'directory'
2509
# get the root in the inventory
2510
inv = self.inventory
2511
top_id = inv.path2id(prefix)
2515
pending = [(prefix, '', _directory, None, top_id, None)]
2518
currentdir = pending.pop()
2519
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2520
top_id = currentdir[4]
2522
relroot = currentdir[0] + '/'
2525
# FIXME: stash the node in pending
2527
if entry.kind == 'directory':
2528
for name, child in entry.sorted_children():
2529
dirblock.append((relroot + name, name, child.kind, None,
2530
child.file_id, child.kind
2532
yield (currentdir[0], entry.file_id), dirblock
2533
# push the user specified dirs from dirblock
2534
for dir in reversed(dirblock):
2535
if dir[2] == _directory:
2538
@needs_tree_write_lock
2539
def auto_resolve(self):
2540
"""Automatically resolve text conflicts according to contents.
2542
Only text conflicts are auto_resolvable. Files with no conflict markers
2543
are considered 'resolved', because bzr always puts conflict markers
2544
into files that have text conflicts. The corresponding .THIS .BASE and
2545
.OTHER files are deleted, as per 'resolve'.
2546
:return: a tuple of ConflictLists: (un_resolved, resolved).
2548
un_resolved = _mod_conflicts.ConflictList()
2549
resolved = _mod_conflicts.ConflictList()
2550
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2551
for conflict in self.conflicts():
2552
if (conflict.typestring != 'text conflict' or
2553
self.kind(conflict.file_id) != 'file'):
2554
un_resolved.append(conflict)
2556
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2558
for line in my_file:
2559
if conflict_re.search(line):
2560
un_resolved.append(conflict)
2563
resolved.append(conflict)
2566
resolved.remove_files(self)
2567
self.set_conflicts(un_resolved)
2568
return un_resolved, resolved
2571
def _check(self, references):
2572
"""Check the tree for consistency.
2574
:param references: A dict with keys matching the items returned by
2575
self._get_check_refs(), and values from looking those keys up in
2578
tree_basis = self.basis_tree()
2579
tree_basis.lock_read()
2581
repo_basis = references[('trees', self.last_revision())]
2582
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2583
raise errors.BzrCheckError(
2584
"Mismatched basis inventory content.")
2589
def _validate(self):
2590
"""Validate internal structures.
2592
This is meant mostly for the test suite. To give it a chance to detect
2593
corruption after actions have occurred. The default implementation is a
2596
:return: None. An exception should be raised if there is an error.
2600
def _get_rules_searcher(self, default_searcher):
2601
"""See Tree._get_rules_searcher."""
2602
if self._rules_searcher is None:
2603
self._rules_searcher = super(WorkingTree,
2604
self)._get_rules_searcher(default_searcher)
2605
return self._rules_searcher
2607
def get_shelf_manager(self):
2608
"""Return the ShelfManager for this WorkingTree."""
2609
from bzrlib.shelf import ShelfManager
2610
return ShelfManager(self, self._transport)
2613
class WorkingTree2(WorkingTree):
2614
"""This is the Format 2 working tree.
2616
This was the first weave based working tree.
2617
- uses os locks for locking.
2618
- uses the branch last-revision.
2621
def __init__(self, *args, **kwargs):
2622
super(WorkingTree2, self).__init__(*args, **kwargs)
2623
# WorkingTree2 has more of a constraint that self._inventory must
2624
# exist. Because this is an older format, we don't mind the overhead
2625
# caused by the extra computation here.
2627
# Newer WorkingTree's should only have self._inventory set when they
2629
if self._inventory is None:
2630
self.read_working_inventory()
2632
def _get_check_refs(self):
2633
"""Return the references needed to perform a check of this tree."""
2634
return [('trees', self.last_revision())]
2636
def lock_tree_write(self):
2637
"""See WorkingTree.lock_tree_write().
2639
In Format2 WorkingTrees we have a single lock for the branch and tree
2640
so lock_tree_write() degrades to lock_write().
2642
self.branch.lock_write()
2644
return self._control_files.lock_write()
2646
self.branch.unlock()
2650
# do non-implementation specific cleanup
2653
# we share control files:
2654
if self._control_files._lock_count == 3:
2655
# _inventory_is_modified is always False during a read lock.
2656
if self._inventory_is_modified:
2658
self._write_hashcache_if_dirty()
2660
# reverse order of locking.
2662
return self._control_files.unlock()
2664
self.branch.unlock()
2667
class WorkingTree3(WorkingTree):
2668
"""This is the Format 3 working tree.
2670
This differs from the base WorkingTree by:
2671
- having its own file lock
2672
- having its own last-revision property.
2674
This is new in bzr 0.8
2678
def _last_revision(self):
2679
"""See Mutable.last_revision."""
2681
return self._transport.get_bytes('last-revision')
2682
except errors.NoSuchFile:
2683
return _mod_revision.NULL_REVISION
2685
def _change_last_revision(self, revision_id):
2686
"""See WorkingTree._change_last_revision."""
2687
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2689
self._transport.delete('last-revision')
2690
except errors.NoSuchFile:
2694
self._transport.put_bytes('last-revision', revision_id,
2695
mode=self.bzrdir._get_file_mode())
2698
def _get_check_refs(self):
2699
"""Return the references needed to perform a check of this tree."""
2700
return [('trees', self.last_revision())]
2702
@needs_tree_write_lock
2703
def set_conflicts(self, conflicts):
2704
self._put_rio('conflicts', conflicts.to_stanzas(),
2707
@needs_tree_write_lock
2708
def add_conflicts(self, new_conflicts):
2709
conflict_set = set(self.conflicts())
2710
conflict_set.update(set(list(new_conflicts)))
2711
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2712
key=_mod_conflicts.Conflict.sort_key)))
2715
def conflicts(self):
2717
confile = self._transport.get('conflicts')
2718
except errors.NoSuchFile:
2719
return _mod_conflicts.ConflictList()
2722
if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
raise errors.ConflictFormatError()
2724
except StopIteration:
2725
raise errors.ConflictFormatError()
2726
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2731
# do non-implementation specific cleanup
2733
if self._control_files._lock_count == 1:
2734
# _inventory_is_modified is always False during a read lock.
2735
if self._inventory_is_modified:
2737
self._write_hashcache_if_dirty()
2738
# reverse order of locking.
2740
return self._control_files.unlock()
2742
self.branch.unlock()
2745
def get_conflicted_stem(path):
2746
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2747
if path.endswith(suffix):
2748
return path[:-len(suffix)]
2751
class WorkingTreeFormat(object):
2752
"""An encapsulation of the initialization and open routines for a format.
2754
Formats provide three things:
2755
* An initialization routine,
2759
Formats are placed in an dict by their format string for reference
2760
during workingtree opening. Its not required that these be instances, they
2761
can be classes themselves with class methods - it simply depends on
2762
whether state is needed for a given format or not.
2764
Once a format is deprecated, just deprecate the initialize and open
2765
methods on the format class. Do not deprecate the object, as the
2766
object will be created every time regardless.
2769
_default_format = None
2770
"""The default format used for new trees."""
2773
"""The known formats."""
2775
requires_rich_root = False
2777
upgrade_recommended = False
2780
def find_format(klass, a_bzrdir):
2781
"""Return the format for the working tree object in a_bzrdir."""
2783
transport = a_bzrdir.get_workingtree_transport(None)
2784
format_string = transport.get_bytes("format")
2785
return klass._formats[format_string]
2786
except errors.NoSuchFile:
2787
raise errors.NoWorkingTree(base=transport.base)
2789
raise errors.UnknownFormatError(format=format_string,
2790
kind="working tree")
2792
def __eq__(self, other):
2793
return self.__class__ is other.__class__
2795
def __ne__(self, other):
2796
return not (self == other)
2799
def get_default_format(klass):
2800
"""Return the current default format."""
2801
return klass._default_format
2803
def get_format_string(self):
2804
"""Return the ASCII format string that identifies this format."""
2805
raise NotImplementedError(self.get_format_string)
2807
def get_format_description(self):
2808
"""Return the short description for this format."""
2809
raise NotImplementedError(self.get_format_description)
2811
def is_supported(self):
2812
"""Is this format supported?
2814
Supported formats can be initialized and opened.
2815
Unsupported formats may not support initialization or committing or
2816
some other features depending on the reason for not being supported.
2820
def supports_content_filtering(self):
2821
"""True if this format supports content filtering."""
2824
def supports_views(self):
2825
"""True if this format supports stored views."""
2829
def register_format(klass, format):
2830
klass._formats[format.get_format_string()] = format
2833
def set_default_format(klass, format):
2834
klass._default_format = format
2837
def unregister_format(klass, format):
2838
del klass._formats[format.get_format_string()]
2841
class WorkingTreeFormat2(WorkingTreeFormat):
2842
"""The second working tree format.
2844
This format modified the hash cache from the format 1 hash cache.
2847
upgrade_recommended = True
2849
def get_format_description(self):
2850
"""See WorkingTreeFormat.get_format_description()."""
2851
return "Working tree format 2"
2853
def _stub_initialize_on_transport(self, transport, file_mode):
2854
"""Workaround: create control files for a remote working tree.
2856
This ensures that it can later be updated and dealt with locally,
2857
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2858
no working tree. (See bug #43064).
2861
inv = inventory.Inventory()
2862
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2864
transport.put_file('inventory', sio, file_mode)
2865
transport.put_bytes('pending-merges', '', file_mode)
2867
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2868
accelerator_tree=None, hardlink=False):
2869
"""See WorkingTreeFormat.initialize()."""
2870
if not isinstance(a_bzrdir.transport, LocalTransport):
2871
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2872
if from_branch is not None:
2873
branch = from_branch
2875
branch = a_bzrdir.open_branch()
2876
if revision_id is None:
2877
revision_id = _mod_revision.ensure_null(branch.last_revision())
2880
branch.generate_revision_history(revision_id)
2883
inv = inventory.Inventory()
2884
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2890
basis_tree = branch.repository.revision_tree(revision_id)
2891
if basis_tree.inventory.root is not None:
2892
wt.set_root_id(basis_tree.get_root_id())
2893
# set the parent list and cache the basis tree.
2894
if _mod_revision.is_null(revision_id):
2897
parent_trees = [(revision_id, basis_tree)]
2898
wt.set_parent_trees(parent_trees)
2899
transform.build_tree(basis_tree, wt)
2903
super(WorkingTreeFormat2, self).__init__()
2904
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2906
def open(self, a_bzrdir, _found=False):
2907
"""Return the WorkingTree object for a_bzrdir
2909
_found is a private parameter, do not use it. It is used to indicate
2910
if format probing has already been done.
2913
# we are being called directly and must probe.
2914
raise NotImplementedError
2915
if not isinstance(a_bzrdir.transport, LocalTransport):
2916
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2917
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2923
class WorkingTreeFormat3(WorkingTreeFormat):
2924
"""The second working tree format updated to record a format marker.
2927
- exists within a metadir controlling .bzr
2928
- includes an explicit version marker for the workingtree control
2929
files, separate from the BzrDir format
2930
- modifies the hash cache format
2932
- uses a LockDir to guard access for writes.
2935
upgrade_recommended = True
2937
def get_format_string(self):
2938
"""See WorkingTreeFormat.get_format_string()."""
2939
return "Bazaar-NG Working Tree format 3"
2941
def get_format_description(self):
2942
"""See WorkingTreeFormat.get_format_description()."""
2943
return "Working tree format 3"
2945
_lock_file_name = 'lock'
2946
_lock_class = LockDir
2948
_tree_class = WorkingTree3
2950
def __get_matchingbzrdir(self):
2951
return bzrdir.BzrDirMetaFormat1()
2953
_matchingbzrdir = property(__get_matchingbzrdir)
2955
def _open_control_files(self, a_bzrdir):
2956
transport = a_bzrdir.get_workingtree_transport(None)
2957
return LockableFiles(transport, self._lock_file_name,
2960
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2961
accelerator_tree=None, hardlink=False):
2962
"""See WorkingTreeFormat.initialize().
2964
:param revision_id: if supplied, create a working tree at a different
2965
revision than the branch is at.
2966
:param accelerator_tree: A tree which can be used for retrieving file
2967
contents more quickly than the revision tree, i.e. a workingtree.
2968
The revision tree will be used for cases where accelerator_tree's
2969
content is different.
2970
:param hardlink: If true, hard-link files from accelerator_tree,
2973
if not isinstance(a_bzrdir.transport, LocalTransport):
2974
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2975
transport = a_bzrdir.get_workingtree_transport(self)
2976
control_files = self._open_control_files(a_bzrdir)
2977
control_files.create_lock()
2978
control_files.lock_write()
2979
transport.put_bytes('format', self.get_format_string(),
2980
mode=a_bzrdir._get_file_mode())
2981
if from_branch is not None:
2982
branch = from_branch
2984
branch = a_bzrdir.open_branch()
2985
if revision_id is None:
2986
revision_id = _mod_revision.ensure_null(branch.last_revision())
2987
# WorkingTree3 can handle an inventory which has a unique root id.
2988
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2989
# those trees. And because there isn't a format bump inbetween, we
2990
# are maintaining compatibility with older clients.
2991
# inv = Inventory(root_id=gen_root_id())
2992
inv = self._initial_inventory()
2993
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2999
_control_files=control_files)
3000
wt.lock_tree_write()
3002
basis_tree = branch.repository.revision_tree(revision_id)
3003
# only set an explicit root id if there is one to set.
3004
if basis_tree.inventory.root is not None:
3005
wt.set_root_id(basis_tree.get_root_id())
3006
if revision_id == _mod_revision.NULL_REVISION:
3007
wt.set_parent_trees([])
3009
wt.set_parent_trees([(revision_id, basis_tree)])
3010
transform.build_tree(basis_tree, wt)
3012
# Unlock in this order so that the unlock-triggers-flush in
3013
# WorkingTree is given a chance to fire.
3014
control_files.unlock()
3018
def _initial_inventory(self):
3019
return inventory.Inventory()
3022
super(WorkingTreeFormat3, self).__init__()
3024
def open(self, a_bzrdir, _found=False):
3025
"""Return the WorkingTree object for a_bzrdir
3027
_found is a private parameter, do not use it. It is used to indicate
3028
if format probing has already been done.
3031
# we are being called directly and must probe.
3032
raise NotImplementedError
3033
if not isinstance(a_bzrdir.transport, LocalTransport):
3034
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3035
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3038
def _open(self, a_bzrdir, control_files):
3039
"""Open the tree itself.
3041
:param a_bzrdir: the dir for the tree.
3042
:param control_files: the control files for the tree.
3044
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3048
_control_files=control_files)
3051
return self.get_format_string()
3054
__default_format = WorkingTreeFormat6()
3055
WorkingTreeFormat.register_format(__default_format)
3056
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3057
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3058
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3059
WorkingTreeFormat.set_default_format(__default_format)
3060
# formats which have no format string are not discoverable
3061
# and not independently creatable, so are not registered.
3062
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
