1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
import bzrlib.mutabletree
75
from bzrlib.mutabletree import needs_tree_write_lock
76
from bzrlib.osutils import (
93
from bzrlib.progress import DummyProgress, ProgressPhase
94
from bzrlib.revision import NULL_REVISION
95
import bzrlib.revisiontree
96
from bzrlib.rio import RioReader, rio_file, Stanza
97
from bzrlib.symbol_versioning import (deprecated_passed,
100
DEPRECATED_PARAMETER,
104
from bzrlib.trace import mutter, note
105
from bzrlib.transform import build_tree
106
from bzrlib.transport import get_transport
107
from bzrlib.transport.local import LocalTransport
108
from bzrlib.textui import show_status
113
# the regex removes any weird characters; we don't escape them
114
# but rather just pull them out
115
_gen_file_id_re = re.compile(r'[^\w.]')
116
_gen_id_suffix = None
120
def _next_id_suffix():
121
"""Create a new file id suffix that is reasonably unique.
123
On the first call we combine the current time with 64 bits of randomness
124
to give a highly probably globally unique number. Then each call in the same
125
process adds 1 to a serial number we append to that unique value.
127
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
128
# than having to move the id randomness out of the inner loop like this.
129
# XXX TODO: for the global randomness this uses we should add the thread-id
130
# before the serial #.
131
global _gen_id_suffix, _gen_id_serial
132
if _gen_id_suffix is None:
133
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
135
return _gen_id_suffix + str(_gen_id_serial)
138
def gen_file_id(name):
139
"""Return new file id for the basename 'name'.
141
The uniqueness is supplied from _next_id_suffix.
143
# The real randomness is in the _next_id_suffix, the
144
# rest of the identifier is just to be nice.
146
# 1) Remove non-ascii word characters to keep the ids portable
147
# 2) squash to lowercase, so the file id doesn't have to
148
# be escaped (case insensitive filesystems would bork for ids
149
# that only differred in case without escaping).
150
# 3) truncate the filename to 20 chars. Long filenames also bork on some
152
# 4) Removing starting '.' characters to prevent the file ids from
153
# being considered hidden.
154
ascii_word_only = _gen_file_id_re.sub('', name.lower())
155
short_no_dots = ascii_word_only.lstrip('.')[:20]
156
return short_no_dots + _next_id_suffix()
160
"""Return a new tree-root file id."""
161
return gen_file_id('TREE_ROOT')
164
class TreeEntry(object):
165
"""An entry that implements the minimum interface used by commands.
167
This needs further inspection, it may be better to have
168
InventoryEntries without ids - though that seems wrong. For now,
169
this is a parallel hierarchy to InventoryEntry, and needs to become
170
one of several things: decorates to that hierarchy, children of, or
172
Another note is that these objects are currently only used when there is
173
no InventoryEntry available - i.e. for unversioned objects.
174
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
177
def __eq__(self, other):
178
# yes, this us ugly, TODO: best practice __eq__ style.
179
return (isinstance(other, TreeEntry)
180
and other.__class__ == self.__class__)
182
def kind_character(self):
186
class TreeDirectory(TreeEntry):
187
"""See TreeEntry. This is a directory in a working tree."""
189
def __eq__(self, other):
190
return (isinstance(other, TreeDirectory)
191
and other.__class__ == self.__class__)
193
def kind_character(self):
197
class TreeFile(TreeEntry):
198
"""See TreeEntry. This is a regular file in a working tree."""
200
def __eq__(self, other):
201
return (isinstance(other, TreeFile)
202
and other.__class__ == self.__class__)
204
def kind_character(self):
208
class TreeLink(TreeEntry):
209
"""See TreeEntry. This is a symlink in a working tree."""
211
def __eq__(self, other):
212
return (isinstance(other, TreeLink)
213
and other.__class__ == self.__class__)
215
def kind_character(self):
219
class WorkingTree(bzrlib.mutabletree.MutableTree):
220
"""Working copy tree.
222
The inventory is held in the `Branch` working-inventory, and the
223
files are in a directory on disk.
225
It is possible for a `WorkingTree` to have a filename which is
226
not listed in the Inventory and vice versa.
229
def __init__(self, basedir='.',
230
branch=DEPRECATED_PARAMETER,
236
"""Construct a WorkingTree for basedir.
238
If the branch is not supplied, it is opened automatically.
239
If the branch is supplied, it must be the branch for this basedir.
240
(branch.base is not cross checked, because for remote branches that
241
would be meaningless).
243
self._format = _format
244
self.bzrdir = _bzrdir
246
# not created via open etc.
247
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
248
"Please use bzrdir.open_workingtree or WorkingTree.open().",
251
wt = WorkingTree.open(basedir)
252
self._branch = wt.branch
253
self.basedir = wt.basedir
254
self._control_files = wt._control_files
255
self._hashcache = wt._hashcache
256
self._set_inventory(wt._inventory)
257
self._format = wt._format
258
self.bzrdir = wt.bzrdir
259
from bzrlib.hashcache import HashCache
260
from bzrlib.trace import note, mutter
261
assert isinstance(basedir, basestring), \
262
"base directory %r is not a string" % basedir
263
basedir = safe_unicode(basedir)
264
mutter("opening working tree %r", basedir)
265
if deprecated_passed(branch):
267
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
268
" Please use bzrdir.open_workingtree() or"
269
" WorkingTree.open().",
273
self._branch = branch
275
self._branch = self.bzrdir.open_branch()
276
self.basedir = realpath(basedir)
277
# if branch is at our basedir and is a format 6 or less
278
if isinstance(self._format, WorkingTreeFormat2):
279
# share control object
280
self._control_files = self.branch.control_files
282
# assume all other formats have their own control files.
283
assert isinstance(_control_files, LockableFiles), \
284
"_control_files must be a LockableFiles, not %r" \
286
self._control_files = _control_files
287
# update the whole cache up front and write to disk if anything changed;
288
# in the future we might want to do this more selectively
289
# two possible ways offer themselves : in self._unlock, write the cache
290
# if needed, or, when the cache sees a change, append it to the hash
291
# cache file, and have the parser take the most recent entry for a
293
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
294
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
296
# is this scan needed ? it makes things kinda slow.
303
if _inventory is None:
304
self._set_inventory(self.read_working_inventory())
306
self._set_inventory(_inventory)
309
fget=lambda self: self._branch,
310
doc="""The branch this WorkingTree is connected to.
312
This cannot be set - it is reflective of the actual disk structure
313
the working tree has been constructed from.
316
def break_lock(self):
317
"""Break a lock if one is present from another instance.
319
Uses the ui factory to ask for confirmation if the lock may be from
322
This will probe the repository for its lock as well.
324
self._control_files.break_lock()
325
self.branch.break_lock()
327
def _set_inventory(self, inv):
328
assert inv.root is not None
329
self._inventory = inv
332
def open(path=None, _unsupported=False):
333
"""Open an existing working tree at path.
337
path = os.path.getcwdu()
338
control = bzrdir.BzrDir.open(path, _unsupported)
339
return control.open_workingtree(_unsupported)
342
def open_containing(path=None):
343
"""Open an existing working tree which has its root about path.
345
This probes for a working tree at path and searches upwards from there.
347
Basically we keep looking up until we find the control directory or
348
run into /. If there isn't one, raises NotBranchError.
349
TODO: give this a new exception.
350
If there is one, it is returned, along with the unused portion of path.
352
:return: The WorkingTree that contains 'path', and the rest of path
355
path = osutils.getcwd()
356
control, relpath = bzrdir.BzrDir.open_containing(path)
358
return control.open_workingtree(), relpath
361
def open_downlevel(path=None):
362
"""Open an unsupported working tree.
364
Only intended for advanced situations like upgrading part of a bzrdir.
366
return WorkingTree.open(path, _unsupported=True)
369
"""Iterate through file_ids for this tree.
371
file_ids are in a WorkingTree if they are in the working inventory
372
and the working file exists.
374
inv = self._inventory
375
for path, ie in inv.iter_entries():
376
if osutils.lexists(self.abspath(path)):
380
return "<%s of %s>" % (self.__class__.__name__,
381
getattr(self, 'basedir', None))
383
def abspath(self, filename):
384
return pathjoin(self.basedir, filename)
386
def basis_tree(self):
387
"""Return RevisionTree for the current last revision.
389
If the left most parent is a ghost then the returned tree will be an
390
empty tree - one obtained by calling repository.revision_tree(None).
393
revision_id = self.get_parent_ids()[0]
395
# no parents, return an empty revision tree.
396
# in the future this should return the tree for
397
# 'empty:' - the implicit root empty tree.
398
return self.branch.repository.revision_tree(None)
401
xml = self.read_basis_inventory()
402
inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
403
if inv is not None and inv.revision_id == revision_id:
404
return bzrlib.tree.RevisionTree(self.branch.repository,
406
except (NoSuchFile, errors.BadInventoryFormat):
408
# No cached copy available, retrieve from the repository.
409
# FIXME? RBC 20060403 should we cache the inventory locally
412
return self.branch.repository.revision_tree(revision_id)
413
except errors.RevisionNotPresent:
414
# the basis tree *may* be a ghost or a low level error may have
415
# occured. If the revision is present, its a problem, if its not
417
if self.branch.repository.has_revision(revision_id):
419
# the basis tree is a ghost so return an empty tree.
420
return self.branch.repository.revision_tree(None)
423
@deprecated_method(zero_eight)
424
def create(branch, directory):
425
"""Create a workingtree for branch at directory.
427
If existing_directory already exists it must have a .bzr directory.
428
If it does not exist, it will be created.
430
This returns a new WorkingTree object for the new checkout.
432
TODO FIXME RBC 20060124 when we have checkout formats in place this
433
should accept an optional revisionid to checkout [and reject this if
434
checking out into the same dir as a pre-checkout-aware branch format.]
436
XXX: When BzrDir is present, these should be created through that
439
warnings.warn('delete WorkingTree.create', stacklevel=3)
440
transport = get_transport(directory)
441
if branch.bzrdir.root_transport.base == transport.base:
443
return branch.bzrdir.create_workingtree()
444
# different directory,
445
# create a branch reference
446
# and now a working tree.
447
raise NotImplementedError
450
@deprecated_method(zero_eight)
451
def create_standalone(directory):
452
"""Create a checkout and a branch and a repo at directory.
454
Directory must exist and be empty.
456
please use BzrDir.create_standalone_workingtree
458
return bzrdir.BzrDir.create_standalone_workingtree(directory)
460
def relpath(self, path):
461
"""Return the local path portion from a given path.
463
The path may be absolute or relative. If its a relative path it is
464
interpreted relative to the python current working directory.
466
return relpath(self.basedir, path)
468
def has_filename(self, filename):
469
return osutils.lexists(self.abspath(filename))
471
def get_file(self, file_id):
472
return self.get_file_byname(self.id2path(file_id))
474
def get_file_text(self, file_id):
475
return self.get_file(file_id).read()
477
def get_file_byname(self, filename):
478
return file(self.abspath(filename), 'rb')
480
def get_parent_ids(self):
481
"""See Tree.get_parent_ids.
483
This implementation reads the pending merges list and last_revision
484
value and uses that to decide what the parents list should be.
486
last_rev = self._last_revision()
492
merges_file = self._control_files.get_utf8('pending-merges')
496
for l in merges_file.readlines():
497
parents.append(l.rstrip('\n'))
500
def get_root_id(self):
501
"""Return the id of this trees root"""
502
inv = self.read_working_inventory()
503
return inv.root.file_id
505
def _get_store_filename(self, file_id):
506
## XXX: badly named; this is not in the store at all
507
return self.abspath(self.id2path(file_id))
510
def clone(self, to_bzrdir, revision_id=None, basis=None):
511
"""Duplicate this working tree into to_bzr, including all state.
513
Specifically modified files are kept as modified, but
514
ignored and unknown files are discarded.
516
If you want to make a new line of development, see bzrdir.sprout()
519
If not None, the cloned tree will have its last revision set to
520
revision, and and difference between the source trees last revision
521
and this one merged in.
524
If not None, a closer copy of a tree which may have some files in
525
common, and which file content should be preferentially copied from.
527
# assumes the target bzr dir format is compatible.
528
result = self._format.initialize(to_bzrdir)
529
self.copy_content_into(result, revision_id)
533
def copy_content_into(self, tree, revision_id=None):
534
"""Copy the current content and user files of this tree into tree."""
535
if revision_id is None:
536
transform_tree(tree, self)
538
# TODO now merge from tree.last_revision to revision (to preserve
539
# user local changes)
540
transform_tree(tree, self)
541
tree.set_parent_ids([revision_id])
543
def id2abspath(self, file_id):
544
return self.abspath(self.id2path(file_id))
546
def has_id(self, file_id):
547
# files that have been deleted are excluded
548
inv = self._inventory
549
if not inv.has_id(file_id):
551
path = inv.id2path(file_id)
552
return osutils.lexists(self.abspath(path))
554
def has_or_had_id(self, file_id):
555
if file_id == self.inventory.root.file_id:
557
return self.inventory.has_id(file_id)
559
__contains__ = has_id
561
def get_file_size(self, file_id):
562
return os.path.getsize(self.id2abspath(file_id))
565
def get_file_sha1(self, file_id, path=None):
567
path = self._inventory.id2path(file_id)
568
return self._hashcache.get_sha1(path)
570
def get_file_mtime(self, file_id, path=None):
572
path = self._inventory.id2path(file_id)
573
return os.lstat(self.abspath(path)).st_mtime
575
if not supports_executable():
576
def is_executable(self, file_id, path=None):
577
return self._inventory[file_id].executable
579
def is_executable(self, file_id, path=None):
581
path = self._inventory.id2path(file_id)
582
mode = os.lstat(self.abspath(path)).st_mode
583
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
586
def _add(self, files, ids, kinds):
587
"""See MutableTree._add."""
588
# TODO: Re-adding a file that is removed in the working copy
589
# should probably put it back with the previous ID.
590
# the read and write working inventory should not occur in this
591
# function - they should be part of lock_write and unlock.
592
inv = self.read_working_inventory()
593
for f, file_id, kind in zip(files, ids, kinds):
594
assert kind is not None
596
inv.add_path(f, kind=kind)
598
inv.add_path(f, kind=kind, file_id=file_id)
599
self._write_inventory(inv)
601
@needs_tree_write_lock
602
def _gather_kinds(self, files, kinds):
603
"""See MutableTree._gather_kinds."""
604
for pos, f in enumerate(files):
605
if kinds[pos] is None:
606
fullpath = normpath(self.abspath(f))
608
kinds[pos] = file_kind(fullpath)
610
if e.errno == errno.ENOENT:
611
raise NoSuchFile(fullpath)
614
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
615
"""Add revision_id as a parent.
617
This is equivalent to retrieving the current list of parent ids
618
and setting the list to its value plus revision_id.
620
:param revision_id: The revision id to add to the parent list. It may
621
be a ghost revision as long as its not the first parent to be added,
622
or the allow_leftmost_as_ghost parameter is set True.
623
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
625
parents = self.get_parent_ids() + [revision_id]
626
self.set_parent_ids(parents,
627
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
629
@needs_tree_write_lock
630
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
631
"""Add revision_id, tree tuple as a parent.
633
This is equivalent to retrieving the current list of parent trees
634
and setting the list to its value plus parent_tuple. See also
635
add_parent_tree_id - if you only have a parent id available it will be
636
simpler to use that api. If you have the parent already available, using
637
this api is preferred.
639
:param parent_tuple: The (revision id, tree) to add to the parent list.
640
If the revision_id is a ghost, pass None for the tree.
641
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
643
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
644
if len(parent_ids) > 1:
645
# the leftmost may have already been a ghost, preserve that if it
647
allow_leftmost_as_ghost = True
648
self.set_parent_ids(parent_ids,
649
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
651
@needs_tree_write_lock
652
def add_pending_merge(self, *revision_ids):
653
# TODO: Perhaps should check at this point that the
654
# history of the revision is actually present?
655
parents = self.get_parent_ids()
657
for rev_id in revision_ids:
658
if rev_id in parents:
660
parents.append(rev_id)
663
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
665
@deprecated_method(zero_eleven)
667
def pending_merges(self):
668
"""Return a list of pending merges.
670
These are revisions that have been merged into the working
671
directory but not yet committed.
673
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
674
instead - which is available on all tree objects.
676
return self.get_parent_ids()[1:]
678
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
679
"""Common ghost checking functionality from set_parent_*.
681
This checks that the left hand-parent exists if there are any
684
if len(revision_ids) > 0:
685
leftmost_id = revision_ids[0]
686
if (not allow_leftmost_as_ghost and not
687
self.branch.repository.has_revision(leftmost_id)):
688
raise errors.GhostRevisionUnusableHere(leftmost_id)
690
def _set_merges_from_parent_ids(self, parent_ids):
691
merges = parent_ids[1:]
692
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
694
@needs_tree_write_lock
695
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
696
"""Set the parent ids to revision_ids.
698
See also set_parent_trees. This api will try to retrieve the tree data
699
for each element of revision_ids from the trees repository. If you have
700
tree data already available, it is more efficient to use
701
set_parent_trees rather than set_parent_ids. set_parent_ids is however
702
an easier API to use.
704
:param revision_ids: The revision_ids to set as the parent ids of this
705
working tree. Any of these may be ghosts.
707
self._check_parents_for_ghosts(revision_ids,
708
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
710
if len(revision_ids) > 0:
711
self.set_last_revision(revision_ids[0])
713
self.set_last_revision(None)
715
self._set_merges_from_parent_ids(revision_ids)
717
@needs_tree_write_lock
718
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
719
"""See MutableTree.set_parent_trees."""
720
parent_ids = [rev for (rev, tree) in parents_list]
722
self._check_parents_for_ghosts(parent_ids,
723
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
725
if len(parent_ids) == 0:
726
leftmost_parent_id = None
727
leftmost_parent_tree = None
729
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
731
if self._change_last_revision(leftmost_parent_id):
732
if leftmost_parent_tree is None:
733
# If we don't have a tree, fall back to reading the
734
# parent tree from the repository.
735
self._cache_basis_inventory(leftmost_parent_id)
737
inv = leftmost_parent_tree.inventory
738
xml = self._create_basis_xml_from_inventory(
739
leftmost_parent_id, inv)
740
self._write_basis_inventory(xml)
741
self._set_merges_from_parent_ids(parent_ids)
743
@needs_tree_write_lock
744
def set_pending_merges(self, rev_list):
745
parents = self.get_parent_ids()
746
leftmost = parents[:1]
747
new_parents = leftmost + rev_list
748
self.set_parent_ids(new_parents)
750
@needs_tree_write_lock
751
def set_merge_modified(self, modified_hashes):
753
for file_id, hash in modified_hashes.iteritems():
754
yield Stanza(file_id=file_id, hash=hash)
755
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
757
@needs_tree_write_lock
758
def _put_rio(self, filename, stanzas, header):
759
my_file = rio_file(stanzas, header)
760
self._control_files.put(filename, my_file)
762
@needs_write_lock # because merge pulls data into the branch.
763
def merge_from_branch(self, branch, to_revision=None):
764
"""Merge from a branch into this working tree.
766
:param branch: The branch to merge from.
767
:param to_revision: If non-None, the merge will merge to to_revision, but
768
not beyond it. to_revision does not need to be in the history of
769
the branch when it is supplied. If None, to_revision defaults to
770
branch.last_revision().
772
from bzrlib.merge import Merger, Merge3Merger
773
pb = bzrlib.ui.ui_factory.nested_progress_bar()
775
merger = Merger(self.branch, this_tree=self, pb=pb)
776
merger.pp = ProgressPhase("Merge phase", 5, pb)
777
merger.pp.next_phase()
778
# check that there are no
780
merger.check_basis(check_clean=True, require_commits=False)
781
if to_revision is None:
782
to_revision = branch.last_revision()
783
merger.other_rev_id = to_revision
784
if merger.other_rev_id is None:
785
raise error.NoCommits(branch)
786
self.branch.fetch(branch, last_revision=merger.other_rev_id)
787
merger.other_basis = merger.other_rev_id
788
merger.other_tree = self.branch.repository.revision_tree(
790
merger.pp.next_phase()
792
if merger.base_rev_id == merger.other_rev_id:
793
raise errors.PointlessMerge
794
merger.backup_files = False
795
merger.merge_type = Merge3Merger
796
merger.set_interesting_files(None)
797
merger.show_base = False
798
merger.reprocess = False
799
conflicts = merger.do_merge()
806
def merge_modified(self):
808
hashfile = self._control_files.get('merge-hashes')
813
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
814
raise MergeModifiedFormatError()
815
except StopIteration:
816
raise MergeModifiedFormatError()
817
for s in RioReader(hashfile):
818
file_id = s.get("file_id")
819
if file_id not in self.inventory:
822
if hash == self.get_file_sha1(file_id):
823
merge_hashes[file_id] = hash
827
def mkdir(self, path, file_id=None):
828
"""See MutableTree.mkdir()."""
830
file_id = gen_file_id(os.path.basename(path))
831
os.mkdir(self.abspath(path))
832
self.add(path, file_id, 'directory')
835
def get_symlink_target(self, file_id):
836
return os.readlink(self.id2abspath(file_id))
838
def file_class(self, filename):
839
if self.path2id(filename):
841
elif self.is_ignored(filename):
846
def list_files(self, include_root=False):
847
"""Recursively list all files as (path, class, kind, id, entry).
849
Lists, but does not descend into unversioned directories.
851
This does not include files that have been deleted in this
854
Skips the control directory.
856
inv = self._inventory
857
if include_root is True:
858
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
859
# Convert these into local objects to save lookup times
860
pathjoin = osutils.pathjoin
861
file_kind = osutils.file_kind
863
# transport.base ends in a slash, we want the piece
864
# between the last two slashes
865
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
867
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
869
# directory file_id, relative path, absolute path, reverse sorted children
870
children = os.listdir(self.basedir)
872
# jam 20060527 The kernel sized tree seems equivalent whether we
873
# use a deque and popleft to keep them sorted, or if we use a plain
874
# list and just reverse() them.
875
children = collections.deque(children)
876
stack = [(inv.root.file_id, u'', self.basedir, children)]
878
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
881
f = children.popleft()
882
## TODO: If we find a subdirectory with its own .bzr
883
## directory, then that is a separate tree and we
884
## should exclude it.
886
# the bzrdir for this tree
887
if transport_base_dir == f:
890
# we know that from_dir_relpath and from_dir_abspath never end in a slash
891
# and 'f' doesn't begin with one, we can do a string op, rather
892
# than the checks of pathjoin(), all relative paths will have an extra slash
894
fp = from_dir_relpath + '/' + f
897
fap = from_dir_abspath + '/' + f
899
f_ie = inv.get_child(from_dir_id, f)
902
elif self.is_ignored(fp[1:]):
905
# we may not have found this file, because of a unicode issue
906
f_norm, can_access = osutils.normalized_filename(f)
907
if f == f_norm or not can_access:
908
# No change, so treat this file normally
911
# this file can be accessed by a normalized path
912
# check again if it is versioned
913
# these lines are repeated here for performance
915
fp = from_dir_relpath + '/' + f
916
fap = from_dir_abspath + '/' + f
917
f_ie = inv.get_child(from_dir_id, f)
920
elif self.is_ignored(fp[1:]):
929
raise BzrCheckError("file %r entered as kind %r id %r, "
931
% (fap, f_ie.kind, f_ie.file_id, fk))
933
# make a last minute entry
935
yield fp[1:], c, fk, f_ie.file_id, f_ie
938
yield fp[1:], c, fk, None, fk_entries[fk]()
940
yield fp[1:], c, fk, None, TreeEntry()
943
if fk != 'directory':
946
# But do this child first
947
new_children = os.listdir(fap)
949
new_children = collections.deque(new_children)
950
stack.append((f_ie.file_id, fp, fap, new_children))
951
# Break out of inner loop, so that we start outer loop with child
954
# if we finished all children, pop it off the stack
957
@needs_tree_write_lock
958
def move(self, from_paths, to_name):
961
to_name must exist in the inventory.
963
If to_name exists and is a directory, the files are moved into
964
it, keeping their old names.
966
Note that to_name is only the last component of the new name;
967
this doesn't change the directory.
969
This returns a list of (from_path, to_path) pairs for each
973
## TODO: Option to move IDs only
974
assert not isinstance(from_paths, basestring)
976
to_abs = self.abspath(to_name)
977
if not isdir(to_abs):
978
raise BzrError("destination %r is not a directory" % to_abs)
979
if not self.has_filename(to_name):
980
raise BzrError("destination %r not in working directory" % to_abs)
981
to_dir_id = inv.path2id(to_name)
982
if to_dir_id is None and to_name != '':
983
raise BzrError("destination %r is not a versioned directory" % to_name)
984
to_dir_ie = inv[to_dir_id]
985
if to_dir_ie.kind != 'directory':
986
raise BzrError("destination %r is not a directory" % to_abs)
988
to_idpath = inv.get_idpath(to_dir_id)
991
if not self.has_filename(f):
992
raise BzrError("%r does not exist in working tree" % f)
993
f_id = inv.path2id(f)
995
raise BzrError("%r is not versioned" % f)
996
name_tail = splitpath(f)[-1]
997
dest_path = pathjoin(to_name, name_tail)
998
if self.has_filename(dest_path):
999
raise BzrError("destination %r already exists" % dest_path)
1000
if f_id in to_idpath:
1001
raise BzrError("can't move %r to a subdirectory of itself" % f)
1003
# OK, so there's a race here, it's possible that someone will
1004
# create a file in this interval and then the rename might be
1005
# left half-done. But we should have caught most problems.
1006
orig_inv = deepcopy(self.inventory)
1008
for f in from_paths:
1009
name_tail = splitpath(f)[-1]
1010
dest_path = pathjoin(to_name, name_tail)
1011
result.append((f, dest_path))
1012
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1014
rename(self.abspath(f), self.abspath(dest_path))
1016
raise BzrError("failed to rename %r to %r: %s" %
1017
(f, dest_path, e[1]),
1018
["rename rolled back"])
1020
# restore the inventory on error
1021
self._set_inventory(orig_inv)
1023
self._write_inventory(inv)
1026
@needs_tree_write_lock
1027
def rename_one(self, from_rel, to_rel):
1030
This can change the directory or the filename or both.
1032
inv = self.inventory
1033
if not self.has_filename(from_rel):
1034
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1035
if self.has_filename(to_rel):
1036
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1038
file_id = inv.path2id(from_rel)
1040
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1042
entry = inv[file_id]
1043
from_parent = entry.parent_id
1044
from_name = entry.name
1046
if inv.path2id(to_rel):
1047
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1049
to_dir, to_tail = os.path.split(to_rel)
1050
to_dir_id = inv.path2id(to_dir)
1051
if to_dir_id is None and to_dir != '':
1052
raise BzrError("can't determine destination directory id for %r" % to_dir)
1054
mutter("rename_one:")
1055
mutter(" file_id {%s}" % file_id)
1056
mutter(" from_rel %r" % from_rel)
1057
mutter(" to_rel %r" % to_rel)
1058
mutter(" to_dir %r" % to_dir)
1059
mutter(" to_dir_id {%s}" % to_dir_id)
1061
inv.rename(file_id, to_dir_id, to_tail)
1063
from_abs = self.abspath(from_rel)
1064
to_abs = self.abspath(to_rel)
1066
rename(from_abs, to_abs)
1068
inv.rename(file_id, from_parent, from_name)
1069
raise BzrError("failed to rename %r to %r: %s"
1070
% (from_abs, to_abs, e[1]),
1071
["rename rolled back"])
1072
self._write_inventory(inv)
1076
"""Return all unknown files.
1078
These are files in the working directory that are not versioned or
1079
control files or ignored.
1081
for subp in self.extras():
1082
if not self.is_ignored(subp):
1085
@needs_tree_write_lock
1086
def unversion(self, file_ids):
1087
"""Remove the file ids in file_ids from the current versioned set.
1089
When a file_id is unversioned, all of its children are automatically
1092
:param file_ids: The file ids to stop versioning.
1093
:raises: NoSuchId if any fileid is not currently versioned.
1095
for file_id in file_ids:
1096
if self._inventory.has_id(file_id):
1097
self._inventory.remove_recursive_id(file_id)
1099
raise errors.NoSuchId(self, file_id)
1101
# in the future this should just set a dirty bit to wait for the
1102
# final unlock. However, until all methods of workingtree start
1103
# with the current in -memory inventory rather than triggering
1104
# a read, it is more complex - we need to teach read_inventory
1105
# to know when to read, and when to not read first... and possibly
1106
# to save first when the in memory one may be corrupted.
1107
# so for now, we just only write it if it is indeed dirty.
1109
self._write_inventory(self._inventory)
1111
@deprecated_method(zero_eight)
1112
def iter_conflicts(self):
1113
"""List all files in the tree that have text or content conflicts.
1114
DEPRECATED. Use conflicts instead."""
1115
return self._iter_conflicts()
1117
def _iter_conflicts(self):
1119
for info in self.list_files():
1121
stem = get_conflicted_stem(path)
1124
if stem not in conflicted:
1125
conflicted.add(stem)
1129
def pull(self, source, overwrite=False, stop_revision=None):
1130
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1133
pp = ProgressPhase("Pull phase", 2, top_pb)
1135
old_revision_history = self.branch.revision_history()
1136
basis_tree = self.basis_tree()
1137
count = self.branch.pull(source, overwrite, stop_revision)
1138
new_revision_history = self.branch.revision_history()
1139
if new_revision_history != old_revision_history:
1141
if len(old_revision_history):
1142
other_revision = old_revision_history[-1]
1144
other_revision = None
1145
repository = self.branch.repository
1146
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1148
new_basis_tree = self.branch.basis_tree()
1149
merge_inner(self.branch,
1156
# TODO - dedup parents list with things merged by pull ?
1157
# reuse the revisiontree we merged against to set the new
1159
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1160
# we have to pull the merge trees out again, because
1161
# merge_inner has set the ids. - this corner is not yet
1162
# layered well enough to prevent double handling.
1163
merges = self.get_parent_ids()[1:]
1164
parent_trees.extend([
1165
(parent, repository.revision_tree(parent)) for
1167
self.set_parent_trees(parent_trees)
1174
def put_file_bytes_non_atomic(self, file_id, bytes):
1175
"""See MutableTree.put_file_bytes_non_atomic."""
1176
stream = file(self.id2abspath(file_id), 'wb')
1181
# TODO: update the hashcache here ?
1184
"""Yield all unknown files in this WorkingTree.
1186
If there are any unknown directories then only the directory is
1187
returned, not all its children. But if there are unknown files
1188
under a versioned subdirectory, they are returned.
1190
Currently returned depth-first, sorted by name within directories.
1192
## TODO: Work from given directory downwards
1193
for path, dir_entry in self.inventory.directories():
1194
# mutter("search for unknowns in %r", path)
1195
dirabs = self.abspath(path)
1196
if not isdir(dirabs):
1197
# e.g. directory deleted
1201
for subf in os.listdir(dirabs):
1204
if subf not in dir_entry.children:
1205
subf_norm, can_access = osutils.normalized_filename(subf)
1206
if subf_norm != subf and can_access:
1207
if subf_norm not in dir_entry.children:
1208
fl.append(subf_norm)
1214
subp = pathjoin(path, subf)
1217
def _translate_ignore_rule(self, rule):
1218
"""Translate a single ignore rule to a regex.
1220
There are two types of ignore rules. Those that do not contain a / are
1221
matched against the tail of the filename (that is, they do not care
1222
what directory the file is in.) Rules which do contain a slash must
1223
match the entire path. As a special case, './' at the start of the
1224
string counts as a slash in the string but is removed before matching
1225
(e.g. ./foo.c, ./src/foo.c)
1227
:return: The translated regex.
1229
if rule[:2] in ('./', '.\\'):
1231
result = fnmatch.translate(rule[2:])
1232
elif '/' in rule or '\\' in rule:
1234
result = fnmatch.translate(rule)
1236
# default rule style.
1237
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1238
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1239
return "(" + result + ")"
1241
def _combine_ignore_rules(self, rules):
1242
"""Combine a list of ignore rules into a single regex object.
1244
Each individual rule is combined with | to form a big regex, which then
1245
has $ added to it to form something like ()|()|()$. The group index for
1246
each subregex's outermost group is placed in a dictionary mapping back
1247
to the rule. This allows quick identification of the matching rule that
1249
:return: a list of the compiled regex and the matching-group index
1250
dictionaries. We return a list because python complains if you try to
1251
combine more than 100 regexes.
1256
translated_rules = []
1258
translated_rule = self._translate_ignore_rule(rule)
1259
compiled_rule = re.compile(translated_rule)
1260
groups[next_group] = rule
1261
next_group += compiled_rule.groups
1262
translated_rules.append(translated_rule)
1263
if next_group == 99:
1264
result.append((re.compile("|".join(translated_rules)), groups))
1267
translated_rules = []
1268
if len(translated_rules):
1269
result.append((re.compile("|".join(translated_rules)), groups))
1272
def ignored_files(self):
1273
"""Yield list of PATH, IGNORE_PATTERN"""
1274
for subp in self.extras():
1275
pat = self.is_ignored(subp)
1279
def get_ignore_list(self):
1280
"""Return list of ignore patterns.
1282
Cached in the Tree object after the first call.
1284
ignoreset = getattr(self, '_ignoreset', None)
1285
if ignoreset is not None:
1288
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1289
ignore_globs.update(ignores.get_runtime_ignores())
1291
ignore_globs.update(ignores.get_user_ignores())
1293
if self.has_filename(bzrlib.IGNORE_FILENAME):
1294
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1296
ignore_globs.update(ignores.parse_ignore_file(f))
1300
self._ignoreset = ignore_globs
1301
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1304
def _get_ignore_rules_as_regex(self):
1305
"""Return a regex of the ignore rules and a mapping dict.
1307
:return: (ignore rules compiled regex, dictionary mapping rule group
1308
indices to original rule.)
1310
if getattr(self, '_ignoreset', None) is None:
1311
self.get_ignore_list()
1312
return self._ignore_regex
1314
def is_ignored(self, filename):
1315
r"""Check whether the filename matches an ignore pattern.
1317
Patterns containing '/' or '\' need to match the whole path;
1318
others match against only the last component.
1320
If the file is ignored, returns the pattern which caused it to
1321
be ignored, otherwise None. So this can simply be used as a
1322
boolean if desired."""
1324
# TODO: Use '**' to match directories, and other extended
1325
# globbing stuff from cvs/rsync.
1327
# XXX: fnmatch is actually not quite what we want: it's only
1328
# approximately the same as real Unix fnmatch, and doesn't
1329
# treat dotfiles correctly and allows * to match /.
1330
# Eventually it should be replaced with something more
1333
rules = self._get_ignore_rules_as_regex()
1334
for regex, mapping in rules:
1335
match = regex.match(filename)
1336
if match is not None:
1337
# one or more of the groups in mapping will have a non-None
1339
groups = match.groups()
1340
rules = [mapping[group] for group in
1341
mapping if groups[group] is not None]
1345
def kind(self, file_id):
1346
return file_kind(self.id2abspath(file_id))
1348
def last_revision(self):
1349
"""Return the last revision of the branch for this tree.
1351
This format tree does not support a separate marker for last-revision
1352
compared to the branch.
1354
See MutableTree.last_revision
1356
return self._last_revision()
1359
def _last_revision(self):
1360
"""helper for get_parent_ids."""
1361
return self.branch.last_revision()
1363
def is_locked(self):
1364
return self._control_files.is_locked()
1366
def lock_read(self):
1367
"""See Branch.lock_read, and WorkingTree.unlock."""
1368
self.branch.lock_read()
1370
return self._control_files.lock_read()
1372
self.branch.unlock()
1375
def lock_tree_write(self):
1376
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1377
self.branch.lock_read()
1379
return self._control_files.lock_write()
1381
self.branch.unlock()
1384
def lock_write(self):
1385
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1386
self.branch.lock_write()
1388
return self._control_files.lock_write()
1390
self.branch.unlock()
1393
def get_physical_lock_status(self):
1394
return self._control_files.get_physical_lock_status()
1396
def _basis_inventory_name(self):
1397
return 'basis-inventory-cache'
1399
@needs_tree_write_lock
1400
def set_last_revision(self, new_revision):
1401
"""Change the last revision in the working tree."""
1402
if self._change_last_revision(new_revision):
1403
self._cache_basis_inventory(new_revision)
1405
def _change_last_revision(self, new_revision):
1406
"""Template method part of set_last_revision to perform the change.
1408
This is used to allow WorkingTree3 instances to not affect branch
1409
when their last revision is set.
1411
if new_revision is None:
1412
self.branch.set_revision_history([])
1415
self.branch.generate_revision_history(new_revision)
1416
except errors.NoSuchRevision:
1417
# not present in the repo - dont try to set it deeper than the tip
1418
self.branch.set_revision_history([new_revision])
1421
def _write_basis_inventory(self, xml):
1422
"""Write the basis inventory XML to the basis-inventory file"""
1423
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1424
path = self._basis_inventory_name()
1426
self._control_files.put(path, sio)
1428
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1429
"""Create the text that will be saved in basis-inventory"""
1430
inventory.revision_id = revision_id
1431
return bzrlib.xml6.serializer_v6.write_inventory_to_string(inventory)
1433
def _cache_basis_inventory(self, new_revision):
1434
"""Cache new_revision as the basis inventory."""
1435
# TODO: this should allow the ready-to-use inventory to be passed in,
1436
# as commit already has that ready-to-use [while the format is the
1439
# this double handles the inventory - unpack and repack -
1440
# but is easier to understand. We can/should put a conditional
1441
# in here based on whether the inventory is in the latest format
1442
# - perhaps we should repack all inventories on a repository
1444
# the fast path is to copy the raw xml from the repository. If the
1445
# xml contains 'revision_id="', then we assume the right
1446
# revision_id is set. We must check for this full string, because a
1447
# root node id can legitimately look like 'revision_id' but cannot
1449
xml = self.branch.repository.get_inventory_xml(new_revision)
1450
firstline = xml.split('\n', 1)[0]
1451
if (not 'revision_id="' in firstline or
1452
'format="6"' not in firstline):
1453
inv = self.branch.repository.deserialise_inventory(
1455
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1456
self._write_basis_inventory(xml)
1457
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1460
def read_basis_inventory(self):
1461
"""Read the cached basis inventory."""
1462
path = self._basis_inventory_name()
1463
return self._control_files.get(path).read()
1466
def read_working_inventory(self):
1467
"""Read the working inventory."""
1468
# ElementTree does its own conversion from UTF-8, so open in
1470
result = bzrlib.xml5.serializer_v5.read_inventory(
1471
self._control_files.get('inventory'))
1472
self._set_inventory(result)
1475
@needs_tree_write_lock
1476
def remove(self, files, verbose=False, to_file=None):
1477
"""Remove nominated files from the working inventory..
1479
This does not remove their text. This does not run on XXX on what? RBC
1481
TODO: Refuse to remove modified files unless --force is given?
1483
TODO: Do something useful with directories.
1485
TODO: Should this remove the text or not? Tough call; not
1486
removing may be useful and the user can just use use rm, and
1487
is the opposite of add. Removing it is consistent with most
1488
other tools. Maybe an option.
1490
## TODO: Normalize names
1491
## TODO: Remove nested loops; better scalability
1492
if isinstance(files, basestring):
1495
inv = self.inventory
1497
# do this before any modifications
1499
fid = inv.path2id(f)
1501
# TODO: Perhaps make this just a warning, and continue?
1502
# This tends to happen when
1503
raise NotVersionedError(path=f)
1505
# having remove it, it must be either ignored or unknown
1506
if self.is_ignored(f):
1510
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1513
self._write_inventory(inv)
1515
@needs_tree_write_lock
1516
def revert(self, filenames, old_tree=None, backups=True,
1517
pb=DummyProgress()):
1518
from transform import revert
1519
from conflicts import resolve
1520
if old_tree is None:
1521
old_tree = self.basis_tree()
1522
conflicts = revert(self, old_tree, filenames, backups, pb)
1523
if not len(filenames):
1524
self.set_parent_ids(self.get_parent_ids()[:1])
1527
resolve(self, filenames, ignore_misses=True)
1530
# XXX: This method should be deprecated in favour of taking in a proper
1531
# new Inventory object.
1532
@needs_tree_write_lock
1533
def set_inventory(self, new_inventory_list):
1534
from bzrlib.inventory import (Inventory,
1539
inv = Inventory(self.get_root_id())
1540
for path, file_id, parent, kind in new_inventory_list:
1541
name = os.path.basename(path)
1544
# fixme, there should be a factory function inv,add_??
1545
if kind == 'directory':
1546
inv.add(InventoryDirectory(file_id, name, parent))
1547
elif kind == 'file':
1548
inv.add(InventoryFile(file_id, name, parent))
1549
elif kind == 'symlink':
1550
inv.add(InventoryLink(file_id, name, parent))
1552
raise BzrError("unknown kind %r" % kind)
1553
self._write_inventory(inv)
1555
@needs_tree_write_lock
1556
def set_root_id(self, file_id):
1557
"""Set the root id for this tree."""
1558
inv = self.read_working_inventory()
1559
orig_root_id = inv.root.file_id
1560
del inv._byid[inv.root.file_id]
1561
inv.root.file_id = file_id
1562
inv._byid[inv.root.file_id] = inv.root
1565
if entry.parent_id == orig_root_id:
1566
entry.parent_id = inv.root.file_id
1567
self._write_inventory(inv)
1570
"""See Branch.unlock.
1572
WorkingTree locking just uses the Branch locking facilities.
1573
This is current because all working trees have an embedded branch
1574
within them. IF in the future, we were to make branch data shareable
1575
between multiple working trees, i.e. via shared storage, then we
1576
would probably want to lock both the local tree, and the branch.
1578
raise NotImplementedError(self.unlock)
1582
"""Update a working tree along its branch.
1584
This will update the branch if its bound too, which means we have multiple trees involved:
1585
The new basis tree of the master.
1586
The old basis tree of the branch.
1587
The old basis tree of the working tree.
1588
The current working tree state.
1589
pathologically all three may be different, and non ancestors of each other.
1590
Conceptually we want to:
1591
Preserve the wt.basis->wt.state changes
1592
Transform the wt.basis to the new master basis.
1593
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1594
Restore the wt.basis->wt.state changes.
1596
There isn't a single operation at the moment to do that, so we:
1597
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1598
Do a 'normal' merge of the old branch basis if it is relevant.
1600
old_tip = self.branch.update()
1601
# here if old_tip is not None, it is the old tip of the branch before
1602
# it was updated from the master branch. This should become a pending
1603
# merge in the working tree to preserve the user existing work. we
1604
# cant set that until we update the working trees last revision to be
1605
# one from the new branch, because it will just get absorbed by the
1606
# parent de-duplication logic.
1608
# We MUST save it even if an error occurs, because otherwise the users
1609
# local work is unreferenced and will appear to have been lost.
1613
last_rev = self.get_parent_ids()[0]
1616
if last_rev != self.branch.last_revision():
1617
# merge tree state up to new branch tip.
1618
basis = self.basis_tree()
1619
to_tree = self.branch.basis_tree()
1620
result += merge_inner(self.branch,
1624
# TODO - dedup parents list with things merged by pull ?
1625
# reuse the tree we've updated to to set the basis:
1626
parent_trees = [(self.branch.last_revision(), to_tree)]
1627
merges = self.get_parent_ids()[1:]
1628
# Ideally we ask the tree for the trees here, that way the working
1629
# tree can decide whether to give us teh entire tree or give us a
1630
# lazy initialised tree. dirstate for instance will have the trees
1631
# in ram already, whereas a last-revision + basis-inventory tree
1632
# will not, but also does not need them when setting parents.
1633
for parent in merges:
1634
parent_trees.append(
1635
(parent, self.branch.repository.revision_tree(parent)))
1636
if old_tip is not None:
1637
parent_trees.append(
1638
(old_tip, self.branch.repository.revision_tree(old_tip)))
1639
self.set_parent_trees(parent_trees)
1640
last_rev = parent_trees[0][0]
1642
# the working tree had the same last-revision as the master
1643
# branch did. We may still have pivot local work from the local
1644
# branch into old_tip:
1645
if old_tip is not None:
1646
self.add_parent_tree_id(old_tip)
1647
if old_tip and old_tip != last_rev:
1648
# our last revision was not the prior branch last revision
1649
# and we have converted that last revision to a pending merge.
1650
# base is somewhere between the branch tip now
1651
# and the now pending merge
1652
from bzrlib.revision import common_ancestor
1654
base_rev_id = common_ancestor(self.branch.last_revision(),
1656
self.branch.repository)
1657
except errors.NoCommonAncestor:
1659
base_tree = self.branch.repository.revision_tree(base_rev_id)
1660
other_tree = self.branch.repository.revision_tree(old_tip)
1661
result += merge_inner(self.branch,
1667
@needs_tree_write_lock
1668
def _write_inventory(self, inv):
1669
"""Write inventory as the current inventory."""
1671
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1673
self._control_files.put('inventory', sio)
1674
self._set_inventory(inv)
1675
mutter('wrote working inventory')
1677
def set_conflicts(self, arg):
1678
raise UnsupportedOperation(self.set_conflicts, self)
1680
def add_conflicts(self, arg):
1681
raise UnsupportedOperation(self.add_conflicts, self)
1684
def conflicts(self):
1685
conflicts = ConflictList()
1686
for conflicted in self._iter_conflicts():
1689
if file_kind(self.abspath(conflicted)) != "file":
1691
except errors.NoSuchFile:
1694
for suffix in ('.THIS', '.OTHER'):
1696
kind = file_kind(self.abspath(conflicted+suffix))
1699
except errors.NoSuchFile:
1703
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1704
conflicts.append(Conflict.factory(ctype, path=conflicted,
1705
file_id=self.path2id(conflicted)))
1709
class WorkingTree2(WorkingTree):
1710
"""This is the Format 2 working tree.
1712
This was the first weave based working tree.
1713
- uses os locks for locking.
1714
- uses the branch last-revision.
1717
def lock_tree_write(self):
1718
"""See WorkingTree.lock_tree_write().
1720
In Format2 WorkingTrees we have a single lock for the branch and tree
1721
so lock_tree_write() degrades to lock_write().
1723
self.branch.lock_write()
1725
return self._control_files.lock_write()
1727
self.branch.unlock()
1731
# we share control files:
1732
if self._hashcache.needs_write and self._control_files._lock_count==3:
1733
self._hashcache.write()
1734
# reverse order of locking.
1736
return self._control_files.unlock()
1738
self.branch.unlock()
1741
class WorkingTree3(WorkingTree):
1742
"""This is the Format 3 working tree.
1744
This differs from the base WorkingTree by:
1745
- having its own file lock
1746
- having its own last-revision property.
1748
This is new in bzr 0.8
1752
def _last_revision(self):
1753
"""See Mutable.last_revision."""
1755
return self._control_files.get_utf8('last-revision').read()
1759
def _change_last_revision(self, revision_id):
1760
"""See WorkingTree._change_last_revision."""
1761
if revision_id is None or revision_id == NULL_REVISION:
1763
self._control_files._transport.delete('last-revision')
1764
except errors.NoSuchFile:
1768
self._control_files.put_utf8('last-revision', revision_id)
1771
@needs_tree_write_lock
1772
def set_conflicts(self, conflicts):
1773
self._put_rio('conflicts', conflicts.to_stanzas(),
1776
@needs_tree_write_lock
1777
def add_conflicts(self, new_conflicts):
1778
conflict_set = set(self.conflicts())
1779
conflict_set.update(set(list(new_conflicts)))
1780
self.set_conflicts(ConflictList(sorted(conflict_set,
1781
key=Conflict.sort_key)))
1784
def conflicts(self):
1786
confile = self._control_files.get('conflicts')
1788
return ConflictList()
1790
if confile.next() != CONFLICT_HEADER_1 + '\n':
1791
raise ConflictFormatError()
1792
except StopIteration:
1793
raise ConflictFormatError()
1794
return ConflictList.from_stanzas(RioReader(confile))
1797
if self._hashcache.needs_write and self._control_files._lock_count==1:
1798
self._hashcache.write()
1799
# reverse order of locking.
1801
return self._control_files.unlock()
1803
self.branch.unlock()
1806
def get_conflicted_stem(path):
1807
for suffix in CONFLICT_SUFFIXES:
1808
if path.endswith(suffix):
1809
return path[:-len(suffix)]
1811
@deprecated_function(zero_eight)
1812
def is_control_file(filename):
1813
"""See WorkingTree.is_control_filename(filename)."""
1814
## FIXME: better check
1815
filename = normpath(filename)
1816
while filename != '':
1817
head, tail = os.path.split(filename)
1818
## mutter('check %r for control file' % ((head, tail),))
1821
if filename == head:
1827
class WorkingTreeFormat(object):
1828
"""An encapsulation of the initialization and open routines for a format.
1830
Formats provide three things:
1831
* An initialization routine,
1835
Formats are placed in an dict by their format string for reference
1836
during workingtree opening. Its not required that these be instances, they
1837
can be classes themselves with class methods - it simply depends on
1838
whether state is needed for a given format or not.
1840
Once a format is deprecated, just deprecate the initialize and open
1841
methods on the format class. Do not deprecate the object, as the
1842
object will be created every time regardless.
1845
_default_format = None
1846
"""The default format used for new trees."""
1849
"""The known formats."""
1852
def find_format(klass, a_bzrdir):
1853
"""Return the format for the working tree object in a_bzrdir."""
1855
transport = a_bzrdir.get_workingtree_transport(None)
1856
format_string = transport.get("format").read()
1857
return klass._formats[format_string]
1859
raise errors.NoWorkingTree(base=transport.base)
1861
raise errors.UnknownFormatError(format=format_string)
1864
def get_default_format(klass):
1865
"""Return the current default format."""
1866
return klass._default_format
1868
def get_format_string(self):
1869
"""Return the ASCII format string that identifies this format."""
1870
raise NotImplementedError(self.get_format_string)
1872
def get_format_description(self):
1873
"""Return the short description for this format."""
1874
raise NotImplementedError(self.get_format_description)
1876
def is_supported(self):
1877
"""Is this format supported?
1879
Supported formats can be initialized and opened.
1880
Unsupported formats may not support initialization or committing or
1881
some other features depending on the reason for not being supported.
1886
def register_format(klass, format):
1887
klass._formats[format.get_format_string()] = format
1890
def set_default_format(klass, format):
1891
klass._default_format = format
1894
def unregister_format(klass, format):
1895
assert klass._formats[format.get_format_string()] is format
1896
del klass._formats[format.get_format_string()]
1900
class WorkingTreeFormat2(WorkingTreeFormat):
1901
"""The second working tree format.
1903
This format modified the hash cache from the format 1 hash cache.
1906
def get_format_description(self):
1907
"""See WorkingTreeFormat.get_format_description()."""
1908
return "Working tree format 2"
1910
def stub_initialize_remote(self, control_files):
1911
"""As a special workaround create critical control files for a remote working tree
1913
This ensures that it can later be updated and dealt with locally,
1914
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1915
no working tree. (See bug #43064).
1919
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1921
control_files.put('inventory', sio)
1923
control_files.put_utf8('pending-merges', '')
1926
def initialize(self, a_bzrdir, revision_id=None):
1927
"""See WorkingTreeFormat.initialize()."""
1928
if not isinstance(a_bzrdir.transport, LocalTransport):
1929
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1930
branch = a_bzrdir.open_branch()
1931
if revision_id is not None:
1934
revision_history = branch.revision_history()
1936
position = revision_history.index(revision_id)
1938
raise errors.NoSuchRevision(branch, revision_id)
1939
branch.set_revision_history(revision_history[:position + 1])
1942
revision = branch.last_revision()
1944
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1950
wt._write_inventory(inv)
1951
wt.set_root_id(inv.root.file_id)
1952
basis_tree = branch.repository.revision_tree(revision)
1953
wt.set_parent_trees([(revision, basis_tree)])
1954
build_tree(basis_tree, wt)
1958
super(WorkingTreeFormat2, self).__init__()
1959
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1961
def open(self, a_bzrdir, _found=False):
1962
"""Return the WorkingTree object for a_bzrdir
1964
_found is a private parameter, do not use it. It is used to indicate
1965
if format probing has already been done.
1968
# we are being called directly and must probe.
1969
raise NotImplementedError
1970
if not isinstance(a_bzrdir.transport, LocalTransport):
1971
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1972
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1978
class WorkingTreeFormat3(WorkingTreeFormat):
1979
"""The second working tree format updated to record a format marker.
1982
- exists within a metadir controlling .bzr
1983
- includes an explicit version marker for the workingtree control
1984
files, separate from the BzrDir format
1985
- modifies the hash cache format
1987
- uses a LockDir to guard access for writes.
1990
def get_format_string(self):
1991
"""See WorkingTreeFormat.get_format_string()."""
1992
return "Bazaar-NG Working Tree format 3"
1994
def get_format_description(self):
1995
"""See WorkingTreeFormat.get_format_description()."""
1996
return "Working tree format 3"
1998
_lock_file_name = 'lock'
1999
_lock_class = LockDir
2001
def _open_control_files(self, a_bzrdir):
2002
transport = a_bzrdir.get_workingtree_transport(None)
2003
return LockableFiles(transport, self._lock_file_name,
2006
def initialize(self, a_bzrdir, revision_id=None):
2007
"""See WorkingTreeFormat.initialize().
2009
revision_id allows creating a working tree at a different
2010
revision than the branch is at.
2012
if not isinstance(a_bzrdir.transport, LocalTransport):
2013
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2014
transport = a_bzrdir.get_workingtree_transport(self)
2015
control_files = self._open_control_files(a_bzrdir)
2016
control_files.create_lock()
2017
control_files.lock_write()
2018
control_files.put_utf8('format', self.get_format_string())
2019
branch = a_bzrdir.open_branch()
2020
if revision_id is None:
2021
revision_id = branch.last_revision()
2023
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2029
_control_files=control_files)
2030
wt.lock_tree_write()
2032
wt._write_inventory(inv)
2033
wt.set_root_id(inv.root.file_id)
2034
basis_tree = branch.repository.revision_tree(revision_id)
2035
if revision_id == bzrlib.revision.NULL_REVISION:
2036
wt.set_parent_trees([])
2038
wt.set_parent_trees([(revision_id, basis_tree)])
2039
build_tree(basis_tree, wt)
2042
control_files.unlock()
2046
super(WorkingTreeFormat3, self).__init__()
2047
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2049
def open(self, a_bzrdir, _found=False):
2050
"""Return the WorkingTree object for a_bzrdir
2052
_found is a private parameter, do not use it. It is used to indicate
2053
if format probing has already been done.
2056
# we are being called directly and must probe.
2057
raise NotImplementedError
2058
if not isinstance(a_bzrdir.transport, LocalTransport):
2059
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2060
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2062
def _open(self, a_bzrdir, control_files):
2063
"""Open the tree itself.
2065
:param a_bzrdir: the dir for the tree.
2066
:param control_files: the control files for the tree.
2068
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2072
_control_files=control_files)
2075
return self.get_format_string()
2078
# formats which have no format string are not discoverable
2079
# and not independently creatable, so are not registered.
2080
__default_format = WorkingTreeFormat3()
2081
WorkingTreeFormat.register_format(__default_format)
2082
WorkingTreeFormat.set_default_format(__default_format)
2083
_legacy_formats = [WorkingTreeFormat2(),
2087
class WorkingTreeTestProviderAdapter(object):
2088
"""A tool to generate a suite testing multiple workingtree formats at once.
2090
This is done by copying the test once for each transport and injecting
2091
the transport_server, transport_readonly_server, and workingtree_format
2092
classes into each copy. Each copy is also given a new id() to make it
2096
def __init__(self, transport_server, transport_readonly_server, formats):
2097
self._transport_server = transport_server
2098
self._transport_readonly_server = transport_readonly_server
2099
self._formats = formats
2101
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2102
"""Clone test for adaption."""
2103
new_test = deepcopy(test)
2104
new_test.transport_server = self._transport_server
2105
new_test.transport_readonly_server = self._transport_readonly_server
2106
new_test.bzrdir_format = bzrdir_format
2107
new_test.workingtree_format = workingtree_format
2108
def make_new_test_id():
2109
new_id = "%s(%s)" % (test.id(), variation)
2110
return lambda: new_id
2111
new_test.id = make_new_test_id()
2114
def adapt(self, test):
2115
from bzrlib.tests import TestSuite
2116
result = TestSuite()
2117
for workingtree_format, bzrdir_format in self._formats:
2118
new_test = self._clone_test(
2121
workingtree_format, workingtree_format.__class__.__name__)
2122
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
