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")
280
if e.errno != errno.ENOENT:
282
self.case_sensitive = True
284
self.case_sensitive = False
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 _directory_is_tree_reference(self, relpath):
996
# as a special case, if a directory contains control files then
997
# it's a tree reference, except that the root of the tree is not
998
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
999
# TODO: We could ask all the control formats whether they
1000
# recognize this directory, but at the moment there's no cheap api
1001
# to do that. Since we probably can only nest bzr checkouts and
1002
# they always use this name it's ok for now. -- mbp 20060306
1004
# FIXME: There is an unhandled case here of a subdirectory
1005
# containing .bzr but not a branch; that will probably blow up
1006
# when you try to commit it. It might happen if there is a
1007
# checkout in a subdirectory. This can be avoided by not adding
1010
@needs_tree_write_lock
1011
def extract(self, file_id, format=None):
1012
"""Extract a subtree from this tree.
1014
A new branch will be created, relative to the path for this tree.
1018
segments = osutils.splitpath(path)
1019
transport = self.branch.bzrdir.root_transport
1020
for name in segments:
1021
transport = transport.clone(name)
1022
transport.ensure_base()
1025
sub_path = self.id2path(file_id)
1026
branch_transport = mkdirs(sub_path)
1028
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1029
branch_transport.ensure_base()
1030
branch_bzrdir = format.initialize_on_transport(branch_transport)
1032
repo = branch_bzrdir.find_repository()
1033
except errors.NoRepositoryPresent:
1034
repo = branch_bzrdir.create_repository()
1035
assert repo.supports_rich_root()
1037
if not repo.supports_rich_root():
1038
raise errors.RootNotRich()
1039
new_branch = branch_bzrdir.create_branch()
1040
new_branch.pull(self.branch)
1041
for parent_id in self.get_parent_ids():
1042
new_branch.fetch(self.branch, parent_id)
1043
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1044
if tree_transport.base != branch_transport.base:
1045
tree_bzrdir = format.initialize_on_transport(tree_transport)
1046
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1048
tree_bzrdir = branch_bzrdir
1049
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1050
wt.set_parent_ids(self.get_parent_ids())
1051
my_inv = self.inventory
1052
child_inv = Inventory(root_id=None)
1053
new_root = my_inv[file_id]
1054
my_inv.remove_recursive_id(file_id)
1055
new_root.parent_id = None
1056
child_inv.add(new_root)
1057
self._write_inventory(my_inv)
1058
wt._write_inventory(child_inv)
1061
def _serialize(self, inventory, out_file):
1062
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1065
def _deserialize(selt, in_file):
1066
return xml5.serializer_v5.read_inventory(in_file)
1069
"""Write the in memory inventory to disk."""
1070
# TODO: Maybe this should only write on dirty ?
1071
if self._control_files._lock_mode != 'w':
1072
raise errors.NotWriteLocked(self)
1074
self._serialize(self._inventory, sio)
1076
self._control_files.put('inventory', sio)
1077
self._inventory_is_modified = False
1079
def _kind(self, relpath):
1080
return osutils.file_kind(self.abspath(relpath))
1082
def list_files(self, include_root=False):
1083
"""Recursively list all files as (path, class, kind, id, entry).
1085
Lists, but does not descend into unversioned directories.
1087
This does not include files that have been deleted in this
1090
Skips the control directory.
1092
# list_files is an iterator, so @needs_read_lock doesn't work properly
1093
# with it. So callers should be careful to always read_lock the tree.
1094
if not self.is_locked():
1095
raise errors.ObjectNotLocked(self)
1097
inv = self.inventory
1098
if include_root is True:
1099
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1100
# Convert these into local objects to save lookup times
1101
pathjoin = osutils.pathjoin
1102
file_kind = self._kind
1104
# transport.base ends in a slash, we want the piece
1105
# between the last two slashes
1106
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1108
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1110
# directory file_id, relative path, absolute path, reverse sorted children
1111
children = os.listdir(self.basedir)
1113
# jam 20060527 The kernel sized tree seems equivalent whether we
1114
# use a deque and popleft to keep them sorted, or if we use a plain
1115
# list and just reverse() them.
1116
children = collections.deque(children)
1117
stack = [(inv.root.file_id, u'', self.basedir, children)]
1119
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1122
f = children.popleft()
1123
## TODO: If we find a subdirectory with its own .bzr
1124
## directory, then that is a separate tree and we
1125
## should exclude it.
1127
# the bzrdir for this tree
1128
if transport_base_dir == f:
1131
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1132
# and 'f' doesn't begin with one, we can do a string op, rather
1133
# than the checks of pathjoin(), all relative paths will have an extra slash
1135
fp = from_dir_relpath + '/' + f
1138
fap = from_dir_abspath + '/' + f
1140
f_ie = inv.get_child(from_dir_id, f)
1143
elif self.is_ignored(fp[1:]):
1146
# we may not have found this file, because of a unicode issue
1147
f_norm, can_access = osutils.normalized_filename(f)
1148
if f == f_norm or not can_access:
1149
# No change, so treat this file normally
1152
# this file can be accessed by a normalized path
1153
# check again if it is versioned
1154
# these lines are repeated here for performance
1156
fp = from_dir_relpath + '/' + f
1157
fap = from_dir_abspath + '/' + f
1158
f_ie = inv.get_child(from_dir_id, f)
1161
elif self.is_ignored(fp[1:]):
1168
# make a last minute entry
1170
yield fp[1:], c, fk, f_ie.file_id, f_ie
1173
yield fp[1:], c, fk, None, fk_entries[fk]()
1175
yield fp[1:], c, fk, None, TreeEntry()
1178
if fk != 'directory':
1181
# But do this child first
1182
new_children = os.listdir(fap)
1184
new_children = collections.deque(new_children)
1185
stack.append((f_ie.file_id, fp, fap, new_children))
1186
# Break out of inner loop,
1187
# so that we start outer loop with child
1190
# if we finished all children, pop it off the stack
1193
@needs_tree_write_lock
1194
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1197
to_dir must exist in the inventory.
1199
If to_dir exists and is a directory, the files are moved into
1200
it, keeping their old names.
1202
Note that to_dir is only the last component of the new name;
1203
this doesn't change the directory.
1205
For each entry in from_paths the move mode will be determined
1208
The first mode moves the file in the filesystem and updates the
1209
inventory. The second mode only updates the inventory without
1210
touching the file on the filesystem. This is the new mode introduced
1213
move uses the second mode if 'after == True' and the target is not
1214
versioned but present in the working tree.
1216
move uses the second mode if 'after == False' and the source is
1217
versioned but no longer in the working tree, and the target is not
1218
versioned but present in the working tree.
1220
move uses the first mode if 'after == False' and the source is
1221
versioned and present in the working tree, and the target is not
1222
versioned and not present in the working tree.
1224
Everything else results in an error.
1226
This returns a list of (from_path, to_path) pairs for each
1227
entry that is moved.
1232
# check for deprecated use of signature
1234
to_dir = kwargs.get('to_name', None)
1236
raise TypeError('You must supply a target directory')
1238
symbol_versioning.warn('The parameter to_name was deprecated'
1239
' in version 0.13. Use to_dir instead',
1242
# check destination directory
1243
assert not isinstance(from_paths, basestring)
1244
inv = self.inventory
1245
to_abs = self.abspath(to_dir)
1246
if not isdir(to_abs):
1247
raise errors.BzrMoveFailedError('',to_dir,
1248
errors.NotADirectory(to_abs))
1249
if not self.has_filename(to_dir):
1250
raise errors.BzrMoveFailedError('',to_dir,
1251
errors.NotInWorkingDirectory(to_dir))
1252
to_dir_id = inv.path2id(to_dir)
1253
if to_dir_id is None:
1254
raise errors.BzrMoveFailedError('',to_dir,
1255
errors.NotVersionedError(path=str(to_dir)))
1257
to_dir_ie = inv[to_dir_id]
1258
if to_dir_ie.kind != 'directory':
1259
raise errors.BzrMoveFailedError('',to_dir,
1260
errors.NotADirectory(to_abs))
1262
# create rename entries and tuples
1263
for from_rel in from_paths:
1264
from_tail = splitpath(from_rel)[-1]
1265
from_id = inv.path2id(from_rel)
1267
raise errors.BzrMoveFailedError(from_rel,to_dir,
1268
errors.NotVersionedError(path=str(from_rel)))
1270
from_entry = inv[from_id]
1271
from_parent_id = from_entry.parent_id
1272
to_rel = pathjoin(to_dir, from_tail)
1273
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1275
from_tail=from_tail,
1276
from_parent_id=from_parent_id,
1277
to_rel=to_rel, to_tail=from_tail,
1278
to_parent_id=to_dir_id)
1279
rename_entries.append(rename_entry)
1280
rename_tuples.append((from_rel, to_rel))
1282
# determine which move mode to use. checks also for movability
1283
rename_entries = self._determine_mv_mode(rename_entries, after)
1285
original_modified = self._inventory_is_modified
1288
self._inventory_is_modified = True
1289
self._move(rename_entries)
1291
# restore the inventory on error
1292
self._inventory_is_modified = original_modified
1294
self._write_inventory(inv)
1295
return rename_tuples
1297
def _determine_mv_mode(self, rename_entries, after=False):
1298
"""Determines for each from-to pair if both inventory and working tree
1299
or only the inventory has to be changed.
1301
Also does basic plausability tests.
1303
inv = self.inventory
1305
for rename_entry in rename_entries:
1306
# store to local variables for easier reference
1307
from_rel = rename_entry.from_rel
1308
from_id = rename_entry.from_id
1309
to_rel = rename_entry.to_rel
1310
to_id = inv.path2id(to_rel)
1311
only_change_inv = False
1313
# check the inventory for source and destination
1315
raise errors.BzrMoveFailedError(from_rel,to_rel,
1316
errors.NotVersionedError(path=str(from_rel)))
1317
if to_id is not None:
1318
raise errors.BzrMoveFailedError(from_rel,to_rel,
1319
errors.AlreadyVersionedError(path=str(to_rel)))
1321
# try to determine the mode for rename (only change inv or change
1322
# inv and file system)
1324
if not self.has_filename(to_rel):
1325
raise errors.BzrMoveFailedError(from_id,to_rel,
1326
errors.NoSuchFile(path=str(to_rel),
1327
extra="New file has not been created yet"))
1328
only_change_inv = True
1329
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1330
only_change_inv = True
1331
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1332
only_change_inv = False
1333
elif (sys.platform == 'win32'
1334
and from_rel.lower() == to_rel.lower()
1335
and self.has_filename(from_rel)):
1336
only_change_inv = False
1338
# something is wrong, so lets determine what exactly
1339
if not self.has_filename(from_rel) and \
1340
not self.has_filename(to_rel):
1341
raise errors.BzrRenameFailedError(from_rel,to_rel,
1342
errors.PathsDoNotExist(paths=(str(from_rel),
1345
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1346
rename_entry.only_change_inv = only_change_inv
1347
return rename_entries
1349
def _move(self, rename_entries):
1350
"""Moves a list of files.
1352
Depending on the value of the flag 'only_change_inv', the
1353
file will be moved on the file system or not.
1355
inv = self.inventory
1358
for entry in rename_entries:
1360
self._move_entry(entry)
1362
self._rollback_move(moved)
1366
def _rollback_move(self, moved):
1367
"""Try to rollback a previous move in case of an filesystem error."""
1368
inv = self.inventory
1371
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1372
entry.to_tail, entry.to_parent_id, entry.from_rel,
1373
entry.from_tail, entry.from_parent_id,
1374
entry.only_change_inv))
1375
except errors.BzrMoveFailedError, e:
1376
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1377
" The working tree is in an inconsistent state."
1378
" Please consider doing a 'bzr revert'."
1379
" Error message is: %s" % e)
1381
def _move_entry(self, entry):
1382
inv = self.inventory
1383
from_rel_abs = self.abspath(entry.from_rel)
1384
to_rel_abs = self.abspath(entry.to_rel)
1385
if from_rel_abs == to_rel_abs:
1386
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1387
"Source and target are identical.")
1389
if not entry.only_change_inv:
1391
osutils.rename(from_rel_abs, to_rel_abs)
1393
raise errors.BzrMoveFailedError(entry.from_rel,
1395
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1397
@needs_tree_write_lock
1398
def rename_one(self, from_rel, to_rel, after=False):
1401
This can change the directory or the filename or both.
1403
rename_one has several 'modes' to work. First, it can rename a physical
1404
file and change the file_id. That is the normal mode. Second, it can
1405
only change the file_id without touching any physical file. This is
1406
the new mode introduced in version 0.15.
1408
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1409
versioned but present in the working tree.
1411
rename_one uses the second mode if 'after == False' and 'from_rel' is
1412
versioned but no longer in the working tree, and 'to_rel' is not
1413
versioned but present in the working tree.
1415
rename_one uses the first mode if 'after == False' and 'from_rel' is
1416
versioned and present in the working tree, and 'to_rel' is not
1417
versioned and not present in the working tree.
1419
Everything else results in an error.
1421
inv = self.inventory
1424
# create rename entries and tuples
1425
from_tail = splitpath(from_rel)[-1]
1426
from_id = inv.path2id(from_rel)
1428
raise errors.BzrRenameFailedError(from_rel,to_rel,
1429
errors.NotVersionedError(path=str(from_rel)))
1430
from_entry = inv[from_id]
1431
from_parent_id = from_entry.parent_id
1432
to_dir, to_tail = os.path.split(to_rel)
1433
to_dir_id = inv.path2id(to_dir)
1434
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1436
from_tail=from_tail,
1437
from_parent_id=from_parent_id,
1438
to_rel=to_rel, to_tail=to_tail,
1439
to_parent_id=to_dir_id)
1440
rename_entries.append(rename_entry)
1442
# determine which move mode to use. checks also for movability
1443
rename_entries = self._determine_mv_mode(rename_entries, after)
1445
# check if the target changed directory and if the target directory is
1447
if to_dir_id is None:
1448
raise errors.BzrMoveFailedError(from_rel,to_rel,
1449
errors.NotVersionedError(path=str(to_dir)))
1451
# all checks done. now we can continue with our actual work
1452
mutter('rename_one:\n'
1457
' to_dir_id {%s}\n',
1458
from_id, from_rel, to_rel, to_dir, to_dir_id)
1460
self._move(rename_entries)
1461
self._write_inventory(inv)
1463
class _RenameEntry(object):
1464
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1465
to_rel, to_tail, to_parent_id, only_change_inv=False):
1466
self.from_rel = from_rel
1467
self.from_id = from_id
1468
self.from_tail = from_tail
1469
self.from_parent_id = from_parent_id
1470
self.to_rel = to_rel
1471
self.to_tail = to_tail
1472
self.to_parent_id = to_parent_id
1473
self.only_change_inv = only_change_inv
1477
"""Return all unknown files.
1479
These are files in the working directory that are not versioned or
1480
control files or ignored.
1482
# force the extras method to be fully executed before returning, to
1483
# prevent race conditions with the lock
1485
[subp for subp in self.extras() if not self.is_ignored(subp)])
1487
@needs_tree_write_lock
1488
def unversion(self, file_ids):
1489
"""Remove the file ids in file_ids from the current versioned set.
1491
When a file_id is unversioned, all of its children are automatically
1494
:param file_ids: The file ids to stop versioning.
1495
:raises: NoSuchId if any fileid is not currently versioned.
1497
for file_id in file_ids:
1498
if self._inventory.has_id(file_id):
1499
self._inventory.remove_recursive_id(file_id)
1501
raise errors.NoSuchId(self, file_id)
1503
# in the future this should just set a dirty bit to wait for the
1504
# final unlock. However, until all methods of workingtree start
1505
# with the current in -memory inventory rather than triggering
1506
# a read, it is more complex - we need to teach read_inventory
1507
# to know when to read, and when to not read first... and possibly
1508
# to save first when the in memory one may be corrupted.
1509
# so for now, we just only write it if it is indeed dirty.
1511
self._write_inventory(self._inventory)
1513
@deprecated_method(zero_eight)
1514
def iter_conflicts(self):
1515
"""List all files in the tree that have text or content conflicts.
1516
DEPRECATED. Use conflicts instead."""
1517
return self._iter_conflicts()
1519
def _iter_conflicts(self):
1521
for info in self.list_files():
1523
stem = get_conflicted_stem(path)
1526
if stem not in conflicted:
1527
conflicted.add(stem)
1531
def pull(self, source, overwrite=False, stop_revision=None,
1532
change_reporter=None, possible_transports=None):
1533
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1536
pp = ProgressPhase("Pull phase", 2, top_pb)
1538
old_revision_info = self.branch.last_revision_info()
1539
basis_tree = self.basis_tree()
1540
count = self.branch.pull(source, overwrite, stop_revision,
1541
possible_transports=possible_transports)
1542
new_revision_info = self.branch.last_revision_info()
1543
if new_revision_info != old_revision_info:
1545
repository = self.branch.repository
1546
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1547
basis_tree.lock_read()
1549
new_basis_tree = self.branch.basis_tree()
1556
change_reporter=change_reporter)
1557
if (basis_tree.inventory.root is None and
1558
new_basis_tree.inventory.root is not None):
1559
self.set_root_id(new_basis_tree.get_root_id())
1563
# TODO - dedup parents list with things merged by pull ?
1564
# reuse the revisiontree we merged against to set the new
1566
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1567
# we have to pull the merge trees out again, because
1568
# merge_inner has set the ids. - this corner is not yet
1569
# layered well enough to prevent double handling.
1570
# XXX TODO: Fix the double handling: telling the tree about
1571
# the already known parent data is wasteful.
1572
merges = self.get_parent_ids()[1:]
1573
parent_trees.extend([
1574
(parent, repository.revision_tree(parent)) for
1576
self.set_parent_trees(parent_trees)
1583
def put_file_bytes_non_atomic(self, file_id, bytes):
1584
"""See MutableTree.put_file_bytes_non_atomic."""
1585
stream = file(self.id2abspath(file_id), 'wb')
1590
# TODO: update the hashcache here ?
1593
"""Yield all unversioned files in this WorkingTree.
1595
If there are any unversioned directories then only the directory is
1596
returned, not all its children. But if there are unversioned files
1597
under a versioned subdirectory, they are returned.
1599
Currently returned depth-first, sorted by name within directories.
1600
This is the same order used by 'osutils.walkdirs'.
1602
## TODO: Work from given directory downwards
1603
for path, dir_entry in self.inventory.directories():
1604
# mutter("search for unknowns in %r", path)
1605
dirabs = self.abspath(path)
1606
if not isdir(dirabs):
1607
# e.g. directory deleted
1611
for subf in os.listdir(dirabs):
1614
if subf not in dir_entry.children:
1615
subf_norm, can_access = osutils.normalized_filename(subf)
1616
if subf_norm != subf and can_access:
1617
if subf_norm not in dir_entry.children:
1618
fl.append(subf_norm)
1624
subp = pathjoin(path, subf)
1627
def ignored_files(self):
1628
"""Yield list of PATH, IGNORE_PATTERN"""
1629
for subp in self.extras():
1630
pat = self.is_ignored(subp)
1634
def get_ignore_list(self):
1635
"""Return list of ignore patterns.
1637
Cached in the Tree object after the first call.
1639
ignoreset = getattr(self, '_ignoreset', None)
1640
if ignoreset is not None:
1643
ignore_globs = set()
1644
ignore_globs.update(ignores.get_runtime_ignores())
1645
ignore_globs.update(ignores.get_user_ignores())
1646
if self.has_filename(bzrlib.IGNORE_FILENAME):
1647
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1649
ignore_globs.update(ignores.parse_ignore_file(f))
1652
self._ignoreset = ignore_globs
1655
def _flush_ignore_list_cache(self):
1656
"""Resets the cached ignore list to force a cache rebuild."""
1657
self._ignoreset = None
1658
self._ignoreglobster = None
1660
def is_ignored(self, filename):
1661
r"""Check whether the filename matches an ignore pattern.
1663
Patterns containing '/' or '\' need to match the whole path;
1664
others match against only the last component.
1666
If the file is ignored, returns the pattern which caused it to
1667
be ignored, otherwise None. So this can simply be used as a
1668
boolean if desired."""
1669
if getattr(self, '_ignoreglobster', None) is None:
1670
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1671
return self._ignoreglobster.match(filename)
1673
def kind(self, file_id):
1674
return file_kind(self.id2abspath(file_id))
1676
def _comparison_data(self, entry, path):
1677
abspath = self.abspath(path)
1679
stat_value = os.lstat(abspath)
1681
if getattr(e, 'errno', None) == errno.ENOENT:
1688
mode = stat_value.st_mode
1689
kind = osutils.file_kind_from_stat_mode(mode)
1690
if not supports_executable():
1691
executable = entry is not None and entry.executable
1693
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1694
return kind, executable, stat_value
1696
def _file_size(self, entry, stat_value):
1697
return stat_value.st_size
1699
def last_revision(self):
1700
"""Return the last revision of the branch for this tree.
1702
This format tree does not support a separate marker for last-revision
1703
compared to the branch.
1705
See MutableTree.last_revision
1707
return self._last_revision()
1710
def _last_revision(self):
1711
"""helper for get_parent_ids."""
1712
return _mod_revision.ensure_null(self.branch.last_revision())
1714
def is_locked(self):
1715
return self._control_files.is_locked()
1717
def _must_be_locked(self):
1718
if not self.is_locked():
1719
raise errors.ObjectNotLocked(self)
1721
def lock_read(self):
1722
"""See Branch.lock_read, and WorkingTree.unlock."""
1723
if not self.is_locked():
1725
self.branch.lock_read()
1727
return self._control_files.lock_read()
1729
self.branch.unlock()
1732
def lock_tree_write(self):
1733
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1734
if not self.is_locked():
1736
self.branch.lock_read()
1738
return self._control_files.lock_write()
1740
self.branch.unlock()
1743
def lock_write(self):
1744
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1745
if not self.is_locked():
1747
self.branch.lock_write()
1749
return self._control_files.lock_write()
1751
self.branch.unlock()
1754
def get_physical_lock_status(self):
1755
return self._control_files.get_physical_lock_status()
1757
def _basis_inventory_name(self):
1758
return 'basis-inventory-cache'
1760
def _reset_data(self):
1761
"""Reset transient data that cannot be revalidated."""
1762
self._inventory_is_modified = False
1763
result = self._deserialize(self._control_files.get('inventory'))
1764
self._set_inventory(result, dirty=False)
1766
@needs_tree_write_lock
1767
def set_last_revision(self, new_revision):
1768
"""Change the last revision in the working tree."""
1769
if self._change_last_revision(new_revision):
1770
self._cache_basis_inventory(new_revision)
1772
def _change_last_revision(self, new_revision):
1773
"""Template method part of set_last_revision to perform the change.
1775
This is used to allow WorkingTree3 instances to not affect branch
1776
when their last revision is set.
1778
if _mod_revision.is_null(new_revision):
1779
self.branch.set_revision_history([])
1782
self.branch.generate_revision_history(new_revision)
1783
except errors.NoSuchRevision:
1784
# not present in the repo - dont try to set it deeper than the tip
1785
self.branch.set_revision_history([new_revision])
1788
def _write_basis_inventory(self, xml):
1789
"""Write the basis inventory XML to the basis-inventory file"""
1790
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1791
path = self._basis_inventory_name()
1793
self._control_files.put(path, sio)
1795
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1796
"""Create the text that will be saved in basis-inventory"""
1797
inventory.revision_id = revision_id
1798
return xml7.serializer_v7.write_inventory_to_string(inventory)
1800
def _cache_basis_inventory(self, new_revision):
1801
"""Cache new_revision as the basis inventory."""
1802
# TODO: this should allow the ready-to-use inventory to be passed in,
1803
# as commit already has that ready-to-use [while the format is the
1806
# this double handles the inventory - unpack and repack -
1807
# but is easier to understand. We can/should put a conditional
1808
# in here based on whether the inventory is in the latest format
1809
# - perhaps we should repack all inventories on a repository
1811
# the fast path is to copy the raw xml from the repository. If the
1812
# xml contains 'revision_id="', then we assume the right
1813
# revision_id is set. We must check for this full string, because a
1814
# root node id can legitimately look like 'revision_id' but cannot
1816
xml = self.branch.repository.get_inventory_xml(new_revision)
1817
firstline = xml.split('\n', 1)[0]
1818
if (not 'revision_id="' in firstline or
1819
'format="7"' not in firstline):
1820
inv = self.branch.repository.deserialise_inventory(
1822
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1823
self._write_basis_inventory(xml)
1824
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1827
def read_basis_inventory(self):
1828
"""Read the cached basis inventory."""
1829
path = self._basis_inventory_name()
1830
return self._control_files.get(path).read()
1833
def read_working_inventory(self):
1834
"""Read the working inventory.
1836
:raises errors.InventoryModified: read_working_inventory will fail
1837
when the current in memory inventory has been modified.
1839
# conceptually this should be an implementation detail of the tree.
1840
# XXX: Deprecate this.
1841
# ElementTree does its own conversion from UTF-8, so open in
1843
if self._inventory_is_modified:
1844
raise errors.InventoryModified(self)
1845
result = self._deserialize(self._control_files.get('inventory'))
1846
self._set_inventory(result, dirty=False)
1849
@needs_tree_write_lock
1850
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1852
"""Remove nominated files from the working inventory.
1854
:files: File paths relative to the basedir.
1855
:keep_files: If true, the files will also be kept.
1856
:force: Delete files and directories, even if they are changed and
1857
even if the directories are not empty.
1859
if isinstance(files, basestring):
1865
unknown_nested_files=set()
1867
def recurse_directory_to_add_files(directory):
1868
# Recurse directory and add all files
1869
# so we can check if they have changed.
1870
for parent_info, file_infos in\
1871
osutils.walkdirs(self.abspath(directory),
1873
for relpath, basename, kind, lstat, abspath in file_infos:
1874
# Is it versioned or ignored?
1875
if self.path2id(relpath) or self.is_ignored(relpath):
1876
# Add nested content for deletion.
1877
new_files.add(relpath)
1879
# Files which are not versioned and not ignored
1880
# should be treated as unknown.
1881
unknown_nested_files.add((relpath, None, kind))
1883
for filename in files:
1884
# Get file name into canonical form.
1885
abspath = self.abspath(filename)
1886
filename = self.relpath(abspath)
1887
if len(filename) > 0:
1888
new_files.add(filename)
1889
if osutils.isdir(abspath):
1890
recurse_directory_to_add_files(filename)
1892
files = list(new_files)
1895
return # nothing to do
1897
# Sort needed to first handle directory content before the directory
1898
files.sort(reverse=True)
1900
# Bail out if we are going to delete files we shouldn't
1901
if not keep_files and not force:
1902
has_changed_files = len(unknown_nested_files) > 0
1903
if not has_changed_files:
1904
for (file_id, path, content_change, versioned, parent_id, name,
1905
kind, executable) in self._iter_changes(self.basis_tree(),
1906
include_unchanged=True, require_versioned=False,
1907
want_unversioned=True, specific_files=files):
1908
# Check if it's an unknown (but not ignored) OR
1909
# changed (but not deleted) :
1910
if ((versioned == (False, False) or
1911
content_change and kind[1] != None)
1912
and not self.is_ignored(path[1])):
1913
has_changed_files = True
1916
if has_changed_files:
1917
# Make delta show ALL applicable changes in error message.
1918
tree_delta = self.changes_from(self.basis_tree(),
1919
require_versioned=False, want_unversioned=True,
1920
specific_files=files)
1921
for unknown_file in unknown_nested_files:
1922
if unknown_file not in tree_delta.unversioned:
1923
tree_delta.unversioned.extend((unknown_file,))
1924
raise errors.BzrRemoveChangedFilesError(tree_delta)
1926
# Build inv_delta and delete files where applicaple,
1927
# do this before any modifications to inventory.
1929
fid = self.path2id(f)
1932
message = "%s is not versioned." % (f,)
1935
# having removed it, it must be either ignored or unknown
1936
if self.is_ignored(f):
1940
textui.show_status(new_status, self.kind(fid), f,
1943
inv_delta.append((f, None, fid, None))
1944
message = "removed %s" % (f,)
1947
abs_path = self.abspath(f)
1948
if osutils.lexists(abs_path):
1949
if (osutils.isdir(abs_path) and
1950
len(os.listdir(abs_path)) > 0):
1952
osutils.rmtree(abs_path)
1954
message = "%s is not an empty directory "\
1955
"and won't be deleted." % (f,)
1957
osutils.delete_any(abs_path)
1958
message = "deleted %s" % (f,)
1959
elif message is not None:
1960
# Only care if we haven't done anything yet.
1961
message = "%s does not exist." % (f,)
1963
# Print only one message (if any) per file.
1964
if message is not None:
1966
self.apply_inventory_delta(inv_delta)
1968
@needs_tree_write_lock
1969
def revert(self, filenames=None, old_tree=None, backups=True,
1970
pb=DummyProgress(), report_changes=False):
1971
from bzrlib.conflicts import resolve
1974
symbol_versioning.warn('Using [] to revert all files is deprecated'
1975
' as of bzr 0.91. Please use None (the default) instead.',
1976
DeprecationWarning, stacklevel=2)
1977
if old_tree is None:
1978
basis_tree = self.basis_tree()
1979
basis_tree.lock_read()
1980
old_tree = basis_tree
1984
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1986
if filenames is None and len(self.get_parent_ids()) > 1:
1988
last_revision = self.last_revision()
1989
if last_revision != NULL_REVISION:
1990
if basis_tree is None:
1991
basis_tree = self.basis_tree()
1992
basis_tree.lock_read()
1993
parent_trees.append((last_revision, basis_tree))
1994
self.set_parent_trees(parent_trees)
1997
resolve(self, filenames, ignore_misses=True, recursive=True)
1999
if basis_tree is not None:
2003
def revision_tree(self, revision_id):
2004
"""See Tree.revision_tree.
2006
WorkingTree can supply revision_trees for the basis revision only
2007
because there is only one cached inventory in the bzr directory.
2009
if revision_id == self.last_revision():
2011
xml = self.read_basis_inventory()
2012
except errors.NoSuchFile:
2016
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2017
# dont use the repository revision_tree api because we want
2018
# to supply the inventory.
2019
if inv.revision_id == revision_id:
2020
return revisiontree.RevisionTree(self.branch.repository,
2022
except errors.BadInventoryFormat:
2024
# raise if there was no inventory, or if we read the wrong inventory.
2025
raise errors.NoSuchRevisionInTree(self, revision_id)
2027
# XXX: This method should be deprecated in favour of taking in a proper
2028
# new Inventory object.
2029
@needs_tree_write_lock
2030
def set_inventory(self, new_inventory_list):
2031
from bzrlib.inventory import (Inventory,
2036
inv = Inventory(self.get_root_id())
2037
for path, file_id, parent, kind in new_inventory_list:
2038
name = os.path.basename(path)
2041
# fixme, there should be a factory function inv,add_??
2042
if kind == 'directory':
2043
inv.add(InventoryDirectory(file_id, name, parent))
2044
elif kind == 'file':
2045
inv.add(InventoryFile(file_id, name, parent))
2046
elif kind == 'symlink':
2047
inv.add(InventoryLink(file_id, name, parent))
2049
raise errors.BzrError("unknown kind %r" % kind)
2050
self._write_inventory(inv)
2052
@needs_tree_write_lock
2053
def set_root_id(self, file_id):
2054
"""Set the root id for this tree."""
2057
symbol_versioning.warn(symbol_versioning.zero_twelve
2058
% 'WorkingTree.set_root_id with fileid=None',
2063
file_id = osutils.safe_file_id(file_id)
2064
self._set_root_id(file_id)
2066
def _set_root_id(self, file_id):
2067
"""Set the root id for this tree, in a format specific manner.
2069
:param file_id: The file id to assign to the root. It must not be
2070
present in the current inventory or an error will occur. It must
2071
not be None, but rather a valid file id.
2073
inv = self._inventory
2074
orig_root_id = inv.root.file_id
2075
# TODO: it might be nice to exit early if there was nothing
2076
# to do, saving us from trigger a sync on unlock.
2077
self._inventory_is_modified = True
2078
# we preserve the root inventory entry object, but
2079
# unlinkit from the byid index
2080
del inv._byid[inv.root.file_id]
2081
inv.root.file_id = file_id
2082
# and link it into the index with the new changed id.
2083
inv._byid[inv.root.file_id] = inv.root
2084
# and finally update all children to reference the new id.
2085
# XXX: this should be safe to just look at the root.children
2086
# list, not the WHOLE INVENTORY.
2089
if entry.parent_id == orig_root_id:
2090
entry.parent_id = inv.root.file_id
2093
"""See Branch.unlock.
2095
WorkingTree locking just uses the Branch locking facilities.
2096
This is current because all working trees have an embedded branch
2097
within them. IF in the future, we were to make branch data shareable
2098
between multiple working trees, i.e. via shared storage, then we
2099
would probably want to lock both the local tree, and the branch.
2101
raise NotImplementedError(self.unlock)
2103
def update(self, change_reporter=None, possible_transports=None):
2104
"""Update a working tree along its branch.
2106
This will update the branch if its bound too, which means we have
2107
multiple trees involved:
2109
- The new basis tree of the master.
2110
- The old basis tree of the branch.
2111
- The old basis tree of the working tree.
2112
- The current working tree state.
2114
Pathologically, all three may be different, and non-ancestors of each
2115
other. Conceptually we want to:
2117
- Preserve the wt.basis->wt.state changes
2118
- Transform the wt.basis to the new master basis.
2119
- Apply a merge of the old branch basis to get any 'local' changes from
2121
- Restore the wt.basis->wt.state changes.
2123
There isn't a single operation at the moment to do that, so we:
2124
- Merge current state -> basis tree of the master w.r.t. the old tree
2126
- Do a 'normal' merge of the old branch basis if it is relevant.
2128
if self.branch.get_master_branch(possible_transports) is not None:
2130
update_branch = True
2132
self.lock_tree_write()
2133
update_branch = False
2136
old_tip = self.branch.update(possible_transports)
2139
return self._update_tree(old_tip, change_reporter)
2143
@needs_tree_write_lock
2144
def _update_tree(self, old_tip=None, change_reporter=None):
2145
"""Update a tree to the master branch.
2147
:param old_tip: if supplied, the previous tip revision the branch,
2148
before it was changed to the master branch's tip.
2150
# here if old_tip is not None, it is the old tip of the branch before
2151
# it was updated from the master branch. This should become a pending
2152
# merge in the working tree to preserve the user existing work. we
2153
# cant set that until we update the working trees last revision to be
2154
# one from the new branch, because it will just get absorbed by the
2155
# parent de-duplication logic.
2157
# We MUST save it even if an error occurs, because otherwise the users
2158
# local work is unreferenced and will appear to have been lost.
2162
last_rev = self.get_parent_ids()[0]
2164
last_rev = _mod_revision.NULL_REVISION
2165
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2166
# merge tree state up to new branch tip.
2167
basis = self.basis_tree()
2170
to_tree = self.branch.basis_tree()
2171
if basis.inventory.root is None:
2172
self.set_root_id(to_tree.get_root_id())
2174
result += merge.merge_inner(
2179
change_reporter=change_reporter)
2182
# TODO - dedup parents list with things merged by pull ?
2183
# reuse the tree we've updated to to set the basis:
2184
parent_trees = [(self.branch.last_revision(), to_tree)]
2185
merges = self.get_parent_ids()[1:]
2186
# Ideally we ask the tree for the trees here, that way the working
2187
# tree can decide whether to give us teh entire tree or give us a
2188
# lazy initialised tree. dirstate for instance will have the trees
2189
# in ram already, whereas a last-revision + basis-inventory tree
2190
# will not, but also does not need them when setting parents.
2191
for parent in merges:
2192
parent_trees.append(
2193
(parent, self.branch.repository.revision_tree(parent)))
2194
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2195
parent_trees.append(
2196
(old_tip, self.branch.repository.revision_tree(old_tip)))
2197
self.set_parent_trees(parent_trees)
2198
last_rev = parent_trees[0][0]
2200
# the working tree had the same last-revision as the master
2201
# branch did. We may still have pivot local work from the local
2202
# branch into old_tip:
2203
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2204
self.add_parent_tree_id(old_tip)
2205
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2206
and old_tip != last_rev):
2207
# our last revision was not the prior branch last revision
2208
# and we have converted that last revision to a pending merge.
2209
# base is somewhere between the branch tip now
2210
# and the now pending merge
2212
# Since we just modified the working tree and inventory, flush out
2213
# the current state, before we modify it again.
2214
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2215
# requires it only because TreeTransform directly munges the
2216
# inventory and calls tree._write_inventory(). Ultimately we
2217
# should be able to remove this extra flush.
2219
graph = self.branch.repository.get_graph()
2220
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2222
base_tree = self.branch.repository.revision_tree(base_rev_id)
2223
other_tree = self.branch.repository.revision_tree(old_tip)
2224
result += merge.merge_inner(
2229
change_reporter=change_reporter)
2232
def _write_hashcache_if_dirty(self):
2233
"""Write out the hashcache if it is dirty."""
2234
if self._hashcache.needs_write:
2236
self._hashcache.write()
2238
if e.errno not in (errno.EPERM, errno.EACCES):
2240
# TODO: jam 20061219 Should this be a warning? A single line
2241
# warning might be sufficient to let the user know what
2243
mutter('Could not write hashcache for %s\nError: %s',
2244
self._hashcache.cache_file_name(), e)
2246
@needs_tree_write_lock
2247
def _write_inventory(self, inv):
2248
"""Write inventory as the current inventory."""
2249
self._set_inventory(inv, dirty=True)
2252
def set_conflicts(self, arg):
2253
raise errors.UnsupportedOperation(self.set_conflicts, self)
2255
def add_conflicts(self, arg):
2256
raise errors.UnsupportedOperation(self.add_conflicts, self)
2259
def conflicts(self):
2260
conflicts = _mod_conflicts.ConflictList()
2261
for conflicted in self._iter_conflicts():
2264
if file_kind(self.abspath(conflicted)) != "file":
2266
except errors.NoSuchFile:
2269
for suffix in ('.THIS', '.OTHER'):
2271
kind = file_kind(self.abspath(conflicted+suffix))
2274
except errors.NoSuchFile:
2278
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2279
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2281
file_id=self.path2id(conflicted)))
2284
def walkdirs(self, prefix=""):
2285
"""Walk the directories of this tree.
2287
returns a generator which yields items in the form:
2288
((curren_directory_path, fileid),
2289
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2292
This API returns a generator, which is only valid during the current
2293
tree transaction - within a single lock_read or lock_write duration.
2295
If the tree is not locked, it may cause an error to be raised,
2296
depending on the tree implementation.
2298
disk_top = self.abspath(prefix)
2299
if disk_top.endswith('/'):
2300
disk_top = disk_top[:-1]
2301
top_strip_len = len(disk_top) + 1
2302
inventory_iterator = self._walkdirs(prefix)
2303
disk_iterator = osutils.walkdirs(disk_top, prefix)
2305
current_disk = disk_iterator.next()
2306
disk_finished = False
2308
if not (e.errno == errno.ENOENT or
2309
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2312
disk_finished = True
2314
current_inv = inventory_iterator.next()
2315
inv_finished = False
2316
except StopIteration:
2319
while not inv_finished or not disk_finished:
2321
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2322
cur_disk_dir_content) = current_disk
2324
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2325
cur_disk_dir_content) = ((None, None), None)
2326
if not disk_finished:
2327
# strip out .bzr dirs
2328
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2329
len(cur_disk_dir_content) > 0):
2330
# osutils.walkdirs can be made nicer -
2331
# yield the path-from-prefix rather than the pathjoined
2333
bzrdir_loc = bisect_left(cur_disk_dir_content,
2335
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2336
# we dont yield the contents of, or, .bzr itself.
2337
del cur_disk_dir_content[bzrdir_loc]
2339
# everything is unknown
2342
# everything is missing
2345
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2347
# disk is before inventory - unknown
2348
dirblock = [(relpath, basename, kind, stat, None, None) for
2349
relpath, basename, kind, stat, top_path in
2350
cur_disk_dir_content]
2351
yield (cur_disk_dir_relpath, None), dirblock
2353
current_disk = disk_iterator.next()
2354
except StopIteration:
2355
disk_finished = True
2357
# inventory is before disk - missing.
2358
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2359
for relpath, basename, dkind, stat, fileid, kind in
2361
yield (current_inv[0][0], current_inv[0][1]), dirblock
2363
current_inv = inventory_iterator.next()
2364
except StopIteration:
2367
# versioned present directory
2368
# merge the inventory and disk data together
2370
for relpath, subiterator in itertools.groupby(sorted(
2371
current_inv[1] + cur_disk_dir_content,
2372
key=operator.itemgetter(0)), operator.itemgetter(1)):
2373
path_elements = list(subiterator)
2374
if len(path_elements) == 2:
2375
inv_row, disk_row = path_elements
2376
# versioned, present file
2377
dirblock.append((inv_row[0],
2378
inv_row[1], disk_row[2],
2379
disk_row[3], inv_row[4],
2381
elif len(path_elements[0]) == 5:
2383
dirblock.append((path_elements[0][0],
2384
path_elements[0][1], path_elements[0][2],
2385
path_elements[0][3], None, None))
2386
elif len(path_elements[0]) == 6:
2387
# versioned, absent file.
2388
dirblock.append((path_elements[0][0],
2389
path_elements[0][1], 'unknown', None,
2390
path_elements[0][4], path_elements[0][5]))
2392
raise NotImplementedError('unreachable code')
2393
yield current_inv[0], dirblock
2395
current_inv = inventory_iterator.next()
2396
except StopIteration:
2399
current_disk = disk_iterator.next()
2400
except StopIteration:
2401
disk_finished = True
2403
def _walkdirs(self, prefix=""):
2404
"""Walk the directories of this tree.
2406
:prefix: is used as the directrory to start with.
2407
returns a generator which yields items in the form:
2408
((curren_directory_path, fileid),
2409
[(file1_path, file1_name, file1_kind, None, file1_id,
2412
_directory = 'directory'
2413
# get the root in the inventory
2414
inv = self.inventory
2415
top_id = inv.path2id(prefix)
2419
pending = [(prefix, '', _directory, None, top_id, None)]
2422
currentdir = pending.pop()
2423
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2424
top_id = currentdir[4]
2426
relroot = currentdir[0] + '/'
2429
# FIXME: stash the node in pending
2431
for name, child in entry.sorted_children():
2432
dirblock.append((relroot + name, name, child.kind, None,
2433
child.file_id, child.kind
2435
yield (currentdir[0], entry.file_id), dirblock
2436
# push the user specified dirs from dirblock
2437
for dir in reversed(dirblock):
2438
if dir[2] == _directory:
2441
@needs_tree_write_lock
2442
def auto_resolve(self):
2443
"""Automatically resolve text conflicts according to contents.
2445
Only text conflicts are auto_resolvable. Files with no conflict markers
2446
are considered 'resolved', because bzr always puts conflict markers
2447
into files that have text conflicts. The corresponding .THIS .BASE and
2448
.OTHER files are deleted, as per 'resolve'.
2449
:return: a tuple of ConflictLists: (un_resolved, resolved).
2451
un_resolved = _mod_conflicts.ConflictList()
2452
resolved = _mod_conflicts.ConflictList()
2453
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2454
for conflict in self.conflicts():
2455
if (conflict.typestring != 'text conflict' or
2456
self.kind(conflict.file_id) != 'file'):
2457
un_resolved.append(conflict)
2459
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2461
for line in my_file:
2462
if conflict_re.search(line):
2463
un_resolved.append(conflict)
2466
resolved.append(conflict)
2469
resolved.remove_files(self)
2470
self.set_conflicts(un_resolved)
2471
return un_resolved, resolved
2473
def _validate(self):
2474
"""Validate internal structures.
2476
This is meant mostly for the test suite. To give it a chance to detect
2477
corruption after actions have occurred. The default implementation is a
2480
:return: None. An exception should be raised if there is an error.
2485
class WorkingTree2(WorkingTree):
2486
"""This is the Format 2 working tree.
2488
This was the first weave based working tree.
2489
- uses os locks for locking.
2490
- uses the branch last-revision.
2493
def __init__(self, *args, **kwargs):
2494
super(WorkingTree2, self).__init__(*args, **kwargs)
2495
# WorkingTree2 has more of a constraint that self._inventory must
2496
# exist. Because this is an older format, we don't mind the overhead
2497
# caused by the extra computation here.
2499
# Newer WorkingTree's should only have self._inventory set when they
2501
if self._inventory is None:
2502
self.read_working_inventory()
2504
def lock_tree_write(self):
2505
"""See WorkingTree.lock_tree_write().
2507
In Format2 WorkingTrees we have a single lock for the branch and tree
2508
so lock_tree_write() degrades to lock_write().
2510
self.branch.lock_write()
2512
return self._control_files.lock_write()
2514
self.branch.unlock()
2518
# do non-implementation specific cleanup
2521
# we share control files:
2522
if self._control_files._lock_count == 3:
2523
# _inventory_is_modified is always False during a read lock.
2524
if self._inventory_is_modified:
2526
self._write_hashcache_if_dirty()
2528
# reverse order of locking.
2530
return self._control_files.unlock()
2532
self.branch.unlock()
2535
class WorkingTree3(WorkingTree):
2536
"""This is the Format 3 working tree.
2538
This differs from the base WorkingTree by:
2539
- having its own file lock
2540
- having its own last-revision property.
2542
This is new in bzr 0.8
2546
def _last_revision(self):
2547
"""See Mutable.last_revision."""
2549
return self._control_files.get('last-revision').read()
2550
except errors.NoSuchFile:
2551
return _mod_revision.NULL_REVISION
2553
def _change_last_revision(self, revision_id):
2554
"""See WorkingTree._change_last_revision."""
2555
if revision_id is None or revision_id == NULL_REVISION:
2557
self._control_files._transport.delete('last-revision')
2558
except errors.NoSuchFile:
2562
self._control_files.put_bytes('last-revision', revision_id)
2565
@needs_tree_write_lock
2566
def set_conflicts(self, conflicts):
2567
self._put_rio('conflicts', conflicts.to_stanzas(),
2570
@needs_tree_write_lock
2571
def add_conflicts(self, new_conflicts):
2572
conflict_set = set(self.conflicts())
2573
conflict_set.update(set(list(new_conflicts)))
2574
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2575
key=_mod_conflicts.Conflict.sort_key)))
2578
def conflicts(self):
2580
confile = self._control_files.get('conflicts')
2581
except errors.NoSuchFile:
2582
return _mod_conflicts.ConflictList()
2584
if confile.next() != CONFLICT_HEADER_1 + '\n':
2585
raise errors.ConflictFormatError()
2586
except StopIteration:
2587
raise errors.ConflictFormatError()
2588
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2591
# do non-implementation specific cleanup
2593
if self._control_files._lock_count == 1:
2594
# _inventory_is_modified is always False during a read lock.
2595
if self._inventory_is_modified:
2597
self._write_hashcache_if_dirty()
2598
# reverse order of locking.
2600
return self._control_files.unlock()
2602
self.branch.unlock()
2605
def get_conflicted_stem(path):
2606
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2607
if path.endswith(suffix):
2608
return path[:-len(suffix)]
2611
@deprecated_function(zero_eight)
2612
def is_control_file(filename):
2613
"""See WorkingTree.is_control_filename(filename)."""
2614
## FIXME: better check
2615
filename = normpath(filename)
2616
while filename != '':
2617
head, tail = os.path.split(filename)
2618
## mutter('check %r for control file' % ((head, tail),))
2621
if filename == head:
2627
class WorkingTreeFormat(object):
2628
"""An encapsulation of the initialization and open routines for a format.
2630
Formats provide three things:
2631
* An initialization routine,
2635
Formats are placed in an dict by their format string for reference
2636
during workingtree opening. Its not required that these be instances, they
2637
can be classes themselves with class methods - it simply depends on
2638
whether state is needed for a given format or not.
2640
Once a format is deprecated, just deprecate the initialize and open
2641
methods on the format class. Do not deprecate the object, as the
2642
object will be created every time regardless.
2645
_default_format = None
2646
"""The default format used for new trees."""
2649
"""The known formats."""
2651
requires_rich_root = False
2653
upgrade_recommended = False
2656
def find_format(klass, a_bzrdir):
2657
"""Return the format for the working tree object in a_bzrdir."""
2659
transport = a_bzrdir.get_workingtree_transport(None)
2660
format_string = transport.get("format").read()
2661
return klass._formats[format_string]
2662
except errors.NoSuchFile:
2663
raise errors.NoWorkingTree(base=transport.base)
2665
raise errors.UnknownFormatError(format=format_string)
2667
def __eq__(self, other):
2668
return self.__class__ is other.__class__
2670
def __ne__(self, other):
2671
return not (self == other)
2674
def get_default_format(klass):
2675
"""Return the current default format."""
2676
return klass._default_format
2678
def get_format_string(self):
2679
"""Return the ASCII format string that identifies this format."""
2680
raise NotImplementedError(self.get_format_string)
2682
def get_format_description(self):
2683
"""Return the short description for this format."""
2684
raise NotImplementedError(self.get_format_description)
2686
def is_supported(self):
2687
"""Is this format supported?
2689
Supported formats can be initialized and opened.
2690
Unsupported formats may not support initialization or committing or
2691
some other features depending on the reason for not being supported.
2696
def register_format(klass, format):
2697
klass._formats[format.get_format_string()] = format
2700
def set_default_format(klass, format):
2701
klass._default_format = format
2704
def unregister_format(klass, format):
2705
assert klass._formats[format.get_format_string()] is format
2706
del klass._formats[format.get_format_string()]
2709
class WorkingTreeFormat2(WorkingTreeFormat):
2710
"""The second working tree format.
2712
This format modified the hash cache from the format 1 hash cache.
2715
upgrade_recommended = True
2717
def get_format_description(self):
2718
"""See WorkingTreeFormat.get_format_description()."""
2719
return "Working tree format 2"
2721
def stub_initialize_remote(self, control_files):
2722
"""As a special workaround create critical control files for a remote working tree
2724
This ensures that it can later be updated and dealt with locally,
2725
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2726
no working tree. (See bug #43064).
2730
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2732
control_files.put('inventory', sio)
2734
control_files.put_bytes('pending-merges', '')
2737
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2738
"""See WorkingTreeFormat.initialize()."""
2739
if not isinstance(a_bzrdir.transport, LocalTransport):
2740
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2741
if from_branch is not None:
2742
branch = from_branch
2744
branch = a_bzrdir.open_branch()
2745
if revision_id is None:
2746
revision_id = _mod_revision.ensure_null(branch.last_revision())
2749
branch.generate_revision_history(revision_id)
2753
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2759
basis_tree = branch.repository.revision_tree(revision_id)
2760
if basis_tree.inventory.root is not None:
2761
wt.set_root_id(basis_tree.get_root_id())
2762
# set the parent list and cache the basis tree.
2763
if _mod_revision.is_null(revision_id):
2766
parent_trees = [(revision_id, basis_tree)]
2767
wt.set_parent_trees(parent_trees)
2768
transform.build_tree(basis_tree, wt)
2772
super(WorkingTreeFormat2, self).__init__()
2773
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2775
def open(self, a_bzrdir, _found=False):
2776
"""Return the WorkingTree object for a_bzrdir
2778
_found is a private parameter, do not use it. It is used to indicate
2779
if format probing has already been done.
2782
# we are being called directly and must probe.
2783
raise NotImplementedError
2784
if not isinstance(a_bzrdir.transport, LocalTransport):
2785
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2786
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2792
class WorkingTreeFormat3(WorkingTreeFormat):
2793
"""The second working tree format updated to record a format marker.
2796
- exists within a metadir controlling .bzr
2797
- includes an explicit version marker for the workingtree control
2798
files, separate from the BzrDir format
2799
- modifies the hash cache format
2801
- uses a LockDir to guard access for writes.
2804
upgrade_recommended = True
2806
def get_format_string(self):
2807
"""See WorkingTreeFormat.get_format_string()."""
2808
return "Bazaar-NG Working Tree format 3"
2810
def get_format_description(self):
2811
"""See WorkingTreeFormat.get_format_description()."""
2812
return "Working tree format 3"
2814
_lock_file_name = 'lock'
2815
_lock_class = LockDir
2817
_tree_class = WorkingTree3
2819
def __get_matchingbzrdir(self):
2820
return bzrdir.BzrDirMetaFormat1()
2822
_matchingbzrdir = property(__get_matchingbzrdir)
2824
def _open_control_files(self, a_bzrdir):
2825
transport = a_bzrdir.get_workingtree_transport(None)
2826
return LockableFiles(transport, self._lock_file_name,
2829
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2830
"""See WorkingTreeFormat.initialize().
2832
revision_id allows creating a working tree at a different
2833
revision than the branch is at.
2835
if not isinstance(a_bzrdir.transport, LocalTransport):
2836
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2837
transport = a_bzrdir.get_workingtree_transport(self)
2838
control_files = self._open_control_files(a_bzrdir)
2839
control_files.create_lock()
2840
control_files.lock_write()
2841
control_files.put_utf8('format', self.get_format_string())
2842
if from_branch is not None:
2843
branch = from_branch
2845
branch = a_bzrdir.open_branch()
2846
if revision_id is None:
2847
revision_id = _mod_revision.ensure_null(branch.last_revision())
2848
# WorkingTree3 can handle an inventory which has a unique root id.
2849
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2850
# those trees. And because there isn't a format bump inbetween, we
2851
# are maintaining compatibility with older clients.
2852
# inv = Inventory(root_id=gen_root_id())
2853
inv = self._initial_inventory()
2854
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2860
_control_files=control_files)
2861
wt.lock_tree_write()
2863
basis_tree = branch.repository.revision_tree(revision_id)
2864
# only set an explicit root id if there is one to set.
2865
if basis_tree.inventory.root is not None:
2866
wt.set_root_id(basis_tree.get_root_id())
2867
if revision_id == NULL_REVISION:
2868
wt.set_parent_trees([])
2870
wt.set_parent_trees([(revision_id, basis_tree)])
2871
transform.build_tree(basis_tree, wt)
2873
# Unlock in this order so that the unlock-triggers-flush in
2874
# WorkingTree is given a chance to fire.
2875
control_files.unlock()
2879
def _initial_inventory(self):
2883
super(WorkingTreeFormat3, self).__init__()
2885
def open(self, a_bzrdir, _found=False):
2886
"""Return the WorkingTree object for a_bzrdir
2888
_found is a private parameter, do not use it. It is used to indicate
2889
if format probing has already been done.
2892
# we are being called directly and must probe.
2893
raise NotImplementedError
2894
if not isinstance(a_bzrdir.transport, LocalTransport):
2895
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2896
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2899
def _open(self, a_bzrdir, control_files):
2900
"""Open the tree itself.
2902
:param a_bzrdir: the dir for the tree.
2903
:param control_files: the control files for the tree.
2905
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2909
_control_files=control_files)
2912
return self.get_format_string()
2915
__default_format = WorkingTreeFormat4()
2916
WorkingTreeFormat.register_format(__default_format)
2917
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2918
WorkingTreeFormat.set_default_format(__default_format)
2919
# formats which have no format string are not discoverable
2920
# and not independently creatable, so are not registered.
2921
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
