1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
46
from copy import deepcopy
56
conflicts as _mod_conflicts,
68
from bzrlib.transport import get_transport
72
from bzrlib import symbol_versioning
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
from bzrlib.errors import (BzrCheckError,
77
WeaveRevisionNotPresent,
81
MergeModifiedFormatError,
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
85
from bzrlib.lockable_files import LockableFiles, TransportLock
86
from bzrlib.lockdir import LockDir
87
import bzrlib.mutabletree
88
from bzrlib.mutabletree import needs_tree_write_lock
89
from bzrlib.osutils import (
101
from bzrlib.trace import mutter, note
102
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION
106
import bzrlib.revisiontree
107
from bzrlib.rio import RioReader, rio_file, Stanza
108
from bzrlib.symbol_versioning import (deprecated_passed,
111
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
# the regex removes any weird characters; we don't escape them
121
# but rather just pull them out
122
_gen_file_id_re = re.compile(r'[^\w.]')
123
_gen_id_suffix = None
127
def _next_id_suffix():
128
"""Create a new file id suffix that is reasonably unique.
130
On the first call we combine the current time with 64 bits of randomness
131
to give a highly probably globally unique number. Then each call in the same
132
process adds 1 to a serial number we append to that unique value.
134
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
135
# than having to move the id randomness out of the inner loop like this.
136
# XXX TODO: for the global randomness this uses we should add the thread-id
137
# before the serial #.
138
global _gen_id_suffix, _gen_id_serial
139
if _gen_id_suffix is None:
140
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
142
return _gen_id_suffix + str(_gen_id_serial)
145
def gen_file_id(name):
146
"""Return new file id for the basename 'name'.
148
The uniqueness is supplied from _next_id_suffix.
150
# The real randomness is in the _next_id_suffix, the
151
# rest of the identifier is just to be nice.
153
# 1) Remove non-ascii word characters to keep the ids portable
154
# 2) squash to lowercase, so the file id doesn't have to
155
# be escaped (case insensitive filesystems would bork for ids
156
# that only differred in case without escaping).
157
# 3) truncate the filename to 20 chars. Long filenames also bork on some
159
# 4) Removing starting '.' characters to prevent the file ids from
160
# being considered hidden.
161
ascii_word_only = _gen_file_id_re.sub('', name.lower())
162
short_no_dots = ascii_word_only.lstrip('.')[:20]
163
return short_no_dots + _next_id_suffix()
167
"""Return a new tree-root file id."""
168
return gen_file_id('tree_root')
171
class TreeEntry(object):
172
"""An entry that implements the minimum interface used by commands.
174
This needs further inspection, it may be better to have
175
InventoryEntries without ids - though that seems wrong. For now,
176
this is a parallel hierarchy to InventoryEntry, and needs to become
177
one of several things: decorates to that hierarchy, children of, or
179
Another note is that these objects are currently only used when there is
180
no InventoryEntry available - i.e. for unversioned objects.
181
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
184
def __eq__(self, other):
185
# yes, this us ugly, TODO: best practice __eq__ style.
186
return (isinstance(other, TreeEntry)
187
and other.__class__ == self.__class__)
189
def kind_character(self):
193
class TreeDirectory(TreeEntry):
194
"""See TreeEntry. This is a directory in a working tree."""
196
def __eq__(self, other):
197
return (isinstance(other, TreeDirectory)
198
and other.__class__ == self.__class__)
200
def kind_character(self):
204
class TreeFile(TreeEntry):
205
"""See TreeEntry. This is a regular file in a working tree."""
207
def __eq__(self, other):
208
return (isinstance(other, TreeFile)
209
and other.__class__ == self.__class__)
211
def kind_character(self):
215
class TreeLink(TreeEntry):
216
"""See TreeEntry. This is a symlink in a working tree."""
218
def __eq__(self, other):
219
return (isinstance(other, TreeLink)
220
and other.__class__ == self.__class__)
222
def kind_character(self):
226
class WorkingTree(bzrlib.mutabletree.MutableTree):
227
"""Working copy tree.
229
The inventory is held in the `Branch` working-inventory, and the
230
files are in a directory on disk.
232
It is possible for a `WorkingTree` to have a filename which is
233
not listed in the Inventory and vice versa.
236
def __init__(self, basedir='.',
237
branch=DEPRECATED_PARAMETER,
243
"""Construct a WorkingTree for basedir.
245
If the branch is not supplied, it is opened automatically.
246
If the branch is supplied, it must be the branch for this basedir.
247
(branch.base is not cross checked, because for remote branches that
248
would be meaningless).
250
self._format = _format
251
self.bzrdir = _bzrdir
253
# not created via open etc.
254
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
255
"Please use bzrdir.open_workingtree or WorkingTree.open().",
258
wt = WorkingTree.open(basedir)
259
self._branch = wt.branch
260
self.basedir = wt.basedir
261
self._control_files = wt._control_files
262
self._hashcache = wt._hashcache
263
self._set_inventory(wt._inventory, dirty=False)
264
self._format = wt._format
265
self.bzrdir = wt.bzrdir
266
from bzrlib.hashcache import HashCache
267
from bzrlib.trace import note, mutter
268
assert isinstance(basedir, basestring), \
269
"base directory %r is not a string" % basedir
270
basedir = safe_unicode(basedir)
271
mutter("opening working tree %r", basedir)
272
if deprecated_passed(branch):
274
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
275
" Please use bzrdir.open_workingtree() or"
276
" WorkingTree.open().",
280
self._branch = branch
282
self._branch = self.bzrdir.open_branch()
283
self.basedir = realpath(basedir)
284
# if branch is at our basedir and is a format 6 or less
285
if isinstance(self._format, WorkingTreeFormat2):
286
# share control object
287
self._control_files = self.branch.control_files
289
# assume all other formats have their own control files.
290
assert isinstance(_control_files, LockableFiles), \
291
"_control_files must be a LockableFiles, not %r" \
293
self._control_files = _control_files
294
# update the whole cache up front and write to disk if anything changed;
295
# in the future we might want to do this more selectively
296
# two possible ways offer themselves : in self._unlock, write the cache
297
# if needed, or, when the cache sees a change, append it to the hash
298
# cache file, and have the parser take the most recent entry for a
300
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
301
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
303
# is this scan needed ? it makes things kinda slow.
310
if _inventory is None:
311
self._inventory_is_modified = False
312
self.read_working_inventory()
314
# the caller of __init__ has provided an inventory,
315
# we assume they know what they are doing - as its only
316
# the Format factory and creation methods that are
317
# permitted to do this.
318
self._set_inventory(_inventory, dirty=False)
321
fget=lambda self: self._branch,
322
doc="""The branch this WorkingTree is connected to.
324
This cannot be set - it is reflective of the actual disk structure
325
the working tree has been constructed from.
328
def break_lock(self):
329
"""Break a lock if one is present from another instance.
331
Uses the ui factory to ask for confirmation if the lock may be from
334
This will probe the repository for its lock as well.
336
self._control_files.break_lock()
337
self.branch.break_lock()
339
def _set_inventory(self, inv, dirty):
340
"""Set the internal cached inventory.
342
:param inv: The inventory to set.
343
:param dirty: A boolean indicating whether the inventory is the same
344
logical inventory as whats on disk. If True the inventory is not
345
the same and should be written to disk or data will be lost, if
346
False then the inventory is the same as that on disk and any
347
serialisation would be unneeded overhead.
349
assert inv.root is not None
350
self._inventory = inv
351
self._inventory_is_modified = dirty
354
def open(path=None, _unsupported=False):
355
"""Open an existing working tree at path.
359
path = os.path.getcwdu()
360
control = bzrdir.BzrDir.open(path, _unsupported)
361
return control.open_workingtree(_unsupported)
364
def open_containing(path=None):
365
"""Open an existing working tree which has its root about path.
367
This probes for a working tree at path and searches upwards from there.
369
Basically we keep looking up until we find the control directory or
370
run into /. If there isn't one, raises NotBranchError.
371
TODO: give this a new exception.
372
If there is one, it is returned, along with the unused portion of path.
374
:return: The WorkingTree that contains 'path', and the rest of path
377
path = osutils.getcwd()
378
control, relpath = bzrdir.BzrDir.open_containing(path)
380
return control.open_workingtree(), relpath
383
def open_downlevel(path=None):
384
"""Open an unsupported working tree.
386
Only intended for advanced situations like upgrading part of a bzrdir.
388
return WorkingTree.open(path, _unsupported=True)
391
"""Iterate through file_ids for this tree.
393
file_ids are in a WorkingTree if they are in the working inventory
394
and the working file exists.
396
inv = self._inventory
397
for path, ie in inv.iter_entries():
398
if osutils.lexists(self.abspath(path)):
402
return "<%s of %s>" % (self.__class__.__name__,
403
getattr(self, 'basedir', None))
405
def abspath(self, filename):
406
return pathjoin(self.basedir, filename)
408
def basis_tree(self):
409
"""Return RevisionTree for the current last revision.
411
If the left most parent is a ghost then the returned tree will be an
412
empty tree - one obtained by calling repository.revision_tree(None).
415
revision_id = self.get_parent_ids()[0]
417
# no parents, return an empty revision tree.
418
# in the future this should return the tree for
419
# 'empty:' - the implicit root empty tree.
420
return self.branch.repository.revision_tree(None)
423
xml = self.read_basis_inventory()
424
inv = xml6.serializer_v6.read_inventory_from_string(xml)
425
if inv is not None and inv.revision_id == revision_id:
426
return bzrlib.revisiontree.RevisionTree(
427
self.branch.repository, inv, revision_id)
428
except (NoSuchFile, errors.BadInventoryFormat):
430
# No cached copy available, retrieve from the repository.
431
# FIXME? RBC 20060403 should we cache the inventory locally
434
return self.branch.repository.revision_tree(revision_id)
435
except errors.RevisionNotPresent:
436
# the basis tree *may* be a ghost or a low level error may have
437
# occured. If the revision is present, its a problem, if its not
439
if self.branch.repository.has_revision(revision_id):
441
# the basis tree is a ghost so return an empty tree.
442
return self.branch.repository.revision_tree(None)
445
@deprecated_method(zero_eight)
446
def create(branch, directory):
447
"""Create a workingtree for branch at directory.
449
If existing_directory already exists it must have a .bzr directory.
450
If it does not exist, it will be created.
452
This returns a new WorkingTree object for the new checkout.
454
TODO FIXME RBC 20060124 when we have checkout formats in place this
455
should accept an optional revisionid to checkout [and reject this if
456
checking out into the same dir as a pre-checkout-aware branch format.]
458
XXX: When BzrDir is present, these should be created through that
461
warnings.warn('delete WorkingTree.create', stacklevel=3)
462
transport = get_transport(directory)
463
if branch.bzrdir.root_transport.base == transport.base:
465
return branch.bzrdir.create_workingtree()
466
# different directory,
467
# create a branch reference
468
# and now a working tree.
469
raise NotImplementedError
472
@deprecated_method(zero_eight)
473
def create_standalone(directory):
474
"""Create a checkout and a branch and a repo at directory.
476
Directory must exist and be empty.
478
please use BzrDir.create_standalone_workingtree
480
return bzrdir.BzrDir.create_standalone_workingtree(directory)
482
def relpath(self, path):
483
"""Return the local path portion from a given path.
485
The path may be absolute or relative. If its a relative path it is
486
interpreted relative to the python current working directory.
488
return osutils.relpath(self.basedir, path)
490
def has_filename(self, filename):
491
return osutils.lexists(self.abspath(filename))
493
def get_file(self, file_id):
494
return self.get_file_byname(self.id2path(file_id))
496
def get_file_text(self, file_id):
497
return self.get_file(file_id).read()
499
def get_file_byname(self, filename):
500
return file(self.abspath(filename), 'rb')
502
def get_parent_ids(self):
503
"""See Tree.get_parent_ids.
505
This implementation reads the pending merges list and last_revision
506
value and uses that to decide what the parents list should be.
508
last_rev = self._last_revision()
514
merges_file = self._control_files.get_utf8('pending-merges')
518
for l in merges_file.readlines():
519
parents.append(l.rstrip('\n'))
523
def get_root_id(self):
524
"""Return the id of this trees root"""
525
return self._inventory.root.file_id
527
def _get_store_filename(self, file_id):
528
## XXX: badly named; this is not in the store at all
529
return self.abspath(self.id2path(file_id))
532
def clone(self, to_bzrdir, revision_id=None, basis=None):
533
"""Duplicate this working tree into to_bzr, including all state.
535
Specifically modified files are kept as modified, but
536
ignored and unknown files are discarded.
538
If you want to make a new line of development, see bzrdir.sprout()
541
If not None, the cloned tree will have its last revision set to
542
revision, and and difference between the source trees last revision
543
and this one merged in.
546
If not None, a closer copy of a tree which may have some files in
547
common, and which file content should be preferentially copied from.
549
# assumes the target bzr dir format is compatible.
550
result = self._format.initialize(to_bzrdir)
551
self.copy_content_into(result, revision_id)
555
def copy_content_into(self, tree, revision_id=None):
556
"""Copy the current content and user files of this tree into tree."""
557
tree.set_root_id(self.get_root_id())
558
if revision_id is None:
559
merge.transform_tree(tree, self)
561
# TODO now merge from tree.last_revision to revision (to preserve
562
# user local changes)
563
merge.transform_tree(tree, self)
564
tree.set_parent_ids([revision_id])
566
def id2abspath(self, file_id):
567
return self.abspath(self.id2path(file_id))
569
def has_id(self, file_id):
570
# files that have been deleted are excluded
571
inv = self._inventory
572
if not inv.has_id(file_id):
574
path = inv.id2path(file_id)
575
return osutils.lexists(self.abspath(path))
577
def has_or_had_id(self, file_id):
578
if file_id == self.inventory.root.file_id:
580
return self.inventory.has_id(file_id)
582
__contains__ = has_id
584
def get_file_size(self, file_id):
585
return os.path.getsize(self.id2abspath(file_id))
588
def get_file_sha1(self, file_id, path=None):
590
path = self._inventory.id2path(file_id)
591
return self._hashcache.get_sha1(path)
593
def get_file_mtime(self, file_id, path=None):
595
path = self._inventory.id2path(file_id)
596
return os.lstat(self.abspath(path)).st_mtime
598
if not supports_executable():
599
def is_executable(self, file_id, path=None):
600
return self._inventory[file_id].executable
602
def is_executable(self, file_id, path=None):
604
path = self._inventory.id2path(file_id)
605
mode = os.lstat(self.abspath(path)).st_mode
606
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
609
def _add(self, files, ids, kinds):
610
"""See MutableTree._add."""
611
# TODO: Re-adding a file that is removed in the working copy
612
# should probably put it back with the previous ID.
613
# the read and write working inventory should not occur in this
614
# function - they should be part of lock_write and unlock.
615
inv = self.read_working_inventory()
616
for f, file_id, kind in zip(files, ids, kinds):
617
assert kind is not None
619
inv.add_path(f, kind=kind)
621
inv.add_path(f, kind=kind, file_id=file_id)
622
self._write_inventory(inv)
624
@needs_tree_write_lock
625
def _gather_kinds(self, files, kinds):
626
"""See MutableTree._gather_kinds."""
627
for pos, f in enumerate(files):
628
if kinds[pos] is None:
629
fullpath = normpath(self.abspath(f))
631
kinds[pos] = file_kind(fullpath)
633
if e.errno == errno.ENOENT:
634
raise NoSuchFile(fullpath)
637
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
638
"""Add revision_id as a parent.
640
This is equivalent to retrieving the current list of parent ids
641
and setting the list to its value plus revision_id.
643
:param revision_id: The revision id to add to the parent list. It may
644
be a ghost revision as long as its not the first parent to be added,
645
or the allow_leftmost_as_ghost parameter is set True.
646
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
648
parents = self.get_parent_ids() + [revision_id]
649
self.set_parent_ids(parents,
650
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
652
@needs_tree_write_lock
653
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
654
"""Add revision_id, tree tuple as a parent.
656
This is equivalent to retrieving the current list of parent trees
657
and setting the list to its value plus parent_tuple. See also
658
add_parent_tree_id - if you only have a parent id available it will be
659
simpler to use that api. If you have the parent already available, using
660
this api is preferred.
662
:param parent_tuple: The (revision id, tree) to add to the parent list.
663
If the revision_id is a ghost, pass None for the tree.
664
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
666
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
667
if len(parent_ids) > 1:
668
# the leftmost may have already been a ghost, preserve that if it
670
allow_leftmost_as_ghost = True
671
self.set_parent_ids(parent_ids,
672
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
674
@needs_tree_write_lock
675
def add_pending_merge(self, *revision_ids):
676
# TODO: Perhaps should check at this point that the
677
# history of the revision is actually present?
678
parents = self.get_parent_ids()
680
for rev_id in revision_ids:
681
if rev_id in parents:
683
parents.append(rev_id)
686
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
688
@deprecated_method(zero_eleven)
690
def pending_merges(self):
691
"""Return a list of pending merges.
693
These are revisions that have been merged into the working
694
directory but not yet committed.
696
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
697
instead - which is available on all tree objects.
699
return self.get_parent_ids()[1:]
701
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
702
"""Common ghost checking functionality from set_parent_*.
704
This checks that the left hand-parent exists if there are any
707
if len(revision_ids) > 0:
708
leftmost_id = revision_ids[0]
709
if (not allow_leftmost_as_ghost and not
710
self.branch.repository.has_revision(leftmost_id)):
711
raise errors.GhostRevisionUnusableHere(leftmost_id)
713
def _set_merges_from_parent_ids(self, parent_ids):
714
merges = parent_ids[1:]
715
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
717
@needs_tree_write_lock
718
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
719
"""Set the parent ids to revision_ids.
721
See also set_parent_trees. This api will try to retrieve the tree data
722
for each element of revision_ids from the trees repository. If you have
723
tree data already available, it is more efficient to use
724
set_parent_trees rather than set_parent_ids. set_parent_ids is however
725
an easier API to use.
727
:param revision_ids: The revision_ids to set as the parent ids of this
728
working tree. Any of these may be ghosts.
730
self._check_parents_for_ghosts(revision_ids,
731
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
733
if len(revision_ids) > 0:
734
self.set_last_revision(revision_ids[0])
736
self.set_last_revision(None)
738
self._set_merges_from_parent_ids(revision_ids)
740
@needs_tree_write_lock
741
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
742
"""See MutableTree.set_parent_trees."""
743
parent_ids = [rev for (rev, tree) in parents_list]
745
self._check_parents_for_ghosts(parent_ids,
746
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
748
if len(parent_ids) == 0:
749
leftmost_parent_id = None
750
leftmost_parent_tree = None
752
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
754
if self._change_last_revision(leftmost_parent_id):
755
if leftmost_parent_tree is None:
756
# If we don't have a tree, fall back to reading the
757
# parent tree from the repository.
758
self._cache_basis_inventory(leftmost_parent_id)
760
inv = leftmost_parent_tree.inventory
761
xml = self._create_basis_xml_from_inventory(
762
leftmost_parent_id, inv)
763
self._write_basis_inventory(xml)
764
self._set_merges_from_parent_ids(parent_ids)
766
@needs_tree_write_lock
767
def set_pending_merges(self, rev_list):
768
parents = self.get_parent_ids()
769
leftmost = parents[:1]
770
new_parents = leftmost + rev_list
771
self.set_parent_ids(new_parents)
773
@needs_tree_write_lock
774
def set_merge_modified(self, modified_hashes):
776
for file_id, hash in modified_hashes.iteritems():
777
yield Stanza(file_id=file_id, hash=hash)
778
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
780
@needs_tree_write_lock
781
def _put_rio(self, filename, stanzas, header):
782
my_file = rio_file(stanzas, header)
783
self._control_files.put(filename, my_file)
785
@needs_write_lock # because merge pulls data into the branch.
786
def merge_from_branch(self, branch, to_revision=None):
787
"""Merge from a branch into this working tree.
789
:param branch: The branch to merge from.
790
:param to_revision: If non-None, the merge will merge to to_revision, but
791
not beyond it. to_revision does not need to be in the history of
792
the branch when it is supplied. If None, to_revision defaults to
793
branch.last_revision().
795
from bzrlib.merge import Merger, Merge3Merger
796
pb = bzrlib.ui.ui_factory.nested_progress_bar()
798
merger = Merger(self.branch, this_tree=self, pb=pb)
799
merger.pp = ProgressPhase("Merge phase", 5, pb)
800
merger.pp.next_phase()
801
# check that there are no
803
merger.check_basis(check_clean=True, require_commits=False)
804
if to_revision is None:
805
to_revision = branch.last_revision()
806
merger.other_rev_id = to_revision
807
if merger.other_rev_id is None:
808
raise error.NoCommits(branch)
809
self.branch.fetch(branch, last_revision=merger.other_rev_id)
810
merger.other_basis = merger.other_rev_id
811
merger.other_tree = self.branch.repository.revision_tree(
813
merger.pp.next_phase()
815
if merger.base_rev_id == merger.other_rev_id:
816
raise errors.PointlessMerge
817
merger.backup_files = False
818
merger.merge_type = Merge3Merger
819
merger.set_interesting_files(None)
820
merger.show_base = False
821
merger.reprocess = False
822
conflicts = merger.do_merge()
829
def merge_modified(self):
831
hashfile = self._control_files.get('merge-hashes')
836
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
837
raise MergeModifiedFormatError()
838
except StopIteration:
839
raise MergeModifiedFormatError()
840
for s in RioReader(hashfile):
841
file_id = s.get("file_id")
842
if file_id not in self.inventory:
845
if hash == self.get_file_sha1(file_id):
846
merge_hashes[file_id] = hash
850
def mkdir(self, path, file_id=None):
851
"""See MutableTree.mkdir()."""
853
file_id = gen_file_id(os.path.basename(path))
854
os.mkdir(self.abspath(path))
855
self.add(path, file_id, 'directory')
858
def get_symlink_target(self, file_id):
859
return os.readlink(self.id2abspath(file_id))
861
def file_class(self, filename):
862
if self.path2id(filename):
864
elif self.is_ignored(filename):
870
"""Write the in memory inventory to disk."""
871
# TODO: Maybe this should only write on dirty ?
872
if self._control_files._lock_mode != 'w':
873
raise errors.NotWriteLocked(self)
875
xml5.serializer_v5.write_inventory(self._inventory, sio)
877
self._control_files.put('inventory', sio)
878
self._inventory_is_modified = False
880
def list_files(self, include_root=False):
881
"""Recursively list all files as (path, class, kind, id, entry).
883
Lists, but does not descend into unversioned directories.
885
This does not include files that have been deleted in this
888
Skips the control directory.
890
inv = self._inventory
891
if include_root is True:
892
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
893
# Convert these into local objects to save lookup times
894
pathjoin = osutils.pathjoin
895
file_kind = osutils.file_kind
897
# transport.base ends in a slash, we want the piece
898
# between the last two slashes
899
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
901
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
903
# directory file_id, relative path, absolute path, reverse sorted children
904
children = os.listdir(self.basedir)
906
# jam 20060527 The kernel sized tree seems equivalent whether we
907
# use a deque and popleft to keep them sorted, or if we use a plain
908
# list and just reverse() them.
909
children = collections.deque(children)
910
stack = [(inv.root.file_id, u'', self.basedir, children)]
912
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
915
f = children.popleft()
916
## TODO: If we find a subdirectory with its own .bzr
917
## directory, then that is a separate tree and we
918
## should exclude it.
920
# the bzrdir for this tree
921
if transport_base_dir == f:
924
# we know that from_dir_relpath and from_dir_abspath never end in a slash
925
# and 'f' doesn't begin with one, we can do a string op, rather
926
# than the checks of pathjoin(), all relative paths will have an extra slash
928
fp = from_dir_relpath + '/' + f
931
fap = from_dir_abspath + '/' + f
933
f_ie = inv.get_child(from_dir_id, f)
936
elif self.is_ignored(fp[1:]):
939
# we may not have found this file, because of a unicode issue
940
f_norm, can_access = osutils.normalized_filename(f)
941
if f == f_norm or not can_access:
942
# No change, so treat this file normally
945
# this file can be accessed by a normalized path
946
# check again if it is versioned
947
# these lines are repeated here for performance
949
fp = from_dir_relpath + '/' + f
950
fap = from_dir_abspath + '/' + f
951
f_ie = inv.get_child(from_dir_id, f)
954
elif self.is_ignored(fp[1:]):
963
raise BzrCheckError("file %r entered as kind %r id %r, "
965
% (fap, f_ie.kind, f_ie.file_id, fk))
967
# make a last minute entry
969
yield fp[1:], c, fk, f_ie.file_id, f_ie
972
yield fp[1:], c, fk, None, fk_entries[fk]()
974
yield fp[1:], c, fk, None, TreeEntry()
977
if fk != 'directory':
980
# But do this child first
981
new_children = os.listdir(fap)
983
new_children = collections.deque(new_children)
984
stack.append((f_ie.file_id, fp, fap, new_children))
985
# Break out of inner loop, so that we start outer loop with child
988
# if we finished all children, pop it off the stack
991
@needs_tree_write_lock
992
def move(self, from_paths, to_name):
995
to_name must exist in the inventory.
997
If to_name exists and is a directory, the files are moved into
998
it, keeping their old names.
1000
Note that to_name is only the last component of the new name;
1001
this doesn't change the directory.
1003
This returns a list of (from_path, to_path) pairs for each
1004
entry that is moved.
1007
## TODO: Option to move IDs only
1008
assert not isinstance(from_paths, basestring)
1009
inv = self.inventory
1010
to_abs = self.abspath(to_name)
1011
if not isdir(to_abs):
1012
raise BzrError("destination %r is not a directory" % to_abs)
1013
if not self.has_filename(to_name):
1014
raise BzrError("destination %r not in working directory" % to_abs)
1015
to_dir_id = inv.path2id(to_name)
1016
if to_dir_id is None and to_name != '':
1017
raise BzrError("destination %r is not a versioned directory" % to_name)
1018
to_dir_ie = inv[to_dir_id]
1019
if to_dir_ie.kind != 'directory':
1020
raise BzrError("destination %r is not a directory" % to_abs)
1022
to_idpath = inv.get_idpath(to_dir_id)
1024
for f in from_paths:
1025
if not self.has_filename(f):
1026
raise BzrError("%r does not exist in working tree" % f)
1027
f_id = inv.path2id(f)
1029
raise BzrError("%r is not versioned" % f)
1030
name_tail = splitpath(f)[-1]
1031
dest_path = pathjoin(to_name, name_tail)
1032
if self.has_filename(dest_path):
1033
raise BzrError("destination %r already exists" % dest_path)
1034
if f_id in to_idpath:
1035
raise BzrError("can't move %r to a subdirectory of itself" % f)
1037
# OK, so there's a race here, it's possible that someone will
1038
# create a file in this interval and then the rename might be
1039
# left half-done. But we should have caught most problems.
1040
orig_inv = deepcopy(self.inventory)
1041
original_modified = self._inventory_is_modified
1044
self._inventory_is_modified = True
1045
for f in from_paths:
1046
name_tail = splitpath(f)[-1]
1047
dest_path = pathjoin(to_name, name_tail)
1048
result.append((f, dest_path))
1049
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1051
osutils.rename(self.abspath(f), self.abspath(dest_path))
1053
raise BzrError("failed to rename %r to %r: %s" %
1054
(f, dest_path, e[1]),
1055
["rename rolled back"])
1057
# restore the inventory on error
1058
self._set_inventory(orig_inv, dirty=original_modified)
1060
self._write_inventory(inv)
1063
@needs_tree_write_lock
1064
def rename_one(self, from_rel, to_rel):
1067
This can change the directory or the filename or both.
1069
inv = self.inventory
1070
if not self.has_filename(from_rel):
1071
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1072
if self.has_filename(to_rel):
1073
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1075
file_id = inv.path2id(from_rel)
1077
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1079
entry = inv[file_id]
1080
from_parent = entry.parent_id
1081
from_name = entry.name
1083
if inv.path2id(to_rel):
1084
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1086
to_dir, to_tail = os.path.split(to_rel)
1087
to_dir_id = inv.path2id(to_dir)
1088
if to_dir_id is None and to_dir != '':
1089
raise BzrError("can't determine destination directory id for %r" % to_dir)
1091
mutter("rename_one:")
1092
mutter(" file_id {%s}" % file_id)
1093
mutter(" from_rel %r" % from_rel)
1094
mutter(" to_rel %r" % to_rel)
1095
mutter(" to_dir %r" % to_dir)
1096
mutter(" to_dir_id {%s}" % to_dir_id)
1098
inv.rename(file_id, to_dir_id, to_tail)
1100
from_abs = self.abspath(from_rel)
1101
to_abs = self.abspath(to_rel)
1103
osutils.rename(from_abs, to_abs)
1105
inv.rename(file_id, from_parent, from_name)
1106
raise BzrError("failed to rename %r to %r: %s"
1107
% (from_abs, to_abs, e[1]),
1108
["rename rolled back"])
1109
self._write_inventory(inv)
1113
"""Return all unknown files.
1115
These are files in the working directory that are not versioned or
1116
control files or ignored.
1118
for subp in self.extras():
1119
if not self.is_ignored(subp):
1122
@needs_tree_write_lock
1123
def unversion(self, file_ids):
1124
"""Remove the file ids in file_ids from the current versioned set.
1126
When a file_id is unversioned, all of its children are automatically
1129
:param file_ids: The file ids to stop versioning.
1130
:raises: NoSuchId if any fileid is not currently versioned.
1132
for file_id in file_ids:
1133
if self._inventory.has_id(file_id):
1134
self._inventory.remove_recursive_id(file_id)
1136
raise errors.NoSuchId(self, file_id)
1138
# in the future this should just set a dirty bit to wait for the
1139
# final unlock. However, until all methods of workingtree start
1140
# with the current in -memory inventory rather than triggering
1141
# a read, it is more complex - we need to teach read_inventory
1142
# to know when to read, and when to not read first... and possibly
1143
# to save first when the in memory one may be corrupted.
1144
# so for now, we just only write it if it is indeed dirty.
1146
self._write_inventory(self._inventory)
1148
@deprecated_method(zero_eight)
1149
def iter_conflicts(self):
1150
"""List all files in the tree that have text or content conflicts.
1151
DEPRECATED. Use conflicts instead."""
1152
return self._iter_conflicts()
1154
def _iter_conflicts(self):
1156
for info in self.list_files():
1158
stem = get_conflicted_stem(path)
1161
if stem not in conflicted:
1162
conflicted.add(stem)
1166
def pull(self, source, overwrite=False, stop_revision=None):
1167
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1170
pp = ProgressPhase("Pull phase", 2, top_pb)
1172
old_revision_history = self.branch.revision_history()
1173
basis_tree = self.basis_tree()
1174
count = self.branch.pull(source, overwrite, stop_revision)
1175
new_revision_history = self.branch.revision_history()
1176
if new_revision_history != old_revision_history:
1178
if len(old_revision_history):
1179
other_revision = old_revision_history[-1]
1181
other_revision = None
1182
repository = self.branch.repository
1183
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1185
new_basis_tree = self.branch.basis_tree()
1192
if (basis_tree.inventory.root is None and
1193
new_basis_tree.inventory.root is not None):
1194
self.set_root_id(new_basis_tree.inventory.root.file_id)
1197
# TODO - dedup parents list with things merged by pull ?
1198
# reuse the revisiontree we merged against to set the new
1200
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1201
# we have to pull the merge trees out again, because
1202
# merge_inner has set the ids. - this corner is not yet
1203
# layered well enough to prevent double handling.
1204
merges = self.get_parent_ids()[1:]
1205
parent_trees.extend([
1206
(parent, repository.revision_tree(parent)) for
1208
self.set_parent_trees(parent_trees)
1215
def put_file_bytes_non_atomic(self, file_id, bytes):
1216
"""See MutableTree.put_file_bytes_non_atomic."""
1217
stream = file(self.id2abspath(file_id), 'wb')
1222
# TODO: update the hashcache here ?
1225
"""Yield all unknown files in this WorkingTree.
1227
If there are any unknown directories then only the directory is
1228
returned, not all its children. But if there are unknown files
1229
under a versioned subdirectory, they are returned.
1231
Currently returned depth-first, sorted by name within directories.
1233
## TODO: Work from given directory downwards
1234
for path, dir_entry in self.inventory.directories():
1235
# mutter("search for unknowns in %r", path)
1236
dirabs = self.abspath(path)
1237
if not isdir(dirabs):
1238
# e.g. directory deleted
1242
for subf in os.listdir(dirabs):
1245
if subf not in dir_entry.children:
1246
subf_norm, can_access = osutils.normalized_filename(subf)
1247
if subf_norm != subf and can_access:
1248
if subf_norm not in dir_entry.children:
1249
fl.append(subf_norm)
1255
subp = pathjoin(path, subf)
1258
def _translate_ignore_rule(self, rule):
1259
"""Translate a single ignore rule to a regex.
1261
There are two types of ignore rules. Those that do not contain a / are
1262
matched against the tail of the filename (that is, they do not care
1263
what directory the file is in.) Rules which do contain a slash must
1264
match the entire path. As a special case, './' at the start of the
1265
string counts as a slash in the string but is removed before matching
1266
(e.g. ./foo.c, ./src/foo.c)
1268
:return: The translated regex.
1270
if rule[:2] in ('./', '.\\'):
1272
result = fnmatch.translate(rule[2:])
1273
elif '/' in rule or '\\' in rule:
1275
result = fnmatch.translate(rule)
1277
# default rule style.
1278
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1279
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1280
return "(" + result + ")"
1282
def _combine_ignore_rules(self, rules):
1283
"""Combine a list of ignore rules into a single regex object.
1285
Each individual rule is combined with | to form a big regex, which then
1286
has $ added to it to form something like ()|()|()$. The group index for
1287
each subregex's outermost group is placed in a dictionary mapping back
1288
to the rule. This allows quick identification of the matching rule that
1290
:return: a list of the compiled regex and the matching-group index
1291
dictionaries. We return a list because python complains if you try to
1292
combine more than 100 regexes.
1297
translated_rules = []
1299
translated_rule = self._translate_ignore_rule(rule)
1300
compiled_rule = re.compile(translated_rule)
1301
groups[next_group] = rule
1302
next_group += compiled_rule.groups
1303
translated_rules.append(translated_rule)
1304
if next_group == 99:
1305
result.append((re.compile("|".join(translated_rules)), groups))
1308
translated_rules = []
1309
if len(translated_rules):
1310
result.append((re.compile("|".join(translated_rules)), groups))
1313
def ignored_files(self):
1314
"""Yield list of PATH, IGNORE_PATTERN"""
1315
for subp in self.extras():
1316
pat = self.is_ignored(subp)
1320
def get_ignore_list(self):
1321
"""Return list of ignore patterns.
1323
Cached in the Tree object after the first call.
1325
ignoreset = getattr(self, '_ignoreset', None)
1326
if ignoreset is not None:
1329
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1330
ignore_globs.update(ignores.get_runtime_ignores())
1332
ignore_globs.update(ignores.get_user_ignores())
1334
if self.has_filename(bzrlib.IGNORE_FILENAME):
1335
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1337
ignore_globs.update(ignores.parse_ignore_file(f))
1341
self._ignoreset = ignore_globs
1342
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1345
def _get_ignore_rules_as_regex(self):
1346
"""Return a regex of the ignore rules and a mapping dict.
1348
:return: (ignore rules compiled regex, dictionary mapping rule group
1349
indices to original rule.)
1351
if getattr(self, '_ignoreset', None) is None:
1352
self.get_ignore_list()
1353
return self._ignore_regex
1355
def is_ignored(self, filename):
1356
r"""Check whether the filename matches an ignore pattern.
1358
Patterns containing '/' or '\' need to match the whole path;
1359
others match against only the last component.
1361
If the file is ignored, returns the pattern which caused it to
1362
be ignored, otherwise None. So this can simply be used as a
1363
boolean if desired."""
1365
# TODO: Use '**' to match directories, and other extended
1366
# globbing stuff from cvs/rsync.
1368
# XXX: fnmatch is actually not quite what we want: it's only
1369
# approximately the same as real Unix fnmatch, and doesn't
1370
# treat dotfiles correctly and allows * to match /.
1371
# Eventually it should be replaced with something more
1374
rules = self._get_ignore_rules_as_regex()
1375
for regex, mapping in rules:
1376
match = regex.match(filename)
1377
if match is not None:
1378
# one or more of the groups in mapping will have a non-None
1380
groups = match.groups()
1381
rules = [mapping[group] for group in
1382
mapping if groups[group] is not None]
1386
def kind(self, file_id):
1387
return file_kind(self.id2abspath(file_id))
1389
def last_revision(self):
1390
"""Return the last revision of the branch for this tree.
1392
This format tree does not support a separate marker for last-revision
1393
compared to the branch.
1395
See MutableTree.last_revision
1397
return self._last_revision()
1400
def _last_revision(self):
1401
"""helper for get_parent_ids."""
1402
return self.branch.last_revision()
1404
def is_locked(self):
1405
return self._control_files.is_locked()
1407
def lock_read(self):
1408
"""See Branch.lock_read, and WorkingTree.unlock."""
1409
self.branch.lock_read()
1411
return self._control_files.lock_read()
1413
self.branch.unlock()
1416
def lock_tree_write(self):
1417
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1418
self.branch.lock_read()
1420
return self._control_files.lock_write()
1422
self.branch.unlock()
1425
def lock_write(self):
1426
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1427
self.branch.lock_write()
1429
return self._control_files.lock_write()
1431
self.branch.unlock()
1434
def get_physical_lock_status(self):
1435
return self._control_files.get_physical_lock_status()
1437
def _basis_inventory_name(self):
1438
return 'basis-inventory-cache'
1440
@needs_tree_write_lock
1441
def set_last_revision(self, new_revision):
1442
"""Change the last revision in the working tree."""
1443
if self._change_last_revision(new_revision):
1444
self._cache_basis_inventory(new_revision)
1446
def _change_last_revision(self, new_revision):
1447
"""Template method part of set_last_revision to perform the change.
1449
This is used to allow WorkingTree3 instances to not affect branch
1450
when their last revision is set.
1452
if new_revision is None:
1453
self.branch.set_revision_history([])
1456
self.branch.generate_revision_history(new_revision)
1457
except errors.NoSuchRevision:
1458
# not present in the repo - dont try to set it deeper than the tip
1459
self.branch.set_revision_history([new_revision])
1462
def _write_basis_inventory(self, xml):
1463
"""Write the basis inventory XML to the basis-inventory file"""
1464
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1465
path = self._basis_inventory_name()
1467
self._control_files.put(path, sio)
1469
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1470
"""Create the text that will be saved in basis-inventory"""
1471
inventory.revision_id = revision_id
1472
return xml6.serializer_v6.write_inventory_to_string(inventory)
1474
def _cache_basis_inventory(self, new_revision):
1475
"""Cache new_revision as the basis inventory."""
1476
# TODO: this should allow the ready-to-use inventory to be passed in,
1477
# as commit already has that ready-to-use [while the format is the
1480
# this double handles the inventory - unpack and repack -
1481
# but is easier to understand. We can/should put a conditional
1482
# in here based on whether the inventory is in the latest format
1483
# - perhaps we should repack all inventories on a repository
1485
# the fast path is to copy the raw xml from the repository. If the
1486
# xml contains 'revision_id="', then we assume the right
1487
# revision_id is set. We must check for this full string, because a
1488
# root node id can legitimately look like 'revision_id' but cannot
1490
xml = self.branch.repository.get_inventory_xml(new_revision)
1491
firstline = xml.split('\n', 1)[0]
1492
if (not 'revision_id="' in firstline or
1493
'format="6"' not in firstline):
1494
inv = self.branch.repository.deserialise_inventory(
1496
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1497
self._write_basis_inventory(xml)
1498
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1501
def read_basis_inventory(self):
1502
"""Read the cached basis inventory."""
1503
path = self._basis_inventory_name()
1504
return self._control_files.get(path).read()
1507
def read_working_inventory(self):
1508
"""Read the working inventory.
1510
:raises errors.InventoryModified: read_working_inventory will fail
1511
when the current in memory inventory has been modified.
1513
# conceptually this should be an implementation detail of the tree.
1514
# XXX: Deprecate this.
1515
# ElementTree does its own conversion from UTF-8, so open in
1517
if self._inventory_is_modified:
1518
raise errors.InventoryModified(self)
1519
result = xml5.serializer_v5.read_inventory(
1520
self._control_files.get('inventory'))
1521
self._set_inventory(result, dirty=False)
1524
@needs_tree_write_lock
1525
def remove(self, files, verbose=False, to_file=None):
1526
"""Remove nominated files from the working inventory..
1528
This does not remove their text. This does not run on XXX on what? RBC
1530
TODO: Refuse to remove modified files unless --force is given?
1532
TODO: Do something useful with directories.
1534
TODO: Should this remove the text or not? Tough call; not
1535
removing may be useful and the user can just use use rm, and
1536
is the opposite of add. Removing it is consistent with most
1537
other tools. Maybe an option.
1539
## TODO: Normalize names
1540
## TODO: Remove nested loops; better scalability
1541
if isinstance(files, basestring):
1544
inv = self.inventory
1546
# do this before any modifications
1548
fid = inv.path2id(f)
1550
# TODO: Perhaps make this just a warning, and continue?
1551
# This tends to happen when
1552
raise NotVersionedError(path=f)
1554
# having remove it, it must be either ignored or unknown
1555
if self.is_ignored(f):
1559
textui.show_status(new_status, inv[fid].kind, f,
1563
self._write_inventory(inv)
1565
@needs_tree_write_lock
1566
def revert(self, filenames, old_tree=None, backups=True,
1567
pb=DummyProgress()):
1568
from bzrlib.conflicts import resolve
1569
if old_tree is None:
1570
old_tree = self.basis_tree()
1571
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1572
if not len(filenames):
1573
self.set_parent_ids(self.get_parent_ids()[:1])
1576
resolve(self, filenames, ignore_misses=True)
1579
# XXX: This method should be deprecated in favour of taking in a proper
1580
# new Inventory object.
1581
@needs_tree_write_lock
1582
def set_inventory(self, new_inventory_list):
1583
from bzrlib.inventory import (Inventory,
1588
inv = Inventory(self.get_root_id())
1589
for path, file_id, parent, kind in new_inventory_list:
1590
name = os.path.basename(path)
1593
# fixme, there should be a factory function inv,add_??
1594
if kind == 'directory':
1595
inv.add(InventoryDirectory(file_id, name, parent))
1596
elif kind == 'file':
1597
inv.add(InventoryFile(file_id, name, parent))
1598
elif kind == 'symlink':
1599
inv.add(InventoryLink(file_id, name, parent))
1601
raise BzrError("unknown kind %r" % kind)
1602
self._write_inventory(inv)
1604
@needs_tree_write_lock
1605
def set_root_id(self, file_id):
1606
"""Set the root id for this tree."""
1609
symbol_versioning.warn(symbol_versioning.zero_twelve
1610
% 'WorkingTree.set_root_id with fileid=None',
1614
inv = self._inventory
1615
orig_root_id = inv.root.file_id
1616
# TODO: it might be nice to exit early if there was nothing
1617
# to do, saving us from trigger a sync on unlock.
1618
self._inventory_is_modified = True
1619
# we preserve the root inventory entry object, but
1620
# unlinkit from the byid index
1621
del inv._byid[inv.root.file_id]
1622
inv.root.file_id = file_id
1623
# and link it into the index with the new changed id.
1624
inv._byid[inv.root.file_id] = inv.root
1625
# and finally update all children to reference the new id.
1626
# XXX: this should be safe to just look at the root.children
1627
# list, not the WHOLE INVENTORY.
1630
if entry.parent_id == orig_root_id:
1631
entry.parent_id = inv.root.file_id
1634
"""See Branch.unlock.
1636
WorkingTree locking just uses the Branch locking facilities.
1637
This is current because all working trees have an embedded branch
1638
within them. IF in the future, we were to make branch data shareable
1639
between multiple working trees, i.e. via shared storage, then we
1640
would probably want to lock both the local tree, and the branch.
1642
raise NotImplementedError(self.unlock)
1646
"""Update a working tree along its branch.
1648
This will update the branch if its bound too, which means we have
1649
multiple trees involved:
1651
- The new basis tree of the master.
1652
- The old basis tree of the branch.
1653
- The old basis tree of the working tree.
1654
- The current working tree state.
1656
Pathologically, all three may be different, and non-ancestors of each
1657
other. Conceptually we want to:
1659
- Preserve the wt.basis->wt.state changes
1660
- Transform the wt.basis to the new master basis.
1661
- Apply a merge of the old branch basis to get any 'local' changes from
1663
- Restore the wt.basis->wt.state changes.
1665
There isn't a single operation at the moment to do that, so we:
1666
- Merge current state -> basis tree of the master w.r.t. the old tree
1668
- Do a 'normal' merge of the old branch basis if it is relevant.
1670
old_tip = self.branch.update()
1672
# here if old_tip is not None, it is the old tip of the branch before
1673
# it was updated from the master branch. This should become a pending
1674
# merge in the working tree to preserve the user existing work. we
1675
# cant set that until we update the working trees last revision to be
1676
# one from the new branch, because it will just get absorbed by the
1677
# parent de-duplication logic.
1679
# We MUST save it even if an error occurs, because otherwise the users
1680
# local work is unreferenced and will appear to have been lost.
1684
last_rev = self.get_parent_ids()[0]
1687
if last_rev != self.branch.last_revision():
1688
# merge tree state up to new branch tip.
1689
basis = self.basis_tree()
1690
to_tree = self.branch.basis_tree()
1691
if basis.inventory.root is None:
1692
self.set_root_id(to_tree.inventory.root.file_id)
1693
result += merge.merge_inner(
1698
# TODO - dedup parents list with things merged by pull ?
1699
# reuse the tree we've updated to to set the basis:
1700
parent_trees = [(self.branch.last_revision(), to_tree)]
1701
merges = self.get_parent_ids()[1:]
1702
# Ideally we ask the tree for the trees here, that way the working
1703
# tree can decide whether to give us teh entire tree or give us a
1704
# lazy initialised tree. dirstate for instance will have the trees
1705
# in ram already, whereas a last-revision + basis-inventory tree
1706
# will not, but also does not need them when setting parents.
1707
for parent in merges:
1708
parent_trees.append(
1709
(parent, self.branch.repository.revision_tree(parent)))
1710
if old_tip is not None:
1711
parent_trees.append(
1712
(old_tip, self.branch.repository.revision_tree(old_tip)))
1713
self.set_parent_trees(parent_trees)
1714
last_rev = parent_trees[0][0]
1716
# the working tree had the same last-revision as the master
1717
# branch did. We may still have pivot local work from the local
1718
# branch into old_tip:
1719
if old_tip is not None:
1720
self.add_parent_tree_id(old_tip)
1721
if old_tip and old_tip != last_rev:
1722
# our last revision was not the prior branch last revision
1723
# and we have converted that last revision to a pending merge.
1724
# base is somewhere between the branch tip now
1725
# and the now pending merge
1726
from bzrlib.revision import common_ancestor
1728
base_rev_id = common_ancestor(self.branch.last_revision(),
1730
self.branch.repository)
1731
except errors.NoCommonAncestor:
1733
base_tree = self.branch.repository.revision_tree(base_rev_id)
1734
other_tree = self.branch.repository.revision_tree(old_tip)
1735
result += merge.merge_inner(
1742
@needs_tree_write_lock
1743
def _write_inventory(self, inv):
1744
"""Write inventory as the current inventory."""
1745
self._set_inventory(inv, dirty=True)
1748
def set_conflicts(self, arg):
1749
raise UnsupportedOperation(self.set_conflicts, self)
1751
def add_conflicts(self, arg):
1752
raise UnsupportedOperation(self.add_conflicts, self)
1755
def conflicts(self):
1756
conflicts = _mod_conflicts.ConflictList()
1757
for conflicted in self._iter_conflicts():
1760
if file_kind(self.abspath(conflicted)) != "file":
1762
except errors.NoSuchFile:
1765
for suffix in ('.THIS', '.OTHER'):
1767
kind = file_kind(self.abspath(conflicted+suffix))
1770
except errors.NoSuchFile:
1774
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1775
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1777
file_id=self.path2id(conflicted)))
1781
class WorkingTree2(WorkingTree):
1782
"""This is the Format 2 working tree.
1784
This was the first weave based working tree.
1785
- uses os locks for locking.
1786
- uses the branch last-revision.
1789
def lock_tree_write(self):
1790
"""See WorkingTree.lock_tree_write().
1792
In Format2 WorkingTrees we have a single lock for the branch and tree
1793
so lock_tree_write() degrades to lock_write().
1795
self.branch.lock_write()
1797
return self._control_files.lock_write()
1799
self.branch.unlock()
1803
# we share control files:
1804
if self._control_files._lock_count == 3:
1805
# _inventory_is_modified is always False during a read lock.
1806
if self._inventory_is_modified:
1808
if self._hashcache.needs_write:
1809
self._hashcache.write()
1810
# reverse order of locking.
1812
return self._control_files.unlock()
1814
self.branch.unlock()
1817
class WorkingTree3(WorkingTree):
1818
"""This is the Format 3 working tree.
1820
This differs from the base WorkingTree by:
1821
- having its own file lock
1822
- having its own last-revision property.
1824
This is new in bzr 0.8
1828
def _last_revision(self):
1829
"""See Mutable.last_revision."""
1831
return self._control_files.get_utf8('last-revision').read()
1835
def _change_last_revision(self, revision_id):
1836
"""See WorkingTree._change_last_revision."""
1837
if revision_id is None or revision_id == NULL_REVISION:
1839
self._control_files._transport.delete('last-revision')
1840
except errors.NoSuchFile:
1844
self._control_files.put_utf8('last-revision', revision_id)
1847
@needs_tree_write_lock
1848
def set_conflicts(self, conflicts):
1849
self._put_rio('conflicts', conflicts.to_stanzas(),
1852
@needs_tree_write_lock
1853
def add_conflicts(self, new_conflicts):
1854
conflict_set = set(self.conflicts())
1855
conflict_set.update(set(list(new_conflicts)))
1856
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1857
key=_mod_conflicts.Conflict.sort_key)))
1860
def conflicts(self):
1862
confile = self._control_files.get('conflicts')
1864
return _mod_conflicts.ConflictList()
1866
if confile.next() != CONFLICT_HEADER_1 + '\n':
1867
raise ConflictFormatError()
1868
except StopIteration:
1869
raise ConflictFormatError()
1870
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1873
if self._control_files._lock_count == 1:
1874
# _inventory_is_modified is always False during a read lock.
1875
if self._inventory_is_modified:
1877
if self._hashcache.needs_write:
1878
self._hashcache.write()
1879
# reverse order of locking.
1881
return self._control_files.unlock()
1883
self.branch.unlock()
1886
def get_conflicted_stem(path):
1887
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1888
if path.endswith(suffix):
1889
return path[:-len(suffix)]
1891
@deprecated_function(zero_eight)
1892
def is_control_file(filename):
1893
"""See WorkingTree.is_control_filename(filename)."""
1894
## FIXME: better check
1895
filename = normpath(filename)
1896
while filename != '':
1897
head, tail = os.path.split(filename)
1898
## mutter('check %r for control file' % ((head, tail),))
1901
if filename == head:
1907
class WorkingTreeFormat(object):
1908
"""An encapsulation of the initialization and open routines for a format.
1910
Formats provide three things:
1911
* An initialization routine,
1915
Formats are placed in an dict by their format string for reference
1916
during workingtree opening. Its not required that these be instances, they
1917
can be classes themselves with class methods - it simply depends on
1918
whether state is needed for a given format or not.
1920
Once a format is deprecated, just deprecate the initialize and open
1921
methods on the format class. Do not deprecate the object, as the
1922
object will be created every time regardless.
1925
_default_format = None
1926
"""The default format used for new trees."""
1929
"""The known formats."""
1932
def find_format(klass, a_bzrdir):
1933
"""Return the format for the working tree object in a_bzrdir."""
1935
transport = a_bzrdir.get_workingtree_transport(None)
1936
format_string = transport.get("format").read()
1937
return klass._formats[format_string]
1939
raise errors.NoWorkingTree(base=transport.base)
1941
raise errors.UnknownFormatError(format=format_string)
1944
def get_default_format(klass):
1945
"""Return the current default format."""
1946
return klass._default_format
1948
def get_format_string(self):
1949
"""Return the ASCII format string that identifies this format."""
1950
raise NotImplementedError(self.get_format_string)
1952
def get_format_description(self):
1953
"""Return the short description for this format."""
1954
raise NotImplementedError(self.get_format_description)
1956
def is_supported(self):
1957
"""Is this format supported?
1959
Supported formats can be initialized and opened.
1960
Unsupported formats may not support initialization or committing or
1961
some other features depending on the reason for not being supported.
1966
def register_format(klass, format):
1967
klass._formats[format.get_format_string()] = format
1970
def set_default_format(klass, format):
1971
klass._default_format = format
1974
def unregister_format(klass, format):
1975
assert klass._formats[format.get_format_string()] is format
1976
del klass._formats[format.get_format_string()]
1980
class WorkingTreeFormat2(WorkingTreeFormat):
1981
"""The second working tree format.
1983
This format modified the hash cache from the format 1 hash cache.
1986
def get_format_description(self):
1987
"""See WorkingTreeFormat.get_format_description()."""
1988
return "Working tree format 2"
1990
def stub_initialize_remote(self, control_files):
1991
"""As a special workaround create critical control files for a remote working tree
1993
This ensures that it can later be updated and dealt with locally,
1994
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1995
no working tree. (See bug #43064).
1999
xml5.serializer_v5.write_inventory(inv, sio)
2001
control_files.put('inventory', sio)
2003
control_files.put_utf8('pending-merges', '')
2006
def initialize(self, a_bzrdir, revision_id=None):
2007
"""See WorkingTreeFormat.initialize()."""
2008
if not isinstance(a_bzrdir.transport, LocalTransport):
2009
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2010
branch = a_bzrdir.open_branch()
2011
if revision_id is not None:
2014
revision_history = branch.revision_history()
2016
position = revision_history.index(revision_id)
2018
raise errors.NoSuchRevision(branch, revision_id)
2019
branch.set_revision_history(revision_history[:position + 1])
2022
revision = branch.last_revision()
2024
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2030
basis_tree = branch.repository.revision_tree(revision)
2031
if basis_tree.inventory.root is not None:
2032
wt.set_root_id(basis_tree.inventory.root.file_id)
2033
# set the parent list and cache the basis tree.
2034
wt.set_parent_trees([(revision, basis_tree)])
2035
transform.build_tree(basis_tree, wt)
2039
super(WorkingTreeFormat2, self).__init__()
2040
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2042
def open(self, a_bzrdir, _found=False):
2043
"""Return the WorkingTree object for a_bzrdir
2045
_found is a private parameter, do not use it. It is used to indicate
2046
if format probing has already been done.
2049
# we are being called directly and must probe.
2050
raise NotImplementedError
2051
if not isinstance(a_bzrdir.transport, LocalTransport):
2052
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2053
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2059
class WorkingTreeFormat3(WorkingTreeFormat):
2060
"""The second working tree format updated to record a format marker.
2063
- exists within a metadir controlling .bzr
2064
- includes an explicit version marker for the workingtree control
2065
files, separate from the BzrDir format
2066
- modifies the hash cache format
2068
- uses a LockDir to guard access for writes.
2071
def get_format_string(self):
2072
"""See WorkingTreeFormat.get_format_string()."""
2073
return "Bazaar-NG Working Tree format 3"
2075
def get_format_description(self):
2076
"""See WorkingTreeFormat.get_format_description()."""
2077
return "Working tree format 3"
2079
_lock_file_name = 'lock'
2080
_lock_class = LockDir
2082
def _open_control_files(self, a_bzrdir):
2083
transport = a_bzrdir.get_workingtree_transport(None)
2084
return LockableFiles(transport, self._lock_file_name,
2087
def initialize(self, a_bzrdir, revision_id=None):
2088
"""See WorkingTreeFormat.initialize().
2090
revision_id allows creating a working tree at a different
2091
revision than the branch is at.
2093
if not isinstance(a_bzrdir.transport, LocalTransport):
2094
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2095
transport = a_bzrdir.get_workingtree_transport(self)
2096
control_files = self._open_control_files(a_bzrdir)
2097
control_files.create_lock()
2098
control_files.lock_write()
2099
control_files.put_utf8('format', self.get_format_string())
2100
branch = a_bzrdir.open_branch()
2101
if revision_id is None:
2102
revision_id = branch.last_revision()
2103
inv = Inventory(root_id=gen_root_id())
2104
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2110
_control_files=control_files)
2111
wt.lock_tree_write()
2113
basis_tree = branch.repository.revision_tree(revision_id)
2114
# only set an explicit root id if there is one to set.
2115
if basis_tree.inventory.root is not None:
2116
wt.set_root_id(basis_tree.inventory.root.file_id)
2117
if revision_id == NULL_REVISION:
2118
wt.set_parent_trees([])
2120
wt.set_parent_trees([(revision_id, basis_tree)])
2121
transform.build_tree(basis_tree, wt)
2123
# Unlock in this order so that the unlock-triggers-flush in
2124
# WorkingTree is given a chance to fire.
2125
control_files.unlock()
2130
super(WorkingTreeFormat3, self).__init__()
2131
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2133
def open(self, a_bzrdir, _found=False):
2134
"""Return the WorkingTree object for a_bzrdir
2136
_found is a private parameter, do not use it. It is used to indicate
2137
if format probing has already been done.
2140
# we are being called directly and must probe.
2141
raise NotImplementedError
2142
if not isinstance(a_bzrdir.transport, LocalTransport):
2143
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2144
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2146
def _open(self, a_bzrdir, control_files):
2147
"""Open the tree itself.
2149
:param a_bzrdir: the dir for the tree.
2150
:param control_files: the control files for the tree.
2152
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2156
_control_files=control_files)
2159
return self.get_format_string()
2162
# formats which have no format string are not discoverable
2163
# and not independently creatable, so are not registered.
2164
__default_format = WorkingTreeFormat3()
2165
WorkingTreeFormat.register_format(__default_format)
2166
WorkingTreeFormat.set_default_format(__default_format)
2167
_legacy_formats = [WorkingTreeFormat2(),
2171
class WorkingTreeTestProviderAdapter(object):
2172
"""A tool to generate a suite testing multiple workingtree formats at once.
2174
This is done by copying the test once for each transport and injecting
2175
the transport_server, transport_readonly_server, and workingtree_format
2176
classes into each copy. Each copy is also given a new id() to make it
2180
def __init__(self, transport_server, transport_readonly_server, formats):
2181
self._transport_server = transport_server
2182
self._transport_readonly_server = transport_readonly_server
2183
self._formats = formats
2185
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2186
"""Clone test for adaption."""
2187
new_test = deepcopy(test)
2188
new_test.transport_server = self._transport_server
2189
new_test.transport_readonly_server = self._transport_readonly_server
2190
new_test.bzrdir_format = bzrdir_format
2191
new_test.workingtree_format = workingtree_format
2192
def make_new_test_id():
2193
new_id = "%s(%s)" % (test.id(), variation)
2194
return lambda: new_id
2195
new_test.id = make_new_test_id()
2198
def adapt(self, test):
2199
from bzrlib.tests import TestSuite
2200
result = TestSuite()
2201
for workingtree_format, bzrdir_format in self._formats:
2202
new_test = self._clone_test(
2205
workingtree_format, workingtree_format.__class__.__name__)
2206
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
