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)
1000
def _deserialize(selt, in_file):
1001
return xml5.serializer_v5.read_inventory(in_file)
1004
"""Write the in memory inventory to disk."""
1005
# TODO: Maybe this should only write on dirty ?
1006
if self._control_files._lock_mode != 'w':
1007
raise errors.NotWriteLocked(self)
1009
self._serialize(self._inventory, sio)
1011
self._control_files.put('inventory', sio)
1012
self._inventory_is_modified = False
1014
def _kind(self, relpath):
1015
return osutils.file_kind(self.abspath(relpath))
1017
def list_files(self, include_root=False):
1018
"""Recursively list all files as (path, class, kind, id, entry).
1020
Lists, but does not descend into unversioned directories.
1022
This does not include files that have been deleted in this
1025
Skips the control directory.
1027
# list_files is an iterator, so @needs_read_lock doesn't work properly
1028
# with it. So callers should be careful to always read_lock the tree.
1029
if not self.is_locked():
1030
raise errors.ObjectNotLocked(self)
1032
inv = self.inventory
1033
if include_root is True:
1034
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1035
# Convert these into local objects to save lookup times
1036
pathjoin = osutils.pathjoin
1037
file_kind = self._kind
1039
# transport.base ends in a slash, we want the piece
1040
# between the last two slashes
1041
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1043
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1045
# directory file_id, relative path, absolute path, reverse sorted children
1046
children = os.listdir(self.basedir)
1048
# jam 20060527 The kernel sized tree seems equivalent whether we
1049
# use a deque and popleft to keep them sorted, or if we use a plain
1050
# list and just reverse() them.
1051
children = collections.deque(children)
1052
stack = [(inv.root.file_id, u'', self.basedir, children)]
1054
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1057
f = children.popleft()
1058
## TODO: If we find a subdirectory with its own .bzr
1059
## directory, then that is a separate tree and we
1060
## should exclude it.
1062
# the bzrdir for this tree
1063
if transport_base_dir == f:
1066
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1067
# and 'f' doesn't begin with one, we can do a string op, rather
1068
# than the checks of pathjoin(), all relative paths will have an extra slash
1070
fp = from_dir_relpath + '/' + f
1073
fap = from_dir_abspath + '/' + f
1075
f_ie = inv.get_child(from_dir_id, f)
1078
elif self.is_ignored(fp[1:]):
1081
# we may not have found this file, because of a unicode issue
1082
f_norm, can_access = osutils.normalized_filename(f)
1083
if f == f_norm or not can_access:
1084
# No change, so treat this file normally
1087
# this file can be accessed by a normalized path
1088
# check again if it is versioned
1089
# these lines are repeated here for performance
1091
fp = from_dir_relpath + '/' + f
1092
fap = from_dir_abspath + '/' + f
1093
f_ie = inv.get_child(from_dir_id, f)
1096
elif self.is_ignored(fp[1:]):
1103
# make a last minute entry
1105
yield fp[1:], c, fk, f_ie.file_id, f_ie
1108
yield fp[1:], c, fk, None, fk_entries[fk]()
1110
yield fp[1:], c, fk, None, TreeEntry()
1113
if fk != 'directory':
1116
# But do this child first
1117
new_children = os.listdir(fap)
1119
new_children = collections.deque(new_children)
1120
stack.append((f_ie.file_id, fp, fap, new_children))
1121
# Break out of inner loop,
1122
# so that we start outer loop with child
1125
# if we finished all children, pop it off the stack
1128
@needs_tree_write_lock
1129
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1132
to_dir must exist in the inventory.
1134
If to_dir exists and is a directory, the files are moved into
1135
it, keeping their old names.
1137
Note that to_dir is only the last component of the new name;
1138
this doesn't change the directory.
1140
For each entry in from_paths the move mode will be determined
1143
The first mode moves the file in the filesystem and updates the
1144
inventory. The second mode only updates the inventory without
1145
touching the file on the filesystem. This is the new mode introduced
1148
move uses the second mode if 'after == True' and the target is not
1149
versioned but present in the working tree.
1151
move uses the second mode if 'after == False' and the source is
1152
versioned but no longer in the working tree, and the target is not
1153
versioned but present in the working tree.
1155
move uses the first mode if 'after == False' and the source is
1156
versioned and present in the working tree, and the target is not
1157
versioned and not present in the working tree.
1159
Everything else results in an error.
1161
This returns a list of (from_path, to_path) pairs for each
1162
entry that is moved.
1167
# check for deprecated use of signature
1169
to_dir = kwargs.get('to_name', None)
1171
raise TypeError('You must supply a target directory')
1173
symbol_versioning.warn('The parameter to_name was deprecated'
1174
' in version 0.13. Use to_dir instead',
1177
# check destination directory
1178
assert not isinstance(from_paths, basestring)
1179
inv = self.inventory
1180
to_abs = self.abspath(to_dir)
1181
if not isdir(to_abs):
1182
raise errors.BzrMoveFailedError('',to_dir,
1183
errors.NotADirectory(to_abs))
1184
if not self.has_filename(to_dir):
1185
raise errors.BzrMoveFailedError('',to_dir,
1186
errors.NotInWorkingDirectory(to_dir))
1187
to_dir_id = inv.path2id(to_dir)
1188
if to_dir_id is None:
1189
raise errors.BzrMoveFailedError('',to_dir,
1190
errors.NotVersionedError(path=str(to_dir)))
1192
to_dir_ie = inv[to_dir_id]
1193
if to_dir_ie.kind != 'directory':
1194
raise errors.BzrMoveFailedError('',to_dir,
1195
errors.NotADirectory(to_abs))
1197
# create rename entries and tuples
1198
for from_rel in from_paths:
1199
from_tail = splitpath(from_rel)[-1]
1200
from_id = inv.path2id(from_rel)
1202
raise errors.BzrMoveFailedError(from_rel,to_dir,
1203
errors.NotVersionedError(path=str(from_rel)))
1205
from_entry = inv[from_id]
1206
from_parent_id = from_entry.parent_id
1207
to_rel = pathjoin(to_dir, from_tail)
1208
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1210
from_tail=from_tail,
1211
from_parent_id=from_parent_id,
1212
to_rel=to_rel, to_tail=from_tail,
1213
to_parent_id=to_dir_id)
1214
rename_entries.append(rename_entry)
1215
rename_tuples.append((from_rel, to_rel))
1217
# determine which move mode to use. checks also for movability
1218
rename_entries = self._determine_mv_mode(rename_entries, after)
1220
original_modified = self._inventory_is_modified
1223
self._inventory_is_modified = True
1224
self._move(rename_entries)
1226
# restore the inventory on error
1227
self._inventory_is_modified = original_modified
1229
self._write_inventory(inv)
1230
return rename_tuples
1232
def _determine_mv_mode(self, rename_entries, after=False):
1233
"""Determines for each from-to pair if both inventory and working tree
1234
or only the inventory has to be changed.
1236
Also does basic plausability tests.
1238
inv = self.inventory
1240
for rename_entry in rename_entries:
1241
# store to local variables for easier reference
1242
from_rel = rename_entry.from_rel
1243
from_id = rename_entry.from_id
1244
to_rel = rename_entry.to_rel
1245
to_id = inv.path2id(to_rel)
1246
only_change_inv = False
1248
# check the inventory for source and destination
1250
raise errors.BzrMoveFailedError(from_rel,to_rel,
1251
errors.NotVersionedError(path=str(from_rel)))
1252
if to_id is not None:
1253
raise errors.BzrMoveFailedError(from_rel,to_rel,
1254
errors.AlreadyVersionedError(path=str(to_rel)))
1256
# try to determine the mode for rename (only change inv or change
1257
# inv and file system)
1259
if not self.has_filename(to_rel):
1260
raise errors.BzrMoveFailedError(from_id,to_rel,
1261
errors.NoSuchFile(path=str(to_rel),
1262
extra="New file has not been created yet"))
1263
only_change_inv = True
1264
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1265
only_change_inv = True
1266
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1267
only_change_inv = False
1269
# something is wrong, so lets determine what exactly
1270
if not self.has_filename(from_rel) and \
1271
not self.has_filename(to_rel):
1272
raise errors.BzrRenameFailedError(from_rel,to_rel,
1273
errors.PathsDoNotExist(paths=(str(from_rel),
1276
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1277
extra="(Use --after to update the Bazaar id)")
1278
rename_entry.only_change_inv = only_change_inv
1279
return rename_entries
1281
def _move(self, rename_entries):
1282
"""Moves a list of files.
1284
Depending on the value of the flag 'only_change_inv', the
1285
file will be moved on the file system or not.
1287
inv = self.inventory
1290
for entry in rename_entries:
1292
self._move_entry(entry)
1294
self._rollback_move(moved)
1298
def _rollback_move(self, moved):
1299
"""Try to rollback a previous move in case of an filesystem error."""
1300
inv = self.inventory
1303
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1304
entry.to_tail, entry.to_parent_id, entry.from_rel,
1305
entry.from_tail, entry.from_parent_id,
1306
entry.only_change_inv))
1307
except errors.BzrMoveFailedError, e:
1308
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1309
" The working tree is in an inconsistent state."
1310
" Please consider doing a 'bzr revert'."
1311
" Error message is: %s" % e)
1313
def _move_entry(self, entry):
1314
inv = self.inventory
1315
from_rel_abs = self.abspath(entry.from_rel)
1316
to_rel_abs = self.abspath(entry.to_rel)
1317
if from_rel_abs == to_rel_abs:
1318
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1319
"Source and target are identical.")
1321
if not entry.only_change_inv:
1323
osutils.rename(from_rel_abs, to_rel_abs)
1325
raise errors.BzrMoveFailedError(entry.from_rel,
1327
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1329
@needs_tree_write_lock
1330
def rename_one(self, from_rel, to_rel, after=False):
1333
This can change the directory or the filename or both.
1335
rename_one has several 'modes' to work. First, it can rename a physical
1336
file and change the file_id. That is the normal mode. Second, it can
1337
only change the file_id without touching any physical file. This is
1338
the new mode introduced in version 0.15.
1340
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1341
versioned but present in the working tree.
1343
rename_one uses the second mode if 'after == False' and 'from_rel' is
1344
versioned but no longer in the working tree, and 'to_rel' is not
1345
versioned but present in the working tree.
1347
rename_one uses the first mode if 'after == False' and 'from_rel' is
1348
versioned and present in the working tree, and 'to_rel' is not
1349
versioned and not present in the working tree.
1351
Everything else results in an error.
1353
inv = self.inventory
1356
# create rename entries and tuples
1357
from_tail = splitpath(from_rel)[-1]
1358
from_id = inv.path2id(from_rel)
1360
raise errors.BzrRenameFailedError(from_rel,to_rel,
1361
errors.NotVersionedError(path=str(from_rel)))
1362
from_entry = inv[from_id]
1363
from_parent_id = from_entry.parent_id
1364
to_dir, to_tail = os.path.split(to_rel)
1365
to_dir_id = inv.path2id(to_dir)
1366
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1368
from_tail=from_tail,
1369
from_parent_id=from_parent_id,
1370
to_rel=to_rel, to_tail=to_tail,
1371
to_parent_id=to_dir_id)
1372
rename_entries.append(rename_entry)
1374
# determine which move mode to use. checks also for movability
1375
rename_entries = self._determine_mv_mode(rename_entries, after)
1377
# check if the target changed directory and if the target directory is
1379
if to_dir_id is None:
1380
raise errors.BzrMoveFailedError(from_rel,to_rel,
1381
errors.NotVersionedError(path=str(to_dir)))
1383
# all checks done. now we can continue with our actual work
1384
mutter('rename_one:\n'
1389
' to_dir_id {%s}\n',
1390
from_id, from_rel, to_rel, to_dir, to_dir_id)
1392
self._move(rename_entries)
1393
self._write_inventory(inv)
1395
class _RenameEntry(object):
1396
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1397
to_rel, to_tail, to_parent_id, only_change_inv=False):
1398
self.from_rel = from_rel
1399
self.from_id = from_id
1400
self.from_tail = from_tail
1401
self.from_parent_id = from_parent_id
1402
self.to_rel = to_rel
1403
self.to_tail = to_tail
1404
self.to_parent_id = to_parent_id
1405
self.only_change_inv = only_change_inv
1409
"""Return all unknown files.
1411
These are files in the working directory that are not versioned or
1412
control files or ignored.
1414
# force the extras method to be fully executed before returning, to
1415
# prevent race conditions with the lock
1417
[subp for subp in self.extras() if not self.is_ignored(subp)])
1419
@needs_tree_write_lock
1420
def unversion(self, file_ids):
1421
"""Remove the file ids in file_ids from the current versioned set.
1423
When a file_id is unversioned, all of its children are automatically
1426
:param file_ids: The file ids to stop versioning.
1427
:raises: NoSuchId if any fileid is not currently versioned.
1429
for file_id in file_ids:
1430
file_id = osutils.safe_file_id(file_id)
1431
if self._inventory.has_id(file_id):
1432
self._inventory.remove_recursive_id(file_id)
1434
raise errors.NoSuchId(self, file_id)
1436
# in the future this should just set a dirty bit to wait for the
1437
# final unlock. However, until all methods of workingtree start
1438
# with the current in -memory inventory rather than triggering
1439
# a read, it is more complex - we need to teach read_inventory
1440
# to know when to read, and when to not read first... and possibly
1441
# to save first when the in memory one may be corrupted.
1442
# so for now, we just only write it if it is indeed dirty.
1444
self._write_inventory(self._inventory)
1446
@deprecated_method(zero_eight)
1447
def iter_conflicts(self):
1448
"""List all files in the tree that have text or content conflicts.
1449
DEPRECATED. Use conflicts instead."""
1450
return self._iter_conflicts()
1452
def _iter_conflicts(self):
1454
for info in self.list_files():
1456
stem = get_conflicted_stem(path)
1459
if stem not in conflicted:
1460
conflicted.add(stem)
1464
def pull(self, source, overwrite=False, stop_revision=None,
1465
change_reporter=None):
1466
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1469
pp = ProgressPhase("Pull phase", 2, top_pb)
1471
old_revision_info = self.branch.last_revision_info()
1472
basis_tree = self.basis_tree()
1473
count = self.branch.pull(source, overwrite, stop_revision)
1474
new_revision_info = self.branch.last_revision_info()
1475
if new_revision_info != old_revision_info:
1477
repository = self.branch.repository
1478
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1479
basis_tree.lock_read()
1481
new_basis_tree = self.branch.basis_tree()
1488
change_reporter=change_reporter)
1489
if (basis_tree.inventory.root is None and
1490
new_basis_tree.inventory.root is not None):
1491
self.set_root_id(new_basis_tree.inventory.root.file_id)
1495
# TODO - dedup parents list with things merged by pull ?
1496
# reuse the revisiontree we merged against to set the new
1498
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1499
# we have to pull the merge trees out again, because
1500
# merge_inner has set the ids. - this corner is not yet
1501
# layered well enough to prevent double handling.
1502
# XXX TODO: Fix the double handling: telling the tree about
1503
# the already known parent data is wasteful.
1504
merges = self.get_parent_ids()[1:]
1505
parent_trees.extend([
1506
(parent, repository.revision_tree(parent)) for
1508
self.set_parent_trees(parent_trees)
1515
def put_file_bytes_non_atomic(self, file_id, bytes):
1516
"""See MutableTree.put_file_bytes_non_atomic."""
1517
file_id = osutils.safe_file_id(file_id)
1518
stream = file(self.id2abspath(file_id), 'wb')
1523
# TODO: update the hashcache here ?
1526
"""Yield all unversioned files in this WorkingTree.
1528
If there are any unversioned directories then only the directory is
1529
returned, not all its children. But if there are unversioned files
1530
under a versioned subdirectory, they are returned.
1532
Currently returned depth-first, sorted by name within directories.
1533
This is the same order used by 'osutils.walkdirs'.
1535
## TODO: Work from given directory downwards
1536
for path, dir_entry in self.inventory.directories():
1537
# mutter("search for unknowns in %r", path)
1538
dirabs = self.abspath(path)
1539
if not isdir(dirabs):
1540
# e.g. directory deleted
1544
for subf in os.listdir(dirabs):
1547
if subf not in dir_entry.children:
1548
subf_norm, can_access = osutils.normalized_filename(subf)
1549
if subf_norm != subf and can_access:
1550
if subf_norm not in dir_entry.children:
1551
fl.append(subf_norm)
1557
subp = pathjoin(path, subf)
1560
def ignored_files(self):
1561
"""Yield list of PATH, IGNORE_PATTERN"""
1562
for subp in self.extras():
1563
pat = self.is_ignored(subp)
1567
def get_ignore_list(self):
1568
"""Return list of ignore patterns.
1570
Cached in the Tree object after the first call.
1572
ignoreset = getattr(self, '_ignoreset', None)
1573
if ignoreset is not None:
1576
ignore_globs = set()
1577
ignore_globs.update(ignores.get_runtime_ignores())
1578
ignore_globs.update(ignores.get_user_ignores())
1579
if self.has_filename(bzrlib.IGNORE_FILENAME):
1580
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1582
ignore_globs.update(ignores.parse_ignore_file(f))
1585
self._ignoreset = ignore_globs
1588
def _flush_ignore_list_cache(self):
1589
"""Resets the cached ignore list to force a cache rebuild."""
1590
self._ignoreset = None
1591
self._ignoreglobster = None
1593
def is_ignored(self, filename):
1594
r"""Check whether the filename matches an ignore pattern.
1596
Patterns containing '/' or '\' need to match the whole path;
1597
others match against only the last component.
1599
If the file is ignored, returns the pattern which caused it to
1600
be ignored, otherwise None. So this can simply be used as a
1601
boolean if desired."""
1602
if getattr(self, '_ignoreglobster', None) is None:
1603
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1604
return self._ignoreglobster.match(filename)
1606
def kind(self, file_id):
1607
return file_kind(self.id2abspath(file_id))
1609
def _comparison_data(self, entry, path):
1610
abspath = self.abspath(path)
1612
stat_value = os.lstat(abspath)
1614
if getattr(e, 'errno', None) == errno.ENOENT:
1621
mode = stat_value.st_mode
1622
kind = osutils.file_kind_from_stat_mode(mode)
1623
if not supports_executable():
1624
executable = entry is not None and entry.executable
1626
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1627
return kind, executable, stat_value
1629
def _file_size(self, entry, stat_value):
1630
return stat_value.st_size
1632
def last_revision(self):
1633
"""Return the last revision of the branch for this tree.
1635
This format tree does not support a separate marker for last-revision
1636
compared to the branch.
1638
See MutableTree.last_revision
1640
return self._last_revision()
1643
def _last_revision(self):
1644
"""helper for get_parent_ids."""
1645
return _mod_revision.ensure_null(self.branch.last_revision())
1647
def is_locked(self):
1648
return self._control_files.is_locked()
1650
def _must_be_locked(self):
1651
if not self.is_locked():
1652
raise errors.ObjectNotLocked(self)
1654
def lock_read(self):
1655
"""See Branch.lock_read, and WorkingTree.unlock."""
1656
if not self.is_locked():
1658
self.branch.lock_read()
1660
return self._control_files.lock_read()
1662
self.branch.unlock()
1665
def lock_tree_write(self):
1666
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1667
if not self.is_locked():
1669
self.branch.lock_read()
1671
return self._control_files.lock_write()
1673
self.branch.unlock()
1676
def lock_write(self):
1677
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1678
if not self.is_locked():
1680
self.branch.lock_write()
1682
return self._control_files.lock_write()
1684
self.branch.unlock()
1687
def get_physical_lock_status(self):
1688
return self._control_files.get_physical_lock_status()
1690
def _basis_inventory_name(self):
1691
return 'basis-inventory-cache'
1693
def _reset_data(self):
1694
"""Reset transient data that cannot be revalidated."""
1695
self._inventory_is_modified = False
1696
result = self._deserialize(self._control_files.get('inventory'))
1697
self._set_inventory(result, dirty=False)
1699
@needs_tree_write_lock
1700
def set_last_revision(self, new_revision):
1701
"""Change the last revision in the working tree."""
1702
new_revision = osutils.safe_revision_id(new_revision)
1703
if self._change_last_revision(new_revision):
1704
self._cache_basis_inventory(new_revision)
1706
def _change_last_revision(self, new_revision):
1707
"""Template method part of set_last_revision to perform the change.
1709
This is used to allow WorkingTree3 instances to not affect branch
1710
when their last revision is set.
1712
if _mod_revision.is_null(new_revision):
1713
self.branch.set_revision_history([])
1716
self.branch.generate_revision_history(new_revision)
1717
except errors.NoSuchRevision:
1718
# not present in the repo - dont try to set it deeper than the tip
1719
self.branch.set_revision_history([new_revision])
1722
def _write_basis_inventory(self, xml):
1723
"""Write the basis inventory XML to the basis-inventory file"""
1724
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1725
path = self._basis_inventory_name()
1727
self._control_files.put(path, sio)
1729
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1730
"""Create the text that will be saved in basis-inventory"""
1731
# TODO: jam 20070209 This should be redundant, as the revision_id
1732
# as all callers should have already converted the revision_id to
1734
inventory.revision_id = osutils.safe_revision_id(revision_id)
1735
return xml7.serializer_v7.write_inventory_to_string(inventory)
1737
def _cache_basis_inventory(self, new_revision):
1738
"""Cache new_revision as the basis inventory."""
1739
# TODO: this should allow the ready-to-use inventory to be passed in,
1740
# as commit already has that ready-to-use [while the format is the
1743
# this double handles the inventory - unpack and repack -
1744
# but is easier to understand. We can/should put a conditional
1745
# in here based on whether the inventory is in the latest format
1746
# - perhaps we should repack all inventories on a repository
1748
# the fast path is to copy the raw xml from the repository. If the
1749
# xml contains 'revision_id="', then we assume the right
1750
# revision_id is set. We must check for this full string, because a
1751
# root node id can legitimately look like 'revision_id' but cannot
1753
xml = self.branch.repository.get_inventory_xml(new_revision)
1754
firstline = xml.split('\n', 1)[0]
1755
if (not 'revision_id="' in firstline or
1756
'format="7"' not in firstline):
1757
inv = self.branch.repository.deserialise_inventory(
1759
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1760
self._write_basis_inventory(xml)
1761
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1764
def read_basis_inventory(self):
1765
"""Read the cached basis inventory."""
1766
path = self._basis_inventory_name()
1767
return self._control_files.get(path).read()
1770
def read_working_inventory(self):
1771
"""Read the working inventory.
1773
:raises errors.InventoryModified: read_working_inventory will fail
1774
when the current in memory inventory has been modified.
1776
# conceptually this should be an implementation detail of the tree.
1777
# XXX: Deprecate this.
1778
# ElementTree does its own conversion from UTF-8, so open in
1780
if self._inventory_is_modified:
1781
raise errors.InventoryModified(self)
1782
result = self._deserialize(self._control_files.get('inventory'))
1783
self._set_inventory(result, dirty=False)
1786
@needs_tree_write_lock
1787
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1789
"""Remove nominated files from the working inventory.
1791
:files: File paths relative to the basedir.
1792
:keep_files: If true, the files will also be kept.
1793
:force: Delete files and directories, even if they are changed and
1794
even if the directories are not empty.
1796
if isinstance(files, basestring):
1802
unknown_nested_files=set()
1804
def recurse_directory_to_add_files(directory):
1805
# Recurse directory and add all files
1806
# so we can check if they have changed.
1807
for parent_info, file_infos in\
1808
osutils.walkdirs(self.abspath(directory),
1810
for relpath, basename, kind, lstat, abspath in file_infos:
1811
# Is it versioned or ignored?
1812
if self.path2id(relpath) or self.is_ignored(relpath):
1813
# Add nested content for deletion.
1814
new_files.add(relpath)
1816
# Files which are not versioned and not ignored
1817
# should be treated as unknown.
1818
unknown_nested_files.add((relpath, None, kind))
1820
for filename in files:
1821
# Get file name into canonical form.
1822
abspath = self.abspath(filename)
1823
filename = self.relpath(abspath)
1824
if len(filename) > 0:
1825
new_files.add(filename)
1826
if osutils.isdir(abspath):
1827
recurse_directory_to_add_files(filename)
1829
files = list(new_files)
1832
return # nothing to do
1834
# Sort needed to first handle directory content before the directory
1835
files.sort(reverse=True)
1837
# Bail out if we are going to delete files we shouldn't
1838
if not keep_files and not force:
1839
has_changed_files = len(unknown_nested_files) > 0
1840
if not has_changed_files:
1841
for (file_id, path, content_change, versioned, parent_id, name,
1842
kind, executable) in self._iter_changes(self.basis_tree(),
1843
include_unchanged=True, require_versioned=False,
1844
want_unversioned=True, specific_files=files):
1845
# Check if it's an unknown (but not ignored) OR
1846
# changed (but not deleted) :
1847
if not self.is_ignored(path[1]) and (
1848
versioned == (False, False) or
1849
content_change and kind[1] != None):
1850
has_changed_files = True
1853
if has_changed_files:
1854
# Make delta show ALL applicable changes in error message.
1855
tree_delta = self.changes_from(self.basis_tree(),
1856
require_versioned=False, want_unversioned=True,
1857
specific_files=files)
1858
for unknown_file in unknown_nested_files:
1859
if unknown_file not in tree_delta.unversioned:
1860
tree_delta.unversioned.extend((unknown_file,))
1861
raise errors.BzrRemoveChangedFilesError(tree_delta)
1863
# Build inv_delta and delete files where applicaple,
1864
# do this before any modifications to inventory.
1866
fid = self.path2id(f)
1869
message = "%s is not versioned." % (f,)
1872
# having removed it, it must be either ignored or unknown
1873
if self.is_ignored(f):
1877
textui.show_status(new_status, self.kind(fid), f,
1880
inv_delta.append((f, None, fid, None))
1881
message = "removed %s" % (f,)
1884
abs_path = self.abspath(f)
1885
if osutils.lexists(abs_path):
1886
if (osutils.isdir(abs_path) and
1887
len(os.listdir(abs_path)) > 0):
1889
osutils.rmtree(abs_path)
1891
message = "%s is not an empty directory "\
1892
"and won't be deleted." % (f,)
1894
osutils.delete_any(abs_path)
1895
message = "deleted %s" % (f,)
1896
elif message is not None:
1897
# Only care if we haven't done anything yet.
1898
message = "%s does not exist." % (f,)
1900
# Print only one message (if any) per file.
1901
if message is not None:
1903
self.apply_inventory_delta(inv_delta)
1905
@needs_tree_write_lock
1906
def revert(self, filenames=None, old_tree=None, backups=True,
1907
pb=DummyProgress(), report_changes=False):
1908
from bzrlib.conflicts import resolve
1911
symbol_versioning.warn('Using [] to revert all files is deprecated'
1912
' as of bzr 0.91. Please use None (the default) instead.',
1913
DeprecationWarning, stacklevel=2)
1914
if old_tree is None:
1915
old_tree = self.basis_tree()
1916
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1918
if filenames is None:
1919
self.set_parent_ids(self.get_parent_ids()[:1])
1922
resolve(self, filenames, ignore_misses=True)
1925
def revision_tree(self, revision_id):
1926
"""See Tree.revision_tree.
1928
WorkingTree can supply revision_trees for the basis revision only
1929
because there is only one cached inventory in the bzr directory.
1931
if revision_id == self.last_revision():
1933
xml = self.read_basis_inventory()
1934
except errors.NoSuchFile:
1938
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1939
# dont use the repository revision_tree api because we want
1940
# to supply the inventory.
1941
if inv.revision_id == revision_id:
1942
return revisiontree.RevisionTree(self.branch.repository,
1944
except errors.BadInventoryFormat:
1946
# raise if there was no inventory, or if we read the wrong inventory.
1947
raise errors.NoSuchRevisionInTree(self, revision_id)
1949
# XXX: This method should be deprecated in favour of taking in a proper
1950
# new Inventory object.
1951
@needs_tree_write_lock
1952
def set_inventory(self, new_inventory_list):
1953
from bzrlib.inventory import (Inventory,
1958
inv = Inventory(self.get_root_id())
1959
for path, file_id, parent, kind in new_inventory_list:
1960
name = os.path.basename(path)
1963
# fixme, there should be a factory function inv,add_??
1964
if kind == 'directory':
1965
inv.add(InventoryDirectory(file_id, name, parent))
1966
elif kind == 'file':
1967
inv.add(InventoryFile(file_id, name, parent))
1968
elif kind == 'symlink':
1969
inv.add(InventoryLink(file_id, name, parent))
1971
raise errors.BzrError("unknown kind %r" % kind)
1972
self._write_inventory(inv)
1974
@needs_tree_write_lock
1975
def set_root_id(self, file_id):
1976
"""Set the root id for this tree."""
1979
symbol_versioning.warn(symbol_versioning.zero_twelve
1980
% 'WorkingTree.set_root_id with fileid=None',
1985
file_id = osutils.safe_file_id(file_id)
1986
self._set_root_id(file_id)
1988
def _set_root_id(self, file_id):
1989
"""Set the root id for this tree, in a format specific manner.
1991
:param file_id: The file id to assign to the root. It must not be
1992
present in the current inventory or an error will occur. It must
1993
not be None, but rather a valid file id.
1995
inv = self._inventory
1996
orig_root_id = inv.root.file_id
1997
# TODO: it might be nice to exit early if there was nothing
1998
# to do, saving us from trigger a sync on unlock.
1999
self._inventory_is_modified = True
2000
# we preserve the root inventory entry object, but
2001
# unlinkit from the byid index
2002
del inv._byid[inv.root.file_id]
2003
inv.root.file_id = file_id
2004
# and link it into the index with the new changed id.
2005
inv._byid[inv.root.file_id] = inv.root
2006
# and finally update all children to reference the new id.
2007
# XXX: this should be safe to just look at the root.children
2008
# list, not the WHOLE INVENTORY.
2011
if entry.parent_id == orig_root_id:
2012
entry.parent_id = inv.root.file_id
2015
"""See Branch.unlock.
2017
WorkingTree locking just uses the Branch locking facilities.
2018
This is current because all working trees have an embedded branch
2019
within them. IF in the future, we were to make branch data shareable
2020
between multiple working trees, i.e. via shared storage, then we
2021
would probably want to lock both the local tree, and the branch.
2023
raise NotImplementedError(self.unlock)
2025
def update(self, change_reporter=None):
2026
"""Update a working tree along its branch.
2028
This will update the branch if its bound too, which means we have
2029
multiple trees involved:
2031
- The new basis tree of the master.
2032
- The old basis tree of the branch.
2033
- The old basis tree of the working tree.
2034
- The current working tree state.
2036
Pathologically, all three may be different, and non-ancestors of each
2037
other. Conceptually we want to:
2039
- Preserve the wt.basis->wt.state changes
2040
- Transform the wt.basis to the new master basis.
2041
- Apply a merge of the old branch basis to get any 'local' changes from
2043
- Restore the wt.basis->wt.state changes.
2045
There isn't a single operation at the moment to do that, so we:
2046
- Merge current state -> basis tree of the master w.r.t. the old tree
2048
- Do a 'normal' merge of the old branch basis if it is relevant.
2050
if self.branch.get_master_branch() is not None:
2052
update_branch = True
2054
self.lock_tree_write()
2055
update_branch = False
2058
old_tip = self.branch.update()
2061
return self._update_tree(old_tip, change_reporter)
2065
@needs_tree_write_lock
2066
def _update_tree(self, old_tip=None, change_reporter=None):
2067
"""Update a tree to the master branch.
2069
:param old_tip: if supplied, the previous tip revision the branch,
2070
before it was changed to the master branch's tip.
2072
# here if old_tip is not None, it is the old tip of the branch before
2073
# it was updated from the master branch. This should become a pending
2074
# merge in the working tree to preserve the user existing work. we
2075
# cant set that until we update the working trees last revision to be
2076
# one from the new branch, because it will just get absorbed by the
2077
# parent de-duplication logic.
2079
# We MUST save it even if an error occurs, because otherwise the users
2080
# local work is unreferenced and will appear to have been lost.
2084
last_rev = self.get_parent_ids()[0]
2086
last_rev = _mod_revision.NULL_REVISION
2087
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2088
# merge tree state up to new branch tip.
2089
basis = self.basis_tree()
2092
to_tree = self.branch.basis_tree()
2093
if basis.inventory.root is None:
2094
self.set_root_id(to_tree.inventory.root.file_id)
2096
result += merge.merge_inner(
2101
change_reporter=change_reporter)
2104
# TODO - dedup parents list with things merged by pull ?
2105
# reuse the tree we've updated to to set the basis:
2106
parent_trees = [(self.branch.last_revision(), to_tree)]
2107
merges = self.get_parent_ids()[1:]
2108
# Ideally we ask the tree for the trees here, that way the working
2109
# tree can decide whether to give us teh entire tree or give us a
2110
# lazy initialised tree. dirstate for instance will have the trees
2111
# in ram already, whereas a last-revision + basis-inventory tree
2112
# will not, but also does not need them when setting parents.
2113
for parent in merges:
2114
parent_trees.append(
2115
(parent, self.branch.repository.revision_tree(parent)))
2116
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2117
parent_trees.append(
2118
(old_tip, self.branch.repository.revision_tree(old_tip)))
2119
self.set_parent_trees(parent_trees)
2120
last_rev = parent_trees[0][0]
2122
# the working tree had the same last-revision as the master
2123
# branch did. We may still have pivot local work from the local
2124
# branch into old_tip:
2125
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2126
self.add_parent_tree_id(old_tip)
2127
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2128
and old_tip != last_rev):
2129
# our last revision was not the prior branch last revision
2130
# and we have converted that last revision to a pending merge.
2131
# base is somewhere between the branch tip now
2132
# and the now pending merge
2134
# Since we just modified the working tree and inventory, flush out
2135
# the current state, before we modify it again.
2136
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2137
# requires it only because TreeTransform directly munges the
2138
# inventory and calls tree._write_inventory(). Ultimately we
2139
# should be able to remove this extra flush.
2141
graph = self.branch.repository.get_graph()
2142
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2144
base_tree = self.branch.repository.revision_tree(base_rev_id)
2145
other_tree = self.branch.repository.revision_tree(old_tip)
2146
result += merge.merge_inner(
2151
change_reporter=change_reporter)
2154
def _write_hashcache_if_dirty(self):
2155
"""Write out the hashcache if it is dirty."""
2156
if self._hashcache.needs_write:
2158
self._hashcache.write()
2160
if e.errno not in (errno.EPERM, errno.EACCES):
2162
# TODO: jam 20061219 Should this be a warning? A single line
2163
# warning might be sufficient to let the user know what
2165
mutter('Could not write hashcache for %s\nError: %s',
2166
self._hashcache.cache_file_name(), e)
2168
@needs_tree_write_lock
2169
def _write_inventory(self, inv):
2170
"""Write inventory as the current inventory."""
2171
self._set_inventory(inv, dirty=True)
2174
def set_conflicts(self, arg):
2175
raise errors.UnsupportedOperation(self.set_conflicts, self)
2177
def add_conflicts(self, arg):
2178
raise errors.UnsupportedOperation(self.add_conflicts, self)
2181
def conflicts(self):
2182
conflicts = _mod_conflicts.ConflictList()
2183
for conflicted in self._iter_conflicts():
2186
if file_kind(self.abspath(conflicted)) != "file":
2188
except errors.NoSuchFile:
2191
for suffix in ('.THIS', '.OTHER'):
2193
kind = file_kind(self.abspath(conflicted+suffix))
2196
except errors.NoSuchFile:
2200
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2201
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2203
file_id=self.path2id(conflicted)))
2206
def walkdirs(self, prefix=""):
2207
"""Walk the directories of this tree.
2209
returns a generator which yields items in the form:
2210
((curren_directory_path, fileid),
2211
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2214
This API returns a generator, which is only valid during the current
2215
tree transaction - within a single lock_read or lock_write duration.
2217
If the tree is not locked, it may cause an error to be raised,
2218
depending on the tree implementation.
2220
disk_top = self.abspath(prefix)
2221
if disk_top.endswith('/'):
2222
disk_top = disk_top[:-1]
2223
top_strip_len = len(disk_top) + 1
2224
inventory_iterator = self._walkdirs(prefix)
2225
disk_iterator = osutils.walkdirs(disk_top, prefix)
2227
current_disk = disk_iterator.next()
2228
disk_finished = False
2230
if not (e.errno == errno.ENOENT or
2231
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2234
disk_finished = True
2236
current_inv = inventory_iterator.next()
2237
inv_finished = False
2238
except StopIteration:
2241
while not inv_finished or not disk_finished:
2242
if not disk_finished:
2243
# strip out .bzr dirs
2244
if current_disk[0][1][top_strip_len:] == '':
2245
# osutils.walkdirs can be made nicer -
2246
# yield the path-from-prefix rather than the pathjoined
2248
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2249
if current_disk[1][bzrdir_loc][0] == '.bzr':
2250
# we dont yield the contents of, or, .bzr itself.
2251
del current_disk[1][bzrdir_loc]
2253
# everything is unknown
2256
# everything is missing
2259
direction = cmp(current_inv[0][0], current_disk[0][0])
2261
# disk is before inventory - unknown
2262
dirblock = [(relpath, basename, kind, stat, None, None) for
2263
relpath, basename, kind, stat, top_path in current_disk[1]]
2264
yield (current_disk[0][0], None), dirblock
2266
current_disk = disk_iterator.next()
2267
except StopIteration:
2268
disk_finished = True
2270
# inventory is before disk - missing.
2271
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2272
for relpath, basename, dkind, stat, fileid, kind in
2274
yield (current_inv[0][0], current_inv[0][1]), dirblock
2276
current_inv = inventory_iterator.next()
2277
except StopIteration:
2280
# versioned present directory
2281
# merge the inventory and disk data together
2283
for relpath, subiterator in itertools.groupby(sorted(
2284
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2285
path_elements = list(subiterator)
2286
if len(path_elements) == 2:
2287
inv_row, disk_row = path_elements
2288
# versioned, present file
2289
dirblock.append((inv_row[0],
2290
inv_row[1], disk_row[2],
2291
disk_row[3], inv_row[4],
2293
elif len(path_elements[0]) == 5:
2295
dirblock.append((path_elements[0][0],
2296
path_elements[0][1], path_elements[0][2],
2297
path_elements[0][3], None, None))
2298
elif len(path_elements[0]) == 6:
2299
# versioned, absent file.
2300
dirblock.append((path_elements[0][0],
2301
path_elements[0][1], 'unknown', None,
2302
path_elements[0][4], path_elements[0][5]))
2304
raise NotImplementedError('unreachable code')
2305
yield current_inv[0], dirblock
2307
current_inv = inventory_iterator.next()
2308
except StopIteration:
2311
current_disk = disk_iterator.next()
2312
except StopIteration:
2313
disk_finished = True
2315
def _walkdirs(self, prefix=""):
2316
"""Walk the directories of this tree.
2318
:prefix: is used as the directrory to start with.
2319
returns a generator which yields items in the form:
2320
((curren_directory_path, fileid),
2321
[(file1_path, file1_name, file1_kind, None, file1_id,
2324
_directory = 'directory'
2325
# get the root in the inventory
2326
inv = self.inventory
2327
top_id = inv.path2id(prefix)
2331
pending = [(prefix, '', _directory, None, top_id, None)]
2334
currentdir = pending.pop()
2335
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2336
top_id = currentdir[4]
2338
relroot = currentdir[0] + '/'
2341
# FIXME: stash the node in pending
2343
for name, child in entry.sorted_children():
2344
dirblock.append((relroot + name, name, child.kind, None,
2345
child.file_id, child.kind
2347
yield (currentdir[0], entry.file_id), dirblock
2348
# push the user specified dirs from dirblock
2349
for dir in reversed(dirblock):
2350
if dir[2] == _directory:
2353
@needs_tree_write_lock
2354
def auto_resolve(self):
2355
"""Automatically resolve text conflicts according to contents.
2357
Only text conflicts are auto_resolvable. Files with no conflict markers
2358
are considered 'resolved', because bzr always puts conflict markers
2359
into files that have text conflicts. The corresponding .THIS .BASE and
2360
.OTHER files are deleted, as per 'resolve'.
2361
:return: a tuple of ConflictLists: (un_resolved, resolved).
2363
un_resolved = _mod_conflicts.ConflictList()
2364
resolved = _mod_conflicts.ConflictList()
2365
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2366
for conflict in self.conflicts():
2367
if (conflict.typestring != 'text conflict' or
2368
self.kind(conflict.file_id) != 'file'):
2369
un_resolved.append(conflict)
2371
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2373
for line in my_file:
2374
if conflict_re.search(line):
2375
un_resolved.append(conflict)
2378
resolved.append(conflict)
2381
resolved.remove_files(self)
2382
self.set_conflicts(un_resolved)
2383
return un_resolved, resolved
2385
def _validate(self):
2386
"""Validate internal structures.
2388
This is meant mostly for the test suite. To give it a chance to detect
2389
corruption after actions have occurred. The default implementation is a
2392
:return: None. An exception should be raised if there is an error.
2397
class WorkingTree2(WorkingTree):
2398
"""This is the Format 2 working tree.
2400
This was the first weave based working tree.
2401
- uses os locks for locking.
2402
- uses the branch last-revision.
2405
def __init__(self, *args, **kwargs):
2406
super(WorkingTree2, self).__init__(*args, **kwargs)
2407
# WorkingTree2 has more of a constraint that self._inventory must
2408
# exist. Because this is an older format, we don't mind the overhead
2409
# caused by the extra computation here.
2411
# Newer WorkingTree's should only have self._inventory set when they
2413
if self._inventory is None:
2414
self.read_working_inventory()
2416
def lock_tree_write(self):
2417
"""See WorkingTree.lock_tree_write().
2419
In Format2 WorkingTrees we have a single lock for the branch and tree
2420
so lock_tree_write() degrades to lock_write().
2422
self.branch.lock_write()
2424
return self._control_files.lock_write()
2426
self.branch.unlock()
2430
# do non-implementation specific cleanup
2433
# we share control files:
2434
if self._control_files._lock_count == 3:
2435
# _inventory_is_modified is always False during a read lock.
2436
if self._inventory_is_modified:
2438
self._write_hashcache_if_dirty()
2440
# reverse order of locking.
2442
return self._control_files.unlock()
2444
self.branch.unlock()
2447
class WorkingTree3(WorkingTree):
2448
"""This is the Format 3 working tree.
2450
This differs from the base WorkingTree by:
2451
- having its own file lock
2452
- having its own last-revision property.
2454
This is new in bzr 0.8
2458
def _last_revision(self):
2459
"""See Mutable.last_revision."""
2461
return osutils.safe_revision_id(
2462
self._control_files.get('last-revision').read())
2463
except errors.NoSuchFile:
2464
return _mod_revision.NULL_REVISION
2466
def _change_last_revision(self, revision_id):
2467
"""See WorkingTree._change_last_revision."""
2468
if revision_id is None or revision_id == NULL_REVISION:
2470
self._control_files._transport.delete('last-revision')
2471
except errors.NoSuchFile:
2475
self._control_files.put_bytes('last-revision', revision_id)
2478
@needs_tree_write_lock
2479
def set_conflicts(self, conflicts):
2480
self._put_rio('conflicts', conflicts.to_stanzas(),
2483
@needs_tree_write_lock
2484
def add_conflicts(self, new_conflicts):
2485
conflict_set = set(self.conflicts())
2486
conflict_set.update(set(list(new_conflicts)))
2487
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2488
key=_mod_conflicts.Conflict.sort_key)))
2491
def conflicts(self):
2493
confile = self._control_files.get('conflicts')
2494
except errors.NoSuchFile:
2495
return _mod_conflicts.ConflictList()
2497
if confile.next() != CONFLICT_HEADER_1 + '\n':
2498
raise errors.ConflictFormatError()
2499
except StopIteration:
2500
raise errors.ConflictFormatError()
2501
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2504
# do non-implementation specific cleanup
2506
if self._control_files._lock_count == 1:
2507
# _inventory_is_modified is always False during a read lock.
2508
if self._inventory_is_modified:
2510
self._write_hashcache_if_dirty()
2511
# reverse order of locking.
2513
return self._control_files.unlock()
2515
self.branch.unlock()
2518
def get_conflicted_stem(path):
2519
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2520
if path.endswith(suffix):
2521
return path[:-len(suffix)]
2524
@deprecated_function(zero_eight)
2525
def is_control_file(filename):
2526
"""See WorkingTree.is_control_filename(filename)."""
2527
## FIXME: better check
2528
filename = normpath(filename)
2529
while filename != '':
2530
head, tail = os.path.split(filename)
2531
## mutter('check %r for control file' % ((head, tail),))
2534
if filename == head:
2540
class WorkingTreeFormat(object):
2541
"""An encapsulation of the initialization and open routines for a format.
2543
Formats provide three things:
2544
* An initialization routine,
2548
Formats are placed in an dict by their format string for reference
2549
during workingtree opening. Its not required that these be instances, they
2550
can be classes themselves with class methods - it simply depends on
2551
whether state is needed for a given format or not.
2553
Once a format is deprecated, just deprecate the initialize and open
2554
methods on the format class. Do not deprecate the object, as the
2555
object will be created every time regardless.
2558
_default_format = None
2559
"""The default format used for new trees."""
2562
"""The known formats."""
2564
requires_rich_root = False
2566
upgrade_recommended = False
2569
def find_format(klass, a_bzrdir):
2570
"""Return the format for the working tree object in a_bzrdir."""
2572
transport = a_bzrdir.get_workingtree_transport(None)
2573
format_string = transport.get("format").read()
2574
return klass._formats[format_string]
2575
except errors.NoSuchFile:
2576
raise errors.NoWorkingTree(base=transport.base)
2578
raise errors.UnknownFormatError(format=format_string)
2580
def __eq__(self, other):
2581
return self.__class__ is other.__class__
2583
def __ne__(self, other):
2584
return not (self == other)
2587
def get_default_format(klass):
2588
"""Return the current default format."""
2589
return klass._default_format
2591
def get_format_string(self):
2592
"""Return the ASCII format string that identifies this format."""
2593
raise NotImplementedError(self.get_format_string)
2595
def get_format_description(self):
2596
"""Return the short description for this format."""
2597
raise NotImplementedError(self.get_format_description)
2599
def is_supported(self):
2600
"""Is this format supported?
2602
Supported formats can be initialized and opened.
2603
Unsupported formats may not support initialization or committing or
2604
some other features depending on the reason for not being supported.
2609
def register_format(klass, format):
2610
klass._formats[format.get_format_string()] = format
2613
def set_default_format(klass, format):
2614
klass._default_format = format
2617
def unregister_format(klass, format):
2618
assert klass._formats[format.get_format_string()] is format
2619
del klass._formats[format.get_format_string()]
2622
class WorkingTreeFormat2(WorkingTreeFormat):
2623
"""The second working tree format.
2625
This format modified the hash cache from the format 1 hash cache.
2628
upgrade_recommended = True
2630
def get_format_description(self):
2631
"""See WorkingTreeFormat.get_format_description()."""
2632
return "Working tree format 2"
2634
def stub_initialize_remote(self, control_files):
2635
"""As a special workaround create critical control files for a remote working tree
2637
This ensures that it can later be updated and dealt with locally,
2638
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2639
no working tree. (See bug #43064).
2643
xml5.serializer_v5.write_inventory(inv, sio)
2645
control_files.put('inventory', sio)
2647
control_files.put_bytes('pending-merges', '')
2650
def initialize(self, a_bzrdir, revision_id=None):
2651
"""See WorkingTreeFormat.initialize()."""
2652
if not isinstance(a_bzrdir.transport, LocalTransport):
2653
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2654
branch = a_bzrdir.open_branch()
2655
if revision_id is None:
2656
revision_id = _mod_revision.ensure_null(branch.last_revision())
2658
revision_id = osutils.safe_revision_id(revision_id)
2661
branch.generate_revision_history(revision_id)
2665
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2671
basis_tree = branch.repository.revision_tree(revision_id)
2672
if basis_tree.inventory.root is not None:
2673
wt.set_root_id(basis_tree.inventory.root.file_id)
2674
# set the parent list and cache the basis tree.
2675
if _mod_revision.is_null(revision_id):
2678
parent_trees = [(revision_id, basis_tree)]
2679
wt.set_parent_trees(parent_trees)
2680
transform.build_tree(basis_tree, wt)
2684
super(WorkingTreeFormat2, self).__init__()
2685
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2687
def open(self, a_bzrdir, _found=False):
2688
"""Return the WorkingTree object for a_bzrdir
2690
_found is a private parameter, do not use it. It is used to indicate
2691
if format probing has already been done.
2694
# we are being called directly and must probe.
2695
raise NotImplementedError
2696
if not isinstance(a_bzrdir.transport, LocalTransport):
2697
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2698
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2704
class WorkingTreeFormat3(WorkingTreeFormat):
2705
"""The second working tree format updated to record a format marker.
2708
- exists within a metadir controlling .bzr
2709
- includes an explicit version marker for the workingtree control
2710
files, separate from the BzrDir format
2711
- modifies the hash cache format
2713
- uses a LockDir to guard access for writes.
2716
upgrade_recommended = True
2718
def get_format_string(self):
2719
"""See WorkingTreeFormat.get_format_string()."""
2720
return "Bazaar-NG Working Tree format 3"
2722
def get_format_description(self):
2723
"""See WorkingTreeFormat.get_format_description()."""
2724
return "Working tree format 3"
2726
_lock_file_name = 'lock'
2727
_lock_class = LockDir
2729
_tree_class = WorkingTree3
2731
def __get_matchingbzrdir(self):
2732
return bzrdir.BzrDirMetaFormat1()
2734
_matchingbzrdir = property(__get_matchingbzrdir)
2736
def _open_control_files(self, a_bzrdir):
2737
transport = a_bzrdir.get_workingtree_transport(None)
2738
return LockableFiles(transport, self._lock_file_name,
2741
def initialize(self, a_bzrdir, revision_id=None):
2742
"""See WorkingTreeFormat.initialize().
2744
revision_id allows creating a working tree at a different
2745
revision than the branch is at.
2747
if not isinstance(a_bzrdir.transport, LocalTransport):
2748
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2749
transport = a_bzrdir.get_workingtree_transport(self)
2750
control_files = self._open_control_files(a_bzrdir)
2751
control_files.create_lock()
2752
control_files.lock_write()
2753
control_files.put_utf8('format', self.get_format_string())
2754
branch = a_bzrdir.open_branch()
2755
if revision_id is None:
2756
revision_id = _mod_revision.ensure_null(branch.last_revision())
2758
revision_id = osutils.safe_revision_id(revision_id)
2759
# WorkingTree3 can handle an inventory which has a unique root id.
2760
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2761
# those trees. And because there isn't a format bump inbetween, we
2762
# are maintaining compatibility with older clients.
2763
# inv = Inventory(root_id=gen_root_id())
2764
inv = self._initial_inventory()
2765
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2771
_control_files=control_files)
2772
wt.lock_tree_write()
2774
basis_tree = branch.repository.revision_tree(revision_id)
2775
# only set an explicit root id if there is one to set.
2776
if basis_tree.inventory.root is not None:
2777
wt.set_root_id(basis_tree.inventory.root.file_id)
2778
if revision_id == NULL_REVISION:
2779
wt.set_parent_trees([])
2781
wt.set_parent_trees([(revision_id, basis_tree)])
2782
transform.build_tree(basis_tree, wt)
2784
# Unlock in this order so that the unlock-triggers-flush in
2785
# WorkingTree is given a chance to fire.
2786
control_files.unlock()
2790
def _initial_inventory(self):
2794
super(WorkingTreeFormat3, self).__init__()
2796
def open(self, a_bzrdir, _found=False):
2797
"""Return the WorkingTree object for a_bzrdir
2799
_found is a private parameter, do not use it. It is used to indicate
2800
if format probing has already been done.
2803
# we are being called directly and must probe.
2804
raise NotImplementedError
2805
if not isinstance(a_bzrdir.transport, LocalTransport):
2806
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2807
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2810
def _open(self, a_bzrdir, control_files):
2811
"""Open the tree itself.
2813
:param a_bzrdir: the dir for the tree.
2814
:param control_files: the control files for the tree.
2816
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2820
_control_files=control_files)
2823
return self.get_format_string()
2826
__default_format = WorkingTreeFormat4()
2827
WorkingTreeFormat.register_format(__default_format)
2828
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2829
WorkingTreeFormat.set_default_format(__default_format)
2830
# formats which have no format string are not discoverable
2831
# and not independently creatable, so are not registered.
2832
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
