1
# Copyright (C) 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
assert isinstance(basedir, basestring), \
226
"base directory %r is not a string" % basedir
227
basedir = safe_unicode(basedir)
228
mutter("opening working tree %r", basedir)
229
if deprecated_passed(branch):
230
self._branch = branch
232
self._branch = self.bzrdir.open_branch()
233
self.basedir = realpath(basedir)
234
# if branch is at our basedir and is a format 6 or less
235
if isinstance(self._format, WorkingTreeFormat2):
236
# share control object
237
self._control_files = self.branch.control_files
239
# assume all other formats have their own control files.
240
assert isinstance(_control_files, LockableFiles), \
241
"_control_files must be a LockableFiles, not %r" \
243
self._control_files = _control_files
244
# update the whole cache up front and write to disk if anything changed;
245
# in the future we might want to do this more selectively
246
# two possible ways offer themselves : in self._unlock, write the cache
247
# if needed, or, when the cache sees a change, append it to the hash
248
# cache file, and have the parser take the most recent entry for a
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
251
cache_filename = wt_trans.local_abspath('stat-cache')
252
self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
self._control_files._file_mode)
256
# is this scan needed ? it makes things kinda slow.
263
if _inventory is None:
264
# This will be acquired on lock_read() or lock_write()
265
self._inventory_is_modified = False
266
self._inventory = None
268
# the caller of __init__ has provided an inventory,
269
# we assume they know what they are doing - as its only
270
# the Format factory and creation methods that are
271
# permitted to do this.
272
self._set_inventory(_inventory, dirty=False)
273
self._detect_case_handling()
275
def _detect_case_handling(self):
276
wt_trans = self.bzrdir.get_workingtree_transport(None)
278
wt_trans.stat("FoRMaT")
279
except errors.NoSuchFile:
280
self.case_sensitive = True
282
self.case_sensitive = False
284
self._setup_directory_is_tree_reference()
287
fget=lambda self: self._branch,
288
doc="""The branch this WorkingTree is connected to.
290
This cannot be set - it is reflective of the actual disk structure
291
the working tree has been constructed from.
294
def break_lock(self):
295
"""Break a lock if one is present from another instance.
297
Uses the ui factory to ask for confirmation if the lock may be from
300
This will probe the repository for its lock as well.
302
self._control_files.break_lock()
303
self.branch.break_lock()
305
def requires_rich_root(self):
306
return self._format.requires_rich_root
308
def supports_tree_reference(self):
311
def _set_inventory(self, inv, dirty):
312
"""Set the internal cached inventory.
314
:param inv: The inventory to set.
315
:param dirty: A boolean indicating whether the inventory is the same
316
logical inventory as whats on disk. If True the inventory is not
317
the same and should be written to disk or data will be lost, if
318
False then the inventory is the same as that on disk and any
319
serialisation would be unneeded overhead.
321
assert inv.root is not None
322
self._inventory = inv
323
self._inventory_is_modified = dirty
326
def open(path=None, _unsupported=False):
327
"""Open an existing working tree at path.
331
path = os.path.getcwdu()
332
control = bzrdir.BzrDir.open(path, _unsupported)
333
return control.open_workingtree(_unsupported)
336
def open_containing(path=None):
337
"""Open an existing working tree which has its root about path.
339
This probes for a working tree at path and searches upwards from there.
341
Basically we keep looking up until we find the control directory or
342
run into /. If there isn't one, raises NotBranchError.
343
TODO: give this a new exception.
344
If there is one, it is returned, along with the unused portion of path.
346
:return: The WorkingTree that contains 'path', and the rest of path
349
path = osutils.getcwd()
350
control, relpath = bzrdir.BzrDir.open_containing(path)
352
return control.open_workingtree(), relpath
355
def open_downlevel(path=None):
356
"""Open an unsupported working tree.
358
Only intended for advanced situations like upgrading part of a bzrdir.
360
return WorkingTree.open(path, _unsupported=True)
362
# should be deprecated - this is slow and in any case treating them as a
363
# container is (we now know) bad style -- mbp 20070302
364
## @deprecated_method(zero_fifteen)
366
"""Iterate through file_ids for this tree.
368
file_ids are in a WorkingTree if they are in the working inventory
369
and the working file exists.
371
inv = self._inventory
372
for path, ie in inv.iter_entries():
373
if osutils.lexists(self.abspath(path)):
377
return "<%s of %s>" % (self.__class__.__name__,
378
getattr(self, 'basedir', None))
380
def abspath(self, filename):
381
return pathjoin(self.basedir, filename)
383
def basis_tree(self):
384
"""Return RevisionTree for the current last revision.
386
If the left most parent is a ghost then the returned tree will be an
387
empty tree - one obtained by calling repository.revision_tree(None).
390
revision_id = self.get_parent_ids()[0]
392
# no parents, return an empty revision tree.
393
# in the future this should return the tree for
394
# 'empty:' - the implicit root empty tree.
395
return self.branch.repository.revision_tree(None)
397
return self.revision_tree(revision_id)
398
except errors.NoSuchRevision:
400
# No cached copy available, retrieve from the repository.
401
# FIXME? RBC 20060403 should we cache the inventory locally
404
return self.branch.repository.revision_tree(revision_id)
405
except errors.RevisionNotPresent:
406
# the basis tree *may* be a ghost or a low level error may have
407
# occured. If the revision is present, its a problem, if its not
409
if self.branch.repository.has_revision(revision_id):
411
# the basis tree is a ghost so return an empty tree.
412
return self.branch.repository.revision_tree(None)
415
self._flush_ignore_list_cache()
418
@deprecated_method(zero_eight)
419
def create(branch, directory):
420
"""Create a workingtree for branch at directory.
422
If existing_directory already exists it must have a .bzr directory.
423
If it does not exist, it will be created.
425
This returns a new WorkingTree object for the new checkout.
427
TODO FIXME RBC 20060124 when we have checkout formats in place this
428
should accept an optional revisionid to checkout [and reject this if
429
checking out into the same dir as a pre-checkout-aware branch format.]
431
XXX: When BzrDir is present, these should be created through that
434
warnings.warn('delete WorkingTree.create', stacklevel=3)
435
transport = get_transport(directory)
436
if branch.bzrdir.root_transport.base == transport.base:
438
return branch.bzrdir.create_workingtree()
439
# different directory,
440
# create a branch reference
441
# and now a working tree.
442
raise NotImplementedError
445
@deprecated_method(zero_eight)
446
def create_standalone(directory):
447
"""Create a checkout and a branch and a repo at directory.
449
Directory must exist and be empty.
451
please use BzrDir.create_standalone_workingtree
453
return bzrdir.BzrDir.create_standalone_workingtree(directory)
455
def relpath(self, path):
456
"""Return the local path portion from a given path.
458
The path may be absolute or relative. If its a relative path it is
459
interpreted relative to the python current working directory.
461
return osutils.relpath(self.basedir, path)
463
def has_filename(self, filename):
464
return osutils.lexists(self.abspath(filename))
466
def get_file(self, file_id, path=None):
468
path = self.id2path(file_id)
469
return self.get_file_byname(path)
471
def get_file_text(self, file_id):
472
return self.get_file(file_id).read()
474
def get_file_byname(self, filename):
475
return file(self.abspath(filename), 'rb')
478
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
479
"""See Tree.annotate_iter
481
This implementation will use the basis tree implementation if possible.
482
Lines not in the basis are attributed to CURRENT_REVISION
484
If there are pending merges, lines added by those merges will be
485
incorrectly attributed to CURRENT_REVISION (but after committing, the
486
attribution will be correct).
488
basis = self.basis_tree()
491
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
492
require_versioned=True).next()
493
changed_content, kind = changes[2], changes[6]
494
if not changed_content:
495
return basis.annotate_iter(file_id)
499
if kind[0] != 'file':
502
old_lines = list(basis.annotate_iter(file_id))
504
for tree in self.branch.repository.revision_trees(
505
self.get_parent_ids()[1:]):
506
if file_id not in tree:
508
old.append(list(tree.annotate_iter(file_id)))
509
return annotate.reannotate(old, self.get_file(file_id).readlines(),
514
def _get_ancestors(self, default_revision):
515
ancestors = set([default_revision])
516
for parent_id in self.get_parent_ids():
517
ancestors.update(self.branch.repository.get_ancestry(
518
parent_id, topo_sorted=False))
521
def get_parent_ids(self):
522
"""See Tree.get_parent_ids.
524
This implementation reads the pending merges list and last_revision
525
value and uses that to decide what the parents list should be.
527
last_rev = _mod_revision.ensure_null(self._last_revision())
528
if _mod_revision.NULL_REVISION == last_rev:
533
merges_file = self._control_files.get('pending-merges')
534
except errors.NoSuchFile:
537
for l in merges_file.readlines():
538
revision_id = l.rstrip('\n')
539
parents.append(revision_id)
543
def get_root_id(self):
544
"""Return the id of this trees root"""
545
return self._inventory.root.file_id
547
def _get_store_filename(self, file_id):
548
## XXX: badly named; this is not in the store at all
549
return self.abspath(self.id2path(file_id))
552
def clone(self, to_bzrdir, revision_id=None):
553
"""Duplicate this working tree into to_bzr, including all state.
555
Specifically modified files are kept as modified, but
556
ignored and unknown files are discarded.
558
If you want to make a new line of development, see bzrdir.sprout()
561
If not None, the cloned tree will have its last revision set to
562
revision, and and difference between the source trees last revision
563
and this one merged in.
565
# assumes the target bzr dir format is compatible.
566
result = self._format.initialize(to_bzrdir)
567
self.copy_content_into(result, revision_id)
571
def copy_content_into(self, tree, revision_id=None):
572
"""Copy the current content and user files of this tree into tree."""
573
tree.set_root_id(self.get_root_id())
574
if revision_id is None:
575
merge.transform_tree(tree, self)
577
# TODO now merge from tree.last_revision to revision (to preserve
578
# user local changes)
579
merge.transform_tree(tree, self)
580
tree.set_parent_ids([revision_id])
582
def id2abspath(self, file_id):
583
return self.abspath(self.id2path(file_id))
585
def has_id(self, file_id):
586
# files that have been deleted are excluded
588
if not inv.has_id(file_id):
590
path = inv.id2path(file_id)
591
return osutils.lexists(self.abspath(path))
593
def has_or_had_id(self, file_id):
594
if file_id == self.inventory.root.file_id:
596
return self.inventory.has_id(file_id)
598
__contains__ = has_id
600
def get_file_size(self, file_id):
601
return os.path.getsize(self.id2abspath(file_id))
604
def get_file_sha1(self, file_id, path=None, stat_value=None):
606
path = self._inventory.id2path(file_id)
607
return self._hashcache.get_sha1(path, stat_value)
609
def get_file_mtime(self, file_id, path=None):
611
path = self.inventory.id2path(file_id)
612
return os.lstat(self.abspath(path)).st_mtime
614
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
615
file_id = self.path2id(path)
616
return self._inventory[file_id].executable
618
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
619
mode = stat_result.st_mode
620
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
622
if not supports_executable():
623
def is_executable(self, file_id, path=None):
624
return self._inventory[file_id].executable
626
_is_executable_from_path_and_stat = \
627
_is_executable_from_path_and_stat_from_basis
629
def is_executable(self, file_id, path=None):
631
path = self.id2path(file_id)
632
mode = os.lstat(self.abspath(path)).st_mode
633
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
635
_is_executable_from_path_and_stat = \
636
_is_executable_from_path_and_stat_from_stat
638
@needs_tree_write_lock
639
def _add(self, files, ids, kinds):
640
"""See MutableTree._add."""
641
# TODO: Re-adding a file that is removed in the working copy
642
# should probably put it back with the previous ID.
643
# the read and write working inventory should not occur in this
644
# function - they should be part of lock_write and unlock.
646
for f, file_id, kind in zip(files, ids, kinds):
647
assert kind is not None
649
inv.add_path(f, kind=kind)
651
inv.add_path(f, kind=kind, file_id=file_id)
652
self._inventory_is_modified = True
654
@needs_tree_write_lock
655
def _gather_kinds(self, files, kinds):
656
"""See MutableTree._gather_kinds."""
657
for pos, f in enumerate(files):
658
if kinds[pos] is None:
659
fullpath = normpath(self.abspath(f))
661
kinds[pos] = file_kind(fullpath)
663
if e.errno == errno.ENOENT:
664
raise errors.NoSuchFile(fullpath)
667
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
668
"""Add revision_id as a parent.
670
This is equivalent to retrieving the current list of parent ids
671
and setting the list to its value plus revision_id.
673
:param revision_id: The revision id to add to the parent list. It may
674
be a ghost revision as long as its not the first parent to be added,
675
or the allow_leftmost_as_ghost parameter is set True.
676
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
678
parents = self.get_parent_ids() + [revision_id]
679
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
680
or allow_leftmost_as_ghost)
682
@needs_tree_write_lock
683
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
684
"""Add revision_id, tree tuple as a parent.
686
This is equivalent to retrieving the current list of parent trees
687
and setting the list to its value plus parent_tuple. See also
688
add_parent_tree_id - if you only have a parent id available it will be
689
simpler to use that api. If you have the parent already available, using
690
this api is preferred.
692
:param parent_tuple: The (revision id, tree) to add to the parent list.
693
If the revision_id is a ghost, pass None for the tree.
694
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
696
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
697
if len(parent_ids) > 1:
698
# the leftmost may have already been a ghost, preserve that if it
700
allow_leftmost_as_ghost = True
701
self.set_parent_ids(parent_ids,
702
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
704
@needs_tree_write_lock
705
def add_pending_merge(self, *revision_ids):
706
# TODO: Perhaps should check at this point that the
707
# history of the revision is actually present?
708
parents = self.get_parent_ids()
710
for rev_id in revision_ids:
711
if rev_id in parents:
713
parents.append(rev_id)
716
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
718
def path_content_summary(self, path, _lstat=os.lstat,
719
_mapper=osutils.file_kind_from_stat_mode):
720
"""See Tree.path_content_summary."""
721
abspath = self.abspath(path)
723
stat_result = _lstat(abspath)
725
if getattr(e, 'errno', None) == errno.ENOENT:
727
return ('missing', None, None, None)
728
# propagate other errors
730
kind = _mapper(stat_result.st_mode)
732
size = stat_result.st_size
733
# try for a stat cache lookup
734
executable = self._is_executable_from_path_and_stat(path, stat_result)
735
return (kind, size, executable, self._sha_from_stat(
737
elif kind == 'directory':
738
# perhaps it looks like a plain directory, but it's really a
740
if self._directory_is_tree_reference(path):
741
kind = 'tree-reference'
742
return kind, None, None, None
743
elif kind == 'symlink':
744
return ('symlink', None, None, os.readlink(abspath))
746
return (kind, None, None, None)
748
@deprecated_method(zero_eleven)
750
def pending_merges(self):
751
"""Return a list of pending merges.
753
These are revisions that have been merged into the working
754
directory but not yet committed.
756
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
757
instead - which is available on all tree objects.
759
return self.get_parent_ids()[1:]
761
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
762
"""Common ghost checking functionality from set_parent_*.
764
This checks that the left hand-parent exists if there are any
767
if len(revision_ids) > 0:
768
leftmost_id = revision_ids[0]
769
if (not allow_leftmost_as_ghost and not
770
self.branch.repository.has_revision(leftmost_id)):
771
raise errors.GhostRevisionUnusableHere(leftmost_id)
773
def _set_merges_from_parent_ids(self, parent_ids):
774
merges = parent_ids[1:]
775
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
777
@needs_tree_write_lock
778
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
779
"""Set the parent ids to revision_ids.
781
See also set_parent_trees. This api will try to retrieve the tree data
782
for each element of revision_ids from the trees repository. If you have
783
tree data already available, it is more efficient to use
784
set_parent_trees rather than set_parent_ids. set_parent_ids is however
785
an easier API to use.
787
:param revision_ids: The revision_ids to set as the parent ids of this
788
working tree. Any of these may be ghosts.
790
self._check_parents_for_ghosts(revision_ids,
791
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
792
for revision_id in revision_ids:
793
_mod_revision.check_not_reserved_id(revision_id)
795
if len(revision_ids) > 0:
796
self.set_last_revision(revision_ids[0])
798
self.set_last_revision(_mod_revision.NULL_REVISION)
800
self._set_merges_from_parent_ids(revision_ids)
802
@needs_tree_write_lock
803
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
804
"""See MutableTree.set_parent_trees."""
805
parent_ids = [rev for (rev, tree) in parents_list]
806
for revision_id in parent_ids:
807
_mod_revision.check_not_reserved_id(revision_id)
809
self._check_parents_for_ghosts(parent_ids,
810
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
812
if len(parent_ids) == 0:
813
leftmost_parent_id = _mod_revision.NULL_REVISION
814
leftmost_parent_tree = None
816
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
818
if self._change_last_revision(leftmost_parent_id):
819
if leftmost_parent_tree is None:
820
# If we don't have a tree, fall back to reading the
821
# parent tree from the repository.
822
self._cache_basis_inventory(leftmost_parent_id)
824
inv = leftmost_parent_tree.inventory
825
xml = self._create_basis_xml_from_inventory(
826
leftmost_parent_id, inv)
827
self._write_basis_inventory(xml)
828
self._set_merges_from_parent_ids(parent_ids)
830
@needs_tree_write_lock
831
def set_pending_merges(self, rev_list):
832
parents = self.get_parent_ids()
833
leftmost = parents[:1]
834
new_parents = leftmost + rev_list
835
self.set_parent_ids(new_parents)
837
@needs_tree_write_lock
838
def set_merge_modified(self, modified_hashes):
840
for file_id, hash in modified_hashes.iteritems():
841
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
842
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
844
def _sha_from_stat(self, path, stat_result):
845
"""Get a sha digest from the tree's stat cache.
847
The default implementation assumes no stat cache is present.
849
:param path: The path.
850
:param stat_result: The stat result being looked up.
854
def _put_rio(self, filename, stanzas, header):
855
self._must_be_locked()
856
my_file = rio_file(stanzas, header)
857
self._control_files.put(filename, my_file)
859
@needs_write_lock # because merge pulls data into the branch.
860
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
862
"""Merge from a branch into this working tree.
864
:param branch: The branch to merge from.
865
:param to_revision: If non-None, the merge will merge to to_revision,
866
but not beyond it. to_revision does not need to be in the history
867
of the branch when it is supplied. If None, to_revision defaults to
868
branch.last_revision().
870
from bzrlib.merge import Merger, Merge3Merger
871
pb = bzrlib.ui.ui_factory.nested_progress_bar()
873
merger = Merger(self.branch, this_tree=self, pb=pb)
874
merger.pp = ProgressPhase("Merge phase", 5, pb)
875
merger.pp.next_phase()
876
# check that there are no
878
merger.check_basis(check_clean=True, require_commits=False)
879
if to_revision is None:
880
to_revision = _mod_revision.ensure_null(branch.last_revision())
881
merger.other_rev_id = to_revision
882
if _mod_revision.is_null(merger.other_rev_id):
883
raise errors.NoCommits(branch)
884
self.branch.fetch(branch, last_revision=merger.other_rev_id)
885
merger.other_basis = merger.other_rev_id
886
merger.other_tree = self.branch.repository.revision_tree(
888
merger.other_branch = branch
889
merger.pp.next_phase()
890
if from_revision is None:
893
merger.set_base_revision(from_revision, branch)
894
if merger.base_rev_id == merger.other_rev_id:
895
raise errors.PointlessMerge
896
merger.backup_files = False
897
if merge_type is None:
898
merger.merge_type = Merge3Merger
900
merger.merge_type = merge_type
901
merger.set_interesting_files(None)
902
merger.show_base = False
903
merger.reprocess = False
904
conflicts = merger.do_merge()
911
def merge_modified(self):
912
"""Return a dictionary of files modified by a merge.
914
The list is initialized by WorkingTree.set_merge_modified, which is
915
typically called after we make some automatic updates to the tree
918
This returns a map of file_id->sha1, containing only files which are
919
still in the working inventory and have that text hash.
922
hashfile = self._control_files.get('merge-hashes')
923
except errors.NoSuchFile:
927
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
928
raise errors.MergeModifiedFormatError()
929
except StopIteration:
930
raise errors.MergeModifiedFormatError()
931
for s in RioReader(hashfile):
932
# RioReader reads in Unicode, so convert file_ids back to utf8
933
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
934
if file_id not in self.inventory:
936
text_hash = s.get("hash")
937
if text_hash == self.get_file_sha1(file_id):
938
merge_hashes[file_id] = text_hash
942
def mkdir(self, path, file_id=None):
943
"""See MutableTree.mkdir()."""
945
file_id = generate_ids.gen_file_id(os.path.basename(path))
946
os.mkdir(self.abspath(path))
947
self.add(path, file_id, 'directory')
950
def get_symlink_target(self, file_id):
951
return os.readlink(self.id2abspath(file_id))
954
def subsume(self, other_tree):
955
def add_children(inventory, entry):
956
for child_entry in entry.children.values():
957
inventory._byid[child_entry.file_id] = child_entry
958
if child_entry.kind == 'directory':
959
add_children(inventory, child_entry)
960
if other_tree.get_root_id() == self.get_root_id():
961
raise errors.BadSubsumeSource(self, other_tree,
962
'Trees have the same root')
964
other_tree_path = self.relpath(other_tree.basedir)
965
except errors.PathNotChild:
966
raise errors.BadSubsumeSource(self, other_tree,
967
'Tree is not contained by the other')
968
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
969
if new_root_parent is None:
970
raise errors.BadSubsumeSource(self, other_tree,
971
'Parent directory is not versioned.')
972
# We need to ensure that the result of a fetch will have a
973
# versionedfile for the other_tree root, and only fetching into
974
# RepositoryKnit2 guarantees that.
975
if not self.branch.repository.supports_rich_root():
976
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
977
other_tree.lock_tree_write()
979
new_parents = other_tree.get_parent_ids()
980
other_root = other_tree.inventory.root
981
other_root.parent_id = new_root_parent
982
other_root.name = osutils.basename(other_tree_path)
983
self.inventory.add(other_root)
984
add_children(self.inventory, other_root)
985
self._write_inventory(self.inventory)
986
# normally we don't want to fetch whole repositories, but i think
987
# here we really do want to consolidate the whole thing.
988
for parent_id in other_tree.get_parent_ids():
989
self.branch.fetch(other_tree.branch, parent_id)
990
self.add_parent_tree_id(parent_id)
993
other_tree.bzrdir.retire_bzrdir()
995
def _setup_directory_is_tree_reference(self):
996
if self._branch.repository._format.supports_tree_reference:
997
self._directory_is_tree_reference = \
998
self._directory_may_be_tree_reference
1000
self._directory_is_tree_reference = \
1001
self._directory_is_never_tree_reference
1003
def _directory_is_never_tree_reference(self, relpath):
1006
def _directory_may_be_tree_reference(self, relpath):
1007
# as a special case, if a directory contains control files then
1008
# it's a tree reference, except that the root of the tree is not
1009
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1010
# TODO: We could ask all the control formats whether they
1011
# recognize this directory, but at the moment there's no cheap api
1012
# to do that. Since we probably can only nest bzr checkouts and
1013
# they always use this name it's ok for now. -- mbp 20060306
1015
# FIXME: There is an unhandled case here of a subdirectory
1016
# containing .bzr but not a branch; that will probably blow up
1017
# when you try to commit it. It might happen if there is a
1018
# checkout in a subdirectory. This can be avoided by not adding
1021
@needs_tree_write_lock
1022
def extract(self, file_id, format=None):
1023
"""Extract a subtree from this tree.
1025
A new branch will be created, relative to the path for this tree.
1029
segments = osutils.splitpath(path)
1030
transport = self.branch.bzrdir.root_transport
1031
for name in segments:
1032
transport = transport.clone(name)
1033
transport.ensure_base()
1036
sub_path = self.id2path(file_id)
1037
branch_transport = mkdirs(sub_path)
1039
format = self.bzrdir.cloning_metadir()
1040
branch_transport.ensure_base()
1041
branch_bzrdir = format.initialize_on_transport(branch_transport)
1043
repo = branch_bzrdir.find_repository()
1044
except errors.NoRepositoryPresent:
1045
repo = branch_bzrdir.create_repository()
1046
if not repo.supports_rich_root():
1047
raise errors.RootNotRich()
1048
new_branch = branch_bzrdir.create_branch()
1049
new_branch.pull(self.branch)
1050
for parent_id in self.get_parent_ids():
1051
new_branch.fetch(self.branch, parent_id)
1052
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1053
if tree_transport.base != branch_transport.base:
1054
tree_bzrdir = format.initialize_on_transport(tree_transport)
1055
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1057
tree_bzrdir = branch_bzrdir
1058
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1059
wt.set_parent_ids(self.get_parent_ids())
1060
my_inv = self.inventory
1061
child_inv = Inventory(root_id=None)
1062
new_root = my_inv[file_id]
1063
my_inv.remove_recursive_id(file_id)
1064
new_root.parent_id = None
1065
child_inv.add(new_root)
1066
self._write_inventory(my_inv)
1067
wt._write_inventory(child_inv)
1070
def _serialize(self, inventory, out_file):
1071
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1074
def _deserialize(selt, in_file):
1075
return xml5.serializer_v5.read_inventory(in_file)
1078
"""Write the in memory inventory to disk."""
1079
# TODO: Maybe this should only write on dirty ?
1080
if self._control_files._lock_mode != 'w':
1081
raise errors.NotWriteLocked(self)
1083
self._serialize(self._inventory, sio)
1085
self._control_files.put('inventory', sio)
1086
self._inventory_is_modified = False
1088
def _kind(self, relpath):
1089
return osutils.file_kind(self.abspath(relpath))
1091
def list_files(self, include_root=False):
1092
"""Recursively list all files as (path, class, kind, id, entry).
1094
Lists, but does not descend into unversioned directories.
1096
This does not include files that have been deleted in this
1099
Skips the control directory.
1101
# list_files is an iterator, so @needs_read_lock doesn't work properly
1102
# with it. So callers should be careful to always read_lock the tree.
1103
if not self.is_locked():
1104
raise errors.ObjectNotLocked(self)
1106
inv = self.inventory
1107
if include_root is True:
1108
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1109
# Convert these into local objects to save lookup times
1110
pathjoin = osutils.pathjoin
1111
file_kind = self._kind
1113
# transport.base ends in a slash, we want the piece
1114
# between the last two slashes
1115
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1117
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1119
# directory file_id, relative path, absolute path, reverse sorted children
1120
children = os.listdir(self.basedir)
1122
# jam 20060527 The kernel sized tree seems equivalent whether we
1123
# use a deque and popleft to keep them sorted, or if we use a plain
1124
# list and just reverse() them.
1125
children = collections.deque(children)
1126
stack = [(inv.root.file_id, u'', self.basedir, children)]
1128
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1131
f = children.popleft()
1132
## TODO: If we find a subdirectory with its own .bzr
1133
## directory, then that is a separate tree and we
1134
## should exclude it.
1136
# the bzrdir for this tree
1137
if transport_base_dir == f:
1140
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1141
# and 'f' doesn't begin with one, we can do a string op, rather
1142
# than the checks of pathjoin(), all relative paths will have an extra slash
1144
fp = from_dir_relpath + '/' + f
1147
fap = from_dir_abspath + '/' + f
1149
f_ie = inv.get_child(from_dir_id, f)
1152
elif self.is_ignored(fp[1:]):
1155
# we may not have found this file, because of a unicode issue
1156
f_norm, can_access = osutils.normalized_filename(f)
1157
if f == f_norm or not can_access:
1158
# No change, so treat this file normally
1161
# this file can be accessed by a normalized path
1162
# check again if it is versioned
1163
# these lines are repeated here for performance
1165
fp = from_dir_relpath + '/' + f
1166
fap = from_dir_abspath + '/' + f
1167
f_ie = inv.get_child(from_dir_id, f)
1170
elif self.is_ignored(fp[1:]):
1177
# make a last minute entry
1179
yield fp[1:], c, fk, f_ie.file_id, f_ie
1182
yield fp[1:], c, fk, None, fk_entries[fk]()
1184
yield fp[1:], c, fk, None, TreeEntry()
1187
if fk != 'directory':
1190
# But do this child first
1191
new_children = os.listdir(fap)
1193
new_children = collections.deque(new_children)
1194
stack.append((f_ie.file_id, fp, fap, new_children))
1195
# Break out of inner loop,
1196
# so that we start outer loop with child
1199
# if we finished all children, pop it off the stack
1202
@needs_tree_write_lock
1203
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1206
to_dir must exist in the inventory.
1208
If to_dir exists and is a directory, the files are moved into
1209
it, keeping their old names.
1211
Note that to_dir is only the last component of the new name;
1212
this doesn't change the directory.
1214
For each entry in from_paths the move mode will be determined
1217
The first mode moves the file in the filesystem and updates the
1218
inventory. The second mode only updates the inventory without
1219
touching the file on the filesystem. This is the new mode introduced
1222
move uses the second mode if 'after == True' and the target is not
1223
versioned but present in the working tree.
1225
move uses the second mode if 'after == False' and the source is
1226
versioned but no longer in the working tree, and the target is not
1227
versioned but present in the working tree.
1229
move uses the first mode if 'after == False' and the source is
1230
versioned and present in the working tree, and the target is not
1231
versioned and not present in the working tree.
1233
Everything else results in an error.
1235
This returns a list of (from_path, to_path) pairs for each
1236
entry that is moved.
1241
# check for deprecated use of signature
1243
to_dir = kwargs.get('to_name', None)
1245
raise TypeError('You must supply a target directory')
1247
symbol_versioning.warn('The parameter to_name was deprecated'
1248
' in version 0.13. Use to_dir instead',
1251
# check destination directory
1252
assert not isinstance(from_paths, basestring)
1253
inv = self.inventory
1254
to_abs = self.abspath(to_dir)
1255
if not isdir(to_abs):
1256
raise errors.BzrMoveFailedError('',to_dir,
1257
errors.NotADirectory(to_abs))
1258
if not self.has_filename(to_dir):
1259
raise errors.BzrMoveFailedError('',to_dir,
1260
errors.NotInWorkingDirectory(to_dir))
1261
to_dir_id = inv.path2id(to_dir)
1262
if to_dir_id is None:
1263
raise errors.BzrMoveFailedError('',to_dir,
1264
errors.NotVersionedError(path=str(to_dir)))
1266
to_dir_ie = inv[to_dir_id]
1267
if to_dir_ie.kind != 'directory':
1268
raise errors.BzrMoveFailedError('',to_dir,
1269
errors.NotADirectory(to_abs))
1271
# create rename entries and tuples
1272
for from_rel in from_paths:
1273
from_tail = splitpath(from_rel)[-1]
1274
from_id = inv.path2id(from_rel)
1276
raise errors.BzrMoveFailedError(from_rel,to_dir,
1277
errors.NotVersionedError(path=str(from_rel)))
1279
from_entry = inv[from_id]
1280
from_parent_id = from_entry.parent_id
1281
to_rel = pathjoin(to_dir, from_tail)
1282
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1284
from_tail=from_tail,
1285
from_parent_id=from_parent_id,
1286
to_rel=to_rel, to_tail=from_tail,
1287
to_parent_id=to_dir_id)
1288
rename_entries.append(rename_entry)
1289
rename_tuples.append((from_rel, to_rel))
1291
# determine which move mode to use. checks also for movability
1292
rename_entries = self._determine_mv_mode(rename_entries, after)
1294
original_modified = self._inventory_is_modified
1297
self._inventory_is_modified = True
1298
self._move(rename_entries)
1300
# restore the inventory on error
1301
self._inventory_is_modified = original_modified
1303
self._write_inventory(inv)
1304
return rename_tuples
1306
def _determine_mv_mode(self, rename_entries, after=False):
1307
"""Determines for each from-to pair if both inventory and working tree
1308
or only the inventory has to be changed.
1310
Also does basic plausability tests.
1312
inv = self.inventory
1314
for rename_entry in rename_entries:
1315
# store to local variables for easier reference
1316
from_rel = rename_entry.from_rel
1317
from_id = rename_entry.from_id
1318
to_rel = rename_entry.to_rel
1319
to_id = inv.path2id(to_rel)
1320
only_change_inv = False
1322
# check the inventory for source and destination
1324
raise errors.BzrMoveFailedError(from_rel,to_rel,
1325
errors.NotVersionedError(path=str(from_rel)))
1326
if to_id is not None:
1327
raise errors.BzrMoveFailedError(from_rel,to_rel,
1328
errors.AlreadyVersionedError(path=str(to_rel)))
1330
# try to determine the mode for rename (only change inv or change
1331
# inv and file system)
1333
if not self.has_filename(to_rel):
1334
raise errors.BzrMoveFailedError(from_id,to_rel,
1335
errors.NoSuchFile(path=str(to_rel),
1336
extra="New file has not been created yet"))
1337
only_change_inv = True
1338
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1339
only_change_inv = True
1340
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1341
only_change_inv = False
1342
elif (sys.platform == 'win32'
1343
and from_rel.lower() == to_rel.lower()
1344
and self.has_filename(from_rel)):
1345
only_change_inv = False
1347
# something is wrong, so lets determine what exactly
1348
if not self.has_filename(from_rel) and \
1349
not self.has_filename(to_rel):
1350
raise errors.BzrRenameFailedError(from_rel,to_rel,
1351
errors.PathsDoNotExist(paths=(str(from_rel),
1354
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1355
rename_entry.only_change_inv = only_change_inv
1356
return rename_entries
1358
def _move(self, rename_entries):
1359
"""Moves a list of files.
1361
Depending on the value of the flag 'only_change_inv', the
1362
file will be moved on the file system or not.
1364
inv = self.inventory
1367
for entry in rename_entries:
1369
self._move_entry(entry)
1371
self._rollback_move(moved)
1375
def _rollback_move(self, moved):
1376
"""Try to rollback a previous move in case of an filesystem error."""
1377
inv = self.inventory
1380
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1381
entry.to_tail, entry.to_parent_id, entry.from_rel,
1382
entry.from_tail, entry.from_parent_id,
1383
entry.only_change_inv))
1384
except errors.BzrMoveFailedError, e:
1385
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1386
" The working tree is in an inconsistent state."
1387
" Please consider doing a 'bzr revert'."
1388
" Error message is: %s" % e)
1390
def _move_entry(self, entry):
1391
inv = self.inventory
1392
from_rel_abs = self.abspath(entry.from_rel)
1393
to_rel_abs = self.abspath(entry.to_rel)
1394
if from_rel_abs == to_rel_abs:
1395
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1396
"Source and target are identical.")
1398
if not entry.only_change_inv:
1400
osutils.rename(from_rel_abs, to_rel_abs)
1402
raise errors.BzrMoveFailedError(entry.from_rel,
1404
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1406
@needs_tree_write_lock
1407
def rename_one(self, from_rel, to_rel, after=False):
1410
This can change the directory or the filename or both.
1412
rename_one has several 'modes' to work. First, it can rename a physical
1413
file and change the file_id. That is the normal mode. Second, it can
1414
only change the file_id without touching any physical file. This is
1415
the new mode introduced in version 0.15.
1417
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1418
versioned but present in the working tree.
1420
rename_one uses the second mode if 'after == False' and 'from_rel' is
1421
versioned but no longer in the working tree, and 'to_rel' is not
1422
versioned but present in the working tree.
1424
rename_one uses the first mode if 'after == False' and 'from_rel' is
1425
versioned and present in the working tree, and 'to_rel' is not
1426
versioned and not present in the working tree.
1428
Everything else results in an error.
1430
inv = self.inventory
1433
# create rename entries and tuples
1434
from_tail = splitpath(from_rel)[-1]
1435
from_id = inv.path2id(from_rel)
1437
raise errors.BzrRenameFailedError(from_rel,to_rel,
1438
errors.NotVersionedError(path=str(from_rel)))
1439
from_entry = inv[from_id]
1440
from_parent_id = from_entry.parent_id
1441
to_dir, to_tail = os.path.split(to_rel)
1442
to_dir_id = inv.path2id(to_dir)
1443
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1445
from_tail=from_tail,
1446
from_parent_id=from_parent_id,
1447
to_rel=to_rel, to_tail=to_tail,
1448
to_parent_id=to_dir_id)
1449
rename_entries.append(rename_entry)
1451
# determine which move mode to use. checks also for movability
1452
rename_entries = self._determine_mv_mode(rename_entries, after)
1454
# check if the target changed directory and if the target directory is
1456
if to_dir_id is None:
1457
raise errors.BzrMoveFailedError(from_rel,to_rel,
1458
errors.NotVersionedError(path=str(to_dir)))
1460
# all checks done. now we can continue with our actual work
1461
mutter('rename_one:\n'
1466
' to_dir_id {%s}\n',
1467
from_id, from_rel, to_rel, to_dir, to_dir_id)
1469
self._move(rename_entries)
1470
self._write_inventory(inv)
1472
class _RenameEntry(object):
1473
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1474
to_rel, to_tail, to_parent_id, only_change_inv=False):
1475
self.from_rel = from_rel
1476
self.from_id = from_id
1477
self.from_tail = from_tail
1478
self.from_parent_id = from_parent_id
1479
self.to_rel = to_rel
1480
self.to_tail = to_tail
1481
self.to_parent_id = to_parent_id
1482
self.only_change_inv = only_change_inv
1486
"""Return all unknown files.
1488
These are files in the working directory that are not versioned or
1489
control files or ignored.
1491
# force the extras method to be fully executed before returning, to
1492
# prevent race conditions with the lock
1494
[subp for subp in self.extras() if not self.is_ignored(subp)])
1496
@needs_tree_write_lock
1497
def unversion(self, file_ids):
1498
"""Remove the file ids in file_ids from the current versioned set.
1500
When a file_id is unversioned, all of its children are automatically
1503
:param file_ids: The file ids to stop versioning.
1504
:raises: NoSuchId if any fileid is not currently versioned.
1506
for file_id in file_ids:
1507
if self._inventory.has_id(file_id):
1508
self._inventory.remove_recursive_id(file_id)
1510
raise errors.NoSuchId(self, file_id)
1512
# in the future this should just set a dirty bit to wait for the
1513
# final unlock. However, until all methods of workingtree start
1514
# with the current in -memory inventory rather than triggering
1515
# a read, it is more complex - we need to teach read_inventory
1516
# to know when to read, and when to not read first... and possibly
1517
# to save first when the in memory one may be corrupted.
1518
# so for now, we just only write it if it is indeed dirty.
1520
self._write_inventory(self._inventory)
1522
@deprecated_method(zero_eight)
1523
def iter_conflicts(self):
1524
"""List all files in the tree that have text or content conflicts.
1525
DEPRECATED. Use conflicts instead."""
1526
return self._iter_conflicts()
1528
def _iter_conflicts(self):
1530
for info in self.list_files():
1532
stem = get_conflicted_stem(path)
1535
if stem not in conflicted:
1536
conflicted.add(stem)
1540
def pull(self, source, overwrite=False, stop_revision=None,
1541
change_reporter=None, possible_transports=None):
1542
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1545
pp = ProgressPhase("Pull phase", 2, top_pb)
1547
old_revision_info = self.branch.last_revision_info()
1548
basis_tree = self.basis_tree()
1549
count = self.branch.pull(source, overwrite, stop_revision,
1550
possible_transports=possible_transports)
1551
new_revision_info = self.branch.last_revision_info()
1552
if new_revision_info != old_revision_info:
1554
repository = self.branch.repository
1555
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1556
basis_tree.lock_read()
1558
new_basis_tree = self.branch.basis_tree()
1565
change_reporter=change_reporter)
1566
if (basis_tree.inventory.root is None and
1567
new_basis_tree.inventory.root is not None):
1568
self.set_root_id(new_basis_tree.get_root_id())
1572
# TODO - dedup parents list with things merged by pull ?
1573
# reuse the revisiontree we merged against to set the new
1575
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1576
# we have to pull the merge trees out again, because
1577
# merge_inner has set the ids. - this corner is not yet
1578
# layered well enough to prevent double handling.
1579
# XXX TODO: Fix the double handling: telling the tree about
1580
# the already known parent data is wasteful.
1581
merges = self.get_parent_ids()[1:]
1582
parent_trees.extend([
1583
(parent, repository.revision_tree(parent)) for
1585
self.set_parent_trees(parent_trees)
1592
def put_file_bytes_non_atomic(self, file_id, bytes):
1593
"""See MutableTree.put_file_bytes_non_atomic."""
1594
stream = file(self.id2abspath(file_id), 'wb')
1599
# TODO: update the hashcache here ?
1602
"""Yield all unversioned files in this WorkingTree.
1604
If there are any unversioned directories then only the directory is
1605
returned, not all its children. But if there are unversioned files
1606
under a versioned subdirectory, they are returned.
1608
Currently returned depth-first, sorted by name within directories.
1609
This is the same order used by 'osutils.walkdirs'.
1611
## TODO: Work from given directory downwards
1612
for path, dir_entry in self.inventory.directories():
1613
# mutter("search for unknowns in %r", path)
1614
dirabs = self.abspath(path)
1615
if not isdir(dirabs):
1616
# e.g. directory deleted
1620
for subf in os.listdir(dirabs):
1623
if subf not in dir_entry.children:
1624
subf_norm, can_access = osutils.normalized_filename(subf)
1625
if subf_norm != subf and can_access:
1626
if subf_norm not in dir_entry.children:
1627
fl.append(subf_norm)
1633
subp = pathjoin(path, subf)
1636
def ignored_files(self):
1637
"""Yield list of PATH, IGNORE_PATTERN"""
1638
for subp in self.extras():
1639
pat = self.is_ignored(subp)
1643
def get_ignore_list(self):
1644
"""Return list of ignore patterns.
1646
Cached in the Tree object after the first call.
1648
ignoreset = getattr(self, '_ignoreset', None)
1649
if ignoreset is not None:
1652
ignore_globs = set()
1653
ignore_globs.update(ignores.get_runtime_ignores())
1654
ignore_globs.update(ignores.get_user_ignores())
1655
if self.has_filename(bzrlib.IGNORE_FILENAME):
1656
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1658
ignore_globs.update(ignores.parse_ignore_file(f))
1661
self._ignoreset = ignore_globs
1664
def _flush_ignore_list_cache(self):
1665
"""Resets the cached ignore list to force a cache rebuild."""
1666
self._ignoreset = None
1667
self._ignoreglobster = None
1669
def is_ignored(self, filename):
1670
r"""Check whether the filename matches an ignore pattern.
1672
Patterns containing '/' or '\' need to match the whole path;
1673
others match against only the last component.
1675
If the file is ignored, returns the pattern which caused it to
1676
be ignored, otherwise None. So this can simply be used as a
1677
boolean if desired."""
1678
if getattr(self, '_ignoreglobster', None) is None:
1679
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1680
return self._ignoreglobster.match(filename)
1682
def kind(self, file_id):
1683
return file_kind(self.id2abspath(file_id))
1685
def _comparison_data(self, entry, path):
1686
abspath = self.abspath(path)
1688
stat_value = os.lstat(abspath)
1690
if getattr(e, 'errno', None) == errno.ENOENT:
1697
mode = stat_value.st_mode
1698
kind = osutils.file_kind_from_stat_mode(mode)
1699
if not supports_executable():
1700
executable = entry is not None and entry.executable
1702
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1703
return kind, executable, stat_value
1705
def _file_size(self, entry, stat_value):
1706
return stat_value.st_size
1708
def last_revision(self):
1709
"""Return the last revision of the branch for this tree.
1711
This format tree does not support a separate marker for last-revision
1712
compared to the branch.
1714
See MutableTree.last_revision
1716
return self._last_revision()
1719
def _last_revision(self):
1720
"""helper for get_parent_ids."""
1721
return _mod_revision.ensure_null(self.branch.last_revision())
1723
def is_locked(self):
1724
return self._control_files.is_locked()
1726
def _must_be_locked(self):
1727
if not self.is_locked():
1728
raise errors.ObjectNotLocked(self)
1730
def lock_read(self):
1731
"""See Branch.lock_read, and WorkingTree.unlock."""
1732
if not self.is_locked():
1734
self.branch.lock_read()
1736
return self._control_files.lock_read()
1738
self.branch.unlock()
1741
def lock_tree_write(self):
1742
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1743
if not self.is_locked():
1745
self.branch.lock_read()
1747
return self._control_files.lock_write()
1749
self.branch.unlock()
1752
def lock_write(self):
1753
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1754
if not self.is_locked():
1756
self.branch.lock_write()
1758
return self._control_files.lock_write()
1760
self.branch.unlock()
1763
def get_physical_lock_status(self):
1764
return self._control_files.get_physical_lock_status()
1766
def _basis_inventory_name(self):
1767
return 'basis-inventory-cache'
1769
def _reset_data(self):
1770
"""Reset transient data that cannot be revalidated."""
1771
self._inventory_is_modified = False
1772
result = self._deserialize(self._control_files.get('inventory'))
1773
self._set_inventory(result, dirty=False)
1775
@needs_tree_write_lock
1776
def set_last_revision(self, new_revision):
1777
"""Change the last revision in the working tree."""
1778
if self._change_last_revision(new_revision):
1779
self._cache_basis_inventory(new_revision)
1781
def _change_last_revision(self, new_revision):
1782
"""Template method part of set_last_revision to perform the change.
1784
This is used to allow WorkingTree3 instances to not affect branch
1785
when their last revision is set.
1787
if _mod_revision.is_null(new_revision):
1788
self.branch.set_revision_history([])
1791
self.branch.generate_revision_history(new_revision)
1792
except errors.NoSuchRevision:
1793
# not present in the repo - dont try to set it deeper than the tip
1794
self.branch.set_revision_history([new_revision])
1797
def _write_basis_inventory(self, xml):
1798
"""Write the basis inventory XML to the basis-inventory file"""
1799
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1800
path = self._basis_inventory_name()
1802
self._control_files.put(path, sio)
1804
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1805
"""Create the text that will be saved in basis-inventory"""
1806
inventory.revision_id = revision_id
1807
return xml7.serializer_v7.write_inventory_to_string(inventory)
1809
def _cache_basis_inventory(self, new_revision):
1810
"""Cache new_revision as the basis inventory."""
1811
# TODO: this should allow the ready-to-use inventory to be passed in,
1812
# as commit already has that ready-to-use [while the format is the
1815
# this double handles the inventory - unpack and repack -
1816
# but is easier to understand. We can/should put a conditional
1817
# in here based on whether the inventory is in the latest format
1818
# - perhaps we should repack all inventories on a repository
1820
# the fast path is to copy the raw xml from the repository. If the
1821
# xml contains 'revision_id="', then we assume the right
1822
# revision_id is set. We must check for this full string, because a
1823
# root node id can legitimately look like 'revision_id' but cannot
1825
xml = self.branch.repository.get_inventory_xml(new_revision)
1826
firstline = xml.split('\n', 1)[0]
1827
if (not 'revision_id="' in firstline or
1828
'format="7"' not in firstline):
1829
inv = self.branch.repository.deserialise_inventory(
1831
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1832
self._write_basis_inventory(xml)
1833
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1836
def read_basis_inventory(self):
1837
"""Read the cached basis inventory."""
1838
path = self._basis_inventory_name()
1839
return self._control_files.get(path).read()
1842
def read_working_inventory(self):
1843
"""Read the working inventory.
1845
:raises errors.InventoryModified: read_working_inventory will fail
1846
when the current in memory inventory has been modified.
1848
# conceptually this should be an implementation detail of the tree.
1849
# XXX: Deprecate this.
1850
# ElementTree does its own conversion from UTF-8, so open in
1852
if self._inventory_is_modified:
1853
raise errors.InventoryModified(self)
1854
result = self._deserialize(self._control_files.get('inventory'))
1855
self._set_inventory(result, dirty=False)
1858
@needs_tree_write_lock
1859
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1861
"""Remove nominated files from the working inventory.
1863
:files: File paths relative to the basedir.
1864
:keep_files: If true, the files will also be kept.
1865
:force: Delete files and directories, even if they are changed and
1866
even if the directories are not empty.
1868
if isinstance(files, basestring):
1874
unknown_nested_files=set()
1876
def recurse_directory_to_add_files(directory):
1877
# Recurse directory and add all files
1878
# so we can check if they have changed.
1879
for parent_info, file_infos in\
1880
osutils.walkdirs(self.abspath(directory),
1882
for relpath, basename, kind, lstat, abspath in file_infos:
1883
# Is it versioned or ignored?
1884
if self.path2id(relpath) or self.is_ignored(relpath):
1885
# Add nested content for deletion.
1886
new_files.add(relpath)
1888
# Files which are not versioned and not ignored
1889
# should be treated as unknown.
1890
unknown_nested_files.add((relpath, None, kind))
1892
for filename in files:
1893
# Get file name into canonical form.
1894
abspath = self.abspath(filename)
1895
filename = self.relpath(abspath)
1896
if len(filename) > 0:
1897
new_files.add(filename)
1898
if osutils.isdir(abspath):
1899
recurse_directory_to_add_files(filename)
1901
files = list(new_files)
1904
return # nothing to do
1906
# Sort needed to first handle directory content before the directory
1907
files.sort(reverse=True)
1909
# Bail out if we are going to delete files we shouldn't
1910
if not keep_files and not force:
1911
has_changed_files = len(unknown_nested_files) > 0
1912
if not has_changed_files:
1913
for (file_id, path, content_change, versioned, parent_id, name,
1914
kind, executable) in self._iter_changes(self.basis_tree(),
1915
include_unchanged=True, require_versioned=False,
1916
want_unversioned=True, specific_files=files):
1917
if versioned == (False, False):
1918
# The record is unknown ...
1919
if not self.is_ignored(path[1]):
1920
# ... but not ignored
1921
has_changed_files = True
1923
elif content_change and (kind[1] != None):
1924
# Versioned and changed, but not deleted
1925
has_changed_files = True
1928
if has_changed_files:
1929
# Make delta show ALL applicable changes in error message.
1930
tree_delta = self.changes_from(self.basis_tree(),
1931
require_versioned=False, want_unversioned=True,
1932
specific_files=files)
1933
for unknown_file in unknown_nested_files:
1934
if unknown_file not in tree_delta.unversioned:
1935
tree_delta.unversioned.extend((unknown_file,))
1936
raise errors.BzrRemoveChangedFilesError(tree_delta)
1938
# Build inv_delta and delete files where applicaple,
1939
# do this before any modifications to inventory.
1941
fid = self.path2id(f)
1944
message = "%s is not versioned." % (f,)
1947
# having removed it, it must be either ignored or unknown
1948
if self.is_ignored(f):
1952
textui.show_status(new_status, self.kind(fid), f,
1955
inv_delta.append((f, None, fid, None))
1956
message = "removed %s" % (f,)
1959
abs_path = self.abspath(f)
1960
if osutils.lexists(abs_path):
1961
if (osutils.isdir(abs_path) and
1962
len(os.listdir(abs_path)) > 0):
1964
osutils.rmtree(abs_path)
1966
message = "%s is not an empty directory "\
1967
"and won't be deleted." % (f,)
1969
osutils.delete_any(abs_path)
1970
message = "deleted %s" % (f,)
1971
elif message is not None:
1972
# Only care if we haven't done anything yet.
1973
message = "%s does not exist." % (f,)
1975
# Print only one message (if any) per file.
1976
if message is not None:
1978
self.apply_inventory_delta(inv_delta)
1980
@needs_tree_write_lock
1981
def revert(self, filenames=None, old_tree=None, backups=True,
1982
pb=DummyProgress(), report_changes=False):
1983
from bzrlib.conflicts import resolve
1986
symbol_versioning.warn('Using [] to revert all files is deprecated'
1987
' as of bzr 0.91. Please use None (the default) instead.',
1988
DeprecationWarning, stacklevel=2)
1989
if old_tree is None:
1990
basis_tree = self.basis_tree()
1991
basis_tree.lock_read()
1992
old_tree = basis_tree
1996
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1998
if filenames is None and len(self.get_parent_ids()) > 1:
2000
last_revision = self.last_revision()
2001
if last_revision != NULL_REVISION:
2002
if basis_tree is None:
2003
basis_tree = self.basis_tree()
2004
basis_tree.lock_read()
2005
parent_trees.append((last_revision, basis_tree))
2006
self.set_parent_trees(parent_trees)
2009
resolve(self, filenames, ignore_misses=True, recursive=True)
2011
if basis_tree is not None:
2015
def revision_tree(self, revision_id):
2016
"""See Tree.revision_tree.
2018
WorkingTree can supply revision_trees for the basis revision only
2019
because there is only one cached inventory in the bzr directory.
2021
if revision_id == self.last_revision():
2023
xml = self.read_basis_inventory()
2024
except errors.NoSuchFile:
2028
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2029
# dont use the repository revision_tree api because we want
2030
# to supply the inventory.
2031
if inv.revision_id == revision_id:
2032
return revisiontree.RevisionTree(self.branch.repository,
2034
except errors.BadInventoryFormat:
2036
# raise if there was no inventory, or if we read the wrong inventory.
2037
raise errors.NoSuchRevisionInTree(self, revision_id)
2039
# XXX: This method should be deprecated in favour of taking in a proper
2040
# new Inventory object.
2041
@needs_tree_write_lock
2042
def set_inventory(self, new_inventory_list):
2043
from bzrlib.inventory import (Inventory,
2048
inv = Inventory(self.get_root_id())
2049
for path, file_id, parent, kind in new_inventory_list:
2050
name = os.path.basename(path)
2053
# fixme, there should be a factory function inv,add_??
2054
if kind == 'directory':
2055
inv.add(InventoryDirectory(file_id, name, parent))
2056
elif kind == 'file':
2057
inv.add(InventoryFile(file_id, name, parent))
2058
elif kind == 'symlink':
2059
inv.add(InventoryLink(file_id, name, parent))
2061
raise errors.BzrError("unknown kind %r" % kind)
2062
self._write_inventory(inv)
2064
@needs_tree_write_lock
2065
def set_root_id(self, file_id):
2066
"""Set the root id for this tree."""
2069
symbol_versioning.warn(symbol_versioning.zero_twelve
2070
% 'WorkingTree.set_root_id with fileid=None',
2075
file_id = osutils.safe_file_id(file_id)
2076
self._set_root_id(file_id)
2078
def _set_root_id(self, file_id):
2079
"""Set the root id for this tree, in a format specific manner.
2081
:param file_id: The file id to assign to the root. It must not be
2082
present in the current inventory or an error will occur. It must
2083
not be None, but rather a valid file id.
2085
inv = self._inventory
2086
orig_root_id = inv.root.file_id
2087
# TODO: it might be nice to exit early if there was nothing
2088
# to do, saving us from trigger a sync on unlock.
2089
self._inventory_is_modified = True
2090
# we preserve the root inventory entry object, but
2091
# unlinkit from the byid index
2092
del inv._byid[inv.root.file_id]
2093
inv.root.file_id = file_id
2094
# and link it into the index with the new changed id.
2095
inv._byid[inv.root.file_id] = inv.root
2096
# and finally update all children to reference the new id.
2097
# XXX: this should be safe to just look at the root.children
2098
# list, not the WHOLE INVENTORY.
2101
if entry.parent_id == orig_root_id:
2102
entry.parent_id = inv.root.file_id
2105
"""See Branch.unlock.
2107
WorkingTree locking just uses the Branch locking facilities.
2108
This is current because all working trees have an embedded branch
2109
within them. IF in the future, we were to make branch data shareable
2110
between multiple working trees, i.e. via shared storage, then we
2111
would probably want to lock both the local tree, and the branch.
2113
raise NotImplementedError(self.unlock)
2115
def update(self, change_reporter=None, possible_transports=None):
2116
"""Update a working tree along its branch.
2118
This will update the branch if its bound too, which means we have
2119
multiple trees involved:
2121
- The new basis tree of the master.
2122
- The old basis tree of the branch.
2123
- The old basis tree of the working tree.
2124
- The current working tree state.
2126
Pathologically, all three may be different, and non-ancestors of each
2127
other. Conceptually we want to:
2129
- Preserve the wt.basis->wt.state changes
2130
- Transform the wt.basis to the new master basis.
2131
- Apply a merge of the old branch basis to get any 'local' changes from
2133
- Restore the wt.basis->wt.state changes.
2135
There isn't a single operation at the moment to do that, so we:
2136
- Merge current state -> basis tree of the master w.r.t. the old tree
2138
- Do a 'normal' merge of the old branch basis if it is relevant.
2140
if self.branch.get_master_branch(possible_transports) is not None:
2142
update_branch = True
2144
self.lock_tree_write()
2145
update_branch = False
2148
old_tip = self.branch.update(possible_transports)
2151
return self._update_tree(old_tip, change_reporter)
2155
@needs_tree_write_lock
2156
def _update_tree(self, old_tip=None, change_reporter=None):
2157
"""Update a tree to the master branch.
2159
:param old_tip: if supplied, the previous tip revision the branch,
2160
before it was changed to the master branch's tip.
2162
# here if old_tip is not None, it is the old tip of the branch before
2163
# it was updated from the master branch. This should become a pending
2164
# merge in the working tree to preserve the user existing work. we
2165
# cant set that until we update the working trees last revision to be
2166
# one from the new branch, because it will just get absorbed by the
2167
# parent de-duplication logic.
2169
# We MUST save it even if an error occurs, because otherwise the users
2170
# local work is unreferenced and will appear to have been lost.
2174
last_rev = self.get_parent_ids()[0]
2176
last_rev = _mod_revision.NULL_REVISION
2177
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2178
# merge tree state up to new branch tip.
2179
basis = self.basis_tree()
2182
to_tree = self.branch.basis_tree()
2183
if basis.inventory.root is None:
2184
self.set_root_id(to_tree.get_root_id())
2186
result += merge.merge_inner(
2191
change_reporter=change_reporter)
2194
# TODO - dedup parents list with things merged by pull ?
2195
# reuse the tree we've updated to to set the basis:
2196
parent_trees = [(self.branch.last_revision(), to_tree)]
2197
merges = self.get_parent_ids()[1:]
2198
# Ideally we ask the tree for the trees here, that way the working
2199
# tree can decide whether to give us teh entire tree or give us a
2200
# lazy initialised tree. dirstate for instance will have the trees
2201
# in ram already, whereas a last-revision + basis-inventory tree
2202
# will not, but also does not need them when setting parents.
2203
for parent in merges:
2204
parent_trees.append(
2205
(parent, self.branch.repository.revision_tree(parent)))
2206
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2207
parent_trees.append(
2208
(old_tip, self.branch.repository.revision_tree(old_tip)))
2209
self.set_parent_trees(parent_trees)
2210
last_rev = parent_trees[0][0]
2212
# the working tree had the same last-revision as the master
2213
# branch did. We may still have pivot local work from the local
2214
# branch into old_tip:
2215
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2216
self.add_parent_tree_id(old_tip)
2217
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2218
and old_tip != last_rev):
2219
# our last revision was not the prior branch last revision
2220
# and we have converted that last revision to a pending merge.
2221
# base is somewhere between the branch tip now
2222
# and the now pending merge
2224
# Since we just modified the working tree and inventory, flush out
2225
# the current state, before we modify it again.
2226
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2227
# requires it only because TreeTransform directly munges the
2228
# inventory and calls tree._write_inventory(). Ultimately we
2229
# should be able to remove this extra flush.
2231
graph = self.branch.repository.get_graph()
2232
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2234
base_tree = self.branch.repository.revision_tree(base_rev_id)
2235
other_tree = self.branch.repository.revision_tree(old_tip)
2236
result += merge.merge_inner(
2241
change_reporter=change_reporter)
2244
def _write_hashcache_if_dirty(self):
2245
"""Write out the hashcache if it is dirty."""
2246
if self._hashcache.needs_write:
2248
self._hashcache.write()
2250
if e.errno not in (errno.EPERM, errno.EACCES):
2252
# TODO: jam 20061219 Should this be a warning? A single line
2253
# warning might be sufficient to let the user know what
2255
mutter('Could not write hashcache for %s\nError: %s',
2256
self._hashcache.cache_file_name(), e)
2258
@needs_tree_write_lock
2259
def _write_inventory(self, inv):
2260
"""Write inventory as the current inventory."""
2261
self._set_inventory(inv, dirty=True)
2264
def set_conflicts(self, arg):
2265
raise errors.UnsupportedOperation(self.set_conflicts, self)
2267
def add_conflicts(self, arg):
2268
raise errors.UnsupportedOperation(self.add_conflicts, self)
2271
def conflicts(self):
2272
conflicts = _mod_conflicts.ConflictList()
2273
for conflicted in self._iter_conflicts():
2276
if file_kind(self.abspath(conflicted)) != "file":
2278
except errors.NoSuchFile:
2281
for suffix in ('.THIS', '.OTHER'):
2283
kind = file_kind(self.abspath(conflicted+suffix))
2286
except errors.NoSuchFile:
2290
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2291
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2293
file_id=self.path2id(conflicted)))
2296
def walkdirs(self, prefix=""):
2297
"""Walk the directories of this tree.
2299
returns a generator which yields items in the form:
2300
((curren_directory_path, fileid),
2301
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2304
This API returns a generator, which is only valid during the current
2305
tree transaction - within a single lock_read or lock_write duration.
2307
If the tree is not locked, it may cause an error to be raised,
2308
depending on the tree implementation.
2310
disk_top = self.abspath(prefix)
2311
if disk_top.endswith('/'):
2312
disk_top = disk_top[:-1]
2313
top_strip_len = len(disk_top) + 1
2314
inventory_iterator = self._walkdirs(prefix)
2315
disk_iterator = osutils.walkdirs(disk_top, prefix)
2317
current_disk = disk_iterator.next()
2318
disk_finished = False
2320
if not (e.errno == errno.ENOENT or
2321
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2324
disk_finished = True
2326
current_inv = inventory_iterator.next()
2327
inv_finished = False
2328
except StopIteration:
2331
while not inv_finished or not disk_finished:
2333
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2334
cur_disk_dir_content) = current_disk
2336
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2337
cur_disk_dir_content) = ((None, None), None)
2338
if not disk_finished:
2339
# strip out .bzr dirs
2340
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2341
len(cur_disk_dir_content) > 0):
2342
# osutils.walkdirs can be made nicer -
2343
# yield the path-from-prefix rather than the pathjoined
2345
bzrdir_loc = bisect_left(cur_disk_dir_content,
2347
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2348
# we dont yield the contents of, or, .bzr itself.
2349
del cur_disk_dir_content[bzrdir_loc]
2351
# everything is unknown
2354
# everything is missing
2357
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2359
# disk is before inventory - unknown
2360
dirblock = [(relpath, basename, kind, stat, None, None) for
2361
relpath, basename, kind, stat, top_path in
2362
cur_disk_dir_content]
2363
yield (cur_disk_dir_relpath, None), dirblock
2365
current_disk = disk_iterator.next()
2366
except StopIteration:
2367
disk_finished = True
2369
# inventory is before disk - missing.
2370
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2371
for relpath, basename, dkind, stat, fileid, kind in
2373
yield (current_inv[0][0], current_inv[0][1]), dirblock
2375
current_inv = inventory_iterator.next()
2376
except StopIteration:
2379
# versioned present directory
2380
# merge the inventory and disk data together
2382
for relpath, subiterator in itertools.groupby(sorted(
2383
current_inv[1] + cur_disk_dir_content,
2384
key=operator.itemgetter(0)), operator.itemgetter(1)):
2385
path_elements = list(subiterator)
2386
if len(path_elements) == 2:
2387
inv_row, disk_row = path_elements
2388
# versioned, present file
2389
dirblock.append((inv_row[0],
2390
inv_row[1], disk_row[2],
2391
disk_row[3], inv_row[4],
2393
elif len(path_elements[0]) == 5:
2395
dirblock.append((path_elements[0][0],
2396
path_elements[0][1], path_elements[0][2],
2397
path_elements[0][3], None, None))
2398
elif len(path_elements[0]) == 6:
2399
# versioned, absent file.
2400
dirblock.append((path_elements[0][0],
2401
path_elements[0][1], 'unknown', None,
2402
path_elements[0][4], path_elements[0][5]))
2404
raise NotImplementedError('unreachable code')
2405
yield current_inv[0], dirblock
2407
current_inv = inventory_iterator.next()
2408
except StopIteration:
2411
current_disk = disk_iterator.next()
2412
except StopIteration:
2413
disk_finished = True
2415
def _walkdirs(self, prefix=""):
2416
"""Walk the directories of this tree.
2418
:prefix: is used as the directrory to start with.
2419
returns a generator which yields items in the form:
2420
((curren_directory_path, fileid),
2421
[(file1_path, file1_name, file1_kind, None, file1_id,
2424
_directory = 'directory'
2425
# get the root in the inventory
2426
inv = self.inventory
2427
top_id = inv.path2id(prefix)
2431
pending = [(prefix, '', _directory, None, top_id, None)]
2434
currentdir = pending.pop()
2435
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2436
top_id = currentdir[4]
2438
relroot = currentdir[0] + '/'
2441
# FIXME: stash the node in pending
2443
for name, child in entry.sorted_children():
2444
dirblock.append((relroot + name, name, child.kind, None,
2445
child.file_id, child.kind
2447
yield (currentdir[0], entry.file_id), dirblock
2448
# push the user specified dirs from dirblock
2449
for dir in reversed(dirblock):
2450
if dir[2] == _directory:
2453
@needs_tree_write_lock
2454
def auto_resolve(self):
2455
"""Automatically resolve text conflicts according to contents.
2457
Only text conflicts are auto_resolvable. Files with no conflict markers
2458
are considered 'resolved', because bzr always puts conflict markers
2459
into files that have text conflicts. The corresponding .THIS .BASE and
2460
.OTHER files are deleted, as per 'resolve'.
2461
:return: a tuple of ConflictLists: (un_resolved, resolved).
2463
un_resolved = _mod_conflicts.ConflictList()
2464
resolved = _mod_conflicts.ConflictList()
2465
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2466
for conflict in self.conflicts():
2467
if (conflict.typestring != 'text conflict' or
2468
self.kind(conflict.file_id) != 'file'):
2469
un_resolved.append(conflict)
2471
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2473
for line in my_file:
2474
if conflict_re.search(line):
2475
un_resolved.append(conflict)
2478
resolved.append(conflict)
2481
resolved.remove_files(self)
2482
self.set_conflicts(un_resolved)
2483
return un_resolved, resolved
2485
def _validate(self):
2486
"""Validate internal structures.
2488
This is meant mostly for the test suite. To give it a chance to detect
2489
corruption after actions have occurred. The default implementation is a
2492
:return: None. An exception should be raised if there is an error.
2497
class WorkingTree2(WorkingTree):
2498
"""This is the Format 2 working tree.
2500
This was the first weave based working tree.
2501
- uses os locks for locking.
2502
- uses the branch last-revision.
2505
def __init__(self, *args, **kwargs):
2506
super(WorkingTree2, self).__init__(*args, **kwargs)
2507
# WorkingTree2 has more of a constraint that self._inventory must
2508
# exist. Because this is an older format, we don't mind the overhead
2509
# caused by the extra computation here.
2511
# Newer WorkingTree's should only have self._inventory set when they
2513
if self._inventory is None:
2514
self.read_working_inventory()
2516
def lock_tree_write(self):
2517
"""See WorkingTree.lock_tree_write().
2519
In Format2 WorkingTrees we have a single lock for the branch and tree
2520
so lock_tree_write() degrades to lock_write().
2522
self.branch.lock_write()
2524
return self._control_files.lock_write()
2526
self.branch.unlock()
2530
# do non-implementation specific cleanup
2533
# we share control files:
2534
if self._control_files._lock_count == 3:
2535
# _inventory_is_modified is always False during a read lock.
2536
if self._inventory_is_modified:
2538
self._write_hashcache_if_dirty()
2540
# reverse order of locking.
2542
return self._control_files.unlock()
2544
self.branch.unlock()
2547
class WorkingTree3(WorkingTree):
2548
"""This is the Format 3 working tree.
2550
This differs from the base WorkingTree by:
2551
- having its own file lock
2552
- having its own last-revision property.
2554
This is new in bzr 0.8
2558
def _last_revision(self):
2559
"""See Mutable.last_revision."""
2561
return self._control_files.get('last-revision').read()
2562
except errors.NoSuchFile:
2563
return _mod_revision.NULL_REVISION
2565
def _change_last_revision(self, revision_id):
2566
"""See WorkingTree._change_last_revision."""
2567
if revision_id is None or revision_id == NULL_REVISION:
2569
self._control_files._transport.delete('last-revision')
2570
except errors.NoSuchFile:
2574
self._control_files.put_bytes('last-revision', revision_id)
2577
@needs_tree_write_lock
2578
def set_conflicts(self, conflicts):
2579
self._put_rio('conflicts', conflicts.to_stanzas(),
2582
@needs_tree_write_lock
2583
def add_conflicts(self, new_conflicts):
2584
conflict_set = set(self.conflicts())
2585
conflict_set.update(set(list(new_conflicts)))
2586
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2587
key=_mod_conflicts.Conflict.sort_key)))
2590
def conflicts(self):
2592
confile = self._control_files.get('conflicts')
2593
except errors.NoSuchFile:
2594
return _mod_conflicts.ConflictList()
2596
if confile.next() != CONFLICT_HEADER_1 + '\n':
2597
raise errors.ConflictFormatError()
2598
except StopIteration:
2599
raise errors.ConflictFormatError()
2600
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2603
# do non-implementation specific cleanup
2605
if self._control_files._lock_count == 1:
2606
# _inventory_is_modified is always False during a read lock.
2607
if self._inventory_is_modified:
2609
self._write_hashcache_if_dirty()
2610
# reverse order of locking.
2612
return self._control_files.unlock()
2614
self.branch.unlock()
2617
def get_conflicted_stem(path):
2618
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2619
if path.endswith(suffix):
2620
return path[:-len(suffix)]
2623
@deprecated_function(zero_eight)
2624
def is_control_file(filename):
2625
"""See WorkingTree.is_control_filename(filename)."""
2626
## FIXME: better check
2627
filename = normpath(filename)
2628
while filename != '':
2629
head, tail = os.path.split(filename)
2630
## mutter('check %r for control file' % ((head, tail),))
2633
if filename == head:
2639
class WorkingTreeFormat(object):
2640
"""An encapsulation of the initialization and open routines for a format.
2642
Formats provide three things:
2643
* An initialization routine,
2647
Formats are placed in an dict by their format string for reference
2648
during workingtree opening. Its not required that these be instances, they
2649
can be classes themselves with class methods - it simply depends on
2650
whether state is needed for a given format or not.
2652
Once a format is deprecated, just deprecate the initialize and open
2653
methods on the format class. Do not deprecate the object, as the
2654
object will be created every time regardless.
2657
_default_format = None
2658
"""The default format used for new trees."""
2661
"""The known formats."""
2663
requires_rich_root = False
2665
upgrade_recommended = False
2668
def find_format(klass, a_bzrdir):
2669
"""Return the format for the working tree object in a_bzrdir."""
2671
transport = a_bzrdir.get_workingtree_transport(None)
2672
format_string = transport.get("format").read()
2673
return klass._formats[format_string]
2674
except errors.NoSuchFile:
2675
raise errors.NoWorkingTree(base=transport.base)
2677
raise errors.UnknownFormatError(format=format_string)
2679
def __eq__(self, other):
2680
return self.__class__ is other.__class__
2682
def __ne__(self, other):
2683
return not (self == other)
2686
def get_default_format(klass):
2687
"""Return the current default format."""
2688
return klass._default_format
2690
def get_format_string(self):
2691
"""Return the ASCII format string that identifies this format."""
2692
raise NotImplementedError(self.get_format_string)
2694
def get_format_description(self):
2695
"""Return the short description for this format."""
2696
raise NotImplementedError(self.get_format_description)
2698
def is_supported(self):
2699
"""Is this format supported?
2701
Supported formats can be initialized and opened.
2702
Unsupported formats may not support initialization or committing or
2703
some other features depending on the reason for not being supported.
2708
def register_format(klass, format):
2709
klass._formats[format.get_format_string()] = format
2712
def set_default_format(klass, format):
2713
klass._default_format = format
2716
def unregister_format(klass, format):
2717
assert klass._formats[format.get_format_string()] is format
2718
del klass._formats[format.get_format_string()]
2721
class WorkingTreeFormat2(WorkingTreeFormat):
2722
"""The second working tree format.
2724
This format modified the hash cache from the format 1 hash cache.
2727
upgrade_recommended = True
2729
def get_format_description(self):
2730
"""See WorkingTreeFormat.get_format_description()."""
2731
return "Working tree format 2"
2733
def stub_initialize_remote(self, control_files):
2734
"""As a special workaround create critical control files for a remote working tree
2736
This ensures that it can later be updated and dealt with locally,
2737
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2738
no working tree. (See bug #43064).
2742
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2744
control_files.put('inventory', sio)
2746
control_files.put_bytes('pending-merges', '')
2749
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2750
accelerator_tree=None, hardlink=False):
2751
"""See WorkingTreeFormat.initialize()."""
2752
if not isinstance(a_bzrdir.transport, LocalTransport):
2753
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2754
if from_branch is not None:
2755
branch = from_branch
2757
branch = a_bzrdir.open_branch()
2758
if revision_id is None:
2759
revision_id = _mod_revision.ensure_null(branch.last_revision())
2762
branch.generate_revision_history(revision_id)
2766
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2772
basis_tree = branch.repository.revision_tree(revision_id)
2773
if basis_tree.inventory.root is not None:
2774
wt.set_root_id(basis_tree.get_root_id())
2775
# set the parent list and cache the basis tree.
2776
if _mod_revision.is_null(revision_id):
2779
parent_trees = [(revision_id, basis_tree)]
2780
wt.set_parent_trees(parent_trees)
2781
transform.build_tree(basis_tree, wt)
2785
super(WorkingTreeFormat2, self).__init__()
2786
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2788
def open(self, a_bzrdir, _found=False):
2789
"""Return the WorkingTree object for a_bzrdir
2791
_found is a private parameter, do not use it. It is used to indicate
2792
if format probing has already been done.
2795
# we are being called directly and must probe.
2796
raise NotImplementedError
2797
if not isinstance(a_bzrdir.transport, LocalTransport):
2798
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2799
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2805
class WorkingTreeFormat3(WorkingTreeFormat):
2806
"""The second working tree format updated to record a format marker.
2809
- exists within a metadir controlling .bzr
2810
- includes an explicit version marker for the workingtree control
2811
files, separate from the BzrDir format
2812
- modifies the hash cache format
2814
- uses a LockDir to guard access for writes.
2817
upgrade_recommended = True
2819
def get_format_string(self):
2820
"""See WorkingTreeFormat.get_format_string()."""
2821
return "Bazaar-NG Working Tree format 3"
2823
def get_format_description(self):
2824
"""See WorkingTreeFormat.get_format_description()."""
2825
return "Working tree format 3"
2827
_lock_file_name = 'lock'
2828
_lock_class = LockDir
2830
_tree_class = WorkingTree3
2832
def __get_matchingbzrdir(self):
2833
return bzrdir.BzrDirMetaFormat1()
2835
_matchingbzrdir = property(__get_matchingbzrdir)
2837
def _open_control_files(self, a_bzrdir):
2838
transport = a_bzrdir.get_workingtree_transport(None)
2839
return LockableFiles(transport, self._lock_file_name,
2842
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2843
accelerator_tree=None, hardlink=False):
2844
"""See WorkingTreeFormat.initialize().
2846
:param revision_id: if supplied, create a working tree at a different
2847
revision than the branch is at.
2848
:param accelerator_tree: A tree which can be used for retrieving file
2849
contents more quickly than the revision tree, i.e. a workingtree.
2850
The revision tree will be used for cases where accelerator_tree's
2851
content is different.
2852
:param hardlink: If true, hard-link files from accelerator_tree,
2855
if not isinstance(a_bzrdir.transport, LocalTransport):
2856
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2857
transport = a_bzrdir.get_workingtree_transport(self)
2858
control_files = self._open_control_files(a_bzrdir)
2859
control_files.create_lock()
2860
control_files.lock_write()
2861
control_files.put_utf8('format', self.get_format_string())
2862
if from_branch is not None:
2863
branch = from_branch
2865
branch = a_bzrdir.open_branch()
2866
if revision_id is None:
2867
revision_id = _mod_revision.ensure_null(branch.last_revision())
2868
# WorkingTree3 can handle an inventory which has a unique root id.
2869
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2870
# those trees. And because there isn't a format bump inbetween, we
2871
# are maintaining compatibility with older clients.
2872
# inv = Inventory(root_id=gen_root_id())
2873
inv = self._initial_inventory()
2874
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2880
_control_files=control_files)
2881
wt.lock_tree_write()
2883
basis_tree = branch.repository.revision_tree(revision_id)
2884
# only set an explicit root id if there is one to set.
2885
if basis_tree.inventory.root is not None:
2886
wt.set_root_id(basis_tree.get_root_id())
2887
if revision_id == NULL_REVISION:
2888
wt.set_parent_trees([])
2890
wt.set_parent_trees([(revision_id, basis_tree)])
2891
transform.build_tree(basis_tree, wt)
2893
# Unlock in this order so that the unlock-triggers-flush in
2894
# WorkingTree is given a chance to fire.
2895
control_files.unlock()
2899
def _initial_inventory(self):
2903
super(WorkingTreeFormat3, self).__init__()
2905
def open(self, a_bzrdir, _found=False):
2906
"""Return the WorkingTree object for a_bzrdir
2908
_found is a private parameter, do not use it. It is used to indicate
2909
if format probing has already been done.
2912
# we are being called directly and must probe.
2913
raise NotImplementedError
2914
if not isinstance(a_bzrdir.transport, LocalTransport):
2915
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2916
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2919
def _open(self, a_bzrdir, control_files):
2920
"""Open the tree itself.
2922
:param a_bzrdir: the dir for the tree.
2923
:param control_files: the control files for the tree.
2925
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2929
_control_files=control_files)
2932
return self.get_format_string()
2935
__default_format = WorkingTreeFormat4()
2936
WorkingTreeFormat.register_format(__default_format)
2937
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2938
WorkingTreeFormat.set_default_format(__default_format)
2939
# formats which have no format string are not discoverable
2940
# and not independently creatable, so are not registered.
2941
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
