1
# Copyright (C) 2005, 2006 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(), """
46
from copy import deepcopy
56
conflicts as _mod_conflicts,
68
from bzrlib.transport import get_transport
72
from bzrlib import symbol_versioning
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
from bzrlib.errors import (BzrCheckError,
77
WeaveRevisionNotPresent,
81
MergeModifiedFormatError,
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
85
from bzrlib.lockable_files import LockableFiles, TransportLock
86
from bzrlib.lockdir import LockDir
87
import bzrlib.mutabletree
88
from bzrlib.mutabletree import needs_tree_write_lock
89
from bzrlib.osutils import (
101
from bzrlib.trace import mutter, note
102
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION
106
import bzrlib.revisiontree
107
from bzrlib.rio import RioReader, rio_file, Stanza
108
from bzrlib.symbol_versioning import (deprecated_passed,
111
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
# the regex removes any weird characters; we don't escape them
121
# but rather just pull them out
122
_gen_file_id_re = re.compile(r'[^\w.]')
123
_gen_id_suffix = None
127
def _next_id_suffix():
128
"""Create a new file id suffix that is reasonably unique.
130
On the first call we combine the current time with 64 bits of randomness
131
to give a highly probably globally unique number. Then each call in the same
132
process adds 1 to a serial number we append to that unique value.
134
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
135
# than having to move the id randomness out of the inner loop like this.
136
# XXX TODO: for the global randomness this uses we should add the thread-id
137
# before the serial #.
138
global _gen_id_suffix, _gen_id_serial
139
if _gen_id_suffix is None:
140
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
142
return _gen_id_suffix + str(_gen_id_serial)
145
def gen_file_id(name):
146
"""Return new file id for the basename 'name'.
148
The uniqueness is supplied from _next_id_suffix.
150
# The real randomness is in the _next_id_suffix, the
151
# rest of the identifier is just to be nice.
153
# 1) Remove non-ascii word characters to keep the ids portable
154
# 2) squash to lowercase, so the file id doesn't have to
155
# be escaped (case insensitive filesystems would bork for ids
156
# that only differred in case without escaping).
157
# 3) truncate the filename to 20 chars. Long filenames also bork on some
159
# 4) Removing starting '.' characters to prevent the file ids from
160
# being considered hidden.
161
ascii_word_only = _gen_file_id_re.sub('', name.lower())
162
short_no_dots = ascii_word_only.lstrip('.')[:20]
163
return short_no_dots + _next_id_suffix()
167
"""Return a new tree-root file id."""
168
return gen_file_id('tree_root')
171
class TreeEntry(object):
172
"""An entry that implements the minimum interface used by commands.
174
This needs further inspection, it may be better to have
175
InventoryEntries without ids - though that seems wrong. For now,
176
this is a parallel hierarchy to InventoryEntry, and needs to become
177
one of several things: decorates to that hierarchy, children of, or
179
Another note is that these objects are currently only used when there is
180
no InventoryEntry available - i.e. for unversioned objects.
181
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
184
def __eq__(self, other):
185
# yes, this us ugly, TODO: best practice __eq__ style.
186
return (isinstance(other, TreeEntry)
187
and other.__class__ == self.__class__)
189
def kind_character(self):
193
class TreeDirectory(TreeEntry):
194
"""See TreeEntry. This is a directory in a working tree."""
196
def __eq__(self, other):
197
return (isinstance(other, TreeDirectory)
198
and other.__class__ == self.__class__)
200
def kind_character(self):
204
class TreeFile(TreeEntry):
205
"""See TreeEntry. This is a regular file in a working tree."""
207
def __eq__(self, other):
208
return (isinstance(other, TreeFile)
209
and other.__class__ == self.__class__)
211
def kind_character(self):
215
class TreeLink(TreeEntry):
216
"""See TreeEntry. This is a symlink in a working tree."""
218
def __eq__(self, other):
219
return (isinstance(other, TreeLink)
220
and other.__class__ == self.__class__)
222
def kind_character(self):
226
class WorkingTree(bzrlib.mutabletree.MutableTree):
227
"""Working copy tree.
229
The inventory is held in the `Branch` working-inventory, and the
230
files are in a directory on disk.
232
It is possible for a `WorkingTree` to have a filename which is
233
not listed in the Inventory and vice versa.
236
def __init__(self, basedir='.',
237
branch=DEPRECATED_PARAMETER,
243
"""Construct a WorkingTree for basedir.
245
If the branch is not supplied, it is opened automatically.
246
If the branch is supplied, it must be the branch for this basedir.
247
(branch.base is not cross checked, because for remote branches that
248
would be meaningless).
250
self._format = _format
251
self.bzrdir = _bzrdir
253
# not created via open etc.
254
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
255
"Please use bzrdir.open_workingtree or WorkingTree.open().",
258
wt = WorkingTree.open(basedir)
259
self._branch = wt.branch
260
self.basedir = wt.basedir
261
self._control_files = wt._control_files
262
self._hashcache = wt._hashcache
263
self._set_inventory(wt._inventory, dirty=False)
264
self._format = wt._format
265
self.bzrdir = wt.bzrdir
266
from bzrlib.hashcache import HashCache
267
from bzrlib.trace import note, mutter
268
assert isinstance(basedir, basestring), \
269
"base directory %r is not a string" % basedir
270
basedir = safe_unicode(basedir)
271
mutter("opening working tree %r", basedir)
272
if deprecated_passed(branch):
274
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
275
" Please use bzrdir.open_workingtree() or"
276
" WorkingTree.open().",
280
self._branch = branch
282
self._branch = self.bzrdir.open_branch()
283
self.basedir = realpath(basedir)
284
# if branch is at our basedir and is a format 6 or less
285
if isinstance(self._format, WorkingTreeFormat2):
286
# share control object
287
self._control_files = self.branch.control_files
289
# assume all other formats have their own control files.
290
assert isinstance(_control_files, LockableFiles), \
291
"_control_files must be a LockableFiles, not %r" \
293
self._control_files = _control_files
294
# update the whole cache up front and write to disk if anything changed;
295
# in the future we might want to do this more selectively
296
# two possible ways offer themselves : in self._unlock, write the cache
297
# if needed, or, when the cache sees a change, append it to the hash
298
# cache file, and have the parser take the most recent entry for a
300
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
301
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
303
# is this scan needed ? it makes things kinda slow.
310
if _inventory is None:
311
self._inventory_is_modified = False
312
self.read_working_inventory()
314
# the caller of __init__ has provided an inventory,
315
# we assume they know what they are doing - as its only
316
# the Format factory and creation methods that are
317
# permitted to do this.
318
self._set_inventory(_inventory, dirty=False)
321
fget=lambda self: self._branch,
322
doc="""The branch this WorkingTree is connected to.
324
This cannot be set - it is reflective of the actual disk structure
325
the working tree has been constructed from.
328
def break_lock(self):
329
"""Break a lock if one is present from another instance.
331
Uses the ui factory to ask for confirmation if the lock may be from
334
This will probe the repository for its lock as well.
336
self._control_files.break_lock()
337
self.branch.break_lock()
339
def _set_inventory(self, inv, dirty):
340
"""Set the internal cached inventory.
342
:param inv: The inventory to set.
343
:param dirty: A boolean indicating whether the inventory is the same
344
logical inventory as whats on disk. If True the inventory is not
345
the same and should be written to disk or data will be lost, if
346
False then the inventory is the same as that on disk and any
347
serialisation would be unneeded overhead.
349
assert inv.root is not None
350
self._inventory = inv
351
self._inventory_is_modified = dirty
354
def open(path=None, _unsupported=False):
355
"""Open an existing working tree at path.
359
path = os.path.getcwdu()
360
control = bzrdir.BzrDir.open(path, _unsupported)
361
return control.open_workingtree(_unsupported)
364
def open_containing(path=None):
365
"""Open an existing working tree which has its root about path.
367
This probes for a working tree at path and searches upwards from there.
369
Basically we keep looking up until we find the control directory or
370
run into /. If there isn't one, raises NotBranchError.
371
TODO: give this a new exception.
372
If there is one, it is returned, along with the unused portion of path.
374
:return: The WorkingTree that contains 'path', and the rest of path
377
path = osutils.getcwd()
378
control, relpath = bzrdir.BzrDir.open_containing(path)
380
return control.open_workingtree(), relpath
383
def open_downlevel(path=None):
384
"""Open an unsupported working tree.
386
Only intended for advanced situations like upgrading part of a bzrdir.
388
return WorkingTree.open(path, _unsupported=True)
391
"""Iterate through file_ids for this tree.
393
file_ids are in a WorkingTree if they are in the working inventory
394
and the working file exists.
396
inv = self._inventory
397
for path, ie in inv.iter_entries():
398
if osutils.lexists(self.abspath(path)):
402
return "<%s of %s>" % (self.__class__.__name__,
403
getattr(self, 'basedir', None))
405
def abspath(self, filename):
406
return pathjoin(self.basedir, filename)
408
def basis_tree(self):
409
"""Return RevisionTree for the current last revision.
411
If the left most parent is a ghost then the returned tree will be an
412
empty tree - one obtained by calling repository.revision_tree(None).
415
revision_id = self.get_parent_ids()[0]
417
# no parents, return an empty revision tree.
418
# in the future this should return the tree for
419
# 'empty:' - the implicit root empty tree.
420
return self.branch.repository.revision_tree(None)
423
xml = self.read_basis_inventory()
424
inv = xml6.serializer_v6.read_inventory_from_string(xml)
425
if inv is not None and inv.revision_id == revision_id:
426
return bzrlib.revisiontree.RevisionTree(
427
self.branch.repository, inv, revision_id)
428
except (NoSuchFile, errors.BadInventoryFormat):
430
# No cached copy available, retrieve from the repository.
431
# FIXME? RBC 20060403 should we cache the inventory locally
434
return self.branch.repository.revision_tree(revision_id)
435
except errors.RevisionNotPresent:
436
# the basis tree *may* be a ghost or a low level error may have
437
# occured. If the revision is present, its a problem, if its not
439
if self.branch.repository.has_revision(revision_id):
441
# the basis tree is a ghost so return an empty tree.
442
return self.branch.repository.revision_tree(None)
445
@deprecated_method(zero_eight)
446
def create(branch, directory):
447
"""Create a workingtree for branch at directory.
449
If existing_directory already exists it must have a .bzr directory.
450
If it does not exist, it will be created.
452
This returns a new WorkingTree object for the new checkout.
454
TODO FIXME RBC 20060124 when we have checkout formats in place this
455
should accept an optional revisionid to checkout [and reject this if
456
checking out into the same dir as a pre-checkout-aware branch format.]
458
XXX: When BzrDir is present, these should be created through that
461
warnings.warn('delete WorkingTree.create', stacklevel=3)
462
transport = get_transport(directory)
463
if branch.bzrdir.root_transport.base == transport.base:
465
return branch.bzrdir.create_workingtree()
466
# different directory,
467
# create a branch reference
468
# and now a working tree.
469
raise NotImplementedError
472
@deprecated_method(zero_eight)
473
def create_standalone(directory):
474
"""Create a checkout and a branch and a repo at directory.
476
Directory must exist and be empty.
478
please use BzrDir.create_standalone_workingtree
480
return bzrdir.BzrDir.create_standalone_workingtree(directory)
482
def relpath(self, path):
483
"""Return the local path portion from a given path.
485
The path may be absolute or relative. If its a relative path it is
486
interpreted relative to the python current working directory.
488
return osutils.relpath(self.basedir, path)
490
def has_filename(self, filename):
491
return osutils.lexists(self.abspath(filename))
493
def get_file(self, file_id):
494
return self.get_file_byname(self.id2path(file_id))
496
def get_file_text(self, file_id):
497
return self.get_file(file_id).read()
499
def get_file_byname(self, filename):
500
return file(self.abspath(filename), 'rb')
502
def get_parent_ids(self):
503
"""See Tree.get_parent_ids.
505
This implementation reads the pending merges list and last_revision
506
value and uses that to decide what the parents list should be.
508
last_rev = self._last_revision()
514
merges_file = self._control_files.get_utf8('pending-merges')
518
for l in merges_file.readlines():
519
parents.append(l.rstrip('\n'))
523
def get_root_id(self):
524
"""Return the id of this trees root"""
525
return self._inventory.root.file_id
527
def _get_store_filename(self, file_id):
528
## XXX: badly named; this is not in the store at all
529
return self.abspath(self.id2path(file_id))
532
def clone(self, to_bzrdir, revision_id=None, basis=None):
533
"""Duplicate this working tree into to_bzr, including all state.
535
Specifically modified files are kept as modified, but
536
ignored and unknown files are discarded.
538
If you want to make a new line of development, see bzrdir.sprout()
541
If not None, the cloned tree will have its last revision set to
542
revision, and and difference between the source trees last revision
543
and this one merged in.
546
If not None, a closer copy of a tree which may have some files in
547
common, and which file content should be preferentially copied from.
549
# assumes the target bzr dir format is compatible.
550
result = self._format.initialize(to_bzrdir)
551
self.copy_content_into(result, revision_id)
555
def copy_content_into(self, tree, revision_id=None):
556
"""Copy the current content and user files of this tree into tree."""
557
tree.set_root_id(self.get_root_id())
558
if revision_id is None:
559
merge.transform_tree(tree, self)
561
# TODO now merge from tree.last_revision to revision (to preserve
562
# user local changes)
563
merge.transform_tree(tree, self)
564
tree.set_parent_ids([revision_id])
566
def id2abspath(self, file_id):
567
return self.abspath(self.id2path(file_id))
569
def has_id(self, file_id):
570
# files that have been deleted are excluded
571
inv = self._inventory
572
if not inv.has_id(file_id):
574
path = inv.id2path(file_id)
575
return osutils.lexists(self.abspath(path))
577
def has_or_had_id(self, file_id):
578
if file_id == self.inventory.root.file_id:
580
return self.inventory.has_id(file_id)
582
__contains__ = has_id
584
def get_file_size(self, file_id):
585
return os.path.getsize(self.id2abspath(file_id))
588
def get_file_sha1(self, file_id, path=None):
590
path = self._inventory.id2path(file_id)
591
return self._hashcache.get_sha1(path)
593
def get_file_mtime(self, file_id, path=None):
595
path = self._inventory.id2path(file_id)
596
return os.lstat(self.abspath(path)).st_mtime
598
if not supports_executable():
599
def is_executable(self, file_id, path=None):
600
return self._inventory[file_id].executable
602
def is_executable(self, file_id, path=None):
604
path = self._inventory.id2path(file_id)
605
mode = os.lstat(self.abspath(path)).st_mode
606
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
609
def _add(self, files, ids, kinds):
610
"""See MutableTree._add."""
611
# TODO: Re-adding a file that is removed in the working copy
612
# should probably put it back with the previous ID.
613
# the read and write working inventory should not occur in this
614
# function - they should be part of lock_write and unlock.
615
inv = self.read_working_inventory()
616
for f, file_id, kind in zip(files, ids, kinds):
617
assert kind is not None
619
inv.add_path(f, kind=kind)
621
inv.add_path(f, kind=kind, file_id=file_id)
622
self._write_inventory(inv)
624
@needs_tree_write_lock
625
def _gather_kinds(self, files, kinds):
626
"""See MutableTree._gather_kinds."""
627
for pos, f in enumerate(files):
628
if kinds[pos] is None:
629
fullpath = normpath(self.abspath(f))
631
kinds[pos] = file_kind(fullpath)
633
if e.errno == errno.ENOENT:
634
raise NoSuchFile(fullpath)
637
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
638
"""Add revision_id as a parent.
640
This is equivalent to retrieving the current list of parent ids
641
and setting the list to its value plus revision_id.
643
:param revision_id: The revision id to add to the parent list. It may
644
be a ghost revision as long as its not the first parent to be added,
645
or the allow_leftmost_as_ghost parameter is set True.
646
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
648
parents = self.get_parent_ids() + [revision_id]
649
self.set_parent_ids(parents,
650
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
652
@needs_tree_write_lock
653
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
654
"""Add revision_id, tree tuple as a parent.
656
This is equivalent to retrieving the current list of parent trees
657
and setting the list to its value plus parent_tuple. See also
658
add_parent_tree_id - if you only have a parent id available it will be
659
simpler to use that api. If you have the parent already available, using
660
this api is preferred.
662
:param parent_tuple: The (revision id, tree) to add to the parent list.
663
If the revision_id is a ghost, pass None for the tree.
664
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
666
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
667
if len(parent_ids) > 1:
668
# the leftmost may have already been a ghost, preserve that if it
670
allow_leftmost_as_ghost = True
671
self.set_parent_ids(parent_ids,
672
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
674
@needs_tree_write_lock
675
def add_pending_merge(self, *revision_ids):
676
# TODO: Perhaps should check at this point that the
677
# history of the revision is actually present?
678
parents = self.get_parent_ids()
680
for rev_id in revision_ids:
681
if rev_id in parents:
683
parents.append(rev_id)
686
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
688
@deprecated_method(zero_eleven)
690
def pending_merges(self):
691
"""Return a list of pending merges.
693
These are revisions that have been merged into the working
694
directory but not yet committed.
696
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
697
instead - which is available on all tree objects.
699
return self.get_parent_ids()[1:]
701
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
702
"""Common ghost checking functionality from set_parent_*.
704
This checks that the left hand-parent exists if there are any
707
if len(revision_ids) > 0:
708
leftmost_id = revision_ids[0]
709
if (not allow_leftmost_as_ghost and not
710
self.branch.repository.has_revision(leftmost_id)):
711
raise errors.GhostRevisionUnusableHere(leftmost_id)
713
def _set_merges_from_parent_ids(self, parent_ids):
714
merges = parent_ids[1:]
715
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
717
@needs_tree_write_lock
718
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
719
"""Set the parent ids to revision_ids.
721
See also set_parent_trees. This api will try to retrieve the tree data
722
for each element of revision_ids from the trees repository. If you have
723
tree data already available, it is more efficient to use
724
set_parent_trees rather than set_parent_ids. set_parent_ids is however
725
an easier API to use.
727
:param revision_ids: The revision_ids to set as the parent ids of this
728
working tree. Any of these may be ghosts.
730
self._check_parents_for_ghosts(revision_ids,
731
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
733
if len(revision_ids) > 0:
734
self.set_last_revision(revision_ids[0])
736
self.set_last_revision(None)
738
self._set_merges_from_parent_ids(revision_ids)
740
@needs_tree_write_lock
741
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
742
"""See MutableTree.set_parent_trees."""
743
parent_ids = [rev for (rev, tree) in parents_list]
745
self._check_parents_for_ghosts(parent_ids,
746
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
748
if len(parent_ids) == 0:
749
leftmost_parent_id = None
750
leftmost_parent_tree = None
752
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
754
if self._change_last_revision(leftmost_parent_id):
755
if leftmost_parent_tree is None:
756
# If we don't have a tree, fall back to reading the
757
# parent tree from the repository.
758
self._cache_basis_inventory(leftmost_parent_id)
760
inv = leftmost_parent_tree.inventory
761
xml = self._create_basis_xml_from_inventory(
762
leftmost_parent_id, inv)
763
self._write_basis_inventory(xml)
764
self._set_merges_from_parent_ids(parent_ids)
766
@needs_tree_write_lock
767
def set_pending_merges(self, rev_list):
768
parents = self.get_parent_ids()
769
leftmost = parents[:1]
770
new_parents = leftmost + rev_list
771
self.set_parent_ids(new_parents)
773
@needs_tree_write_lock
774
def set_merge_modified(self, modified_hashes):
776
for file_id, hash in modified_hashes.iteritems():
777
yield Stanza(file_id=file_id, hash=hash)
778
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
780
@needs_tree_write_lock
781
def _put_rio(self, filename, stanzas, header):
782
my_file = rio_file(stanzas, header)
783
self._control_files.put(filename, my_file)
785
@needs_write_lock # because merge pulls data into the branch.
786
def merge_from_branch(self, branch, to_revision=None):
787
"""Merge from a branch into this working tree.
789
:param branch: The branch to merge from.
790
:param to_revision: If non-None, the merge will merge to to_revision, but
791
not beyond it. to_revision does not need to be in the history of
792
the branch when it is supplied. If None, to_revision defaults to
793
branch.last_revision().
795
from bzrlib.merge import Merger, Merge3Merger
796
pb = bzrlib.ui.ui_factory.nested_progress_bar()
798
merger = Merger(self.branch, this_tree=self, pb=pb)
799
merger.pp = ProgressPhase("Merge phase", 5, pb)
800
merger.pp.next_phase()
801
# check that there are no
803
merger.check_basis(check_clean=True, require_commits=False)
804
if to_revision is None:
805
to_revision = branch.last_revision()
806
merger.other_rev_id = to_revision
807
if merger.other_rev_id is None:
808
raise error.NoCommits(branch)
809
self.branch.fetch(branch, last_revision=merger.other_rev_id)
810
merger.other_basis = merger.other_rev_id
811
merger.other_tree = self.branch.repository.revision_tree(
813
merger.pp.next_phase()
815
if merger.base_rev_id == merger.other_rev_id:
816
raise errors.PointlessMerge
817
merger.backup_files = False
818
merger.merge_type = Merge3Merger
819
merger.set_interesting_files(None)
820
merger.show_base = False
821
merger.reprocess = False
822
conflicts = merger.do_merge()
829
def merge_modified(self):
831
hashfile = self._control_files.get('merge-hashes')
836
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
837
raise MergeModifiedFormatError()
838
except StopIteration:
839
raise MergeModifiedFormatError()
840
for s in RioReader(hashfile):
841
file_id = s.get("file_id")
842
if file_id not in self.inventory:
845
if hash == self.get_file_sha1(file_id):
846
merge_hashes[file_id] = hash
850
def mkdir(self, path, file_id=None):
851
"""See MutableTree.mkdir()."""
853
file_id = gen_file_id(os.path.basename(path))
854
os.mkdir(self.abspath(path))
855
self.add(path, file_id, 'directory')
858
def get_symlink_target(self, file_id):
859
return os.readlink(self.id2abspath(file_id))
861
def file_class(self, filename):
862
if self.path2id(filename):
864
elif self.is_ignored(filename):
870
"""Write the in memory inventory to disk."""
871
# TODO: Maybe this should only write on dirty ?
872
if self._control_files._lock_mode != 'w':
873
raise errors.NotWriteLocked(self)
875
xml5.serializer_v5.write_inventory(self._inventory, sio)
877
self._control_files.put('inventory', sio)
878
self._inventory_is_modified = False
880
def list_files(self, include_root=False):
881
"""Recursively list all files as (path, class, kind, id, entry).
883
Lists, but does not descend into unversioned directories.
885
This does not include files that have been deleted in this
888
Skips the control directory.
890
inv = self._inventory
891
if include_root is True:
892
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
893
# Convert these into local objects to save lookup times
894
pathjoin = osutils.pathjoin
895
file_kind = osutils.file_kind
897
# transport.base ends in a slash, we want the piece
898
# between the last two slashes
899
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
901
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
903
# directory file_id, relative path, absolute path, reverse sorted children
904
children = os.listdir(self.basedir)
906
# jam 20060527 The kernel sized tree seems equivalent whether we
907
# use a deque and popleft to keep them sorted, or if we use a plain
908
# list and just reverse() them.
909
children = collections.deque(children)
910
stack = [(inv.root.file_id, u'', self.basedir, children)]
912
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
915
f = children.popleft()
916
## TODO: If we find a subdirectory with its own .bzr
917
## directory, then that is a separate tree and we
918
## should exclude it.
920
# the bzrdir for this tree
921
if transport_base_dir == f:
924
# we know that from_dir_relpath and from_dir_abspath never end in a slash
925
# and 'f' doesn't begin with one, we can do a string op, rather
926
# than the checks of pathjoin(), all relative paths will have an extra slash
928
fp = from_dir_relpath + '/' + f
931
fap = from_dir_abspath + '/' + f
933
f_ie = inv.get_child(from_dir_id, f)
936
elif self.is_ignored(fp[1:]):
939
# we may not have found this file, because of a unicode issue
940
f_norm, can_access = osutils.normalized_filename(f)
941
if f == f_norm or not can_access:
942
# No change, so treat this file normally
945
# this file can be accessed by a normalized path
946
# check again if it is versioned
947
# these lines are repeated here for performance
949
fp = from_dir_relpath + '/' + f
950
fap = from_dir_abspath + '/' + f
951
f_ie = inv.get_child(from_dir_id, f)
954
elif self.is_ignored(fp[1:]):
963
raise BzrCheckError("file %r entered as kind %r id %r, "
965
% (fap, f_ie.kind, f_ie.file_id, fk))
967
# make a last minute entry
969
yield fp[1:], c, fk, f_ie.file_id, f_ie
972
yield fp[1:], c, fk, None, fk_entries[fk]()
974
yield fp[1:], c, fk, None, TreeEntry()
977
if fk != 'directory':
980
# But do this child first
981
new_children = os.listdir(fap)
983
new_children = collections.deque(new_children)
984
stack.append((f_ie.file_id, fp, fap, new_children))
985
# Break out of inner loop, so that we start outer loop with child
988
# if we finished all children, pop it off the stack
991
@needs_tree_write_lock
992
def move(self, from_paths, to_name):
995
to_name must exist in the inventory.
997
If to_name exists and is a directory, the files are moved into
998
it, keeping their old names.
1000
Note that to_name is only the last component of the new name;
1001
this doesn't change the directory.
1003
This returns a list of (from_path, to_path) pairs for each
1004
entry that is moved.
1007
## TODO: Option to move IDs only
1008
assert not isinstance(from_paths, basestring)
1009
inv = self.inventory
1010
to_abs = self.abspath(to_name)
1011
if not isdir(to_abs):
1012
raise BzrError("destination %r is not a directory" % to_abs)
1013
if not self.has_filename(to_name):
1014
raise BzrError("destination %r not in working directory" % to_abs)
1015
to_dir_id = inv.path2id(to_name)
1016
if to_dir_id is None and to_name != '':
1017
raise BzrError("destination %r is not a versioned directory" % to_name)
1018
to_dir_ie = inv[to_dir_id]
1019
if to_dir_ie.kind != 'directory':
1020
raise BzrError("destination %r is not a directory" % to_abs)
1022
to_idpath = inv.get_idpath(to_dir_id)
1024
for f in from_paths:
1025
if not self.has_filename(f):
1026
raise BzrError("%r does not exist in working tree" % f)
1027
f_id = inv.path2id(f)
1029
raise BzrError("%r is not versioned" % f)
1030
name_tail = splitpath(f)[-1]
1031
dest_path = pathjoin(to_name, name_tail)
1032
if self.has_filename(dest_path):
1033
raise BzrError("destination %r already exists" % dest_path)
1034
if f_id in to_idpath:
1035
raise BzrError("can't move %r to a subdirectory of itself" % f)
1037
# OK, so there's a race here, it's possible that someone will
1038
# create a file in this interval and then the rename might be
1039
# left half-done. But we should have caught most problems.
1040
orig_inv = deepcopy(self.inventory)
1041
original_modified = self._inventory_is_modified
1044
self._inventory_is_modified = True
1045
for f in from_paths:
1046
name_tail = splitpath(f)[-1]
1047
dest_path = pathjoin(to_name, name_tail)
1048
result.append((f, dest_path))
1049
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1051
osutils.rename(self.abspath(f), self.abspath(dest_path))
1053
raise BzrError("failed to rename %r to %r: %s" %
1054
(f, dest_path, e[1]))
1056
# restore the inventory on error
1057
self._set_inventory(orig_inv, dirty=original_modified)
1059
self._write_inventory(inv)
1062
@needs_tree_write_lock
1063
def rename_one(self, from_rel, to_rel):
1066
This can change the directory or the filename or both.
1068
inv = self.inventory
1069
if not self.has_filename(from_rel):
1070
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1071
if self.has_filename(to_rel):
1072
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1074
file_id = inv.path2id(from_rel)
1076
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1078
entry = inv[file_id]
1079
from_parent = entry.parent_id
1080
from_name = entry.name
1082
if inv.path2id(to_rel):
1083
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1085
to_dir, to_tail = os.path.split(to_rel)
1086
to_dir_id = inv.path2id(to_dir)
1087
if to_dir_id is None and to_dir != '':
1088
raise BzrError("can't determine destination directory id for %r" % to_dir)
1090
mutter("rename_one:")
1091
mutter(" file_id {%s}" % file_id)
1092
mutter(" from_rel %r" % from_rel)
1093
mutter(" to_rel %r" % to_rel)
1094
mutter(" to_dir %r" % to_dir)
1095
mutter(" to_dir_id {%s}" % to_dir_id)
1097
inv.rename(file_id, to_dir_id, to_tail)
1099
from_abs = self.abspath(from_rel)
1100
to_abs = self.abspath(to_rel)
1102
osutils.rename(from_abs, to_abs)
1104
inv.rename(file_id, from_parent, from_name)
1105
raise BzrError("failed to rename %r to %r: %s"
1106
% (from_abs, to_abs, e[1]))
1107
self._write_inventory(inv)
1111
"""Return all unknown files.
1113
These are files in the working directory that are not versioned or
1114
control files or ignored.
1116
for subp in self.extras():
1117
if not self.is_ignored(subp):
1120
@needs_tree_write_lock
1121
def unversion(self, file_ids):
1122
"""Remove the file ids in file_ids from the current versioned set.
1124
When a file_id is unversioned, all of its children are automatically
1127
:param file_ids: The file ids to stop versioning.
1128
:raises: NoSuchId if any fileid is not currently versioned.
1130
for file_id in file_ids:
1131
if self._inventory.has_id(file_id):
1132
self._inventory.remove_recursive_id(file_id)
1134
raise errors.NoSuchId(self, file_id)
1136
# in the future this should just set a dirty bit to wait for the
1137
# final unlock. However, until all methods of workingtree start
1138
# with the current in -memory inventory rather than triggering
1139
# a read, it is more complex - we need to teach read_inventory
1140
# to know when to read, and when to not read first... and possibly
1141
# to save first when the in memory one may be corrupted.
1142
# so for now, we just only write it if it is indeed dirty.
1144
self._write_inventory(self._inventory)
1146
@deprecated_method(zero_eight)
1147
def iter_conflicts(self):
1148
"""List all files in the tree that have text or content conflicts.
1149
DEPRECATED. Use conflicts instead."""
1150
return self._iter_conflicts()
1152
def _iter_conflicts(self):
1154
for info in self.list_files():
1156
stem = get_conflicted_stem(path)
1159
if stem not in conflicted:
1160
conflicted.add(stem)
1164
def pull(self, source, overwrite=False, stop_revision=None):
1165
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1168
pp = ProgressPhase("Pull phase", 2, top_pb)
1170
old_revision_history = self.branch.revision_history()
1171
basis_tree = self.basis_tree()
1172
count = self.branch.pull(source, overwrite, stop_revision)
1173
new_revision_history = self.branch.revision_history()
1174
if new_revision_history != old_revision_history:
1176
if len(old_revision_history):
1177
other_revision = old_revision_history[-1]
1179
other_revision = None
1180
repository = self.branch.repository
1181
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1183
new_basis_tree = self.branch.basis_tree()
1190
if (basis_tree.inventory.root is None and
1191
new_basis_tree.inventory.root is not None):
1192
self.set_root_id(new_basis_tree.inventory.root.file_id)
1195
# TODO - dedup parents list with things merged by pull ?
1196
# reuse the revisiontree we merged against to set the new
1198
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1199
# we have to pull the merge trees out again, because
1200
# merge_inner has set the ids. - this corner is not yet
1201
# layered well enough to prevent double handling.
1202
merges = self.get_parent_ids()[1:]
1203
parent_trees.extend([
1204
(parent, repository.revision_tree(parent)) for
1206
self.set_parent_trees(parent_trees)
1213
def put_file_bytes_non_atomic(self, file_id, bytes):
1214
"""See MutableTree.put_file_bytes_non_atomic."""
1215
stream = file(self.id2abspath(file_id), 'wb')
1220
# TODO: update the hashcache here ?
1223
"""Yield all unknown files in this WorkingTree.
1225
If there are any unknown directories then only the directory is
1226
returned, not all its children. But if there are unknown files
1227
under a versioned subdirectory, they are returned.
1229
Currently returned depth-first, sorted by name within directories.
1231
## TODO: Work from given directory downwards
1232
for path, dir_entry in self.inventory.directories():
1233
# mutter("search for unknowns in %r", path)
1234
dirabs = self.abspath(path)
1235
if not isdir(dirabs):
1236
# e.g. directory deleted
1240
for subf in os.listdir(dirabs):
1243
if subf not in dir_entry.children:
1244
subf_norm, can_access = osutils.normalized_filename(subf)
1245
if subf_norm != subf and can_access:
1246
if subf_norm not in dir_entry.children:
1247
fl.append(subf_norm)
1253
subp = pathjoin(path, subf)
1256
def _translate_ignore_rule(self, rule):
1257
"""Translate a single ignore rule to a regex.
1259
There are two types of ignore rules. Those that do not contain a / are
1260
matched against the tail of the filename (that is, they do not care
1261
what directory the file is in.) Rules which do contain a slash must
1262
match the entire path. As a special case, './' at the start of the
1263
string counts as a slash in the string but is removed before matching
1264
(e.g. ./foo.c, ./src/foo.c)
1266
:return: The translated regex.
1268
if rule[:2] in ('./', '.\\'):
1270
result = fnmatch.translate(rule[2:])
1271
elif '/' in rule or '\\' in rule:
1273
result = fnmatch.translate(rule)
1275
# default rule style.
1276
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1277
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1278
return "(" + result + ")"
1280
def _combine_ignore_rules(self, rules):
1281
"""Combine a list of ignore rules into a single regex object.
1283
Each individual rule is combined with | to form a big regex, which then
1284
has $ added to it to form something like ()|()|()$. The group index for
1285
each subregex's outermost group is placed in a dictionary mapping back
1286
to the rule. This allows quick identification of the matching rule that
1288
:return: a list of the compiled regex and the matching-group index
1289
dictionaries. We return a list because python complains if you try to
1290
combine more than 100 regexes.
1295
translated_rules = []
1297
translated_rule = self._translate_ignore_rule(rule)
1298
compiled_rule = re.compile(translated_rule)
1299
groups[next_group] = rule
1300
next_group += compiled_rule.groups
1301
translated_rules.append(translated_rule)
1302
if next_group == 99:
1303
result.append((re.compile("|".join(translated_rules)), groups))
1306
translated_rules = []
1307
if len(translated_rules):
1308
result.append((re.compile("|".join(translated_rules)), groups))
1311
def ignored_files(self):
1312
"""Yield list of PATH, IGNORE_PATTERN"""
1313
for subp in self.extras():
1314
pat = self.is_ignored(subp)
1318
def get_ignore_list(self):
1319
"""Return list of ignore patterns.
1321
Cached in the Tree object after the first call.
1323
ignoreset = getattr(self, '_ignoreset', None)
1324
if ignoreset is not None:
1327
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1328
ignore_globs.update(ignores.get_runtime_ignores())
1330
ignore_globs.update(ignores.get_user_ignores())
1332
if self.has_filename(bzrlib.IGNORE_FILENAME):
1333
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1335
ignore_globs.update(ignores.parse_ignore_file(f))
1339
self._ignoreset = ignore_globs
1340
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1343
def _get_ignore_rules_as_regex(self):
1344
"""Return a regex of the ignore rules and a mapping dict.
1346
:return: (ignore rules compiled regex, dictionary mapping rule group
1347
indices to original rule.)
1349
if getattr(self, '_ignoreset', None) is None:
1350
self.get_ignore_list()
1351
return self._ignore_regex
1353
def is_ignored(self, filename):
1354
r"""Check whether the filename matches an ignore pattern.
1356
Patterns containing '/' or '\' need to match the whole path;
1357
others match against only the last component.
1359
If the file is ignored, returns the pattern which caused it to
1360
be ignored, otherwise None. So this can simply be used as a
1361
boolean if desired."""
1363
# TODO: Use '**' to match directories, and other extended
1364
# globbing stuff from cvs/rsync.
1366
# XXX: fnmatch is actually not quite what we want: it's only
1367
# approximately the same as real Unix fnmatch, and doesn't
1368
# treat dotfiles correctly and allows * to match /.
1369
# Eventually it should be replaced with something more
1372
rules = self._get_ignore_rules_as_regex()
1373
for regex, mapping in rules:
1374
match = regex.match(filename)
1375
if match is not None:
1376
# one or more of the groups in mapping will have a non-None
1378
groups = match.groups()
1379
rules = [mapping[group] for group in
1380
mapping if groups[group] is not None]
1384
def kind(self, file_id):
1385
return file_kind(self.id2abspath(file_id))
1387
def last_revision(self):
1388
"""Return the last revision of the branch for this tree.
1390
This format tree does not support a separate marker for last-revision
1391
compared to the branch.
1393
See MutableTree.last_revision
1395
return self._last_revision()
1398
def _last_revision(self):
1399
"""helper for get_parent_ids."""
1400
return self.branch.last_revision()
1402
def is_locked(self):
1403
return self._control_files.is_locked()
1405
def lock_read(self):
1406
"""See Branch.lock_read, and WorkingTree.unlock."""
1407
self.branch.lock_read()
1409
return self._control_files.lock_read()
1411
self.branch.unlock()
1414
def lock_tree_write(self):
1415
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1416
self.branch.lock_read()
1418
return self._control_files.lock_write()
1420
self.branch.unlock()
1423
def lock_write(self):
1424
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1425
self.branch.lock_write()
1427
return self._control_files.lock_write()
1429
self.branch.unlock()
1432
def get_physical_lock_status(self):
1433
return self._control_files.get_physical_lock_status()
1435
def _basis_inventory_name(self):
1436
return 'basis-inventory-cache'
1438
@needs_tree_write_lock
1439
def set_last_revision(self, new_revision):
1440
"""Change the last revision in the working tree."""
1441
if self._change_last_revision(new_revision):
1442
self._cache_basis_inventory(new_revision)
1444
def _change_last_revision(self, new_revision):
1445
"""Template method part of set_last_revision to perform the change.
1447
This is used to allow WorkingTree3 instances to not affect branch
1448
when their last revision is set.
1450
if new_revision is None:
1451
self.branch.set_revision_history([])
1454
self.branch.generate_revision_history(new_revision)
1455
except errors.NoSuchRevision:
1456
# not present in the repo - dont try to set it deeper than the tip
1457
self.branch.set_revision_history([new_revision])
1460
def _write_basis_inventory(self, xml):
1461
"""Write the basis inventory XML to the basis-inventory file"""
1462
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1463
path = self._basis_inventory_name()
1465
self._control_files.put(path, sio)
1467
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1468
"""Create the text that will be saved in basis-inventory"""
1469
inventory.revision_id = revision_id
1470
return xml6.serializer_v6.write_inventory_to_string(inventory)
1472
def _cache_basis_inventory(self, new_revision):
1473
"""Cache new_revision as the basis inventory."""
1474
# TODO: this should allow the ready-to-use inventory to be passed in,
1475
# as commit already has that ready-to-use [while the format is the
1478
# this double handles the inventory - unpack and repack -
1479
# but is easier to understand. We can/should put a conditional
1480
# in here based on whether the inventory is in the latest format
1481
# - perhaps we should repack all inventories on a repository
1483
# the fast path is to copy the raw xml from the repository. If the
1484
# xml contains 'revision_id="', then we assume the right
1485
# revision_id is set. We must check for this full string, because a
1486
# root node id can legitimately look like 'revision_id' but cannot
1488
xml = self.branch.repository.get_inventory_xml(new_revision)
1489
firstline = xml.split('\n', 1)[0]
1490
if (not 'revision_id="' in firstline or
1491
'format="6"' not in firstline):
1492
inv = self.branch.repository.deserialise_inventory(
1494
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1495
self._write_basis_inventory(xml)
1496
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1499
def read_basis_inventory(self):
1500
"""Read the cached basis inventory."""
1501
path = self._basis_inventory_name()
1502
return self._control_files.get(path).read()
1505
def read_working_inventory(self):
1506
"""Read the working inventory.
1508
:raises errors.InventoryModified: read_working_inventory will fail
1509
when the current in memory inventory has been modified.
1511
# conceptually this should be an implementation detail of the tree.
1512
# XXX: Deprecate this.
1513
# ElementTree does its own conversion from UTF-8, so open in
1515
if self._inventory_is_modified:
1516
raise errors.InventoryModified(self)
1517
result = xml5.serializer_v5.read_inventory(
1518
self._control_files.get('inventory'))
1519
self._set_inventory(result, dirty=False)
1522
@needs_tree_write_lock
1523
def remove(self, files, verbose=False, to_file=None):
1524
"""Remove nominated files from the working inventory..
1526
This does not remove their text. This does not run on XXX on what? RBC
1528
TODO: Refuse to remove modified files unless --force is given?
1530
TODO: Do something useful with directories.
1532
TODO: Should this remove the text or not? Tough call; not
1533
removing may be useful and the user can just use use rm, and
1534
is the opposite of add. Removing it is consistent with most
1535
other tools. Maybe an option.
1537
## TODO: Normalize names
1538
## TODO: Remove nested loops; better scalability
1539
if isinstance(files, basestring):
1542
inv = self.inventory
1544
# do this before any modifications
1546
fid = inv.path2id(f)
1548
# TODO: Perhaps make this just a warning, and continue?
1549
# This tends to happen when
1550
raise NotVersionedError(path=f)
1552
# having remove it, it must be either ignored or unknown
1553
if self.is_ignored(f):
1557
textui.show_status(new_status, inv[fid].kind, f,
1561
self._write_inventory(inv)
1563
@needs_tree_write_lock
1564
def revert(self, filenames, old_tree=None, backups=True,
1565
pb=DummyProgress()):
1566
from bzrlib.conflicts import resolve
1567
if old_tree is None:
1568
old_tree = self.basis_tree()
1569
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1570
if not len(filenames):
1571
self.set_parent_ids(self.get_parent_ids()[:1])
1574
resolve(self, filenames, ignore_misses=True)
1577
# XXX: This method should be deprecated in favour of taking in a proper
1578
# new Inventory object.
1579
@needs_tree_write_lock
1580
def set_inventory(self, new_inventory_list):
1581
from bzrlib.inventory import (Inventory,
1586
inv = Inventory(self.get_root_id())
1587
for path, file_id, parent, kind in new_inventory_list:
1588
name = os.path.basename(path)
1591
# fixme, there should be a factory function inv,add_??
1592
if kind == 'directory':
1593
inv.add(InventoryDirectory(file_id, name, parent))
1594
elif kind == 'file':
1595
inv.add(InventoryFile(file_id, name, parent))
1596
elif kind == 'symlink':
1597
inv.add(InventoryLink(file_id, name, parent))
1599
raise BzrError("unknown kind %r" % kind)
1600
self._write_inventory(inv)
1602
@needs_tree_write_lock
1603
def set_root_id(self, file_id):
1604
"""Set the root id for this tree."""
1607
symbol_versioning.warn(symbol_versioning.zero_twelve
1608
% 'WorkingTree.set_root_id with fileid=None',
1612
inv = self._inventory
1613
orig_root_id = inv.root.file_id
1614
# TODO: it might be nice to exit early if there was nothing
1615
# to do, saving us from trigger a sync on unlock.
1616
self._inventory_is_modified = True
1617
# we preserve the root inventory entry object, but
1618
# unlinkit from the byid index
1619
del inv._byid[inv.root.file_id]
1620
inv.root.file_id = file_id
1621
# and link it into the index with the new changed id.
1622
inv._byid[inv.root.file_id] = inv.root
1623
# and finally update all children to reference the new id.
1624
# XXX: this should be safe to just look at the root.children
1625
# list, not the WHOLE INVENTORY.
1628
if entry.parent_id == orig_root_id:
1629
entry.parent_id = inv.root.file_id
1632
"""See Branch.unlock.
1634
WorkingTree locking just uses the Branch locking facilities.
1635
This is current because all working trees have an embedded branch
1636
within them. IF in the future, we were to make branch data shareable
1637
between multiple working trees, i.e. via shared storage, then we
1638
would probably want to lock both the local tree, and the branch.
1640
raise NotImplementedError(self.unlock)
1643
"""Update a working tree along its branch.
1645
This will update the branch if its bound too, which means we have
1646
multiple trees involved:
1648
- The new basis tree of the master.
1649
- The old basis tree of the branch.
1650
- The old basis tree of the working tree.
1651
- The current working tree state.
1653
Pathologically, all three may be different, and non-ancestors of each
1654
other. Conceptually we want to:
1656
- Preserve the wt.basis->wt.state changes
1657
- Transform the wt.basis to the new master basis.
1658
- Apply a merge of the old branch basis to get any 'local' changes from
1660
- Restore the wt.basis->wt.state changes.
1662
There isn't a single operation at the moment to do that, so we:
1663
- Merge current state -> basis tree of the master w.r.t. the old tree
1665
- Do a 'normal' merge of the old branch basis if it is relevant.
1667
if self.branch.get_master_branch() is not None:
1669
update_branch = True
1671
self.lock_tree_write()
1672
update_branch = False
1675
old_tip = self.branch.update()
1678
return self._update_tree(old_tip)
1682
@needs_tree_write_lock
1683
def _update_tree(self, old_tip=None):
1684
"""Update a tree to the master branch.
1686
:param old_tip: if supplied, the previous tip revision the branch,
1687
before it was changed to the master branch's tip.
1689
# here if old_tip is not None, it is the old tip of the branch before
1690
# it was updated from the master branch. This should become a pending
1691
# merge in the working tree to preserve the user existing work. we
1692
# cant set that until we update the working trees last revision to be
1693
# one from the new branch, because it will just get absorbed by the
1694
# parent de-duplication logic.
1696
# We MUST save it even if an error occurs, because otherwise the users
1697
# local work is unreferenced and will appear to have been lost.
1701
last_rev = self.get_parent_ids()[0]
1704
if last_rev != self.branch.last_revision():
1705
# merge tree state up to new branch tip.
1706
basis = self.basis_tree()
1707
to_tree = self.branch.basis_tree()
1708
if basis.inventory.root is None:
1709
self.set_root_id(to_tree.inventory.root.file_id)
1710
result += merge.merge_inner(
1715
# TODO - dedup parents list with things merged by pull ?
1716
# reuse the tree we've updated to to set the basis:
1717
parent_trees = [(self.branch.last_revision(), to_tree)]
1718
merges = self.get_parent_ids()[1:]
1719
# Ideally we ask the tree for the trees here, that way the working
1720
# tree can decide whether to give us teh entire tree or give us a
1721
# lazy initialised tree. dirstate for instance will have the trees
1722
# in ram already, whereas a last-revision + basis-inventory tree
1723
# will not, but also does not need them when setting parents.
1724
for parent in merges:
1725
parent_trees.append(
1726
(parent, self.branch.repository.revision_tree(parent)))
1727
if old_tip is not None:
1728
parent_trees.append(
1729
(old_tip, self.branch.repository.revision_tree(old_tip)))
1730
self.set_parent_trees(parent_trees)
1731
last_rev = parent_trees[0][0]
1733
# the working tree had the same last-revision as the master
1734
# branch did. We may still have pivot local work from the local
1735
# branch into old_tip:
1736
if old_tip is not None:
1737
self.add_parent_tree_id(old_tip)
1738
if old_tip and old_tip != last_rev:
1739
# our last revision was not the prior branch last revision
1740
# and we have converted that last revision to a pending merge.
1741
# base is somewhere between the branch tip now
1742
# and the now pending merge
1743
from bzrlib.revision import common_ancestor
1745
base_rev_id = common_ancestor(self.branch.last_revision(),
1747
self.branch.repository)
1748
except errors.NoCommonAncestor:
1750
base_tree = self.branch.repository.revision_tree(base_rev_id)
1751
other_tree = self.branch.repository.revision_tree(old_tip)
1752
result += merge.merge_inner(
1759
@needs_tree_write_lock
1760
def _write_inventory(self, inv):
1761
"""Write inventory as the current inventory."""
1762
self._set_inventory(inv, dirty=True)
1765
def set_conflicts(self, arg):
1766
raise UnsupportedOperation(self.set_conflicts, self)
1768
def add_conflicts(self, arg):
1769
raise UnsupportedOperation(self.add_conflicts, self)
1772
def conflicts(self):
1773
conflicts = _mod_conflicts.ConflictList()
1774
for conflicted in self._iter_conflicts():
1777
if file_kind(self.abspath(conflicted)) != "file":
1779
except errors.NoSuchFile:
1782
for suffix in ('.THIS', '.OTHER'):
1784
kind = file_kind(self.abspath(conflicted+suffix))
1787
except errors.NoSuchFile:
1791
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1792
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1794
file_id=self.path2id(conflicted)))
1798
class WorkingTree2(WorkingTree):
1799
"""This is the Format 2 working tree.
1801
This was the first weave based working tree.
1802
- uses os locks for locking.
1803
- uses the branch last-revision.
1806
def lock_tree_write(self):
1807
"""See WorkingTree.lock_tree_write().
1809
In Format2 WorkingTrees we have a single lock for the branch and tree
1810
so lock_tree_write() degrades to lock_write().
1812
self.branch.lock_write()
1814
return self._control_files.lock_write()
1816
self.branch.unlock()
1820
# we share control files:
1821
if self._control_files._lock_count == 3:
1822
# _inventory_is_modified is always False during a read lock.
1823
if self._inventory_is_modified:
1825
if self._hashcache.needs_write:
1826
self._hashcache.write()
1827
# reverse order of locking.
1829
return self._control_files.unlock()
1831
self.branch.unlock()
1834
class WorkingTree3(WorkingTree):
1835
"""This is the Format 3 working tree.
1837
This differs from the base WorkingTree by:
1838
- having its own file lock
1839
- having its own last-revision property.
1841
This is new in bzr 0.8
1845
def _last_revision(self):
1846
"""See Mutable.last_revision."""
1848
return self._control_files.get_utf8('last-revision').read()
1852
def _change_last_revision(self, revision_id):
1853
"""See WorkingTree._change_last_revision."""
1854
if revision_id is None or revision_id == NULL_REVISION:
1856
self._control_files._transport.delete('last-revision')
1857
except errors.NoSuchFile:
1861
self._control_files.put_utf8('last-revision', revision_id)
1864
@needs_tree_write_lock
1865
def set_conflicts(self, conflicts):
1866
self._put_rio('conflicts', conflicts.to_stanzas(),
1869
@needs_tree_write_lock
1870
def add_conflicts(self, new_conflicts):
1871
conflict_set = set(self.conflicts())
1872
conflict_set.update(set(list(new_conflicts)))
1873
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1874
key=_mod_conflicts.Conflict.sort_key)))
1877
def conflicts(self):
1879
confile = self._control_files.get('conflicts')
1881
return _mod_conflicts.ConflictList()
1883
if confile.next() != CONFLICT_HEADER_1 + '\n':
1884
raise ConflictFormatError()
1885
except StopIteration:
1886
raise ConflictFormatError()
1887
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1890
if self._control_files._lock_count == 1:
1891
# _inventory_is_modified is always False during a read lock.
1892
if self._inventory_is_modified:
1894
if self._hashcache.needs_write:
1895
self._hashcache.write()
1896
# reverse order of locking.
1898
return self._control_files.unlock()
1900
self.branch.unlock()
1903
def get_conflicted_stem(path):
1904
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1905
if path.endswith(suffix):
1906
return path[:-len(suffix)]
1908
@deprecated_function(zero_eight)
1909
def is_control_file(filename):
1910
"""See WorkingTree.is_control_filename(filename)."""
1911
## FIXME: better check
1912
filename = normpath(filename)
1913
while filename != '':
1914
head, tail = os.path.split(filename)
1915
## mutter('check %r for control file' % ((head, tail),))
1918
if filename == head:
1924
class WorkingTreeFormat(object):
1925
"""An encapsulation of the initialization and open routines for a format.
1927
Formats provide three things:
1928
* An initialization routine,
1932
Formats are placed in an dict by their format string for reference
1933
during workingtree opening. Its not required that these be instances, they
1934
can be classes themselves with class methods - it simply depends on
1935
whether state is needed for a given format or not.
1937
Once a format is deprecated, just deprecate the initialize and open
1938
methods on the format class. Do not deprecate the object, as the
1939
object will be created every time regardless.
1942
_default_format = None
1943
"""The default format used for new trees."""
1946
"""The known formats."""
1949
def find_format(klass, a_bzrdir):
1950
"""Return the format for the working tree object in a_bzrdir."""
1952
transport = a_bzrdir.get_workingtree_transport(None)
1953
format_string = transport.get("format").read()
1954
return klass._formats[format_string]
1956
raise errors.NoWorkingTree(base=transport.base)
1958
raise errors.UnknownFormatError(format=format_string)
1961
def get_default_format(klass):
1962
"""Return the current default format."""
1963
return klass._default_format
1965
def get_format_string(self):
1966
"""Return the ASCII format string that identifies this format."""
1967
raise NotImplementedError(self.get_format_string)
1969
def get_format_description(self):
1970
"""Return the short description for this format."""
1971
raise NotImplementedError(self.get_format_description)
1973
def is_supported(self):
1974
"""Is this format supported?
1976
Supported formats can be initialized and opened.
1977
Unsupported formats may not support initialization or committing or
1978
some other features depending on the reason for not being supported.
1983
def register_format(klass, format):
1984
klass._formats[format.get_format_string()] = format
1987
def set_default_format(klass, format):
1988
klass._default_format = format
1991
def unregister_format(klass, format):
1992
assert klass._formats[format.get_format_string()] is format
1993
del klass._formats[format.get_format_string()]
1997
class WorkingTreeFormat2(WorkingTreeFormat):
1998
"""The second working tree format.
2000
This format modified the hash cache from the format 1 hash cache.
2003
def get_format_description(self):
2004
"""See WorkingTreeFormat.get_format_description()."""
2005
return "Working tree format 2"
2007
def stub_initialize_remote(self, control_files):
2008
"""As a special workaround create critical control files for a remote working tree
2010
This ensures that it can later be updated and dealt with locally,
2011
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2012
no working tree. (See bug #43064).
2016
xml5.serializer_v5.write_inventory(inv, sio)
2018
control_files.put('inventory', sio)
2020
control_files.put_utf8('pending-merges', '')
2023
def initialize(self, a_bzrdir, revision_id=None):
2024
"""See WorkingTreeFormat.initialize()."""
2025
if not isinstance(a_bzrdir.transport, LocalTransport):
2026
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2027
branch = a_bzrdir.open_branch()
2028
if revision_id is not None:
2031
revision_history = branch.revision_history()
2033
position = revision_history.index(revision_id)
2035
raise errors.NoSuchRevision(branch, revision_id)
2036
branch.set_revision_history(revision_history[:position + 1])
2039
revision = branch.last_revision()
2041
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2047
basis_tree = branch.repository.revision_tree(revision)
2048
if basis_tree.inventory.root is not None:
2049
wt.set_root_id(basis_tree.inventory.root.file_id)
2050
# set the parent list and cache the basis tree.
2051
wt.set_parent_trees([(revision, basis_tree)])
2052
transform.build_tree(basis_tree, wt)
2056
super(WorkingTreeFormat2, self).__init__()
2057
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2059
def open(self, a_bzrdir, _found=False):
2060
"""Return the WorkingTree object for a_bzrdir
2062
_found is a private parameter, do not use it. It is used to indicate
2063
if format probing has already been done.
2066
# we are being called directly and must probe.
2067
raise NotImplementedError
2068
if not isinstance(a_bzrdir.transport, LocalTransport):
2069
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2070
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2076
class WorkingTreeFormat3(WorkingTreeFormat):
2077
"""The second working tree format updated to record a format marker.
2080
- exists within a metadir controlling .bzr
2081
- includes an explicit version marker for the workingtree control
2082
files, separate from the BzrDir format
2083
- modifies the hash cache format
2085
- uses a LockDir to guard access for writes.
2088
def get_format_string(self):
2089
"""See WorkingTreeFormat.get_format_string()."""
2090
return "Bazaar-NG Working Tree format 3"
2092
def get_format_description(self):
2093
"""See WorkingTreeFormat.get_format_description()."""
2094
return "Working tree format 3"
2096
_lock_file_name = 'lock'
2097
_lock_class = LockDir
2099
def _open_control_files(self, a_bzrdir):
2100
transport = a_bzrdir.get_workingtree_transport(None)
2101
return LockableFiles(transport, self._lock_file_name,
2104
def initialize(self, a_bzrdir, revision_id=None):
2105
"""See WorkingTreeFormat.initialize().
2107
revision_id allows creating a working tree at a different
2108
revision than the branch is at.
2110
if not isinstance(a_bzrdir.transport, LocalTransport):
2111
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2112
transport = a_bzrdir.get_workingtree_transport(self)
2113
control_files = self._open_control_files(a_bzrdir)
2114
control_files.create_lock()
2115
control_files.lock_write()
2116
control_files.put_utf8('format', self.get_format_string())
2117
branch = a_bzrdir.open_branch()
2118
if revision_id is None:
2119
revision_id = branch.last_revision()
2120
# WorkingTree3 can handle an inventory which has a unique root id.
2121
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2122
# those trees. And because there isn't a format bump inbetween, we
2123
# are maintaining compatibility with older clients.
2124
# inv = Inventory(root_id=gen_root_id())
2126
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2132
_control_files=control_files)
2133
wt.lock_tree_write()
2135
basis_tree = branch.repository.revision_tree(revision_id)
2136
# only set an explicit root id if there is one to set.
2137
if basis_tree.inventory.root is not None:
2138
wt.set_root_id(basis_tree.inventory.root.file_id)
2139
if revision_id == NULL_REVISION:
2140
wt.set_parent_trees([])
2142
wt.set_parent_trees([(revision_id, basis_tree)])
2143
transform.build_tree(basis_tree, wt)
2145
# Unlock in this order so that the unlock-triggers-flush in
2146
# WorkingTree is given a chance to fire.
2147
control_files.unlock()
2152
super(WorkingTreeFormat3, self).__init__()
2153
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2155
def open(self, a_bzrdir, _found=False):
2156
"""Return the WorkingTree object for a_bzrdir
2158
_found is a private parameter, do not use it. It is used to indicate
2159
if format probing has already been done.
2162
# we are being called directly and must probe.
2163
raise NotImplementedError
2164
if not isinstance(a_bzrdir.transport, LocalTransport):
2165
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2166
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2168
def _open(self, a_bzrdir, control_files):
2169
"""Open the tree itself.
2171
:param a_bzrdir: the dir for the tree.
2172
:param control_files: the control files for the tree.
2174
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2178
_control_files=control_files)
2181
return self.get_format_string()
2184
# formats which have no format string are not discoverable
2185
# and not independently creatable, so are not registered.
2186
__default_format = WorkingTreeFormat3()
2187
WorkingTreeFormat.register_format(__default_format)
2188
WorkingTreeFormat.set_default_format(__default_format)
2189
_legacy_formats = [WorkingTreeFormat2(),
2193
class WorkingTreeTestProviderAdapter(object):
2194
"""A tool to generate a suite testing multiple workingtree formats at once.
2196
This is done by copying the test once for each transport and injecting
2197
the transport_server, transport_readonly_server, and workingtree_format
2198
classes into each copy. Each copy is also given a new id() to make it
2202
def __init__(self, transport_server, transport_readonly_server, formats):
2203
self._transport_server = transport_server
2204
self._transport_readonly_server = transport_readonly_server
2205
self._formats = formats
2207
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2208
"""Clone test for adaption."""
2209
new_test = deepcopy(test)
2210
new_test.transport_server = self._transport_server
2211
new_test.transport_readonly_server = self._transport_readonly_server
2212
new_test.bzrdir_format = bzrdir_format
2213
new_test.workingtree_format = workingtree_format
2214
def make_new_test_id():
2215
new_id = "%s(%s)" % (test.id(), variation)
2216
return lambda: new_id
2217
new_test.id = make_new_test_id()
2220
def adapt(self, test):
2221
from bzrlib.tests import TestSuite
2222
result = TestSuite()
2223
for workingtree_format, bzrdir_format in self._formats:
2224
new_test = self._clone_test(
2227
workingtree_format, workingtree_format.__class__.__name__)
2228
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
