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,
68
revision as _mod_revision,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
86
from bzrlib import symbol_versioning
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
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)
275
fget=lambda self: self._branch,
276
doc="""The branch this WorkingTree is connected to.
278
This cannot be set - it is reflective of the actual disk structure
279
the working tree has been constructed from.
282
def break_lock(self):
283
"""Break a lock if one is present from another instance.
285
Uses the ui factory to ask for confirmation if the lock may be from
288
This will probe the repository for its lock as well.
290
self._control_files.break_lock()
291
self.branch.break_lock()
293
def requires_rich_root(self):
294
return self._format.requires_rich_root
296
def supports_tree_reference(self):
299
def _set_inventory(self, inv, dirty):
300
"""Set the internal cached inventory.
302
:param inv: The inventory to set.
303
:param dirty: A boolean indicating whether the inventory is the same
304
logical inventory as whats on disk. If True the inventory is not
305
the same and should be written to disk or data will be lost, if
306
False then the inventory is the same as that on disk and any
307
serialisation would be unneeded overhead.
309
assert inv.root is not None
310
self._inventory = inv
311
self._inventory_is_modified = dirty
314
def open(path=None, _unsupported=False):
315
"""Open an existing working tree at path.
319
path = os.path.getcwdu()
320
control = bzrdir.BzrDir.open(path, _unsupported)
321
return control.open_workingtree(_unsupported)
324
def open_containing(path=None):
325
"""Open an existing working tree which has its root about path.
327
This probes for a working tree at path and searches upwards from there.
329
Basically we keep looking up until we find the control directory or
330
run into /. If there isn't one, raises NotBranchError.
331
TODO: give this a new exception.
332
If there is one, it is returned, along with the unused portion of path.
334
:return: The WorkingTree that contains 'path', and the rest of path
337
path = osutils.getcwd()
338
control, relpath = bzrdir.BzrDir.open_containing(path)
340
return control.open_workingtree(), relpath
343
def open_downlevel(path=None):
344
"""Open an unsupported working tree.
346
Only intended for advanced situations like upgrading part of a bzrdir.
348
return WorkingTree.open(path, _unsupported=True)
350
# should be deprecated - this is slow and in any case treating them as a
351
# container is (we now know) bad style -- mbp 20070302
352
## @deprecated_method(zero_fifteen)
354
"""Iterate through file_ids for this tree.
356
file_ids are in a WorkingTree if they are in the working inventory
357
and the working file exists.
359
inv = self._inventory
360
for path, ie in inv.iter_entries():
361
if osutils.lexists(self.abspath(path)):
365
return "<%s of %s>" % (self.__class__.__name__,
366
getattr(self, 'basedir', None))
368
def abspath(self, filename):
369
return pathjoin(self.basedir, filename)
371
def basis_tree(self):
372
"""Return RevisionTree for the current last revision.
374
If the left most parent is a ghost then the returned tree will be an
375
empty tree - one obtained by calling repository.revision_tree(None).
378
revision_id = self.get_parent_ids()[0]
380
# no parents, return an empty revision tree.
381
# in the future this should return the tree for
382
# 'empty:' - the implicit root empty tree.
383
return self.branch.repository.revision_tree(None)
385
return self.revision_tree(revision_id)
386
except errors.NoSuchRevision:
388
# No cached copy available, retrieve from the repository.
389
# FIXME? RBC 20060403 should we cache the inventory locally
392
return self.branch.repository.revision_tree(revision_id)
393
except errors.RevisionNotPresent:
394
# the basis tree *may* be a ghost or a low level error may have
395
# occured. If the revision is present, its a problem, if its not
397
if self.branch.repository.has_revision(revision_id):
399
# the basis tree is a ghost so return an empty tree.
400
return self.branch.repository.revision_tree(None)
403
self._flush_ignore_list_cache()
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
451
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id, path=None):
456
file_id = osutils.safe_file_id(file_id)
457
path = self.id2path(file_id)
458
return self.get_file_byname(path)
460
def get_file_text(self, file_id):
461
file_id = osutils.safe_file_id(file_id)
462
return self.get_file(file_id).read()
464
def get_file_byname(self, filename):
465
return file(self.abspath(filename), 'rb')
468
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
469
"""See Tree.annotate_iter
471
This implementation will use the basis tree implementation if possible.
472
Lines not in the basis are attributed to CURRENT_REVISION
474
If there are pending merges, lines added by those merges will be
475
incorrectly attributed to CURRENT_REVISION (but after committing, the
476
attribution will be correct).
478
file_id = osutils.safe_file_id(file_id)
479
basis = self.basis_tree()
482
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
483
require_versioned=True).next()
484
changed_content, kind = changes[2], changes[6]
485
if not changed_content:
486
return basis.annotate_iter(file_id)
490
if kind[0] != 'file':
493
old_lines = list(basis.annotate_iter(file_id))
495
for tree in self.branch.repository.revision_trees(
496
self.get_parent_ids()[1:]):
497
if file_id not in tree:
499
old.append(list(tree.annotate_iter(file_id)))
500
return annotate.reannotate(old, self.get_file(file_id).readlines(),
505
def _get_ancestors(self, default_revision):
506
ancestors = set([default_revision])
507
for parent_id in self.get_parent_ids():
508
ancestors.update(self.branch.repository.get_ancestry(
509
parent_id, topo_sorted=False))
512
def get_parent_ids(self):
513
"""See Tree.get_parent_ids.
515
This implementation reads the pending merges list and last_revision
516
value and uses that to decide what the parents list should be.
518
last_rev = _mod_revision.ensure_null(self._last_revision())
519
if _mod_revision.NULL_REVISION == last_rev:
524
merges_file = self._control_files.get('pending-merges')
525
except errors.NoSuchFile:
528
for l in merges_file.readlines():
529
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
530
parents.append(revision_id)
534
def get_root_id(self):
535
"""Return the id of this trees root"""
536
return self._inventory.root.file_id
538
def _get_store_filename(self, file_id):
539
## XXX: badly named; this is not in the store at all
540
file_id = osutils.safe_file_id(file_id)
541
return self.abspath(self.id2path(file_id))
544
def clone(self, to_bzrdir, revision_id=None):
545
"""Duplicate this working tree into to_bzr, including all state.
547
Specifically modified files are kept as modified, but
548
ignored and unknown files are discarded.
550
If you want to make a new line of development, see bzrdir.sprout()
553
If not None, the cloned tree will have its last revision set to
554
revision, and and difference between the source trees last revision
555
and this one merged in.
557
# assumes the target bzr dir format is compatible.
558
result = self._format.initialize(to_bzrdir)
559
self.copy_content_into(result, revision_id)
563
def copy_content_into(self, tree, revision_id=None):
564
"""Copy the current content and user files of this tree into tree."""
565
tree.set_root_id(self.get_root_id())
566
if revision_id is None:
567
merge.transform_tree(tree, self)
569
# TODO now merge from tree.last_revision to revision (to preserve
570
# user local changes)
571
merge.transform_tree(tree, self)
572
tree.set_parent_ids([revision_id])
574
def id2abspath(self, file_id):
575
file_id = osutils.safe_file_id(file_id)
576
return self.abspath(self.id2path(file_id))
578
def has_id(self, file_id):
579
# files that have been deleted are excluded
580
file_id = osutils.safe_file_id(file_id)
582
if not inv.has_id(file_id):
584
path = inv.id2path(file_id)
585
return osutils.lexists(self.abspath(path))
587
def has_or_had_id(self, file_id):
588
file_id = osutils.safe_file_id(file_id)
589
if file_id == self.inventory.root.file_id:
591
return self.inventory.has_id(file_id)
593
__contains__ = has_id
595
def get_file_size(self, file_id):
596
file_id = osutils.safe_file_id(file_id)
597
return os.path.getsize(self.id2abspath(file_id))
600
def get_file_sha1(self, file_id, path=None, stat_value=None):
601
file_id = osutils.safe_file_id(file_id)
603
path = self._inventory.id2path(file_id)
604
return self._hashcache.get_sha1(path, stat_value)
606
def get_file_mtime(self, file_id, path=None):
607
file_id = osutils.safe_file_id(file_id)
609
path = self.inventory.id2path(file_id)
610
return os.lstat(self.abspath(path)).st_mtime
612
if not supports_executable():
613
def is_executable(self, file_id, path=None):
614
file_id = osutils.safe_file_id(file_id)
615
return self._inventory[file_id].executable
617
def is_executable(self, file_id, path=None):
619
file_id = osutils.safe_file_id(file_id)
620
path = self.id2path(file_id)
621
mode = os.lstat(self.abspath(path)).st_mode
622
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
624
@needs_tree_write_lock
625
def _add(self, files, ids, kinds):
626
"""See MutableTree._add."""
627
# TODO: Re-adding a file that is removed in the working copy
628
# should probably put it back with the previous ID.
629
# the read and write working inventory should not occur in this
630
# function - they should be part of lock_write and unlock.
632
for f, file_id, kind in zip(files, ids, kinds):
633
assert kind is not None
635
inv.add_path(f, kind=kind)
637
file_id = osutils.safe_file_id(file_id)
638
inv.add_path(f, kind=kind, file_id=file_id)
639
self._inventory_is_modified = True
641
@needs_tree_write_lock
642
def _gather_kinds(self, files, kinds):
643
"""See MutableTree._gather_kinds."""
644
for pos, f in enumerate(files):
645
if kinds[pos] is None:
646
fullpath = normpath(self.abspath(f))
648
kinds[pos] = file_kind(fullpath)
650
if e.errno == errno.ENOENT:
651
raise errors.NoSuchFile(fullpath)
654
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
655
"""Add revision_id as a parent.
657
This is equivalent to retrieving the current list of parent ids
658
and setting the list to its value plus revision_id.
660
:param revision_id: The revision id to add to the parent list. It may
661
be a ghost revision as long as its not the first parent to be added,
662
or the allow_leftmost_as_ghost parameter is set True.
663
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
665
parents = self.get_parent_ids() + [revision_id]
666
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
667
or allow_leftmost_as_ghost)
669
@needs_tree_write_lock
670
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
671
"""Add revision_id, tree tuple as a parent.
673
This is equivalent to retrieving the current list of parent trees
674
and setting the list to its value plus parent_tuple. See also
675
add_parent_tree_id - if you only have a parent id available it will be
676
simpler to use that api. If you have the parent already available, using
677
this api is preferred.
679
:param parent_tuple: The (revision id, tree) to add to the parent list.
680
If the revision_id is a ghost, pass None for the tree.
681
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
683
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
684
if len(parent_ids) > 1:
685
# the leftmost may have already been a ghost, preserve that if it
687
allow_leftmost_as_ghost = True
688
self.set_parent_ids(parent_ids,
689
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
691
@needs_tree_write_lock
692
def add_pending_merge(self, *revision_ids):
693
# TODO: Perhaps should check at this point that the
694
# history of the revision is actually present?
695
parents = self.get_parent_ids()
697
for rev_id in revision_ids:
698
if rev_id in parents:
700
parents.append(rev_id)
703
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
705
@deprecated_method(zero_eleven)
707
def pending_merges(self):
708
"""Return a list of pending merges.
710
These are revisions that have been merged into the working
711
directory but not yet committed.
713
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
714
instead - which is available on all tree objects.
716
return self.get_parent_ids()[1:]
718
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
719
"""Common ghost checking functionality from set_parent_*.
721
This checks that the left hand-parent exists if there are any
724
if len(revision_ids) > 0:
725
leftmost_id = revision_ids[0]
726
if (not allow_leftmost_as_ghost and not
727
self.branch.repository.has_revision(leftmost_id)):
728
raise errors.GhostRevisionUnusableHere(leftmost_id)
730
def _set_merges_from_parent_ids(self, parent_ids):
731
merges = parent_ids[1:]
732
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
734
@needs_tree_write_lock
735
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
736
"""Set the parent ids to revision_ids.
738
See also set_parent_trees. This api will try to retrieve the tree data
739
for each element of revision_ids from the trees repository. If you have
740
tree data already available, it is more efficient to use
741
set_parent_trees rather than set_parent_ids. set_parent_ids is however
742
an easier API to use.
744
:param revision_ids: The revision_ids to set as the parent ids of this
745
working tree. Any of these may be ghosts.
747
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
748
self._check_parents_for_ghosts(revision_ids,
749
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
750
for revision_id in revision_ids:
751
_mod_revision.check_not_reserved_id(revision_id)
753
if len(revision_ids) > 0:
754
self.set_last_revision(revision_ids[0])
756
self.set_last_revision(_mod_revision.NULL_REVISION)
758
self._set_merges_from_parent_ids(revision_ids)
760
@needs_tree_write_lock
761
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
762
"""See MutableTree.set_parent_trees."""
763
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
764
for revision_id in parent_ids:
765
_mod_revision.check_not_reserved_id(revision_id)
767
self._check_parents_for_ghosts(parent_ids,
768
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
770
if len(parent_ids) == 0:
771
leftmost_parent_id = _mod_revision.NULL_REVISION
772
leftmost_parent_tree = None
774
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
776
if self._change_last_revision(leftmost_parent_id):
777
if leftmost_parent_tree is None:
778
# If we don't have a tree, fall back to reading the
779
# parent tree from the repository.
780
self._cache_basis_inventory(leftmost_parent_id)
782
inv = leftmost_parent_tree.inventory
783
xml = self._create_basis_xml_from_inventory(
784
leftmost_parent_id, inv)
785
self._write_basis_inventory(xml)
786
self._set_merges_from_parent_ids(parent_ids)
788
@needs_tree_write_lock
789
def set_pending_merges(self, rev_list):
790
parents = self.get_parent_ids()
791
leftmost = parents[:1]
792
new_parents = leftmost + rev_list
793
self.set_parent_ids(new_parents)
795
@needs_tree_write_lock
796
def set_merge_modified(self, modified_hashes):
798
for file_id, hash in modified_hashes.iteritems():
799
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
800
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
802
def _put_rio(self, filename, stanzas, header):
803
self._must_be_locked()
804
my_file = rio_file(stanzas, header)
805
self._control_files.put(filename, my_file)
807
@needs_write_lock # because merge pulls data into the branch.
808
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
810
"""Merge from a branch into this working tree.
812
:param branch: The branch to merge from.
813
:param to_revision: If non-None, the merge will merge to to_revision,
814
but not beyond it. to_revision does not need to be in the history
815
of the branch when it is supplied. If None, to_revision defaults to
816
branch.last_revision().
818
from bzrlib.merge import Merger, Merge3Merger
819
pb = bzrlib.ui.ui_factory.nested_progress_bar()
821
merger = Merger(self.branch, this_tree=self, pb=pb)
822
merger.pp = ProgressPhase("Merge phase", 5, pb)
823
merger.pp.next_phase()
824
# check that there are no
826
merger.check_basis(check_clean=True, require_commits=False)
827
if to_revision is None:
828
to_revision = _mod_revision.ensure_null(branch.last_revision())
830
to_revision = osutils.safe_revision_id(to_revision)
831
merger.other_rev_id = to_revision
832
if _mod_revision.is_null(merger.other_rev_id):
833
raise errors.NoCommits(branch)
834
self.branch.fetch(branch, last_revision=merger.other_rev_id)
835
merger.other_basis = merger.other_rev_id
836
merger.other_tree = self.branch.repository.revision_tree(
838
merger.other_branch = branch
839
merger.pp.next_phase()
840
if from_revision is None:
843
merger.set_base_revision(from_revision, branch)
844
if merger.base_rev_id == merger.other_rev_id:
845
raise errors.PointlessMerge
846
merger.backup_files = False
847
if merge_type is None:
848
merger.merge_type = Merge3Merger
850
merger.merge_type = merge_type
851
merger.set_interesting_files(None)
852
merger.show_base = False
853
merger.reprocess = False
854
conflicts = merger.do_merge()
861
def merge_modified(self):
862
"""Return a dictionary of files modified by a merge.
864
The list is initialized by WorkingTree.set_merge_modified, which is
865
typically called after we make some automatic updates to the tree
868
This returns a map of file_id->sha1, containing only files which are
869
still in the working inventory and have that text hash.
872
hashfile = self._control_files.get('merge-hashes')
873
except errors.NoSuchFile:
877
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
878
raise errors.MergeModifiedFormatError()
879
except StopIteration:
880
raise errors.MergeModifiedFormatError()
881
for s in RioReader(hashfile):
882
# RioReader reads in Unicode, so convert file_ids back to utf8
883
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
884
if file_id not in self.inventory:
886
text_hash = s.get("hash")
887
if text_hash == self.get_file_sha1(file_id):
888
merge_hashes[file_id] = text_hash
892
def mkdir(self, path, file_id=None):
893
"""See MutableTree.mkdir()."""
895
file_id = generate_ids.gen_file_id(os.path.basename(path))
896
os.mkdir(self.abspath(path))
897
self.add(path, file_id, 'directory')
900
def get_symlink_target(self, file_id):
901
file_id = osutils.safe_file_id(file_id)
902
return os.readlink(self.id2abspath(file_id))
905
def subsume(self, other_tree):
906
def add_children(inventory, entry):
907
for child_entry in entry.children.values():
908
inventory._byid[child_entry.file_id] = child_entry
909
if child_entry.kind == 'directory':
910
add_children(inventory, child_entry)
911
if other_tree.get_root_id() == self.get_root_id():
912
raise errors.BadSubsumeSource(self, other_tree,
913
'Trees have the same root')
915
other_tree_path = self.relpath(other_tree.basedir)
916
except errors.PathNotChild:
917
raise errors.BadSubsumeSource(self, other_tree,
918
'Tree is not contained by the other')
919
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
920
if new_root_parent is None:
921
raise errors.BadSubsumeSource(self, other_tree,
922
'Parent directory is not versioned.')
923
# We need to ensure that the result of a fetch will have a
924
# versionedfile for the other_tree root, and only fetching into
925
# RepositoryKnit2 guarantees that.
926
if not self.branch.repository.supports_rich_root():
927
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
928
other_tree.lock_tree_write()
930
new_parents = other_tree.get_parent_ids()
931
other_root = other_tree.inventory.root
932
other_root.parent_id = new_root_parent
933
other_root.name = osutils.basename(other_tree_path)
934
self.inventory.add(other_root)
935
add_children(self.inventory, other_root)
936
self._write_inventory(self.inventory)
937
# normally we don't want to fetch whole repositories, but i think
938
# here we really do want to consolidate the whole thing.
939
for parent_id in other_tree.get_parent_ids():
940
self.branch.fetch(other_tree.branch, parent_id)
941
self.add_parent_tree_id(parent_id)
944
other_tree.bzrdir.retire_bzrdir()
946
@needs_tree_write_lock
947
def extract(self, file_id, format=None):
948
"""Extract a subtree from this tree.
950
A new branch will be created, relative to the path for this tree.
954
segments = osutils.splitpath(path)
955
transport = self.branch.bzrdir.root_transport
956
for name in segments:
957
transport = transport.clone(name)
958
transport.ensure_base()
961
sub_path = self.id2path(file_id)
962
branch_transport = mkdirs(sub_path)
964
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
965
branch_transport.ensure_base()
966
branch_bzrdir = format.initialize_on_transport(branch_transport)
968
repo = branch_bzrdir.find_repository()
969
except errors.NoRepositoryPresent:
970
repo = branch_bzrdir.create_repository()
971
assert repo.supports_rich_root()
973
if not repo.supports_rich_root():
974
raise errors.RootNotRich()
975
new_branch = branch_bzrdir.create_branch()
976
new_branch.pull(self.branch)
977
for parent_id in self.get_parent_ids():
978
new_branch.fetch(self.branch, parent_id)
979
tree_transport = self.bzrdir.root_transport.clone(sub_path)
980
if tree_transport.base != branch_transport.base:
981
tree_bzrdir = format.initialize_on_transport(tree_transport)
982
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
984
tree_bzrdir = branch_bzrdir
985
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
986
wt.set_parent_ids(self.get_parent_ids())
987
my_inv = self.inventory
988
child_inv = Inventory(root_id=None)
989
new_root = my_inv[file_id]
990
my_inv.remove_recursive_id(file_id)
991
new_root.parent_id = None
992
child_inv.add(new_root)
993
self._write_inventory(my_inv)
994
wt._write_inventory(child_inv)
997
def _serialize(self, inventory, out_file):
998
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1001
def _deserialize(selt, in_file):
1002
return xml5.serializer_v5.read_inventory(in_file)
1005
"""Write the in memory inventory to disk."""
1006
# TODO: Maybe this should only write on dirty ?
1007
if self._control_files._lock_mode != 'w':
1008
raise errors.NotWriteLocked(self)
1010
self._serialize(self._inventory, sio)
1012
self._control_files.put('inventory', sio)
1013
self._inventory_is_modified = False
1015
def _kind(self, relpath):
1016
return osutils.file_kind(self.abspath(relpath))
1018
def list_files(self, include_root=False):
1019
"""Recursively list all files as (path, class, kind, id, entry).
1021
Lists, but does not descend into unversioned directories.
1023
This does not include files that have been deleted in this
1026
Skips the control directory.
1028
# list_files is an iterator, so @needs_read_lock doesn't work properly
1029
# with it. So callers should be careful to always read_lock the tree.
1030
if not self.is_locked():
1031
raise errors.ObjectNotLocked(self)
1033
inv = self.inventory
1034
if include_root is True:
1035
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1036
# Convert these into local objects to save lookup times
1037
pathjoin = osutils.pathjoin
1038
file_kind = self._kind
1040
# transport.base ends in a slash, we want the piece
1041
# between the last two slashes
1042
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1044
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1046
# directory file_id, relative path, absolute path, reverse sorted children
1047
children = os.listdir(self.basedir)
1049
# jam 20060527 The kernel sized tree seems equivalent whether we
1050
# use a deque and popleft to keep them sorted, or if we use a plain
1051
# list and just reverse() them.
1052
children = collections.deque(children)
1053
stack = [(inv.root.file_id, u'', self.basedir, children)]
1055
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1058
f = children.popleft()
1059
## TODO: If we find a subdirectory with its own .bzr
1060
## directory, then that is a separate tree and we
1061
## should exclude it.
1063
# the bzrdir for this tree
1064
if transport_base_dir == f:
1067
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1068
# and 'f' doesn't begin with one, we can do a string op, rather
1069
# than the checks of pathjoin(), all relative paths will have an extra slash
1071
fp = from_dir_relpath + '/' + f
1074
fap = from_dir_abspath + '/' + f
1076
f_ie = inv.get_child(from_dir_id, f)
1079
elif self.is_ignored(fp[1:]):
1082
# we may not have found this file, because of a unicode issue
1083
f_norm, can_access = osutils.normalized_filename(f)
1084
if f == f_norm or not can_access:
1085
# No change, so treat this file normally
1088
# this file can be accessed by a normalized path
1089
# check again if it is versioned
1090
# these lines are repeated here for performance
1092
fp = from_dir_relpath + '/' + f
1093
fap = from_dir_abspath + '/' + f
1094
f_ie = inv.get_child(from_dir_id, f)
1097
elif self.is_ignored(fp[1:]):
1104
# make a last minute entry
1106
yield fp[1:], c, fk, f_ie.file_id, f_ie
1109
yield fp[1:], c, fk, None, fk_entries[fk]()
1111
yield fp[1:], c, fk, None, TreeEntry()
1114
if fk != 'directory':
1117
# But do this child first
1118
new_children = os.listdir(fap)
1120
new_children = collections.deque(new_children)
1121
stack.append((f_ie.file_id, fp, fap, new_children))
1122
# Break out of inner loop,
1123
# so that we start outer loop with child
1126
# if we finished all children, pop it off the stack
1129
@needs_tree_write_lock
1130
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1133
to_dir must exist in the inventory.
1135
If to_dir exists and is a directory, the files are moved into
1136
it, keeping their old names.
1138
Note that to_dir is only the last component of the new name;
1139
this doesn't change the directory.
1141
For each entry in from_paths the move mode will be determined
1144
The first mode moves the file in the filesystem and updates the
1145
inventory. The second mode only updates the inventory without
1146
touching the file on the filesystem. This is the new mode introduced
1149
move uses the second mode if 'after == True' and the target is not
1150
versioned but present in the working tree.
1152
move uses the second mode if 'after == False' and the source is
1153
versioned but no longer in the working tree, and the target is not
1154
versioned but present in the working tree.
1156
move uses the first mode if 'after == False' and the source is
1157
versioned and present in the working tree, and the target is not
1158
versioned and not present in the working tree.
1160
Everything else results in an error.
1162
This returns a list of (from_path, to_path) pairs for each
1163
entry that is moved.
1168
# check for deprecated use of signature
1170
to_dir = kwargs.get('to_name', None)
1172
raise TypeError('You must supply a target directory')
1174
symbol_versioning.warn('The parameter to_name was deprecated'
1175
' in version 0.13. Use to_dir instead',
1178
# check destination directory
1179
assert not isinstance(from_paths, basestring)
1180
inv = self.inventory
1181
to_abs = self.abspath(to_dir)
1182
if not isdir(to_abs):
1183
raise errors.BzrMoveFailedError('',to_dir,
1184
errors.NotADirectory(to_abs))
1185
if not self.has_filename(to_dir):
1186
raise errors.BzrMoveFailedError('',to_dir,
1187
errors.NotInWorkingDirectory(to_dir))
1188
to_dir_id = inv.path2id(to_dir)
1189
if to_dir_id is None:
1190
raise errors.BzrMoveFailedError('',to_dir,
1191
errors.NotVersionedError(path=str(to_dir)))
1193
to_dir_ie = inv[to_dir_id]
1194
if to_dir_ie.kind != 'directory':
1195
raise errors.BzrMoveFailedError('',to_dir,
1196
errors.NotADirectory(to_abs))
1198
# create rename entries and tuples
1199
for from_rel in from_paths:
1200
from_tail = splitpath(from_rel)[-1]
1201
from_id = inv.path2id(from_rel)
1203
raise errors.BzrMoveFailedError(from_rel,to_dir,
1204
errors.NotVersionedError(path=str(from_rel)))
1206
from_entry = inv[from_id]
1207
from_parent_id = from_entry.parent_id
1208
to_rel = pathjoin(to_dir, from_tail)
1209
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1211
from_tail=from_tail,
1212
from_parent_id=from_parent_id,
1213
to_rel=to_rel, to_tail=from_tail,
1214
to_parent_id=to_dir_id)
1215
rename_entries.append(rename_entry)
1216
rename_tuples.append((from_rel, to_rel))
1218
# determine which move mode to use. checks also for movability
1219
rename_entries = self._determine_mv_mode(rename_entries, after)
1221
original_modified = self._inventory_is_modified
1224
self._inventory_is_modified = True
1225
self._move(rename_entries)
1227
# restore the inventory on error
1228
self._inventory_is_modified = original_modified
1230
self._write_inventory(inv)
1231
return rename_tuples
1233
def _determine_mv_mode(self, rename_entries, after=False):
1234
"""Determines for each from-to pair if both inventory and working tree
1235
or only the inventory has to be changed.
1237
Also does basic plausability tests.
1239
inv = self.inventory
1241
for rename_entry in rename_entries:
1242
# store to local variables for easier reference
1243
from_rel = rename_entry.from_rel
1244
from_id = rename_entry.from_id
1245
to_rel = rename_entry.to_rel
1246
to_id = inv.path2id(to_rel)
1247
only_change_inv = False
1249
# check the inventory for source and destination
1251
raise errors.BzrMoveFailedError(from_rel,to_rel,
1252
errors.NotVersionedError(path=str(from_rel)))
1253
if to_id is not None:
1254
raise errors.BzrMoveFailedError(from_rel,to_rel,
1255
errors.AlreadyVersionedError(path=str(to_rel)))
1257
# try to determine the mode for rename (only change inv or change
1258
# inv and file system)
1260
if not self.has_filename(to_rel):
1261
raise errors.BzrMoveFailedError(from_id,to_rel,
1262
errors.NoSuchFile(path=str(to_rel),
1263
extra="New file has not been created yet"))
1264
only_change_inv = True
1265
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1266
only_change_inv = True
1267
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1268
only_change_inv = False
1270
# something is wrong, so lets determine what exactly
1271
if not self.has_filename(from_rel) and \
1272
not self.has_filename(to_rel):
1273
raise errors.BzrRenameFailedError(from_rel,to_rel,
1274
errors.PathsDoNotExist(paths=(str(from_rel),
1277
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1278
extra="(Use --after to update the Bazaar id)")
1279
rename_entry.only_change_inv = only_change_inv
1280
return rename_entries
1282
def _move(self, rename_entries):
1283
"""Moves a list of files.
1285
Depending on the value of the flag 'only_change_inv', the
1286
file will be moved on the file system or not.
1288
inv = self.inventory
1291
for entry in rename_entries:
1293
self._move_entry(entry)
1295
self._rollback_move(moved)
1299
def _rollback_move(self, moved):
1300
"""Try to rollback a previous move in case of an filesystem error."""
1301
inv = self.inventory
1304
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1305
entry.to_tail, entry.to_parent_id, entry.from_rel,
1306
entry.from_tail, entry.from_parent_id,
1307
entry.only_change_inv))
1308
except errors.BzrMoveFailedError, e:
1309
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1310
" The working tree is in an inconsistent state."
1311
" Please consider doing a 'bzr revert'."
1312
" Error message is: %s" % e)
1314
def _move_entry(self, entry):
1315
inv = self.inventory
1316
from_rel_abs = self.abspath(entry.from_rel)
1317
to_rel_abs = self.abspath(entry.to_rel)
1318
if from_rel_abs == to_rel_abs:
1319
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1320
"Source and target are identical.")
1322
if not entry.only_change_inv:
1324
osutils.rename(from_rel_abs, to_rel_abs)
1326
raise errors.BzrMoveFailedError(entry.from_rel,
1328
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1330
@needs_tree_write_lock
1331
def rename_one(self, from_rel, to_rel, after=False):
1334
This can change the directory or the filename or both.
1336
rename_one has several 'modes' to work. First, it can rename a physical
1337
file and change the file_id. That is the normal mode. Second, it can
1338
only change the file_id without touching any physical file. This is
1339
the new mode introduced in version 0.15.
1341
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1342
versioned but present in the working tree.
1344
rename_one uses the second mode if 'after == False' and 'from_rel' is
1345
versioned but no longer in the working tree, and 'to_rel' is not
1346
versioned but present in the working tree.
1348
rename_one uses the first mode if 'after == False' and 'from_rel' is
1349
versioned and present in the working tree, and 'to_rel' is not
1350
versioned and not present in the working tree.
1352
Everything else results in an error.
1354
inv = self.inventory
1357
# create rename entries and tuples
1358
from_tail = splitpath(from_rel)[-1]
1359
from_id = inv.path2id(from_rel)
1361
raise errors.BzrRenameFailedError(from_rel,to_rel,
1362
errors.NotVersionedError(path=str(from_rel)))
1363
from_entry = inv[from_id]
1364
from_parent_id = from_entry.parent_id
1365
to_dir, to_tail = os.path.split(to_rel)
1366
to_dir_id = inv.path2id(to_dir)
1367
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1369
from_tail=from_tail,
1370
from_parent_id=from_parent_id,
1371
to_rel=to_rel, to_tail=to_tail,
1372
to_parent_id=to_dir_id)
1373
rename_entries.append(rename_entry)
1375
# determine which move mode to use. checks also for movability
1376
rename_entries = self._determine_mv_mode(rename_entries, after)
1378
# check if the target changed directory and if the target directory is
1380
if to_dir_id is None:
1381
raise errors.BzrMoveFailedError(from_rel,to_rel,
1382
errors.NotVersionedError(path=str(to_dir)))
1384
# all checks done. now we can continue with our actual work
1385
mutter('rename_one:\n'
1390
' to_dir_id {%s}\n',
1391
from_id, from_rel, to_rel, to_dir, to_dir_id)
1393
self._move(rename_entries)
1394
self._write_inventory(inv)
1396
class _RenameEntry(object):
1397
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1398
to_rel, to_tail, to_parent_id, only_change_inv=False):
1399
self.from_rel = from_rel
1400
self.from_id = from_id
1401
self.from_tail = from_tail
1402
self.from_parent_id = from_parent_id
1403
self.to_rel = to_rel
1404
self.to_tail = to_tail
1405
self.to_parent_id = to_parent_id
1406
self.only_change_inv = only_change_inv
1410
"""Return all unknown files.
1412
These are files in the working directory that are not versioned or
1413
control files or ignored.
1415
# force the extras method to be fully executed before returning, to
1416
# prevent race conditions with the lock
1418
[subp for subp in self.extras() if not self.is_ignored(subp)])
1420
@needs_tree_write_lock
1421
def unversion(self, file_ids):
1422
"""Remove the file ids in file_ids from the current versioned set.
1424
When a file_id is unversioned, all of its children are automatically
1427
:param file_ids: The file ids to stop versioning.
1428
:raises: NoSuchId if any fileid is not currently versioned.
1430
for file_id in file_ids:
1431
file_id = osutils.safe_file_id(file_id)
1432
if self._inventory.has_id(file_id):
1433
self._inventory.remove_recursive_id(file_id)
1435
raise errors.NoSuchId(self, file_id)
1437
# in the future this should just set a dirty bit to wait for the
1438
# final unlock. However, until all methods of workingtree start
1439
# with the current in -memory inventory rather than triggering
1440
# a read, it is more complex - we need to teach read_inventory
1441
# to know when to read, and when to not read first... and possibly
1442
# to save first when the in memory one may be corrupted.
1443
# so for now, we just only write it if it is indeed dirty.
1445
self._write_inventory(self._inventory)
1447
@deprecated_method(zero_eight)
1448
def iter_conflicts(self):
1449
"""List all files in the tree that have text or content conflicts.
1450
DEPRECATED. Use conflicts instead."""
1451
return self._iter_conflicts()
1453
def _iter_conflicts(self):
1455
for info in self.list_files():
1457
stem = get_conflicted_stem(path)
1460
if stem not in conflicted:
1461
conflicted.add(stem)
1465
def pull(self, source, overwrite=False, stop_revision=None,
1466
change_reporter=None, possible_transports=None):
1467
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1470
pp = ProgressPhase("Pull phase", 2, top_pb)
1472
old_revision_info = self.branch.last_revision_info()
1473
basis_tree = self.basis_tree()
1474
count = self.branch.pull(source, overwrite, stop_revision,
1475
possible_transports=possible_transports)
1476
new_revision_info = self.branch.last_revision_info()
1477
if new_revision_info != old_revision_info:
1479
repository = self.branch.repository
1480
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1481
basis_tree.lock_read()
1483
new_basis_tree = self.branch.basis_tree()
1490
change_reporter=change_reporter)
1491
if (basis_tree.inventory.root is None and
1492
new_basis_tree.inventory.root is not None):
1493
self.set_root_id(new_basis_tree.inventory.root.file_id)
1497
# TODO - dedup parents list with things merged by pull ?
1498
# reuse the revisiontree we merged against to set the new
1500
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1501
# we have to pull the merge trees out again, because
1502
# merge_inner has set the ids. - this corner is not yet
1503
# layered well enough to prevent double handling.
1504
# XXX TODO: Fix the double handling: telling the tree about
1505
# the already known parent data is wasteful.
1506
merges = self.get_parent_ids()[1:]
1507
parent_trees.extend([
1508
(parent, repository.revision_tree(parent)) for
1510
self.set_parent_trees(parent_trees)
1517
def put_file_bytes_non_atomic(self, file_id, bytes):
1518
"""See MutableTree.put_file_bytes_non_atomic."""
1519
file_id = osutils.safe_file_id(file_id)
1520
stream = file(self.id2abspath(file_id), 'wb')
1525
# TODO: update the hashcache here ?
1528
"""Yield all unversioned files in this WorkingTree.
1530
If there are any unversioned directories then only the directory is
1531
returned, not all its children. But if there are unversioned files
1532
under a versioned subdirectory, they are returned.
1534
Currently returned depth-first, sorted by name within directories.
1535
This is the same order used by 'osutils.walkdirs'.
1537
## TODO: Work from given directory downwards
1538
for path, dir_entry in self.inventory.directories():
1539
# mutter("search for unknowns in %r", path)
1540
dirabs = self.abspath(path)
1541
if not isdir(dirabs):
1542
# e.g. directory deleted
1546
for subf in os.listdir(dirabs):
1549
if subf not in dir_entry.children:
1550
subf_norm, can_access = osutils.normalized_filename(subf)
1551
if subf_norm != subf and can_access:
1552
if subf_norm not in dir_entry.children:
1553
fl.append(subf_norm)
1559
subp = pathjoin(path, subf)
1562
def ignored_files(self):
1563
"""Yield list of PATH, IGNORE_PATTERN"""
1564
for subp in self.extras():
1565
pat = self.is_ignored(subp)
1569
def get_ignore_list(self):
1570
"""Return list of ignore patterns.
1572
Cached in the Tree object after the first call.
1574
ignoreset = getattr(self, '_ignoreset', None)
1575
if ignoreset is not None:
1578
ignore_globs = set()
1579
ignore_globs.update(ignores.get_runtime_ignores())
1580
ignore_globs.update(ignores.get_user_ignores())
1581
if self.has_filename(bzrlib.IGNORE_FILENAME):
1582
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1584
ignore_globs.update(ignores.parse_ignore_file(f))
1587
self._ignoreset = ignore_globs
1590
def _flush_ignore_list_cache(self):
1591
"""Resets the cached ignore list to force a cache rebuild."""
1592
self._ignoreset = None
1593
self._ignoreglobster = None
1595
def is_ignored(self, filename):
1596
r"""Check whether the filename matches an ignore pattern.
1598
Patterns containing '/' or '\' need to match the whole path;
1599
others match against only the last component.
1601
If the file is ignored, returns the pattern which caused it to
1602
be ignored, otherwise None. So this can simply be used as a
1603
boolean if desired."""
1604
if getattr(self, '_ignoreglobster', None) is None:
1605
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1606
return self._ignoreglobster.match(filename)
1608
def kind(self, file_id):
1609
return file_kind(self.id2abspath(file_id))
1611
def _comparison_data(self, entry, path):
1612
abspath = self.abspath(path)
1614
stat_value = os.lstat(abspath)
1616
if getattr(e, 'errno', None) == errno.ENOENT:
1623
mode = stat_value.st_mode
1624
kind = osutils.file_kind_from_stat_mode(mode)
1625
if not supports_executable():
1626
executable = entry is not None and entry.executable
1628
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1629
return kind, executable, stat_value
1631
def _file_size(self, entry, stat_value):
1632
return stat_value.st_size
1634
def last_revision(self):
1635
"""Return the last revision of the branch for this tree.
1637
This format tree does not support a separate marker for last-revision
1638
compared to the branch.
1640
See MutableTree.last_revision
1642
return self._last_revision()
1645
def _last_revision(self):
1646
"""helper for get_parent_ids."""
1647
return _mod_revision.ensure_null(self.branch.last_revision())
1649
def is_locked(self):
1650
return self._control_files.is_locked()
1652
def _must_be_locked(self):
1653
if not self.is_locked():
1654
raise errors.ObjectNotLocked(self)
1656
def lock_read(self):
1657
"""See Branch.lock_read, and WorkingTree.unlock."""
1658
if not self.is_locked():
1660
self.branch.lock_read()
1662
return self._control_files.lock_read()
1664
self.branch.unlock()
1667
def lock_tree_write(self):
1668
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1669
if not self.is_locked():
1671
self.branch.lock_read()
1673
return self._control_files.lock_write()
1675
self.branch.unlock()
1678
def lock_write(self):
1679
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1680
if not self.is_locked():
1682
self.branch.lock_write()
1684
return self._control_files.lock_write()
1686
self.branch.unlock()
1689
def get_physical_lock_status(self):
1690
return self._control_files.get_physical_lock_status()
1692
def _basis_inventory_name(self):
1693
return 'basis-inventory-cache'
1695
def _reset_data(self):
1696
"""Reset transient data that cannot be revalidated."""
1697
self._inventory_is_modified = False
1698
result = self._deserialize(self._control_files.get('inventory'))
1699
self._set_inventory(result, dirty=False)
1701
@needs_tree_write_lock
1702
def set_last_revision(self, new_revision):
1703
"""Change the last revision in the working tree."""
1704
new_revision = osutils.safe_revision_id(new_revision)
1705
if self._change_last_revision(new_revision):
1706
self._cache_basis_inventory(new_revision)
1708
def _change_last_revision(self, new_revision):
1709
"""Template method part of set_last_revision to perform the change.
1711
This is used to allow WorkingTree3 instances to not affect branch
1712
when their last revision is set.
1714
if _mod_revision.is_null(new_revision):
1715
self.branch.set_revision_history([])
1718
self.branch.generate_revision_history(new_revision)
1719
except errors.NoSuchRevision:
1720
# not present in the repo - dont try to set it deeper than the tip
1721
self.branch.set_revision_history([new_revision])
1724
def _write_basis_inventory(self, xml):
1725
"""Write the basis inventory XML to the basis-inventory file"""
1726
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1727
path = self._basis_inventory_name()
1729
self._control_files.put(path, sio)
1731
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1732
"""Create the text that will be saved in basis-inventory"""
1733
# TODO: jam 20070209 This should be redundant, as the revision_id
1734
# as all callers should have already converted the revision_id to
1736
inventory.revision_id = osutils.safe_revision_id(revision_id)
1737
return xml7.serializer_v7.write_inventory_to_string(inventory)
1739
def _cache_basis_inventory(self, new_revision):
1740
"""Cache new_revision as the basis inventory."""
1741
# TODO: this should allow the ready-to-use inventory to be passed in,
1742
# as commit already has that ready-to-use [while the format is the
1745
# this double handles the inventory - unpack and repack -
1746
# but is easier to understand. We can/should put a conditional
1747
# in here based on whether the inventory is in the latest format
1748
# - perhaps we should repack all inventories on a repository
1750
# the fast path is to copy the raw xml from the repository. If the
1751
# xml contains 'revision_id="', then we assume the right
1752
# revision_id is set. We must check for this full string, because a
1753
# root node id can legitimately look like 'revision_id' but cannot
1755
xml = self.branch.repository.get_inventory_xml(new_revision)
1756
firstline = xml.split('\n', 1)[0]
1757
if (not 'revision_id="' in firstline or
1758
'format="7"' not in firstline):
1759
inv = self.branch.repository.deserialise_inventory(
1761
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1762
self._write_basis_inventory(xml)
1763
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1766
def read_basis_inventory(self):
1767
"""Read the cached basis inventory."""
1768
path = self._basis_inventory_name()
1769
return self._control_files.get(path).read()
1772
def read_working_inventory(self):
1773
"""Read the working inventory.
1775
:raises errors.InventoryModified: read_working_inventory will fail
1776
when the current in memory inventory has been modified.
1778
# conceptually this should be an implementation detail of the tree.
1779
# XXX: Deprecate this.
1780
# ElementTree does its own conversion from UTF-8, so open in
1782
if self._inventory_is_modified:
1783
raise errors.InventoryModified(self)
1784
result = self._deserialize(self._control_files.get('inventory'))
1785
self._set_inventory(result, dirty=False)
1788
@needs_tree_write_lock
1789
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1791
"""Remove nominated files from the working inventory.
1793
:files: File paths relative to the basedir.
1794
:keep_files: If true, the files will also be kept.
1795
:force: Delete files and directories, even if they are changed and
1796
even if the directories are not empty.
1798
if isinstance(files, basestring):
1804
unknown_nested_files=set()
1806
def recurse_directory_to_add_files(directory):
1807
# Recurse directory and add all files
1808
# so we can check if they have changed.
1809
for parent_info, file_infos in\
1810
osutils.walkdirs(self.abspath(directory),
1812
for relpath, basename, kind, lstat, abspath in file_infos:
1813
# Is it versioned or ignored?
1814
if self.path2id(relpath) or self.is_ignored(relpath):
1815
# Add nested content for deletion.
1816
new_files.add(relpath)
1818
# Files which are not versioned and not ignored
1819
# should be treated as unknown.
1820
unknown_nested_files.add((relpath, None, kind))
1822
for filename in files:
1823
# Get file name into canonical form.
1824
abspath = self.abspath(filename)
1825
filename = self.relpath(abspath)
1826
if len(filename) > 0:
1827
new_files.add(filename)
1828
if osutils.isdir(abspath):
1829
recurse_directory_to_add_files(filename)
1831
files = list(new_files)
1834
return # nothing to do
1836
# Sort needed to first handle directory content before the directory
1837
files.sort(reverse=True)
1839
# Bail out if we are going to delete files we shouldn't
1840
if not keep_files and not force:
1841
has_changed_files = len(unknown_nested_files) > 0
1842
if not has_changed_files:
1843
for (file_id, path, content_change, versioned, parent_id, name,
1844
kind, executable) in self._iter_changes(self.basis_tree(),
1845
include_unchanged=True, require_versioned=False,
1846
want_unversioned=True, specific_files=files):
1847
# Check if it's an unknown (but not ignored) OR
1848
# changed (but not deleted) :
1849
if not self.is_ignored(path[1]) and (
1850
versioned == (False, False) or
1851
content_change and kind[1] != None):
1852
has_changed_files = True
1855
if has_changed_files:
1856
# Make delta show ALL applicable changes in error message.
1857
tree_delta = self.changes_from(self.basis_tree(),
1858
require_versioned=False, want_unversioned=True,
1859
specific_files=files)
1860
for unknown_file in unknown_nested_files:
1861
if unknown_file not in tree_delta.unversioned:
1862
tree_delta.unversioned.extend((unknown_file,))
1863
raise errors.BzrRemoveChangedFilesError(tree_delta)
1865
# Build inv_delta and delete files where applicaple,
1866
# do this before any modifications to inventory.
1868
fid = self.path2id(f)
1871
message = "%s is not versioned." % (f,)
1874
# having removed it, it must be either ignored or unknown
1875
if self.is_ignored(f):
1879
textui.show_status(new_status, self.kind(fid), f,
1882
inv_delta.append((f, None, fid, None))
1883
message = "removed %s" % (f,)
1886
abs_path = self.abspath(f)
1887
if osutils.lexists(abs_path):
1888
if (osutils.isdir(abs_path) and
1889
len(os.listdir(abs_path)) > 0):
1891
osutils.rmtree(abs_path)
1893
message = "%s is not an empty directory "\
1894
"and won't be deleted." % (f,)
1896
osutils.delete_any(abs_path)
1897
message = "deleted %s" % (f,)
1898
elif message is not None:
1899
# Only care if we haven't done anything yet.
1900
message = "%s does not exist." % (f,)
1902
# Print only one message (if any) per file.
1903
if message is not None:
1905
self.apply_inventory_delta(inv_delta)
1907
@needs_tree_write_lock
1908
def revert(self, filenames=None, old_tree=None, backups=True,
1909
pb=DummyProgress(), report_changes=False):
1910
from bzrlib.conflicts import resolve
1913
symbol_versioning.warn('Using [] to revert all files is deprecated'
1914
' as of bzr 0.91. Please use None (the default) instead.',
1915
DeprecationWarning, stacklevel=2)
1916
if old_tree is None:
1917
old_tree = self.basis_tree()
1918
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1920
if filenames is None:
1921
self.set_parent_ids(self.get_parent_ids()[:1])
1924
resolve(self, filenames, ignore_misses=True)
1927
def revision_tree(self, revision_id):
1928
"""See Tree.revision_tree.
1930
WorkingTree can supply revision_trees for the basis revision only
1931
because there is only one cached inventory in the bzr directory.
1933
if revision_id == self.last_revision():
1935
xml = self.read_basis_inventory()
1936
except errors.NoSuchFile:
1940
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1941
# dont use the repository revision_tree api because we want
1942
# to supply the inventory.
1943
if inv.revision_id == revision_id:
1944
return revisiontree.RevisionTree(self.branch.repository,
1946
except errors.BadInventoryFormat:
1948
# raise if there was no inventory, or if we read the wrong inventory.
1949
raise errors.NoSuchRevisionInTree(self, revision_id)
1951
# XXX: This method should be deprecated in favour of taking in a proper
1952
# new Inventory object.
1953
@needs_tree_write_lock
1954
def set_inventory(self, new_inventory_list):
1955
from bzrlib.inventory import (Inventory,
1960
inv = Inventory(self.get_root_id())
1961
for path, file_id, parent, kind in new_inventory_list:
1962
name = os.path.basename(path)
1965
# fixme, there should be a factory function inv,add_??
1966
if kind == 'directory':
1967
inv.add(InventoryDirectory(file_id, name, parent))
1968
elif kind == 'file':
1969
inv.add(InventoryFile(file_id, name, parent))
1970
elif kind == 'symlink':
1971
inv.add(InventoryLink(file_id, name, parent))
1973
raise errors.BzrError("unknown kind %r" % kind)
1974
self._write_inventory(inv)
1976
@needs_tree_write_lock
1977
def set_root_id(self, file_id):
1978
"""Set the root id for this tree."""
1981
symbol_versioning.warn(symbol_versioning.zero_twelve
1982
% 'WorkingTree.set_root_id with fileid=None',
1987
file_id = osutils.safe_file_id(file_id)
1988
self._set_root_id(file_id)
1990
def _set_root_id(self, file_id):
1991
"""Set the root id for this tree, in a format specific manner.
1993
:param file_id: The file id to assign to the root. It must not be
1994
present in the current inventory or an error will occur. It must
1995
not be None, but rather a valid file id.
1997
inv = self._inventory
1998
orig_root_id = inv.root.file_id
1999
# TODO: it might be nice to exit early if there was nothing
2000
# to do, saving us from trigger a sync on unlock.
2001
self._inventory_is_modified = True
2002
# we preserve the root inventory entry object, but
2003
# unlinkit from the byid index
2004
del inv._byid[inv.root.file_id]
2005
inv.root.file_id = file_id
2006
# and link it into the index with the new changed id.
2007
inv._byid[inv.root.file_id] = inv.root
2008
# and finally update all children to reference the new id.
2009
# XXX: this should be safe to just look at the root.children
2010
# list, not the WHOLE INVENTORY.
2013
if entry.parent_id == orig_root_id:
2014
entry.parent_id = inv.root.file_id
2017
"""See Branch.unlock.
2019
WorkingTree locking just uses the Branch locking facilities.
2020
This is current because all working trees have an embedded branch
2021
within them. IF in the future, we were to make branch data shareable
2022
between multiple working trees, i.e. via shared storage, then we
2023
would probably want to lock both the local tree, and the branch.
2025
raise NotImplementedError(self.unlock)
2027
def update(self, change_reporter=None, possible_transports=None):
2028
"""Update a working tree along its branch.
2030
This will update the branch if its bound too, which means we have
2031
multiple trees involved:
2033
- The new basis tree of the master.
2034
- The old basis tree of the branch.
2035
- The old basis tree of the working tree.
2036
- The current working tree state.
2038
Pathologically, all three may be different, and non-ancestors of each
2039
other. Conceptually we want to:
2041
- Preserve the wt.basis->wt.state changes
2042
- Transform the wt.basis to the new master basis.
2043
- Apply a merge of the old branch basis to get any 'local' changes from
2045
- Restore the wt.basis->wt.state changes.
2047
There isn't a single operation at the moment to do that, so we:
2048
- Merge current state -> basis tree of the master w.r.t. the old tree
2050
- Do a 'normal' merge of the old branch basis if it is relevant.
2052
if self.branch.get_master_branch(possible_transports) is not None:
2054
update_branch = True
2056
self.lock_tree_write()
2057
update_branch = False
2060
old_tip = self.branch.update(possible_transports)
2063
return self._update_tree(old_tip, change_reporter)
2067
@needs_tree_write_lock
2068
def _update_tree(self, old_tip=None, change_reporter=None):
2069
"""Update a tree to the master branch.
2071
:param old_tip: if supplied, the previous tip revision the branch,
2072
before it was changed to the master branch's tip.
2074
# here if old_tip is not None, it is the old tip of the branch before
2075
# it was updated from the master branch. This should become a pending
2076
# merge in the working tree to preserve the user existing work. we
2077
# cant set that until we update the working trees last revision to be
2078
# one from the new branch, because it will just get absorbed by the
2079
# parent de-duplication logic.
2081
# We MUST save it even if an error occurs, because otherwise the users
2082
# local work is unreferenced and will appear to have been lost.
2086
last_rev = self.get_parent_ids()[0]
2088
last_rev = _mod_revision.NULL_REVISION
2089
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2090
# merge tree state up to new branch tip.
2091
basis = self.basis_tree()
2094
to_tree = self.branch.basis_tree()
2095
if basis.inventory.root is None:
2096
self.set_root_id(to_tree.inventory.root.file_id)
2098
result += merge.merge_inner(
2103
change_reporter=change_reporter)
2106
# TODO - dedup parents list with things merged by pull ?
2107
# reuse the tree we've updated to to set the basis:
2108
parent_trees = [(self.branch.last_revision(), to_tree)]
2109
merges = self.get_parent_ids()[1:]
2110
# Ideally we ask the tree for the trees here, that way the working
2111
# tree can decide whether to give us teh entire tree or give us a
2112
# lazy initialised tree. dirstate for instance will have the trees
2113
# in ram already, whereas a last-revision + basis-inventory tree
2114
# will not, but also does not need them when setting parents.
2115
for parent in merges:
2116
parent_trees.append(
2117
(parent, self.branch.repository.revision_tree(parent)))
2118
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2119
parent_trees.append(
2120
(old_tip, self.branch.repository.revision_tree(old_tip)))
2121
self.set_parent_trees(parent_trees)
2122
last_rev = parent_trees[0][0]
2124
# the working tree had the same last-revision as the master
2125
# branch did. We may still have pivot local work from the local
2126
# branch into old_tip:
2127
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2128
self.add_parent_tree_id(old_tip)
2129
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2130
and old_tip != last_rev):
2131
# our last revision was not the prior branch last revision
2132
# and we have converted that last revision to a pending merge.
2133
# base is somewhere between the branch tip now
2134
# and the now pending merge
2136
# Since we just modified the working tree and inventory, flush out
2137
# the current state, before we modify it again.
2138
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2139
# requires it only because TreeTransform directly munges the
2140
# inventory and calls tree._write_inventory(). Ultimately we
2141
# should be able to remove this extra flush.
2143
graph = self.branch.repository.get_graph()
2144
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2146
base_tree = self.branch.repository.revision_tree(base_rev_id)
2147
other_tree = self.branch.repository.revision_tree(old_tip)
2148
result += merge.merge_inner(
2153
change_reporter=change_reporter)
2156
def _write_hashcache_if_dirty(self):
2157
"""Write out the hashcache if it is dirty."""
2158
if self._hashcache.needs_write:
2160
self._hashcache.write()
2162
if e.errno not in (errno.EPERM, errno.EACCES):
2164
# TODO: jam 20061219 Should this be a warning? A single line
2165
# warning might be sufficient to let the user know what
2167
mutter('Could not write hashcache for %s\nError: %s',
2168
self._hashcache.cache_file_name(), e)
2170
@needs_tree_write_lock
2171
def _write_inventory(self, inv):
2172
"""Write inventory as the current inventory."""
2173
self._set_inventory(inv, dirty=True)
2176
def set_conflicts(self, arg):
2177
raise errors.UnsupportedOperation(self.set_conflicts, self)
2179
def add_conflicts(self, arg):
2180
raise errors.UnsupportedOperation(self.add_conflicts, self)
2183
def conflicts(self):
2184
conflicts = _mod_conflicts.ConflictList()
2185
for conflicted in self._iter_conflicts():
2188
if file_kind(self.abspath(conflicted)) != "file":
2190
except errors.NoSuchFile:
2193
for suffix in ('.THIS', '.OTHER'):
2195
kind = file_kind(self.abspath(conflicted+suffix))
2198
except errors.NoSuchFile:
2202
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2203
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2205
file_id=self.path2id(conflicted)))
2208
def walkdirs(self, prefix=""):
2209
"""Walk the directories of this tree.
2211
returns a generator which yields items in the form:
2212
((curren_directory_path, fileid),
2213
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2216
This API returns a generator, which is only valid during the current
2217
tree transaction - within a single lock_read or lock_write duration.
2219
If the tree is not locked, it may cause an error to be raised,
2220
depending on the tree implementation.
2222
disk_top = self.abspath(prefix)
2223
if disk_top.endswith('/'):
2224
disk_top = disk_top[:-1]
2225
top_strip_len = len(disk_top) + 1
2226
inventory_iterator = self._walkdirs(prefix)
2227
disk_iterator = osutils.walkdirs(disk_top, prefix)
2229
current_disk = disk_iterator.next()
2230
disk_finished = False
2232
if not (e.errno == errno.ENOENT or
2233
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2236
disk_finished = True
2238
current_inv = inventory_iterator.next()
2239
inv_finished = False
2240
except StopIteration:
2243
while not inv_finished or not disk_finished:
2244
if not disk_finished:
2245
# strip out .bzr dirs
2246
if current_disk[0][1][top_strip_len:] == '':
2247
# osutils.walkdirs can be made nicer -
2248
# yield the path-from-prefix rather than the pathjoined
2250
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2251
if current_disk[1][bzrdir_loc][0] == '.bzr':
2252
# we dont yield the contents of, or, .bzr itself.
2253
del current_disk[1][bzrdir_loc]
2255
# everything is unknown
2258
# everything is missing
2261
direction = cmp(current_inv[0][0], current_disk[0][0])
2263
# disk is before inventory - unknown
2264
dirblock = [(relpath, basename, kind, stat, None, None) for
2265
relpath, basename, kind, stat, top_path in current_disk[1]]
2266
yield (current_disk[0][0], None), dirblock
2268
current_disk = disk_iterator.next()
2269
except StopIteration:
2270
disk_finished = True
2272
# inventory is before disk - missing.
2273
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2274
for relpath, basename, dkind, stat, fileid, kind in
2276
yield (current_inv[0][0], current_inv[0][1]), dirblock
2278
current_inv = inventory_iterator.next()
2279
except StopIteration:
2282
# versioned present directory
2283
# merge the inventory and disk data together
2285
for relpath, subiterator in itertools.groupby(sorted(
2286
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2287
path_elements = list(subiterator)
2288
if len(path_elements) == 2:
2289
inv_row, disk_row = path_elements
2290
# versioned, present file
2291
dirblock.append((inv_row[0],
2292
inv_row[1], disk_row[2],
2293
disk_row[3], inv_row[4],
2295
elif len(path_elements[0]) == 5:
2297
dirblock.append((path_elements[0][0],
2298
path_elements[0][1], path_elements[0][2],
2299
path_elements[0][3], None, None))
2300
elif len(path_elements[0]) == 6:
2301
# versioned, absent file.
2302
dirblock.append((path_elements[0][0],
2303
path_elements[0][1], 'unknown', None,
2304
path_elements[0][4], path_elements[0][5]))
2306
raise NotImplementedError('unreachable code')
2307
yield current_inv[0], dirblock
2309
current_inv = inventory_iterator.next()
2310
except StopIteration:
2313
current_disk = disk_iterator.next()
2314
except StopIteration:
2315
disk_finished = True
2317
def _walkdirs(self, prefix=""):
2318
"""Walk the directories of this tree.
2320
:prefix: is used as the directrory to start with.
2321
returns a generator which yields items in the form:
2322
((curren_directory_path, fileid),
2323
[(file1_path, file1_name, file1_kind, None, file1_id,
2326
_directory = 'directory'
2327
# get the root in the inventory
2328
inv = self.inventory
2329
top_id = inv.path2id(prefix)
2333
pending = [(prefix, '', _directory, None, top_id, None)]
2336
currentdir = pending.pop()
2337
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2338
top_id = currentdir[4]
2340
relroot = currentdir[0] + '/'
2343
# FIXME: stash the node in pending
2345
for name, child in entry.sorted_children():
2346
dirblock.append((relroot + name, name, child.kind, None,
2347
child.file_id, child.kind
2349
yield (currentdir[0], entry.file_id), dirblock
2350
# push the user specified dirs from dirblock
2351
for dir in reversed(dirblock):
2352
if dir[2] == _directory:
2355
@needs_tree_write_lock
2356
def auto_resolve(self):
2357
"""Automatically resolve text conflicts according to contents.
2359
Only text conflicts are auto_resolvable. Files with no conflict markers
2360
are considered 'resolved', because bzr always puts conflict markers
2361
into files that have text conflicts. The corresponding .THIS .BASE and
2362
.OTHER files are deleted, as per 'resolve'.
2363
:return: a tuple of ConflictLists: (un_resolved, resolved).
2365
un_resolved = _mod_conflicts.ConflictList()
2366
resolved = _mod_conflicts.ConflictList()
2367
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2368
for conflict in self.conflicts():
2369
if (conflict.typestring != 'text conflict' or
2370
self.kind(conflict.file_id) != 'file'):
2371
un_resolved.append(conflict)
2373
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2375
for line in my_file:
2376
if conflict_re.search(line):
2377
un_resolved.append(conflict)
2380
resolved.append(conflict)
2383
resolved.remove_files(self)
2384
self.set_conflicts(un_resolved)
2385
return un_resolved, resolved
2387
def _validate(self):
2388
"""Validate internal structures.
2390
This is meant mostly for the test suite. To give it a chance to detect
2391
corruption after actions have occurred. The default implementation is a
2394
:return: None. An exception should be raised if there is an error.
2399
class WorkingTree2(WorkingTree):
2400
"""This is the Format 2 working tree.
2402
This was the first weave based working tree.
2403
- uses os locks for locking.
2404
- uses the branch last-revision.
2407
def __init__(self, *args, **kwargs):
2408
super(WorkingTree2, self).__init__(*args, **kwargs)
2409
# WorkingTree2 has more of a constraint that self._inventory must
2410
# exist. Because this is an older format, we don't mind the overhead
2411
# caused by the extra computation here.
2413
# Newer WorkingTree's should only have self._inventory set when they
2415
if self._inventory is None:
2416
self.read_working_inventory()
2418
def lock_tree_write(self):
2419
"""See WorkingTree.lock_tree_write().
2421
In Format2 WorkingTrees we have a single lock for the branch and tree
2422
so lock_tree_write() degrades to lock_write().
2424
self.branch.lock_write()
2426
return self._control_files.lock_write()
2428
self.branch.unlock()
2432
# do non-implementation specific cleanup
2435
# we share control files:
2436
if self._control_files._lock_count == 3:
2437
# _inventory_is_modified is always False during a read lock.
2438
if self._inventory_is_modified:
2440
self._write_hashcache_if_dirty()
2442
# reverse order of locking.
2444
return self._control_files.unlock()
2446
self.branch.unlock()
2449
class WorkingTree3(WorkingTree):
2450
"""This is the Format 3 working tree.
2452
This differs from the base WorkingTree by:
2453
- having its own file lock
2454
- having its own last-revision property.
2456
This is new in bzr 0.8
2460
def _last_revision(self):
2461
"""See Mutable.last_revision."""
2463
return osutils.safe_revision_id(
2464
self._control_files.get('last-revision').read())
2465
except errors.NoSuchFile:
2466
return _mod_revision.NULL_REVISION
2468
def _change_last_revision(self, revision_id):
2469
"""See WorkingTree._change_last_revision."""
2470
if revision_id is None or revision_id == NULL_REVISION:
2472
self._control_files._transport.delete('last-revision')
2473
except errors.NoSuchFile:
2477
self._control_files.put_bytes('last-revision', revision_id)
2480
@needs_tree_write_lock
2481
def set_conflicts(self, conflicts):
2482
self._put_rio('conflicts', conflicts.to_stanzas(),
2485
@needs_tree_write_lock
2486
def add_conflicts(self, new_conflicts):
2487
conflict_set = set(self.conflicts())
2488
conflict_set.update(set(list(new_conflicts)))
2489
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2490
key=_mod_conflicts.Conflict.sort_key)))
2493
def conflicts(self):
2495
confile = self._control_files.get('conflicts')
2496
except errors.NoSuchFile:
2497
return _mod_conflicts.ConflictList()
2499
if confile.next() != CONFLICT_HEADER_1 + '\n':
2500
raise errors.ConflictFormatError()
2501
except StopIteration:
2502
raise errors.ConflictFormatError()
2503
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2506
# do non-implementation specific cleanup
2508
if self._control_files._lock_count == 1:
2509
# _inventory_is_modified is always False during a read lock.
2510
if self._inventory_is_modified:
2512
self._write_hashcache_if_dirty()
2513
# reverse order of locking.
2515
return self._control_files.unlock()
2517
self.branch.unlock()
2520
def get_conflicted_stem(path):
2521
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2522
if path.endswith(suffix):
2523
return path[:-len(suffix)]
2526
@deprecated_function(zero_eight)
2527
def is_control_file(filename):
2528
"""See WorkingTree.is_control_filename(filename)."""
2529
## FIXME: better check
2530
filename = normpath(filename)
2531
while filename != '':
2532
head, tail = os.path.split(filename)
2533
## mutter('check %r for control file' % ((head, tail),))
2536
if filename == head:
2542
class WorkingTreeFormat(object):
2543
"""An encapsulation of the initialization and open routines for a format.
2545
Formats provide three things:
2546
* An initialization routine,
2550
Formats are placed in an dict by their format string for reference
2551
during workingtree opening. Its not required that these be instances, they
2552
can be classes themselves with class methods - it simply depends on
2553
whether state is needed for a given format or not.
2555
Once a format is deprecated, just deprecate the initialize and open
2556
methods on the format class. Do not deprecate the object, as the
2557
object will be created every time regardless.
2560
_default_format = None
2561
"""The default format used for new trees."""
2564
"""The known formats."""
2566
requires_rich_root = False
2568
upgrade_recommended = False
2571
def find_format(klass, a_bzrdir):
2572
"""Return the format for the working tree object in a_bzrdir."""
2574
transport = a_bzrdir.get_workingtree_transport(None)
2575
format_string = transport.get("format").read()
2576
return klass._formats[format_string]
2577
except errors.NoSuchFile:
2578
raise errors.NoWorkingTree(base=transport.base)
2580
raise errors.UnknownFormatError(format=format_string)
2582
def __eq__(self, other):
2583
return self.__class__ is other.__class__
2585
def __ne__(self, other):
2586
return not (self == other)
2589
def get_default_format(klass):
2590
"""Return the current default format."""
2591
return klass._default_format
2593
def get_format_string(self):
2594
"""Return the ASCII format string that identifies this format."""
2595
raise NotImplementedError(self.get_format_string)
2597
def get_format_description(self):
2598
"""Return the short description for this format."""
2599
raise NotImplementedError(self.get_format_description)
2601
def is_supported(self):
2602
"""Is this format supported?
2604
Supported formats can be initialized and opened.
2605
Unsupported formats may not support initialization or committing or
2606
some other features depending on the reason for not being supported.
2611
def register_format(klass, format):
2612
klass._formats[format.get_format_string()] = format
2615
def set_default_format(klass, format):
2616
klass._default_format = format
2619
def unregister_format(klass, format):
2620
assert klass._formats[format.get_format_string()] is format
2621
del klass._formats[format.get_format_string()]
2624
class WorkingTreeFormat2(WorkingTreeFormat):
2625
"""The second working tree format.
2627
This format modified the hash cache from the format 1 hash cache.
2630
upgrade_recommended = True
2632
def get_format_description(self):
2633
"""See WorkingTreeFormat.get_format_description()."""
2634
return "Working tree format 2"
2636
def stub_initialize_remote(self, control_files):
2637
"""As a special workaround create critical control files for a remote working tree
2639
This ensures that it can later be updated and dealt with locally,
2640
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2641
no working tree. (See bug #43064).
2645
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2647
control_files.put('inventory', sio)
2649
control_files.put_bytes('pending-merges', '')
2652
def initialize(self, a_bzrdir, revision_id=None):
2653
"""See WorkingTreeFormat.initialize()."""
2654
if not isinstance(a_bzrdir.transport, LocalTransport):
2655
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2656
branch = a_bzrdir.open_branch()
2657
if revision_id is None:
2658
revision_id = _mod_revision.ensure_null(branch.last_revision())
2660
revision_id = osutils.safe_revision_id(revision_id)
2663
branch.generate_revision_history(revision_id)
2667
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2673
basis_tree = branch.repository.revision_tree(revision_id)
2674
if basis_tree.inventory.root is not None:
2675
wt.set_root_id(basis_tree.inventory.root.file_id)
2676
# set the parent list and cache the basis tree.
2677
if _mod_revision.is_null(revision_id):
2680
parent_trees = [(revision_id, basis_tree)]
2681
wt.set_parent_trees(parent_trees)
2682
transform.build_tree(basis_tree, wt)
2686
super(WorkingTreeFormat2, self).__init__()
2687
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2689
def open(self, a_bzrdir, _found=False):
2690
"""Return the WorkingTree object for a_bzrdir
2692
_found is a private parameter, do not use it. It is used to indicate
2693
if format probing has already been done.
2696
# we are being called directly and must probe.
2697
raise NotImplementedError
2698
if not isinstance(a_bzrdir.transport, LocalTransport):
2699
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2700
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2706
class WorkingTreeFormat3(WorkingTreeFormat):
2707
"""The second working tree format updated to record a format marker.
2710
- exists within a metadir controlling .bzr
2711
- includes an explicit version marker for the workingtree control
2712
files, separate from the BzrDir format
2713
- modifies the hash cache format
2715
- uses a LockDir to guard access for writes.
2718
upgrade_recommended = True
2720
def get_format_string(self):
2721
"""See WorkingTreeFormat.get_format_string()."""
2722
return "Bazaar-NG Working Tree format 3"
2724
def get_format_description(self):
2725
"""See WorkingTreeFormat.get_format_description()."""
2726
return "Working tree format 3"
2728
_lock_file_name = 'lock'
2729
_lock_class = LockDir
2731
_tree_class = WorkingTree3
2733
def __get_matchingbzrdir(self):
2734
return bzrdir.BzrDirMetaFormat1()
2736
_matchingbzrdir = property(__get_matchingbzrdir)
2738
def _open_control_files(self, a_bzrdir):
2739
transport = a_bzrdir.get_workingtree_transport(None)
2740
return LockableFiles(transport, self._lock_file_name,
2743
def initialize(self, a_bzrdir, revision_id=None):
2744
"""See WorkingTreeFormat.initialize().
2746
revision_id allows creating a working tree at a different
2747
revision than the branch is at.
2749
if not isinstance(a_bzrdir.transport, LocalTransport):
2750
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2751
transport = a_bzrdir.get_workingtree_transport(self)
2752
control_files = self._open_control_files(a_bzrdir)
2753
control_files.create_lock()
2754
control_files.lock_write()
2755
control_files.put_utf8('format', self.get_format_string())
2756
branch = a_bzrdir.open_branch()
2757
if revision_id is None:
2758
revision_id = _mod_revision.ensure_null(branch.last_revision())
2760
revision_id = osutils.safe_revision_id(revision_id)
2761
# WorkingTree3 can handle an inventory which has a unique root id.
2762
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2763
# those trees. And because there isn't a format bump inbetween, we
2764
# are maintaining compatibility with older clients.
2765
# inv = Inventory(root_id=gen_root_id())
2766
inv = self._initial_inventory()
2767
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2773
_control_files=control_files)
2774
wt.lock_tree_write()
2776
basis_tree = branch.repository.revision_tree(revision_id)
2777
# only set an explicit root id if there is one to set.
2778
if basis_tree.inventory.root is not None:
2779
wt.set_root_id(basis_tree.inventory.root.file_id)
2780
if revision_id == NULL_REVISION:
2781
wt.set_parent_trees([])
2783
wt.set_parent_trees([(revision_id, basis_tree)])
2784
transform.build_tree(basis_tree, wt)
2786
# Unlock in this order so that the unlock-triggers-flush in
2787
# WorkingTree is given a chance to fire.
2788
control_files.unlock()
2792
def _initial_inventory(self):
2796
super(WorkingTreeFormat3, self).__init__()
2798
def open(self, a_bzrdir, _found=False):
2799
"""Return the WorkingTree object for a_bzrdir
2801
_found is a private parameter, do not use it. It is used to indicate
2802
if format probing has already been done.
2805
# we are being called directly and must probe.
2806
raise NotImplementedError
2807
if not isinstance(a_bzrdir.transport, LocalTransport):
2808
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2809
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2812
def _open(self, a_bzrdir, control_files):
2813
"""Open the tree itself.
2815
:param a_bzrdir: the dir for the tree.
2816
:param control_files: the control files for the tree.
2818
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2822
_control_files=control_files)
2825
return self.get_format_string()
2828
__default_format = WorkingTreeFormat4()
2829
WorkingTreeFormat.register_format(__default_format)
2830
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2831
WorkingTreeFormat.set_default_format(__default_format)
2832
# formats which have no format string are not discoverable
2833
# and not independently creatable, so are not registered.
2834
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
