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
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
import bzrlib.mutabletree
75
from bzrlib.mutabletree import needs_tree_write_lock
76
from bzrlib.osutils import (
93
from bzrlib.progress import DummyProgress, ProgressPhase
94
from bzrlib.revision import NULL_REVISION
95
import bzrlib.revisiontree
96
from bzrlib.rio import RioReader, rio_file, Stanza
97
from bzrlib.symbol_versioning import (deprecated_passed,
100
DEPRECATED_PARAMETER,
104
from bzrlib.trace import mutter, note
105
from bzrlib.transform import build_tree
106
from bzrlib.transport import get_transport
107
from bzrlib.transport.local import LocalTransport
108
from bzrlib.textui import show_status
113
# the regex removes any weird characters; we don't escape them
114
# but rather just pull them out
115
_gen_file_id_re = re.compile(r'[^\w.]')
116
_gen_id_suffix = None
120
def _next_id_suffix():
121
"""Create a new file id suffix that is reasonably unique.
123
On the first call we combine the current time with 64 bits of randomness
124
to give a highly probably globally unique number. Then each call in the same
125
process adds 1 to a serial number we append to that unique value.
127
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
128
# than having to move the id randomness out of the inner loop like this.
129
# XXX TODO: for the global randomness this uses we should add the thread-id
130
# before the serial #.
131
global _gen_id_suffix, _gen_id_serial
132
if _gen_id_suffix is None:
133
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
135
return _gen_id_suffix + str(_gen_id_serial)
138
def gen_file_id(name):
139
"""Return new file id for the basename 'name'.
141
The uniqueness is supplied from _next_id_suffix.
143
# The real randomness is in the _next_id_suffix, the
144
# rest of the identifier is just to be nice.
146
# 1) Remove non-ascii word characters to keep the ids portable
147
# 2) squash to lowercase, so the file id doesn't have to
148
# be escaped (case insensitive filesystems would bork for ids
149
# that only differred in case without escaping).
150
# 3) truncate the filename to 20 chars. Long filenames also bork on some
152
# 4) Removing starting '.' characters to prevent the file ids from
153
# being considered hidden.
154
ascii_word_only = _gen_file_id_re.sub('', name.lower())
155
short_no_dots = ascii_word_only.lstrip('.')[:20]
156
return short_no_dots + _next_id_suffix()
160
"""Return a new tree-root file id."""
161
return gen_file_id('TREE_ROOT')
164
class TreeEntry(object):
165
"""An entry that implements the minimum interface used by commands.
167
This needs further inspection, it may be better to have
168
InventoryEntries without ids - though that seems wrong. For now,
169
this is a parallel hierarchy to InventoryEntry, and needs to become
170
one of several things: decorates to that hierarchy, children of, or
172
Another note is that these objects are currently only used when there is
173
no InventoryEntry available - i.e. for unversioned objects.
174
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
177
def __eq__(self, other):
178
# yes, this us ugly, TODO: best practice __eq__ style.
179
return (isinstance(other, TreeEntry)
180
and other.__class__ == self.__class__)
182
def kind_character(self):
186
class TreeDirectory(TreeEntry):
187
"""See TreeEntry. This is a directory in a working tree."""
189
def __eq__(self, other):
190
return (isinstance(other, TreeDirectory)
191
and other.__class__ == self.__class__)
193
def kind_character(self):
197
class TreeFile(TreeEntry):
198
"""See TreeEntry. This is a regular file in a working tree."""
200
def __eq__(self, other):
201
return (isinstance(other, TreeFile)
202
and other.__class__ == self.__class__)
204
def kind_character(self):
208
class TreeLink(TreeEntry):
209
"""See TreeEntry. This is a symlink in a working tree."""
211
def __eq__(self, other):
212
return (isinstance(other, TreeLink)
213
and other.__class__ == self.__class__)
215
def kind_character(self):
219
class WorkingTree(bzrlib.mutabletree.MutableTree):
220
"""Working copy tree.
222
The inventory is held in the `Branch` working-inventory, and the
223
files are in a directory on disk.
225
It is possible for a `WorkingTree` to have a filename which is
226
not listed in the Inventory and vice versa.
229
def __init__(self, basedir='.',
230
branch=DEPRECATED_PARAMETER,
236
"""Construct a WorkingTree for basedir.
238
If the branch is not supplied, it is opened automatically.
239
If the branch is supplied, it must be the branch for this basedir.
240
(branch.base is not cross checked, because for remote branches that
241
would be meaningless).
243
self._format = _format
244
self.bzrdir = _bzrdir
246
# not created via open etc.
247
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
248
"Please use bzrdir.open_workingtree or WorkingTree.open().",
251
wt = WorkingTree.open(basedir)
252
self._branch = wt.branch
253
self.basedir = wt.basedir
254
self._control_files = wt._control_files
255
self._hashcache = wt._hashcache
256
self._set_inventory(wt._inventory)
257
self._format = wt._format
258
self.bzrdir = wt.bzrdir
259
from bzrlib.hashcache import HashCache
260
from bzrlib.trace import note, mutter
261
assert isinstance(basedir, basestring), \
262
"base directory %r is not a string" % basedir
263
basedir = safe_unicode(basedir)
264
mutter("opening working tree %r", basedir)
265
if deprecated_passed(branch):
267
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
268
" Please use bzrdir.open_workingtree() or"
269
" WorkingTree.open().",
273
self._branch = branch
275
self._branch = self.bzrdir.open_branch()
276
self.basedir = realpath(basedir)
277
# if branch is at our basedir and is a format 6 or less
278
if isinstance(self._format, WorkingTreeFormat2):
279
# share control object
280
self._control_files = self.branch.control_files
282
# assume all other formats have their own control files.
283
assert isinstance(_control_files, LockableFiles), \
284
"_control_files must be a LockableFiles, not %r" \
286
self._control_files = _control_files
287
# update the whole cache up front and write to disk if anything changed;
288
# in the future we might want to do this more selectively
289
# two possible ways offer themselves : in self._unlock, write the cache
290
# if needed, or, when the cache sees a change, append it to the hash
291
# cache file, and have the parser take the most recent entry for a
293
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
294
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
296
# is this scan needed ? it makes things kinda slow.
303
if _inventory is None:
304
self._set_inventory(self.read_working_inventory())
306
self._set_inventory(_inventory)
309
fget=lambda self: self._branch,
310
doc="""The branch this WorkingTree is connected to.
312
This cannot be set - it is reflective of the actual disk structure
313
the working tree has been constructed from.
316
def break_lock(self):
317
"""Break a lock if one is present from another instance.
319
Uses the ui factory to ask for confirmation if the lock may be from
322
This will probe the repository for its lock as well.
324
self._control_files.break_lock()
325
self.branch.break_lock()
327
def _set_inventory(self, inv):
328
assert inv.root is not None
329
self._inventory = inv
332
def open(path=None, _unsupported=False):
333
"""Open an existing working tree at path.
337
path = os.path.getcwdu()
338
control = bzrdir.BzrDir.open(path, _unsupported)
339
return control.open_workingtree(_unsupported)
342
def open_containing(path=None):
343
"""Open an existing working tree which has its root about path.
345
This probes for a working tree at path and searches upwards from there.
347
Basically we keep looking up until we find the control directory or
348
run into /. If there isn't one, raises NotBranchError.
349
TODO: give this a new exception.
350
If there is one, it is returned, along with the unused portion of path.
352
:return: The WorkingTree that contains 'path', and the rest of path
355
path = osutils.getcwd()
356
control, relpath = bzrdir.BzrDir.open_containing(path)
358
return control.open_workingtree(), relpath
361
def open_downlevel(path=None):
362
"""Open an unsupported working tree.
364
Only intended for advanced situations like upgrading part of a bzrdir.
366
return WorkingTree.open(path, _unsupported=True)
369
"""Iterate through file_ids for this tree.
371
file_ids are in a WorkingTree if they are in the working inventory
372
and the working file exists.
374
inv = self._inventory
375
for path, ie in inv.iter_entries():
376
if osutils.lexists(self.abspath(path)):
380
return "<%s of %s>" % (self.__class__.__name__,
381
getattr(self, 'basedir', None))
383
def abspath(self, filename):
384
return pathjoin(self.basedir, filename)
386
def basis_tree(self):
387
"""Return RevisionTree for the current last revision.
389
If the left most parent is a ghost then the returned tree will be an
390
empty tree - one obtained by calling repository.revision_tree(None).
393
revision_id = self.get_parent_ids()[0]
395
# no parents, return an empty revision tree.
396
# in the future this should return the tree for
397
# 'empty:' - the implicit root empty tree.
398
return self.branch.repository.revision_tree(None)
401
xml = self.read_basis_inventory()
402
inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
403
if inv is not None and inv.revision_id == revision_id:
404
return bzrlib.tree.RevisionTree(self.branch.repository,
406
except (NoSuchFile, errors.BadInventoryFormat):
408
# No cached copy available, retrieve from the repository.
409
# FIXME? RBC 20060403 should we cache the inventory locally
412
return self.branch.repository.revision_tree(revision_id)
413
except errors.RevisionNotPresent:
414
# the basis tree *may* be a ghost or a low level error may have
415
# occured. If the revision is present, its a problem, if its not
417
if self.branch.repository.has_revision(revision_id):
419
# the basis tree is a ghost so return an empty tree.
420
return self.branch.repository.revision_tree(None)
423
@deprecated_method(zero_eight)
424
def create(branch, directory):
425
"""Create a workingtree for branch at directory.
427
If existing_directory already exists it must have a .bzr directory.
428
If it does not exist, it will be created.
430
This returns a new WorkingTree object for the new checkout.
432
TODO FIXME RBC 20060124 when we have checkout formats in place this
433
should accept an optional revisionid to checkout [and reject this if
434
checking out into the same dir as a pre-checkout-aware branch format.]
436
XXX: When BzrDir is present, these should be created through that
439
warnings.warn('delete WorkingTree.create', stacklevel=3)
440
transport = get_transport(directory)
441
if branch.bzrdir.root_transport.base == transport.base:
443
return branch.bzrdir.create_workingtree()
444
# different directory,
445
# create a branch reference
446
# and now a working tree.
447
raise NotImplementedError
450
@deprecated_method(zero_eight)
451
def create_standalone(directory):
452
"""Create a checkout and a branch and a repo at directory.
454
Directory must exist and be empty.
456
please use BzrDir.create_standalone_workingtree
458
return bzrdir.BzrDir.create_standalone_workingtree(directory)
460
def relpath(self, path):
461
"""Return the local path portion from a given path.
463
The path may be absolute or relative. If its a relative path it is
464
interpreted relative to the python current working directory.
466
return relpath(self.basedir, path)
468
def has_filename(self, filename):
469
return osutils.lexists(self.abspath(filename))
471
def get_file(self, file_id):
472
return self.get_file_byname(self.id2path(file_id))
474
def get_file_text(self, file_id):
475
return self.get_file(file_id).read()
477
def get_file_byname(self, filename):
478
return file(self.abspath(filename), 'rb')
480
def get_parent_ids(self):
481
"""See Tree.get_parent_ids.
483
This implementation reads the pending merges list and last_revision
484
value and uses that to decide what the parents list should be.
486
last_rev = self._last_revision()
492
merges_file = self._control_files.get_utf8('pending-merges')
496
for l in merges_file.readlines():
497
parents.append(l.rstrip('\n'))
500
def get_root_id(self):
501
"""Return the id of this trees root"""
502
inv = self.read_working_inventory()
503
return inv.root.file_id
505
def _get_store_filename(self, file_id):
506
## XXX: badly named; this is not in the store at all
507
return self.abspath(self.id2path(file_id))
510
def clone(self, to_bzrdir, revision_id=None, basis=None):
511
"""Duplicate this working tree into to_bzr, including all state.
513
Specifically modified files are kept as modified, but
514
ignored and unknown files are discarded.
516
If you want to make a new line of development, see bzrdir.sprout()
519
If not None, the cloned tree will have its last revision set to
520
revision, and and difference between the source trees last revision
521
and this one merged in.
524
If not None, a closer copy of a tree which may have some files in
525
common, and which file content should be preferentially copied from.
527
# assumes the target bzr dir format is compatible.
528
result = self._format.initialize(to_bzrdir)
529
self.copy_content_into(result, revision_id)
533
def copy_content_into(self, tree, revision_id=None):
534
"""Copy the current content and user files of this tree into tree."""
535
if revision_id is None:
536
transform_tree(tree, self)
538
# TODO now merge from tree.last_revision to revision (to preserve
539
# user local changes)
540
transform_tree(tree, self)
541
tree.set_parent_ids([revision_id])
543
def id2abspath(self, file_id):
544
return self.abspath(self.id2path(file_id))
546
def has_id(self, file_id):
547
# files that have been deleted are excluded
548
inv = self._inventory
549
if not inv.has_id(file_id):
551
path = inv.id2path(file_id)
552
return osutils.lexists(self.abspath(path))
554
def has_or_had_id(self, file_id):
555
if file_id == self.inventory.root.file_id:
557
return self.inventory.has_id(file_id)
559
__contains__ = has_id
561
def get_file_size(self, file_id):
562
return os.path.getsize(self.id2abspath(file_id))
565
def get_file_sha1(self, file_id, path=None):
567
path = self._inventory.id2path(file_id)
568
return self._hashcache.get_sha1(path)
570
def get_file_mtime(self, file_id, path=None):
572
path = self._inventory.id2path(file_id)
573
return os.lstat(self.abspath(path)).st_mtime
575
if not supports_executable():
576
def is_executable(self, file_id, path=None):
577
return self._inventory[file_id].executable
579
def is_executable(self, file_id, path=None):
581
path = self._inventory.id2path(file_id)
582
mode = os.lstat(self.abspath(path)).st_mode
583
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
586
def _add(self, files, ids, kinds):
587
"""See MutableTree._add."""
588
# TODO: Re-adding a file that is removed in the working copy
589
# should probably put it back with the previous ID.
590
# the read and write working inventory should not occur in this
591
# function - they should be part of lock_write and unlock.
592
inv = self.read_working_inventory()
593
for f, file_id, kind in zip(files, ids, kinds):
594
assert kind is not None
596
inv.add_path(f, kind=kind)
598
inv.add_path(f, kind=kind, file_id=file_id)
599
self._write_inventory(inv)
601
@needs_tree_write_lock
602
def _gather_kinds(self, files, kinds):
603
"""See MutableTree._gather_kinds."""
604
for pos, f in enumerate(files):
605
if kinds[pos] is None:
606
fullpath = normpath(self.abspath(f))
608
kinds[pos] = file_kind(fullpath)
610
if e.errno == errno.ENOENT:
611
raise NoSuchFile(fullpath)
614
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
615
"""Add revision_id as a parent.
617
This is equivalent to retrieving the current list of parent ids
618
and setting the list to its value plus revision_id.
620
:param revision_id: The revision id to add to the parent list. It may
621
be a ghost revision as long as its not the first parent to be added,
622
or the allow_leftmost_as_ghost parameter is set True.
623
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
625
parents = self.get_parent_ids() + [revision_id]
626
self.set_parent_ids(parents,
627
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
629
@needs_tree_write_lock
630
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
631
"""Add revision_id, tree tuple as a parent.
633
This is equivalent to retrieving the current list of parent trees
634
and setting the list to its value plus parent_tuple. See also
635
add_parent_tree_id - if you only have a parent id available it will be
636
simpler to use that api. If you have the parent already available, using
637
this api is preferred.
639
:param parent_tuple: The (revision id, tree) to add to the parent list.
640
If the revision_id is a ghost, pass None for the tree.
641
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
643
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
644
if len(parent_ids) > 1:
645
# the leftmost may have already been a ghost, preserve that if it
647
allow_leftmost_as_ghost = True
648
self.set_parent_ids(parent_ids,
649
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
651
@needs_tree_write_lock
652
def add_pending_merge(self, *revision_ids):
653
# TODO: Perhaps should check at this point that the
654
# history of the revision is actually present?
655
parents = self.get_parent_ids()
657
for rev_id in revision_ids:
658
if rev_id in parents:
660
parents.append(rev_id)
663
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
665
@deprecated_method(zero_eleven)
667
def pending_merges(self):
668
"""Return a list of pending merges.
670
These are revisions that have been merged into the working
671
directory but not yet committed.
673
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
674
instead - which is available on all tree objects.
676
return self.get_parent_ids()[1:]
678
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
679
"""Common ghost checking functionality from set_parent_*.
681
This checks that the left hand-parent exists if there are any
684
if len(revision_ids) > 0:
685
leftmost_id = revision_ids[0]
686
if (not allow_leftmost_as_ghost and not
687
self.branch.repository.has_revision(leftmost_id)):
688
raise errors.GhostRevisionUnusableHere(leftmost_id)
690
def _set_merges_from_parent_ids(self, parent_ids):
691
merges = parent_ids[1:]
692
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
694
@needs_tree_write_lock
695
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
696
"""Set the parent ids to revision_ids.
698
See also set_parent_trees. This api will try to retrieve the tree data
699
for each element of revision_ids from the trees repository. If you have
700
tree data already available, it is more efficient to use
701
set_parent_trees rather than set_parent_ids. set_parent_ids is however
702
an easier API to use.
704
:param revision_ids: The revision_ids to set as the parent ids of this
705
working tree. Any of these may be ghosts.
707
self._check_parents_for_ghosts(revision_ids,
708
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
710
if len(revision_ids) > 0:
711
self.set_last_revision(revision_ids[0])
713
self.set_last_revision(None)
715
self._set_merges_from_parent_ids(revision_ids)
717
@needs_tree_write_lock
718
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
719
"""See MutableTree.set_parent_trees."""
720
parent_ids = [rev for (rev, tree) in parents_list]
722
self._check_parents_for_ghosts(parent_ids,
723
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
725
if len(parent_ids) == 0:
726
leftmost_parent_id = None
727
leftmost_parent_tree = None
729
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
731
if self._change_last_revision(leftmost_parent_id):
732
if leftmost_parent_tree is None:
733
# If we don't have a tree, fall back to reading the
734
# parent tree from the repository.
735
self._cache_basis_inventory(leftmost_parent_id)
737
# It seems Repository.deserialise_inventory is doing this
738
# because apparently commit builder, *doesn't*. It
739
# seems like the in-memory Inventory should always have
740
# the root.revision set without having to serialize out
742
inv = leftmost_parent_tree.inventory
743
if not self.branch.repository._format.rich_root_data:
744
inv.root.revision = leftmost_parent_id
745
xml = self._create_basis_xml_from_inventory(
746
leftmost_parent_id, inv)
747
self._write_basis_inventory(xml)
748
self._set_merges_from_parent_ids(parent_ids)
750
@needs_tree_write_lock
751
def set_pending_merges(self, rev_list):
752
parents = self.get_parent_ids()
753
leftmost = parents[:1]
754
new_parents = leftmost + rev_list
755
self.set_parent_ids(new_parents)
757
@needs_tree_write_lock
758
def set_merge_modified(self, modified_hashes):
760
for file_id, hash in modified_hashes.iteritems():
761
yield Stanza(file_id=file_id, hash=hash)
762
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
764
@needs_tree_write_lock
765
def _put_rio(self, filename, stanzas, header):
766
my_file = rio_file(stanzas, header)
767
self._control_files.put(filename, my_file)
769
@needs_write_lock # because merge pulls data into the branch.
770
def merge_from_branch(self, branch, to_revision=None):
771
"""Merge from a branch into this working tree.
773
:param branch: The branch to merge from.
774
:param to_revision: If non-None, the merge will merge to to_revision, but
775
not beyond it. to_revision does not need to be in the history of
776
the branch when it is supplied. If None, to_revision defaults to
777
branch.last_revision().
779
from bzrlib.merge import Merger, Merge3Merger
780
pb = bzrlib.ui.ui_factory.nested_progress_bar()
782
merger = Merger(self.branch, this_tree=self, pb=pb)
783
merger.pp = ProgressPhase("Merge phase", 5, pb)
784
merger.pp.next_phase()
785
# check that there are no
787
merger.check_basis(check_clean=True, require_commits=False)
788
if to_revision is None:
789
to_revision = branch.last_revision()
790
merger.other_rev_id = to_revision
791
if merger.other_rev_id is None:
792
raise error.NoCommits(branch)
793
self.branch.fetch(branch, last_revision=merger.other_rev_id)
794
merger.other_basis = merger.other_rev_id
795
merger.other_tree = self.branch.repository.revision_tree(
797
merger.pp.next_phase()
799
if merger.base_rev_id == merger.other_rev_id:
800
raise errors.PointlessMerge
801
merger.backup_files = False
802
merger.merge_type = Merge3Merger
803
merger.set_interesting_files(None)
804
merger.show_base = False
805
merger.reprocess = False
806
conflicts = merger.do_merge()
813
def merge_modified(self):
815
hashfile = self._control_files.get('merge-hashes')
820
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
821
raise MergeModifiedFormatError()
822
except StopIteration:
823
raise MergeModifiedFormatError()
824
for s in RioReader(hashfile):
825
file_id = s.get("file_id")
826
if file_id not in self.inventory:
829
if hash == self.get_file_sha1(file_id):
830
merge_hashes[file_id] = hash
834
def mkdir(self, path, file_id=None):
835
"""See MutableTree.mkdir()."""
837
file_id = gen_file_id(os.path.basename(path))
838
os.mkdir(self.abspath(path))
839
self.add(path, file_id, 'directory')
842
def get_symlink_target(self, file_id):
843
return os.readlink(self.id2abspath(file_id))
845
def file_class(self, filename):
846
if self.path2id(filename):
848
elif self.is_ignored(filename):
853
def list_files(self):
854
"""Recursively list all files as (path, class, kind, id, entry).
856
Lists, but does not descend into unversioned directories.
858
This does not include files that have been deleted in this
861
Skips the control directory.
863
inv = self._inventory
864
# Convert these into local objects to save lookup times
865
pathjoin = osutils.pathjoin
866
file_kind = osutils.file_kind
868
# transport.base ends in a slash, we want the piece
869
# between the last two slashes
870
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
872
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
874
# directory file_id, relative path, absolute path, reverse sorted children
875
children = os.listdir(self.basedir)
877
# jam 20060527 The kernel sized tree seems equivalent whether we
878
# use a deque and popleft to keep them sorted, or if we use a plain
879
# list and just reverse() them.
880
children = collections.deque(children)
881
stack = [(inv.root.file_id, u'', self.basedir, children)]
883
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
886
f = children.popleft()
887
## TODO: If we find a subdirectory with its own .bzr
888
## directory, then that is a separate tree and we
889
## should exclude it.
891
# the bzrdir for this tree
892
if transport_base_dir == f:
895
# we know that from_dir_relpath and from_dir_abspath never end in a slash
896
# and 'f' doesn't begin with one, we can do a string op, rather
897
# than the checks of pathjoin(), all relative paths will have an extra slash
899
fp = from_dir_relpath + '/' + f
902
fap = from_dir_abspath + '/' + f
904
f_ie = inv.get_child(from_dir_id, f)
907
elif self.is_ignored(fp[1:]):
910
# we may not have found this file, because of a unicode issue
911
f_norm, can_access = osutils.normalized_filename(f)
912
if f == f_norm or not can_access:
913
# No change, so treat this file normally
916
# this file can be accessed by a normalized path
917
# check again if it is versioned
918
# these lines are repeated here for performance
920
fp = from_dir_relpath + '/' + f
921
fap = from_dir_abspath + '/' + f
922
f_ie = inv.get_child(from_dir_id, f)
925
elif self.is_ignored(fp[1:]):
934
raise BzrCheckError("file %r entered as kind %r id %r, "
936
% (fap, f_ie.kind, f_ie.file_id, fk))
938
# make a last minute entry
940
yield fp[1:], c, fk, f_ie.file_id, f_ie
943
yield fp[1:], c, fk, None, fk_entries[fk]()
945
yield fp[1:], c, fk, None, TreeEntry()
948
if fk != 'directory':
951
# But do this child first
952
new_children = os.listdir(fap)
954
new_children = collections.deque(new_children)
955
stack.append((f_ie.file_id, fp, fap, new_children))
956
# Break out of inner loop, so that we start outer loop with child
959
# if we finished all children, pop it off the stack
962
@needs_tree_write_lock
963
def move(self, from_paths, to_name):
966
to_name must exist in the inventory.
968
If to_name exists and is a directory, the files are moved into
969
it, keeping their old names.
971
Note that to_name is only the last component of the new name;
972
this doesn't change the directory.
974
This returns a list of (from_path, to_path) pairs for each
978
## TODO: Option to move IDs only
979
assert not isinstance(from_paths, basestring)
981
to_abs = self.abspath(to_name)
982
if not isdir(to_abs):
983
raise BzrError("destination %r is not a directory" % to_abs)
984
if not self.has_filename(to_name):
985
raise BzrError("destination %r not in working directory" % to_abs)
986
to_dir_id = inv.path2id(to_name)
987
if to_dir_id is None and to_name != '':
988
raise BzrError("destination %r is not a versioned directory" % to_name)
989
to_dir_ie = inv[to_dir_id]
990
if to_dir_ie.kind != 'directory':
991
raise BzrError("destination %r is not a directory" % to_abs)
993
to_idpath = inv.get_idpath(to_dir_id)
996
if not self.has_filename(f):
997
raise BzrError("%r does not exist in working tree" % f)
998
f_id = inv.path2id(f)
1000
raise BzrError("%r is not versioned" % f)
1001
name_tail = splitpath(f)[-1]
1002
dest_path = pathjoin(to_name, name_tail)
1003
if self.has_filename(dest_path):
1004
raise BzrError("destination %r already exists" % dest_path)
1005
if f_id in to_idpath:
1006
raise BzrError("can't move %r to a subdirectory of itself" % f)
1008
# OK, so there's a race here, it's possible that someone will
1009
# create a file in this interval and then the rename might be
1010
# left half-done. But we should have caught most problems.
1011
orig_inv = deepcopy(self.inventory)
1013
for f in from_paths:
1014
name_tail = splitpath(f)[-1]
1015
dest_path = pathjoin(to_name, name_tail)
1016
result.append((f, dest_path))
1017
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1019
rename(self.abspath(f), self.abspath(dest_path))
1021
raise BzrError("failed to rename %r to %r: %s" %
1022
(f, dest_path, e[1]),
1023
["rename rolled back"])
1025
# restore the inventory on error
1026
self._set_inventory(orig_inv)
1028
self._write_inventory(inv)
1031
@needs_tree_write_lock
1032
def rename_one(self, from_rel, to_rel):
1035
This can change the directory or the filename or both.
1037
inv = self.inventory
1038
if not self.has_filename(from_rel):
1039
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1040
if self.has_filename(to_rel):
1041
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1043
file_id = inv.path2id(from_rel)
1045
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1047
entry = inv[file_id]
1048
from_parent = entry.parent_id
1049
from_name = entry.name
1051
if inv.path2id(to_rel):
1052
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1054
to_dir, to_tail = os.path.split(to_rel)
1055
to_dir_id = inv.path2id(to_dir)
1056
if to_dir_id is None and to_dir != '':
1057
raise BzrError("can't determine destination directory id for %r" % to_dir)
1059
mutter("rename_one:")
1060
mutter(" file_id {%s}" % file_id)
1061
mutter(" from_rel %r" % from_rel)
1062
mutter(" to_rel %r" % to_rel)
1063
mutter(" to_dir %r" % to_dir)
1064
mutter(" to_dir_id {%s}" % to_dir_id)
1066
inv.rename(file_id, to_dir_id, to_tail)
1068
from_abs = self.abspath(from_rel)
1069
to_abs = self.abspath(to_rel)
1071
rename(from_abs, to_abs)
1073
inv.rename(file_id, from_parent, from_name)
1074
raise BzrError("failed to rename %r to %r: %s"
1075
% (from_abs, to_abs, e[1]),
1076
["rename rolled back"])
1077
self._write_inventory(inv)
1081
"""Return all unknown files.
1083
These are files in the working directory that are not versioned or
1084
control files or ignored.
1086
for subp in self.extras():
1087
if not self.is_ignored(subp):
1090
@needs_tree_write_lock
1091
def unversion(self, file_ids):
1092
"""Remove the file ids in file_ids from the current versioned set.
1094
When a file_id is unversioned, all of its children are automatically
1097
:param file_ids: The file ids to stop versioning.
1098
:raises: NoSuchId if any fileid is not currently versioned.
1100
for file_id in file_ids:
1101
if self._inventory.has_id(file_id):
1102
self._inventory.remove_recursive_id(file_id)
1104
raise errors.NoSuchId(self, file_id)
1106
# in the future this should just set a dirty bit to wait for the
1107
# final unlock. However, until all methods of workingtree start
1108
# with the current in -memory inventory rather than triggering
1109
# a read, it is more complex - we need to teach read_inventory
1110
# to know when to read, and when to not read first... and possibly
1111
# to save first when the in memory one may be corrupted.
1112
# so for now, we just only write it if it is indeed dirty.
1114
self._write_inventory(self._inventory)
1116
@deprecated_method(zero_eight)
1117
def iter_conflicts(self):
1118
"""List all files in the tree that have text or content conflicts.
1119
DEPRECATED. Use conflicts instead."""
1120
return self._iter_conflicts()
1122
def _iter_conflicts(self):
1124
for info in self.list_files():
1126
stem = get_conflicted_stem(path)
1129
if stem not in conflicted:
1130
conflicted.add(stem)
1134
def pull(self, source, overwrite=False, stop_revision=None):
1135
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1138
pp = ProgressPhase("Pull phase", 2, top_pb)
1140
old_revision_history = self.branch.revision_history()
1141
basis_tree = self.basis_tree()
1142
count = self.branch.pull(source, overwrite, stop_revision)
1143
new_revision_history = self.branch.revision_history()
1144
if new_revision_history != old_revision_history:
1146
if len(old_revision_history):
1147
other_revision = old_revision_history[-1]
1149
other_revision = None
1150
repository = self.branch.repository
1151
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1153
new_basis_tree = self.branch.basis_tree()
1154
merge_inner(self.branch,
1161
# TODO - dedup parents list with things merged by pull ?
1162
# reuse the revisiontree we merged against to set the new
1164
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1165
# we have to pull the merge trees out again, because
1166
# merge_inner has set the ids. - this corner is not yet
1167
# layered well enough to prevent double handling.
1168
merges = self.get_parent_ids()[1:]
1169
parent_trees.extend([
1170
(parent, repository.revision_tree(parent)) for
1172
self.set_parent_trees(parent_trees)
1179
def put_file_bytes_non_atomic(self, file_id, bytes):
1180
"""See MutableTree.put_file_bytes_non_atomic."""
1181
stream = file(self.id2abspath(file_id), 'wb')
1186
# TODO: update the hashcache here ?
1189
"""Yield all unknown files in this WorkingTree.
1191
If there are any unknown directories then only the directory is
1192
returned, not all its children. But if there are unknown files
1193
under a versioned subdirectory, they are returned.
1195
Currently returned depth-first, sorted by name within directories.
1197
## TODO: Work from given directory downwards
1198
for path, dir_entry in self.inventory.directories():
1199
# mutter("search for unknowns in %r", path)
1200
dirabs = self.abspath(path)
1201
if not isdir(dirabs):
1202
# e.g. directory deleted
1206
for subf in os.listdir(dirabs):
1209
if subf not in dir_entry.children:
1210
subf_norm, can_access = osutils.normalized_filename(subf)
1211
if subf_norm != subf and can_access:
1212
if subf_norm not in dir_entry.children:
1213
fl.append(subf_norm)
1219
subp = pathjoin(path, subf)
1222
def _translate_ignore_rule(self, rule):
1223
"""Translate a single ignore rule to a regex.
1225
There are two types of ignore rules. Those that do not contain a / are
1226
matched against the tail of the filename (that is, they do not care
1227
what directory the file is in.) Rules which do contain a slash must
1228
match the entire path. As a special case, './' at the start of the
1229
string counts as a slash in the string but is removed before matching
1230
(e.g. ./foo.c, ./src/foo.c)
1232
:return: The translated regex.
1234
if rule[:2] in ('./', '.\\'):
1236
result = fnmatch.translate(rule[2:])
1237
elif '/' in rule or '\\' in rule:
1239
result = fnmatch.translate(rule)
1241
# default rule style.
1242
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1243
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1244
return "(" + result + ")"
1246
def _combine_ignore_rules(self, rules):
1247
"""Combine a list of ignore rules into a single regex object.
1249
Each individual rule is combined with | to form a big regex, which then
1250
has $ added to it to form something like ()|()|()$. The group index for
1251
each subregex's outermost group is placed in a dictionary mapping back
1252
to the rule. This allows quick identification of the matching rule that
1254
:return: a list of the compiled regex and the matching-group index
1255
dictionaries. We return a list because python complains if you try to
1256
combine more than 100 regexes.
1261
translated_rules = []
1263
translated_rule = self._translate_ignore_rule(rule)
1264
compiled_rule = re.compile(translated_rule)
1265
groups[next_group] = rule
1266
next_group += compiled_rule.groups
1267
translated_rules.append(translated_rule)
1268
if next_group == 99:
1269
result.append((re.compile("|".join(translated_rules)), groups))
1272
translated_rules = []
1273
if len(translated_rules):
1274
result.append((re.compile("|".join(translated_rules)), groups))
1277
def ignored_files(self):
1278
"""Yield list of PATH, IGNORE_PATTERN"""
1279
for subp in self.extras():
1280
pat = self.is_ignored(subp)
1284
def get_ignore_list(self):
1285
"""Return list of ignore patterns.
1287
Cached in the Tree object after the first call.
1289
ignoreset = getattr(self, '_ignoreset', None)
1290
if ignoreset is not None:
1293
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1294
ignore_globs.update(ignores.get_runtime_ignores())
1296
ignore_globs.update(ignores.get_user_ignores())
1298
if self.has_filename(bzrlib.IGNORE_FILENAME):
1299
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1301
ignore_globs.update(ignores.parse_ignore_file(f))
1305
self._ignoreset = ignore_globs
1306
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1309
def _get_ignore_rules_as_regex(self):
1310
"""Return a regex of the ignore rules and a mapping dict.
1312
:return: (ignore rules compiled regex, dictionary mapping rule group
1313
indices to original rule.)
1315
if getattr(self, '_ignoreset', None) is None:
1316
self.get_ignore_list()
1317
return self._ignore_regex
1319
def is_ignored(self, filename):
1320
r"""Check whether the filename matches an ignore pattern.
1322
Patterns containing '/' or '\' need to match the whole path;
1323
others match against only the last component.
1325
If the file is ignored, returns the pattern which caused it to
1326
be ignored, otherwise None. So this can simply be used as a
1327
boolean if desired."""
1329
# TODO: Use '**' to match directories, and other extended
1330
# globbing stuff from cvs/rsync.
1332
# XXX: fnmatch is actually not quite what we want: it's only
1333
# approximately the same as real Unix fnmatch, and doesn't
1334
# treat dotfiles correctly and allows * to match /.
1335
# Eventually it should be replaced with something more
1338
rules = self._get_ignore_rules_as_regex()
1339
for regex, mapping in rules:
1340
match = regex.match(filename)
1341
if match is not None:
1342
# one or more of the groups in mapping will have a non-None
1344
groups = match.groups()
1345
rules = [mapping[group] for group in
1346
mapping if groups[group] is not None]
1350
def kind(self, file_id):
1351
return file_kind(self.id2abspath(file_id))
1353
def last_revision(self):
1354
"""Return the last revision of the branch for this tree.
1356
This format tree does not support a separate marker for last-revision
1357
compared to the branch.
1359
See MutableTree.last_revision
1361
return self._last_revision()
1364
def _last_revision(self):
1365
"""helper for get_parent_ids."""
1366
return self.branch.last_revision()
1368
def is_locked(self):
1369
return self._control_files.is_locked()
1371
def lock_read(self):
1372
"""See Branch.lock_read, and WorkingTree.unlock."""
1373
self.branch.lock_read()
1375
return self._control_files.lock_read()
1377
self.branch.unlock()
1380
def lock_tree_write(self):
1381
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1382
self.branch.lock_read()
1384
return self._control_files.lock_write()
1386
self.branch.unlock()
1389
def lock_write(self):
1390
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1391
self.branch.lock_write()
1393
return self._control_files.lock_write()
1395
self.branch.unlock()
1398
def get_physical_lock_status(self):
1399
return self._control_files.get_physical_lock_status()
1401
def _basis_inventory_name(self):
1402
return 'basis-inventory-cache'
1404
@needs_tree_write_lock
1405
def set_last_revision(self, new_revision):
1406
"""Change the last revision in the working tree."""
1407
if self._change_last_revision(new_revision):
1408
self._cache_basis_inventory(new_revision)
1410
def _change_last_revision(self, new_revision):
1411
"""Template method part of set_last_revision to perform the change.
1413
This is used to allow WorkingTree3 instances to not affect branch
1414
when their last revision is set.
1416
if new_revision is None:
1417
self.branch.set_revision_history([])
1420
self.branch.generate_revision_history(new_revision)
1421
except errors.NoSuchRevision:
1422
# not present in the repo - dont try to set it deeper than the tip
1423
self.branch.set_revision_history([new_revision])
1426
def _write_basis_inventory(self, xml):
1427
"""Write the basis inventory XML to the basis-inventory file"""
1428
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1429
path = self._basis_inventory_name()
1431
self._control_files.put(path, sio)
1433
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1434
"""Create the text that will be saved in basis-inventory"""
1435
inventory.revision_id = revision_id
1436
return bzrlib.xml6.serializer_v6.write_inventory_to_string(inventory)
1438
def _cache_basis_inventory(self, new_revision):
1439
"""Cache new_revision as the basis inventory."""
1440
# TODO: this should allow the ready-to-use inventory to be passed in,
1441
# as commit already has that ready-to-use [while the format is the
1444
# this double handles the inventory - unpack and repack -
1445
# but is easier to understand. We can/should put a conditional
1446
# in here based on whether the inventory is in the latest format
1447
# - perhaps we should repack all inventories on a repository
1449
# the fast path is to copy the raw xml from the repository. If the
1450
# xml contains 'revision_id="', then we assume the right
1451
# revision_id is set. We must check for this full string, because a
1452
# root node id can legitimately look like 'revision_id' but cannot
1454
xml = self.branch.repository.get_inventory_xml(new_revision)
1455
firstline = xml.split('\n', 1)[0]
1456
if (not 'revision_id="' in firstline or
1457
'format="6"' not in firstline):
1458
inv = self.branch.repository.deserialise_inventory(
1460
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1461
self._write_basis_inventory(xml)
1462
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1465
def read_basis_inventory(self):
1466
"""Read the cached basis inventory."""
1467
path = self._basis_inventory_name()
1468
return self._control_files.get(path).read()
1471
def read_working_inventory(self):
1472
"""Read the working inventory."""
1473
# ElementTree does its own conversion from UTF-8, so open in
1475
result = bzrlib.xml5.serializer_v5.read_inventory(
1476
self._control_files.get('inventory'))
1477
self._set_inventory(result)
1480
@needs_tree_write_lock
1481
def remove(self, files, verbose=False, to_file=None):
1482
"""Remove nominated files from the working inventory..
1484
This does not remove their text. This does not run on XXX on what? RBC
1486
TODO: Refuse to remove modified files unless --force is given?
1488
TODO: Do something useful with directories.
1490
TODO: Should this remove the text or not? Tough call; not
1491
removing may be useful and the user can just use use rm, and
1492
is the opposite of add. Removing it is consistent with most
1493
other tools. Maybe an option.
1495
## TODO: Normalize names
1496
## TODO: Remove nested loops; better scalability
1497
if isinstance(files, basestring):
1500
inv = self.inventory
1502
# do this before any modifications
1504
fid = inv.path2id(f)
1506
# TODO: Perhaps make this just a warning, and continue?
1507
# This tends to happen when
1508
raise NotVersionedError(path=f)
1510
# having remove it, it must be either ignored or unknown
1511
if self.is_ignored(f):
1515
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1518
self._write_inventory(inv)
1520
@needs_tree_write_lock
1521
def revert(self, filenames, old_tree=None, backups=True,
1522
pb=DummyProgress()):
1523
from transform import revert
1524
from conflicts import resolve
1525
if old_tree is None:
1526
old_tree = self.basis_tree()
1527
conflicts = revert(self, old_tree, filenames, backups, pb)
1528
if not len(filenames):
1529
self.set_parent_ids(self.get_parent_ids()[:1])
1532
resolve(self, filenames, ignore_misses=True)
1535
# XXX: This method should be deprecated in favour of taking in a proper
1536
# new Inventory object.
1537
@needs_tree_write_lock
1538
def set_inventory(self, new_inventory_list):
1539
from bzrlib.inventory import (Inventory,
1544
inv = Inventory(self.get_root_id())
1545
for path, file_id, parent, kind in new_inventory_list:
1546
name = os.path.basename(path)
1549
# fixme, there should be a factory function inv,add_??
1550
if kind == 'directory':
1551
inv.add(InventoryDirectory(file_id, name, parent))
1552
elif kind == 'file':
1553
inv.add(InventoryFile(file_id, name, parent))
1554
elif kind == 'symlink':
1555
inv.add(InventoryLink(file_id, name, parent))
1557
raise BzrError("unknown kind %r" % kind)
1558
self._write_inventory(inv)
1560
@needs_tree_write_lock
1561
def set_root_id(self, file_id):
1562
"""Set the root id for this tree."""
1563
inv = self.read_working_inventory()
1564
orig_root_id = inv.root.file_id
1565
del inv._byid[inv.root.file_id]
1566
inv.root.file_id = file_id
1567
inv._byid[inv.root.file_id] = inv.root
1570
if entry.parent_id == orig_root_id:
1571
entry.parent_id = inv.root.file_id
1572
self._write_inventory(inv)
1575
"""See Branch.unlock.
1577
WorkingTree locking just uses the Branch locking facilities.
1578
This is current because all working trees have an embedded branch
1579
within them. IF in the future, we were to make branch data shareable
1580
between multiple working trees, i.e. via shared storage, then we
1581
would probably want to lock both the local tree, and the branch.
1583
raise NotImplementedError(self.unlock)
1587
"""Update a working tree along its branch.
1589
This will update the branch if its bound too, which means we have multiple trees involved:
1590
The new basis tree of the master.
1591
The old basis tree of the branch.
1592
The old basis tree of the working tree.
1593
The current working tree state.
1594
pathologically all three may be different, and non ancestors of each other.
1595
Conceptually we want to:
1596
Preserve the wt.basis->wt.state changes
1597
Transform the wt.basis to the new master basis.
1598
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1599
Restore the wt.basis->wt.state changes.
1601
There isn't a single operation at the moment to do that, so we:
1602
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1603
Do a 'normal' merge of the old branch basis if it is relevant.
1605
old_tip = self.branch.update()
1606
# here if old_tip is not None, it is the old tip of the branch before
1607
# it was updated from the master branch. This should become a pending
1608
# merge in the working tree to preserve the user existing work. we
1609
# cant set that until we update the working trees last revision to be
1610
# one from the new branch, because it will just get absorbed by the
1611
# parent de-duplication logic.
1613
# We MUST save it even if an error occurs, because otherwise the users
1614
# local work is unreferenced and will appear to have been lost.
1618
last_rev = self.get_parent_ids()[0]
1621
if last_rev != self.branch.last_revision():
1622
# merge tree state up to new branch tip.
1623
basis = self.basis_tree()
1624
to_tree = self.branch.basis_tree()
1625
result += merge_inner(self.branch,
1629
# TODO - dedup parents list with things merged by pull ?
1630
# reuse the tree we've updated to to set the basis:
1631
parent_trees = [(self.branch.last_revision(), to_tree)]
1632
merges = self.get_parent_ids()[1:]
1633
# Ideally we ask the tree for the trees here, that way the working
1634
# tree can decide whether to give us teh entire tree or give us a
1635
# lazy initialised tree. dirstate for instance will have the trees
1636
# in ram already, whereas a last-revision + basis-inventory tree
1637
# will not, but also does not need them when setting parents.
1638
for parent in merges:
1639
parent_trees.append(
1640
(parent, self.branch.repository.revision_tree(parent)))
1641
if old_tip is not None:
1642
parent_trees.append(
1643
(old_tip, self.branch.repository.revision_tree(old_tip)))
1644
self.set_parent_trees(parent_trees)
1645
last_rev = parent_trees[0][0]
1647
# the working tree had the same last-revision as the master
1648
# branch did. We may still have pivot local work from the local
1649
# branch into old_tip:
1650
if old_tip is not None:
1651
self.add_parent_tree_id(old_tip)
1652
if old_tip and old_tip != last_rev:
1653
# our last revision was not the prior branch last revision
1654
# and we have converted that last revision to a pending merge.
1655
# base is somewhere between the branch tip now
1656
# and the now pending merge
1657
from bzrlib.revision import common_ancestor
1659
base_rev_id = common_ancestor(self.branch.last_revision(),
1661
self.branch.repository)
1662
except errors.NoCommonAncestor:
1664
base_tree = self.branch.repository.revision_tree(base_rev_id)
1665
other_tree = self.branch.repository.revision_tree(old_tip)
1666
result += merge_inner(self.branch,
1672
@needs_tree_write_lock
1673
def _write_inventory(self, inv):
1674
"""Write inventory as the current inventory."""
1676
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1678
self._control_files.put('inventory', sio)
1679
self._set_inventory(inv)
1680
mutter('wrote working inventory')
1682
def set_conflicts(self, arg):
1683
raise UnsupportedOperation(self.set_conflicts, self)
1685
def add_conflicts(self, arg):
1686
raise UnsupportedOperation(self.add_conflicts, self)
1689
def conflicts(self):
1690
conflicts = ConflictList()
1691
for conflicted in self._iter_conflicts():
1694
if file_kind(self.abspath(conflicted)) != "file":
1696
except errors.NoSuchFile:
1699
for suffix in ('.THIS', '.OTHER'):
1701
kind = file_kind(self.abspath(conflicted+suffix))
1704
except errors.NoSuchFile:
1708
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1709
conflicts.append(Conflict.factory(ctype, path=conflicted,
1710
file_id=self.path2id(conflicted)))
1714
class WorkingTree2(WorkingTree):
1715
"""This is the Format 2 working tree.
1717
This was the first weave based working tree.
1718
- uses os locks for locking.
1719
- uses the branch last-revision.
1722
def lock_tree_write(self):
1723
"""See WorkingTree.lock_tree_write().
1725
In Format2 WorkingTrees we have a single lock for the branch and tree
1726
so lock_tree_write() degrades to lock_write().
1728
self.branch.lock_write()
1730
return self._control_files.lock_write()
1732
self.branch.unlock()
1736
# we share control files:
1737
if self._hashcache.needs_write and self._control_files._lock_count==3:
1738
self._hashcache.write()
1739
# reverse order of locking.
1741
return self._control_files.unlock()
1743
self.branch.unlock()
1746
class WorkingTree3(WorkingTree):
1747
"""This is the Format 3 working tree.
1749
This differs from the base WorkingTree by:
1750
- having its own file lock
1751
- having its own last-revision property.
1753
This is new in bzr 0.8
1757
def _last_revision(self):
1758
"""See Mutable.last_revision."""
1760
return self._control_files.get_utf8('last-revision').read()
1764
def _change_last_revision(self, revision_id):
1765
"""See WorkingTree._change_last_revision."""
1766
if revision_id is None or revision_id == NULL_REVISION:
1768
self._control_files._transport.delete('last-revision')
1769
except errors.NoSuchFile:
1773
self._control_files.put_utf8('last-revision', revision_id)
1776
@needs_tree_write_lock
1777
def set_conflicts(self, conflicts):
1778
self._put_rio('conflicts', conflicts.to_stanzas(),
1781
@needs_tree_write_lock
1782
def add_conflicts(self, new_conflicts):
1783
conflict_set = set(self.conflicts())
1784
conflict_set.update(set(list(new_conflicts)))
1785
self.set_conflicts(ConflictList(sorted(conflict_set,
1786
key=Conflict.sort_key)))
1789
def conflicts(self):
1791
confile = self._control_files.get('conflicts')
1793
return ConflictList()
1795
if confile.next() != CONFLICT_HEADER_1 + '\n':
1796
raise ConflictFormatError()
1797
except StopIteration:
1798
raise ConflictFormatError()
1799
return ConflictList.from_stanzas(RioReader(confile))
1802
if self._hashcache.needs_write and self._control_files._lock_count==1:
1803
self._hashcache.write()
1804
# reverse order of locking.
1806
return self._control_files.unlock()
1808
self.branch.unlock()
1811
def get_conflicted_stem(path):
1812
for suffix in CONFLICT_SUFFIXES:
1813
if path.endswith(suffix):
1814
return path[:-len(suffix)]
1816
@deprecated_function(zero_eight)
1817
def is_control_file(filename):
1818
"""See WorkingTree.is_control_filename(filename)."""
1819
## FIXME: better check
1820
filename = normpath(filename)
1821
while filename != '':
1822
head, tail = os.path.split(filename)
1823
## mutter('check %r for control file' % ((head, tail),))
1826
if filename == head:
1832
class WorkingTreeFormat(object):
1833
"""An encapsulation of the initialization and open routines for a format.
1835
Formats provide three things:
1836
* An initialization routine,
1840
Formats are placed in an dict by their format string for reference
1841
during workingtree opening. Its not required that these be instances, they
1842
can be classes themselves with class methods - it simply depends on
1843
whether state is needed for a given format or not.
1845
Once a format is deprecated, just deprecate the initialize and open
1846
methods on the format class. Do not deprecate the object, as the
1847
object will be created every time regardless.
1850
_default_format = None
1851
"""The default format used for new trees."""
1854
"""The known formats."""
1857
def find_format(klass, a_bzrdir):
1858
"""Return the format for the working tree object in a_bzrdir."""
1860
transport = a_bzrdir.get_workingtree_transport(None)
1861
format_string = transport.get("format").read()
1862
return klass._formats[format_string]
1864
raise errors.NoWorkingTree(base=transport.base)
1866
raise errors.UnknownFormatError(format=format_string)
1869
def get_default_format(klass):
1870
"""Return the current default format."""
1871
return klass._default_format
1873
def get_format_string(self):
1874
"""Return the ASCII format string that identifies this format."""
1875
raise NotImplementedError(self.get_format_string)
1877
def get_format_description(self):
1878
"""Return the short description for this format."""
1879
raise NotImplementedError(self.get_format_description)
1881
def is_supported(self):
1882
"""Is this format supported?
1884
Supported formats can be initialized and opened.
1885
Unsupported formats may not support initialization or committing or
1886
some other features depending on the reason for not being supported.
1891
def register_format(klass, format):
1892
klass._formats[format.get_format_string()] = format
1895
def set_default_format(klass, format):
1896
klass._default_format = format
1899
def unregister_format(klass, format):
1900
assert klass._formats[format.get_format_string()] is format
1901
del klass._formats[format.get_format_string()]
1905
class WorkingTreeFormat2(WorkingTreeFormat):
1906
"""The second working tree format.
1908
This format modified the hash cache from the format 1 hash cache.
1911
def get_format_description(self):
1912
"""See WorkingTreeFormat.get_format_description()."""
1913
return "Working tree format 2"
1915
def stub_initialize_remote(self, control_files):
1916
"""As a special workaround create critical control files for a remote working tree
1918
This ensures that it can later be updated and dealt with locally,
1919
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1920
no working tree. (See bug #43064).
1924
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1926
control_files.put('inventory', sio)
1928
control_files.put_utf8('pending-merges', '')
1931
def initialize(self, a_bzrdir, revision_id=None):
1932
"""See WorkingTreeFormat.initialize()."""
1933
if not isinstance(a_bzrdir.transport, LocalTransport):
1934
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1935
branch = a_bzrdir.open_branch()
1936
if revision_id is not None:
1939
revision_history = branch.revision_history()
1941
position = revision_history.index(revision_id)
1943
raise errors.NoSuchRevision(branch, revision_id)
1944
branch.set_revision_history(revision_history[:position + 1])
1947
revision = branch.last_revision()
1949
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1955
wt._write_inventory(inv)
1956
wt.set_root_id(inv.root.file_id)
1957
basis_tree = branch.repository.revision_tree(revision)
1958
wt.set_parent_trees([(revision, basis_tree)])
1959
build_tree(basis_tree, wt)
1963
super(WorkingTreeFormat2, self).__init__()
1964
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1966
def open(self, a_bzrdir, _found=False):
1967
"""Return the WorkingTree object for a_bzrdir
1969
_found is a private parameter, do not use it. It is used to indicate
1970
if format probing has already been done.
1973
# we are being called directly and must probe.
1974
raise NotImplementedError
1975
if not isinstance(a_bzrdir.transport, LocalTransport):
1976
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1977
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1983
class WorkingTreeFormat3(WorkingTreeFormat):
1984
"""The second working tree format updated to record a format marker.
1987
- exists within a metadir controlling .bzr
1988
- includes an explicit version marker for the workingtree control
1989
files, separate from the BzrDir format
1990
- modifies the hash cache format
1992
- uses a LockDir to guard access for writes.
1995
def get_format_string(self):
1996
"""See WorkingTreeFormat.get_format_string()."""
1997
return "Bazaar-NG Working Tree format 3"
1999
def get_format_description(self):
2000
"""See WorkingTreeFormat.get_format_description()."""
2001
return "Working tree format 3"
2003
_lock_file_name = 'lock'
2004
_lock_class = LockDir
2006
def _open_control_files(self, a_bzrdir):
2007
transport = a_bzrdir.get_workingtree_transport(None)
2008
return LockableFiles(transport, self._lock_file_name,
2011
def initialize(self, a_bzrdir, revision_id=None):
2012
"""See WorkingTreeFormat.initialize().
2014
revision_id allows creating a working tree at a different
2015
revision than the branch is at.
2017
if not isinstance(a_bzrdir.transport, LocalTransport):
2018
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2019
transport = a_bzrdir.get_workingtree_transport(self)
2020
control_files = self._open_control_files(a_bzrdir)
2021
control_files.create_lock()
2022
control_files.lock_write()
2023
control_files.put_utf8('format', self.get_format_string())
2024
branch = a_bzrdir.open_branch()
2025
if revision_id is None:
2026
revision_id = branch.last_revision()
2028
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2034
_control_files=control_files)
2035
wt.lock_tree_write()
2037
wt._write_inventory(inv)
2038
wt.set_root_id(inv.root.file_id)
2039
basis_tree = branch.repository.revision_tree(revision_id)
2040
if revision_id == bzrlib.revision.NULL_REVISION:
2041
wt.set_parent_trees([])
2043
wt.set_parent_trees([(revision_id, basis_tree)])
2044
build_tree(basis_tree, wt)
2047
control_files.unlock()
2051
super(WorkingTreeFormat3, self).__init__()
2052
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2054
def open(self, a_bzrdir, _found=False):
2055
"""Return the WorkingTree object for a_bzrdir
2057
_found is a private parameter, do not use it. It is used to indicate
2058
if format probing has already been done.
2061
# we are being called directly and must probe.
2062
raise NotImplementedError
2063
if not isinstance(a_bzrdir.transport, LocalTransport):
2064
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2065
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2067
def _open(self, a_bzrdir, control_files):
2068
"""Open the tree itself.
2070
:param a_bzrdir: the dir for the tree.
2071
:param control_files: the control files for the tree.
2073
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2077
_control_files=control_files)
2080
return self.get_format_string()
2083
# formats which have no format string are not discoverable
2084
# and not independently creatable, so are not registered.
2085
__default_format = WorkingTreeFormat3()
2086
WorkingTreeFormat.register_format(__default_format)
2087
WorkingTreeFormat.set_default_format(__default_format)
2088
_legacy_formats = [WorkingTreeFormat2(),
2092
class WorkingTreeTestProviderAdapter(object):
2093
"""A tool to generate a suite testing multiple workingtree formats at once.
2095
This is done by copying the test once for each transport and injecting
2096
the transport_server, transport_readonly_server, and workingtree_format
2097
classes into each copy. Each copy is also given a new id() to make it
2101
def __init__(self, transport_server, transport_readonly_server, formats):
2102
self._transport_server = transport_server
2103
self._transport_readonly_server = transport_readonly_server
2104
self._formats = formats
2106
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2107
"""Clone test for adaption."""
2108
new_test = deepcopy(test)
2109
new_test.transport_server = self._transport_server
2110
new_test.transport_readonly_server = self._transport_readonly_server
2111
new_test.bzrdir_format = bzrdir_format
2112
new_test.workingtree_format = workingtree_format
2113
def make_new_test_id():
2114
new_id = "%s(%s)" % (test.id(), variation)
2115
return lambda: new_id
2116
new_test.id = make_new_test_id()
2119
def adapt(self, test):
2120
from bzrlib.tests import TestSuite
2121
result = TestSuite()
2122
for workingtree_format, bzrdir_format in self._formats:
2123
new_test = self._clone_test(
2126
workingtree_format, workingtree_format.__class__.__name__)
2127
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
