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
63
from bzrlib.atomicfile import AtomicFile
65
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
66
from bzrlib.decorators import needs_read_lock, needs_write_lock
67
from bzrlib.errors import (BzrCheckError,
70
WeaveRevisionNotPresent,
74
MergeModifiedFormatError,
77
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
78
from bzrlib.lockable_files import LockableFiles, TransportLock
79
from bzrlib.lockdir import LockDir
80
from bzrlib.merge import merge_inner, transform_tree
81
import bzrlib.mutabletree
82
from bzrlib.mutabletree import needs_tree_write_lock
83
from bzrlib.osutils import (
100
from bzrlib.progress import DummyProgress, ProgressPhase
101
from bzrlib.revision import NULL_REVISION
102
import bzrlib.revisiontree
103
from bzrlib.rio import RioReader, rio_file, Stanza
104
from bzrlib.symbol_versioning import (deprecated_passed,
107
DEPRECATED_PARAMETER,
111
from bzrlib.trace import mutter, note
112
from bzrlib.transform import build_tree
113
from bzrlib.transport import get_transport
114
from bzrlib.transport.local import LocalTransport
115
from bzrlib.textui import show_status
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 = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
425
if inv is not None and inv.revision_id == revision_id:
426
return bzrlib.tree.RevisionTree(self.branch.repository,
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 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
if revision_id is None:
558
transform_tree(tree, self)
560
# TODO now merge from tree.last_revision to revision (to preserve
561
# user local changes)
562
transform_tree(tree, self)
563
tree.set_parent_ids([revision_id])
565
def id2abspath(self, file_id):
566
return self.abspath(self.id2path(file_id))
568
def has_id(self, file_id):
569
# files that have been deleted are excluded
570
inv = self._inventory
571
if not inv.has_id(file_id):
573
path = inv.id2path(file_id)
574
return osutils.lexists(self.abspath(path))
576
def has_or_had_id(self, file_id):
577
if file_id == self.inventory.root.file_id:
579
return self.inventory.has_id(file_id)
581
__contains__ = has_id
583
def get_file_size(self, file_id):
584
return os.path.getsize(self.id2abspath(file_id))
587
def get_file_sha1(self, file_id, path=None):
589
path = self._inventory.id2path(file_id)
590
return self._hashcache.get_sha1(path)
592
def get_file_mtime(self, file_id, path=None):
594
path = self._inventory.id2path(file_id)
595
return os.lstat(self.abspath(path)).st_mtime
597
if not supports_executable():
598
def is_executable(self, file_id, path=None):
599
return self._inventory[file_id].executable
601
def is_executable(self, file_id, path=None):
603
path = self._inventory.id2path(file_id)
604
mode = os.lstat(self.abspath(path)).st_mode
605
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
608
def _add(self, files, ids, kinds):
609
"""See MutableTree._add."""
610
# TODO: Re-adding a file that is removed in the working copy
611
# should probably put it back with the previous ID.
612
# the read and write working inventory should not occur in this
613
# function - they should be part of lock_write and unlock.
614
inv = self.read_working_inventory()
615
for f, file_id, kind in zip(files, ids, kinds):
616
assert kind is not None
618
inv.add_path(f, kind=kind)
620
inv.add_path(f, kind=kind, file_id=file_id)
621
self._write_inventory(inv)
623
@needs_tree_write_lock
624
def _gather_kinds(self, files, kinds):
625
"""See MutableTree._gather_kinds."""
626
for pos, f in enumerate(files):
627
if kinds[pos] is None:
628
fullpath = normpath(self.abspath(f))
630
kinds[pos] = file_kind(fullpath)
632
if e.errno == errno.ENOENT:
633
raise NoSuchFile(fullpath)
636
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
637
"""Add revision_id as a parent.
639
This is equivalent to retrieving the current list of parent ids
640
and setting the list to its value plus revision_id.
642
:param revision_id: The revision id to add to the parent list. It may
643
be a ghost revision as long as its not the first parent to be added,
644
or the allow_leftmost_as_ghost parameter is set True.
645
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
647
parents = self.get_parent_ids() + [revision_id]
648
self.set_parent_ids(parents,
649
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
651
@needs_tree_write_lock
652
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
653
"""Add revision_id, tree tuple as a parent.
655
This is equivalent to retrieving the current list of parent trees
656
and setting the list to its value plus parent_tuple. See also
657
add_parent_tree_id - if you only have a parent id available it will be
658
simpler to use that api. If you have the parent already available, using
659
this api is preferred.
661
:param parent_tuple: The (revision id, tree) to add to the parent list.
662
If the revision_id is a ghost, pass None for the tree.
663
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
665
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
666
if len(parent_ids) > 1:
667
# the leftmost may have already been a ghost, preserve that if it
669
allow_leftmost_as_ghost = True
670
self.set_parent_ids(parent_ids,
671
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
673
@needs_tree_write_lock
674
def add_pending_merge(self, *revision_ids):
675
# TODO: Perhaps should check at this point that the
676
# history of the revision is actually present?
677
parents = self.get_parent_ids()
679
for rev_id in revision_ids:
680
if rev_id in parents:
682
parents.append(rev_id)
685
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
687
@deprecated_method(zero_eleven)
689
def pending_merges(self):
690
"""Return a list of pending merges.
692
These are revisions that have been merged into the working
693
directory but not yet committed.
695
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
696
instead - which is available on all tree objects.
698
return self.get_parent_ids()[1:]
700
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
701
"""Common ghost checking functionality from set_parent_*.
703
This checks that the left hand-parent exists if there are any
706
if len(revision_ids) > 0:
707
leftmost_id = revision_ids[0]
708
if (not allow_leftmost_as_ghost and not
709
self.branch.repository.has_revision(leftmost_id)):
710
raise errors.GhostRevisionUnusableHere(leftmost_id)
712
def _set_merges_from_parent_ids(self, parent_ids):
713
merges = parent_ids[1:]
714
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
716
@needs_tree_write_lock
717
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
718
"""Set the parent ids to revision_ids.
720
See also set_parent_trees. This api will try to retrieve the tree data
721
for each element of revision_ids from the trees repository. If you have
722
tree data already available, it is more efficient to use
723
set_parent_trees rather than set_parent_ids. set_parent_ids is however
724
an easier API to use.
726
:param revision_ids: The revision_ids to set as the parent ids of this
727
working tree. Any of these may be ghosts.
729
self._check_parents_for_ghosts(revision_ids,
730
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
732
if len(revision_ids) > 0:
733
self.set_last_revision(revision_ids[0])
735
self.set_last_revision(None)
737
self._set_merges_from_parent_ids(revision_ids)
739
@needs_tree_write_lock
740
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
741
"""See MutableTree.set_parent_trees."""
742
parent_ids = [rev for (rev, tree) in parents_list]
744
self._check_parents_for_ghosts(parent_ids,
745
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
747
if len(parent_ids) == 0:
748
leftmost_parent_id = None
749
leftmost_parent_tree = None
751
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
753
if self._change_last_revision(leftmost_parent_id):
754
if leftmost_parent_tree is None:
755
# If we don't have a tree, fall back to reading the
756
# parent tree from the repository.
757
self._cache_basis_inventory(leftmost_parent_id)
759
inv = leftmost_parent_tree.inventory
760
xml = self._create_basis_xml_from_inventory(
761
leftmost_parent_id, inv)
762
self._write_basis_inventory(xml)
763
self._set_merges_from_parent_ids(parent_ids)
765
@needs_tree_write_lock
766
def set_pending_merges(self, rev_list):
767
parents = self.get_parent_ids()
768
leftmost = parents[:1]
769
new_parents = leftmost + rev_list
770
self.set_parent_ids(new_parents)
772
@needs_tree_write_lock
773
def set_merge_modified(self, modified_hashes):
775
for file_id, hash in modified_hashes.iteritems():
776
yield Stanza(file_id=file_id, hash=hash)
777
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
779
@needs_tree_write_lock
780
def _put_rio(self, filename, stanzas, header):
781
my_file = rio_file(stanzas, header)
782
self._control_files.put(filename, my_file)
784
@needs_write_lock # because merge pulls data into the branch.
785
def merge_from_branch(self, branch, to_revision=None):
786
"""Merge from a branch into this working tree.
788
:param branch: The branch to merge from.
789
:param to_revision: If non-None, the merge will merge to to_revision, but
790
not beyond it. to_revision does not need to be in the history of
791
the branch when it is supplied. If None, to_revision defaults to
792
branch.last_revision().
794
from bzrlib.merge import Merger, Merge3Merger
795
pb = bzrlib.ui.ui_factory.nested_progress_bar()
797
merger = Merger(self.branch, this_tree=self, pb=pb)
798
merger.pp = ProgressPhase("Merge phase", 5, pb)
799
merger.pp.next_phase()
800
# check that there are no
802
merger.check_basis(check_clean=True, require_commits=False)
803
if to_revision is None:
804
to_revision = branch.last_revision()
805
merger.other_rev_id = to_revision
806
if merger.other_rev_id is None:
807
raise error.NoCommits(branch)
808
self.branch.fetch(branch, last_revision=merger.other_rev_id)
809
merger.other_basis = merger.other_rev_id
810
merger.other_tree = self.branch.repository.revision_tree(
812
merger.pp.next_phase()
814
if merger.base_rev_id == merger.other_rev_id:
815
raise errors.PointlessMerge
816
merger.backup_files = False
817
merger.merge_type = Merge3Merger
818
merger.set_interesting_files(None)
819
merger.show_base = False
820
merger.reprocess = False
821
conflicts = merger.do_merge()
828
def merge_modified(self):
830
hashfile = self._control_files.get('merge-hashes')
835
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
836
raise MergeModifiedFormatError()
837
except StopIteration:
838
raise MergeModifiedFormatError()
839
for s in RioReader(hashfile):
840
file_id = s.get("file_id")
841
if file_id not in self.inventory:
844
if hash == self.get_file_sha1(file_id):
845
merge_hashes[file_id] = hash
849
def mkdir(self, path, file_id=None):
850
"""See MutableTree.mkdir()."""
852
file_id = gen_file_id(os.path.basename(path))
853
os.mkdir(self.abspath(path))
854
self.add(path, file_id, 'directory')
857
def get_symlink_target(self, file_id):
858
return os.readlink(self.id2abspath(file_id))
860
def file_class(self, filename):
861
if self.path2id(filename):
863
elif self.is_ignored(filename):
869
"""Write the in memory inventory to disk."""
870
# TODO: Maybe this should only write on dirty ?
871
if self._control_files._lock_mode != 'w':
872
raise errors.NotWriteLocked(self)
874
bzrlib.xml5.serializer_v5.write_inventory(self._inventory, sio)
876
self._control_files.put('inventory', sio)
877
self._inventory_is_modified = False
879
def list_files(self, include_root=False):
880
"""Recursively list all files as (path, class, kind, id, entry).
882
Lists, but does not descend into unversioned directories.
884
This does not include files that have been deleted in this
887
Skips the control directory.
889
inv = self._inventory
890
if include_root is True:
891
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
892
# Convert these into local objects to save lookup times
893
pathjoin = osutils.pathjoin
894
file_kind = osutils.file_kind
896
# transport.base ends in a slash, we want the piece
897
# between the last two slashes
898
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
900
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
902
# directory file_id, relative path, absolute path, reverse sorted children
903
children = os.listdir(self.basedir)
905
# jam 20060527 The kernel sized tree seems equivalent whether we
906
# use a deque and popleft to keep them sorted, or if we use a plain
907
# list and just reverse() them.
908
children = collections.deque(children)
909
stack = [(inv.root.file_id, u'', self.basedir, children)]
911
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
914
f = children.popleft()
915
## TODO: If we find a subdirectory with its own .bzr
916
## directory, then that is a separate tree and we
917
## should exclude it.
919
# the bzrdir for this tree
920
if transport_base_dir == f:
923
# we know that from_dir_relpath and from_dir_abspath never end in a slash
924
# and 'f' doesn't begin with one, we can do a string op, rather
925
# than the checks of pathjoin(), all relative paths will have an extra slash
927
fp = from_dir_relpath + '/' + f
930
fap = from_dir_abspath + '/' + f
932
f_ie = inv.get_child(from_dir_id, f)
935
elif self.is_ignored(fp[1:]):
938
# we may not have found this file, because of a unicode issue
939
f_norm, can_access = osutils.normalized_filename(f)
940
if f == f_norm or not can_access:
941
# No change, so treat this file normally
944
# this file can be accessed by a normalized path
945
# check again if it is versioned
946
# these lines are repeated here for performance
948
fp = from_dir_relpath + '/' + f
949
fap = from_dir_abspath + '/' + f
950
f_ie = inv.get_child(from_dir_id, f)
953
elif self.is_ignored(fp[1:]):
962
raise BzrCheckError("file %r entered as kind %r id %r, "
964
% (fap, f_ie.kind, f_ie.file_id, fk))
966
# make a last minute entry
968
yield fp[1:], c, fk, f_ie.file_id, f_ie
971
yield fp[1:], c, fk, None, fk_entries[fk]()
973
yield fp[1:], c, fk, None, TreeEntry()
976
if fk != 'directory':
979
# But do this child first
980
new_children = os.listdir(fap)
982
new_children = collections.deque(new_children)
983
stack.append((f_ie.file_id, fp, fap, new_children))
984
# Break out of inner loop, so that we start outer loop with child
987
# if we finished all children, pop it off the stack
990
@needs_tree_write_lock
991
def move(self, from_paths, to_name):
994
to_name must exist in the inventory.
996
If to_name exists and is a directory, the files are moved into
997
it, keeping their old names.
999
Note that to_name is only the last component of the new name;
1000
this doesn't change the directory.
1002
This returns a list of (from_path, to_path) pairs for each
1003
entry that is moved.
1006
## TODO: Option to move IDs only
1007
assert not isinstance(from_paths, basestring)
1008
inv = self.inventory
1009
to_abs = self.abspath(to_name)
1010
if not isdir(to_abs):
1011
raise BzrError("destination %r is not a directory" % to_abs)
1012
if not self.has_filename(to_name):
1013
raise BzrError("destination %r not in working directory" % to_abs)
1014
to_dir_id = inv.path2id(to_name)
1015
if to_dir_id is None and to_name != '':
1016
raise BzrError("destination %r is not a versioned directory" % to_name)
1017
to_dir_ie = inv[to_dir_id]
1018
if to_dir_ie.kind != 'directory':
1019
raise BzrError("destination %r is not a directory" % to_abs)
1021
to_idpath = inv.get_idpath(to_dir_id)
1023
for f in from_paths:
1024
if not self.has_filename(f):
1025
raise BzrError("%r does not exist in working tree" % f)
1026
f_id = inv.path2id(f)
1028
raise BzrError("%r is not versioned" % f)
1029
name_tail = splitpath(f)[-1]
1030
dest_path = pathjoin(to_name, name_tail)
1031
if self.has_filename(dest_path):
1032
raise BzrError("destination %r already exists" % dest_path)
1033
if f_id in to_idpath:
1034
raise BzrError("can't move %r to a subdirectory of itself" % f)
1036
# OK, so there's a race here, it's possible that someone will
1037
# create a file in this interval and then the rename might be
1038
# left half-done. But we should have caught most problems.
1039
orig_inv = deepcopy(self.inventory)
1040
original_modified = self._inventory_is_modified
1043
self._inventory_is_modified = True
1044
for f in from_paths:
1045
name_tail = splitpath(f)[-1]
1046
dest_path = pathjoin(to_name, name_tail)
1047
result.append((f, dest_path))
1048
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1050
rename(self.abspath(f), self.abspath(dest_path))
1052
raise BzrError("failed to rename %r to %r: %s" %
1053
(f, dest_path, e[1]),
1054
["rename rolled back"])
1056
# restore the inventory on error
1057
self._set_inventory(orig_inv, dirty=original_modified)
1059
self._write_inventory(inv)
1062
@needs_tree_write_lock
1063
def rename_one(self, from_rel, to_rel):
1066
This can change the directory or the filename or both.
1068
inv = self.inventory
1069
if not self.has_filename(from_rel):
1070
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1071
if self.has_filename(to_rel):
1072
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1074
file_id = inv.path2id(from_rel)
1076
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1078
entry = inv[file_id]
1079
from_parent = entry.parent_id
1080
from_name = entry.name
1082
if inv.path2id(to_rel):
1083
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1085
to_dir, to_tail = os.path.split(to_rel)
1086
to_dir_id = inv.path2id(to_dir)
1087
if to_dir_id is None and to_dir != '':
1088
raise BzrError("can't determine destination directory id for %r" % to_dir)
1090
mutter("rename_one:")
1091
mutter(" file_id {%s}" % file_id)
1092
mutter(" from_rel %r" % from_rel)
1093
mutter(" to_rel %r" % to_rel)
1094
mutter(" to_dir %r" % to_dir)
1095
mutter(" to_dir_id {%s}" % to_dir_id)
1097
inv.rename(file_id, to_dir_id, to_tail)
1099
from_abs = self.abspath(from_rel)
1100
to_abs = self.abspath(to_rel)
1102
rename(from_abs, to_abs)
1104
inv.rename(file_id, from_parent, from_name)
1105
raise BzrError("failed to rename %r to %r: %s"
1106
% (from_abs, to_abs, e[1]),
1107
["rename rolled back"])
1108
self._write_inventory(inv)
1112
"""Return all unknown files.
1114
These are files in the working directory that are not versioned or
1115
control files or ignored.
1117
for subp in self.extras():
1118
if not self.is_ignored(subp):
1121
@needs_tree_write_lock
1122
def unversion(self, file_ids):
1123
"""Remove the file ids in file_ids from the current versioned set.
1125
When a file_id is unversioned, all of its children are automatically
1128
:param file_ids: The file ids to stop versioning.
1129
:raises: NoSuchId if any fileid is not currently versioned.
1131
for file_id in file_ids:
1132
if self._inventory.has_id(file_id):
1133
self._inventory.remove_recursive_id(file_id)
1135
raise errors.NoSuchId(self, file_id)
1137
# in the future this should just set a dirty bit to wait for the
1138
# final unlock. However, until all methods of workingtree start
1139
# with the current in -memory inventory rather than triggering
1140
# a read, it is more complex - we need to teach read_inventory
1141
# to know when to read, and when to not read first... and possibly
1142
# to save first when the in memory one may be corrupted.
1143
# so for now, we just only write it if it is indeed dirty.
1145
self._write_inventory(self._inventory)
1147
@deprecated_method(zero_eight)
1148
def iter_conflicts(self):
1149
"""List all files in the tree that have text or content conflicts.
1150
DEPRECATED. Use conflicts instead."""
1151
return self._iter_conflicts()
1153
def _iter_conflicts(self):
1155
for info in self.list_files():
1157
stem = get_conflicted_stem(path)
1160
if stem not in conflicted:
1161
conflicted.add(stem)
1165
def pull(self, source, overwrite=False, stop_revision=None):
1166
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1169
pp = ProgressPhase("Pull phase", 2, top_pb)
1171
old_revision_history = self.branch.revision_history()
1172
basis_tree = self.basis_tree()
1173
count = self.branch.pull(source, overwrite, stop_revision)
1174
new_revision_history = self.branch.revision_history()
1175
if new_revision_history != old_revision_history:
1177
if len(old_revision_history):
1178
other_revision = old_revision_history[-1]
1180
other_revision = None
1181
repository = self.branch.repository
1182
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1184
new_basis_tree = self.branch.basis_tree()
1185
merge_inner(self.branch,
1192
# TODO - dedup parents list with things merged by pull ?
1193
# reuse the revisiontree we merged against to set the new
1195
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1196
# we have to pull the merge trees out again, because
1197
# merge_inner has set the ids. - this corner is not yet
1198
# layered well enough to prevent double handling.
1199
merges = self.get_parent_ids()[1:]
1200
parent_trees.extend([
1201
(parent, repository.revision_tree(parent)) for
1203
self.set_parent_trees(parent_trees)
1210
def put_file_bytes_non_atomic(self, file_id, bytes):
1211
"""See MutableTree.put_file_bytes_non_atomic."""
1212
stream = file(self.id2abspath(file_id), 'wb')
1217
# TODO: update the hashcache here ?
1220
"""Yield all unknown files in this WorkingTree.
1222
If there are any unknown directories then only the directory is
1223
returned, not all its children. But if there are unknown files
1224
under a versioned subdirectory, they are returned.
1226
Currently returned depth-first, sorted by name within directories.
1228
## TODO: Work from given directory downwards
1229
for path, dir_entry in self.inventory.directories():
1230
# mutter("search for unknowns in %r", path)
1231
dirabs = self.abspath(path)
1232
if not isdir(dirabs):
1233
# e.g. directory deleted
1237
for subf in os.listdir(dirabs):
1240
if subf not in dir_entry.children:
1241
subf_norm, can_access = osutils.normalized_filename(subf)
1242
if subf_norm != subf and can_access:
1243
if subf_norm not in dir_entry.children:
1244
fl.append(subf_norm)
1250
subp = pathjoin(path, subf)
1253
def _translate_ignore_rule(self, rule):
1254
"""Translate a single ignore rule to a regex.
1256
There are two types of ignore rules. Those that do not contain a / are
1257
matched against the tail of the filename (that is, they do not care
1258
what directory the file is in.) Rules which do contain a slash must
1259
match the entire path. As a special case, './' at the start of the
1260
string counts as a slash in the string but is removed before matching
1261
(e.g. ./foo.c, ./src/foo.c)
1263
:return: The translated regex.
1265
if rule[:2] in ('./', '.\\'):
1267
result = fnmatch.translate(rule[2:])
1268
elif '/' in rule or '\\' in rule:
1270
result = fnmatch.translate(rule)
1272
# default rule style.
1273
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1274
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1275
return "(" + result + ")"
1277
def _combine_ignore_rules(self, rules):
1278
"""Combine a list of ignore rules into a single regex object.
1280
Each individual rule is combined with | to form a big regex, which then
1281
has $ added to it to form something like ()|()|()$. The group index for
1282
each subregex's outermost group is placed in a dictionary mapping back
1283
to the rule. This allows quick identification of the matching rule that
1285
:return: a list of the compiled regex and the matching-group index
1286
dictionaries. We return a list because python complains if you try to
1287
combine more than 100 regexes.
1292
translated_rules = []
1294
translated_rule = self._translate_ignore_rule(rule)
1295
compiled_rule = re.compile(translated_rule)
1296
groups[next_group] = rule
1297
next_group += compiled_rule.groups
1298
translated_rules.append(translated_rule)
1299
if next_group == 99:
1300
result.append((re.compile("|".join(translated_rules)), groups))
1303
translated_rules = []
1304
if len(translated_rules):
1305
result.append((re.compile("|".join(translated_rules)), groups))
1308
def ignored_files(self):
1309
"""Yield list of PATH, IGNORE_PATTERN"""
1310
for subp in self.extras():
1311
pat = self.is_ignored(subp)
1315
def get_ignore_list(self):
1316
"""Return list of ignore patterns.
1318
Cached in the Tree object after the first call.
1320
ignoreset = getattr(self, '_ignoreset', None)
1321
if ignoreset is not None:
1324
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1325
ignore_globs.update(ignores.get_runtime_ignores())
1327
ignore_globs.update(ignores.get_user_ignores())
1329
if self.has_filename(bzrlib.IGNORE_FILENAME):
1330
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1332
ignore_globs.update(ignores.parse_ignore_file(f))
1336
self._ignoreset = ignore_globs
1337
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1340
def _get_ignore_rules_as_regex(self):
1341
"""Return a regex of the ignore rules and a mapping dict.
1343
:return: (ignore rules compiled regex, dictionary mapping rule group
1344
indices to original rule.)
1346
if getattr(self, '_ignoreset', None) is None:
1347
self.get_ignore_list()
1348
return self._ignore_regex
1350
def is_ignored(self, filename):
1351
r"""Check whether the filename matches an ignore pattern.
1353
Patterns containing '/' or '\' need to match the whole path;
1354
others match against only the last component.
1356
If the file is ignored, returns the pattern which caused it to
1357
be ignored, otherwise None. So this can simply be used as a
1358
boolean if desired."""
1360
# TODO: Use '**' to match directories, and other extended
1361
# globbing stuff from cvs/rsync.
1363
# XXX: fnmatch is actually not quite what we want: it's only
1364
# approximately the same as real Unix fnmatch, and doesn't
1365
# treat dotfiles correctly and allows * to match /.
1366
# Eventually it should be replaced with something more
1369
rules = self._get_ignore_rules_as_regex()
1370
for regex, mapping in rules:
1371
match = regex.match(filename)
1372
if match is not None:
1373
# one or more of the groups in mapping will have a non-None
1375
groups = match.groups()
1376
rules = [mapping[group] for group in
1377
mapping if groups[group] is not None]
1381
def kind(self, file_id):
1382
return file_kind(self.id2abspath(file_id))
1384
def last_revision(self):
1385
"""Return the last revision of the branch for this tree.
1387
This format tree does not support a separate marker for last-revision
1388
compared to the branch.
1390
See MutableTree.last_revision
1392
return self._last_revision()
1395
def _last_revision(self):
1396
"""helper for get_parent_ids."""
1397
return self.branch.last_revision()
1399
def is_locked(self):
1400
return self._control_files.is_locked()
1402
def lock_read(self):
1403
"""See Branch.lock_read, and WorkingTree.unlock."""
1404
self.branch.lock_read()
1406
return self._control_files.lock_read()
1408
self.branch.unlock()
1411
def lock_tree_write(self):
1412
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1413
self.branch.lock_read()
1415
return self._control_files.lock_write()
1417
self.branch.unlock()
1420
def lock_write(self):
1421
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1422
self.branch.lock_write()
1424
return self._control_files.lock_write()
1426
self.branch.unlock()
1429
def get_physical_lock_status(self):
1430
return self._control_files.get_physical_lock_status()
1432
def _basis_inventory_name(self):
1433
return 'basis-inventory-cache'
1435
@needs_tree_write_lock
1436
def set_last_revision(self, new_revision):
1437
"""Change the last revision in the working tree."""
1438
if self._change_last_revision(new_revision):
1439
self._cache_basis_inventory(new_revision)
1441
def _change_last_revision(self, new_revision):
1442
"""Template method part of set_last_revision to perform the change.
1444
This is used to allow WorkingTree3 instances to not affect branch
1445
when their last revision is set.
1447
if new_revision is None:
1448
self.branch.set_revision_history([])
1451
self.branch.generate_revision_history(new_revision)
1452
except errors.NoSuchRevision:
1453
# not present in the repo - dont try to set it deeper than the tip
1454
self.branch.set_revision_history([new_revision])
1457
def _write_basis_inventory(self, xml):
1458
"""Write the basis inventory XML to the basis-inventory file"""
1459
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1460
path = self._basis_inventory_name()
1462
self._control_files.put(path, sio)
1464
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1465
"""Create the text that will be saved in basis-inventory"""
1466
inventory.revision_id = revision_id
1467
return bzrlib.xml6.serializer_v6.write_inventory_to_string(inventory)
1469
def _cache_basis_inventory(self, new_revision):
1470
"""Cache new_revision as the basis inventory."""
1471
# TODO: this should allow the ready-to-use inventory to be passed in,
1472
# as commit already has that ready-to-use [while the format is the
1475
# this double handles the inventory - unpack and repack -
1476
# but is easier to understand. We can/should put a conditional
1477
# in here based on whether the inventory is in the latest format
1478
# - perhaps we should repack all inventories on a repository
1480
# the fast path is to copy the raw xml from the repository. If the
1481
# xml contains 'revision_id="', then we assume the right
1482
# revision_id is set. We must check for this full string, because a
1483
# root node id can legitimately look like 'revision_id' but cannot
1485
xml = self.branch.repository.get_inventory_xml(new_revision)
1486
firstline = xml.split('\n', 1)[0]
1487
if (not 'revision_id="' in firstline or
1488
'format="6"' not in firstline):
1489
inv = self.branch.repository.deserialise_inventory(
1491
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1492
self._write_basis_inventory(xml)
1493
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1496
def read_basis_inventory(self):
1497
"""Read the cached basis inventory."""
1498
path = self._basis_inventory_name()
1499
return self._control_files.get(path).read()
1502
def read_working_inventory(self):
1503
"""Read the working inventory.
1505
:raises errors.InventoryModified: When the current in memory
1506
inventory has been modified, read_working_inventory will
1509
# conceptually this should be an implementation detail of the tree.
1510
# XXX: Deprecate this.
1511
# ElementTree does its own conversion from UTF-8, so open in
1513
if self._inventory_is_modified:
1514
raise errors.InventoryModified(self)
1515
result = bzrlib.xml5.serializer_v5.read_inventory(
1516
self._control_files.get('inventory'))
1517
self._set_inventory(result, dirty=False)
1520
@needs_tree_write_lock
1521
def remove(self, files, verbose=False, to_file=None):
1522
"""Remove nominated files from the working inventory..
1524
This does not remove their text. This does not run on XXX on what? RBC
1526
TODO: Refuse to remove modified files unless --force is given?
1528
TODO: Do something useful with directories.
1530
TODO: Should this remove the text or not? Tough call; not
1531
removing may be useful and the user can just use use rm, and
1532
is the opposite of add. Removing it is consistent with most
1533
other tools. Maybe an option.
1535
## TODO: Normalize names
1536
## TODO: Remove nested loops; better scalability
1537
if isinstance(files, basestring):
1540
inv = self.inventory
1542
# do this before any modifications
1544
fid = inv.path2id(f)
1546
# TODO: Perhaps make this just a warning, and continue?
1547
# This tends to happen when
1548
raise NotVersionedError(path=f)
1550
# having remove it, it must be either ignored or unknown
1551
if self.is_ignored(f):
1555
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1558
self._write_inventory(inv)
1560
@needs_tree_write_lock
1561
def revert(self, filenames, old_tree=None, backups=True,
1562
pb=DummyProgress()):
1563
from transform import revert
1564
from conflicts import resolve
1565
if old_tree is None:
1566
old_tree = self.basis_tree()
1567
conflicts = revert(self, old_tree, filenames, backups, pb)
1568
if not len(filenames):
1569
self.set_parent_ids(self.get_parent_ids()[:1])
1572
resolve(self, filenames, ignore_misses=True)
1575
# XXX: This method should be deprecated in favour of taking in a proper
1576
# new Inventory object.
1577
@needs_tree_write_lock
1578
def set_inventory(self, new_inventory_list):
1579
from bzrlib.inventory import (Inventory,
1584
inv = Inventory(self.get_root_id())
1585
for path, file_id, parent, kind in new_inventory_list:
1586
name = os.path.basename(path)
1589
# fixme, there should be a factory function inv,add_??
1590
if kind == 'directory':
1591
inv.add(InventoryDirectory(file_id, name, parent))
1592
elif kind == 'file':
1593
inv.add(InventoryFile(file_id, name, parent))
1594
elif kind == 'symlink':
1595
inv.add(InventoryLink(file_id, name, parent))
1597
raise BzrError("unknown kind %r" % kind)
1598
self._write_inventory(inv)
1600
@needs_tree_write_lock
1601
def set_root_id(self, file_id):
1602
"""Set the root id for this tree."""
1605
symbol_versioning.warn(symbol_versioning.zero_twelve
1606
% 'WorkingTree.set_root_id with fileid=None',
1610
inv = self._inventory
1611
orig_root_id = inv.root.file_id
1612
# TODO: it might be nice to exit early if there was nothing
1613
# to do, saving us from trigger a sync on unlock.
1614
self._inventory_is_modified = True
1615
# we preserve the root inventory entry object, but
1616
# unlinkit from the byid index
1617
del inv._byid[inv.root.file_id]
1618
inv.root.file_id = file_id
1619
# and link it into the index with the new changed id.
1620
inv._byid[inv.root.file_id] = inv.root
1621
# and finally update all children to reference the new id.
1622
# XXX: this should be safe to just look at the root.children
1623
# list, not the WHOLE INVENTORY.
1626
if entry.parent_id == orig_root_id:
1627
entry.parent_id = inv.root.file_id
1630
"""See Branch.unlock.
1632
WorkingTree locking just uses the Branch locking facilities.
1633
This is current because all working trees have an embedded branch
1634
within them. IF in the future, we were to make branch data shareable
1635
between multiple working trees, i.e. via shared storage, then we
1636
would probably want to lock both the local tree, and the branch.
1638
raise NotImplementedError(self.unlock)
1642
"""Update a working tree along its branch.
1644
This will update the branch if its bound too, which means we have multiple trees involved:
1645
The new basis tree of the master.
1646
The old basis tree of the branch.
1647
The old basis tree of the working tree.
1648
The current working tree state.
1649
pathologically all three may be different, and non ancestors of each other.
1650
Conceptually we want to:
1651
Preserve the wt.basis->wt.state changes
1652
Transform the wt.basis to the new master basis.
1653
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1654
Restore the wt.basis->wt.state changes.
1656
There isn't a single operation at the moment to do that, so we:
1657
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1658
Do a 'normal' merge of the old branch basis if it is relevant.
1660
old_tip = self.branch.update()
1661
# here if old_tip is not None, it is the old tip of the branch before
1662
# it was updated from the master branch. This should become a pending
1663
# merge in the working tree to preserve the user existing work. we
1664
# cant set that until we update the working trees last revision to be
1665
# one from the new branch, because it will just get absorbed by the
1666
# parent de-duplication logic.
1668
# We MUST save it even if an error occurs, because otherwise the users
1669
# local work is unreferenced and will appear to have been lost.
1673
last_rev = self.get_parent_ids()[0]
1676
if last_rev != self.branch.last_revision():
1677
# merge tree state up to new branch tip.
1678
basis = self.basis_tree()
1679
to_tree = self.branch.basis_tree()
1680
result += merge_inner(self.branch,
1684
# TODO - dedup parents list with things merged by pull ?
1685
# reuse the tree we've updated to to set the basis:
1686
parent_trees = [(self.branch.last_revision(), to_tree)]
1687
merges = self.get_parent_ids()[1:]
1688
# Ideally we ask the tree for the trees here, that way the working
1689
# tree can decide whether to give us teh entire tree or give us a
1690
# lazy initialised tree. dirstate for instance will have the trees
1691
# in ram already, whereas a last-revision + basis-inventory tree
1692
# will not, but also does not need them when setting parents.
1693
for parent in merges:
1694
parent_trees.append(
1695
(parent, self.branch.repository.revision_tree(parent)))
1696
if old_tip is not None:
1697
parent_trees.append(
1698
(old_tip, self.branch.repository.revision_tree(old_tip)))
1699
self.set_parent_trees(parent_trees)
1700
last_rev = parent_trees[0][0]
1702
# the working tree had the same last-revision as the master
1703
# branch did. We may still have pivot local work from the local
1704
# branch into old_tip:
1705
if old_tip is not None:
1706
self.add_parent_tree_id(old_tip)
1707
if old_tip and old_tip != last_rev:
1708
# our last revision was not the prior branch last revision
1709
# and we have converted that last revision to a pending merge.
1710
# base is somewhere between the branch tip now
1711
# and the now pending merge
1712
from bzrlib.revision import common_ancestor
1714
base_rev_id = common_ancestor(self.branch.last_revision(),
1716
self.branch.repository)
1717
except errors.NoCommonAncestor:
1719
base_tree = self.branch.repository.revision_tree(base_rev_id)
1720
other_tree = self.branch.repository.revision_tree(old_tip)
1721
result += merge_inner(self.branch,
1727
@needs_tree_write_lock
1728
def _write_inventory(self, inv):
1729
"""Write inventory as the current inventory."""
1730
self._set_inventory(inv, dirty=True)
1733
def set_conflicts(self, arg):
1734
raise UnsupportedOperation(self.set_conflicts, self)
1736
def add_conflicts(self, arg):
1737
raise UnsupportedOperation(self.add_conflicts, self)
1740
def conflicts(self):
1741
conflicts = ConflictList()
1742
for conflicted in self._iter_conflicts():
1745
if file_kind(self.abspath(conflicted)) != "file":
1747
except errors.NoSuchFile:
1750
for suffix in ('.THIS', '.OTHER'):
1752
kind = file_kind(self.abspath(conflicted+suffix))
1755
except errors.NoSuchFile:
1759
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1760
conflicts.append(Conflict.factory(ctype, path=conflicted,
1761
file_id=self.path2id(conflicted)))
1765
class WorkingTree2(WorkingTree):
1766
"""This is the Format 2 working tree.
1768
This was the first weave based working tree.
1769
- uses os locks for locking.
1770
- uses the branch last-revision.
1773
def lock_tree_write(self):
1774
"""See WorkingTree.lock_tree_write().
1776
In Format2 WorkingTrees we have a single lock for the branch and tree
1777
so lock_tree_write() degrades to lock_write().
1779
self.branch.lock_write()
1781
return self._control_files.lock_write()
1783
self.branch.unlock()
1787
# we share control files:
1788
if self._control_files._lock_count == 3:
1789
# _inventory_is_modified is always False during a read lock.
1790
if self._inventory_is_modified:
1792
if self._hashcache.needs_write:
1793
self._hashcache.write()
1794
# reverse order of locking.
1796
return self._control_files.unlock()
1798
self.branch.unlock()
1801
class WorkingTree3(WorkingTree):
1802
"""This is the Format 3 working tree.
1804
This differs from the base WorkingTree by:
1805
- having its own file lock
1806
- having its own last-revision property.
1808
This is new in bzr 0.8
1812
def _last_revision(self):
1813
"""See Mutable.last_revision."""
1815
return self._control_files.get_utf8('last-revision').read()
1819
def _change_last_revision(self, revision_id):
1820
"""See WorkingTree._change_last_revision."""
1821
if revision_id is None or revision_id == NULL_REVISION:
1823
self._control_files._transport.delete('last-revision')
1824
except errors.NoSuchFile:
1828
self._control_files.put_utf8('last-revision', revision_id)
1831
@needs_tree_write_lock
1832
def set_conflicts(self, conflicts):
1833
self._put_rio('conflicts', conflicts.to_stanzas(),
1836
@needs_tree_write_lock
1837
def add_conflicts(self, new_conflicts):
1838
conflict_set = set(self.conflicts())
1839
conflict_set.update(set(list(new_conflicts)))
1840
self.set_conflicts(ConflictList(sorted(conflict_set,
1841
key=Conflict.sort_key)))
1844
def conflicts(self):
1846
confile = self._control_files.get('conflicts')
1848
return ConflictList()
1850
if confile.next() != CONFLICT_HEADER_1 + '\n':
1851
raise ConflictFormatError()
1852
except StopIteration:
1853
raise ConflictFormatError()
1854
return ConflictList.from_stanzas(RioReader(confile))
1857
if self._control_files._lock_count == 1:
1858
# _inventory_is_modified is always False during a read lock.
1859
if self._inventory_is_modified:
1861
if self._hashcache.needs_write:
1862
self._hashcache.write()
1863
# reverse order of locking.
1865
return self._control_files.unlock()
1867
self.branch.unlock()
1870
def get_conflicted_stem(path):
1871
for suffix in CONFLICT_SUFFIXES:
1872
if path.endswith(suffix):
1873
return path[:-len(suffix)]
1875
@deprecated_function(zero_eight)
1876
def is_control_file(filename):
1877
"""See WorkingTree.is_control_filename(filename)."""
1878
## FIXME: better check
1879
filename = normpath(filename)
1880
while filename != '':
1881
head, tail = os.path.split(filename)
1882
## mutter('check %r for control file' % ((head, tail),))
1885
if filename == head:
1891
class WorkingTreeFormat(object):
1892
"""An encapsulation of the initialization and open routines for a format.
1894
Formats provide three things:
1895
* An initialization routine,
1899
Formats are placed in an dict by their format string for reference
1900
during workingtree opening. Its not required that these be instances, they
1901
can be classes themselves with class methods - it simply depends on
1902
whether state is needed for a given format or not.
1904
Once a format is deprecated, just deprecate the initialize and open
1905
methods on the format class. Do not deprecate the object, as the
1906
object will be created every time regardless.
1909
_default_format = None
1910
"""The default format used for new trees."""
1913
"""The known formats."""
1916
def find_format(klass, a_bzrdir):
1917
"""Return the format for the working tree object in a_bzrdir."""
1919
transport = a_bzrdir.get_workingtree_transport(None)
1920
format_string = transport.get("format").read()
1921
return klass._formats[format_string]
1923
raise errors.NoWorkingTree(base=transport.base)
1925
raise errors.UnknownFormatError(format=format_string)
1928
def get_default_format(klass):
1929
"""Return the current default format."""
1930
return klass._default_format
1932
def get_format_string(self):
1933
"""Return the ASCII format string that identifies this format."""
1934
raise NotImplementedError(self.get_format_string)
1936
def get_format_description(self):
1937
"""Return the short description for this format."""
1938
raise NotImplementedError(self.get_format_description)
1940
def is_supported(self):
1941
"""Is this format supported?
1943
Supported formats can be initialized and opened.
1944
Unsupported formats may not support initialization or committing or
1945
some other features depending on the reason for not being supported.
1950
def register_format(klass, format):
1951
klass._formats[format.get_format_string()] = format
1954
def set_default_format(klass, format):
1955
klass._default_format = format
1958
def unregister_format(klass, format):
1959
assert klass._formats[format.get_format_string()] is format
1960
del klass._formats[format.get_format_string()]
1964
class WorkingTreeFormat2(WorkingTreeFormat):
1965
"""The second working tree format.
1967
This format modified the hash cache from the format 1 hash cache.
1970
def get_format_description(self):
1971
"""See WorkingTreeFormat.get_format_description()."""
1972
return "Working tree format 2"
1974
def stub_initialize_remote(self, control_files):
1975
"""As a special workaround create critical control files for a remote working tree
1977
This ensures that it can later be updated and dealt with locally,
1978
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1979
no working tree. (See bug #43064).
1983
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1985
control_files.put('inventory', sio)
1987
control_files.put_utf8('pending-merges', '')
1990
def initialize(self, a_bzrdir, revision_id=None):
1991
"""See WorkingTreeFormat.initialize()."""
1992
if not isinstance(a_bzrdir.transport, LocalTransport):
1993
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1994
branch = a_bzrdir.open_branch()
1995
if revision_id is not None:
1998
revision_history = branch.revision_history()
2000
position = revision_history.index(revision_id)
2002
raise errors.NoSuchRevision(branch, revision_id)
2003
branch.set_revision_history(revision_history[:position + 1])
2006
revision = branch.last_revision()
2008
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2014
wt.set_root_id(inv.root.file_id)
2015
basis_tree = branch.repository.revision_tree(revision)
2016
wt.set_parent_trees([(revision, basis_tree)])
2017
build_tree(basis_tree, wt)
2021
super(WorkingTreeFormat2, self).__init__()
2022
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2024
def open(self, a_bzrdir, _found=False):
2025
"""Return the WorkingTree object for a_bzrdir
2027
_found is a private parameter, do not use it. It is used to indicate
2028
if format probing has already been done.
2031
# we are being called directly and must probe.
2032
raise NotImplementedError
2033
if not isinstance(a_bzrdir.transport, LocalTransport):
2034
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2035
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2041
class WorkingTreeFormat3(WorkingTreeFormat):
2042
"""The second working tree format updated to record a format marker.
2045
- exists within a metadir controlling .bzr
2046
- includes an explicit version marker for the workingtree control
2047
files, separate from the BzrDir format
2048
- modifies the hash cache format
2050
- uses a LockDir to guard access for writes.
2053
def get_format_string(self):
2054
"""See WorkingTreeFormat.get_format_string()."""
2055
return "Bazaar-NG Working Tree format 3"
2057
def get_format_description(self):
2058
"""See WorkingTreeFormat.get_format_description()."""
2059
return "Working tree format 3"
2061
_lock_file_name = 'lock'
2062
_lock_class = LockDir
2064
def _open_control_files(self, a_bzrdir):
2065
transport = a_bzrdir.get_workingtree_transport(None)
2066
return LockableFiles(transport, self._lock_file_name,
2069
def initialize(self, a_bzrdir, revision_id=None):
2070
"""See WorkingTreeFormat.initialize().
2072
revision_id allows creating a working tree at a different
2073
revision than the branch is at.
2075
if not isinstance(a_bzrdir.transport, LocalTransport):
2076
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2077
transport = a_bzrdir.get_workingtree_transport(self)
2078
control_files = self._open_control_files(a_bzrdir)
2079
control_files.create_lock()
2080
control_files.lock_write()
2081
control_files.put_utf8('format', self.get_format_string())
2082
branch = a_bzrdir.open_branch()
2083
if revision_id is None:
2084
revision_id = branch.last_revision()
2086
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2092
_control_files=control_files)
2093
wt.lock_tree_write()
2095
# set_root_id will write the inventory to disk.
2096
wt.set_root_id(inv.root.file_id)
2097
basis_tree = branch.repository.revision_tree(revision_id)
2098
if revision_id == bzrlib.revision.NULL_REVISION:
2099
wt.set_parent_trees([])
2101
wt.set_parent_trees([(revision_id, basis_tree)])
2102
build_tree(basis_tree, wt)
2105
control_files.unlock()
2109
super(WorkingTreeFormat3, self).__init__()
2110
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2112
def open(self, a_bzrdir, _found=False):
2113
"""Return the WorkingTree object for a_bzrdir
2115
_found is a private parameter, do not use it. It is used to indicate
2116
if format probing has already been done.
2119
# we are being called directly and must probe.
2120
raise NotImplementedError
2121
if not isinstance(a_bzrdir.transport, LocalTransport):
2122
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2123
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2125
def _open(self, a_bzrdir, control_files):
2126
"""Open the tree itself.
2128
:param a_bzrdir: the dir for the tree.
2129
:param control_files: the control files for the tree.
2131
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2135
_control_files=control_files)
2138
return self.get_format_string()
2141
# formats which have no format string are not discoverable
2142
# and not independently creatable, so are not registered.
2143
__default_format = WorkingTreeFormat3()
2144
WorkingTreeFormat.register_format(__default_format)
2145
WorkingTreeFormat.set_default_format(__default_format)
2146
_legacy_formats = [WorkingTreeFormat2(),
2150
class WorkingTreeTestProviderAdapter(object):
2151
"""A tool to generate a suite testing multiple workingtree formats at once.
2153
This is done by copying the test once for each transport and injecting
2154
the transport_server, transport_readonly_server, and workingtree_format
2155
classes into each copy. Each copy is also given a new id() to make it
2159
def __init__(self, transport_server, transport_readonly_server, formats):
2160
self._transport_server = transport_server
2161
self._transport_readonly_server = transport_readonly_server
2162
self._formats = formats
2164
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2165
"""Clone test for adaption."""
2166
new_test = deepcopy(test)
2167
new_test.transport_server = self._transport_server
2168
new_test.transport_readonly_server = self._transport_readonly_server
2169
new_test.bzrdir_format = bzrdir_format
2170
new_test.workingtree_format = workingtree_format
2171
def make_new_test_id():
2172
new_id = "%s(%s)" % (test.id(), variation)
2173
return lambda: new_id
2174
new_test.id = make_new_test_id()
2177
def adapt(self, test):
2178
from bzrlib.tests import TestSuite
2179
result = TestSuite()
2180
for workingtree_format, bzrdir_format in self._formats:
2181
new_test = self._clone_test(
2184
workingtree_format, workingtree_format.__class__.__name__)
2185
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
