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
self._transport = self._control_files._transport
245
# update the whole cache up front and write to disk if anything changed;
246
# in the future we might want to do this more selectively
247
# two possible ways offer themselves : in self._unlock, write the cache
248
# if needed, or, when the cache sees a change, append it to the hash
249
# cache file, and have the parser take the most recent entry for a
251
wt_trans = self.bzrdir.get_workingtree_transport(None)
252
cache_filename = wt_trans.local_abspath('stat-cache')
253
self._hashcache = hashcache.HashCache(basedir, cache_filename,
254
self._control_files._file_mode)
257
# is this scan needed ? it makes things kinda slow.
264
if _inventory is None:
265
# This will be acquired on lock_read() or lock_write()
266
self._inventory_is_modified = False
267
self._inventory = None
269
# the caller of __init__ has provided an inventory,
270
# we assume they know what they are doing - as its only
271
# the Format factory and creation methods that are
272
# permitted to do this.
273
self._set_inventory(_inventory, dirty=False)
274
self._detect_case_handling()
276
def _detect_case_handling(self):
277
wt_trans = self.bzrdir.get_workingtree_transport(None)
279
wt_trans.stat("FoRMaT")
280
except errors.NoSuchFile:
281
self.case_sensitive = True
283
self.case_sensitive = False
285
self._setup_directory_is_tree_reference()
288
fget=lambda self: self._branch,
289
doc="""The branch this WorkingTree is connected to.
291
This cannot be set - it is reflective of the actual disk structure
292
the working tree has been constructed from.
295
def break_lock(self):
296
"""Break a lock if one is present from another instance.
298
Uses the ui factory to ask for confirmation if the lock may be from
301
This will probe the repository for its lock as well.
303
self._control_files.break_lock()
304
self.branch.break_lock()
306
def requires_rich_root(self):
307
return self._format.requires_rich_root
309
def supports_tree_reference(self):
312
def _set_inventory(self, inv, dirty):
313
"""Set the internal cached inventory.
315
:param inv: The inventory to set.
316
:param dirty: A boolean indicating whether the inventory is the same
317
logical inventory as whats on disk. If True the inventory is not
318
the same and should be written to disk or data will be lost, if
319
False then the inventory is the same as that on disk and any
320
serialisation would be unneeded overhead.
322
assert inv.root is not None
323
self._inventory = inv
324
self._inventory_is_modified = dirty
327
def open(path=None, _unsupported=False):
328
"""Open an existing working tree at path.
332
path = os.path.getcwdu()
333
control = bzrdir.BzrDir.open(path, _unsupported)
334
return control.open_workingtree(_unsupported)
337
def open_containing(path=None):
338
"""Open an existing working tree which has its root about path.
340
This probes for a working tree at path and searches upwards from there.
342
Basically we keep looking up until we find the control directory or
343
run into /. If there isn't one, raises NotBranchError.
344
TODO: give this a new exception.
345
If there is one, it is returned, along with the unused portion of path.
347
:return: The WorkingTree that contains 'path', and the rest of path
350
path = osutils.getcwd()
351
control, relpath = bzrdir.BzrDir.open_containing(path)
353
return control.open_workingtree(), relpath
356
def open_downlevel(path=None):
357
"""Open an unsupported working tree.
359
Only intended for advanced situations like upgrading part of a bzrdir.
361
return WorkingTree.open(path, _unsupported=True)
364
def find_trees(location):
365
def list_current(transport):
366
return [d for d in transport.list_dir('') if d != '.bzr']
367
def evaluate(bzrdir):
369
tree = bzrdir.open_workingtree()
370
except errors.NoWorkingTree:
374
transport = get_transport(location)
375
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
376
list_current=list_current)
377
return [t for t in iterator if t is not None]
379
# should be deprecated - this is slow and in any case treating them as a
380
# container is (we now know) bad style -- mbp 20070302
381
## @deprecated_method(zero_fifteen)
383
"""Iterate through file_ids for this tree.
385
file_ids are in a WorkingTree if they are in the working inventory
386
and the working file exists.
388
inv = self._inventory
389
for path, ie in inv.iter_entries():
390
if osutils.lexists(self.abspath(path)):
393
def all_file_ids(self):
394
"""See Tree.iter_all_file_ids"""
395
return set(self.inventory)
398
return "<%s of %s>" % (self.__class__.__name__,
399
getattr(self, 'basedir', None))
401
def abspath(self, filename):
402
return pathjoin(self.basedir, filename)
404
def basis_tree(self):
405
"""Return RevisionTree for the current last revision.
407
If the left most parent is a ghost then the returned tree will be an
408
empty tree - one obtained by calling repository.revision_tree(None).
411
revision_id = self.get_parent_ids()[0]
413
# no parents, return an empty revision tree.
414
# in the future this should return the tree for
415
# 'empty:' - the implicit root empty tree.
416
return self.branch.repository.revision_tree(None)
418
return self.revision_tree(revision_id)
419
except errors.NoSuchRevision:
421
# No cached copy available, retrieve from the repository.
422
# FIXME? RBC 20060403 should we cache the inventory locally
425
return self.branch.repository.revision_tree(revision_id)
426
except errors.RevisionNotPresent:
427
# the basis tree *may* be a ghost or a low level error may have
428
# occured. If the revision is present, its a problem, if its not
430
if self.branch.repository.has_revision(revision_id):
432
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(None)
436
self._flush_ignore_list_cache()
439
@deprecated_method(zero_eight)
440
def create(branch, directory):
441
"""Create a workingtree for branch at directory.
443
If existing_directory already exists it must have a .bzr directory.
444
If it does not exist, it will be created.
446
This returns a new WorkingTree object for the new checkout.
448
TODO FIXME RBC 20060124 when we have checkout formats in place this
449
should accept an optional revisionid to checkout [and reject this if
450
checking out into the same dir as a pre-checkout-aware branch format.]
452
XXX: When BzrDir is present, these should be created through that
455
warnings.warn('delete WorkingTree.create', stacklevel=3)
456
transport = get_transport(directory)
457
if branch.bzrdir.root_transport.base == transport.base:
459
return branch.bzrdir.create_workingtree()
460
# different directory,
461
# create a branch reference
462
# and now a working tree.
463
raise NotImplementedError
466
@deprecated_method(zero_eight)
467
def create_standalone(directory):
468
"""Create a checkout and a branch and a repo at directory.
470
Directory must exist and be empty.
472
please use BzrDir.create_standalone_workingtree
474
return bzrdir.BzrDir.create_standalone_workingtree(directory)
476
def relpath(self, path):
477
"""Return the local path portion from a given path.
479
The path may be absolute or relative. If its a relative path it is
480
interpreted relative to the python current working directory.
482
return osutils.relpath(self.basedir, path)
484
def has_filename(self, filename):
485
return osutils.lexists(self.abspath(filename))
487
def get_file(self, file_id, path=None):
489
path = self.id2path(file_id)
490
return self.get_file_byname(path)
492
def get_file_text(self, file_id):
493
return self.get_file(file_id).read()
495
def get_file_byname(self, filename):
496
return file(self.abspath(filename), 'rb')
499
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
500
"""See Tree.annotate_iter
502
This implementation will use the basis tree implementation if possible.
503
Lines not in the basis are attributed to CURRENT_REVISION
505
If there are pending merges, lines added by those merges will be
506
incorrectly attributed to CURRENT_REVISION (but after committing, the
507
attribution will be correct).
509
basis = self.basis_tree()
512
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
513
require_versioned=True).next()
514
changed_content, kind = changes[2], changes[6]
515
if not changed_content:
516
return basis.annotate_iter(file_id)
520
if kind[0] != 'file':
523
old_lines = list(basis.annotate_iter(file_id))
525
for tree in self.branch.repository.revision_trees(
526
self.get_parent_ids()[1:]):
527
if file_id not in tree:
529
old.append(list(tree.annotate_iter(file_id)))
530
return annotate.reannotate(old, self.get_file(file_id).readlines(),
535
def _get_ancestors(self, default_revision):
536
ancestors = set([default_revision])
537
for parent_id in self.get_parent_ids():
538
ancestors.update(self.branch.repository.get_ancestry(
539
parent_id, topo_sorted=False))
542
def get_parent_ids(self):
543
"""See Tree.get_parent_ids.
545
This implementation reads the pending merges list and last_revision
546
value and uses that to decide what the parents list should be.
548
last_rev = _mod_revision.ensure_null(self._last_revision())
549
if _mod_revision.NULL_REVISION == last_rev:
554
merges_file = self._control_files._transport.get('pending-merges')
555
except errors.NoSuchFile:
558
for l in merges_file.readlines():
559
revision_id = l.rstrip('\n')
560
parents.append(revision_id)
564
def get_root_id(self):
565
"""Return the id of this trees root"""
566
return self._inventory.root.file_id
568
def _get_store_filename(self, file_id):
569
## XXX: badly named; this is not in the store at all
570
return self.abspath(self.id2path(file_id))
573
def clone(self, to_bzrdir, revision_id=None):
574
"""Duplicate this working tree into to_bzr, including all state.
576
Specifically modified files are kept as modified, but
577
ignored and unknown files are discarded.
579
If you want to make a new line of development, see bzrdir.sprout()
582
If not None, the cloned tree will have its last revision set to
583
revision, and and difference between the source trees last revision
584
and this one merged in.
586
# assumes the target bzr dir format is compatible.
587
result = self._format.initialize(to_bzrdir)
588
self.copy_content_into(result, revision_id)
592
def copy_content_into(self, tree, revision_id=None):
593
"""Copy the current content and user files of this tree into tree."""
594
tree.set_root_id(self.get_root_id())
595
if revision_id is None:
596
merge.transform_tree(tree, self)
598
# TODO now merge from tree.last_revision to revision (to preserve
599
# user local changes)
600
merge.transform_tree(tree, self)
601
tree.set_parent_ids([revision_id])
603
def id2abspath(self, file_id):
604
return self.abspath(self.id2path(file_id))
606
def has_id(self, file_id):
607
# files that have been deleted are excluded
609
if not inv.has_id(file_id):
611
path = inv.id2path(file_id)
612
return osutils.lexists(self.abspath(path))
614
def has_or_had_id(self, file_id):
615
if file_id == self.inventory.root.file_id:
617
return self.inventory.has_id(file_id)
619
__contains__ = has_id
621
def get_file_size(self, file_id):
622
"""See Tree.get_file_size"""
624
return os.path.getsize(self.id2abspath(file_id))
626
if e.errno != errno.ENOENT:
632
def get_file_sha1(self, file_id, path=None, stat_value=None):
634
path = self._inventory.id2path(file_id)
635
return self._hashcache.get_sha1(path, stat_value)
637
def get_file_mtime(self, file_id, path=None):
639
path = self.inventory.id2path(file_id)
640
return os.lstat(self.abspath(path)).st_mtime
642
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
file_id = self.path2id(path)
644
return self._inventory[file_id].executable
646
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
647
mode = stat_result.st_mode
648
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
650
if not supports_executable():
651
def is_executable(self, file_id, path=None):
652
return self._inventory[file_id].executable
654
_is_executable_from_path_and_stat = \
655
_is_executable_from_path_and_stat_from_basis
657
def is_executable(self, file_id, path=None):
659
path = self.id2path(file_id)
660
mode = os.lstat(self.abspath(path)).st_mode
661
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
663
_is_executable_from_path_and_stat = \
664
_is_executable_from_path_and_stat_from_stat
666
@needs_tree_write_lock
667
def _add(self, files, ids, kinds):
668
"""See MutableTree._add."""
669
# TODO: Re-adding a file that is removed in the working copy
670
# should probably put it back with the previous ID.
671
# the read and write working inventory should not occur in this
672
# function - they should be part of lock_write and unlock.
674
for f, file_id, kind in zip(files, ids, kinds):
675
assert kind is not None
677
inv.add_path(f, kind=kind)
679
inv.add_path(f, kind=kind, file_id=file_id)
680
self._inventory_is_modified = True
682
@needs_tree_write_lock
683
def _gather_kinds(self, files, kinds):
684
"""See MutableTree._gather_kinds."""
685
for pos, f in enumerate(files):
686
if kinds[pos] is None:
687
fullpath = normpath(self.abspath(f))
689
kinds[pos] = file_kind(fullpath)
691
if e.errno == errno.ENOENT:
692
raise errors.NoSuchFile(fullpath)
695
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
696
"""Add revision_id as a parent.
698
This is equivalent to retrieving the current list of parent ids
699
and setting the list to its value plus revision_id.
701
:param revision_id: The revision id to add to the parent list. It may
702
be a ghost revision as long as its not the first parent to be added,
703
or the allow_leftmost_as_ghost parameter is set True.
704
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
706
parents = self.get_parent_ids() + [revision_id]
707
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
708
or allow_leftmost_as_ghost)
710
@needs_tree_write_lock
711
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
712
"""Add revision_id, tree tuple as a parent.
714
This is equivalent to retrieving the current list of parent trees
715
and setting the list to its value plus parent_tuple. See also
716
add_parent_tree_id - if you only have a parent id available it will be
717
simpler to use that api. If you have the parent already available, using
718
this api is preferred.
720
:param parent_tuple: The (revision id, tree) to add to the parent list.
721
If the revision_id is a ghost, pass None for the tree.
722
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
724
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
725
if len(parent_ids) > 1:
726
# the leftmost may have already been a ghost, preserve that if it
728
allow_leftmost_as_ghost = True
729
self.set_parent_ids(parent_ids,
730
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
732
@needs_tree_write_lock
733
def add_pending_merge(self, *revision_ids):
734
# TODO: Perhaps should check at this point that the
735
# history of the revision is actually present?
736
parents = self.get_parent_ids()
738
for rev_id in revision_ids:
739
if rev_id in parents:
741
parents.append(rev_id)
744
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
746
def path_content_summary(self, path, _lstat=os.lstat,
747
_mapper=osutils.file_kind_from_stat_mode):
748
"""See Tree.path_content_summary."""
749
abspath = self.abspath(path)
751
stat_result = _lstat(abspath)
753
if getattr(e, 'errno', None) == errno.ENOENT:
755
return ('missing', None, None, None)
756
# propagate other errors
758
kind = _mapper(stat_result.st_mode)
760
size = stat_result.st_size
761
# try for a stat cache lookup
762
executable = self._is_executable_from_path_and_stat(path, stat_result)
763
return (kind, size, executable, self._sha_from_stat(
765
elif kind == 'directory':
766
# perhaps it looks like a plain directory, but it's really a
768
if self._directory_is_tree_reference(path):
769
kind = 'tree-reference'
770
return kind, None, None, None
771
elif kind == 'symlink':
772
return ('symlink', None, None, os.readlink(abspath))
774
return (kind, None, None, None)
776
@deprecated_method(zero_eleven)
778
def pending_merges(self):
779
"""Return a list of pending merges.
781
These are revisions that have been merged into the working
782
directory but not yet committed.
784
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
785
instead - which is available on all tree objects.
787
return self.get_parent_ids()[1:]
789
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
790
"""Common ghost checking functionality from set_parent_*.
792
This checks that the left hand-parent exists if there are any
795
if len(revision_ids) > 0:
796
leftmost_id = revision_ids[0]
797
if (not allow_leftmost_as_ghost and not
798
self.branch.repository.has_revision(leftmost_id)):
799
raise errors.GhostRevisionUnusableHere(leftmost_id)
801
def _set_merges_from_parent_ids(self, parent_ids):
802
merges = parent_ids[1:]
803
self._transport.put_bytes('pending-merges', '\n'.join(merges),
804
mode=self._control_files._file_mode)
806
@needs_tree_write_lock
807
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
808
"""Set the parent ids to revision_ids.
810
See also set_parent_trees. This api will try to retrieve the tree data
811
for each element of revision_ids from the trees repository. If you have
812
tree data already available, it is more efficient to use
813
set_parent_trees rather than set_parent_ids. set_parent_ids is however
814
an easier API to use.
816
:param revision_ids: The revision_ids to set as the parent ids of this
817
working tree. Any of these may be ghosts.
819
self._check_parents_for_ghosts(revision_ids,
820
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
821
for revision_id in revision_ids:
822
_mod_revision.check_not_reserved_id(revision_id)
824
if len(revision_ids) > 0:
825
self.set_last_revision(revision_ids[0])
827
self.set_last_revision(_mod_revision.NULL_REVISION)
829
self._set_merges_from_parent_ids(revision_ids)
831
@needs_tree_write_lock
832
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
833
"""See MutableTree.set_parent_trees."""
834
parent_ids = [rev for (rev, tree) in parents_list]
835
for revision_id in parent_ids:
836
_mod_revision.check_not_reserved_id(revision_id)
838
self._check_parents_for_ghosts(parent_ids,
839
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
841
if len(parent_ids) == 0:
842
leftmost_parent_id = _mod_revision.NULL_REVISION
843
leftmost_parent_tree = None
845
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
847
if self._change_last_revision(leftmost_parent_id):
848
if leftmost_parent_tree is None:
849
# If we don't have a tree, fall back to reading the
850
# parent tree from the repository.
851
self._cache_basis_inventory(leftmost_parent_id)
853
inv = leftmost_parent_tree.inventory
854
xml = self._create_basis_xml_from_inventory(
855
leftmost_parent_id, inv)
856
self._write_basis_inventory(xml)
857
self._set_merges_from_parent_ids(parent_ids)
859
@needs_tree_write_lock
860
def set_pending_merges(self, rev_list):
861
parents = self.get_parent_ids()
862
leftmost = parents[:1]
863
new_parents = leftmost + rev_list
864
self.set_parent_ids(new_parents)
866
@needs_tree_write_lock
867
def set_merge_modified(self, modified_hashes):
869
for file_id, hash in modified_hashes.iteritems():
870
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
871
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
873
def _sha_from_stat(self, path, stat_result):
874
"""Get a sha digest from the tree's stat cache.
876
The default implementation assumes no stat cache is present.
878
:param path: The path.
879
:param stat_result: The stat result being looked up.
883
def _put_rio(self, filename, stanzas, header):
884
self._must_be_locked()
885
my_file = rio_file(stanzas, header)
886
self._transport.put_file(filename, my_file,
887
mode=self._control_files._file_mode)
889
@needs_write_lock # because merge pulls data into the branch.
890
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
892
"""Merge from a branch into this working tree.
894
:param branch: The branch to merge from.
895
:param to_revision: If non-None, the merge will merge to to_revision,
896
but not beyond it. to_revision does not need to be in the history
897
of the branch when it is supplied. If None, to_revision defaults to
898
branch.last_revision().
900
from bzrlib.merge import Merger, Merge3Merger
901
pb = bzrlib.ui.ui_factory.nested_progress_bar()
903
merger = Merger(self.branch, this_tree=self, pb=pb)
904
merger.pp = ProgressPhase("Merge phase", 5, pb)
905
merger.pp.next_phase()
906
# check that there are no
908
merger.check_basis(check_clean=True, require_commits=False)
909
if to_revision is None:
910
to_revision = _mod_revision.ensure_null(branch.last_revision())
911
merger.other_rev_id = to_revision
912
if _mod_revision.is_null(merger.other_rev_id):
913
raise errors.NoCommits(branch)
914
self.branch.fetch(branch, last_revision=merger.other_rev_id)
915
merger.other_basis = merger.other_rev_id
916
merger.other_tree = self.branch.repository.revision_tree(
918
merger.other_branch = branch
919
merger.pp.next_phase()
920
if from_revision is None:
923
merger.set_base_revision(from_revision, branch)
924
if merger.base_rev_id == merger.other_rev_id:
925
raise errors.PointlessMerge
926
merger.backup_files = False
927
if merge_type is None:
928
merger.merge_type = Merge3Merger
930
merger.merge_type = merge_type
931
merger.set_interesting_files(None)
932
merger.show_base = False
933
merger.reprocess = False
934
conflicts = merger.do_merge()
941
def merge_modified(self):
942
"""Return a dictionary of files modified by a merge.
944
The list is initialized by WorkingTree.set_merge_modified, which is
945
typically called after we make some automatic updates to the tree
948
This returns a map of file_id->sha1, containing only files which are
949
still in the working inventory and have that text hash.
952
hashfile = self._control_files._transport.get('merge-hashes')
953
except errors.NoSuchFile:
957
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
958
raise errors.MergeModifiedFormatError()
959
except StopIteration:
960
raise errors.MergeModifiedFormatError()
961
for s in RioReader(hashfile):
962
# RioReader reads in Unicode, so convert file_ids back to utf8
963
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
964
if file_id not in self.inventory:
966
text_hash = s.get("hash")
967
if text_hash == self.get_file_sha1(file_id):
968
merge_hashes[file_id] = text_hash
972
def mkdir(self, path, file_id=None):
973
"""See MutableTree.mkdir()."""
975
file_id = generate_ids.gen_file_id(os.path.basename(path))
976
os.mkdir(self.abspath(path))
977
self.add(path, file_id, 'directory')
980
def get_symlink_target(self, file_id):
981
return os.readlink(self.id2abspath(file_id))
984
def subsume(self, other_tree):
985
def add_children(inventory, entry):
986
for child_entry in entry.children.values():
987
inventory._byid[child_entry.file_id] = child_entry
988
if child_entry.kind == 'directory':
989
add_children(inventory, child_entry)
990
if other_tree.get_root_id() == self.get_root_id():
991
raise errors.BadSubsumeSource(self, other_tree,
992
'Trees have the same root')
994
other_tree_path = self.relpath(other_tree.basedir)
995
except errors.PathNotChild:
996
raise errors.BadSubsumeSource(self, other_tree,
997
'Tree is not contained by the other')
998
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
999
if new_root_parent is None:
1000
raise errors.BadSubsumeSource(self, other_tree,
1001
'Parent directory is not versioned.')
1002
# We need to ensure that the result of a fetch will have a
1003
# versionedfile for the other_tree root, and only fetching into
1004
# RepositoryKnit2 guarantees that.
1005
if not self.branch.repository.supports_rich_root():
1006
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1007
other_tree.lock_tree_write()
1009
new_parents = other_tree.get_parent_ids()
1010
other_root = other_tree.inventory.root
1011
other_root.parent_id = new_root_parent
1012
other_root.name = osutils.basename(other_tree_path)
1013
self.inventory.add(other_root)
1014
add_children(self.inventory, other_root)
1015
self._write_inventory(self.inventory)
1016
# normally we don't want to fetch whole repositories, but i think
1017
# here we really do want to consolidate the whole thing.
1018
for parent_id in other_tree.get_parent_ids():
1019
self.branch.fetch(other_tree.branch, parent_id)
1020
self.add_parent_tree_id(parent_id)
1023
other_tree.bzrdir.retire_bzrdir()
1025
def _setup_directory_is_tree_reference(self):
1026
if self._branch.repository._format.supports_tree_reference:
1027
self._directory_is_tree_reference = \
1028
self._directory_may_be_tree_reference
1030
self._directory_is_tree_reference = \
1031
self._directory_is_never_tree_reference
1033
def _directory_is_never_tree_reference(self, relpath):
1036
def _directory_may_be_tree_reference(self, relpath):
1037
# as a special case, if a directory contains control files then
1038
# it's a tree reference, except that the root of the tree is not
1039
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1040
# TODO: We could ask all the control formats whether they
1041
# recognize this directory, but at the moment there's no cheap api
1042
# to do that. Since we probably can only nest bzr checkouts and
1043
# they always use this name it's ok for now. -- mbp 20060306
1045
# FIXME: There is an unhandled case here of a subdirectory
1046
# containing .bzr but not a branch; that will probably blow up
1047
# when you try to commit it. It might happen if there is a
1048
# checkout in a subdirectory. This can be avoided by not adding
1051
@needs_tree_write_lock
1052
def extract(self, file_id, format=None):
1053
"""Extract a subtree from this tree.
1055
A new branch will be created, relative to the path for this tree.
1059
segments = osutils.splitpath(path)
1060
transport = self.branch.bzrdir.root_transport
1061
for name in segments:
1062
transport = transport.clone(name)
1063
transport.ensure_base()
1066
sub_path = self.id2path(file_id)
1067
branch_transport = mkdirs(sub_path)
1069
format = self.bzrdir.cloning_metadir()
1070
branch_transport.ensure_base()
1071
branch_bzrdir = format.initialize_on_transport(branch_transport)
1073
repo = branch_bzrdir.find_repository()
1074
except errors.NoRepositoryPresent:
1075
repo = branch_bzrdir.create_repository()
1076
if not repo.supports_rich_root():
1077
raise errors.RootNotRich()
1078
new_branch = branch_bzrdir.create_branch()
1079
new_branch.pull(self.branch)
1080
for parent_id in self.get_parent_ids():
1081
new_branch.fetch(self.branch, parent_id)
1082
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1083
if tree_transport.base != branch_transport.base:
1084
tree_bzrdir = format.initialize_on_transport(tree_transport)
1085
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1087
tree_bzrdir = branch_bzrdir
1088
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1089
wt.set_parent_ids(self.get_parent_ids())
1090
my_inv = self.inventory
1091
child_inv = Inventory(root_id=None)
1092
new_root = my_inv[file_id]
1093
my_inv.remove_recursive_id(file_id)
1094
new_root.parent_id = None
1095
child_inv.add(new_root)
1096
self._write_inventory(my_inv)
1097
wt._write_inventory(child_inv)
1100
def _serialize(self, inventory, out_file):
1101
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1104
def _deserialize(selt, in_file):
1105
return xml5.serializer_v5.read_inventory(in_file)
1108
"""Write the in memory inventory to disk."""
1109
# TODO: Maybe this should only write on dirty ?
1110
if self._control_files._lock_mode != 'w':
1111
raise errors.NotWriteLocked(self)
1113
self._serialize(self._inventory, sio)
1115
self._transport.put_file('inventory', sio,
1116
mode=self._control_files._file_mode)
1117
self._inventory_is_modified = False
1119
def _kind(self, relpath):
1120
return osutils.file_kind(self.abspath(relpath))
1122
def list_files(self, include_root=False):
1123
"""Recursively list all files as (path, class, kind, id, entry).
1125
Lists, but does not descend into unversioned directories.
1127
This does not include files that have been deleted in this
1130
Skips the control directory.
1132
# list_files is an iterator, so @needs_read_lock doesn't work properly
1133
# with it. So callers should be careful to always read_lock the tree.
1134
if not self.is_locked():
1135
raise errors.ObjectNotLocked(self)
1137
inv = self.inventory
1138
if include_root is True:
1139
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1140
# Convert these into local objects to save lookup times
1141
pathjoin = osutils.pathjoin
1142
file_kind = self._kind
1144
# transport.base ends in a slash, we want the piece
1145
# between the last two slashes
1146
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1148
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1150
# directory file_id, relative path, absolute path, reverse sorted children
1151
children = os.listdir(self.basedir)
1153
# jam 20060527 The kernel sized tree seems equivalent whether we
1154
# use a deque and popleft to keep them sorted, or if we use a plain
1155
# list and just reverse() them.
1156
children = collections.deque(children)
1157
stack = [(inv.root.file_id, u'', self.basedir, children)]
1159
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1162
f = children.popleft()
1163
## TODO: If we find a subdirectory with its own .bzr
1164
## directory, then that is a separate tree and we
1165
## should exclude it.
1167
# the bzrdir for this tree
1168
if transport_base_dir == f:
1171
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1172
# and 'f' doesn't begin with one, we can do a string op, rather
1173
# than the checks of pathjoin(), all relative paths will have an extra slash
1175
fp = from_dir_relpath + '/' + f
1178
fap = from_dir_abspath + '/' + f
1180
f_ie = inv.get_child(from_dir_id, f)
1183
elif self.is_ignored(fp[1:]):
1186
# we may not have found this file, because of a unicode issue
1187
f_norm, can_access = osutils.normalized_filename(f)
1188
if f == f_norm or not can_access:
1189
# No change, so treat this file normally
1192
# this file can be accessed by a normalized path
1193
# check again if it is versioned
1194
# these lines are repeated here for performance
1196
fp = from_dir_relpath + '/' + f
1197
fap = from_dir_abspath + '/' + f
1198
f_ie = inv.get_child(from_dir_id, f)
1201
elif self.is_ignored(fp[1:]):
1208
# make a last minute entry
1210
yield fp[1:], c, fk, f_ie.file_id, f_ie
1213
yield fp[1:], c, fk, None, fk_entries[fk]()
1215
yield fp[1:], c, fk, None, TreeEntry()
1218
if fk != 'directory':
1221
# But do this child first
1222
new_children = os.listdir(fap)
1224
new_children = collections.deque(new_children)
1225
stack.append((f_ie.file_id, fp, fap, new_children))
1226
# Break out of inner loop,
1227
# so that we start outer loop with child
1230
# if we finished all children, pop it off the stack
1233
@needs_tree_write_lock
1234
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1237
to_dir must exist in the inventory.
1239
If to_dir exists and is a directory, the files are moved into
1240
it, keeping their old names.
1242
Note that to_dir is only the last component of the new name;
1243
this doesn't change the directory.
1245
For each entry in from_paths the move mode will be determined
1248
The first mode moves the file in the filesystem and updates the
1249
inventory. The second mode only updates the inventory without
1250
touching the file on the filesystem. This is the new mode introduced
1253
move uses the second mode if 'after == True' and the target is not
1254
versioned but present in the working tree.
1256
move uses the second mode if 'after == False' and the source is
1257
versioned but no longer in the working tree, and the target is not
1258
versioned but present in the working tree.
1260
move uses the first mode if 'after == False' and the source is
1261
versioned and present in the working tree, and the target is not
1262
versioned and not present in the working tree.
1264
Everything else results in an error.
1266
This returns a list of (from_path, to_path) pairs for each
1267
entry that is moved.
1272
# check for deprecated use of signature
1274
to_dir = kwargs.get('to_name', None)
1276
raise TypeError('You must supply a target directory')
1278
symbol_versioning.warn('The parameter to_name was deprecated'
1279
' in version 0.13. Use to_dir instead',
1282
# check destination directory
1283
assert not isinstance(from_paths, basestring)
1284
inv = self.inventory
1285
to_abs = self.abspath(to_dir)
1286
if not isdir(to_abs):
1287
raise errors.BzrMoveFailedError('',to_dir,
1288
errors.NotADirectory(to_abs))
1289
if not self.has_filename(to_dir):
1290
raise errors.BzrMoveFailedError('',to_dir,
1291
errors.NotInWorkingDirectory(to_dir))
1292
to_dir_id = inv.path2id(to_dir)
1293
if to_dir_id is None:
1294
raise errors.BzrMoveFailedError('',to_dir,
1295
errors.NotVersionedError(path=str(to_dir)))
1297
to_dir_ie = inv[to_dir_id]
1298
if to_dir_ie.kind != 'directory':
1299
raise errors.BzrMoveFailedError('',to_dir,
1300
errors.NotADirectory(to_abs))
1302
# create rename entries and tuples
1303
for from_rel in from_paths:
1304
from_tail = splitpath(from_rel)[-1]
1305
from_id = inv.path2id(from_rel)
1307
raise errors.BzrMoveFailedError(from_rel,to_dir,
1308
errors.NotVersionedError(path=str(from_rel)))
1310
from_entry = inv[from_id]
1311
from_parent_id = from_entry.parent_id
1312
to_rel = pathjoin(to_dir, from_tail)
1313
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1315
from_tail=from_tail,
1316
from_parent_id=from_parent_id,
1317
to_rel=to_rel, to_tail=from_tail,
1318
to_parent_id=to_dir_id)
1319
rename_entries.append(rename_entry)
1320
rename_tuples.append((from_rel, to_rel))
1322
# determine which move mode to use. checks also for movability
1323
rename_entries = self._determine_mv_mode(rename_entries, after)
1325
original_modified = self._inventory_is_modified
1328
self._inventory_is_modified = True
1329
self._move(rename_entries)
1331
# restore the inventory on error
1332
self._inventory_is_modified = original_modified
1334
self._write_inventory(inv)
1335
return rename_tuples
1337
def _determine_mv_mode(self, rename_entries, after=False):
1338
"""Determines for each from-to pair if both inventory and working tree
1339
or only the inventory has to be changed.
1341
Also does basic plausability tests.
1343
inv = self.inventory
1345
for rename_entry in rename_entries:
1346
# store to local variables for easier reference
1347
from_rel = rename_entry.from_rel
1348
from_id = rename_entry.from_id
1349
to_rel = rename_entry.to_rel
1350
to_id = inv.path2id(to_rel)
1351
only_change_inv = False
1353
# check the inventory for source and destination
1355
raise errors.BzrMoveFailedError(from_rel,to_rel,
1356
errors.NotVersionedError(path=str(from_rel)))
1357
if to_id is not None:
1358
raise errors.BzrMoveFailedError(from_rel,to_rel,
1359
errors.AlreadyVersionedError(path=str(to_rel)))
1361
# try to determine the mode for rename (only change inv or change
1362
# inv and file system)
1364
if not self.has_filename(to_rel):
1365
raise errors.BzrMoveFailedError(from_id,to_rel,
1366
errors.NoSuchFile(path=str(to_rel),
1367
extra="New file has not been created yet"))
1368
only_change_inv = True
1369
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1370
only_change_inv = True
1371
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1372
only_change_inv = False
1373
elif (sys.platform == 'win32'
1374
and from_rel.lower() == to_rel.lower()
1375
and self.has_filename(from_rel)):
1376
only_change_inv = False
1378
# something is wrong, so lets determine what exactly
1379
if not self.has_filename(from_rel) and \
1380
not self.has_filename(to_rel):
1381
raise errors.BzrRenameFailedError(from_rel,to_rel,
1382
errors.PathsDoNotExist(paths=(str(from_rel),
1385
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1386
rename_entry.only_change_inv = only_change_inv
1387
return rename_entries
1389
def _move(self, rename_entries):
1390
"""Moves a list of files.
1392
Depending on the value of the flag 'only_change_inv', the
1393
file will be moved on the file system or not.
1395
inv = self.inventory
1398
for entry in rename_entries:
1400
self._move_entry(entry)
1402
self._rollback_move(moved)
1406
def _rollback_move(self, moved):
1407
"""Try to rollback a previous move in case of an filesystem error."""
1408
inv = self.inventory
1411
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1412
entry.to_tail, entry.to_parent_id, entry.from_rel,
1413
entry.from_tail, entry.from_parent_id,
1414
entry.only_change_inv))
1415
except errors.BzrMoveFailedError, e:
1416
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1417
" The working tree is in an inconsistent state."
1418
" Please consider doing a 'bzr revert'."
1419
" Error message is: %s" % e)
1421
def _move_entry(self, entry):
1422
inv = self.inventory
1423
from_rel_abs = self.abspath(entry.from_rel)
1424
to_rel_abs = self.abspath(entry.to_rel)
1425
if from_rel_abs == to_rel_abs:
1426
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1427
"Source and target are identical.")
1429
if not entry.only_change_inv:
1431
osutils.rename(from_rel_abs, to_rel_abs)
1433
raise errors.BzrMoveFailedError(entry.from_rel,
1435
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1437
@needs_tree_write_lock
1438
def rename_one(self, from_rel, to_rel, after=False):
1441
This can change the directory or the filename or both.
1443
rename_one has several 'modes' to work. First, it can rename a physical
1444
file and change the file_id. That is the normal mode. Second, it can
1445
only change the file_id without touching any physical file. This is
1446
the new mode introduced in version 0.15.
1448
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1449
versioned but present in the working tree.
1451
rename_one uses the second mode if 'after == False' and 'from_rel' is
1452
versioned but no longer in the working tree, and 'to_rel' is not
1453
versioned but present in the working tree.
1455
rename_one uses the first mode if 'after == False' and 'from_rel' is
1456
versioned and present in the working tree, and 'to_rel' is not
1457
versioned and not present in the working tree.
1459
Everything else results in an error.
1461
inv = self.inventory
1464
# create rename entries and tuples
1465
from_tail = splitpath(from_rel)[-1]
1466
from_id = inv.path2id(from_rel)
1468
raise errors.BzrRenameFailedError(from_rel,to_rel,
1469
errors.NotVersionedError(path=str(from_rel)))
1470
from_entry = inv[from_id]
1471
from_parent_id = from_entry.parent_id
1472
to_dir, to_tail = os.path.split(to_rel)
1473
to_dir_id = inv.path2id(to_dir)
1474
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1476
from_tail=from_tail,
1477
from_parent_id=from_parent_id,
1478
to_rel=to_rel, to_tail=to_tail,
1479
to_parent_id=to_dir_id)
1480
rename_entries.append(rename_entry)
1482
# determine which move mode to use. checks also for movability
1483
rename_entries = self._determine_mv_mode(rename_entries, after)
1485
# check if the target changed directory and if the target directory is
1487
if to_dir_id is None:
1488
raise errors.BzrMoveFailedError(from_rel,to_rel,
1489
errors.NotVersionedError(path=str(to_dir)))
1491
# all checks done. now we can continue with our actual work
1492
mutter('rename_one:\n'
1497
' to_dir_id {%s}\n',
1498
from_id, from_rel, to_rel, to_dir, to_dir_id)
1500
self._move(rename_entries)
1501
self._write_inventory(inv)
1503
class _RenameEntry(object):
1504
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1505
to_rel, to_tail, to_parent_id, only_change_inv=False):
1506
self.from_rel = from_rel
1507
self.from_id = from_id
1508
self.from_tail = from_tail
1509
self.from_parent_id = from_parent_id
1510
self.to_rel = to_rel
1511
self.to_tail = to_tail
1512
self.to_parent_id = to_parent_id
1513
self.only_change_inv = only_change_inv
1517
"""Return all unknown files.
1519
These are files in the working directory that are not versioned or
1520
control files or ignored.
1522
# force the extras method to be fully executed before returning, to
1523
# prevent race conditions with the lock
1525
[subp for subp in self.extras() if not self.is_ignored(subp)])
1527
@needs_tree_write_lock
1528
def unversion(self, file_ids):
1529
"""Remove the file ids in file_ids from the current versioned set.
1531
When a file_id is unversioned, all of its children are automatically
1534
:param file_ids: The file ids to stop versioning.
1535
:raises: NoSuchId if any fileid is not currently versioned.
1537
for file_id in file_ids:
1538
if self._inventory.has_id(file_id):
1539
self._inventory.remove_recursive_id(file_id)
1541
raise errors.NoSuchId(self, file_id)
1543
# in the future this should just set a dirty bit to wait for the
1544
# final unlock. However, until all methods of workingtree start
1545
# with the current in -memory inventory rather than triggering
1546
# a read, it is more complex - we need to teach read_inventory
1547
# to know when to read, and when to not read first... and possibly
1548
# to save first when the in memory one may be corrupted.
1549
# so for now, we just only write it if it is indeed dirty.
1551
self._write_inventory(self._inventory)
1553
@deprecated_method(zero_eight)
1554
def iter_conflicts(self):
1555
"""List all files in the tree that have text or content conflicts.
1556
DEPRECATED. Use conflicts instead."""
1557
return self._iter_conflicts()
1559
def _iter_conflicts(self):
1561
for info in self.list_files():
1563
stem = get_conflicted_stem(path)
1566
if stem not in conflicted:
1567
conflicted.add(stem)
1571
def pull(self, source, overwrite=False, stop_revision=None,
1572
change_reporter=None, possible_transports=None):
1573
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1576
pp = ProgressPhase("Pull phase", 2, top_pb)
1578
old_revision_info = self.branch.last_revision_info()
1579
basis_tree = self.basis_tree()
1580
count = self.branch.pull(source, overwrite, stop_revision,
1581
possible_transports=possible_transports)
1582
new_revision_info = self.branch.last_revision_info()
1583
if new_revision_info != old_revision_info:
1585
repository = self.branch.repository
1586
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1587
basis_tree.lock_read()
1589
new_basis_tree = self.branch.basis_tree()
1596
change_reporter=change_reporter)
1597
if (basis_tree.inventory.root is None and
1598
new_basis_tree.inventory.root is not None):
1599
self.set_root_id(new_basis_tree.get_root_id())
1603
# TODO - dedup parents list with things merged by pull ?
1604
# reuse the revisiontree we merged against to set the new
1606
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1607
# we have to pull the merge trees out again, because
1608
# merge_inner has set the ids. - this corner is not yet
1609
# layered well enough to prevent double handling.
1610
# XXX TODO: Fix the double handling: telling the tree about
1611
# the already known parent data is wasteful.
1612
merges = self.get_parent_ids()[1:]
1613
parent_trees.extend([
1614
(parent, repository.revision_tree(parent)) for
1616
self.set_parent_trees(parent_trees)
1623
def put_file_bytes_non_atomic(self, file_id, bytes):
1624
"""See MutableTree.put_file_bytes_non_atomic."""
1625
stream = file(self.id2abspath(file_id), 'wb')
1630
# TODO: update the hashcache here ?
1633
"""Yield all unversioned files in this WorkingTree.
1635
If there are any unversioned directories then only the directory is
1636
returned, not all its children. But if there are unversioned files
1637
under a versioned subdirectory, they are returned.
1639
Currently returned depth-first, sorted by name within directories.
1640
This is the same order used by 'osutils.walkdirs'.
1642
## TODO: Work from given directory downwards
1643
for path, dir_entry in self.inventory.directories():
1644
# mutter("search for unknowns in %r", path)
1645
dirabs = self.abspath(path)
1646
if not isdir(dirabs):
1647
# e.g. directory deleted
1651
for subf in os.listdir(dirabs):
1654
if subf not in dir_entry.children:
1655
subf_norm, can_access = osutils.normalized_filename(subf)
1656
if subf_norm != subf and can_access:
1657
if subf_norm not in dir_entry.children:
1658
fl.append(subf_norm)
1664
subp = pathjoin(path, subf)
1667
def ignored_files(self):
1668
"""Yield list of PATH, IGNORE_PATTERN"""
1669
for subp in self.extras():
1670
pat = self.is_ignored(subp)
1674
def get_ignore_list(self):
1675
"""Return list of ignore patterns.
1677
Cached in the Tree object after the first call.
1679
ignoreset = getattr(self, '_ignoreset', None)
1680
if ignoreset is not None:
1683
ignore_globs = set()
1684
ignore_globs.update(ignores.get_runtime_ignores())
1685
ignore_globs.update(ignores.get_user_ignores())
1686
if self.has_filename(bzrlib.IGNORE_FILENAME):
1687
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1689
ignore_globs.update(ignores.parse_ignore_file(f))
1692
self._ignoreset = ignore_globs
1695
def _flush_ignore_list_cache(self):
1696
"""Resets the cached ignore list to force a cache rebuild."""
1697
self._ignoreset = None
1698
self._ignoreglobster = None
1700
def is_ignored(self, filename):
1701
r"""Check whether the filename matches an ignore pattern.
1703
Patterns containing '/' or '\' need to match the whole path;
1704
others match against only the last component.
1706
If the file is ignored, returns the pattern which caused it to
1707
be ignored, otherwise None. So this can simply be used as a
1708
boolean if desired."""
1709
if getattr(self, '_ignoreglobster', None) is None:
1710
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1711
return self._ignoreglobster.match(filename)
1713
def kind(self, file_id):
1714
return file_kind(self.id2abspath(file_id))
1716
def stored_kind(self, file_id):
1717
"""See Tree.stored_kind"""
1718
return self.inventory[file_id].kind
1720
def _comparison_data(self, entry, path):
1721
abspath = self.abspath(path)
1723
stat_value = os.lstat(abspath)
1725
if getattr(e, 'errno', None) == errno.ENOENT:
1732
mode = stat_value.st_mode
1733
kind = osutils.file_kind_from_stat_mode(mode)
1734
if not supports_executable():
1735
executable = entry is not None and entry.executable
1737
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1738
return kind, executable, stat_value
1740
def _file_size(self, entry, stat_value):
1741
return stat_value.st_size
1743
def last_revision(self):
1744
"""Return the last revision of the branch for this tree.
1746
This format tree does not support a separate marker for last-revision
1747
compared to the branch.
1749
See MutableTree.last_revision
1751
return self._last_revision()
1754
def _last_revision(self):
1755
"""helper for get_parent_ids."""
1756
return _mod_revision.ensure_null(self.branch.last_revision())
1758
def is_locked(self):
1759
return self._control_files.is_locked()
1761
def _must_be_locked(self):
1762
if not self.is_locked():
1763
raise errors.ObjectNotLocked(self)
1765
def lock_read(self):
1766
"""See Branch.lock_read, and WorkingTree.unlock."""
1767
if not self.is_locked():
1769
self.branch.lock_read()
1771
return self._control_files.lock_read()
1773
self.branch.unlock()
1776
def lock_tree_write(self):
1777
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1778
if not self.is_locked():
1780
self.branch.lock_read()
1782
return self._control_files.lock_write()
1784
self.branch.unlock()
1787
def lock_write(self):
1788
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1789
if not self.is_locked():
1791
self.branch.lock_write()
1793
return self._control_files.lock_write()
1795
self.branch.unlock()
1798
def get_physical_lock_status(self):
1799
return self._control_files.get_physical_lock_status()
1801
def _basis_inventory_name(self):
1802
return 'basis-inventory-cache'
1804
def _reset_data(self):
1805
"""Reset transient data that cannot be revalidated."""
1806
self._inventory_is_modified = False
1807
result = self._deserialize(self._transport.get('inventory'))
1808
self._set_inventory(result, dirty=False)
1810
@needs_tree_write_lock
1811
def set_last_revision(self, new_revision):
1812
"""Change the last revision in the working tree."""
1813
if self._change_last_revision(new_revision):
1814
self._cache_basis_inventory(new_revision)
1816
def _change_last_revision(self, new_revision):
1817
"""Template method part of set_last_revision to perform the change.
1819
This is used to allow WorkingTree3 instances to not affect branch
1820
when their last revision is set.
1822
if _mod_revision.is_null(new_revision):
1823
self.branch.set_revision_history([])
1826
self.branch.generate_revision_history(new_revision)
1827
except errors.NoSuchRevision:
1828
# not present in the repo - dont try to set it deeper than the tip
1829
self.branch.set_revision_history([new_revision])
1832
def _write_basis_inventory(self, xml):
1833
"""Write the basis inventory XML to the basis-inventory file"""
1834
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1835
path = self._basis_inventory_name()
1837
self._transport.put_file(path, sio,
1838
mode=self._control_files._file_mode)
1840
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1841
"""Create the text that will be saved in basis-inventory"""
1842
inventory.revision_id = revision_id
1843
return xml7.serializer_v7.write_inventory_to_string(inventory)
1845
def _cache_basis_inventory(self, new_revision):
1846
"""Cache new_revision as the basis inventory."""
1847
# TODO: this should allow the ready-to-use inventory to be passed in,
1848
# as commit already has that ready-to-use [while the format is the
1851
# this double handles the inventory - unpack and repack -
1852
# but is easier to understand. We can/should put a conditional
1853
# in here based on whether the inventory is in the latest format
1854
# - perhaps we should repack all inventories on a repository
1856
# the fast path is to copy the raw xml from the repository. If the
1857
# xml contains 'revision_id="', then we assume the right
1858
# revision_id is set. We must check for this full string, because a
1859
# root node id can legitimately look like 'revision_id' but cannot
1861
xml = self.branch.repository.get_inventory_xml(new_revision)
1862
firstline = xml.split('\n', 1)[0]
1863
if (not 'revision_id="' in firstline or
1864
'format="7"' not in firstline):
1865
inv = self.branch.repository.deserialise_inventory(
1867
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1868
self._write_basis_inventory(xml)
1869
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1872
def read_basis_inventory(self):
1873
"""Read the cached basis inventory."""
1874
path = self._basis_inventory_name()
1875
return self._control_files._transport.get_bytes(path)
1878
def read_working_inventory(self):
1879
"""Read the working inventory.
1881
:raises errors.InventoryModified: read_working_inventory will fail
1882
when the current in memory inventory has been modified.
1884
# conceptually this should be an implementation detail of the tree.
1885
# XXX: Deprecate this.
1886
# ElementTree does its own conversion from UTF-8, so open in
1888
if self._inventory_is_modified:
1889
raise errors.InventoryModified(self)
1890
result = self._deserialize(self._control_files._transport.get('inventory'))
1891
self._set_inventory(result, dirty=False)
1894
@needs_tree_write_lock
1895
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1897
"""Remove nominated files from the working inventory.
1899
:files: File paths relative to the basedir.
1900
:keep_files: If true, the files will also be kept.
1901
:force: Delete files and directories, even if they are changed and
1902
even if the directories are not empty.
1904
if isinstance(files, basestring):
1910
unknown_nested_files=set()
1912
def recurse_directory_to_add_files(directory):
1913
# Recurse directory and add all files
1914
# so we can check if they have changed.
1915
for parent_info, file_infos in\
1916
osutils.walkdirs(self.abspath(directory),
1918
for relpath, basename, kind, lstat, abspath in file_infos:
1919
# Is it versioned or ignored?
1920
if self.path2id(relpath) or self.is_ignored(relpath):
1921
# Add nested content for deletion.
1922
new_files.add(relpath)
1924
# Files which are not versioned and not ignored
1925
# should be treated as unknown.
1926
unknown_nested_files.add((relpath, None, kind))
1928
for filename in files:
1929
# Get file name into canonical form.
1930
abspath = self.abspath(filename)
1931
filename = self.relpath(abspath)
1932
if len(filename) > 0:
1933
new_files.add(filename)
1934
if osutils.isdir(abspath):
1935
recurse_directory_to_add_files(filename)
1937
files = list(new_files)
1940
return # nothing to do
1942
# Sort needed to first handle directory content before the directory
1943
files.sort(reverse=True)
1945
# Bail out if we are going to delete files we shouldn't
1946
if not keep_files and not force:
1947
has_changed_files = len(unknown_nested_files) > 0
1948
if not has_changed_files:
1949
for (file_id, path, content_change, versioned, parent_id, name,
1950
kind, executable) in self.iter_changes(self.basis_tree(),
1951
include_unchanged=True, require_versioned=False,
1952
want_unversioned=True, specific_files=files):
1953
if versioned == (False, False):
1954
# The record is unknown ...
1955
if not self.is_ignored(path[1]):
1956
# ... but not ignored
1957
has_changed_files = True
1959
elif content_change and (kind[1] != None):
1960
# Versioned and changed, but not deleted
1961
has_changed_files = True
1964
if has_changed_files:
1965
# Make delta show ALL applicable changes in error message.
1966
tree_delta = self.changes_from(self.basis_tree(),
1967
require_versioned=False, want_unversioned=True,
1968
specific_files=files)
1969
for unknown_file in unknown_nested_files:
1970
if unknown_file not in tree_delta.unversioned:
1971
tree_delta.unversioned.extend((unknown_file,))
1972
raise errors.BzrRemoveChangedFilesError(tree_delta)
1974
# Build inv_delta and delete files where applicaple,
1975
# do this before any modifications to inventory.
1977
fid = self.path2id(f)
1980
message = "%s is not versioned." % (f,)
1983
# having removed it, it must be either ignored or unknown
1984
if self.is_ignored(f):
1988
textui.show_status(new_status, self.kind(fid), f,
1991
inv_delta.append((f, None, fid, None))
1992
message = "removed %s" % (f,)
1995
abs_path = self.abspath(f)
1996
if osutils.lexists(abs_path):
1997
if (osutils.isdir(abs_path) and
1998
len(os.listdir(abs_path)) > 0):
2000
osutils.rmtree(abs_path)
2002
message = "%s is not an empty directory "\
2003
"and won't be deleted." % (f,)
2005
osutils.delete_any(abs_path)
2006
message = "deleted %s" % (f,)
2007
elif message is not None:
2008
# Only care if we haven't done anything yet.
2009
message = "%s does not exist." % (f,)
2011
# Print only one message (if any) per file.
2012
if message is not None:
2014
self.apply_inventory_delta(inv_delta)
2016
@needs_tree_write_lock
2017
def revert(self, filenames=None, old_tree=None, backups=True,
2018
pb=DummyProgress(), report_changes=False):
2019
from bzrlib.conflicts import resolve
2022
symbol_versioning.warn('Using [] to revert all files is deprecated'
2023
' as of bzr 0.91. Please use None (the default) instead.',
2024
DeprecationWarning, stacklevel=2)
2025
if old_tree is None:
2026
basis_tree = self.basis_tree()
2027
basis_tree.lock_read()
2028
old_tree = basis_tree
2032
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2034
if filenames is None and len(self.get_parent_ids()) > 1:
2036
last_revision = self.last_revision()
2037
if last_revision != NULL_REVISION:
2038
if basis_tree is None:
2039
basis_tree = self.basis_tree()
2040
basis_tree.lock_read()
2041
parent_trees.append((last_revision, basis_tree))
2042
self.set_parent_trees(parent_trees)
2045
resolve(self, filenames, ignore_misses=True, recursive=True)
2047
if basis_tree is not None:
2051
def revision_tree(self, revision_id):
2052
"""See Tree.revision_tree.
2054
WorkingTree can supply revision_trees for the basis revision only
2055
because there is only one cached inventory in the bzr directory.
2057
if revision_id == self.last_revision():
2059
xml = self.read_basis_inventory()
2060
except errors.NoSuchFile:
2064
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2065
# dont use the repository revision_tree api because we want
2066
# to supply the inventory.
2067
if inv.revision_id == revision_id:
2068
return revisiontree.RevisionTree(self.branch.repository,
2070
except errors.BadInventoryFormat:
2072
# raise if there was no inventory, or if we read the wrong inventory.
2073
raise errors.NoSuchRevisionInTree(self, revision_id)
2075
# XXX: This method should be deprecated in favour of taking in a proper
2076
# new Inventory object.
2077
@needs_tree_write_lock
2078
def set_inventory(self, new_inventory_list):
2079
from bzrlib.inventory import (Inventory,
2084
inv = Inventory(self.get_root_id())
2085
for path, file_id, parent, kind in new_inventory_list:
2086
name = os.path.basename(path)
2089
# fixme, there should be a factory function inv,add_??
2090
if kind == 'directory':
2091
inv.add(InventoryDirectory(file_id, name, parent))
2092
elif kind == 'file':
2093
inv.add(InventoryFile(file_id, name, parent))
2094
elif kind == 'symlink':
2095
inv.add(InventoryLink(file_id, name, parent))
2097
raise errors.BzrError("unknown kind %r" % kind)
2098
self._write_inventory(inv)
2100
@needs_tree_write_lock
2101
def set_root_id(self, file_id):
2102
"""Set the root id for this tree."""
2105
symbol_versioning.warn(symbol_versioning.zero_twelve
2106
% 'WorkingTree.set_root_id with fileid=None',
2111
file_id = osutils.safe_file_id(file_id)
2112
self._set_root_id(file_id)
2114
def _set_root_id(self, file_id):
2115
"""Set the root id for this tree, in a format specific manner.
2117
:param file_id: The file id to assign to the root. It must not be
2118
present in the current inventory or an error will occur. It must
2119
not be None, but rather a valid file id.
2121
inv = self._inventory
2122
orig_root_id = inv.root.file_id
2123
# TODO: it might be nice to exit early if there was nothing
2124
# to do, saving us from trigger a sync on unlock.
2125
self._inventory_is_modified = True
2126
# we preserve the root inventory entry object, but
2127
# unlinkit from the byid index
2128
del inv._byid[inv.root.file_id]
2129
inv.root.file_id = file_id
2130
# and link it into the index with the new changed id.
2131
inv._byid[inv.root.file_id] = inv.root
2132
# and finally update all children to reference the new id.
2133
# XXX: this should be safe to just look at the root.children
2134
# list, not the WHOLE INVENTORY.
2137
if entry.parent_id == orig_root_id:
2138
entry.parent_id = inv.root.file_id
2141
"""See Branch.unlock.
2143
WorkingTree locking just uses the Branch locking facilities.
2144
This is current because all working trees have an embedded branch
2145
within them. IF in the future, we were to make branch data shareable
2146
between multiple working trees, i.e. via shared storage, then we
2147
would probably want to lock both the local tree, and the branch.
2149
raise NotImplementedError(self.unlock)
2151
def update(self, change_reporter=None, possible_transports=None):
2152
"""Update a working tree along its branch.
2154
This will update the branch if its bound too, which means we have
2155
multiple trees involved:
2157
- The new basis tree of the master.
2158
- The old basis tree of the branch.
2159
- The old basis tree of the working tree.
2160
- The current working tree state.
2162
Pathologically, all three may be different, and non-ancestors of each
2163
other. Conceptually we want to:
2165
- Preserve the wt.basis->wt.state changes
2166
- Transform the wt.basis to the new master basis.
2167
- Apply a merge of the old branch basis to get any 'local' changes from
2169
- Restore the wt.basis->wt.state changes.
2171
There isn't a single operation at the moment to do that, so we:
2172
- Merge current state -> basis tree of the master w.r.t. the old tree
2174
- Do a 'normal' merge of the old branch basis if it is relevant.
2176
if self.branch.get_bound_location() is not None:
2178
update_branch = True
2180
self.lock_tree_write()
2181
update_branch = False
2184
old_tip = self.branch.update(possible_transports)
2187
return self._update_tree(old_tip, change_reporter)
2191
@needs_tree_write_lock
2192
def _update_tree(self, old_tip=None, change_reporter=None):
2193
"""Update a tree to the master branch.
2195
:param old_tip: if supplied, the previous tip revision the branch,
2196
before it was changed to the master branch's tip.
2198
# here if old_tip is not None, it is the old tip of the branch before
2199
# it was updated from the master branch. This should become a pending
2200
# merge in the working tree to preserve the user existing work. we
2201
# cant set that until we update the working trees last revision to be
2202
# one from the new branch, because it will just get absorbed by the
2203
# parent de-duplication logic.
2205
# We MUST save it even if an error occurs, because otherwise the users
2206
# local work is unreferenced and will appear to have been lost.
2210
last_rev = self.get_parent_ids()[0]
2212
last_rev = _mod_revision.NULL_REVISION
2213
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2214
# merge tree state up to new branch tip.
2215
basis = self.basis_tree()
2218
to_tree = self.branch.basis_tree()
2219
if basis.inventory.root is None:
2220
self.set_root_id(to_tree.get_root_id())
2222
result += merge.merge_inner(
2227
change_reporter=change_reporter)
2230
# TODO - dedup parents list with things merged by pull ?
2231
# reuse the tree we've updated to to set the basis:
2232
parent_trees = [(self.branch.last_revision(), to_tree)]
2233
merges = self.get_parent_ids()[1:]
2234
# Ideally we ask the tree for the trees here, that way the working
2235
# tree can decide whether to give us teh entire tree or give us a
2236
# lazy initialised tree. dirstate for instance will have the trees
2237
# in ram already, whereas a last-revision + basis-inventory tree
2238
# will not, but also does not need them when setting parents.
2239
for parent in merges:
2240
parent_trees.append(
2241
(parent, self.branch.repository.revision_tree(parent)))
2242
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2243
parent_trees.append(
2244
(old_tip, self.branch.repository.revision_tree(old_tip)))
2245
self.set_parent_trees(parent_trees)
2246
last_rev = parent_trees[0][0]
2248
# the working tree had the same last-revision as the master
2249
# branch did. We may still have pivot local work from the local
2250
# branch into old_tip:
2251
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2252
self.add_parent_tree_id(old_tip)
2253
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2254
and old_tip != last_rev):
2255
# our last revision was not the prior branch last revision
2256
# and we have converted that last revision to a pending merge.
2257
# base is somewhere between the branch tip now
2258
# and the now pending merge
2260
# Since we just modified the working tree and inventory, flush out
2261
# the current state, before we modify it again.
2262
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2263
# requires it only because TreeTransform directly munges the
2264
# inventory and calls tree._write_inventory(). Ultimately we
2265
# should be able to remove this extra flush.
2267
graph = self.branch.repository.get_graph()
2268
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2270
base_tree = self.branch.repository.revision_tree(base_rev_id)
2271
other_tree = self.branch.repository.revision_tree(old_tip)
2272
result += merge.merge_inner(
2277
change_reporter=change_reporter)
2280
def _write_hashcache_if_dirty(self):
2281
"""Write out the hashcache if it is dirty."""
2282
if self._hashcache.needs_write:
2284
self._hashcache.write()
2286
if e.errno not in (errno.EPERM, errno.EACCES):
2288
# TODO: jam 20061219 Should this be a warning? A single line
2289
# warning might be sufficient to let the user know what
2291
mutter('Could not write hashcache for %s\nError: %s',
2292
self._hashcache.cache_file_name(), e)
2294
@needs_tree_write_lock
2295
def _write_inventory(self, inv):
2296
"""Write inventory as the current inventory."""
2297
self._set_inventory(inv, dirty=True)
2300
def set_conflicts(self, arg):
2301
raise errors.UnsupportedOperation(self.set_conflicts, self)
2303
def add_conflicts(self, arg):
2304
raise errors.UnsupportedOperation(self.add_conflicts, self)
2307
def conflicts(self):
2308
conflicts = _mod_conflicts.ConflictList()
2309
for conflicted in self._iter_conflicts():
2312
if file_kind(self.abspath(conflicted)) != "file":
2314
except errors.NoSuchFile:
2317
for suffix in ('.THIS', '.OTHER'):
2319
kind = file_kind(self.abspath(conflicted+suffix))
2322
except errors.NoSuchFile:
2326
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2327
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2329
file_id=self.path2id(conflicted)))
2332
def walkdirs(self, prefix=""):
2333
"""Walk the directories of this tree.
2335
returns a generator which yields items in the form:
2336
((curren_directory_path, fileid),
2337
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2340
This API returns a generator, which is only valid during the current
2341
tree transaction - within a single lock_read or lock_write duration.
2343
If the tree is not locked, it may cause an error to be raised,
2344
depending on the tree implementation.
2346
disk_top = self.abspath(prefix)
2347
if disk_top.endswith('/'):
2348
disk_top = disk_top[:-1]
2349
top_strip_len = len(disk_top) + 1
2350
inventory_iterator = self._walkdirs(prefix)
2351
disk_iterator = osutils.walkdirs(disk_top, prefix)
2353
current_disk = disk_iterator.next()
2354
disk_finished = False
2356
if not (e.errno == errno.ENOENT or
2357
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2360
disk_finished = True
2362
current_inv = inventory_iterator.next()
2363
inv_finished = False
2364
except StopIteration:
2367
while not inv_finished or not disk_finished:
2369
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2370
cur_disk_dir_content) = current_disk
2372
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2373
cur_disk_dir_content) = ((None, None), None)
2374
if not disk_finished:
2375
# strip out .bzr dirs
2376
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2377
len(cur_disk_dir_content) > 0):
2378
# osutils.walkdirs can be made nicer -
2379
# yield the path-from-prefix rather than the pathjoined
2381
bzrdir_loc = bisect_left(cur_disk_dir_content,
2383
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2384
# we dont yield the contents of, or, .bzr itself.
2385
del cur_disk_dir_content[bzrdir_loc]
2387
# everything is unknown
2390
# everything is missing
2393
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2395
# disk is before inventory - unknown
2396
dirblock = [(relpath, basename, kind, stat, None, None) for
2397
relpath, basename, kind, stat, top_path in
2398
cur_disk_dir_content]
2399
yield (cur_disk_dir_relpath, None), dirblock
2401
current_disk = disk_iterator.next()
2402
except StopIteration:
2403
disk_finished = True
2405
# inventory is before disk - missing.
2406
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2407
for relpath, basename, dkind, stat, fileid, kind in
2409
yield (current_inv[0][0], current_inv[0][1]), dirblock
2411
current_inv = inventory_iterator.next()
2412
except StopIteration:
2415
# versioned present directory
2416
# merge the inventory and disk data together
2418
for relpath, subiterator in itertools.groupby(sorted(
2419
current_inv[1] + cur_disk_dir_content,
2420
key=operator.itemgetter(0)), operator.itemgetter(1)):
2421
path_elements = list(subiterator)
2422
if len(path_elements) == 2:
2423
inv_row, disk_row = path_elements
2424
# versioned, present file
2425
dirblock.append((inv_row[0],
2426
inv_row[1], disk_row[2],
2427
disk_row[3], inv_row[4],
2429
elif len(path_elements[0]) == 5:
2431
dirblock.append((path_elements[0][0],
2432
path_elements[0][1], path_elements[0][2],
2433
path_elements[0][3], None, None))
2434
elif len(path_elements[0]) == 6:
2435
# versioned, absent file.
2436
dirblock.append((path_elements[0][0],
2437
path_elements[0][1], 'unknown', None,
2438
path_elements[0][4], path_elements[0][5]))
2440
raise NotImplementedError('unreachable code')
2441
yield current_inv[0], dirblock
2443
current_inv = inventory_iterator.next()
2444
except StopIteration:
2447
current_disk = disk_iterator.next()
2448
except StopIteration:
2449
disk_finished = True
2451
def _walkdirs(self, prefix=""):
2452
"""Walk the directories of this tree.
2454
:prefix: is used as the directrory to start with.
2455
returns a generator which yields items in the form:
2456
((curren_directory_path, fileid),
2457
[(file1_path, file1_name, file1_kind, None, file1_id,
2460
_directory = 'directory'
2461
# get the root in the inventory
2462
inv = self.inventory
2463
top_id = inv.path2id(prefix)
2467
pending = [(prefix, '', _directory, None, top_id, None)]
2470
currentdir = pending.pop()
2471
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2472
top_id = currentdir[4]
2474
relroot = currentdir[0] + '/'
2477
# FIXME: stash the node in pending
2479
for name, child in entry.sorted_children():
2480
dirblock.append((relroot + name, name, child.kind, None,
2481
child.file_id, child.kind
2483
yield (currentdir[0], entry.file_id), dirblock
2484
# push the user specified dirs from dirblock
2485
for dir in reversed(dirblock):
2486
if dir[2] == _directory:
2489
@needs_tree_write_lock
2490
def auto_resolve(self):
2491
"""Automatically resolve text conflicts according to contents.
2493
Only text conflicts are auto_resolvable. Files with no conflict markers
2494
are considered 'resolved', because bzr always puts conflict markers
2495
into files that have text conflicts. The corresponding .THIS .BASE and
2496
.OTHER files are deleted, as per 'resolve'.
2497
:return: a tuple of ConflictLists: (un_resolved, resolved).
2499
un_resolved = _mod_conflicts.ConflictList()
2500
resolved = _mod_conflicts.ConflictList()
2501
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2502
for conflict in self.conflicts():
2503
if (conflict.typestring != 'text conflict' or
2504
self.kind(conflict.file_id) != 'file'):
2505
un_resolved.append(conflict)
2507
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2509
for line in my_file:
2510
if conflict_re.search(line):
2511
un_resolved.append(conflict)
2514
resolved.append(conflict)
2517
resolved.remove_files(self)
2518
self.set_conflicts(un_resolved)
2519
return un_resolved, resolved
2521
def _validate(self):
2522
"""Validate internal structures.
2524
This is meant mostly for the test suite. To give it a chance to detect
2525
corruption after actions have occurred. The default implementation is a
2528
:return: None. An exception should be raised if there is an error.
2533
class WorkingTree2(WorkingTree):
2534
"""This is the Format 2 working tree.
2536
This was the first weave based working tree.
2537
- uses os locks for locking.
2538
- uses the branch last-revision.
2541
def __init__(self, *args, **kwargs):
2542
super(WorkingTree2, self).__init__(*args, **kwargs)
2543
# WorkingTree2 has more of a constraint that self._inventory must
2544
# exist. Because this is an older format, we don't mind the overhead
2545
# caused by the extra computation here.
2547
# Newer WorkingTree's should only have self._inventory set when they
2549
if self._inventory is None:
2550
self.read_working_inventory()
2552
def lock_tree_write(self):
2553
"""See WorkingTree.lock_tree_write().
2555
In Format2 WorkingTrees we have a single lock for the branch and tree
2556
so lock_tree_write() degrades to lock_write().
2558
self.branch.lock_write()
2560
return self._control_files.lock_write()
2562
self.branch.unlock()
2566
# do non-implementation specific cleanup
2569
# we share control files:
2570
if self._control_files._lock_count == 3:
2571
# _inventory_is_modified is always False during a read lock.
2572
if self._inventory_is_modified:
2574
self._write_hashcache_if_dirty()
2576
# reverse order of locking.
2578
return self._control_files.unlock()
2580
self.branch.unlock()
2583
class WorkingTree3(WorkingTree):
2584
"""This is the Format 3 working tree.
2586
This differs from the base WorkingTree by:
2587
- having its own file lock
2588
- having its own last-revision property.
2590
This is new in bzr 0.8
2594
def _last_revision(self):
2595
"""See Mutable.last_revision."""
2597
return self._transport.get_bytes('last-revision')
2598
except errors.NoSuchFile:
2599
return _mod_revision.NULL_REVISION
2601
def _change_last_revision(self, revision_id):
2602
"""See WorkingTree._change_last_revision."""
2603
if revision_id is None or revision_id == NULL_REVISION:
2605
self._control_files._transport.delete('last-revision')
2606
except errors.NoSuchFile:
2610
self._transport.put_bytes('last-revision', revision_id,
2611
mode=self._control_files._file_mode)
2614
@needs_tree_write_lock
2615
def set_conflicts(self, conflicts):
2616
self._put_rio('conflicts', conflicts.to_stanzas(),
2619
@needs_tree_write_lock
2620
def add_conflicts(self, new_conflicts):
2621
conflict_set = set(self.conflicts())
2622
conflict_set.update(set(list(new_conflicts)))
2623
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2624
key=_mod_conflicts.Conflict.sort_key)))
2627
def conflicts(self):
2629
confile = self._transport.get('conflicts')
2630
except errors.NoSuchFile:
2631
return _mod_conflicts.ConflictList()
2633
if confile.next() != CONFLICT_HEADER_1 + '\n':
2634
raise errors.ConflictFormatError()
2635
except StopIteration:
2636
raise errors.ConflictFormatError()
2637
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2640
# do non-implementation specific cleanup
2642
if self._control_files._lock_count == 1:
2643
# _inventory_is_modified is always False during a read lock.
2644
if self._inventory_is_modified:
2646
self._write_hashcache_if_dirty()
2647
# reverse order of locking.
2649
return self._control_files.unlock()
2651
self.branch.unlock()
2654
def get_conflicted_stem(path):
2655
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2656
if path.endswith(suffix):
2657
return path[:-len(suffix)]
2660
@deprecated_function(zero_eight)
2661
def is_control_file(filename):
2662
"""See WorkingTree.is_control_filename(filename)."""
2663
## FIXME: better check
2664
filename = normpath(filename)
2665
while filename != '':
2666
head, tail = os.path.split(filename)
2667
## mutter('check %r for control file' % ((head, tail),))
2670
if filename == head:
2676
class WorkingTreeFormat(object):
2677
"""An encapsulation of the initialization and open routines for a format.
2679
Formats provide three things:
2680
* An initialization routine,
2684
Formats are placed in an dict by their format string for reference
2685
during workingtree opening. Its not required that these be instances, they
2686
can be classes themselves with class methods - it simply depends on
2687
whether state is needed for a given format or not.
2689
Once a format is deprecated, just deprecate the initialize and open
2690
methods on the format class. Do not deprecate the object, as the
2691
object will be created every time regardless.
2694
_default_format = None
2695
"""The default format used for new trees."""
2698
"""The known formats."""
2700
requires_rich_root = False
2702
upgrade_recommended = False
2705
def find_format(klass, a_bzrdir):
2706
"""Return the format for the working tree object in a_bzrdir."""
2708
transport = a_bzrdir.get_workingtree_transport(None)
2709
format_string = transport.get("format").read()
2710
return klass._formats[format_string]
2711
except errors.NoSuchFile:
2712
raise errors.NoWorkingTree(base=transport.base)
2714
raise errors.UnknownFormatError(format=format_string,
2715
kind="working tree")
2717
def __eq__(self, other):
2718
return self.__class__ is other.__class__
2720
def __ne__(self, other):
2721
return not (self == other)
2724
def get_default_format(klass):
2725
"""Return the current default format."""
2726
return klass._default_format
2728
def get_format_string(self):
2729
"""Return the ASCII format string that identifies this format."""
2730
raise NotImplementedError(self.get_format_string)
2732
def get_format_description(self):
2733
"""Return the short description for this format."""
2734
raise NotImplementedError(self.get_format_description)
2736
def is_supported(self):
2737
"""Is this format supported?
2739
Supported formats can be initialized and opened.
2740
Unsupported formats may not support initialization or committing or
2741
some other features depending on the reason for not being supported.
2746
def register_format(klass, format):
2747
klass._formats[format.get_format_string()] = format
2750
def set_default_format(klass, format):
2751
klass._default_format = format
2754
def unregister_format(klass, format):
2755
assert klass._formats[format.get_format_string()] is format
2756
del klass._formats[format.get_format_string()]
2759
class WorkingTreeFormat2(WorkingTreeFormat):
2760
"""The second working tree format.
2762
This format modified the hash cache from the format 1 hash cache.
2765
upgrade_recommended = True
2767
def get_format_description(self):
2768
"""See WorkingTreeFormat.get_format_description()."""
2769
return "Working tree format 2"
2771
def stub_initialize_remote(self, control_files):
2772
"""As a special workaround create critical control files for a remote working tree
2774
This ensures that it can later be updated and dealt with locally,
2775
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2776
no working tree. (See bug #43064).
2780
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2782
control_files._transport.put_file('inventory', sio,
2783
mode=control_files._file_mode)
2784
control_files._transport.put_bytes('pending-merges', '',
2785
mode=control_files._file_mode)
2788
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2789
accelerator_tree=None, hardlink=False):
2790
"""See WorkingTreeFormat.initialize()."""
2791
if not isinstance(a_bzrdir.transport, LocalTransport):
2792
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2793
if from_branch is not None:
2794
branch = from_branch
2796
branch = a_bzrdir.open_branch()
2797
if revision_id is None:
2798
revision_id = _mod_revision.ensure_null(branch.last_revision())
2801
branch.generate_revision_history(revision_id)
2805
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2811
basis_tree = branch.repository.revision_tree(revision_id)
2812
if basis_tree.inventory.root is not None:
2813
wt.set_root_id(basis_tree.get_root_id())
2814
# set the parent list and cache the basis tree.
2815
if _mod_revision.is_null(revision_id):
2818
parent_trees = [(revision_id, basis_tree)]
2819
wt.set_parent_trees(parent_trees)
2820
transform.build_tree(basis_tree, wt)
2824
super(WorkingTreeFormat2, self).__init__()
2825
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2827
def open(self, a_bzrdir, _found=False):
2828
"""Return the WorkingTree object for a_bzrdir
2830
_found is a private parameter, do not use it. It is used to indicate
2831
if format probing has already been done.
2834
# we are being called directly and must probe.
2835
raise NotImplementedError
2836
if not isinstance(a_bzrdir.transport, LocalTransport):
2837
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2838
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2844
class WorkingTreeFormat3(WorkingTreeFormat):
2845
"""The second working tree format updated to record a format marker.
2848
- exists within a metadir controlling .bzr
2849
- includes an explicit version marker for the workingtree control
2850
files, separate from the BzrDir format
2851
- modifies the hash cache format
2853
- uses a LockDir to guard access for writes.
2856
upgrade_recommended = True
2858
def get_format_string(self):
2859
"""See WorkingTreeFormat.get_format_string()."""
2860
return "Bazaar-NG Working Tree format 3"
2862
def get_format_description(self):
2863
"""See WorkingTreeFormat.get_format_description()."""
2864
return "Working tree format 3"
2866
_lock_file_name = 'lock'
2867
_lock_class = LockDir
2869
_tree_class = WorkingTree3
2871
def __get_matchingbzrdir(self):
2872
return bzrdir.BzrDirMetaFormat1()
2874
_matchingbzrdir = property(__get_matchingbzrdir)
2876
def _open_control_files(self, a_bzrdir):
2877
transport = a_bzrdir.get_workingtree_transport(None)
2878
return LockableFiles(transport, self._lock_file_name,
2881
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2882
accelerator_tree=None, hardlink=False):
2883
"""See WorkingTreeFormat.initialize().
2885
:param revision_id: if supplied, create a working tree at a different
2886
revision than the branch is at.
2887
:param accelerator_tree: A tree which can be used for retrieving file
2888
contents more quickly than the revision tree, i.e. a workingtree.
2889
The revision tree will be used for cases where accelerator_tree's
2890
content is different.
2891
:param hardlink: If true, hard-link files from accelerator_tree,
2894
if not isinstance(a_bzrdir.transport, LocalTransport):
2895
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2896
transport = a_bzrdir.get_workingtree_transport(self)
2897
control_files = self._open_control_files(a_bzrdir)
2898
control_files.create_lock()
2899
control_files.lock_write()
2900
transport.put_bytes('format', self.get_format_string(),
2901
mode=control_files._file_mode)
2902
if from_branch is not None:
2903
branch = from_branch
2905
branch = a_bzrdir.open_branch()
2906
if revision_id is None:
2907
revision_id = _mod_revision.ensure_null(branch.last_revision())
2908
# WorkingTree3 can handle an inventory which has a unique root id.
2909
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2910
# those trees. And because there isn't a format bump inbetween, we
2911
# are maintaining compatibility with older clients.
2912
# inv = Inventory(root_id=gen_root_id())
2913
inv = self._initial_inventory()
2914
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2920
_control_files=control_files)
2921
wt.lock_tree_write()
2923
basis_tree = branch.repository.revision_tree(revision_id)
2924
# only set an explicit root id if there is one to set.
2925
if basis_tree.inventory.root is not None:
2926
wt.set_root_id(basis_tree.get_root_id())
2927
if revision_id == NULL_REVISION:
2928
wt.set_parent_trees([])
2930
wt.set_parent_trees([(revision_id, basis_tree)])
2931
transform.build_tree(basis_tree, wt)
2933
# Unlock in this order so that the unlock-triggers-flush in
2934
# WorkingTree is given a chance to fire.
2935
control_files.unlock()
2939
def _initial_inventory(self):
2943
super(WorkingTreeFormat3, self).__init__()
2945
def open(self, a_bzrdir, _found=False):
2946
"""Return the WorkingTree object for a_bzrdir
2948
_found is a private parameter, do not use it. It is used to indicate
2949
if format probing has already been done.
2952
# we are being called directly and must probe.
2953
raise NotImplementedError
2954
if not isinstance(a_bzrdir.transport, LocalTransport):
2955
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2956
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2959
def _open(self, a_bzrdir, control_files):
2960
"""Open the tree itself.
2962
:param a_bzrdir: the dir for the tree.
2963
:param control_files: the control files for the tree.
2965
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2969
_control_files=control_files)
2972
return self.get_format_string()
2975
__default_format = WorkingTreeFormat4()
2976
WorkingTreeFormat.register_format(__default_format)
2977
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2978
WorkingTreeFormat.set_default_format(__default_format)
2979
# formats which have no format string are not discoverable
2980
# and not independently creatable, so are not registered.
2981
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
