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._control_files.put_bytes('pending-merges', '\n'.join(merges))
805
@needs_tree_write_lock
806
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
807
"""Set the parent ids to revision_ids.
809
See also set_parent_trees. This api will try to retrieve the tree data
810
for each element of revision_ids from the trees repository. If you have
811
tree data already available, it is more efficient to use
812
set_parent_trees rather than set_parent_ids. set_parent_ids is however
813
an easier API to use.
815
:param revision_ids: The revision_ids to set as the parent ids of this
816
working tree. Any of these may be ghosts.
818
self._check_parents_for_ghosts(revision_ids,
819
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
820
for revision_id in revision_ids:
821
_mod_revision.check_not_reserved_id(revision_id)
823
if len(revision_ids) > 0:
824
self.set_last_revision(revision_ids[0])
826
self.set_last_revision(_mod_revision.NULL_REVISION)
828
self._set_merges_from_parent_ids(revision_ids)
830
@needs_tree_write_lock
831
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
832
"""See MutableTree.set_parent_trees."""
833
parent_ids = [rev for (rev, tree) in parents_list]
834
for revision_id in parent_ids:
835
_mod_revision.check_not_reserved_id(revision_id)
837
self._check_parents_for_ghosts(parent_ids,
838
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
840
if len(parent_ids) == 0:
841
leftmost_parent_id = _mod_revision.NULL_REVISION
842
leftmost_parent_tree = None
844
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
846
if self._change_last_revision(leftmost_parent_id):
847
if leftmost_parent_tree is None:
848
# If we don't have a tree, fall back to reading the
849
# parent tree from the repository.
850
self._cache_basis_inventory(leftmost_parent_id)
852
inv = leftmost_parent_tree.inventory
853
xml = self._create_basis_xml_from_inventory(
854
leftmost_parent_id, inv)
855
self._write_basis_inventory(xml)
856
self._set_merges_from_parent_ids(parent_ids)
858
@needs_tree_write_lock
859
def set_pending_merges(self, rev_list):
860
parents = self.get_parent_ids()
861
leftmost = parents[:1]
862
new_parents = leftmost + rev_list
863
self.set_parent_ids(new_parents)
865
@needs_tree_write_lock
866
def set_merge_modified(self, modified_hashes):
868
for file_id, hash in modified_hashes.iteritems():
869
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
870
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
872
def _sha_from_stat(self, path, stat_result):
873
"""Get a sha digest from the tree's stat cache.
875
The default implementation assumes no stat cache is present.
877
:param path: The path.
878
:param stat_result: The stat result being looked up.
882
def _put_rio(self, filename, stanzas, header):
883
self._must_be_locked()
884
my_file = rio_file(stanzas, header)
885
self._control_files.put(filename, my_file)
887
@needs_write_lock # because merge pulls data into the branch.
888
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
890
"""Merge from a branch into this working tree.
892
:param branch: The branch to merge from.
893
:param to_revision: If non-None, the merge will merge to to_revision,
894
but not beyond it. to_revision does not need to be in the history
895
of the branch when it is supplied. If None, to_revision defaults to
896
branch.last_revision().
898
from bzrlib.merge import Merger, Merge3Merger
899
pb = bzrlib.ui.ui_factory.nested_progress_bar()
901
merger = Merger(self.branch, this_tree=self, pb=pb)
902
merger.pp = ProgressPhase("Merge phase", 5, pb)
903
merger.pp.next_phase()
904
# check that there are no
906
merger.check_basis(check_clean=True, require_commits=False)
907
if to_revision is None:
908
to_revision = _mod_revision.ensure_null(branch.last_revision())
909
merger.other_rev_id = to_revision
910
if _mod_revision.is_null(merger.other_rev_id):
911
raise errors.NoCommits(branch)
912
self.branch.fetch(branch, last_revision=merger.other_rev_id)
913
merger.other_basis = merger.other_rev_id
914
merger.other_tree = self.branch.repository.revision_tree(
916
merger.other_branch = branch
917
merger.pp.next_phase()
918
if from_revision is None:
921
merger.set_base_revision(from_revision, branch)
922
if merger.base_rev_id == merger.other_rev_id:
923
raise errors.PointlessMerge
924
merger.backup_files = False
925
if merge_type is None:
926
merger.merge_type = Merge3Merger
928
merger.merge_type = merge_type
929
merger.set_interesting_files(None)
930
merger.show_base = False
931
merger.reprocess = False
932
conflicts = merger.do_merge()
939
def merge_modified(self):
940
"""Return a dictionary of files modified by a merge.
942
The list is initialized by WorkingTree.set_merge_modified, which is
943
typically called after we make some automatic updates to the tree
946
This returns a map of file_id->sha1, containing only files which are
947
still in the working inventory and have that text hash.
950
hashfile = self._control_files._transport.get('merge-hashes')
951
except errors.NoSuchFile:
955
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
956
raise errors.MergeModifiedFormatError()
957
except StopIteration:
958
raise errors.MergeModifiedFormatError()
959
for s in RioReader(hashfile):
960
# RioReader reads in Unicode, so convert file_ids back to utf8
961
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
962
if file_id not in self.inventory:
964
text_hash = s.get("hash")
965
if text_hash == self.get_file_sha1(file_id):
966
merge_hashes[file_id] = text_hash
970
def mkdir(self, path, file_id=None):
971
"""See MutableTree.mkdir()."""
973
file_id = generate_ids.gen_file_id(os.path.basename(path))
974
os.mkdir(self.abspath(path))
975
self.add(path, file_id, 'directory')
978
def get_symlink_target(self, file_id):
979
return os.readlink(self.id2abspath(file_id))
982
def subsume(self, other_tree):
983
def add_children(inventory, entry):
984
for child_entry in entry.children.values():
985
inventory._byid[child_entry.file_id] = child_entry
986
if child_entry.kind == 'directory':
987
add_children(inventory, child_entry)
988
if other_tree.get_root_id() == self.get_root_id():
989
raise errors.BadSubsumeSource(self, other_tree,
990
'Trees have the same root')
992
other_tree_path = self.relpath(other_tree.basedir)
993
except errors.PathNotChild:
994
raise errors.BadSubsumeSource(self, other_tree,
995
'Tree is not contained by the other')
996
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
997
if new_root_parent is None:
998
raise errors.BadSubsumeSource(self, other_tree,
999
'Parent directory is not versioned.')
1000
# We need to ensure that the result of a fetch will have a
1001
# versionedfile for the other_tree root, and only fetching into
1002
# RepositoryKnit2 guarantees that.
1003
if not self.branch.repository.supports_rich_root():
1004
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1005
other_tree.lock_tree_write()
1007
new_parents = other_tree.get_parent_ids()
1008
other_root = other_tree.inventory.root
1009
other_root.parent_id = new_root_parent
1010
other_root.name = osutils.basename(other_tree_path)
1011
self.inventory.add(other_root)
1012
add_children(self.inventory, other_root)
1013
self._write_inventory(self.inventory)
1014
# normally we don't want to fetch whole repositories, but i think
1015
# here we really do want to consolidate the whole thing.
1016
for parent_id in other_tree.get_parent_ids():
1017
self.branch.fetch(other_tree.branch, parent_id)
1018
self.add_parent_tree_id(parent_id)
1021
other_tree.bzrdir.retire_bzrdir()
1023
def _setup_directory_is_tree_reference(self):
1024
if self._branch.repository._format.supports_tree_reference:
1025
self._directory_is_tree_reference = \
1026
self._directory_may_be_tree_reference
1028
self._directory_is_tree_reference = \
1029
self._directory_is_never_tree_reference
1031
def _directory_is_never_tree_reference(self, relpath):
1034
def _directory_may_be_tree_reference(self, relpath):
1035
# as a special case, if a directory contains control files then
1036
# it's a tree reference, except that the root of the tree is not
1037
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1038
# TODO: We could ask all the control formats whether they
1039
# recognize this directory, but at the moment there's no cheap api
1040
# to do that. Since we probably can only nest bzr checkouts and
1041
# they always use this name it's ok for now. -- mbp 20060306
1043
# FIXME: There is an unhandled case here of a subdirectory
1044
# containing .bzr but not a branch; that will probably blow up
1045
# when you try to commit it. It might happen if there is a
1046
# checkout in a subdirectory. This can be avoided by not adding
1049
@needs_tree_write_lock
1050
def extract(self, file_id, format=None):
1051
"""Extract a subtree from this tree.
1053
A new branch will be created, relative to the path for this tree.
1057
segments = osutils.splitpath(path)
1058
transport = self.branch.bzrdir.root_transport
1059
for name in segments:
1060
transport = transport.clone(name)
1061
transport.ensure_base()
1064
sub_path = self.id2path(file_id)
1065
branch_transport = mkdirs(sub_path)
1067
format = self.bzrdir.cloning_metadir()
1068
branch_transport.ensure_base()
1069
branch_bzrdir = format.initialize_on_transport(branch_transport)
1071
repo = branch_bzrdir.find_repository()
1072
except errors.NoRepositoryPresent:
1073
repo = branch_bzrdir.create_repository()
1074
if not repo.supports_rich_root():
1075
raise errors.RootNotRich()
1076
new_branch = branch_bzrdir.create_branch()
1077
new_branch.pull(self.branch)
1078
for parent_id in self.get_parent_ids():
1079
new_branch.fetch(self.branch, parent_id)
1080
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1081
if tree_transport.base != branch_transport.base:
1082
tree_bzrdir = format.initialize_on_transport(tree_transport)
1083
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1085
tree_bzrdir = branch_bzrdir
1086
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1087
wt.set_parent_ids(self.get_parent_ids())
1088
my_inv = self.inventory
1089
child_inv = Inventory(root_id=None)
1090
new_root = my_inv[file_id]
1091
my_inv.remove_recursive_id(file_id)
1092
new_root.parent_id = None
1093
child_inv.add(new_root)
1094
self._write_inventory(my_inv)
1095
wt._write_inventory(child_inv)
1098
def _serialize(self, inventory, out_file):
1099
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1102
def _deserialize(selt, in_file):
1103
return xml5.serializer_v5.read_inventory(in_file)
1106
"""Write the in memory inventory to disk."""
1107
# TODO: Maybe this should only write on dirty ?
1108
if self._control_files._lock_mode != 'w':
1109
raise errors.NotWriteLocked(self)
1111
self._serialize(self._inventory, sio)
1113
self._control_files.put('inventory', sio)
1114
self._inventory_is_modified = False
1116
def _kind(self, relpath):
1117
return osutils.file_kind(self.abspath(relpath))
1119
def list_files(self, include_root=False):
1120
"""Recursively list all files as (path, class, kind, id, entry).
1122
Lists, but does not descend into unversioned directories.
1124
This does not include files that have been deleted in this
1127
Skips the control directory.
1129
# list_files is an iterator, so @needs_read_lock doesn't work properly
1130
# with it. So callers should be careful to always read_lock the tree.
1131
if not self.is_locked():
1132
raise errors.ObjectNotLocked(self)
1134
inv = self.inventory
1135
if include_root is True:
1136
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1137
# Convert these into local objects to save lookup times
1138
pathjoin = osutils.pathjoin
1139
file_kind = self._kind
1141
# transport.base ends in a slash, we want the piece
1142
# between the last two slashes
1143
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1145
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1147
# directory file_id, relative path, absolute path, reverse sorted children
1148
children = os.listdir(self.basedir)
1150
# jam 20060527 The kernel sized tree seems equivalent whether we
1151
# use a deque and popleft to keep them sorted, or if we use a plain
1152
# list and just reverse() them.
1153
children = collections.deque(children)
1154
stack = [(inv.root.file_id, u'', self.basedir, children)]
1156
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1159
f = children.popleft()
1160
## TODO: If we find a subdirectory with its own .bzr
1161
## directory, then that is a separate tree and we
1162
## should exclude it.
1164
# the bzrdir for this tree
1165
if transport_base_dir == f:
1168
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1169
# and 'f' doesn't begin with one, we can do a string op, rather
1170
# than the checks of pathjoin(), all relative paths will have an extra slash
1172
fp = from_dir_relpath + '/' + f
1175
fap = from_dir_abspath + '/' + f
1177
f_ie = inv.get_child(from_dir_id, f)
1180
elif self.is_ignored(fp[1:]):
1183
# we may not have found this file, because of a unicode issue
1184
f_norm, can_access = osutils.normalized_filename(f)
1185
if f == f_norm or not can_access:
1186
# No change, so treat this file normally
1189
# this file can be accessed by a normalized path
1190
# check again if it is versioned
1191
# these lines are repeated here for performance
1193
fp = from_dir_relpath + '/' + f
1194
fap = from_dir_abspath + '/' + f
1195
f_ie = inv.get_child(from_dir_id, f)
1198
elif self.is_ignored(fp[1:]):
1205
# make a last minute entry
1207
yield fp[1:], c, fk, f_ie.file_id, f_ie
1210
yield fp[1:], c, fk, None, fk_entries[fk]()
1212
yield fp[1:], c, fk, None, TreeEntry()
1215
if fk != 'directory':
1218
# But do this child first
1219
new_children = os.listdir(fap)
1221
new_children = collections.deque(new_children)
1222
stack.append((f_ie.file_id, fp, fap, new_children))
1223
# Break out of inner loop,
1224
# so that we start outer loop with child
1227
# if we finished all children, pop it off the stack
1230
@needs_tree_write_lock
1231
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1234
to_dir must exist in the inventory.
1236
If to_dir exists and is a directory, the files are moved into
1237
it, keeping their old names.
1239
Note that to_dir is only the last component of the new name;
1240
this doesn't change the directory.
1242
For each entry in from_paths the move mode will be determined
1245
The first mode moves the file in the filesystem and updates the
1246
inventory. The second mode only updates the inventory without
1247
touching the file on the filesystem. This is the new mode introduced
1250
move uses the second mode if 'after == True' and the target is not
1251
versioned but present in the working tree.
1253
move uses the second mode if 'after == False' and the source is
1254
versioned but no longer in the working tree, and the target is not
1255
versioned but present in the working tree.
1257
move uses the first mode if 'after == False' and the source is
1258
versioned and present in the working tree, and the target is not
1259
versioned and not present in the working tree.
1261
Everything else results in an error.
1263
This returns a list of (from_path, to_path) pairs for each
1264
entry that is moved.
1269
# check for deprecated use of signature
1271
to_dir = kwargs.get('to_name', None)
1273
raise TypeError('You must supply a target directory')
1275
symbol_versioning.warn('The parameter to_name was deprecated'
1276
' in version 0.13. Use to_dir instead',
1279
# check destination directory
1280
assert not isinstance(from_paths, basestring)
1281
inv = self.inventory
1282
to_abs = self.abspath(to_dir)
1283
if not isdir(to_abs):
1284
raise errors.BzrMoveFailedError('',to_dir,
1285
errors.NotADirectory(to_abs))
1286
if not self.has_filename(to_dir):
1287
raise errors.BzrMoveFailedError('',to_dir,
1288
errors.NotInWorkingDirectory(to_dir))
1289
to_dir_id = inv.path2id(to_dir)
1290
if to_dir_id is None:
1291
raise errors.BzrMoveFailedError('',to_dir,
1292
errors.NotVersionedError(path=str(to_dir)))
1294
to_dir_ie = inv[to_dir_id]
1295
if to_dir_ie.kind != 'directory':
1296
raise errors.BzrMoveFailedError('',to_dir,
1297
errors.NotADirectory(to_abs))
1299
# create rename entries and tuples
1300
for from_rel in from_paths:
1301
from_tail = splitpath(from_rel)[-1]
1302
from_id = inv.path2id(from_rel)
1304
raise errors.BzrMoveFailedError(from_rel,to_dir,
1305
errors.NotVersionedError(path=str(from_rel)))
1307
from_entry = inv[from_id]
1308
from_parent_id = from_entry.parent_id
1309
to_rel = pathjoin(to_dir, from_tail)
1310
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1312
from_tail=from_tail,
1313
from_parent_id=from_parent_id,
1314
to_rel=to_rel, to_tail=from_tail,
1315
to_parent_id=to_dir_id)
1316
rename_entries.append(rename_entry)
1317
rename_tuples.append((from_rel, to_rel))
1319
# determine which move mode to use. checks also for movability
1320
rename_entries = self._determine_mv_mode(rename_entries, after)
1322
original_modified = self._inventory_is_modified
1325
self._inventory_is_modified = True
1326
self._move(rename_entries)
1328
# restore the inventory on error
1329
self._inventory_is_modified = original_modified
1331
self._write_inventory(inv)
1332
return rename_tuples
1334
def _determine_mv_mode(self, rename_entries, after=False):
1335
"""Determines for each from-to pair if both inventory and working tree
1336
or only the inventory has to be changed.
1338
Also does basic plausability tests.
1340
inv = self.inventory
1342
for rename_entry in rename_entries:
1343
# store to local variables for easier reference
1344
from_rel = rename_entry.from_rel
1345
from_id = rename_entry.from_id
1346
to_rel = rename_entry.to_rel
1347
to_id = inv.path2id(to_rel)
1348
only_change_inv = False
1350
# check the inventory for source and destination
1352
raise errors.BzrMoveFailedError(from_rel,to_rel,
1353
errors.NotVersionedError(path=str(from_rel)))
1354
if to_id is not None:
1355
raise errors.BzrMoveFailedError(from_rel,to_rel,
1356
errors.AlreadyVersionedError(path=str(to_rel)))
1358
# try to determine the mode for rename (only change inv or change
1359
# inv and file system)
1361
if not self.has_filename(to_rel):
1362
raise errors.BzrMoveFailedError(from_id,to_rel,
1363
errors.NoSuchFile(path=str(to_rel),
1364
extra="New file has not been created yet"))
1365
only_change_inv = True
1366
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1367
only_change_inv = True
1368
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1369
only_change_inv = False
1370
elif (sys.platform == 'win32'
1371
and from_rel.lower() == to_rel.lower()
1372
and self.has_filename(from_rel)):
1373
only_change_inv = False
1375
# something is wrong, so lets determine what exactly
1376
if not self.has_filename(from_rel) and \
1377
not self.has_filename(to_rel):
1378
raise errors.BzrRenameFailedError(from_rel,to_rel,
1379
errors.PathsDoNotExist(paths=(str(from_rel),
1382
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1383
rename_entry.only_change_inv = only_change_inv
1384
return rename_entries
1386
def _move(self, rename_entries):
1387
"""Moves a list of files.
1389
Depending on the value of the flag 'only_change_inv', the
1390
file will be moved on the file system or not.
1392
inv = self.inventory
1395
for entry in rename_entries:
1397
self._move_entry(entry)
1399
self._rollback_move(moved)
1403
def _rollback_move(self, moved):
1404
"""Try to rollback a previous move in case of an filesystem error."""
1405
inv = self.inventory
1408
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1409
entry.to_tail, entry.to_parent_id, entry.from_rel,
1410
entry.from_tail, entry.from_parent_id,
1411
entry.only_change_inv))
1412
except errors.BzrMoveFailedError, e:
1413
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1414
" The working tree is in an inconsistent state."
1415
" Please consider doing a 'bzr revert'."
1416
" Error message is: %s" % e)
1418
def _move_entry(self, entry):
1419
inv = self.inventory
1420
from_rel_abs = self.abspath(entry.from_rel)
1421
to_rel_abs = self.abspath(entry.to_rel)
1422
if from_rel_abs == to_rel_abs:
1423
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1424
"Source and target are identical.")
1426
if not entry.only_change_inv:
1428
osutils.rename(from_rel_abs, to_rel_abs)
1430
raise errors.BzrMoveFailedError(entry.from_rel,
1432
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1434
@needs_tree_write_lock
1435
def rename_one(self, from_rel, to_rel, after=False):
1438
This can change the directory or the filename or both.
1440
rename_one has several 'modes' to work. First, it can rename a physical
1441
file and change the file_id. That is the normal mode. Second, it can
1442
only change the file_id without touching any physical file. This is
1443
the new mode introduced in version 0.15.
1445
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1446
versioned but present in the working tree.
1448
rename_one uses the second mode if 'after == False' and 'from_rel' is
1449
versioned but no longer in the working tree, and 'to_rel' is not
1450
versioned but present in the working tree.
1452
rename_one uses the first mode if 'after == False' and 'from_rel' is
1453
versioned and present in the working tree, and 'to_rel' is not
1454
versioned and not present in the working tree.
1456
Everything else results in an error.
1458
inv = self.inventory
1461
# create rename entries and tuples
1462
from_tail = splitpath(from_rel)[-1]
1463
from_id = inv.path2id(from_rel)
1465
raise errors.BzrRenameFailedError(from_rel,to_rel,
1466
errors.NotVersionedError(path=str(from_rel)))
1467
from_entry = inv[from_id]
1468
from_parent_id = from_entry.parent_id
1469
to_dir, to_tail = os.path.split(to_rel)
1470
to_dir_id = inv.path2id(to_dir)
1471
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1473
from_tail=from_tail,
1474
from_parent_id=from_parent_id,
1475
to_rel=to_rel, to_tail=to_tail,
1476
to_parent_id=to_dir_id)
1477
rename_entries.append(rename_entry)
1479
# determine which move mode to use. checks also for movability
1480
rename_entries = self._determine_mv_mode(rename_entries, after)
1482
# check if the target changed directory and if the target directory is
1484
if to_dir_id is None:
1485
raise errors.BzrMoveFailedError(from_rel,to_rel,
1486
errors.NotVersionedError(path=str(to_dir)))
1488
# all checks done. now we can continue with our actual work
1489
mutter('rename_one:\n'
1494
' to_dir_id {%s}\n',
1495
from_id, from_rel, to_rel, to_dir, to_dir_id)
1497
self._move(rename_entries)
1498
self._write_inventory(inv)
1500
class _RenameEntry(object):
1501
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1502
to_rel, to_tail, to_parent_id, only_change_inv=False):
1503
self.from_rel = from_rel
1504
self.from_id = from_id
1505
self.from_tail = from_tail
1506
self.from_parent_id = from_parent_id
1507
self.to_rel = to_rel
1508
self.to_tail = to_tail
1509
self.to_parent_id = to_parent_id
1510
self.only_change_inv = only_change_inv
1514
"""Return all unknown files.
1516
These are files in the working directory that are not versioned or
1517
control files or ignored.
1519
# force the extras method to be fully executed before returning, to
1520
# prevent race conditions with the lock
1522
[subp for subp in self.extras() if not self.is_ignored(subp)])
1524
@needs_tree_write_lock
1525
def unversion(self, file_ids):
1526
"""Remove the file ids in file_ids from the current versioned set.
1528
When a file_id is unversioned, all of its children are automatically
1531
:param file_ids: The file ids to stop versioning.
1532
:raises: NoSuchId if any fileid is not currently versioned.
1534
for file_id in file_ids:
1535
if self._inventory.has_id(file_id):
1536
self._inventory.remove_recursive_id(file_id)
1538
raise errors.NoSuchId(self, file_id)
1540
# in the future this should just set a dirty bit to wait for the
1541
# final unlock. However, until all methods of workingtree start
1542
# with the current in -memory inventory rather than triggering
1543
# a read, it is more complex - we need to teach read_inventory
1544
# to know when to read, and when to not read first... and possibly
1545
# to save first when the in memory one may be corrupted.
1546
# so for now, we just only write it if it is indeed dirty.
1548
self._write_inventory(self._inventory)
1550
@deprecated_method(zero_eight)
1551
def iter_conflicts(self):
1552
"""List all files in the tree that have text or content conflicts.
1553
DEPRECATED. Use conflicts instead."""
1554
return self._iter_conflicts()
1556
def _iter_conflicts(self):
1558
for info in self.list_files():
1560
stem = get_conflicted_stem(path)
1563
if stem not in conflicted:
1564
conflicted.add(stem)
1568
def pull(self, source, overwrite=False, stop_revision=None,
1569
change_reporter=None, possible_transports=None):
1570
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1573
pp = ProgressPhase("Pull phase", 2, top_pb)
1575
old_revision_info = self.branch.last_revision_info()
1576
basis_tree = self.basis_tree()
1577
count = self.branch.pull(source, overwrite, stop_revision,
1578
possible_transports=possible_transports)
1579
new_revision_info = self.branch.last_revision_info()
1580
if new_revision_info != old_revision_info:
1582
repository = self.branch.repository
1583
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1584
basis_tree.lock_read()
1586
new_basis_tree = self.branch.basis_tree()
1593
change_reporter=change_reporter)
1594
if (basis_tree.inventory.root is None and
1595
new_basis_tree.inventory.root is not None):
1596
self.set_root_id(new_basis_tree.get_root_id())
1600
# TODO - dedup parents list with things merged by pull ?
1601
# reuse the revisiontree we merged against to set the new
1603
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1604
# we have to pull the merge trees out again, because
1605
# merge_inner has set the ids. - this corner is not yet
1606
# layered well enough to prevent double handling.
1607
# XXX TODO: Fix the double handling: telling the tree about
1608
# the already known parent data is wasteful.
1609
merges = self.get_parent_ids()[1:]
1610
parent_trees.extend([
1611
(parent, repository.revision_tree(parent)) for
1613
self.set_parent_trees(parent_trees)
1620
def put_file_bytes_non_atomic(self, file_id, bytes):
1621
"""See MutableTree.put_file_bytes_non_atomic."""
1622
stream = file(self.id2abspath(file_id), 'wb')
1627
# TODO: update the hashcache here ?
1630
"""Yield all unversioned files in this WorkingTree.
1632
If there are any unversioned directories then only the directory is
1633
returned, not all its children. But if there are unversioned files
1634
under a versioned subdirectory, they are returned.
1636
Currently returned depth-first, sorted by name within directories.
1637
This is the same order used by 'osutils.walkdirs'.
1639
## TODO: Work from given directory downwards
1640
for path, dir_entry in self.inventory.directories():
1641
# mutter("search for unknowns in %r", path)
1642
dirabs = self.abspath(path)
1643
if not isdir(dirabs):
1644
# e.g. directory deleted
1648
for subf in os.listdir(dirabs):
1651
if subf not in dir_entry.children:
1652
subf_norm, can_access = osutils.normalized_filename(subf)
1653
if subf_norm != subf and can_access:
1654
if subf_norm not in dir_entry.children:
1655
fl.append(subf_norm)
1661
subp = pathjoin(path, subf)
1664
def ignored_files(self):
1665
"""Yield list of PATH, IGNORE_PATTERN"""
1666
for subp in self.extras():
1667
pat = self.is_ignored(subp)
1671
def get_ignore_list(self):
1672
"""Return list of ignore patterns.
1674
Cached in the Tree object after the first call.
1676
ignoreset = getattr(self, '_ignoreset', None)
1677
if ignoreset is not None:
1680
ignore_globs = set()
1681
ignore_globs.update(ignores.get_runtime_ignores())
1682
ignore_globs.update(ignores.get_user_ignores())
1683
if self.has_filename(bzrlib.IGNORE_FILENAME):
1684
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1686
ignore_globs.update(ignores.parse_ignore_file(f))
1689
self._ignoreset = ignore_globs
1692
def _flush_ignore_list_cache(self):
1693
"""Resets the cached ignore list to force a cache rebuild."""
1694
self._ignoreset = None
1695
self._ignoreglobster = None
1697
def is_ignored(self, filename):
1698
r"""Check whether the filename matches an ignore pattern.
1700
Patterns containing '/' or '\' need to match the whole path;
1701
others match against only the last component.
1703
If the file is ignored, returns the pattern which caused it to
1704
be ignored, otherwise None. So this can simply be used as a
1705
boolean if desired."""
1706
if getattr(self, '_ignoreglobster', None) is None:
1707
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1708
return self._ignoreglobster.match(filename)
1710
def kind(self, file_id):
1711
return file_kind(self.id2abspath(file_id))
1713
def stored_kind(self, file_id):
1714
"""See Tree.stored_kind"""
1715
return self.inventory[file_id].kind
1717
def _comparison_data(self, entry, path):
1718
abspath = self.abspath(path)
1720
stat_value = os.lstat(abspath)
1722
if getattr(e, 'errno', None) == errno.ENOENT:
1729
mode = stat_value.st_mode
1730
kind = osutils.file_kind_from_stat_mode(mode)
1731
if not supports_executable():
1732
executable = entry is not None and entry.executable
1734
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1735
return kind, executable, stat_value
1737
def _file_size(self, entry, stat_value):
1738
return stat_value.st_size
1740
def last_revision(self):
1741
"""Return the last revision of the branch for this tree.
1743
This format tree does not support a separate marker for last-revision
1744
compared to the branch.
1746
See MutableTree.last_revision
1748
return self._last_revision()
1751
def _last_revision(self):
1752
"""helper for get_parent_ids."""
1753
return _mod_revision.ensure_null(self.branch.last_revision())
1755
def is_locked(self):
1756
return self._control_files.is_locked()
1758
def _must_be_locked(self):
1759
if not self.is_locked():
1760
raise errors.ObjectNotLocked(self)
1762
def lock_read(self):
1763
"""See Branch.lock_read, and WorkingTree.unlock."""
1764
if not self.is_locked():
1766
self.branch.lock_read()
1768
return self._control_files.lock_read()
1770
self.branch.unlock()
1773
def lock_tree_write(self):
1774
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1775
if not self.is_locked():
1777
self.branch.lock_read()
1779
return self._control_files.lock_write()
1781
self.branch.unlock()
1784
def lock_write(self):
1785
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1786
if not self.is_locked():
1788
self.branch.lock_write()
1790
return self._control_files.lock_write()
1792
self.branch.unlock()
1795
def get_physical_lock_status(self):
1796
return self._control_files.get_physical_lock_status()
1798
def _basis_inventory_name(self):
1799
return 'basis-inventory-cache'
1801
def _reset_data(self):
1802
"""Reset transient data that cannot be revalidated."""
1803
self._inventory_is_modified = False
1804
result = self._deserialize(self._transport.get('inventory'))
1805
self._set_inventory(result, dirty=False)
1807
@needs_tree_write_lock
1808
def set_last_revision(self, new_revision):
1809
"""Change the last revision in the working tree."""
1810
if self._change_last_revision(new_revision):
1811
self._cache_basis_inventory(new_revision)
1813
def _change_last_revision(self, new_revision):
1814
"""Template method part of set_last_revision to perform the change.
1816
This is used to allow WorkingTree3 instances to not affect branch
1817
when their last revision is set.
1819
if _mod_revision.is_null(new_revision):
1820
self.branch.set_revision_history([])
1823
self.branch.generate_revision_history(new_revision)
1824
except errors.NoSuchRevision:
1825
# not present in the repo - dont try to set it deeper than the tip
1826
self.branch.set_revision_history([new_revision])
1829
def _write_basis_inventory(self, xml):
1830
"""Write the basis inventory XML to the basis-inventory file"""
1831
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1832
path = self._basis_inventory_name()
1834
self._control_files.put(path, sio)
1836
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1837
"""Create the text that will be saved in basis-inventory"""
1838
inventory.revision_id = revision_id
1839
return xml7.serializer_v7.write_inventory_to_string(inventory)
1841
def _cache_basis_inventory(self, new_revision):
1842
"""Cache new_revision as the basis inventory."""
1843
# TODO: this should allow the ready-to-use inventory to be passed in,
1844
# as commit already has that ready-to-use [while the format is the
1847
# this double handles the inventory - unpack and repack -
1848
# but is easier to understand. We can/should put a conditional
1849
# in here based on whether the inventory is in the latest format
1850
# - perhaps we should repack all inventories on a repository
1852
# the fast path is to copy the raw xml from the repository. If the
1853
# xml contains 'revision_id="', then we assume the right
1854
# revision_id is set. We must check for this full string, because a
1855
# root node id can legitimately look like 'revision_id' but cannot
1857
xml = self.branch.repository.get_inventory_xml(new_revision)
1858
firstline = xml.split('\n', 1)[0]
1859
if (not 'revision_id="' in firstline or
1860
'format="7"' not in firstline):
1861
inv = self.branch.repository.deserialise_inventory(
1863
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1864
self._write_basis_inventory(xml)
1865
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1868
def read_basis_inventory(self):
1869
"""Read the cached basis inventory."""
1870
path = self._basis_inventory_name()
1871
return self._control_files._transport.get_bytes(path)
1874
def read_working_inventory(self):
1875
"""Read the working inventory.
1877
:raises errors.InventoryModified: read_working_inventory will fail
1878
when the current in memory inventory has been modified.
1880
# conceptually this should be an implementation detail of the tree.
1881
# XXX: Deprecate this.
1882
# ElementTree does its own conversion from UTF-8, so open in
1884
if self._inventory_is_modified:
1885
raise errors.InventoryModified(self)
1886
result = self._deserialize(self._control_files._transport.get('inventory'))
1887
self._set_inventory(result, dirty=False)
1890
@needs_tree_write_lock
1891
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1893
"""Remove nominated files from the working inventory.
1895
:files: File paths relative to the basedir.
1896
:keep_files: If true, the files will also be kept.
1897
:force: Delete files and directories, even if they are changed and
1898
even if the directories are not empty.
1900
if isinstance(files, basestring):
1906
unknown_nested_files=set()
1908
def recurse_directory_to_add_files(directory):
1909
# Recurse directory and add all files
1910
# so we can check if they have changed.
1911
for parent_info, file_infos in\
1912
osutils.walkdirs(self.abspath(directory),
1914
for relpath, basename, kind, lstat, abspath in file_infos:
1915
# Is it versioned or ignored?
1916
if self.path2id(relpath) or self.is_ignored(relpath):
1917
# Add nested content for deletion.
1918
new_files.add(relpath)
1920
# Files which are not versioned and not ignored
1921
# should be treated as unknown.
1922
unknown_nested_files.add((relpath, None, kind))
1924
for filename in files:
1925
# Get file name into canonical form.
1926
abspath = self.abspath(filename)
1927
filename = self.relpath(abspath)
1928
if len(filename) > 0:
1929
new_files.add(filename)
1930
if osutils.isdir(abspath):
1931
recurse_directory_to_add_files(filename)
1933
files = list(new_files)
1936
return # nothing to do
1938
# Sort needed to first handle directory content before the directory
1939
files.sort(reverse=True)
1941
# Bail out if we are going to delete files we shouldn't
1942
if not keep_files and not force:
1943
has_changed_files = len(unknown_nested_files) > 0
1944
if not has_changed_files:
1945
for (file_id, path, content_change, versioned, parent_id, name,
1946
kind, executable) in self.iter_changes(self.basis_tree(),
1947
include_unchanged=True, require_versioned=False,
1948
want_unversioned=True, specific_files=files):
1949
if versioned == (False, False):
1950
# The record is unknown ...
1951
if not self.is_ignored(path[1]):
1952
# ... but not ignored
1953
has_changed_files = True
1955
elif content_change and (kind[1] != None):
1956
# Versioned and changed, but not deleted
1957
has_changed_files = True
1960
if has_changed_files:
1961
# Make delta show ALL applicable changes in error message.
1962
tree_delta = self.changes_from(self.basis_tree(),
1963
require_versioned=False, want_unversioned=True,
1964
specific_files=files)
1965
for unknown_file in unknown_nested_files:
1966
if unknown_file not in tree_delta.unversioned:
1967
tree_delta.unversioned.extend((unknown_file,))
1968
raise errors.BzrRemoveChangedFilesError(tree_delta)
1970
# Build inv_delta and delete files where applicaple,
1971
# do this before any modifications to inventory.
1973
fid = self.path2id(f)
1976
message = "%s is not versioned." % (f,)
1979
# having removed it, it must be either ignored or unknown
1980
if self.is_ignored(f):
1984
textui.show_status(new_status, self.kind(fid), f,
1987
inv_delta.append((f, None, fid, None))
1988
message = "removed %s" % (f,)
1991
abs_path = self.abspath(f)
1992
if osutils.lexists(abs_path):
1993
if (osutils.isdir(abs_path) and
1994
len(os.listdir(abs_path)) > 0):
1996
osutils.rmtree(abs_path)
1998
message = "%s is not an empty directory "\
1999
"and won't be deleted." % (f,)
2001
osutils.delete_any(abs_path)
2002
message = "deleted %s" % (f,)
2003
elif message is not None:
2004
# Only care if we haven't done anything yet.
2005
message = "%s does not exist." % (f,)
2007
# Print only one message (if any) per file.
2008
if message is not None:
2010
self.apply_inventory_delta(inv_delta)
2012
@needs_tree_write_lock
2013
def revert(self, filenames=None, old_tree=None, backups=True,
2014
pb=DummyProgress(), report_changes=False):
2015
from bzrlib.conflicts import resolve
2018
symbol_versioning.warn('Using [] to revert all files is deprecated'
2019
' as of bzr 0.91. Please use None (the default) instead.',
2020
DeprecationWarning, stacklevel=2)
2021
if old_tree is None:
2022
basis_tree = self.basis_tree()
2023
basis_tree.lock_read()
2024
old_tree = basis_tree
2028
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2030
if filenames is None and len(self.get_parent_ids()) > 1:
2032
last_revision = self.last_revision()
2033
if last_revision != NULL_REVISION:
2034
if basis_tree is None:
2035
basis_tree = self.basis_tree()
2036
basis_tree.lock_read()
2037
parent_trees.append((last_revision, basis_tree))
2038
self.set_parent_trees(parent_trees)
2041
resolve(self, filenames, ignore_misses=True, recursive=True)
2043
if basis_tree is not None:
2047
def revision_tree(self, revision_id):
2048
"""See Tree.revision_tree.
2050
WorkingTree can supply revision_trees for the basis revision only
2051
because there is only one cached inventory in the bzr directory.
2053
if revision_id == self.last_revision():
2055
xml = self.read_basis_inventory()
2056
except errors.NoSuchFile:
2060
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2061
# dont use the repository revision_tree api because we want
2062
# to supply the inventory.
2063
if inv.revision_id == revision_id:
2064
return revisiontree.RevisionTree(self.branch.repository,
2066
except errors.BadInventoryFormat:
2068
# raise if there was no inventory, or if we read the wrong inventory.
2069
raise errors.NoSuchRevisionInTree(self, revision_id)
2071
# XXX: This method should be deprecated in favour of taking in a proper
2072
# new Inventory object.
2073
@needs_tree_write_lock
2074
def set_inventory(self, new_inventory_list):
2075
from bzrlib.inventory import (Inventory,
2080
inv = Inventory(self.get_root_id())
2081
for path, file_id, parent, kind in new_inventory_list:
2082
name = os.path.basename(path)
2085
# fixme, there should be a factory function inv,add_??
2086
if kind == 'directory':
2087
inv.add(InventoryDirectory(file_id, name, parent))
2088
elif kind == 'file':
2089
inv.add(InventoryFile(file_id, name, parent))
2090
elif kind == 'symlink':
2091
inv.add(InventoryLink(file_id, name, parent))
2093
raise errors.BzrError("unknown kind %r" % kind)
2094
self._write_inventory(inv)
2096
@needs_tree_write_lock
2097
def set_root_id(self, file_id):
2098
"""Set the root id for this tree."""
2101
symbol_versioning.warn(symbol_versioning.zero_twelve
2102
% 'WorkingTree.set_root_id with fileid=None',
2107
file_id = osutils.safe_file_id(file_id)
2108
self._set_root_id(file_id)
2110
def _set_root_id(self, file_id):
2111
"""Set the root id for this tree, in a format specific manner.
2113
:param file_id: The file id to assign to the root. It must not be
2114
present in the current inventory or an error will occur. It must
2115
not be None, but rather a valid file id.
2117
inv = self._inventory
2118
orig_root_id = inv.root.file_id
2119
# TODO: it might be nice to exit early if there was nothing
2120
# to do, saving us from trigger a sync on unlock.
2121
self._inventory_is_modified = True
2122
# we preserve the root inventory entry object, but
2123
# unlinkit from the byid index
2124
del inv._byid[inv.root.file_id]
2125
inv.root.file_id = file_id
2126
# and link it into the index with the new changed id.
2127
inv._byid[inv.root.file_id] = inv.root
2128
# and finally update all children to reference the new id.
2129
# XXX: this should be safe to just look at the root.children
2130
# list, not the WHOLE INVENTORY.
2133
if entry.parent_id == orig_root_id:
2134
entry.parent_id = inv.root.file_id
2137
"""See Branch.unlock.
2139
WorkingTree locking just uses the Branch locking facilities.
2140
This is current because all working trees have an embedded branch
2141
within them. IF in the future, we were to make branch data shareable
2142
between multiple working trees, i.e. via shared storage, then we
2143
would probably want to lock both the local tree, and the branch.
2145
raise NotImplementedError(self.unlock)
2147
def update(self, change_reporter=None, possible_transports=None):
2148
"""Update a working tree along its branch.
2150
This will update the branch if its bound too, which means we have
2151
multiple trees involved:
2153
- The new basis tree of the master.
2154
- The old basis tree of the branch.
2155
- The old basis tree of the working tree.
2156
- The current working tree state.
2158
Pathologically, all three may be different, and non-ancestors of each
2159
other. Conceptually we want to:
2161
- Preserve the wt.basis->wt.state changes
2162
- Transform the wt.basis to the new master basis.
2163
- Apply a merge of the old branch basis to get any 'local' changes from
2165
- Restore the wt.basis->wt.state changes.
2167
There isn't a single operation at the moment to do that, so we:
2168
- Merge current state -> basis tree of the master w.r.t. the old tree
2170
- Do a 'normal' merge of the old branch basis if it is relevant.
2172
if self.branch.get_bound_location() is not None:
2174
update_branch = True
2176
self.lock_tree_write()
2177
update_branch = False
2180
old_tip = self.branch.update(possible_transports)
2183
return self._update_tree(old_tip, change_reporter)
2187
@needs_tree_write_lock
2188
def _update_tree(self, old_tip=None, change_reporter=None):
2189
"""Update a tree to the master branch.
2191
:param old_tip: if supplied, the previous tip revision the branch,
2192
before it was changed to the master branch's tip.
2194
# here if old_tip is not None, it is the old tip of the branch before
2195
# it was updated from the master branch. This should become a pending
2196
# merge in the working tree to preserve the user existing work. we
2197
# cant set that until we update the working trees last revision to be
2198
# one from the new branch, because it will just get absorbed by the
2199
# parent de-duplication logic.
2201
# We MUST save it even if an error occurs, because otherwise the users
2202
# local work is unreferenced and will appear to have been lost.
2206
last_rev = self.get_parent_ids()[0]
2208
last_rev = _mod_revision.NULL_REVISION
2209
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2210
# merge tree state up to new branch tip.
2211
basis = self.basis_tree()
2214
to_tree = self.branch.basis_tree()
2215
if basis.inventory.root is None:
2216
self.set_root_id(to_tree.get_root_id())
2218
result += merge.merge_inner(
2223
change_reporter=change_reporter)
2226
# TODO - dedup parents list with things merged by pull ?
2227
# reuse the tree we've updated to to set the basis:
2228
parent_trees = [(self.branch.last_revision(), to_tree)]
2229
merges = self.get_parent_ids()[1:]
2230
# Ideally we ask the tree for the trees here, that way the working
2231
# tree can decide whether to give us teh entire tree or give us a
2232
# lazy initialised tree. dirstate for instance will have the trees
2233
# in ram already, whereas a last-revision + basis-inventory tree
2234
# will not, but also does not need them when setting parents.
2235
for parent in merges:
2236
parent_trees.append(
2237
(parent, self.branch.repository.revision_tree(parent)))
2238
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2239
parent_trees.append(
2240
(old_tip, self.branch.repository.revision_tree(old_tip)))
2241
self.set_parent_trees(parent_trees)
2242
last_rev = parent_trees[0][0]
2244
# the working tree had the same last-revision as the master
2245
# branch did. We may still have pivot local work from the local
2246
# branch into old_tip:
2247
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2248
self.add_parent_tree_id(old_tip)
2249
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2250
and old_tip != last_rev):
2251
# our last revision was not the prior branch last revision
2252
# and we have converted that last revision to a pending merge.
2253
# base is somewhere between the branch tip now
2254
# and the now pending merge
2256
# Since we just modified the working tree and inventory, flush out
2257
# the current state, before we modify it again.
2258
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2259
# requires it only because TreeTransform directly munges the
2260
# inventory and calls tree._write_inventory(). Ultimately we
2261
# should be able to remove this extra flush.
2263
graph = self.branch.repository.get_graph()
2264
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2266
base_tree = self.branch.repository.revision_tree(base_rev_id)
2267
other_tree = self.branch.repository.revision_tree(old_tip)
2268
result += merge.merge_inner(
2273
change_reporter=change_reporter)
2276
def _write_hashcache_if_dirty(self):
2277
"""Write out the hashcache if it is dirty."""
2278
if self._hashcache.needs_write:
2280
self._hashcache.write()
2282
if e.errno not in (errno.EPERM, errno.EACCES):
2284
# TODO: jam 20061219 Should this be a warning? A single line
2285
# warning might be sufficient to let the user know what
2287
mutter('Could not write hashcache for %s\nError: %s',
2288
self._hashcache.cache_file_name(), e)
2290
@needs_tree_write_lock
2291
def _write_inventory(self, inv):
2292
"""Write inventory as the current inventory."""
2293
self._set_inventory(inv, dirty=True)
2296
def set_conflicts(self, arg):
2297
raise errors.UnsupportedOperation(self.set_conflicts, self)
2299
def add_conflicts(self, arg):
2300
raise errors.UnsupportedOperation(self.add_conflicts, self)
2303
def conflicts(self):
2304
conflicts = _mod_conflicts.ConflictList()
2305
for conflicted in self._iter_conflicts():
2308
if file_kind(self.abspath(conflicted)) != "file":
2310
except errors.NoSuchFile:
2313
for suffix in ('.THIS', '.OTHER'):
2315
kind = file_kind(self.abspath(conflicted+suffix))
2318
except errors.NoSuchFile:
2322
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2323
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2325
file_id=self.path2id(conflicted)))
2328
def walkdirs(self, prefix=""):
2329
"""Walk the directories of this tree.
2331
returns a generator which yields items in the form:
2332
((curren_directory_path, fileid),
2333
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2336
This API returns a generator, which is only valid during the current
2337
tree transaction - within a single lock_read or lock_write duration.
2339
If the tree is not locked, it may cause an error to be raised,
2340
depending on the tree implementation.
2342
disk_top = self.abspath(prefix)
2343
if disk_top.endswith('/'):
2344
disk_top = disk_top[:-1]
2345
top_strip_len = len(disk_top) + 1
2346
inventory_iterator = self._walkdirs(prefix)
2347
disk_iterator = osutils.walkdirs(disk_top, prefix)
2349
current_disk = disk_iterator.next()
2350
disk_finished = False
2352
if not (e.errno == errno.ENOENT or
2353
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2356
disk_finished = True
2358
current_inv = inventory_iterator.next()
2359
inv_finished = False
2360
except StopIteration:
2363
while not inv_finished or not disk_finished:
2365
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2366
cur_disk_dir_content) = current_disk
2368
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2369
cur_disk_dir_content) = ((None, None), None)
2370
if not disk_finished:
2371
# strip out .bzr dirs
2372
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2373
len(cur_disk_dir_content) > 0):
2374
# osutils.walkdirs can be made nicer -
2375
# yield the path-from-prefix rather than the pathjoined
2377
bzrdir_loc = bisect_left(cur_disk_dir_content,
2379
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2380
# we dont yield the contents of, or, .bzr itself.
2381
del cur_disk_dir_content[bzrdir_loc]
2383
# everything is unknown
2386
# everything is missing
2389
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2391
# disk is before inventory - unknown
2392
dirblock = [(relpath, basename, kind, stat, None, None) for
2393
relpath, basename, kind, stat, top_path in
2394
cur_disk_dir_content]
2395
yield (cur_disk_dir_relpath, None), dirblock
2397
current_disk = disk_iterator.next()
2398
except StopIteration:
2399
disk_finished = True
2401
# inventory is before disk - missing.
2402
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2403
for relpath, basename, dkind, stat, fileid, kind in
2405
yield (current_inv[0][0], current_inv[0][1]), dirblock
2407
current_inv = inventory_iterator.next()
2408
except StopIteration:
2411
# versioned present directory
2412
# merge the inventory and disk data together
2414
for relpath, subiterator in itertools.groupby(sorted(
2415
current_inv[1] + cur_disk_dir_content,
2416
key=operator.itemgetter(0)), operator.itemgetter(1)):
2417
path_elements = list(subiterator)
2418
if len(path_elements) == 2:
2419
inv_row, disk_row = path_elements
2420
# versioned, present file
2421
dirblock.append((inv_row[0],
2422
inv_row[1], disk_row[2],
2423
disk_row[3], inv_row[4],
2425
elif len(path_elements[0]) == 5:
2427
dirblock.append((path_elements[0][0],
2428
path_elements[0][1], path_elements[0][2],
2429
path_elements[0][3], None, None))
2430
elif len(path_elements[0]) == 6:
2431
# versioned, absent file.
2432
dirblock.append((path_elements[0][0],
2433
path_elements[0][1], 'unknown', None,
2434
path_elements[0][4], path_elements[0][5]))
2436
raise NotImplementedError('unreachable code')
2437
yield current_inv[0], dirblock
2439
current_inv = inventory_iterator.next()
2440
except StopIteration:
2443
current_disk = disk_iterator.next()
2444
except StopIteration:
2445
disk_finished = True
2447
def _walkdirs(self, prefix=""):
2448
"""Walk the directories of this tree.
2450
:prefix: is used as the directrory to start with.
2451
returns a generator which yields items in the form:
2452
((curren_directory_path, fileid),
2453
[(file1_path, file1_name, file1_kind, None, file1_id,
2456
_directory = 'directory'
2457
# get the root in the inventory
2458
inv = self.inventory
2459
top_id = inv.path2id(prefix)
2463
pending = [(prefix, '', _directory, None, top_id, None)]
2466
currentdir = pending.pop()
2467
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2468
top_id = currentdir[4]
2470
relroot = currentdir[0] + '/'
2473
# FIXME: stash the node in pending
2475
for name, child in entry.sorted_children():
2476
dirblock.append((relroot + name, name, child.kind, None,
2477
child.file_id, child.kind
2479
yield (currentdir[0], entry.file_id), dirblock
2480
# push the user specified dirs from dirblock
2481
for dir in reversed(dirblock):
2482
if dir[2] == _directory:
2485
@needs_tree_write_lock
2486
def auto_resolve(self):
2487
"""Automatically resolve text conflicts according to contents.
2489
Only text conflicts are auto_resolvable. Files with no conflict markers
2490
are considered 'resolved', because bzr always puts conflict markers
2491
into files that have text conflicts. The corresponding .THIS .BASE and
2492
.OTHER files are deleted, as per 'resolve'.
2493
:return: a tuple of ConflictLists: (un_resolved, resolved).
2495
un_resolved = _mod_conflicts.ConflictList()
2496
resolved = _mod_conflicts.ConflictList()
2497
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2498
for conflict in self.conflicts():
2499
if (conflict.typestring != 'text conflict' or
2500
self.kind(conflict.file_id) != 'file'):
2501
un_resolved.append(conflict)
2503
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2505
for line in my_file:
2506
if conflict_re.search(line):
2507
un_resolved.append(conflict)
2510
resolved.append(conflict)
2513
resolved.remove_files(self)
2514
self.set_conflicts(un_resolved)
2515
return un_resolved, resolved
2517
def _validate(self):
2518
"""Validate internal structures.
2520
This is meant mostly for the test suite. To give it a chance to detect
2521
corruption after actions have occurred. The default implementation is a
2524
:return: None. An exception should be raised if there is an error.
2529
class WorkingTree2(WorkingTree):
2530
"""This is the Format 2 working tree.
2532
This was the first weave based working tree.
2533
- uses os locks for locking.
2534
- uses the branch last-revision.
2537
def __init__(self, *args, **kwargs):
2538
super(WorkingTree2, self).__init__(*args, **kwargs)
2539
# WorkingTree2 has more of a constraint that self._inventory must
2540
# exist. Because this is an older format, we don't mind the overhead
2541
# caused by the extra computation here.
2543
# Newer WorkingTree's should only have self._inventory set when they
2545
if self._inventory is None:
2546
self.read_working_inventory()
2548
def lock_tree_write(self):
2549
"""See WorkingTree.lock_tree_write().
2551
In Format2 WorkingTrees we have a single lock for the branch and tree
2552
so lock_tree_write() degrades to lock_write().
2554
self.branch.lock_write()
2556
return self._control_files.lock_write()
2558
self.branch.unlock()
2562
# do non-implementation specific cleanup
2565
# we share control files:
2566
if self._control_files._lock_count == 3:
2567
# _inventory_is_modified is always False during a read lock.
2568
if self._inventory_is_modified:
2570
self._write_hashcache_if_dirty()
2572
# reverse order of locking.
2574
return self._control_files.unlock()
2576
self.branch.unlock()
2579
class WorkingTree3(WorkingTree):
2580
"""This is the Format 3 working tree.
2582
This differs from the base WorkingTree by:
2583
- having its own file lock
2584
- having its own last-revision property.
2586
This is new in bzr 0.8
2590
def _last_revision(self):
2591
"""See Mutable.last_revision."""
2593
return self._transport.get_bytes('last-revision')
2594
except errors.NoSuchFile:
2595
return _mod_revision.NULL_REVISION
2597
def _change_last_revision(self, revision_id):
2598
"""See WorkingTree._change_last_revision."""
2599
if revision_id is None or revision_id == NULL_REVISION:
2601
self._control_files._transport.delete('last-revision')
2602
except errors.NoSuchFile:
2606
self._control_files.put_bytes('last-revision', revision_id)
2609
@needs_tree_write_lock
2610
def set_conflicts(self, conflicts):
2611
self._put_rio('conflicts', conflicts.to_stanzas(),
2614
@needs_tree_write_lock
2615
def add_conflicts(self, new_conflicts):
2616
conflict_set = set(self.conflicts())
2617
conflict_set.update(set(list(new_conflicts)))
2618
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2619
key=_mod_conflicts.Conflict.sort_key)))
2622
def conflicts(self):
2624
confile = self._transport.get('conflicts')
2625
except errors.NoSuchFile:
2626
return _mod_conflicts.ConflictList()
2628
if confile.next() != CONFLICT_HEADER_1 + '\n':
2629
raise errors.ConflictFormatError()
2630
except StopIteration:
2631
raise errors.ConflictFormatError()
2632
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2635
# do non-implementation specific cleanup
2637
if self._control_files._lock_count == 1:
2638
# _inventory_is_modified is always False during a read lock.
2639
if self._inventory_is_modified:
2641
self._write_hashcache_if_dirty()
2642
# reverse order of locking.
2644
return self._control_files.unlock()
2646
self.branch.unlock()
2649
def get_conflicted_stem(path):
2650
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2651
if path.endswith(suffix):
2652
return path[:-len(suffix)]
2655
@deprecated_function(zero_eight)
2656
def is_control_file(filename):
2657
"""See WorkingTree.is_control_filename(filename)."""
2658
## FIXME: better check
2659
filename = normpath(filename)
2660
while filename != '':
2661
head, tail = os.path.split(filename)
2662
## mutter('check %r for control file' % ((head, tail),))
2665
if filename == head:
2671
class WorkingTreeFormat(object):
2672
"""An encapsulation of the initialization and open routines for a format.
2674
Formats provide three things:
2675
* An initialization routine,
2679
Formats are placed in an dict by their format string for reference
2680
during workingtree opening. Its not required that these be instances, they
2681
can be classes themselves with class methods - it simply depends on
2682
whether state is needed for a given format or not.
2684
Once a format is deprecated, just deprecate the initialize and open
2685
methods on the format class. Do not deprecate the object, as the
2686
object will be created every time regardless.
2689
_default_format = None
2690
"""The default format used for new trees."""
2693
"""The known formats."""
2695
requires_rich_root = False
2697
upgrade_recommended = False
2700
def find_format(klass, a_bzrdir):
2701
"""Return the format for the working tree object in a_bzrdir."""
2703
transport = a_bzrdir.get_workingtree_transport(None)
2704
format_string = transport.get("format").read()
2705
return klass._formats[format_string]
2706
except errors.NoSuchFile:
2707
raise errors.NoWorkingTree(base=transport.base)
2709
raise errors.UnknownFormatError(format=format_string,
2710
kind="working tree")
2712
def __eq__(self, other):
2713
return self.__class__ is other.__class__
2715
def __ne__(self, other):
2716
return not (self == other)
2719
def get_default_format(klass):
2720
"""Return the current default format."""
2721
return klass._default_format
2723
def get_format_string(self):
2724
"""Return the ASCII format string that identifies this format."""
2725
raise NotImplementedError(self.get_format_string)
2727
def get_format_description(self):
2728
"""Return the short description for this format."""
2729
raise NotImplementedError(self.get_format_description)
2731
def is_supported(self):
2732
"""Is this format supported?
2734
Supported formats can be initialized and opened.
2735
Unsupported formats may not support initialization or committing or
2736
some other features depending on the reason for not being supported.
2741
def register_format(klass, format):
2742
klass._formats[format.get_format_string()] = format
2745
def set_default_format(klass, format):
2746
klass._default_format = format
2749
def unregister_format(klass, format):
2750
assert klass._formats[format.get_format_string()] is format
2751
del klass._formats[format.get_format_string()]
2754
class WorkingTreeFormat2(WorkingTreeFormat):
2755
"""The second working tree format.
2757
This format modified the hash cache from the format 1 hash cache.
2760
upgrade_recommended = True
2762
def get_format_description(self):
2763
"""See WorkingTreeFormat.get_format_description()."""
2764
return "Working tree format 2"
2766
def stub_initialize_remote(self, control_files):
2767
"""As a special workaround create critical control files for a remote working tree
2769
This ensures that it can later be updated and dealt with locally,
2770
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2771
no working tree. (See bug #43064).
2775
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2777
control_files.put('inventory', sio)
2779
control_files.put_bytes('pending-merges', '')
2782
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2783
accelerator_tree=None, hardlink=False):
2784
"""See WorkingTreeFormat.initialize()."""
2785
if not isinstance(a_bzrdir.transport, LocalTransport):
2786
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2787
if from_branch is not None:
2788
branch = from_branch
2790
branch = a_bzrdir.open_branch()
2791
if revision_id is None:
2792
revision_id = _mod_revision.ensure_null(branch.last_revision())
2795
branch.generate_revision_history(revision_id)
2799
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2805
basis_tree = branch.repository.revision_tree(revision_id)
2806
if basis_tree.inventory.root is not None:
2807
wt.set_root_id(basis_tree.get_root_id())
2808
# set the parent list and cache the basis tree.
2809
if _mod_revision.is_null(revision_id):
2812
parent_trees = [(revision_id, basis_tree)]
2813
wt.set_parent_trees(parent_trees)
2814
transform.build_tree(basis_tree, wt)
2818
super(WorkingTreeFormat2, self).__init__()
2819
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2821
def open(self, a_bzrdir, _found=False):
2822
"""Return the WorkingTree object for a_bzrdir
2824
_found is a private parameter, do not use it. It is used to indicate
2825
if format probing has already been done.
2828
# we are being called directly and must probe.
2829
raise NotImplementedError
2830
if not isinstance(a_bzrdir.transport, LocalTransport):
2831
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2832
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2838
class WorkingTreeFormat3(WorkingTreeFormat):
2839
"""The second working tree format updated to record a format marker.
2842
- exists within a metadir controlling .bzr
2843
- includes an explicit version marker for the workingtree control
2844
files, separate from the BzrDir format
2845
- modifies the hash cache format
2847
- uses a LockDir to guard access for writes.
2850
upgrade_recommended = True
2852
def get_format_string(self):
2853
"""See WorkingTreeFormat.get_format_string()."""
2854
return "Bazaar-NG Working Tree format 3"
2856
def get_format_description(self):
2857
"""See WorkingTreeFormat.get_format_description()."""
2858
return "Working tree format 3"
2860
_lock_file_name = 'lock'
2861
_lock_class = LockDir
2863
_tree_class = WorkingTree3
2865
def __get_matchingbzrdir(self):
2866
return bzrdir.BzrDirMetaFormat1()
2868
_matchingbzrdir = property(__get_matchingbzrdir)
2870
def _open_control_files(self, a_bzrdir):
2871
transport = a_bzrdir.get_workingtree_transport(None)
2872
return LockableFiles(transport, self._lock_file_name,
2875
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2876
accelerator_tree=None, hardlink=False):
2877
"""See WorkingTreeFormat.initialize().
2879
:param revision_id: if supplied, create a working tree at a different
2880
revision than the branch is at.
2881
:param accelerator_tree: A tree which can be used for retrieving file
2882
contents more quickly than the revision tree, i.e. a workingtree.
2883
The revision tree will be used for cases where accelerator_tree's
2884
content is different.
2885
:param hardlink: If true, hard-link files from accelerator_tree,
2888
if not isinstance(a_bzrdir.transport, LocalTransport):
2889
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2890
transport = a_bzrdir.get_workingtree_transport(self)
2891
control_files = self._open_control_files(a_bzrdir)
2892
control_files.create_lock()
2893
control_files.lock_write()
2894
transport.put_bytes('format', self.get_format_string(),
2895
mode=control_files._file_mode)
2896
if from_branch is not None:
2897
branch = from_branch
2899
branch = a_bzrdir.open_branch()
2900
if revision_id is None:
2901
revision_id = _mod_revision.ensure_null(branch.last_revision())
2902
# WorkingTree3 can handle an inventory which has a unique root id.
2903
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2904
# those trees. And because there isn't a format bump inbetween, we
2905
# are maintaining compatibility with older clients.
2906
# inv = Inventory(root_id=gen_root_id())
2907
inv = self._initial_inventory()
2908
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2914
_control_files=control_files)
2915
wt.lock_tree_write()
2917
basis_tree = branch.repository.revision_tree(revision_id)
2918
# only set an explicit root id if there is one to set.
2919
if basis_tree.inventory.root is not None:
2920
wt.set_root_id(basis_tree.get_root_id())
2921
if revision_id == NULL_REVISION:
2922
wt.set_parent_trees([])
2924
wt.set_parent_trees([(revision_id, basis_tree)])
2925
transform.build_tree(basis_tree, wt)
2927
# Unlock in this order so that the unlock-triggers-flush in
2928
# WorkingTree is given a chance to fire.
2929
control_files.unlock()
2933
def _initial_inventory(self):
2937
super(WorkingTreeFormat3, self).__init__()
2939
def open(self, a_bzrdir, _found=False):
2940
"""Return the WorkingTree object for a_bzrdir
2942
_found is a private parameter, do not use it. It is used to indicate
2943
if format probing has already been done.
2946
# we are being called directly and must probe.
2947
raise NotImplementedError
2948
if not isinstance(a_bzrdir.transport, LocalTransport):
2949
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2950
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2953
def _open(self, a_bzrdir, control_files):
2954
"""Open the tree itself.
2956
:param a_bzrdir: the dir for the tree.
2957
:param control_files: the control files for the tree.
2959
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2963
_control_files=control_files)
2966
return self.get_format_string()
2969
__default_format = WorkingTreeFormat4()
2970
WorkingTreeFormat.register_format(__default_format)
2971
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2972
WorkingTreeFormat.set_default_format(__default_format)
2973
# formats which have no format string are not discoverable
2974
# and not independently creatable, so are not registered.
2975
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
