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
tree.set_root_id(self.get_root_id())
536
if revision_id is None:
537
transform_tree(tree, self)
539
# TODO now merge from tree.last_revision to revision (to preserve
540
# user local changes)
541
transform_tree(tree, self)
542
tree.set_parent_ids([revision_id])
544
def id2abspath(self, file_id):
545
return self.abspath(self.id2path(file_id))
547
def has_id(self, file_id):
548
# files that have been deleted are excluded
549
inv = self._inventory
550
if not inv.has_id(file_id):
552
path = inv.id2path(file_id)
553
return osutils.lexists(self.abspath(path))
555
def has_or_had_id(self, file_id):
556
if file_id == self.inventory.root.file_id:
558
return self.inventory.has_id(file_id)
560
__contains__ = has_id
562
def get_file_size(self, file_id):
563
return os.path.getsize(self.id2abspath(file_id))
566
def get_file_sha1(self, file_id, path=None):
568
path = self._inventory.id2path(file_id)
569
return self._hashcache.get_sha1(path)
571
def get_file_mtime(self, file_id, path=None):
573
path = self._inventory.id2path(file_id)
574
return os.lstat(self.abspath(path)).st_mtime
576
if not supports_executable():
577
def is_executable(self, file_id, path=None):
578
return self._inventory[file_id].executable
580
def is_executable(self, file_id, path=None):
582
path = self._inventory.id2path(file_id)
583
mode = os.lstat(self.abspath(path)).st_mode
584
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
587
def _add(self, files, ids, kinds):
588
"""See MutableTree._add."""
589
# TODO: Re-adding a file that is removed in the working copy
590
# should probably put it back with the previous ID.
591
# the read and write working inventory should not occur in this
592
# function - they should be part of lock_write and unlock.
593
inv = self.read_working_inventory()
594
for f, file_id, kind in zip(files, ids, kinds):
595
assert kind is not None
597
inv.add_path(f, kind=kind)
599
inv.add_path(f, kind=kind, file_id=file_id)
600
self._write_inventory(inv)
602
@needs_tree_write_lock
603
def _gather_kinds(self, files, kinds):
604
"""See MutableTree._gather_kinds."""
605
for pos, f in enumerate(files):
606
if kinds[pos] is None:
607
fullpath = normpath(self.abspath(f))
609
kinds[pos] = file_kind(fullpath)
611
if e.errno == errno.ENOENT:
612
raise NoSuchFile(fullpath)
615
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
616
"""Add revision_id as a parent.
618
This is equivalent to retrieving the current list of parent ids
619
and setting the list to its value plus revision_id.
621
:param revision_id: The revision id to add to the parent list. It may
622
be a ghost revision as long as its not the first parent to be added,
623
or the allow_leftmost_as_ghost parameter is set True.
624
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
626
parents = self.get_parent_ids() + [revision_id]
627
self.set_parent_ids(parents,
628
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
630
@needs_tree_write_lock
631
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
632
"""Add revision_id, tree tuple as a parent.
634
This is equivalent to retrieving the current list of parent trees
635
and setting the list to its value plus parent_tuple. See also
636
add_parent_tree_id - if you only have a parent id available it will be
637
simpler to use that api. If you have the parent already available, using
638
this api is preferred.
640
:param parent_tuple: The (revision id, tree) to add to the parent list.
641
If the revision_id is a ghost, pass None for the tree.
642
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
644
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
645
if len(parent_ids) > 1:
646
# the leftmost may have already been a ghost, preserve that if it
648
allow_leftmost_as_ghost = True
649
self.set_parent_ids(parent_ids,
650
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
652
@needs_tree_write_lock
653
def add_pending_merge(self, *revision_ids):
654
# TODO: Perhaps should check at this point that the
655
# history of the revision is actually present?
656
parents = self.get_parent_ids()
658
for rev_id in revision_ids:
659
if rev_id in parents:
661
parents.append(rev_id)
664
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
666
@deprecated_method(zero_eleven)
668
def pending_merges(self):
669
"""Return a list of pending merges.
671
These are revisions that have been merged into the working
672
directory but not yet committed.
674
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
675
instead - which is available on all tree objects.
677
return self.get_parent_ids()[1:]
679
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
680
"""Common ghost checking functionality from set_parent_*.
682
This checks that the left hand-parent exists if there are any
685
if len(revision_ids) > 0:
686
leftmost_id = revision_ids[0]
687
if (not allow_leftmost_as_ghost and not
688
self.branch.repository.has_revision(leftmost_id)):
689
raise errors.GhostRevisionUnusableHere(leftmost_id)
691
def _set_merges_from_parent_ids(self, parent_ids):
692
merges = parent_ids[1:]
693
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
695
@needs_tree_write_lock
696
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
697
"""Set the parent ids to revision_ids.
699
See also set_parent_trees. This api will try to retrieve the tree data
700
for each element of revision_ids from the trees repository. If you have
701
tree data already available, it is more efficient to use
702
set_parent_trees rather than set_parent_ids. set_parent_ids is however
703
an easier API to use.
705
:param revision_ids: The revision_ids to set as the parent ids of this
706
working tree. Any of these may be ghosts.
708
self._check_parents_for_ghosts(revision_ids,
709
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
711
if len(revision_ids) > 0:
712
self.set_last_revision(revision_ids[0])
714
self.set_last_revision(None)
716
self._set_merges_from_parent_ids(revision_ids)
718
@needs_tree_write_lock
719
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
720
"""See MutableTree.set_parent_trees."""
721
parent_ids = [rev for (rev, tree) in parents_list]
723
self._check_parents_for_ghosts(parent_ids,
724
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
726
if len(parent_ids) == 0:
727
leftmost_parent_id = None
728
leftmost_parent_tree = None
730
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
732
if self._change_last_revision(leftmost_parent_id):
733
if leftmost_parent_tree is None:
734
# If we don't have a tree, fall back to reading the
735
# parent tree from the repository.
736
self._cache_basis_inventory(leftmost_parent_id)
738
inv = leftmost_parent_tree.inventory
739
xml = self._create_basis_xml_from_inventory(
740
leftmost_parent_id, inv)
741
self._write_basis_inventory(xml)
742
self._set_merges_from_parent_ids(parent_ids)
744
@needs_tree_write_lock
745
def set_pending_merges(self, rev_list):
746
parents = self.get_parent_ids()
747
leftmost = parents[:1]
748
new_parents = leftmost + rev_list
749
self.set_parent_ids(new_parents)
751
@needs_tree_write_lock
752
def set_merge_modified(self, modified_hashes):
754
for file_id, hash in modified_hashes.iteritems():
755
yield Stanza(file_id=file_id, hash=hash)
756
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
758
@needs_tree_write_lock
759
def _put_rio(self, filename, stanzas, header):
760
my_file = rio_file(stanzas, header)
761
self._control_files.put(filename, my_file)
763
@needs_write_lock # because merge pulls data into the branch.
764
def merge_from_branch(self, branch, to_revision=None):
765
"""Merge from a branch into this working tree.
767
:param branch: The branch to merge from.
768
:param to_revision: If non-None, the merge will merge to to_revision, but
769
not beyond it. to_revision does not need to be in the history of
770
the branch when it is supplied. If None, to_revision defaults to
771
branch.last_revision().
773
from bzrlib.merge import Merger, Merge3Merger
774
pb = bzrlib.ui.ui_factory.nested_progress_bar()
776
merger = Merger(self.branch, this_tree=self, pb=pb)
777
merger.pp = ProgressPhase("Merge phase", 5, pb)
778
merger.pp.next_phase()
779
# check that there are no
781
merger.check_basis(check_clean=True, require_commits=False)
782
if to_revision is None:
783
to_revision = branch.last_revision()
784
merger.other_rev_id = to_revision
785
if merger.other_rev_id is None:
786
raise error.NoCommits(branch)
787
self.branch.fetch(branch, last_revision=merger.other_rev_id)
788
merger.other_basis = merger.other_rev_id
789
merger.other_tree = self.branch.repository.revision_tree(
791
merger.pp.next_phase()
793
if merger.base_rev_id == merger.other_rev_id:
794
raise errors.PointlessMerge
795
merger.backup_files = False
796
merger.merge_type = Merge3Merger
797
merger.set_interesting_files(None)
798
merger.show_base = False
799
merger.reprocess = False
800
conflicts = merger.do_merge()
807
def merge_modified(self):
809
hashfile = self._control_files.get('merge-hashes')
814
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
815
raise MergeModifiedFormatError()
816
except StopIteration:
817
raise MergeModifiedFormatError()
818
for s in RioReader(hashfile):
819
file_id = s.get("file_id")
820
if file_id not in self.inventory:
823
if hash == self.get_file_sha1(file_id):
824
merge_hashes[file_id] = hash
828
def mkdir(self, path, file_id=None):
829
"""See MutableTree.mkdir()."""
831
file_id = gen_file_id(os.path.basename(path))
832
os.mkdir(self.abspath(path))
833
self.add(path, file_id, 'directory')
836
def get_symlink_target(self, file_id):
837
return os.readlink(self.id2abspath(file_id))
839
def file_class(self, filename):
840
if self.path2id(filename):
842
elif self.is_ignored(filename):
847
def list_files(self, include_root=False):
848
"""Recursively list all files as (path, class, kind, id, entry).
850
Lists, but does not descend into unversioned directories.
852
This does not include files that have been deleted in this
855
Skips the control directory.
857
inv = self._inventory
858
if include_root is True:
859
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
860
# Convert these into local objects to save lookup times
861
pathjoin = osutils.pathjoin
862
file_kind = osutils.file_kind
864
# transport.base ends in a slash, we want the piece
865
# between the last two slashes
866
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
868
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
870
# directory file_id, relative path, absolute path, reverse sorted children
871
children = os.listdir(self.basedir)
873
# jam 20060527 The kernel sized tree seems equivalent whether we
874
# use a deque and popleft to keep them sorted, or if we use a plain
875
# list and just reverse() them.
876
children = collections.deque(children)
877
stack = [(inv.root.file_id, u'', self.basedir, children)]
879
yield u'', 'V', 'directory', inv.root.file_id, inv.root
881
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
884
f = children.popleft()
885
## TODO: If we find a subdirectory with its own .bzr
886
## directory, then that is a separate tree and we
887
## should exclude it.
889
# the bzrdir for this tree
890
if transport_base_dir == f:
893
# we know that from_dir_relpath and from_dir_abspath never end in a slash
894
# and 'f' doesn't begin with one, we can do a string op, rather
895
# than the checks of pathjoin(), all relative paths will have an extra slash
897
fp = from_dir_relpath + '/' + f
900
fap = from_dir_abspath + '/' + f
902
f_ie = inv.get_child(from_dir_id, f)
905
elif self.is_ignored(fp[1:]):
908
# we may not have found this file, because of a unicode issue
909
f_norm, can_access = osutils.normalized_filename(f)
910
if f == f_norm or not can_access:
911
# No change, so treat this file normally
914
# this file can be accessed by a normalized path
915
# check again if it is versioned
916
# these lines are repeated here for performance
918
fp = from_dir_relpath + '/' + f
919
fap = from_dir_abspath + '/' + f
920
f_ie = inv.get_child(from_dir_id, f)
923
elif self.is_ignored(fp[1:]):
932
raise BzrCheckError("file %r entered as kind %r id %r, "
934
% (fap, f_ie.kind, f_ie.file_id, fk))
936
# make a last minute entry
938
yield fp[1:], c, fk, f_ie.file_id, f_ie
941
yield fp[1:], c, fk, None, fk_entries[fk]()
943
yield fp[1:], c, fk, None, TreeEntry()
946
if fk != 'directory':
949
# But do this child first
950
new_children = os.listdir(fap)
952
new_children = collections.deque(new_children)
953
stack.append((f_ie.file_id, fp, fap, new_children))
954
# Break out of inner loop, so that we start outer loop with child
957
# if we finished all children, pop it off the stack
960
@needs_tree_write_lock
961
def move(self, from_paths, to_name):
964
to_name must exist in the inventory.
966
If to_name exists and is a directory, the files are moved into
967
it, keeping their old names.
969
Note that to_name is only the last component of the new name;
970
this doesn't change the directory.
972
This returns a list of (from_path, to_path) pairs for each
976
## TODO: Option to move IDs only
977
assert not isinstance(from_paths, basestring)
979
to_abs = self.abspath(to_name)
980
if not isdir(to_abs):
981
raise BzrError("destination %r is not a directory" % to_abs)
982
if not self.has_filename(to_name):
983
raise BzrError("destination %r not in working directory" % to_abs)
984
to_dir_id = inv.path2id(to_name)
985
if to_dir_id is None and to_name != '':
986
raise BzrError("destination %r is not a versioned directory" % to_name)
987
to_dir_ie = inv[to_dir_id]
988
if to_dir_ie.kind != 'directory':
989
raise BzrError("destination %r is not a directory" % to_abs)
991
to_idpath = inv.get_idpath(to_dir_id)
994
if not self.has_filename(f):
995
raise BzrError("%r does not exist in working tree" % f)
996
f_id = inv.path2id(f)
998
raise BzrError("%r is not versioned" % f)
999
name_tail = splitpath(f)[-1]
1000
dest_path = pathjoin(to_name, name_tail)
1001
if self.has_filename(dest_path):
1002
raise BzrError("destination %r already exists" % dest_path)
1003
if f_id in to_idpath:
1004
raise BzrError("can't move %r to a subdirectory of itself" % f)
1006
# OK, so there's a race here, it's possible that someone will
1007
# create a file in this interval and then the rename might be
1008
# left half-done. But we should have caught most problems.
1009
orig_inv = deepcopy(self.inventory)
1011
for f in from_paths:
1012
name_tail = splitpath(f)[-1]
1013
dest_path = pathjoin(to_name, name_tail)
1014
result.append((f, dest_path))
1015
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1017
rename(self.abspath(f), self.abspath(dest_path))
1019
raise BzrError("failed to rename %r to %r: %s" %
1020
(f, dest_path, e[1]),
1021
["rename rolled back"])
1023
# restore the inventory on error
1024
self._set_inventory(orig_inv)
1026
self._write_inventory(inv)
1029
@needs_tree_write_lock
1030
def rename_one(self, from_rel, to_rel):
1033
This can change the directory or the filename or both.
1035
inv = self.inventory
1036
if not self.has_filename(from_rel):
1037
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1038
if self.has_filename(to_rel):
1039
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1041
file_id = inv.path2id(from_rel)
1043
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1045
entry = inv[file_id]
1046
from_parent = entry.parent_id
1047
from_name = entry.name
1049
if inv.path2id(to_rel):
1050
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1052
to_dir, to_tail = os.path.split(to_rel)
1053
to_dir_id = inv.path2id(to_dir)
1054
if to_dir_id is None and to_dir != '':
1055
raise BzrError("can't determine destination directory id for %r" % to_dir)
1057
mutter("rename_one:")
1058
mutter(" file_id {%s}" % file_id)
1059
mutter(" from_rel %r" % from_rel)
1060
mutter(" to_rel %r" % to_rel)
1061
mutter(" to_dir %r" % to_dir)
1062
mutter(" to_dir_id {%s}" % to_dir_id)
1064
inv.rename(file_id, to_dir_id, to_tail)
1066
from_abs = self.abspath(from_rel)
1067
to_abs = self.abspath(to_rel)
1069
rename(from_abs, to_abs)
1071
inv.rename(file_id, from_parent, from_name)
1072
raise BzrError("failed to rename %r to %r: %s"
1073
% (from_abs, to_abs, e[1]),
1074
["rename rolled back"])
1075
self._write_inventory(inv)
1079
"""Return all unknown files.
1081
These are files in the working directory that are not versioned or
1082
control files or ignored.
1084
for subp in self.extras():
1085
if not self.is_ignored(subp):
1088
@needs_tree_write_lock
1089
def unversion(self, file_ids):
1090
"""Remove the file ids in file_ids from the current versioned set.
1092
When a file_id is unversioned, all of its children are automatically
1095
:param file_ids: The file ids to stop versioning.
1096
:raises: NoSuchId if any fileid is not currently versioned.
1098
for file_id in file_ids:
1099
if self._inventory.has_id(file_id):
1100
self._inventory.remove_recursive_id(file_id)
1102
raise errors.NoSuchId(self, file_id)
1104
# in the future this should just set a dirty bit to wait for the
1105
# final unlock. However, until all methods of workingtree start
1106
# with the current in -memory inventory rather than triggering
1107
# a read, it is more complex - we need to teach read_inventory
1108
# to know when to read, and when to not read first... and possibly
1109
# to save first when the in memory one may be corrupted.
1110
# so for now, we just only write it if it is indeed dirty.
1112
self._write_inventory(self._inventory)
1114
@deprecated_method(zero_eight)
1115
def iter_conflicts(self):
1116
"""List all files in the tree that have text or content conflicts.
1117
DEPRECATED. Use conflicts instead."""
1118
return self._iter_conflicts()
1120
def _iter_conflicts(self):
1122
for info in self.list_files():
1124
stem = get_conflicted_stem(path)
1127
if stem not in conflicted:
1128
conflicted.add(stem)
1132
def pull(self, source, overwrite=False, stop_revision=None):
1133
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1136
pp = ProgressPhase("Pull phase", 2, top_pb)
1138
old_revision_history = self.branch.revision_history()
1139
basis_tree = self.basis_tree()
1140
count = self.branch.pull(source, overwrite, stop_revision)
1141
new_revision_history = self.branch.revision_history()
1142
if new_revision_history != old_revision_history:
1144
if len(old_revision_history):
1145
other_revision = old_revision_history[-1]
1147
other_revision = None
1148
repository = self.branch.repository
1149
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1151
new_basis_tree = self.branch.basis_tree()
1152
merge_inner(self.branch,
1157
if (basis_tree.inventory.root is None and
1158
new_basis_tree.inventory.root is not None):
1159
self.set_root_id(new_basis_tree.inventory.root.file_id)
1162
# TODO - dedup parents list with things merged by pull ?
1163
# reuse the revisiontree we merged against to set the new
1165
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1166
# we have to pull the merge trees out again, because
1167
# merge_inner has set the ids. - this corner is not yet
1168
# layered well enough to prevent double handling.
1169
merges = self.get_parent_ids()[1:]
1170
parent_trees.extend([
1171
(parent, repository.revision_tree(parent)) for
1173
self.set_parent_trees(parent_trees)
1180
def put_file_bytes_non_atomic(self, file_id, bytes):
1181
"""See MutableTree.put_file_bytes_non_atomic."""
1182
stream = file(self.id2abspath(file_id), 'wb')
1187
# TODO: update the hashcache here ?
1190
"""Yield all unknown files in this WorkingTree.
1192
If there are any unknown directories then only the directory is
1193
returned, not all its children. But if there are unknown files
1194
under a versioned subdirectory, they are returned.
1196
Currently returned depth-first, sorted by name within directories.
1198
## TODO: Work from given directory downwards
1199
for path, dir_entry in self.inventory.directories():
1200
# mutter("search for unknowns in %r", path)
1201
dirabs = self.abspath(path)
1202
if not isdir(dirabs):
1203
# e.g. directory deleted
1207
for subf in os.listdir(dirabs):
1210
if subf not in dir_entry.children:
1211
subf_norm, can_access = osutils.normalized_filename(subf)
1212
if subf_norm != subf and can_access:
1213
if subf_norm not in dir_entry.children:
1214
fl.append(subf_norm)
1220
subp = pathjoin(path, subf)
1223
def _translate_ignore_rule(self, rule):
1224
"""Translate a single ignore rule to a regex.
1226
There are two types of ignore rules. Those that do not contain a / are
1227
matched against the tail of the filename (that is, they do not care
1228
what directory the file is in.) Rules which do contain a slash must
1229
match the entire path. As a special case, './' at the start of the
1230
string counts as a slash in the string but is removed before matching
1231
(e.g. ./foo.c, ./src/foo.c)
1233
:return: The translated regex.
1235
if rule[:2] in ('./', '.\\'):
1237
result = fnmatch.translate(rule[2:])
1238
elif '/' in rule or '\\' in rule:
1240
result = fnmatch.translate(rule)
1242
# default rule style.
1243
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1244
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1245
return "(" + result + ")"
1247
def _combine_ignore_rules(self, rules):
1248
"""Combine a list of ignore rules into a single regex object.
1250
Each individual rule is combined with | to form a big regex, which then
1251
has $ added to it to form something like ()|()|()$. The group index for
1252
each subregex's outermost group is placed in a dictionary mapping back
1253
to the rule. This allows quick identification of the matching rule that
1255
:return: a list of the compiled regex and the matching-group index
1256
dictionaries. We return a list because python complains if you try to
1257
combine more than 100 regexes.
1262
translated_rules = []
1264
translated_rule = self._translate_ignore_rule(rule)
1265
compiled_rule = re.compile(translated_rule)
1266
groups[next_group] = rule
1267
next_group += compiled_rule.groups
1268
translated_rules.append(translated_rule)
1269
if next_group == 99:
1270
result.append((re.compile("|".join(translated_rules)), groups))
1273
translated_rules = []
1274
if len(translated_rules):
1275
result.append((re.compile("|".join(translated_rules)), groups))
1278
def ignored_files(self):
1279
"""Yield list of PATH, IGNORE_PATTERN"""
1280
for subp in self.extras():
1281
pat = self.is_ignored(subp)
1285
def get_ignore_list(self):
1286
"""Return list of ignore patterns.
1288
Cached in the Tree object after the first call.
1290
ignoreset = getattr(self, '_ignoreset', None)
1291
if ignoreset is not None:
1294
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1295
ignore_globs.update(ignores.get_runtime_ignores())
1297
ignore_globs.update(ignores.get_user_ignores())
1299
if self.has_filename(bzrlib.IGNORE_FILENAME):
1300
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1302
ignore_globs.update(ignores.parse_ignore_file(f))
1306
self._ignoreset = ignore_globs
1307
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1310
def _get_ignore_rules_as_regex(self):
1311
"""Return a regex of the ignore rules and a mapping dict.
1313
:return: (ignore rules compiled regex, dictionary mapping rule group
1314
indices to original rule.)
1316
if getattr(self, '_ignoreset', None) is None:
1317
self.get_ignore_list()
1318
return self._ignore_regex
1320
def is_ignored(self, filename):
1321
r"""Check whether the filename matches an ignore pattern.
1323
Patterns containing '/' or '\' need to match the whole path;
1324
others match against only the last component.
1326
If the file is ignored, returns the pattern which caused it to
1327
be ignored, otherwise None. So this can simply be used as a
1328
boolean if desired."""
1330
# TODO: Use '**' to match directories, and other extended
1331
# globbing stuff from cvs/rsync.
1333
# XXX: fnmatch is actually not quite what we want: it's only
1334
# approximately the same as real Unix fnmatch, and doesn't
1335
# treat dotfiles correctly and allows * to match /.
1336
# Eventually it should be replaced with something more
1339
rules = self._get_ignore_rules_as_regex()
1340
for regex, mapping in rules:
1341
match = regex.match(filename)
1342
if match is not None:
1343
# one or more of the groups in mapping will have a non-None
1345
groups = match.groups()
1346
rules = [mapping[group] for group in
1347
mapping if groups[group] is not None]
1351
def kind(self, file_id):
1352
return file_kind(self.id2abspath(file_id))
1354
def last_revision(self):
1355
"""Return the last revision of the branch for this tree.
1357
This format tree does not support a separate marker for last-revision
1358
compared to the branch.
1360
See MutableTree.last_revision
1362
return self._last_revision()
1365
def _last_revision(self):
1366
"""helper for get_parent_ids."""
1367
return self.branch.last_revision()
1369
def is_locked(self):
1370
return self._control_files.is_locked()
1372
def lock_read(self):
1373
"""See Branch.lock_read, and WorkingTree.unlock."""
1374
self.branch.lock_read()
1376
return self._control_files.lock_read()
1378
self.branch.unlock()
1381
def lock_tree_write(self):
1382
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1383
self.branch.lock_read()
1385
return self._control_files.lock_write()
1387
self.branch.unlock()
1390
def lock_write(self):
1391
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1392
self.branch.lock_write()
1394
return self._control_files.lock_write()
1396
self.branch.unlock()
1399
def get_physical_lock_status(self):
1400
return self._control_files.get_physical_lock_status()
1402
def _basis_inventory_name(self):
1403
return 'basis-inventory-cache'
1405
@needs_tree_write_lock
1406
def set_last_revision(self, new_revision):
1407
"""Change the last revision in the working tree."""
1408
if self._change_last_revision(new_revision):
1409
self._cache_basis_inventory(new_revision)
1411
def _change_last_revision(self, new_revision):
1412
"""Template method part of set_last_revision to perform the change.
1414
This is used to allow WorkingTree3 instances to not affect branch
1415
when their last revision is set.
1417
if new_revision is None:
1418
self.branch.set_revision_history([])
1421
self.branch.generate_revision_history(new_revision)
1422
except errors.NoSuchRevision:
1423
# not present in the repo - dont try to set it deeper than the tip
1424
self.branch.set_revision_history([new_revision])
1427
def _write_basis_inventory(self, xml):
1428
"""Write the basis inventory XML to the basis-inventory file"""
1429
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1430
path = self._basis_inventory_name()
1432
self._control_files.put(path, sio)
1434
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1435
"""Create the text that will be saved in basis-inventory"""
1436
inventory.revision_id = revision_id
1437
return bzrlib.xml6.serializer_v6.write_inventory_to_string(inventory)
1439
def _cache_basis_inventory(self, new_revision):
1440
"""Cache new_revision as the basis inventory."""
1441
# TODO: this should allow the ready-to-use inventory to be passed in,
1442
# as commit already has that ready-to-use [while the format is the
1445
# this double handles the inventory - unpack and repack -
1446
# but is easier to understand. We can/should put a conditional
1447
# in here based on whether the inventory is in the latest format
1448
# - perhaps we should repack all inventories on a repository
1450
# the fast path is to copy the raw xml from the repository. If the
1451
# xml contains 'revision_id="', then we assume the right
1452
# revision_id is set. We must check for this full string, because a
1453
# root node id can legitimately look like 'revision_id' but cannot
1455
xml = self.branch.repository.get_inventory_xml(new_revision)
1456
firstline = xml.split('\n', 1)[0]
1457
if (not 'revision_id="' in firstline or
1458
'format="6"' not in firstline):
1459
inv = self.branch.repository.deserialise_inventory(
1461
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1462
self._write_basis_inventory(xml)
1463
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1466
def read_basis_inventory(self):
1467
"""Read the cached basis inventory."""
1468
path = self._basis_inventory_name()
1469
return self._control_files.get(path).read()
1472
def read_working_inventory(self):
1473
"""Read the working inventory."""
1474
# ElementTree does its own conversion from UTF-8, so open in
1476
result = bzrlib.xml5.serializer_v5.read_inventory(
1477
self._control_files.get('inventory'))
1478
self._set_inventory(result)
1481
@needs_tree_write_lock
1482
def remove(self, files, verbose=False, to_file=None):
1483
"""Remove nominated files from the working inventory..
1485
This does not remove their text. This does not run on XXX on what? RBC
1487
TODO: Refuse to remove modified files unless --force is given?
1489
TODO: Do something useful with directories.
1491
TODO: Should this remove the text or not? Tough call; not
1492
removing may be useful and the user can just use use rm, and
1493
is the opposite of add. Removing it is consistent with most
1494
other tools. Maybe an option.
1496
## TODO: Normalize names
1497
## TODO: Remove nested loops; better scalability
1498
if isinstance(files, basestring):
1501
inv = self.inventory
1503
# do this before any modifications
1505
fid = inv.path2id(f)
1507
# TODO: Perhaps make this just a warning, and continue?
1508
# This tends to happen when
1509
raise NotVersionedError(path=f)
1511
# having remove it, it must be either ignored or unknown
1512
if self.is_ignored(f):
1516
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1519
self._write_inventory(inv)
1521
@needs_tree_write_lock
1522
def revert(self, filenames, old_tree=None, backups=True,
1523
pb=DummyProgress()):
1524
from transform import revert
1525
from conflicts import resolve
1526
if old_tree is None:
1527
old_tree = self.basis_tree()
1528
conflicts = revert(self, old_tree, filenames, backups, pb)
1529
if not len(filenames):
1530
self.set_parent_ids(self.get_parent_ids()[:1])
1533
resolve(self, filenames, ignore_misses=True)
1536
# XXX: This method should be deprecated in favour of taking in a proper
1537
# new Inventory object.
1538
@needs_tree_write_lock
1539
def set_inventory(self, new_inventory_list):
1540
from bzrlib.inventory import (Inventory,
1545
inv = Inventory(self.get_root_id())
1546
for path, file_id, parent, kind in new_inventory_list:
1547
name = os.path.basename(path)
1550
# fixme, there should be a factory function inv,add_??
1551
if kind == 'directory':
1552
inv.add(InventoryDirectory(file_id, name, parent))
1553
elif kind == 'file':
1554
inv.add(InventoryFile(file_id, name, parent))
1555
elif kind == 'symlink':
1556
inv.add(InventoryLink(file_id, name, parent))
1558
raise BzrError("unknown kind %r" % kind)
1559
self._write_inventory(inv)
1561
@needs_tree_write_lock
1562
def set_root_id(self, file_id):
1563
"""Set the root id for this tree."""
1564
inv = self.read_working_inventory()
1565
orig_root_id = inv.root.file_id
1566
del inv._byid[inv.root.file_id]
1567
inv.root.file_id = file_id
1568
inv._byid[inv.root.file_id] = inv.root
1571
if entry.parent_id == orig_root_id:
1572
entry.parent_id = inv.root.file_id
1573
self._write_inventory(inv)
1576
"""See Branch.unlock.
1578
WorkingTree locking just uses the Branch locking facilities.
1579
This is current because all working trees have an embedded branch
1580
within them. IF in the future, we were to make branch data shareable
1581
between multiple working trees, i.e. via shared storage, then we
1582
would probably want to lock both the local tree, and the branch.
1584
raise NotImplementedError(self.unlock)
1588
"""Update a working tree along its branch.
1590
This will update the branch if its bound too, which means we have
1591
multiple trees involved:
1593
- The new basis tree of the master.
1594
- The old basis tree of the branch.
1595
- The old basis tree of the working tree.
1596
- The current working tree state.
1598
Pathologically, all three may be different, and non-ancestors of each
1599
other. Conceptually we want to:
1601
- Preserve the wt.basis->wt.state changes
1602
- Transform the wt.basis to the new master basis.
1603
- Apply a merge of the old branch basis to get any 'local' changes from
1605
- Restore the wt.basis->wt.state changes.
1607
There isn't a single operation at the moment to do that, so we:
1608
- Merge current state -> basis tree of the master w.r.t. the old tree
1610
- Do a 'normal' merge of the old branch basis if it is relevant.
1612
old_tip = self.branch.update()
1614
# here if old_tip is not None, it is the old tip of the branch before
1615
# it was updated from the master branch. This should become a pending
1616
# merge in the working tree to preserve the user existing work. we
1617
# cant set that until we update the working trees last revision to be
1618
# one from the new branch, because it will just get absorbed by the
1619
# parent de-duplication logic.
1621
# We MUST save it even if an error occurs, because otherwise the users
1622
# local work is unreferenced and will appear to have been lost.
1626
last_rev = self.get_parent_ids()[0]
1629
if last_rev != self.branch.last_revision():
1630
# merge tree state up to new branch tip.
1631
basis = self.basis_tree()
1632
to_tree = self.branch.basis_tree()
1633
if basis.inventory.root is None:
1634
self.set_root_id(to_tree.inventory.root.file_id)
1635
result += merge_inner(self.branch,
1639
# TODO - dedup parents list with things merged by pull ?
1640
# reuse the tree we've updated to to set the basis:
1641
parent_trees = [(self.branch.last_revision(), to_tree)]
1642
merges = self.get_parent_ids()[1:]
1643
# Ideally we ask the tree for the trees here, that way the working
1644
# tree can decide whether to give us teh entire tree or give us a
1645
# lazy initialised tree. dirstate for instance will have the trees
1646
# in ram already, whereas a last-revision + basis-inventory tree
1647
# will not, but also does not need them when setting parents.
1648
for parent in merges:
1649
parent_trees.append(
1650
(parent, self.branch.repository.revision_tree(parent)))
1651
if old_tip is not None:
1652
parent_trees.append(
1653
(old_tip, self.branch.repository.revision_tree(old_tip)))
1654
self.set_parent_trees(parent_trees)
1655
last_rev = parent_trees[0][0]
1657
# the working tree had the same last-revision as the master
1658
# branch did. We may still have pivot local work from the local
1659
# branch into old_tip:
1660
if old_tip is not None:
1661
self.add_parent_tree_id(old_tip)
1662
if old_tip and old_tip != last_rev:
1663
# our last revision was not the prior branch last revision
1664
# and we have converted that last revision to a pending merge.
1665
# base is somewhere between the branch tip now
1666
# and the now pending merge
1667
from bzrlib.revision import common_ancestor
1669
base_rev_id = common_ancestor(self.branch.last_revision(),
1671
self.branch.repository)
1672
except errors.NoCommonAncestor:
1674
base_tree = self.branch.repository.revision_tree(base_rev_id)
1675
other_tree = self.branch.repository.revision_tree(old_tip)
1676
result += merge_inner(self.branch,
1682
@needs_tree_write_lock
1683
def _write_inventory(self, inv):
1684
"""Write inventory as the current inventory."""
1686
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1688
self._control_files.put('inventory', sio)
1689
self._set_inventory(inv)
1690
mutter('wrote working inventory')
1692
def set_conflicts(self, arg):
1693
raise UnsupportedOperation(self.set_conflicts, self)
1695
def add_conflicts(self, arg):
1696
raise UnsupportedOperation(self.add_conflicts, self)
1699
def conflicts(self):
1700
conflicts = ConflictList()
1701
for conflicted in self._iter_conflicts():
1704
if file_kind(self.abspath(conflicted)) != "file":
1706
except errors.NoSuchFile:
1709
for suffix in ('.THIS', '.OTHER'):
1711
kind = file_kind(self.abspath(conflicted+suffix))
1714
except errors.NoSuchFile:
1718
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1719
conflicts.append(Conflict.factory(ctype, path=conflicted,
1720
file_id=self.path2id(conflicted)))
1724
class WorkingTree2(WorkingTree):
1725
"""This is the Format 2 working tree.
1727
This was the first weave based working tree.
1728
- uses os locks for locking.
1729
- uses the branch last-revision.
1732
def lock_tree_write(self):
1733
"""See WorkingTree.lock_tree_write().
1735
In Format2 WorkingTrees we have a single lock for the branch and tree
1736
so lock_tree_write() degrades to lock_write().
1738
self.branch.lock_write()
1740
return self._control_files.lock_write()
1742
self.branch.unlock()
1746
# we share control files:
1747
if self._hashcache.needs_write and self._control_files._lock_count==3:
1748
self._hashcache.write()
1749
# reverse order of locking.
1751
return self._control_files.unlock()
1753
self.branch.unlock()
1756
class WorkingTree3(WorkingTree):
1757
"""This is the Format 3 working tree.
1759
This differs from the base WorkingTree by:
1760
- having its own file lock
1761
- having its own last-revision property.
1763
This is new in bzr 0.8
1767
def _last_revision(self):
1768
"""See Mutable.last_revision."""
1770
return self._control_files.get_utf8('last-revision').read()
1774
def _change_last_revision(self, revision_id):
1775
"""See WorkingTree._change_last_revision."""
1776
if revision_id is None or revision_id == NULL_REVISION:
1778
self._control_files._transport.delete('last-revision')
1779
except errors.NoSuchFile:
1783
self._control_files.put_utf8('last-revision', revision_id)
1786
@needs_tree_write_lock
1787
def set_conflicts(self, conflicts):
1788
self._put_rio('conflicts', conflicts.to_stanzas(),
1791
@needs_tree_write_lock
1792
def add_conflicts(self, new_conflicts):
1793
conflict_set = set(self.conflicts())
1794
conflict_set.update(set(list(new_conflicts)))
1795
self.set_conflicts(ConflictList(sorted(conflict_set,
1796
key=Conflict.sort_key)))
1799
def conflicts(self):
1801
confile = self._control_files.get('conflicts')
1803
return ConflictList()
1805
if confile.next() != CONFLICT_HEADER_1 + '\n':
1806
raise ConflictFormatError()
1807
except StopIteration:
1808
raise ConflictFormatError()
1809
return ConflictList.from_stanzas(RioReader(confile))
1812
if self._hashcache.needs_write and self._control_files._lock_count==1:
1813
self._hashcache.write()
1814
# reverse order of locking.
1816
return self._control_files.unlock()
1818
self.branch.unlock()
1821
def get_conflicted_stem(path):
1822
for suffix in CONFLICT_SUFFIXES:
1823
if path.endswith(suffix):
1824
return path[:-len(suffix)]
1826
@deprecated_function(zero_eight)
1827
def is_control_file(filename):
1828
"""See WorkingTree.is_control_filename(filename)."""
1829
## FIXME: better check
1830
filename = normpath(filename)
1831
while filename != '':
1832
head, tail = os.path.split(filename)
1833
## mutter('check %r for control file' % ((head, tail),))
1836
if filename == head:
1842
class WorkingTreeFormat(object):
1843
"""An encapsulation of the initialization and open routines for a format.
1845
Formats provide three things:
1846
* An initialization routine,
1850
Formats are placed in an dict by their format string for reference
1851
during workingtree opening. Its not required that these be instances, they
1852
can be classes themselves with class methods - it simply depends on
1853
whether state is needed for a given format or not.
1855
Once a format is deprecated, just deprecate the initialize and open
1856
methods on the format class. Do not deprecate the object, as the
1857
object will be created every time regardless.
1860
_default_format = None
1861
"""The default format used for new trees."""
1864
"""The known formats."""
1867
def find_format(klass, a_bzrdir):
1868
"""Return the format for the working tree object in a_bzrdir."""
1870
transport = a_bzrdir.get_workingtree_transport(None)
1871
format_string = transport.get("format").read()
1872
return klass._formats[format_string]
1874
raise errors.NoWorkingTree(base=transport.base)
1876
raise errors.UnknownFormatError(format=format_string)
1879
def get_default_format(klass):
1880
"""Return the current default format."""
1881
return klass._default_format
1883
def get_format_string(self):
1884
"""Return the ASCII format string that identifies this format."""
1885
raise NotImplementedError(self.get_format_string)
1887
def get_format_description(self):
1888
"""Return the short description for this format."""
1889
raise NotImplementedError(self.get_format_description)
1891
def is_supported(self):
1892
"""Is this format supported?
1894
Supported formats can be initialized and opened.
1895
Unsupported formats may not support initialization or committing or
1896
some other features depending on the reason for not being supported.
1901
def register_format(klass, format):
1902
klass._formats[format.get_format_string()] = format
1905
def set_default_format(klass, format):
1906
klass._default_format = format
1909
def unregister_format(klass, format):
1910
assert klass._formats[format.get_format_string()] is format
1911
del klass._formats[format.get_format_string()]
1915
class WorkingTreeFormat2(WorkingTreeFormat):
1916
"""The second working tree format.
1918
This format modified the hash cache from the format 1 hash cache.
1921
def get_format_description(self):
1922
"""See WorkingTreeFormat.get_format_description()."""
1923
return "Working tree format 2"
1925
def stub_initialize_remote(self, control_files):
1926
"""As a special workaround create critical control files for a remote working tree
1928
This ensures that it can later be updated and dealt with locally,
1929
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1930
no working tree. (See bug #43064).
1934
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1936
control_files.put('inventory', sio)
1938
control_files.put_utf8('pending-merges', '')
1941
def initialize(self, a_bzrdir, revision_id=None):
1942
"""See WorkingTreeFormat.initialize()."""
1943
if not isinstance(a_bzrdir.transport, LocalTransport):
1944
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1945
branch = a_bzrdir.open_branch()
1946
if revision_id is not None:
1949
revision_history = branch.revision_history()
1951
position = revision_history.index(revision_id)
1953
raise errors.NoSuchRevision(branch, revision_id)
1954
branch.set_revision_history(revision_history[:position + 1])
1957
revision = branch.last_revision()
1959
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1965
wt.set_last_revision(revision)
1966
basis_tree = wt.basis_tree()
1967
if basis_tree.inventory.root is not None:
1968
inv.root.file_id = basis_tree.inventory.root.file_id
1969
wt._write_inventory(inv)
1970
wt.set_parent_trees([(revision, basis_tree)])
1971
build_tree(basis_tree, wt)
1975
super(WorkingTreeFormat2, self).__init__()
1976
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1978
def open(self, a_bzrdir, _found=False):
1979
"""Return the WorkingTree object for a_bzrdir
1981
_found is a private parameter, do not use it. It is used to indicate
1982
if format probing has already been done.
1985
# we are being called directly and must probe.
1986
raise NotImplementedError
1987
if not isinstance(a_bzrdir.transport, LocalTransport):
1988
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1989
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1995
class WorkingTreeFormat3(WorkingTreeFormat):
1996
"""The second working tree format updated to record a format marker.
1999
- exists within a metadir controlling .bzr
2000
- includes an explicit version marker for the workingtree control
2001
files, separate from the BzrDir format
2002
- modifies the hash cache format
2004
- uses a LockDir to guard access for writes.
2007
def get_format_string(self):
2008
"""See WorkingTreeFormat.get_format_string()."""
2009
return "Bazaar-NG Working Tree format 3"
2011
def get_format_description(self):
2012
"""See WorkingTreeFormat.get_format_description()."""
2013
return "Working tree format 3"
2015
_lock_file_name = 'lock'
2016
_lock_class = LockDir
2018
def _open_control_files(self, a_bzrdir):
2019
transport = a_bzrdir.get_workingtree_transport(None)
2020
return LockableFiles(transport, self._lock_file_name,
2023
def initialize(self, a_bzrdir, revision_id=None):
2024
"""See WorkingTreeFormat.initialize().
2026
revision_id allows creating a working tree at a different
2027
revision than the branch is at.
2029
if not isinstance(a_bzrdir.transport, LocalTransport):
2030
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2031
transport = a_bzrdir.get_workingtree_transport(self)
2032
control_files = self._open_control_files(a_bzrdir)
2033
control_files.create_lock()
2034
control_files.lock_write()
2035
control_files.put_utf8('format', self.get_format_string())
2036
branch = a_bzrdir.open_branch()
2037
if revision_id is None:
2038
revision_id = branch.last_revision()
2039
inv = Inventory(root_id=gen_root_id())
2040
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2046
_control_files=control_files)
2047
wt.lock_tree_write()
2049
wt.set_last_revision(revision_id)
2050
basis_tree = wt.basis_tree()
2051
wt._write_inventory(inv)
2052
wt.set_pending_merges([])
2053
if revision_id == bzrlib.revision.NULL_REVISION:
2054
wt.set_parent_trees([])
2056
wt.set_parent_trees([(revision_id, basis_tree)])
2057
build_tree(basis_tree, wt)
2060
control_files.unlock()
2064
super(WorkingTreeFormat3, self).__init__()
2065
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2067
def open(self, a_bzrdir, _found=False):
2068
"""Return the WorkingTree object for a_bzrdir
2070
_found is a private parameter, do not use it. It is used to indicate
2071
if format probing has already been done.
2074
# we are being called directly and must probe.
2075
raise NotImplementedError
2076
if not isinstance(a_bzrdir.transport, LocalTransport):
2077
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2078
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2080
def _open(self, a_bzrdir, control_files):
2081
"""Open the tree itself.
2083
:param a_bzrdir: the dir for the tree.
2084
:param control_files: the control files for the tree.
2086
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2090
_control_files=control_files)
2093
return self.get_format_string()
2096
# formats which have no format string are not discoverable
2097
# and not independently creatable, so are not registered.
2098
__default_format = WorkingTreeFormat3()
2099
WorkingTreeFormat.register_format(__default_format)
2100
WorkingTreeFormat.set_default_format(__default_format)
2101
_legacy_formats = [WorkingTreeFormat2(),
2105
class WorkingTreeTestProviderAdapter(object):
2106
"""A tool to generate a suite testing multiple workingtree formats at once.
2108
This is done by copying the test once for each transport and injecting
2109
the transport_server, transport_readonly_server, and workingtree_format
2110
classes into each copy. Each copy is also given a new id() to make it
2114
def __init__(self, transport_server, transport_readonly_server, formats):
2115
self._transport_server = transport_server
2116
self._transport_readonly_server = transport_readonly_server
2117
self._formats = formats
2119
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2120
"""Clone test for adaption."""
2121
new_test = deepcopy(test)
2122
new_test.transport_server = self._transport_server
2123
new_test.transport_readonly_server = self._transport_readonly_server
2124
new_test.bzrdir_format = bzrdir_format
2125
new_test.workingtree_format = workingtree_format
2126
def make_new_test_id():
2127
new_id = "%s(%s)" % (test.id(), variation)
2128
return lambda: new_id
2129
new_test.id = make_new_test_id()
2132
def adapt(self, test):
2133
from bzrlib.tests import TestSuite
2134
result = TestSuite()
2135
for workingtree_format, bzrdir_format in self._formats:
2136
new_test = self._clone_test(
2139
workingtree_format, workingtree_format.__class__.__name__)
2140
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
