1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
assert isinstance(basedir, basestring), \
226
"base directory %r is not a string" % basedir
227
basedir = safe_unicode(basedir)
228
mutter("opening working tree %r", basedir)
229
if deprecated_passed(branch):
230
self._branch = branch
232
self._branch = self.bzrdir.open_branch()
233
self.basedir = realpath(basedir)
234
# if branch is at our basedir and is a format 6 or less
235
if isinstance(self._format, WorkingTreeFormat2):
236
# share control object
237
self._control_files = self.branch.control_files
239
# assume all other formats have their own control files.
240
assert isinstance(_control_files, LockableFiles), \
241
"_control_files must be a LockableFiles, not %r" \
243
self._control_files = _control_files
244
# update the whole cache up front and write to disk if anything changed;
245
# in the future we might want to do this more selectively
246
# two possible ways offer themselves : in self._unlock, write the cache
247
# if needed, or, when the cache sees a change, append it to the hash
248
# cache file, and have the parser take the most recent entry for a
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
251
cache_filename = wt_trans.local_abspath('stat-cache')
252
self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
self._control_files._file_mode)
256
# is this scan needed ? it makes things kinda slow.
263
if _inventory is None:
264
# This will be acquired on lock_read() or lock_write()
265
self._inventory_is_modified = False
266
self._inventory = None
268
# the caller of __init__ has provided an inventory,
269
# we assume they know what they are doing - as its only
270
# the Format factory and creation methods that are
271
# permitted to do this.
272
self._set_inventory(_inventory, dirty=False)
273
self._detect_case_handling()
275
def _detect_case_handling(self):
276
wt_trans = self.bzrdir.get_workingtree_transport(None)
278
wt_trans.stat("FoRMaT")
279
except errors.NoSuchFile:
280
self.case_sensitive = True
282
self.case_sensitive = False
284
self._setup_directory_is_tree_reference()
287
fget=lambda self: self._branch,
288
doc="""The branch this WorkingTree is connected to.
290
This cannot be set - it is reflective of the actual disk structure
291
the working tree has been constructed from.
294
def break_lock(self):
295
"""Break a lock if one is present from another instance.
297
Uses the ui factory to ask for confirmation if the lock may be from
300
This will probe the repository for its lock as well.
302
self._control_files.break_lock()
303
self.branch.break_lock()
305
def requires_rich_root(self):
306
return self._format.requires_rich_root
308
def supports_tree_reference(self):
311
def _set_inventory(self, inv, dirty):
312
"""Set the internal cached inventory.
314
:param inv: The inventory to set.
315
:param dirty: A boolean indicating whether the inventory is the same
316
logical inventory as whats on disk. If True the inventory is not
317
the same and should be written to disk or data will be lost, if
318
False then the inventory is the same as that on disk and any
319
serialisation would be unneeded overhead.
321
assert inv.root is not None
322
self._inventory = inv
323
self._inventory_is_modified = dirty
326
def open(path=None, _unsupported=False):
327
"""Open an existing working tree at path.
331
path = os.path.getcwdu()
332
control = bzrdir.BzrDir.open(path, _unsupported)
333
return control.open_workingtree(_unsupported)
336
def open_containing(path=None):
337
"""Open an existing working tree which has its root about path.
339
This probes for a working tree at path and searches upwards from there.
341
Basically we keep looking up until we find the control directory or
342
run into /. If there isn't one, raises NotBranchError.
343
TODO: give this a new exception.
344
If there is one, it is returned, along with the unused portion of path.
346
:return: The WorkingTree that contains 'path', and the rest of path
349
path = osutils.getcwd()
350
control, relpath = bzrdir.BzrDir.open_containing(path)
352
return control.open_workingtree(), relpath
355
def open_downlevel(path=None):
356
"""Open an unsupported working tree.
358
Only intended for advanced situations like upgrading part of a bzrdir.
360
return WorkingTree.open(path, _unsupported=True)
363
def find_trees(location):
364
def list_current(transport):
365
return [d for d in transport.list_dir('') if d != '.bzr']
366
def evaluate(bzrdir):
368
tree = bzrdir.open_workingtree()
369
except errors.NoWorkingTree:
373
transport = get_transport(location)
374
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
375
list_current=list_current)
376
return [t for t in iterator if t is not None]
378
# should be deprecated - this is slow and in any case treating them as a
379
# container is (we now know) bad style -- mbp 20070302
380
## @deprecated_method(zero_fifteen)
382
"""Iterate through file_ids for this tree.
384
file_ids are in a WorkingTree if they are in the working inventory
385
and the working file exists.
387
inv = self._inventory
388
for path, ie in inv.iter_entries():
389
if osutils.lexists(self.abspath(path)):
392
def all_file_ids(self):
393
"""See Tree.iter_all_file_ids"""
394
return set(self.inventory)
397
return "<%s of %s>" % (self.__class__.__name__,
398
getattr(self, 'basedir', None))
400
def abspath(self, filename):
401
return pathjoin(self.basedir, filename)
403
def basis_tree(self):
404
"""Return RevisionTree for the current last revision.
406
If the left most parent is a ghost then the returned tree will be an
407
empty tree - one obtained by calling repository.revision_tree(None).
410
revision_id = self.get_parent_ids()[0]
412
# no parents, return an empty revision tree.
413
# in the future this should return the tree for
414
# 'empty:' - the implicit root empty tree.
415
return self.branch.repository.revision_tree(None)
417
return self.revision_tree(revision_id)
418
except errors.NoSuchRevision:
420
# No cached copy available, retrieve from the repository.
421
# FIXME? RBC 20060403 should we cache the inventory locally
424
return self.branch.repository.revision_tree(revision_id)
425
except errors.RevisionNotPresent:
426
# the basis tree *may* be a ghost or a low level error may have
427
# occured. If the revision is present, its a problem, if its not
429
if self.branch.repository.has_revision(revision_id):
431
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(None)
435
self._flush_ignore_list_cache()
438
@deprecated_method(zero_eight)
439
def create(branch, directory):
440
"""Create a workingtree for branch at directory.
442
If existing_directory already exists it must have a .bzr directory.
443
If it does not exist, it will be created.
445
This returns a new WorkingTree object for the new checkout.
447
TODO FIXME RBC 20060124 when we have checkout formats in place this
448
should accept an optional revisionid to checkout [and reject this if
449
checking out into the same dir as a pre-checkout-aware branch format.]
451
XXX: When BzrDir is present, these should be created through that
454
warnings.warn('delete WorkingTree.create', stacklevel=3)
455
transport = get_transport(directory)
456
if branch.bzrdir.root_transport.base == transport.base:
458
return branch.bzrdir.create_workingtree()
459
# different directory,
460
# create a branch reference
461
# and now a working tree.
462
raise NotImplementedError
465
@deprecated_method(zero_eight)
466
def create_standalone(directory):
467
"""Create a checkout and a branch and a repo at directory.
469
Directory must exist and be empty.
471
please use BzrDir.create_standalone_workingtree
473
return bzrdir.BzrDir.create_standalone_workingtree(directory)
475
def relpath(self, path):
476
"""Return the local path portion from a given path.
478
The path may be absolute or relative. If its a relative path it is
479
interpreted relative to the python current working directory.
481
return osutils.relpath(self.basedir, path)
483
def has_filename(self, filename):
484
return osutils.lexists(self.abspath(filename))
486
def get_file(self, file_id, path=None):
488
path = self.id2path(file_id)
489
return self.get_file_byname(path)
491
def get_file_text(self, file_id):
492
return self.get_file(file_id).read()
494
def get_file_byname(self, filename):
495
return file(self.abspath(filename), 'rb')
498
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
499
"""See Tree.annotate_iter
501
This implementation will use the basis tree implementation if possible.
502
Lines not in the basis are attributed to CURRENT_REVISION
504
If there are pending merges, lines added by those merges will be
505
incorrectly attributed to CURRENT_REVISION (but after committing, the
506
attribution will be correct).
508
basis = self.basis_tree()
511
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
512
require_versioned=True).next()
513
changed_content, kind = changes[2], changes[6]
514
if not changed_content:
515
return basis.annotate_iter(file_id)
519
if kind[0] != 'file':
522
old_lines = list(basis.annotate_iter(file_id))
524
for tree in self.branch.repository.revision_trees(
525
self.get_parent_ids()[1:]):
526
if file_id not in tree:
528
old.append(list(tree.annotate_iter(file_id)))
529
return annotate.reannotate(old, self.get_file(file_id).readlines(),
534
def _get_ancestors(self, default_revision):
535
ancestors = set([default_revision])
536
for parent_id in self.get_parent_ids():
537
ancestors.update(self.branch.repository.get_ancestry(
538
parent_id, topo_sorted=False))
541
def get_parent_ids(self):
542
"""See Tree.get_parent_ids.
544
This implementation reads the pending merges list and last_revision
545
value and uses that to decide what the parents list should be.
547
last_rev = _mod_revision.ensure_null(self._last_revision())
548
if _mod_revision.NULL_REVISION == last_rev:
553
merges_file = self._control_files.get('pending-merges')
554
except errors.NoSuchFile:
557
for l in merges_file.readlines():
558
revision_id = l.rstrip('\n')
559
parents.append(revision_id)
563
def get_root_id(self):
564
"""Return the id of this trees root"""
565
return self._inventory.root.file_id
567
def _get_store_filename(self, file_id):
568
## XXX: badly named; this is not in the store at all
569
return self.abspath(self.id2path(file_id))
572
def clone(self, to_bzrdir, revision_id=None):
573
"""Duplicate this working tree into to_bzr, including all state.
575
Specifically modified files are kept as modified, but
576
ignored and unknown files are discarded.
578
If you want to make a new line of development, see bzrdir.sprout()
581
If not None, the cloned tree will have its last revision set to
582
revision, and and difference between the source trees last revision
583
and this one merged in.
585
# assumes the target bzr dir format is compatible.
586
result = self._format.initialize(to_bzrdir)
587
self.copy_content_into(result, revision_id)
591
def copy_content_into(self, tree, revision_id=None):
592
"""Copy the current content and user files of this tree into tree."""
593
tree.set_root_id(self.get_root_id())
594
if revision_id is None:
595
merge.transform_tree(tree, self)
597
# TODO now merge from tree.last_revision to revision (to preserve
598
# user local changes)
599
merge.transform_tree(tree, self)
600
tree.set_parent_ids([revision_id])
602
def id2abspath(self, file_id):
603
return self.abspath(self.id2path(file_id))
605
def has_id(self, file_id):
606
# files that have been deleted are excluded
608
if not inv.has_id(file_id):
610
path = inv.id2path(file_id)
611
return osutils.lexists(self.abspath(path))
613
def has_or_had_id(self, file_id):
614
if file_id == self.inventory.root.file_id:
616
return self.inventory.has_id(file_id)
618
__contains__ = has_id
620
def get_file_size(self, file_id):
621
"""See Tree.get_file_size"""
623
return os.path.getsize(self.id2abspath(file_id))
625
if e.errno != errno.ENOENT:
631
def get_file_sha1(self, file_id, path=None, stat_value=None):
633
path = self._inventory.id2path(file_id)
634
return self._hashcache.get_sha1(path, stat_value)
636
def get_file_mtime(self, file_id, path=None):
638
path = self.inventory.id2path(file_id)
639
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
643
return self._inventory[file_id].executable
645
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
646
mode = stat_result.st_mode
647
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
649
if not supports_executable():
650
def is_executable(self, file_id, path=None):
651
return self._inventory[file_id].executable
653
_is_executable_from_path_and_stat = \
654
_is_executable_from_path_and_stat_from_basis
656
def is_executable(self, file_id, path=None):
658
path = self.id2path(file_id)
659
mode = os.lstat(self.abspath(path)).st_mode
660
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
662
_is_executable_from_path_and_stat = \
663
_is_executable_from_path_and_stat_from_stat
665
@needs_tree_write_lock
666
def _add(self, files, ids, kinds):
667
"""See MutableTree._add."""
668
# TODO: Re-adding a file that is removed in the working copy
669
# should probably put it back with the previous ID.
670
# the read and write working inventory should not occur in this
671
# function - they should be part of lock_write and unlock.
673
for f, file_id, kind in zip(files, ids, kinds):
674
assert kind is not None
676
inv.add_path(f, kind=kind)
678
inv.add_path(f, kind=kind, file_id=file_id)
679
self._inventory_is_modified = True
681
@needs_tree_write_lock
682
def _gather_kinds(self, files, kinds):
683
"""See MutableTree._gather_kinds."""
684
for pos, f in enumerate(files):
685
if kinds[pos] is None:
686
fullpath = normpath(self.abspath(f))
688
kinds[pos] = file_kind(fullpath)
690
if e.errno == errno.ENOENT:
691
raise errors.NoSuchFile(fullpath)
694
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
695
"""Add revision_id as a parent.
697
This is equivalent to retrieving the current list of parent ids
698
and setting the list to its value plus revision_id.
700
:param revision_id: The revision id to add to the parent list. It may
701
be a ghost revision as long as its not the first parent to be added,
702
or the allow_leftmost_as_ghost parameter is set True.
703
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
705
parents = self.get_parent_ids() + [revision_id]
706
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
707
or allow_leftmost_as_ghost)
709
@needs_tree_write_lock
710
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
711
"""Add revision_id, tree tuple as a parent.
713
This is equivalent to retrieving the current list of parent trees
714
and setting the list to its value plus parent_tuple. See also
715
add_parent_tree_id - if you only have a parent id available it will be
716
simpler to use that api. If you have the parent already available, using
717
this api is preferred.
719
:param parent_tuple: The (revision id, tree) to add to the parent list.
720
If the revision_id is a ghost, pass None for the tree.
721
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
723
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
724
if len(parent_ids) > 1:
725
# the leftmost may have already been a ghost, preserve that if it
727
allow_leftmost_as_ghost = True
728
self.set_parent_ids(parent_ids,
729
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
731
@needs_tree_write_lock
732
def add_pending_merge(self, *revision_ids):
733
# TODO: Perhaps should check at this point that the
734
# history of the revision is actually present?
735
parents = self.get_parent_ids()
737
for rev_id in revision_ids:
738
if rev_id in parents:
740
parents.append(rev_id)
743
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
745
def path_content_summary(self, path, _lstat=os.lstat,
746
_mapper=osutils.file_kind_from_stat_mode):
747
"""See Tree.path_content_summary."""
748
abspath = self.abspath(path)
750
stat_result = _lstat(abspath)
752
if getattr(e, 'errno', None) == errno.ENOENT:
754
return ('missing', None, None, None)
755
# propagate other errors
757
kind = _mapper(stat_result.st_mode)
759
size = stat_result.st_size
760
# try for a stat cache lookup
761
executable = self._is_executable_from_path_and_stat(path, stat_result)
762
return (kind, size, executable, self._sha_from_stat(
764
elif kind == 'directory':
765
# perhaps it looks like a plain directory, but it's really a
767
if self._directory_is_tree_reference(path):
768
kind = 'tree-reference'
769
return kind, None, None, None
770
elif kind == 'symlink':
771
return ('symlink', None, None, os.readlink(abspath))
773
return (kind, None, None, None)
775
@deprecated_method(zero_eleven)
777
def pending_merges(self):
778
"""Return a list of pending merges.
780
These are revisions that have been merged into the working
781
directory but not yet committed.
783
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
784
instead - which is available on all tree objects.
786
return self.get_parent_ids()[1:]
788
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
789
"""Common ghost checking functionality from set_parent_*.
791
This checks that the left hand-parent exists if there are any
794
if len(revision_ids) > 0:
795
leftmost_id = revision_ids[0]
796
if (not allow_leftmost_as_ghost and not
797
self.branch.repository.has_revision(leftmost_id)):
798
raise errors.GhostRevisionUnusableHere(leftmost_id)
800
def _set_merges_from_parent_ids(self, parent_ids):
801
merges = parent_ids[1:]
802
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
804
@needs_tree_write_lock
805
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
806
"""Set the parent ids to revision_ids.
808
See also set_parent_trees. This api will try to retrieve the tree data
809
for each element of revision_ids from the trees repository. If you have
810
tree data already available, it is more efficient to use
811
set_parent_trees rather than set_parent_ids. set_parent_ids is however
812
an easier API to use.
814
:param revision_ids: The revision_ids to set as the parent ids of this
815
working tree. Any of these may be ghosts.
817
self._check_parents_for_ghosts(revision_ids,
818
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
819
for revision_id in revision_ids:
820
_mod_revision.check_not_reserved_id(revision_id)
822
if len(revision_ids) > 0:
823
self.set_last_revision(revision_ids[0])
825
self.set_last_revision(_mod_revision.NULL_REVISION)
827
self._set_merges_from_parent_ids(revision_ids)
829
@needs_tree_write_lock
830
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
831
"""See MutableTree.set_parent_trees."""
832
parent_ids = [rev for (rev, tree) in parents_list]
833
for revision_id in parent_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
self._check_parents_for_ghosts(parent_ids,
837
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
839
if len(parent_ids) == 0:
840
leftmost_parent_id = _mod_revision.NULL_REVISION
841
leftmost_parent_tree = None
843
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
845
if self._change_last_revision(leftmost_parent_id):
846
if leftmost_parent_tree is None:
847
# If we don't have a tree, fall back to reading the
848
# parent tree from the repository.
849
self._cache_basis_inventory(leftmost_parent_id)
851
inv = leftmost_parent_tree.inventory
852
xml = self._create_basis_xml_from_inventory(
853
leftmost_parent_id, inv)
854
self._write_basis_inventory(xml)
855
self._set_merges_from_parent_ids(parent_ids)
857
@needs_tree_write_lock
858
def set_pending_merges(self, rev_list):
859
parents = self.get_parent_ids()
860
leftmost = parents[:1]
861
new_parents = leftmost + rev_list
862
self.set_parent_ids(new_parents)
864
@needs_tree_write_lock
865
def set_merge_modified(self, modified_hashes):
867
for file_id, hash in modified_hashes.iteritems():
868
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
869
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
871
def _sha_from_stat(self, path, stat_result):
872
"""Get a sha digest from the tree's stat cache.
874
The default implementation assumes no stat cache is present.
876
:param path: The path.
877
:param stat_result: The stat result being looked up.
881
def _put_rio(self, filename, stanzas, header):
882
self._must_be_locked()
883
my_file = rio_file(stanzas, header)
884
self._control_files.put(filename, my_file)
886
@needs_write_lock # because merge pulls data into the branch.
887
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
889
"""Merge from a branch into this working tree.
891
:param branch: The branch to merge from.
892
:param to_revision: If non-None, the merge will merge to to_revision,
893
but not beyond it. to_revision does not need to be in the history
894
of the branch when it is supplied. If None, to_revision defaults to
895
branch.last_revision().
897
from bzrlib.merge import Merger, Merge3Merger
898
pb = bzrlib.ui.ui_factory.nested_progress_bar()
900
merger = Merger(self.branch, this_tree=self, pb=pb)
901
merger.pp = ProgressPhase("Merge phase", 5, pb)
902
merger.pp.next_phase()
903
# check that there are no
905
merger.check_basis(check_clean=True, require_commits=False)
906
if to_revision is None:
907
to_revision = _mod_revision.ensure_null(branch.last_revision())
908
merger.other_rev_id = to_revision
909
if _mod_revision.is_null(merger.other_rev_id):
910
raise errors.NoCommits(branch)
911
self.branch.fetch(branch, last_revision=merger.other_rev_id)
912
merger.other_basis = merger.other_rev_id
913
merger.other_tree = self.branch.repository.revision_tree(
915
merger.other_branch = branch
916
merger.pp.next_phase()
917
if from_revision is None:
920
merger.set_base_revision(from_revision, branch)
921
if merger.base_rev_id == merger.other_rev_id:
922
raise errors.PointlessMerge
923
merger.backup_files = False
924
if merge_type is None:
925
merger.merge_type = Merge3Merger
927
merger.merge_type = merge_type
928
merger.set_interesting_files(None)
929
merger.show_base = False
930
merger.reprocess = False
931
conflicts = merger.do_merge()
938
def merge_modified(self):
939
"""Return a dictionary of files modified by a merge.
941
The list is initialized by WorkingTree.set_merge_modified, which is
942
typically called after we make some automatic updates to the tree
945
This returns a map of file_id->sha1, containing only files which are
946
still in the working inventory and have that text hash.
949
hashfile = self._control_files.get('merge-hashes')
950
except errors.NoSuchFile:
954
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
955
raise errors.MergeModifiedFormatError()
956
except StopIteration:
957
raise errors.MergeModifiedFormatError()
958
for s in RioReader(hashfile):
959
# RioReader reads in Unicode, so convert file_ids back to utf8
960
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
961
if file_id not in self.inventory:
963
text_hash = s.get("hash")
964
if text_hash == self.get_file_sha1(file_id):
965
merge_hashes[file_id] = text_hash
969
def mkdir(self, path, file_id=None):
970
"""See MutableTree.mkdir()."""
972
file_id = generate_ids.gen_file_id(os.path.basename(path))
973
os.mkdir(self.abspath(path))
974
self.add(path, file_id, 'directory')
977
def get_symlink_target(self, file_id):
978
return os.readlink(self.id2abspath(file_id))
981
def subsume(self, other_tree):
982
def add_children(inventory, entry):
983
for child_entry in entry.children.values():
984
inventory._byid[child_entry.file_id] = child_entry
985
if child_entry.kind == 'directory':
986
add_children(inventory, child_entry)
987
if other_tree.get_root_id() == self.get_root_id():
988
raise errors.BadSubsumeSource(self, other_tree,
989
'Trees have the same root')
991
other_tree_path = self.relpath(other_tree.basedir)
992
except errors.PathNotChild:
993
raise errors.BadSubsumeSource(self, other_tree,
994
'Tree is not contained by the other')
995
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
996
if new_root_parent is None:
997
raise errors.BadSubsumeSource(self, other_tree,
998
'Parent directory is not versioned.')
999
# We need to ensure that the result of a fetch will have a
1000
# versionedfile for the other_tree root, and only fetching into
1001
# RepositoryKnit2 guarantees that.
1002
if not self.branch.repository.supports_rich_root():
1003
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1004
other_tree.lock_tree_write()
1006
new_parents = other_tree.get_parent_ids()
1007
other_root = other_tree.inventory.root
1008
other_root.parent_id = new_root_parent
1009
other_root.name = osutils.basename(other_tree_path)
1010
self.inventory.add(other_root)
1011
add_children(self.inventory, other_root)
1012
self._write_inventory(self.inventory)
1013
# normally we don't want to fetch whole repositories, but i think
1014
# here we really do want to consolidate the whole thing.
1015
for parent_id in other_tree.get_parent_ids():
1016
self.branch.fetch(other_tree.branch, parent_id)
1017
self.add_parent_tree_id(parent_id)
1020
other_tree.bzrdir.retire_bzrdir()
1022
def _setup_directory_is_tree_reference(self):
1023
if self._branch.repository._format.supports_tree_reference:
1024
self._directory_is_tree_reference = \
1025
self._directory_may_be_tree_reference
1027
self._directory_is_tree_reference = \
1028
self._directory_is_never_tree_reference
1030
def _directory_is_never_tree_reference(self, relpath):
1033
def _directory_may_be_tree_reference(self, relpath):
1034
# as a special case, if a directory contains control files then
1035
# it's a tree reference, except that the root of the tree is not
1036
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1037
# TODO: We could ask all the control formats whether they
1038
# recognize this directory, but at the moment there's no cheap api
1039
# to do that. Since we probably can only nest bzr checkouts and
1040
# they always use this name it's ok for now. -- mbp 20060306
1042
# FIXME: There is an unhandled case here of a subdirectory
1043
# containing .bzr but not a branch; that will probably blow up
1044
# when you try to commit it. It might happen if there is a
1045
# checkout in a subdirectory. This can be avoided by not adding
1048
@needs_tree_write_lock
1049
def extract(self, file_id, format=None):
1050
"""Extract a subtree from this tree.
1052
A new branch will be created, relative to the path for this tree.
1056
segments = osutils.splitpath(path)
1057
transport = self.branch.bzrdir.root_transport
1058
for name in segments:
1059
transport = transport.clone(name)
1060
transport.ensure_base()
1063
sub_path = self.id2path(file_id)
1064
branch_transport = mkdirs(sub_path)
1066
format = self.bzrdir.cloning_metadir()
1067
branch_transport.ensure_base()
1068
branch_bzrdir = format.initialize_on_transport(branch_transport)
1070
repo = branch_bzrdir.find_repository()
1071
except errors.NoRepositoryPresent:
1072
repo = branch_bzrdir.create_repository()
1073
if not repo.supports_rich_root():
1074
raise errors.RootNotRich()
1075
new_branch = branch_bzrdir.create_branch()
1076
new_branch.pull(self.branch)
1077
for parent_id in self.get_parent_ids():
1078
new_branch.fetch(self.branch, parent_id)
1079
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1080
if tree_transport.base != branch_transport.base:
1081
tree_bzrdir = format.initialize_on_transport(tree_transport)
1082
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1084
tree_bzrdir = branch_bzrdir
1085
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1086
wt.set_parent_ids(self.get_parent_ids())
1087
my_inv = self.inventory
1088
child_inv = Inventory(root_id=None)
1089
new_root = my_inv[file_id]
1090
my_inv.remove_recursive_id(file_id)
1091
new_root.parent_id = None
1092
child_inv.add(new_root)
1093
self._write_inventory(my_inv)
1094
wt._write_inventory(child_inv)
1097
def _serialize(self, inventory, out_file):
1098
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1101
def _deserialize(selt, in_file):
1102
return xml5.serializer_v5.read_inventory(in_file)
1105
"""Write the in memory inventory to disk."""
1106
# TODO: Maybe this should only write on dirty ?
1107
if self._control_files._lock_mode != 'w':
1108
raise errors.NotWriteLocked(self)
1110
self._serialize(self._inventory, sio)
1112
self._control_files.put('inventory', sio)
1113
self._inventory_is_modified = False
1115
def _kind(self, relpath):
1116
return osutils.file_kind(self.abspath(relpath))
1118
def list_files(self, include_root=False):
1119
"""Recursively list all files as (path, class, kind, id, entry).
1121
Lists, but does not descend into unversioned directories.
1123
This does not include files that have been deleted in this
1126
Skips the control directory.
1128
# list_files is an iterator, so @needs_read_lock doesn't work properly
1129
# with it. So callers should be careful to always read_lock the tree.
1130
if not self.is_locked():
1131
raise errors.ObjectNotLocked(self)
1133
inv = self.inventory
1134
if include_root is True:
1135
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1136
# Convert these into local objects to save lookup times
1137
pathjoin = osutils.pathjoin
1138
file_kind = self._kind
1140
# transport.base ends in a slash, we want the piece
1141
# between the last two slashes
1142
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1144
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1146
# directory file_id, relative path, absolute path, reverse sorted children
1147
children = os.listdir(self.basedir)
1149
# jam 20060527 The kernel sized tree seems equivalent whether we
1150
# use a deque and popleft to keep them sorted, or if we use a plain
1151
# list and just reverse() them.
1152
children = collections.deque(children)
1153
stack = [(inv.root.file_id, u'', self.basedir, children)]
1155
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1158
f = children.popleft()
1159
## TODO: If we find a subdirectory with its own .bzr
1160
## directory, then that is a separate tree and we
1161
## should exclude it.
1163
# the bzrdir for this tree
1164
if transport_base_dir == f:
1167
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1168
# and 'f' doesn't begin with one, we can do a string op, rather
1169
# than the checks of pathjoin(), all relative paths will have an extra slash
1171
fp = from_dir_relpath + '/' + f
1174
fap = from_dir_abspath + '/' + f
1176
f_ie = inv.get_child(from_dir_id, f)
1179
elif self.is_ignored(fp[1:]):
1182
# we may not have found this file, because of a unicode issue
1183
f_norm, can_access = osutils.normalized_filename(f)
1184
if f == f_norm or not can_access:
1185
# No change, so treat this file normally
1188
# this file can be accessed by a normalized path
1189
# check again if it is versioned
1190
# these lines are repeated here for performance
1192
fp = from_dir_relpath + '/' + f
1193
fap = from_dir_abspath + '/' + f
1194
f_ie = inv.get_child(from_dir_id, f)
1197
elif self.is_ignored(fp[1:]):
1204
# make a last minute entry
1206
yield fp[1:], c, fk, f_ie.file_id, f_ie
1209
yield fp[1:], c, fk, None, fk_entries[fk]()
1211
yield fp[1:], c, fk, None, TreeEntry()
1214
if fk != 'directory':
1217
# But do this child first
1218
new_children = os.listdir(fap)
1220
new_children = collections.deque(new_children)
1221
stack.append((f_ie.file_id, fp, fap, new_children))
1222
# Break out of inner loop,
1223
# so that we start outer loop with child
1226
# if we finished all children, pop it off the stack
1229
@needs_tree_write_lock
1230
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1233
to_dir must exist in the inventory.
1235
If to_dir exists and is a directory, the files are moved into
1236
it, keeping their old names.
1238
Note that to_dir is only the last component of the new name;
1239
this doesn't change the directory.
1241
For each entry in from_paths the move mode will be determined
1244
The first mode moves the file in the filesystem and updates the
1245
inventory. The second mode only updates the inventory without
1246
touching the file on the filesystem. This is the new mode introduced
1249
move uses the second mode if 'after == True' and the target is not
1250
versioned but present in the working tree.
1252
move uses the second mode if 'after == False' and the source is
1253
versioned but no longer in the working tree, and the target is not
1254
versioned but present in the working tree.
1256
move uses the first mode if 'after == False' and the source is
1257
versioned and present in the working tree, and the target is not
1258
versioned and not present in the working tree.
1260
Everything else results in an error.
1262
This returns a list of (from_path, to_path) pairs for each
1263
entry that is moved.
1268
# check for deprecated use of signature
1270
to_dir = kwargs.get('to_name', None)
1272
raise TypeError('You must supply a target directory')
1274
symbol_versioning.warn('The parameter to_name was deprecated'
1275
' in version 0.13. Use to_dir instead',
1278
# check destination directory
1279
assert not isinstance(from_paths, basestring)
1280
inv = self.inventory
1281
to_abs = self.abspath(to_dir)
1282
if not isdir(to_abs):
1283
raise errors.BzrMoveFailedError('',to_dir,
1284
errors.NotADirectory(to_abs))
1285
if not self.has_filename(to_dir):
1286
raise errors.BzrMoveFailedError('',to_dir,
1287
errors.NotInWorkingDirectory(to_dir))
1288
to_dir_id = inv.path2id(to_dir)
1289
if to_dir_id is None:
1290
raise errors.BzrMoveFailedError('',to_dir,
1291
errors.NotVersionedError(path=str(to_dir)))
1293
to_dir_ie = inv[to_dir_id]
1294
if to_dir_ie.kind != 'directory':
1295
raise errors.BzrMoveFailedError('',to_dir,
1296
errors.NotADirectory(to_abs))
1298
# create rename entries and tuples
1299
for from_rel in from_paths:
1300
from_tail = splitpath(from_rel)[-1]
1301
from_id = inv.path2id(from_rel)
1303
raise errors.BzrMoveFailedError(from_rel,to_dir,
1304
errors.NotVersionedError(path=str(from_rel)))
1306
from_entry = inv[from_id]
1307
from_parent_id = from_entry.parent_id
1308
to_rel = pathjoin(to_dir, from_tail)
1309
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1311
from_tail=from_tail,
1312
from_parent_id=from_parent_id,
1313
to_rel=to_rel, to_tail=from_tail,
1314
to_parent_id=to_dir_id)
1315
rename_entries.append(rename_entry)
1316
rename_tuples.append((from_rel, to_rel))
1318
# determine which move mode to use. checks also for movability
1319
rename_entries = self._determine_mv_mode(rename_entries, after)
1321
original_modified = self._inventory_is_modified
1324
self._inventory_is_modified = True
1325
self._move(rename_entries)
1327
# restore the inventory on error
1328
self._inventory_is_modified = original_modified
1330
self._write_inventory(inv)
1331
return rename_tuples
1333
def _determine_mv_mode(self, rename_entries, after=False):
1334
"""Determines for each from-to pair if both inventory and working tree
1335
or only the inventory has to be changed.
1337
Also does basic plausability tests.
1339
inv = self.inventory
1341
for rename_entry in rename_entries:
1342
# store to local variables for easier reference
1343
from_rel = rename_entry.from_rel
1344
from_id = rename_entry.from_id
1345
to_rel = rename_entry.to_rel
1346
to_id = inv.path2id(to_rel)
1347
only_change_inv = False
1349
# check the inventory for source and destination
1351
raise errors.BzrMoveFailedError(from_rel,to_rel,
1352
errors.NotVersionedError(path=str(from_rel)))
1353
if to_id is not None:
1354
raise errors.BzrMoveFailedError(from_rel,to_rel,
1355
errors.AlreadyVersionedError(path=str(to_rel)))
1357
# try to determine the mode for rename (only change inv or change
1358
# inv and file system)
1360
if not self.has_filename(to_rel):
1361
raise errors.BzrMoveFailedError(from_id,to_rel,
1362
errors.NoSuchFile(path=str(to_rel),
1363
extra="New file has not been created yet"))
1364
only_change_inv = True
1365
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1366
only_change_inv = True
1367
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1368
only_change_inv = False
1369
elif (sys.platform == 'win32'
1370
and from_rel.lower() == to_rel.lower()
1371
and self.has_filename(from_rel)):
1372
only_change_inv = False
1374
# something is wrong, so lets determine what exactly
1375
if not self.has_filename(from_rel) and \
1376
not self.has_filename(to_rel):
1377
raise errors.BzrRenameFailedError(from_rel,to_rel,
1378
errors.PathsDoNotExist(paths=(str(from_rel),
1381
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1382
rename_entry.only_change_inv = only_change_inv
1383
return rename_entries
1385
def _move(self, rename_entries):
1386
"""Moves a list of files.
1388
Depending on the value of the flag 'only_change_inv', the
1389
file will be moved on the file system or not.
1391
inv = self.inventory
1394
for entry in rename_entries:
1396
self._move_entry(entry)
1398
self._rollback_move(moved)
1402
def _rollback_move(self, moved):
1403
"""Try to rollback a previous move in case of an filesystem error."""
1404
inv = self.inventory
1407
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1408
entry.to_tail, entry.to_parent_id, entry.from_rel,
1409
entry.from_tail, entry.from_parent_id,
1410
entry.only_change_inv))
1411
except errors.BzrMoveFailedError, e:
1412
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1413
" The working tree is in an inconsistent state."
1414
" Please consider doing a 'bzr revert'."
1415
" Error message is: %s" % e)
1417
def _move_entry(self, entry):
1418
inv = self.inventory
1419
from_rel_abs = self.abspath(entry.from_rel)
1420
to_rel_abs = self.abspath(entry.to_rel)
1421
if from_rel_abs == to_rel_abs:
1422
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1423
"Source and target are identical.")
1425
if not entry.only_change_inv:
1427
osutils.rename(from_rel_abs, to_rel_abs)
1429
raise errors.BzrMoveFailedError(entry.from_rel,
1431
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1433
@needs_tree_write_lock
1434
def rename_one(self, from_rel, to_rel, after=False):
1437
This can change the directory or the filename or both.
1439
rename_one has several 'modes' to work. First, it can rename a physical
1440
file and change the file_id. That is the normal mode. Second, it can
1441
only change the file_id without touching any physical file. This is
1442
the new mode introduced in version 0.15.
1444
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1445
versioned but present in the working tree.
1447
rename_one uses the second mode if 'after == False' and 'from_rel' is
1448
versioned but no longer in the working tree, and 'to_rel' is not
1449
versioned but present in the working tree.
1451
rename_one uses the first mode if 'after == False' and 'from_rel' is
1452
versioned and present in the working tree, and 'to_rel' is not
1453
versioned and not present in the working tree.
1455
Everything else results in an error.
1457
inv = self.inventory
1460
# create rename entries and tuples
1461
from_tail = splitpath(from_rel)[-1]
1462
from_id = inv.path2id(from_rel)
1464
raise errors.BzrRenameFailedError(from_rel,to_rel,
1465
errors.NotVersionedError(path=str(from_rel)))
1466
from_entry = inv[from_id]
1467
from_parent_id = from_entry.parent_id
1468
to_dir, to_tail = os.path.split(to_rel)
1469
to_dir_id = inv.path2id(to_dir)
1470
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1472
from_tail=from_tail,
1473
from_parent_id=from_parent_id,
1474
to_rel=to_rel, to_tail=to_tail,
1475
to_parent_id=to_dir_id)
1476
rename_entries.append(rename_entry)
1478
# determine which move mode to use. checks also for movability
1479
rename_entries = self._determine_mv_mode(rename_entries, after)
1481
# check if the target changed directory and if the target directory is
1483
if to_dir_id is None:
1484
raise errors.BzrMoveFailedError(from_rel,to_rel,
1485
errors.NotVersionedError(path=str(to_dir)))
1487
# all checks done. now we can continue with our actual work
1488
mutter('rename_one:\n'
1493
' to_dir_id {%s}\n',
1494
from_id, from_rel, to_rel, to_dir, to_dir_id)
1496
self._move(rename_entries)
1497
self._write_inventory(inv)
1499
class _RenameEntry(object):
1500
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1501
to_rel, to_tail, to_parent_id, only_change_inv=False):
1502
self.from_rel = from_rel
1503
self.from_id = from_id
1504
self.from_tail = from_tail
1505
self.from_parent_id = from_parent_id
1506
self.to_rel = to_rel
1507
self.to_tail = to_tail
1508
self.to_parent_id = to_parent_id
1509
self.only_change_inv = only_change_inv
1513
"""Return all unknown files.
1515
These are files in the working directory that are not versioned or
1516
control files or ignored.
1518
# force the extras method to be fully executed before returning, to
1519
# prevent race conditions with the lock
1521
[subp for subp in self.extras() if not self.is_ignored(subp)])
1523
@needs_tree_write_lock
1524
def unversion(self, file_ids):
1525
"""Remove the file ids in file_ids from the current versioned set.
1527
When a file_id is unversioned, all of its children are automatically
1530
:param file_ids: The file ids to stop versioning.
1531
:raises: NoSuchId if any fileid is not currently versioned.
1533
for file_id in file_ids:
1534
if self._inventory.has_id(file_id):
1535
self._inventory.remove_recursive_id(file_id)
1537
raise errors.NoSuchId(self, file_id)
1539
# in the future this should just set a dirty bit to wait for the
1540
# final unlock. However, until all methods of workingtree start
1541
# with the current in -memory inventory rather than triggering
1542
# a read, it is more complex - we need to teach read_inventory
1543
# to know when to read, and when to not read first... and possibly
1544
# to save first when the in memory one may be corrupted.
1545
# so for now, we just only write it if it is indeed dirty.
1547
self._write_inventory(self._inventory)
1549
@deprecated_method(zero_eight)
1550
def iter_conflicts(self):
1551
"""List all files in the tree that have text or content conflicts.
1552
DEPRECATED. Use conflicts instead."""
1553
return self._iter_conflicts()
1555
def _iter_conflicts(self):
1557
for info in self.list_files():
1559
stem = get_conflicted_stem(path)
1562
if stem not in conflicted:
1563
conflicted.add(stem)
1567
def pull(self, source, overwrite=False, stop_revision=None,
1568
change_reporter=None, possible_transports=None):
1569
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1572
pp = ProgressPhase("Pull phase", 2, top_pb)
1574
old_revision_info = self.branch.last_revision_info()
1575
basis_tree = self.basis_tree()
1576
count = self.branch.pull(source, overwrite, stop_revision,
1577
possible_transports=possible_transports)
1578
new_revision_info = self.branch.last_revision_info()
1579
if new_revision_info != old_revision_info:
1581
repository = self.branch.repository
1582
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1583
basis_tree.lock_read()
1585
new_basis_tree = self.branch.basis_tree()
1592
change_reporter=change_reporter)
1593
if (basis_tree.inventory.root is None and
1594
new_basis_tree.inventory.root is not None):
1595
self.set_root_id(new_basis_tree.get_root_id())
1599
# TODO - dedup parents list with things merged by pull ?
1600
# reuse the revisiontree we merged against to set the new
1602
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1603
# we have to pull the merge trees out again, because
1604
# merge_inner has set the ids. - this corner is not yet
1605
# layered well enough to prevent double handling.
1606
# XXX TODO: Fix the double handling: telling the tree about
1607
# the already known parent data is wasteful.
1608
merges = self.get_parent_ids()[1:]
1609
parent_trees.extend([
1610
(parent, repository.revision_tree(parent)) for
1612
self.set_parent_trees(parent_trees)
1619
def put_file_bytes_non_atomic(self, file_id, bytes):
1620
"""See MutableTree.put_file_bytes_non_atomic."""
1621
stream = file(self.id2abspath(file_id), 'wb')
1626
# TODO: update the hashcache here ?
1629
"""Yield all unversioned files in this WorkingTree.
1631
If there are any unversioned directories then only the directory is
1632
returned, not all its children. But if there are unversioned files
1633
under a versioned subdirectory, they are returned.
1635
Currently returned depth-first, sorted by name within directories.
1636
This is the same order used by 'osutils.walkdirs'.
1638
## TODO: Work from given directory downwards
1639
for path, dir_entry in self.inventory.directories():
1640
# mutter("search for unknowns in %r", path)
1641
dirabs = self.abspath(path)
1642
if not isdir(dirabs):
1643
# e.g. directory deleted
1647
for subf in os.listdir(dirabs):
1650
if subf not in dir_entry.children:
1651
subf_norm, can_access = osutils.normalized_filename(subf)
1652
if subf_norm != subf and can_access:
1653
if subf_norm not in dir_entry.children:
1654
fl.append(subf_norm)
1660
subp = pathjoin(path, subf)
1663
def ignored_files(self):
1664
"""Yield list of PATH, IGNORE_PATTERN"""
1665
for subp in self.extras():
1666
pat = self.is_ignored(subp)
1670
def get_ignore_list(self):
1671
"""Return list of ignore patterns.
1673
Cached in the Tree object after the first call.
1675
ignoreset = getattr(self, '_ignoreset', None)
1676
if ignoreset is not None:
1679
ignore_globs = set()
1680
ignore_globs.update(ignores.get_runtime_ignores())
1681
ignore_globs.update(ignores.get_user_ignores())
1682
if self.has_filename(bzrlib.IGNORE_FILENAME):
1683
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1685
ignore_globs.update(ignores.parse_ignore_file(f))
1688
self._ignoreset = ignore_globs
1691
def _flush_ignore_list_cache(self):
1692
"""Resets the cached ignore list to force a cache rebuild."""
1693
self._ignoreset = None
1694
self._ignoreglobster = None
1696
def is_ignored(self, filename):
1697
r"""Check whether the filename matches an ignore pattern.
1699
Patterns containing '/' or '\' need to match the whole path;
1700
others match against only the last component.
1702
If the file is ignored, returns the pattern which caused it to
1703
be ignored, otherwise None. So this can simply be used as a
1704
boolean if desired."""
1705
if getattr(self, '_ignoreglobster', None) is None:
1706
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1707
return self._ignoreglobster.match(filename)
1709
def kind(self, file_id):
1710
return file_kind(self.id2abspath(file_id))
1712
def stored_kind(self, file_id):
1713
"""See Tree.stored_kind"""
1714
return self.inventory[file_id].kind
1716
def _comparison_data(self, entry, path):
1717
abspath = self.abspath(path)
1719
stat_value = os.lstat(abspath)
1721
if getattr(e, 'errno', None) == errno.ENOENT:
1728
mode = stat_value.st_mode
1729
kind = osutils.file_kind_from_stat_mode(mode)
1730
if not supports_executable():
1731
executable = entry is not None and entry.executable
1733
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1734
return kind, executable, stat_value
1736
def _file_size(self, entry, stat_value):
1737
return stat_value.st_size
1739
def last_revision(self):
1740
"""Return the last revision of the branch for this tree.
1742
This format tree does not support a separate marker for last-revision
1743
compared to the branch.
1745
See MutableTree.last_revision
1747
return self._last_revision()
1750
def _last_revision(self):
1751
"""helper for get_parent_ids."""
1752
return _mod_revision.ensure_null(self.branch.last_revision())
1754
def is_locked(self):
1755
return self._control_files.is_locked()
1757
def _must_be_locked(self):
1758
if not self.is_locked():
1759
raise errors.ObjectNotLocked(self)
1761
def lock_read(self):
1762
"""See Branch.lock_read, and WorkingTree.unlock."""
1763
if not self.is_locked():
1765
self.branch.lock_read()
1767
return self._control_files.lock_read()
1769
self.branch.unlock()
1772
def lock_tree_write(self):
1773
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1774
if not self.is_locked():
1776
self.branch.lock_read()
1778
return self._control_files.lock_write()
1780
self.branch.unlock()
1783
def lock_write(self):
1784
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1785
if not self.is_locked():
1787
self.branch.lock_write()
1789
return self._control_files.lock_write()
1791
self.branch.unlock()
1794
def get_physical_lock_status(self):
1795
return self._control_files.get_physical_lock_status()
1797
def _basis_inventory_name(self):
1798
return 'basis-inventory-cache'
1800
def _reset_data(self):
1801
"""Reset transient data that cannot be revalidated."""
1802
self._inventory_is_modified = False
1803
result = self._deserialize(self._control_files.get('inventory'))
1804
self._set_inventory(result, dirty=False)
1806
@needs_tree_write_lock
1807
def set_last_revision(self, new_revision):
1808
"""Change the last revision in the working tree."""
1809
if self._change_last_revision(new_revision):
1810
self._cache_basis_inventory(new_revision)
1812
def _change_last_revision(self, new_revision):
1813
"""Template method part of set_last_revision to perform the change.
1815
This is used to allow WorkingTree3 instances to not affect branch
1816
when their last revision is set.
1818
if _mod_revision.is_null(new_revision):
1819
self.branch.set_revision_history([])
1822
self.branch.generate_revision_history(new_revision)
1823
except errors.NoSuchRevision:
1824
# not present in the repo - dont try to set it deeper than the tip
1825
self.branch.set_revision_history([new_revision])
1828
def _write_basis_inventory(self, xml):
1829
"""Write the basis inventory XML to the basis-inventory file"""
1830
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1831
path = self._basis_inventory_name()
1833
self._control_files.put(path, sio)
1835
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1836
"""Create the text that will be saved in basis-inventory"""
1837
inventory.revision_id = revision_id
1838
return xml7.serializer_v7.write_inventory_to_string(inventory)
1840
def _cache_basis_inventory(self, new_revision):
1841
"""Cache new_revision as the basis inventory."""
1842
# TODO: this should allow the ready-to-use inventory to be passed in,
1843
# as commit already has that ready-to-use [while the format is the
1846
# this double handles the inventory - unpack and repack -
1847
# but is easier to understand. We can/should put a conditional
1848
# in here based on whether the inventory is in the latest format
1849
# - perhaps we should repack all inventories on a repository
1851
# the fast path is to copy the raw xml from the repository. If the
1852
# xml contains 'revision_id="', then we assume the right
1853
# revision_id is set. We must check for this full string, because a
1854
# root node id can legitimately look like 'revision_id' but cannot
1856
xml = self.branch.repository.get_inventory_xml(new_revision)
1857
firstline = xml.split('\n', 1)[0]
1858
if (not 'revision_id="' in firstline or
1859
'format="7"' not in firstline):
1860
inv = self.branch.repository.deserialise_inventory(
1862
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1863
self._write_basis_inventory(xml)
1864
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1867
def read_basis_inventory(self):
1868
"""Read the cached basis inventory."""
1869
path = self._basis_inventory_name()
1870
return self._control_files.get(path).read()
1873
def read_working_inventory(self):
1874
"""Read the working inventory.
1876
:raises errors.InventoryModified: read_working_inventory will fail
1877
when the current in memory inventory has been modified.
1879
# conceptually this should be an implementation detail of the tree.
1880
# XXX: Deprecate this.
1881
# ElementTree does its own conversion from UTF-8, so open in
1883
if self._inventory_is_modified:
1884
raise errors.InventoryModified(self)
1885
result = self._deserialize(self._control_files.get('inventory'))
1886
self._set_inventory(result, dirty=False)
1889
@needs_tree_write_lock
1890
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1892
"""Remove nominated files from the working inventory.
1894
:files: File paths relative to the basedir.
1895
:keep_files: If true, the files will also be kept.
1896
:force: Delete files and directories, even if they are changed and
1897
even if the directories are not empty.
1899
if isinstance(files, basestring):
1905
unknown_nested_files=set()
1907
def recurse_directory_to_add_files(directory):
1908
# Recurse directory and add all files
1909
# so we can check if they have changed.
1910
for parent_info, file_infos in\
1911
osutils.walkdirs(self.abspath(directory),
1913
for relpath, basename, kind, lstat, abspath in file_infos:
1914
# Is it versioned or ignored?
1915
if self.path2id(relpath) or self.is_ignored(relpath):
1916
# Add nested content for deletion.
1917
new_files.add(relpath)
1919
# Files which are not versioned and not ignored
1920
# should be treated as unknown.
1921
unknown_nested_files.add((relpath, None, kind))
1923
for filename in files:
1924
# Get file name into canonical form.
1925
abspath = self.abspath(filename)
1926
filename = self.relpath(abspath)
1927
if len(filename) > 0:
1928
new_files.add(filename)
1929
if osutils.isdir(abspath):
1930
recurse_directory_to_add_files(filename)
1932
files = list(new_files)
1935
return # nothing to do
1937
# Sort needed to first handle directory content before the directory
1938
files.sort(reverse=True)
1940
# Bail out if we are going to delete files we shouldn't
1941
if not keep_files and not force:
1942
has_changed_files = len(unknown_nested_files) > 0
1943
if not has_changed_files:
1944
for (file_id, path, content_change, versioned, parent_id, name,
1945
kind, executable) in self.iter_changes(self.basis_tree(),
1946
include_unchanged=True, require_versioned=False,
1947
want_unversioned=True, specific_files=files):
1948
if versioned == (False, False):
1949
# The record is unknown ...
1950
if not self.is_ignored(path[1]):
1951
# ... but not ignored
1952
has_changed_files = True
1954
elif content_change and (kind[1] != None):
1955
# Versioned and changed, but not deleted
1956
has_changed_files = True
1959
if has_changed_files:
1960
# Make delta show ALL applicable changes in error message.
1961
tree_delta = self.changes_from(self.basis_tree(),
1962
require_versioned=False, want_unversioned=True,
1963
specific_files=files)
1964
for unknown_file in unknown_nested_files:
1965
if unknown_file not in tree_delta.unversioned:
1966
tree_delta.unversioned.extend((unknown_file,))
1967
raise errors.BzrRemoveChangedFilesError(tree_delta)
1969
# Build inv_delta and delete files where applicaple,
1970
# do this before any modifications to inventory.
1972
fid = self.path2id(f)
1975
message = "%s is not versioned." % (f,)
1978
# having removed it, it must be either ignored or unknown
1979
if self.is_ignored(f):
1983
textui.show_status(new_status, self.kind(fid), f,
1986
inv_delta.append((f, None, fid, None))
1987
message = "removed %s" % (f,)
1990
abs_path = self.abspath(f)
1991
if osutils.lexists(abs_path):
1992
if (osutils.isdir(abs_path) and
1993
len(os.listdir(abs_path)) > 0):
1995
osutils.rmtree(abs_path)
1997
message = "%s is not an empty directory "\
1998
"and won't be deleted." % (f,)
2000
osutils.delete_any(abs_path)
2001
message = "deleted %s" % (f,)
2002
elif message is not None:
2003
# Only care if we haven't done anything yet.
2004
message = "%s does not exist." % (f,)
2006
# Print only one message (if any) per file.
2007
if message is not None:
2009
self.apply_inventory_delta(inv_delta)
2011
@needs_tree_write_lock
2012
def revert(self, filenames=None, old_tree=None, backups=True,
2013
pb=DummyProgress(), report_changes=False):
2014
from bzrlib.conflicts import resolve
2017
symbol_versioning.warn('Using [] to revert all files is deprecated'
2018
' as of bzr 0.91. Please use None (the default) instead.',
2019
DeprecationWarning, stacklevel=2)
2020
if old_tree is None:
2021
basis_tree = self.basis_tree()
2022
basis_tree.lock_read()
2023
old_tree = basis_tree
2027
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2029
if filenames is None and len(self.get_parent_ids()) > 1:
2031
last_revision = self.last_revision()
2032
if last_revision != NULL_REVISION:
2033
if basis_tree is None:
2034
basis_tree = self.basis_tree()
2035
basis_tree.lock_read()
2036
parent_trees.append((last_revision, basis_tree))
2037
self.set_parent_trees(parent_trees)
2040
resolve(self, filenames, ignore_misses=True, recursive=True)
2042
if basis_tree is not None:
2046
def revision_tree(self, revision_id):
2047
"""See Tree.revision_tree.
2049
WorkingTree can supply revision_trees for the basis revision only
2050
because there is only one cached inventory in the bzr directory.
2052
if revision_id == self.last_revision():
2054
xml = self.read_basis_inventory()
2055
except errors.NoSuchFile:
2059
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2060
# dont use the repository revision_tree api because we want
2061
# to supply the inventory.
2062
if inv.revision_id == revision_id:
2063
return revisiontree.RevisionTree(self.branch.repository,
2065
except errors.BadInventoryFormat:
2067
# raise if there was no inventory, or if we read the wrong inventory.
2068
raise errors.NoSuchRevisionInTree(self, revision_id)
2070
# XXX: This method should be deprecated in favour of taking in a proper
2071
# new Inventory object.
2072
@needs_tree_write_lock
2073
def set_inventory(self, new_inventory_list):
2074
from bzrlib.inventory import (Inventory,
2079
inv = Inventory(self.get_root_id())
2080
for path, file_id, parent, kind in new_inventory_list:
2081
name = os.path.basename(path)
2084
# fixme, there should be a factory function inv,add_??
2085
if kind == 'directory':
2086
inv.add(InventoryDirectory(file_id, name, parent))
2087
elif kind == 'file':
2088
inv.add(InventoryFile(file_id, name, parent))
2089
elif kind == 'symlink':
2090
inv.add(InventoryLink(file_id, name, parent))
2092
raise errors.BzrError("unknown kind %r" % kind)
2093
self._write_inventory(inv)
2095
@needs_tree_write_lock
2096
def set_root_id(self, file_id):
2097
"""Set the root id for this tree."""
2100
symbol_versioning.warn(symbol_versioning.zero_twelve
2101
% 'WorkingTree.set_root_id with fileid=None',
2106
file_id = osutils.safe_file_id(file_id)
2107
self._set_root_id(file_id)
2109
def _set_root_id(self, file_id):
2110
"""Set the root id for this tree, in a format specific manner.
2112
:param file_id: The file id to assign to the root. It must not be
2113
present in the current inventory or an error will occur. It must
2114
not be None, but rather a valid file id.
2116
inv = self._inventory
2117
orig_root_id = inv.root.file_id
2118
# TODO: it might be nice to exit early if there was nothing
2119
# to do, saving us from trigger a sync on unlock.
2120
self._inventory_is_modified = True
2121
# we preserve the root inventory entry object, but
2122
# unlinkit from the byid index
2123
del inv._byid[inv.root.file_id]
2124
inv.root.file_id = file_id
2125
# and link it into the index with the new changed id.
2126
inv._byid[inv.root.file_id] = inv.root
2127
# and finally update all children to reference the new id.
2128
# XXX: this should be safe to just look at the root.children
2129
# list, not the WHOLE INVENTORY.
2132
if entry.parent_id == orig_root_id:
2133
entry.parent_id = inv.root.file_id
2136
"""See Branch.unlock.
2138
WorkingTree locking just uses the Branch locking facilities.
2139
This is current because all working trees have an embedded branch
2140
within them. IF in the future, we were to make branch data shareable
2141
between multiple working trees, i.e. via shared storage, then we
2142
would probably want to lock both the local tree, and the branch.
2144
raise NotImplementedError(self.unlock)
2146
def update(self, change_reporter=None, possible_transports=None):
2147
"""Update a working tree along its branch.
2149
This will update the branch if its bound too, which means we have
2150
multiple trees involved:
2152
- The new basis tree of the master.
2153
- The old basis tree of the branch.
2154
- The old basis tree of the working tree.
2155
- The current working tree state.
2157
Pathologically, all three may be different, and non-ancestors of each
2158
other. Conceptually we want to:
2160
- Preserve the wt.basis->wt.state changes
2161
- Transform the wt.basis to the new master basis.
2162
- Apply a merge of the old branch basis to get any 'local' changes from
2164
- Restore the wt.basis->wt.state changes.
2166
There isn't a single operation at the moment to do that, so we:
2167
- Merge current state -> basis tree of the master w.r.t. the old tree
2169
- Do a 'normal' merge of the old branch basis if it is relevant.
2171
if self.branch.get_bound_location() is not None:
2173
update_branch = True
2175
self.lock_tree_write()
2176
update_branch = False
2179
old_tip = self.branch.update(possible_transports)
2182
return self._update_tree(old_tip, change_reporter)
2186
@needs_tree_write_lock
2187
def _update_tree(self, old_tip=None, change_reporter=None):
2188
"""Update a tree to the master branch.
2190
:param old_tip: if supplied, the previous tip revision the branch,
2191
before it was changed to the master branch's tip.
2193
# here if old_tip is not None, it is the old tip of the branch before
2194
# it was updated from the master branch. This should become a pending
2195
# merge in the working tree to preserve the user existing work. we
2196
# cant set that until we update the working trees last revision to be
2197
# one from the new branch, because it will just get absorbed by the
2198
# parent de-duplication logic.
2200
# We MUST save it even if an error occurs, because otherwise the users
2201
# local work is unreferenced and will appear to have been lost.
2205
last_rev = self.get_parent_ids()[0]
2207
last_rev = _mod_revision.NULL_REVISION
2208
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2209
# merge tree state up to new branch tip.
2210
basis = self.basis_tree()
2213
to_tree = self.branch.basis_tree()
2214
if basis.inventory.root is None:
2215
self.set_root_id(to_tree.get_root_id())
2217
result += merge.merge_inner(
2222
change_reporter=change_reporter)
2225
# TODO - dedup parents list with things merged by pull ?
2226
# reuse the tree we've updated to to set the basis:
2227
parent_trees = [(self.branch.last_revision(), to_tree)]
2228
merges = self.get_parent_ids()[1:]
2229
# Ideally we ask the tree for the trees here, that way the working
2230
# tree can decide whether to give us teh entire tree or give us a
2231
# lazy initialised tree. dirstate for instance will have the trees
2232
# in ram already, whereas a last-revision + basis-inventory tree
2233
# will not, but also does not need them when setting parents.
2234
for parent in merges:
2235
parent_trees.append(
2236
(parent, self.branch.repository.revision_tree(parent)))
2237
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2238
parent_trees.append(
2239
(old_tip, self.branch.repository.revision_tree(old_tip)))
2240
self.set_parent_trees(parent_trees)
2241
last_rev = parent_trees[0][0]
2243
# the working tree had the same last-revision as the master
2244
# branch did. We may still have pivot local work from the local
2245
# branch into old_tip:
2246
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2247
self.add_parent_tree_id(old_tip)
2248
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2249
and old_tip != last_rev):
2250
# our last revision was not the prior branch last revision
2251
# and we have converted that last revision to a pending merge.
2252
# base is somewhere between the branch tip now
2253
# and the now pending merge
2255
# Since we just modified the working tree and inventory, flush out
2256
# the current state, before we modify it again.
2257
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2258
# requires it only because TreeTransform directly munges the
2259
# inventory and calls tree._write_inventory(). Ultimately we
2260
# should be able to remove this extra flush.
2262
graph = self.branch.repository.get_graph()
2263
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2265
base_tree = self.branch.repository.revision_tree(base_rev_id)
2266
other_tree = self.branch.repository.revision_tree(old_tip)
2267
result += merge.merge_inner(
2272
change_reporter=change_reporter)
2275
def _write_hashcache_if_dirty(self):
2276
"""Write out the hashcache if it is dirty."""
2277
if self._hashcache.needs_write:
2279
self._hashcache.write()
2281
if e.errno not in (errno.EPERM, errno.EACCES):
2283
# TODO: jam 20061219 Should this be a warning? A single line
2284
# warning might be sufficient to let the user know what
2286
mutter('Could not write hashcache for %s\nError: %s',
2287
self._hashcache.cache_file_name(), e)
2289
@needs_tree_write_lock
2290
def _write_inventory(self, inv):
2291
"""Write inventory as the current inventory."""
2292
self._set_inventory(inv, dirty=True)
2295
def set_conflicts(self, arg):
2296
raise errors.UnsupportedOperation(self.set_conflicts, self)
2298
def add_conflicts(self, arg):
2299
raise errors.UnsupportedOperation(self.add_conflicts, self)
2302
def conflicts(self):
2303
conflicts = _mod_conflicts.ConflictList()
2304
for conflicted in self._iter_conflicts():
2307
if file_kind(self.abspath(conflicted)) != "file":
2309
except errors.NoSuchFile:
2312
for suffix in ('.THIS', '.OTHER'):
2314
kind = file_kind(self.abspath(conflicted+suffix))
2317
except errors.NoSuchFile:
2321
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2322
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2324
file_id=self.path2id(conflicted)))
2327
def walkdirs(self, prefix=""):
2328
"""Walk the directories of this tree.
2330
returns a generator which yields items in the form:
2331
((curren_directory_path, fileid),
2332
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2335
This API returns a generator, which is only valid during the current
2336
tree transaction - within a single lock_read or lock_write duration.
2338
If the tree is not locked, it may cause an error to be raised,
2339
depending on the tree implementation.
2341
disk_top = self.abspath(prefix)
2342
if disk_top.endswith('/'):
2343
disk_top = disk_top[:-1]
2344
top_strip_len = len(disk_top) + 1
2345
inventory_iterator = self._walkdirs(prefix)
2346
disk_iterator = osutils.walkdirs(disk_top, prefix)
2348
current_disk = disk_iterator.next()
2349
disk_finished = False
2351
if not (e.errno == errno.ENOENT or
2352
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2355
disk_finished = True
2357
current_inv = inventory_iterator.next()
2358
inv_finished = False
2359
except StopIteration:
2362
while not inv_finished or not disk_finished:
2364
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2365
cur_disk_dir_content) = current_disk
2367
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2368
cur_disk_dir_content) = ((None, None), None)
2369
if not disk_finished:
2370
# strip out .bzr dirs
2371
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2372
len(cur_disk_dir_content) > 0):
2373
# osutils.walkdirs can be made nicer -
2374
# yield the path-from-prefix rather than the pathjoined
2376
bzrdir_loc = bisect_left(cur_disk_dir_content,
2378
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2379
# we dont yield the contents of, or, .bzr itself.
2380
del cur_disk_dir_content[bzrdir_loc]
2382
# everything is unknown
2385
# everything is missing
2388
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2390
# disk is before inventory - unknown
2391
dirblock = [(relpath, basename, kind, stat, None, None) for
2392
relpath, basename, kind, stat, top_path in
2393
cur_disk_dir_content]
2394
yield (cur_disk_dir_relpath, None), dirblock
2396
current_disk = disk_iterator.next()
2397
except StopIteration:
2398
disk_finished = True
2400
# inventory is before disk - missing.
2401
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2402
for relpath, basename, dkind, stat, fileid, kind in
2404
yield (current_inv[0][0], current_inv[0][1]), dirblock
2406
current_inv = inventory_iterator.next()
2407
except StopIteration:
2410
# versioned present directory
2411
# merge the inventory and disk data together
2413
for relpath, subiterator in itertools.groupby(sorted(
2414
current_inv[1] + cur_disk_dir_content,
2415
key=operator.itemgetter(0)), operator.itemgetter(1)):
2416
path_elements = list(subiterator)
2417
if len(path_elements) == 2:
2418
inv_row, disk_row = path_elements
2419
# versioned, present file
2420
dirblock.append((inv_row[0],
2421
inv_row[1], disk_row[2],
2422
disk_row[3], inv_row[4],
2424
elif len(path_elements[0]) == 5:
2426
dirblock.append((path_elements[0][0],
2427
path_elements[0][1], path_elements[0][2],
2428
path_elements[0][3], None, None))
2429
elif len(path_elements[0]) == 6:
2430
# versioned, absent file.
2431
dirblock.append((path_elements[0][0],
2432
path_elements[0][1], 'unknown', None,
2433
path_elements[0][4], path_elements[0][5]))
2435
raise NotImplementedError('unreachable code')
2436
yield current_inv[0], dirblock
2438
current_inv = inventory_iterator.next()
2439
except StopIteration:
2442
current_disk = disk_iterator.next()
2443
except StopIteration:
2444
disk_finished = True
2446
def _walkdirs(self, prefix=""):
2447
"""Walk the directories of this tree.
2449
:prefix: is used as the directrory to start with.
2450
returns a generator which yields items in the form:
2451
((curren_directory_path, fileid),
2452
[(file1_path, file1_name, file1_kind, None, file1_id,
2455
_directory = 'directory'
2456
# get the root in the inventory
2457
inv = self.inventory
2458
top_id = inv.path2id(prefix)
2462
pending = [(prefix, '', _directory, None, top_id, None)]
2465
currentdir = pending.pop()
2466
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2467
top_id = currentdir[4]
2469
relroot = currentdir[0] + '/'
2472
# FIXME: stash the node in pending
2474
for name, child in entry.sorted_children():
2475
dirblock.append((relroot + name, name, child.kind, None,
2476
child.file_id, child.kind
2478
yield (currentdir[0], entry.file_id), dirblock
2479
# push the user specified dirs from dirblock
2480
for dir in reversed(dirblock):
2481
if dir[2] == _directory:
2484
@needs_tree_write_lock
2485
def auto_resolve(self):
2486
"""Automatically resolve text conflicts according to contents.
2488
Only text conflicts are auto_resolvable. Files with no conflict markers
2489
are considered 'resolved', because bzr always puts conflict markers
2490
into files that have text conflicts. The corresponding .THIS .BASE and
2491
.OTHER files are deleted, as per 'resolve'.
2492
:return: a tuple of ConflictLists: (un_resolved, resolved).
2494
un_resolved = _mod_conflicts.ConflictList()
2495
resolved = _mod_conflicts.ConflictList()
2496
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2497
for conflict in self.conflicts():
2498
if (conflict.typestring != 'text conflict' or
2499
self.kind(conflict.file_id) != 'file'):
2500
un_resolved.append(conflict)
2502
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2504
for line in my_file:
2505
if conflict_re.search(line):
2506
un_resolved.append(conflict)
2509
resolved.append(conflict)
2512
resolved.remove_files(self)
2513
self.set_conflicts(un_resolved)
2514
return un_resolved, resolved
2516
def _validate(self):
2517
"""Validate internal structures.
2519
This is meant mostly for the test suite. To give it a chance to detect
2520
corruption after actions have occurred. The default implementation is a
2523
:return: None. An exception should be raised if there is an error.
2528
class WorkingTree2(WorkingTree):
2529
"""This is the Format 2 working tree.
2531
This was the first weave based working tree.
2532
- uses os locks for locking.
2533
- uses the branch last-revision.
2536
def __init__(self, *args, **kwargs):
2537
super(WorkingTree2, self).__init__(*args, **kwargs)
2538
# WorkingTree2 has more of a constraint that self._inventory must
2539
# exist. Because this is an older format, we don't mind the overhead
2540
# caused by the extra computation here.
2542
# Newer WorkingTree's should only have self._inventory set when they
2544
if self._inventory is None:
2545
self.read_working_inventory()
2547
def lock_tree_write(self):
2548
"""See WorkingTree.lock_tree_write().
2550
In Format2 WorkingTrees we have a single lock for the branch and tree
2551
so lock_tree_write() degrades to lock_write().
2553
self.branch.lock_write()
2555
return self._control_files.lock_write()
2557
self.branch.unlock()
2561
# do non-implementation specific cleanup
2564
# we share control files:
2565
if self._control_files._lock_count == 3:
2566
# _inventory_is_modified is always False during a read lock.
2567
if self._inventory_is_modified:
2569
self._write_hashcache_if_dirty()
2571
# reverse order of locking.
2573
return self._control_files.unlock()
2575
self.branch.unlock()
2578
class WorkingTree3(WorkingTree):
2579
"""This is the Format 3 working tree.
2581
This differs from the base WorkingTree by:
2582
- having its own file lock
2583
- having its own last-revision property.
2585
This is new in bzr 0.8
2589
def _last_revision(self):
2590
"""See Mutable.last_revision."""
2592
return self._control_files.get('last-revision').read()
2593
except errors.NoSuchFile:
2594
return _mod_revision.NULL_REVISION
2596
def _change_last_revision(self, revision_id):
2597
"""See WorkingTree._change_last_revision."""
2598
if revision_id is None or revision_id == NULL_REVISION:
2600
self._control_files._transport.delete('last-revision')
2601
except errors.NoSuchFile:
2605
self._control_files.put_bytes('last-revision', revision_id)
2608
@needs_tree_write_lock
2609
def set_conflicts(self, conflicts):
2610
self._put_rio('conflicts', conflicts.to_stanzas(),
2613
@needs_tree_write_lock
2614
def add_conflicts(self, new_conflicts):
2615
conflict_set = set(self.conflicts())
2616
conflict_set.update(set(list(new_conflicts)))
2617
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2618
key=_mod_conflicts.Conflict.sort_key)))
2621
def conflicts(self):
2623
confile = self._control_files.get('conflicts')
2624
except errors.NoSuchFile:
2625
return _mod_conflicts.ConflictList()
2627
if confile.next() != CONFLICT_HEADER_1 + '\n':
2628
raise errors.ConflictFormatError()
2629
except StopIteration:
2630
raise errors.ConflictFormatError()
2631
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2634
# do non-implementation specific cleanup
2636
if self._control_files._lock_count == 1:
2637
# _inventory_is_modified is always False during a read lock.
2638
if self._inventory_is_modified:
2640
self._write_hashcache_if_dirty()
2641
# reverse order of locking.
2643
return self._control_files.unlock()
2645
self.branch.unlock()
2648
def get_conflicted_stem(path):
2649
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2650
if path.endswith(suffix):
2651
return path[:-len(suffix)]
2654
@deprecated_function(zero_eight)
2655
def is_control_file(filename):
2656
"""See WorkingTree.is_control_filename(filename)."""
2657
## FIXME: better check
2658
filename = normpath(filename)
2659
while filename != '':
2660
head, tail = os.path.split(filename)
2661
## mutter('check %r for control file' % ((head, tail),))
2664
if filename == head:
2670
class WorkingTreeFormat(object):
2671
"""An encapsulation of the initialization and open routines for a format.
2673
Formats provide three things:
2674
* An initialization routine,
2678
Formats are placed in an dict by their format string for reference
2679
during workingtree opening. Its not required that these be instances, they
2680
can be classes themselves with class methods - it simply depends on
2681
whether state is needed for a given format or not.
2683
Once a format is deprecated, just deprecate the initialize and open
2684
methods on the format class. Do not deprecate the object, as the
2685
object will be created every time regardless.
2688
_default_format = None
2689
"""The default format used for new trees."""
2692
"""The known formats."""
2694
requires_rich_root = False
2696
upgrade_recommended = False
2699
def find_format(klass, a_bzrdir):
2700
"""Return the format for the working tree object in a_bzrdir."""
2702
transport = a_bzrdir.get_workingtree_transport(None)
2703
format_string = transport.get("format").read()
2704
return klass._formats[format_string]
2705
except errors.NoSuchFile:
2706
raise errors.NoWorkingTree(base=transport.base)
2708
raise errors.UnknownFormatError(format=format_string,
2709
kind="working tree")
2711
def __eq__(self, other):
2712
return self.__class__ is other.__class__
2714
def __ne__(self, other):
2715
return not (self == other)
2718
def get_default_format(klass):
2719
"""Return the current default format."""
2720
return klass._default_format
2722
def get_format_string(self):
2723
"""Return the ASCII format string that identifies this format."""
2724
raise NotImplementedError(self.get_format_string)
2726
def get_format_description(self):
2727
"""Return the short description for this format."""
2728
raise NotImplementedError(self.get_format_description)
2730
def is_supported(self):
2731
"""Is this format supported?
2733
Supported formats can be initialized and opened.
2734
Unsupported formats may not support initialization or committing or
2735
some other features depending on the reason for not being supported.
2740
def register_format(klass, format):
2741
klass._formats[format.get_format_string()] = format
2744
def set_default_format(klass, format):
2745
klass._default_format = format
2748
def unregister_format(klass, format):
2749
assert klass._formats[format.get_format_string()] is format
2750
del klass._formats[format.get_format_string()]
2753
class WorkingTreeFormat2(WorkingTreeFormat):
2754
"""The second working tree format.
2756
This format modified the hash cache from the format 1 hash cache.
2759
upgrade_recommended = True
2761
def get_format_description(self):
2762
"""See WorkingTreeFormat.get_format_description()."""
2763
return "Working tree format 2"
2765
def stub_initialize_remote(self, control_files):
2766
"""As a special workaround create critical control files for a remote working tree
2768
This ensures that it can later be updated and dealt with locally,
2769
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2770
no working tree. (See bug #43064).
2774
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2776
control_files.put('inventory', sio)
2778
control_files.put_bytes('pending-merges', '')
2781
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2782
accelerator_tree=None, hardlink=False):
2783
"""See WorkingTreeFormat.initialize()."""
2784
if not isinstance(a_bzrdir.transport, LocalTransport):
2785
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2786
if from_branch is not None:
2787
branch = from_branch
2789
branch = a_bzrdir.open_branch()
2790
if revision_id is None:
2791
revision_id = _mod_revision.ensure_null(branch.last_revision())
2794
branch.generate_revision_history(revision_id)
2798
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2804
basis_tree = branch.repository.revision_tree(revision_id)
2805
if basis_tree.inventory.root is not None:
2806
wt.set_root_id(basis_tree.get_root_id())
2807
# set the parent list and cache the basis tree.
2808
if _mod_revision.is_null(revision_id):
2811
parent_trees = [(revision_id, basis_tree)]
2812
wt.set_parent_trees(parent_trees)
2813
transform.build_tree(basis_tree, wt)
2817
super(WorkingTreeFormat2, self).__init__()
2818
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2820
def open(self, a_bzrdir, _found=False):
2821
"""Return the WorkingTree object for a_bzrdir
2823
_found is a private parameter, do not use it. It is used to indicate
2824
if format probing has already been done.
2827
# we are being called directly and must probe.
2828
raise NotImplementedError
2829
if not isinstance(a_bzrdir.transport, LocalTransport):
2830
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2831
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2837
class WorkingTreeFormat3(WorkingTreeFormat):
2838
"""The second working tree format updated to record a format marker.
2841
- exists within a metadir controlling .bzr
2842
- includes an explicit version marker for the workingtree control
2843
files, separate from the BzrDir format
2844
- modifies the hash cache format
2846
- uses a LockDir to guard access for writes.
2849
upgrade_recommended = True
2851
def get_format_string(self):
2852
"""See WorkingTreeFormat.get_format_string()."""
2853
return "Bazaar-NG Working Tree format 3"
2855
def get_format_description(self):
2856
"""See WorkingTreeFormat.get_format_description()."""
2857
return "Working tree format 3"
2859
_lock_file_name = 'lock'
2860
_lock_class = LockDir
2862
_tree_class = WorkingTree3
2864
def __get_matchingbzrdir(self):
2865
return bzrdir.BzrDirMetaFormat1()
2867
_matchingbzrdir = property(__get_matchingbzrdir)
2869
def _open_control_files(self, a_bzrdir):
2870
transport = a_bzrdir.get_workingtree_transport(None)
2871
return LockableFiles(transport, self._lock_file_name,
2874
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2875
accelerator_tree=None, hardlink=False):
2876
"""See WorkingTreeFormat.initialize().
2878
:param revision_id: if supplied, create a working tree at a different
2879
revision than the branch is at.
2880
:param accelerator_tree: A tree which can be used for retrieving file
2881
contents more quickly than the revision tree, i.e. a workingtree.
2882
The revision tree will be used for cases where accelerator_tree's
2883
content is different.
2884
:param hardlink: If true, hard-link files from accelerator_tree,
2887
if not isinstance(a_bzrdir.transport, LocalTransport):
2888
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2889
transport = a_bzrdir.get_workingtree_transport(self)
2890
control_files = self._open_control_files(a_bzrdir)
2891
control_files.create_lock()
2892
control_files.lock_write()
2893
control_files.put_utf8('format', self.get_format_string())
2894
if from_branch is not None:
2895
branch = from_branch
2897
branch = a_bzrdir.open_branch()
2898
if revision_id is None:
2899
revision_id = _mod_revision.ensure_null(branch.last_revision())
2900
# WorkingTree3 can handle an inventory which has a unique root id.
2901
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2902
# those trees. And because there isn't a format bump inbetween, we
2903
# are maintaining compatibility with older clients.
2904
# inv = Inventory(root_id=gen_root_id())
2905
inv = self._initial_inventory()
2906
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2912
_control_files=control_files)
2913
wt.lock_tree_write()
2915
basis_tree = branch.repository.revision_tree(revision_id)
2916
# only set an explicit root id if there is one to set.
2917
if basis_tree.inventory.root is not None:
2918
wt.set_root_id(basis_tree.get_root_id())
2919
if revision_id == NULL_REVISION:
2920
wt.set_parent_trees([])
2922
wt.set_parent_trees([(revision_id, basis_tree)])
2923
transform.build_tree(basis_tree, wt)
2925
# Unlock in this order so that the unlock-triggers-flush in
2926
# WorkingTree is given a chance to fire.
2927
control_files.unlock()
2931
def _initial_inventory(self):
2935
super(WorkingTreeFormat3, self).__init__()
2937
def open(self, a_bzrdir, _found=False):
2938
"""Return the WorkingTree object for a_bzrdir
2940
_found is a private parameter, do not use it. It is used to indicate
2941
if format probing has already been done.
2944
# we are being called directly and must probe.
2945
raise NotImplementedError
2946
if not isinstance(a_bzrdir.transport, LocalTransport):
2947
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2948
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2951
def _open(self, a_bzrdir, control_files):
2952
"""Open the tree itself.
2954
:param a_bzrdir: the dir for the tree.
2955
:param control_files: the control files for the tree.
2957
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2961
_control_files=control_files)
2964
return self.get_format_string()
2967
__default_format = WorkingTreeFormat4()
2968
WorkingTreeFormat.register_format(__default_format)
2969
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2970
WorkingTreeFormat.set_default_format(__default_format)
2971
# formats which have no format string are not discoverable
2972
# and not independently creatable, so are not registered.
2973
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
