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
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
101
from bzrlib.trace import mutter, note
102
from bzrlib.transform import build_tree
103
from bzrlib.transport import get_transport
104
from bzrlib.transport.local import LocalTransport
105
from bzrlib.textui import show_status
111
# the regex removes any weird characters; we don't escape them
112
# but rather just pull them out
113
_gen_file_id_re = re.compile(r'[^\w.]')
114
_gen_id_suffix = None
118
def _next_id_suffix():
119
"""Create a new file id suffix that is reasonably unique.
121
On the first call we combine the current time with 64 bits of randomness
122
to give a highly probably globally unique number. Then each call in the same
123
process adds 1 to a serial number we append to that unique value.
125
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
126
# than having to move the id randomness out of the inner loop like this.
127
# XXX TODO: for the global randomness this uses we should add the thread-id
128
# before the serial #.
129
global _gen_id_suffix, _gen_id_serial
130
if _gen_id_suffix is None:
131
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
133
return _gen_id_suffix + str(_gen_id_serial)
136
def gen_file_id(name):
137
"""Return new file id for the basename 'name'.
139
The uniqueness is supplied from _next_id_suffix.
141
# The real randomness is in the _next_id_suffix, the
142
# rest of the identifier is just to be nice.
144
# 1) Remove non-ascii word characters to keep the ids portable
145
# 2) squash to lowercase, so the file id doesn't have to
146
# be escaped (case insensitive filesystems would bork for ids
147
# that only differred in case without escaping).
148
# 3) truncate the filename to 20 chars. Long filenames also bork on some
150
# 4) Removing starting '.' characters to prevent the file ids from
151
# being considered hidden.
152
ascii_word_only = _gen_file_id_re.sub('', name.lower())
153
short_no_dots = ascii_word_only.lstrip('.')[:20]
154
return short_no_dots + _next_id_suffix()
158
"""Return a new tree-root file id."""
159
return gen_file_id('TREE_ROOT')
162
def needs_tree_write_lock(unbound):
163
"""Decorate unbound to take out and release a tree_write lock."""
164
def tree_write_locked(self, *args, **kwargs):
165
self.lock_tree_write()
167
return unbound(self, *args, **kwargs)
170
tree_write_locked.__doc__ = unbound.__doc__
171
tree_write_locked.__name__ = unbound.__name__
172
return tree_write_locked
175
class TreeEntry(object):
176
"""An entry that implements the minimum interface used by commands.
178
This needs further inspection, it may be better to have
179
InventoryEntries without ids - though that seems wrong. For now,
180
this is a parallel hierarchy to InventoryEntry, and needs to become
181
one of several things: decorates to that hierarchy, children of, or
183
Another note is that these objects are currently only used when there is
184
no InventoryEntry available - i.e. for unversioned objects.
185
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
188
def __eq__(self, other):
189
# yes, this us ugly, TODO: best practice __eq__ style.
190
return (isinstance(other, TreeEntry)
191
and other.__class__ == self.__class__)
193
def kind_character(self):
197
class TreeDirectory(TreeEntry):
198
"""See TreeEntry. This is a directory in a working tree."""
200
def __eq__(self, other):
201
return (isinstance(other, TreeDirectory)
202
and other.__class__ == self.__class__)
204
def kind_character(self):
208
class TreeFile(TreeEntry):
209
"""See TreeEntry. This is a regular file in a working tree."""
211
def __eq__(self, other):
212
return (isinstance(other, TreeFile)
213
and other.__class__ == self.__class__)
215
def kind_character(self):
219
class TreeLink(TreeEntry):
220
"""See TreeEntry. This is a symlink in a working tree."""
222
def __eq__(self, other):
223
return (isinstance(other, TreeLink)
224
and other.__class__ == self.__class__)
226
def kind_character(self):
230
class WorkingTree(bzrlib.tree.Tree):
231
"""Working copy tree.
233
The inventory is held in the `Branch` working-inventory, and the
234
files are in a directory on disk.
236
It is possible for a `WorkingTree` to have a filename which is
237
not listed in the Inventory and vice versa.
240
def __init__(self, basedir='.',
241
branch=DEPRECATED_PARAMETER,
247
"""Construct a WorkingTree for basedir.
249
If the branch is not supplied, it is opened automatically.
250
If the branch is supplied, it must be the branch for this basedir.
251
(branch.base is not cross checked, because for remote branches that
252
would be meaningless).
254
self._format = _format
255
self.bzrdir = _bzrdir
257
# not created via open etc.
258
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
259
"Please use bzrdir.open_workingtree or WorkingTree.open().",
262
wt = WorkingTree.open(basedir)
263
self._branch = wt.branch
264
self.basedir = wt.basedir
265
self._control_files = wt._control_files
266
self._hashcache = wt._hashcache
267
self._set_inventory(wt._inventory)
268
self._format = wt._format
269
self.bzrdir = wt.bzrdir
270
from bzrlib.hashcache import HashCache
271
from bzrlib.trace import note, mutter
272
assert isinstance(basedir, basestring), \
273
"base directory %r is not a string" % basedir
274
basedir = safe_unicode(basedir)
275
mutter("opening working tree %r", basedir)
276
if deprecated_passed(branch):
278
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
279
" Please use bzrdir.open_workingtree() or"
280
" WorkingTree.open().",
284
self._branch = branch
286
self._branch = self.bzrdir.open_branch()
287
self.basedir = realpath(basedir)
288
# if branch is at our basedir and is a format 6 or less
289
if isinstance(self._format, WorkingTreeFormat2):
290
# share control object
291
self._control_files = self.branch.control_files
293
# assume all other formats have their own control files.
294
assert isinstance(_control_files, LockableFiles), \
295
"_control_files must be a LockableFiles, not %r" \
297
self._control_files = _control_files
298
# update the whole cache up front and write to disk if anything changed;
299
# in the future we might want to do this more selectively
300
# two possible ways offer themselves : in self._unlock, write the cache
301
# if needed, or, when the cache sees a change, append it to the hash
302
# cache file, and have the parser take the most recent entry for a
304
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
305
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
307
# is this scan needed ? it makes things kinda slow.
314
if _inventory is None:
315
self._set_inventory(self.read_working_inventory())
317
self._set_inventory(_inventory)
320
fget=lambda self: self._branch,
321
doc="""The branch this WorkingTree is connected to.
323
This cannot be set - it is reflective of the actual disk structure
324
the working tree has been constructed from.
327
def break_lock(self):
328
"""Break a lock if one is present from another instance.
330
Uses the ui factory to ask for confirmation if the lock may be from
333
This will probe the repository for its lock as well.
335
self._control_files.break_lock()
336
self.branch.break_lock()
338
def _set_inventory(self, inv):
339
assert inv.root is not None
340
self._inventory = inv
341
self.path2id = self._inventory.path2id
343
def is_control_filename(self, filename):
344
"""True if filename is the name of a control file in this tree.
346
:param filename: A filename within the tree. This is a relative path
347
from the root of this tree.
349
This is true IF and ONLY IF the filename is part of the meta data
350
that bzr controls in this tree. I.E. a random .bzr directory placed
351
on disk will not be a control file for this tree.
353
return self.bzrdir.is_control_filename(filename)
356
def open(path=None, _unsupported=False):
357
"""Open an existing working tree at path.
361
path = os.path.getcwdu()
362
control = bzrdir.BzrDir.open(path, _unsupported)
363
return control.open_workingtree(_unsupported)
366
def open_containing(path=None):
367
"""Open an existing working tree which has its root about path.
369
This probes for a working tree at path and searches upwards from there.
371
Basically we keep looking up until we find the control directory or
372
run into /. If there isn't one, raises NotBranchError.
373
TODO: give this a new exception.
374
If there is one, it is returned, along with the unused portion of path.
376
:return: The WorkingTree that contains 'path', and the rest of path
379
path = osutils.getcwd()
380
control, relpath = bzrdir.BzrDir.open_containing(path)
382
return control.open_workingtree(), relpath
385
def open_downlevel(path=None):
386
"""Open an unsupported working tree.
388
Only intended for advanced situations like upgrading part of a bzrdir.
390
return WorkingTree.open(path, _unsupported=True)
393
"""Iterate through file_ids for this tree.
395
file_ids are in a WorkingTree if they are in the working inventory
396
and the working file exists.
398
inv = self._inventory
399
for path, ie in inv.iter_entries():
400
if osutils.lexists(self.abspath(path)):
404
return "<%s of %s>" % (self.__class__.__name__,
405
getattr(self, 'basedir', None))
407
def abspath(self, filename):
408
return pathjoin(self.basedir, filename)
410
def basis_tree(self):
411
"""Return RevisionTree for the current last revision.
413
If the left most parent is a ghost then the returned tree will be an
414
empty tree - one obtained by calling repository.revision_tree(None).
417
revision_id = self.get_parent_ids()[0]
419
# no parents, return an empty revision tree.
420
# in the future this should return the tree for
421
# 'empty:' - the implicit root empty tree.
422
return self.branch.repository.revision_tree(None)
425
xml = self.read_basis_inventory()
426
inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
427
if inv is not None and inv.revision_id == revision_id:
428
return bzrlib.tree.RevisionTree(self.branch.repository,
430
except (NoSuchFile, errors.BadInventoryFormat):
432
# No cached copy available, retrieve from the repository.
433
# FIXME? RBC 20060403 should we cache the inventory locally
436
return self.branch.repository.revision_tree(revision_id)
437
except errors.RevisionNotPresent:
438
# the basis tree *may* be a ghost or a low level error may have
439
# occured. If the revision is present, its a problem, if its not
441
if self.branch.repository.has_revision(revision_id):
443
# the basis tree is a ghost so return an empty tree.
444
return self.branch.repository.revision_tree(None)
447
@deprecated_method(zero_eight)
448
def create(branch, directory):
449
"""Create a workingtree for branch at directory.
451
If existing_directory already exists it must have a .bzr directory.
452
If it does not exist, it will be created.
454
This returns a new WorkingTree object for the new checkout.
456
TODO FIXME RBC 20060124 when we have checkout formats in place this
457
should accept an optional revisionid to checkout [and reject this if
458
checking out into the same dir as a pre-checkout-aware branch format.]
460
XXX: When BzrDir is present, these should be created through that
463
warnings.warn('delete WorkingTree.create', stacklevel=3)
464
transport = get_transport(directory)
465
if branch.bzrdir.root_transport.base == transport.base:
467
return branch.bzrdir.create_workingtree()
468
# different directory,
469
# create a branch reference
470
# and now a working tree.
471
raise NotImplementedError
474
@deprecated_method(zero_eight)
475
def create_standalone(directory):
476
"""Create a checkout and a branch and a repo at directory.
478
Directory must exist and be empty.
480
please use BzrDir.create_standalone_workingtree
482
return bzrdir.BzrDir.create_standalone_workingtree(directory)
484
def relpath(self, path):
485
"""Return the local path portion from a given path.
487
The path may be absolute or relative. If its a relative path it is
488
interpreted relative to the python current working directory.
490
return relpath(self.basedir, path)
492
def has_filename(self, filename):
493
return osutils.lexists(self.abspath(filename))
495
def get_file(self, file_id):
496
return self.get_file_byname(self.id2path(file_id))
498
def get_file_text(self, file_id):
499
return self.get_file(file_id).read()
501
def get_file_byname(self, filename):
502
return file(self.abspath(filename), 'rb')
504
def get_parent_ids(self):
505
"""See Tree.get_parent_ids.
507
This implementation reads the pending merges list and last_revision
508
value and uses that to decide what the parents list should be.
510
last_rev = self._last_revision()
516
merges_file = self._control_files.get_utf8('pending-merges')
520
for l in merges_file.readlines():
521
parents.append(l.rstrip('\n'))
524
def get_root_id(self):
525
"""Return the id of this trees root"""
526
inv = self.read_working_inventory()
527
return inv.root.file_id
529
def _get_store_filename(self, file_id):
530
## XXX: badly named; this is not in the store at all
531
return self.abspath(self.id2path(file_id))
534
def clone(self, to_bzrdir, revision_id=None, basis=None):
535
"""Duplicate this working tree into to_bzr, including all state.
537
Specifically modified files are kept as modified, but
538
ignored and unknown files are discarded.
540
If you want to make a new line of development, see bzrdir.sprout()
543
If not None, the cloned tree will have its last revision set to
544
revision, and and difference between the source trees last revision
545
and this one merged in.
548
If not None, a closer copy of a tree which may have some files in
549
common, and which file content should be preferentially copied from.
551
# assumes the target bzr dir format is compatible.
552
result = self._format.initialize(to_bzrdir)
553
self.copy_content_into(result, revision_id)
557
def copy_content_into(self, tree, revision_id=None):
558
"""Copy the current content and user files of this tree into tree."""
559
if revision_id is None:
560
transform_tree(tree, self)
562
# TODO now merge from tree.last_revision to revision (to preserve
563
# user local changes)
564
transform_tree(tree, self)
565
tree.set_parent_ids([revision_id])
568
def commit(self, message=None, revprops=None, *args, **kwargs):
569
# avoid circular imports
570
from bzrlib.commit import Commit
573
if not 'branch-nick' in revprops:
574
revprops['branch-nick'] = self.branch.nick
575
# args for wt.commit start at message from the Commit.commit method,
576
# but with branch a kwarg now, passing in args as is results in the
577
#message being used for the branch
578
args = (DEPRECATED_PARAMETER, message, ) + args
579
committed_id = Commit().commit( working_tree=self, revprops=revprops,
583
def id2abspath(self, file_id):
584
return self.abspath(self.id2path(file_id))
586
def has_id(self, file_id):
587
# files that have been deleted are excluded
588
inv = self._inventory
589
if not inv.has_id(file_id):
591
path = inv.id2path(file_id)
592
return osutils.lexists(self.abspath(path))
594
def has_or_had_id(self, file_id):
595
if file_id == self.inventory.root.file_id:
597
return self.inventory.has_id(file_id)
599
__contains__ = has_id
601
def get_file_size(self, file_id):
602
return os.path.getsize(self.id2abspath(file_id))
605
def get_file_sha1(self, file_id, path=None):
607
path = self._inventory.id2path(file_id)
608
return self._hashcache.get_sha1(path)
610
def get_file_mtime(self, file_id, path=None):
612
path = self._inventory.id2path(file_id)
613
return os.lstat(self.abspath(path)).st_mtime
615
if not supports_executable():
616
def is_executable(self, file_id, path=None):
617
return self._inventory[file_id].executable
619
def is_executable(self, file_id, path=None):
621
path = self._inventory.id2path(file_id)
622
mode = os.lstat(self.abspath(path)).st_mode
623
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
625
@needs_tree_write_lock
626
def add(self, files, ids=None):
627
"""Make files versioned.
629
Note that the command line normally calls smart_add instead,
630
which can automatically recurse.
632
This adds the files to the inventory, so that they will be
633
recorded by the next commit.
636
List of paths to add, relative to the base of the tree.
639
If set, use these instead of automatically generated ids.
640
Must be the same length as the list of files, but may
641
contain None for ids that are to be autogenerated.
643
TODO: Perhaps have an option to add the ids even if the files do
646
TODO: Perhaps callback with the ids and paths as they're added.
648
# TODO: Re-adding a file that is removed in the working copy
649
# should probably put it back with the previous ID.
650
if isinstance(files, basestring):
651
assert(ids is None or isinstance(ids, basestring))
657
ids = [None] * len(files)
659
assert(len(ids) == len(files))
661
inv = self.read_working_inventory()
662
for f,file_id in zip(files, ids):
663
if self.is_control_filename(f):
664
raise errors.ForbiddenControlFileError(filename=f)
669
raise BzrError("cannot add top-level %r" % f)
671
fullpath = normpath(self.abspath(f))
673
kind = file_kind(fullpath)
675
if e.errno == errno.ENOENT:
676
raise NoSuchFile(fullpath)
677
if not InventoryEntry.versionable_kind(kind):
678
raise errors.BadFileKindError(filename=f, kind=kind)
680
inv.add_path(f, kind=kind)
682
inv.add_path(f, kind=kind, file_id=file_id)
684
self._write_inventory(inv)
686
@needs_tree_write_lock
687
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
688
"""Add revision_id as a parent.
690
This is equivalent to retrieving the current list of parent ids
691
and setting the list to its value plus revision_id.
693
:param revision_id: The revision id to add to the parent list. It may
694
be a ghost revision as long as its not the first parent to be added,
695
or the allow_leftmost_as_ghost parameter is set True.
696
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
698
parents = self.get_parent_ids() + [revision_id]
699
self.set_parent_ids(parents,
700
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
702
@needs_tree_write_lock
703
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
704
"""Add revision_id, tree tuple as a parent.
706
This is equivalent to retrieving the current list of parent trees
707
and setting the list to its value plus parent_tuple. See also
708
add_parent_tree_id - if you only have a parent id available it will be
709
simpler to use that api. If you have the parent already available, using
710
this api is preferred.
712
:param parent_tuple: The (revision id, tree) to add to the parent list.
713
If the revision_id is a ghost, pass None for the tree.
714
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
716
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
717
if len(parent_ids) > 1:
718
# the leftmost may have already been a ghost, preserve that if it
720
allow_leftmost_as_ghost = True
721
self.set_parent_ids(parent_ids,
722
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
724
@needs_tree_write_lock
725
def add_pending_merge(self, *revision_ids):
726
# TODO: Perhaps should check at this point that the
727
# history of the revision is actually present?
728
parents = self.get_parent_ids()
730
for rev_id in revision_ids:
731
if rev_id in parents:
733
parents.append(rev_id)
736
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
738
@deprecated_method(zero_eleven)
740
def pending_merges(self):
741
"""Return a list of pending merges.
743
These are revisions that have been merged into the working
744
directory but not yet committed.
746
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
747
instead - which is available on all tree objects.
749
return self.get_parent_ids()[1:]
751
@needs_tree_write_lock
752
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
753
"""Set the parent ids to revision_ids.
755
See also set_parent_trees. This api will try to retrieve the tree data
756
for each element of revision_ids from the trees repository. If you have
757
tree data already available, it is more efficient to use
758
set_parent_trees rather than set_parent_ids. set_parent_ids is however
759
an easier API to use.
761
:param revision_ids: The revision_ids to set as the parent ids of this
762
working tree. Any of these may be ghosts.
764
if len(revision_ids) > 0:
765
leftmost_id = revision_ids[0]
766
if (not allow_leftmost_as_ghost and not
767
self.branch.repository.has_revision(leftmost_id)):
768
raise errors.GhostRevisionUnusableHere(leftmost_id)
769
self.set_last_revision(leftmost_id)
771
self.set_last_revision(None)
772
merges = revision_ids[1:]
773
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
775
@needs_tree_write_lock
776
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
777
"""Set the parents of the working tree.
779
:param parents_list: A list of (revision_id, tree) tuples.
780
If tree is None, then that element is treated as an unreachable
781
parent tree - i.e. a ghost.
783
# parent trees are not used in current format trees, delegate to
785
self.set_parent_ids([rev for (rev, tree) in parents_list],
786
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
788
@needs_tree_write_lock
789
def set_pending_merges(self, rev_list):
790
parents = self.get_parent_ids()
791
leftmost = parents[:1]
792
new_parents = leftmost + rev_list
793
self.set_parent_ids(new_parents)
795
@needs_tree_write_lock
796
def set_merge_modified(self, modified_hashes):
798
for file_id, hash in modified_hashes.iteritems():
799
yield Stanza(file_id=file_id, hash=hash)
800
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
802
@needs_tree_write_lock
803
def _put_rio(self, filename, stanzas, header):
804
my_file = rio_file(stanzas, header)
805
self._control_files.put(filename, my_file)
807
@needs_write_lock # because merge pulls data into the branch.
808
def merge_from_branch(self, branch, to_revision=None):
809
"""Merge from a branch into this working tree.
811
:param branch: The branch to merge from.
812
:param to_revision: If non-None, the merge will merge to to_revision, but
813
not beyond it. to_revision does not need to be in the history of
814
the branch when it is supplied. If None, to_revision defaults to
815
branch.last_revision().
817
from bzrlib.merge import Merger, Merge3Merger
818
pb = bzrlib.ui.ui_factory.nested_progress_bar()
820
merger = Merger(self.branch, this_tree=self, pb=pb)
821
merger.pp = ProgressPhase("Merge phase", 5, pb)
822
merger.pp.next_phase()
823
# check that there are no
825
merger.check_basis(check_clean=True, require_commits=False)
826
if to_revision is None:
827
to_revision = branch.last_revision()
828
merger.other_rev_id = to_revision
829
if merger.other_rev_id is None:
830
raise error.NoCommits(branch)
831
self.branch.fetch(branch, last_revision=merger.other_rev_id)
832
merger.other_basis = merger.other_rev_id
833
merger.other_tree = self.branch.repository.revision_tree(
835
merger.pp.next_phase()
837
if merger.base_rev_id == merger.other_rev_id:
838
raise errors.PointlessMerge
839
merger.backup_files = False
840
merger.merge_type = Merge3Merger
841
merger.set_interesting_files(None)
842
merger.show_base = False
843
merger.reprocess = False
844
conflicts = merger.do_merge()
851
def merge_modified(self):
853
hashfile = self._control_files.get('merge-hashes')
858
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
859
raise MergeModifiedFormatError()
860
except StopIteration:
861
raise MergeModifiedFormatError()
862
for s in RioReader(hashfile):
863
file_id = s.get("file_id")
864
if file_id not in self.inventory:
867
if hash == self.get_file_sha1(file_id):
868
merge_hashes[file_id] = hash
871
def get_symlink_target(self, file_id):
872
return os.readlink(self.id2abspath(file_id))
874
def file_class(self, filename):
875
if self.path2id(filename):
877
elif self.is_ignored(filename):
882
def list_files(self):
883
"""Recursively list all files as (path, class, kind, id, entry).
885
Lists, but does not descend into unversioned directories.
887
This does not include files that have been deleted in this
890
Skips the control directory.
892
inv = self._inventory
893
# Convert these into local objects to save lookup times
894
pathjoin = osutils.pathjoin
895
file_kind = osutils.file_kind
897
# transport.base ends in a slash, we want the piece
898
# between the last two slashes
899
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
901
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
903
# directory file_id, relative path, absolute path, reverse sorted children
904
children = os.listdir(self.basedir)
906
# jam 20060527 The kernel sized tree seems equivalent whether we
907
# use a deque and popleft to keep them sorted, or if we use a plain
908
# list and just reverse() them.
909
children = collections.deque(children)
910
stack = [(inv.root.file_id, u'', self.basedir, children)]
912
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
915
f = children.popleft()
916
## TODO: If we find a subdirectory with its own .bzr
917
## directory, then that is a separate tree and we
918
## should exclude it.
920
# the bzrdir for this tree
921
if transport_base_dir == f:
924
# we know that from_dir_relpath and from_dir_abspath never end in a slash
925
# and 'f' doesn't begin with one, we can do a string op, rather
926
# than the checks of pathjoin(), all relative paths will have an extra slash
928
fp = from_dir_relpath + '/' + f
931
fap = from_dir_abspath + '/' + f
933
f_ie = inv.get_child(from_dir_id, f)
936
elif self.is_ignored(fp[1:]):
939
# we may not have found this file, because of a unicode issue
940
f_norm, can_access = osutils.normalized_filename(f)
941
if f == f_norm or not can_access:
942
# No change, so treat this file normally
945
# this file can be accessed by a normalized path
946
# check again if it is versioned
947
# these lines are repeated here for performance
949
fp = from_dir_relpath + '/' + f
950
fap = from_dir_abspath + '/' + f
951
f_ie = inv.get_child(from_dir_id, f)
954
elif self.is_ignored(fp[1:]):
963
raise BzrCheckError("file %r entered as kind %r id %r, "
965
% (fap, f_ie.kind, f_ie.file_id, fk))
967
# make a last minute entry
969
yield fp[1:], c, fk, f_ie.file_id, f_ie
972
yield fp[1:], c, fk, None, fk_entries[fk]()
974
yield fp[1:], c, fk, None, TreeEntry()
977
if fk != 'directory':
980
# But do this child first
981
new_children = os.listdir(fap)
983
new_children = collections.deque(new_children)
984
stack.append((f_ie.file_id, fp, fap, new_children))
985
# Break out of inner loop, so that we start outer loop with child
988
# if we finished all children, pop it off the stack
991
@needs_tree_write_lock
992
def move(self, from_paths, to_name):
995
to_name must exist in the inventory.
997
If to_name exists and is a directory, the files are moved into
998
it, keeping their old names.
1000
Note that to_name is only the last component of the new name;
1001
this doesn't change the directory.
1003
This returns a list of (from_path, to_path) pairs for each
1004
entry that is moved.
1007
## TODO: Option to move IDs only
1008
assert not isinstance(from_paths, basestring)
1009
inv = self.inventory
1010
to_abs = self.abspath(to_name)
1011
if not isdir(to_abs):
1012
raise BzrError("destination %r is not a directory" % to_abs)
1013
if not self.has_filename(to_name):
1014
raise BzrError("destination %r not in working directory" % to_abs)
1015
to_dir_id = inv.path2id(to_name)
1016
if to_dir_id is None and to_name != '':
1017
raise BzrError("destination %r is not a versioned directory" % to_name)
1018
to_dir_ie = inv[to_dir_id]
1019
if to_dir_ie.kind != 'directory':
1020
raise BzrError("destination %r is not a directory" % to_abs)
1022
to_idpath = inv.get_idpath(to_dir_id)
1024
for f in from_paths:
1025
if not self.has_filename(f):
1026
raise BzrError("%r does not exist in working tree" % f)
1027
f_id = inv.path2id(f)
1029
raise BzrError("%r is not versioned" % f)
1030
name_tail = splitpath(f)[-1]
1031
dest_path = pathjoin(to_name, name_tail)
1032
if self.has_filename(dest_path):
1033
raise BzrError("destination %r already exists" % dest_path)
1034
if f_id in to_idpath:
1035
raise BzrError("can't move %r to a subdirectory of itself" % f)
1037
# OK, so there's a race here, it's possible that someone will
1038
# create a file in this interval and then the rename might be
1039
# left half-done. But we should have caught most problems.
1040
orig_inv = deepcopy(self.inventory)
1042
for f in from_paths:
1043
name_tail = splitpath(f)[-1]
1044
dest_path = pathjoin(to_name, name_tail)
1045
result.append((f, dest_path))
1046
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1048
rename(self.abspath(f), self.abspath(dest_path))
1050
raise BzrError("failed to rename %r to %r: %s" %
1051
(f, dest_path, e[1]),
1052
["rename rolled back"])
1054
# restore the inventory on error
1055
self._set_inventory(orig_inv)
1057
self._write_inventory(inv)
1060
@needs_tree_write_lock
1061
def rename_one(self, from_rel, to_rel):
1064
This can change the directory or the filename or both.
1066
inv = self.inventory
1067
if not self.has_filename(from_rel):
1068
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1069
if self.has_filename(to_rel):
1070
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1072
file_id = inv.path2id(from_rel)
1074
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1076
entry = inv[file_id]
1077
from_parent = entry.parent_id
1078
from_name = entry.name
1080
if inv.path2id(to_rel):
1081
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1083
to_dir, to_tail = os.path.split(to_rel)
1084
to_dir_id = inv.path2id(to_dir)
1085
if to_dir_id is None and to_dir != '':
1086
raise BzrError("can't determine destination directory id for %r" % to_dir)
1088
mutter("rename_one:")
1089
mutter(" file_id {%s}" % file_id)
1090
mutter(" from_rel %r" % from_rel)
1091
mutter(" to_rel %r" % to_rel)
1092
mutter(" to_dir %r" % to_dir)
1093
mutter(" to_dir_id {%s}" % to_dir_id)
1095
inv.rename(file_id, to_dir_id, to_tail)
1097
from_abs = self.abspath(from_rel)
1098
to_abs = self.abspath(to_rel)
1100
rename(from_abs, to_abs)
1102
inv.rename(file_id, from_parent, from_name)
1103
raise BzrError("failed to rename %r to %r: %s"
1104
% (from_abs, to_abs, e[1]),
1105
["rename rolled back"])
1106
self._write_inventory(inv)
1110
"""Return all unknown files.
1112
These are files in the working directory that are not versioned or
1113
control files or ignored.
1115
for subp in self.extras():
1116
if not self.is_ignored(subp):
1119
@needs_tree_write_lock
1120
def unversion(self, file_ids):
1121
"""Remove the file ids in file_ids from the current versioned set.
1123
When a file_id is unversioned, all of its children are automatically
1126
:param file_ids: The file ids to stop versioning.
1127
:raises: NoSuchId if any fileid is not currently versioned.
1129
for file_id in file_ids:
1130
if self._inventory.has_id(file_id):
1131
self._inventory.remove_recursive_id(file_id)
1133
raise errors.NoSuchId(self, file_id)
1135
# in the future this should just set a dirty bit to wait for the
1136
# final unlock. However, until all methods of workingtree start
1137
# with the current in -memory inventory rather than triggering
1138
# a read, it is more complex - we need to teach read_inventory
1139
# to know when to read, and when to not read first... and possibly
1140
# to save first when the in memory one may be corrupted.
1141
# so for now, we just only write it if it is indeed dirty.
1143
self._write_inventory(self._inventory)
1145
@deprecated_method(zero_eight)
1146
def iter_conflicts(self):
1147
"""List all files in the tree that have text or content conflicts.
1148
DEPRECATED. Use conflicts instead."""
1149
return self._iter_conflicts()
1151
def _iter_conflicts(self):
1153
for info in self.list_files():
1155
stem = get_conflicted_stem(path)
1158
if stem not in conflicted:
1159
conflicted.add(stem)
1163
def pull(self, source, overwrite=False, stop_revision=None):
1164
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1167
pp = ProgressPhase("Pull phase", 2, top_pb)
1169
old_revision_history = self.branch.revision_history()
1170
basis_tree = self.basis_tree()
1171
count = self.branch.pull(source, overwrite, stop_revision)
1172
new_revision_history = self.branch.revision_history()
1173
if new_revision_history != old_revision_history:
1175
if len(old_revision_history):
1176
other_revision = old_revision_history[-1]
1178
other_revision = None
1179
repository = self.branch.repository
1180
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1182
new_basis_tree = self.branch.basis_tree()
1183
merge_inner(self.branch,
1190
# TODO - dedup parents list with things merged by pull ?
1191
# reuse the revisiontree we merged against to set the new
1193
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1194
# we have to pull the merge trees out again, because
1195
# merge_inner has set the ids. - this corner is not yet
1196
# layered well enough to prevent double handling.
1197
merges = self.get_parent_ids()[1:]
1198
parent_trees.extend([
1199
(parent, repository.revision_tree(parent)) for
1201
self.set_parent_trees(parent_trees)
1208
"""Yield all unknown files in this WorkingTree.
1210
If there are any unknown directories then only the directory is
1211
returned, not all its children. But if there are unknown files
1212
under a versioned subdirectory, they are returned.
1214
Currently returned depth-first, sorted by name within directories.
1216
## TODO: Work from given directory downwards
1217
for path, dir_entry in self.inventory.directories():
1218
# mutter("search for unknowns in %r", path)
1219
dirabs = self.abspath(path)
1220
if not isdir(dirabs):
1221
# e.g. directory deleted
1225
for subf in os.listdir(dirabs):
1228
if subf not in dir_entry.children:
1229
subf_norm, can_access = osutils.normalized_filename(subf)
1230
if subf_norm != subf and can_access:
1231
if subf_norm not in dir_entry.children:
1232
fl.append(subf_norm)
1238
subp = pathjoin(path, subf)
1241
def _translate_ignore_rule(self, rule):
1242
"""Translate a single ignore rule to a regex.
1244
There are two types of ignore rules. Those that do not contain a / are
1245
matched against the tail of the filename (that is, they do not care
1246
what directory the file is in.) Rules which do contain a slash must
1247
match the entire path. As a special case, './' at the start of the
1248
string counts as a slash in the string but is removed before matching
1249
(e.g. ./foo.c, ./src/foo.c)
1251
:return: The translated regex.
1253
if rule[:2] in ('./', '.\\'):
1255
result = fnmatch.translate(rule[2:])
1256
elif '/' in rule or '\\' in rule:
1258
result = fnmatch.translate(rule)
1260
# default rule style.
1261
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1262
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1263
return "(" + result + ")"
1265
def _combine_ignore_rules(self, rules):
1266
"""Combine a list of ignore rules into a single regex object.
1268
Each individual rule is combined with | to form a big regex, which then
1269
has $ added to it to form something like ()|()|()$. The group index for
1270
each subregex's outermost group is placed in a dictionary mapping back
1271
to the rule. This allows quick identification of the matching rule that
1273
:return: a list of the compiled regex and the matching-group index
1274
dictionaries. We return a list because python complains if you try to
1275
combine more than 100 regexes.
1280
translated_rules = []
1282
translated_rule = self._translate_ignore_rule(rule)
1283
compiled_rule = re.compile(translated_rule)
1284
groups[next_group] = rule
1285
next_group += compiled_rule.groups
1286
translated_rules.append(translated_rule)
1287
if next_group == 99:
1288
result.append((re.compile("|".join(translated_rules)), groups))
1291
translated_rules = []
1292
if len(translated_rules):
1293
result.append((re.compile("|".join(translated_rules)), groups))
1296
def ignored_files(self):
1297
"""Yield list of PATH, IGNORE_PATTERN"""
1298
for subp in self.extras():
1299
pat = self.is_ignored(subp)
1303
def get_ignore_list(self):
1304
"""Return list of ignore patterns.
1306
Cached in the Tree object after the first call.
1308
ignoreset = getattr(self, '_ignoreset', None)
1309
if ignoreset is not None:
1312
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1313
ignore_globs.update(ignores.get_runtime_ignores())
1315
ignore_globs.update(ignores.get_user_ignores())
1317
if self.has_filename(bzrlib.IGNORE_FILENAME):
1318
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1320
ignore_globs.update(ignores.parse_ignore_file(f))
1324
self._ignoreset = ignore_globs
1325
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1328
def _get_ignore_rules_as_regex(self):
1329
"""Return a regex of the ignore rules and a mapping dict.
1331
:return: (ignore rules compiled regex, dictionary mapping rule group
1332
indices to original rule.)
1334
if getattr(self, '_ignoreset', None) is None:
1335
self.get_ignore_list()
1336
return self._ignore_regex
1338
def is_ignored(self, filename):
1339
r"""Check whether the filename matches an ignore pattern.
1341
Patterns containing '/' or '\' need to match the whole path;
1342
others match against only the last component.
1344
If the file is ignored, returns the pattern which caused it to
1345
be ignored, otherwise None. So this can simply be used as a
1346
boolean if desired."""
1348
# TODO: Use '**' to match directories, and other extended
1349
# globbing stuff from cvs/rsync.
1351
# XXX: fnmatch is actually not quite what we want: it's only
1352
# approximately the same as real Unix fnmatch, and doesn't
1353
# treat dotfiles correctly and allows * to match /.
1354
# Eventually it should be replaced with something more
1357
rules = self._get_ignore_rules_as_regex()
1358
for regex, mapping in rules:
1359
match = regex.match(filename)
1360
if match is not None:
1361
# one or more of the groups in mapping will have a non-None
1363
groups = match.groups()
1364
rules = [mapping[group] for group in
1365
mapping if groups[group] is not None]
1369
def kind(self, file_id):
1370
return file_kind(self.id2abspath(file_id))
1372
def last_revision(self):
1373
"""Return the last revision id of this working tree.
1375
In early branch formats this was the same as the branch last_revision,
1376
but that cannot be relied upon - for working tree operations,
1377
always use tree.last_revision(). This returns the left most parent id,
1378
or None if there are no parents.
1380
This was deprecated as of 0.11. Please use get_parent_ids instead.
1382
return self._last_revision()
1385
def _last_revision(self):
1386
"""helper for get_parent_ids."""
1387
return self.branch.last_revision()
1389
def is_locked(self):
1390
return self._control_files.is_locked()
1392
def lock_read(self):
1393
"""See Branch.lock_read, and WorkingTree.unlock."""
1394
self.branch.lock_read()
1396
return self._control_files.lock_read()
1398
self.branch.unlock()
1401
def lock_tree_write(self):
1402
"""Lock the working tree for write, and the branch for read.
1404
This is useful for operations which only need to mutate the working
1405
tree. Taking out branch write locks is a relatively expensive process
1406
and may fail if the branch is on read only media. So branch write locks
1407
should only be taken out when we are modifying branch data - such as in
1408
operations like commit, pull, uncommit and update.
1410
self.branch.lock_read()
1412
return self._control_files.lock_write()
1414
self.branch.unlock()
1417
def lock_write(self):
1418
"""See Branch.lock_write, and WorkingTree.unlock."""
1419
self.branch.lock_write()
1421
return self._control_files.lock_write()
1423
self.branch.unlock()
1426
def get_physical_lock_status(self):
1427
return self._control_files.get_physical_lock_status()
1429
def _basis_inventory_name(self):
1430
return 'basis-inventory-cache'
1432
@needs_tree_write_lock
1433
def set_last_revision(self, new_revision):
1434
"""Change the last revision in the working tree."""
1435
if self._change_last_revision(new_revision):
1436
self._cache_basis_inventory(new_revision)
1438
def _change_last_revision(self, new_revision):
1439
"""Template method part of set_last_revision to perform the change.
1441
This is used to allow WorkingTree3 instances to not affect branch
1442
when their last revision is set.
1444
if new_revision is None:
1445
self.branch.set_revision_history([])
1448
self.branch.generate_revision_history(new_revision)
1449
except errors.NoSuchRevision:
1450
# not present in the repo - dont try to set it deeper than the tip
1451
self.branch.set_revision_history([new_revision])
1454
def _cache_basis_inventory(self, new_revision):
1455
"""Cache new_revision as the basis inventory."""
1456
# TODO: this should allow the ready-to-use inventory to be passed in,
1457
# as commit already has that ready-to-use [while the format is the
1460
# this double handles the inventory - unpack and repack -
1461
# but is easier to understand. We can/should put a conditional
1462
# in here based on whether the inventory is in the latest format
1463
# - perhaps we should repack all inventories on a repository
1465
# the fast path is to copy the raw xml from the repository. If the
1466
# xml contains 'revision_id="', then we assume the right
1467
# revision_id is set. We must check for this full string, because a
1468
# root node id can legitimately look like 'revision_id' but cannot
1470
xml = self.branch.repository.get_inventory_xml(new_revision)
1471
firstline = xml.split('\n', 1)[0]
1472
if (not 'revision_id="' in firstline or
1473
'format="6"' not in firstline):
1474
inv = self.branch.repository.deserialise_inventory(
1476
inv.revision_id = new_revision
1477
xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
1478
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1479
path = self._basis_inventory_name()
1481
self._control_files.put(path, sio)
1482
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1485
def read_basis_inventory(self):
1486
"""Read the cached basis inventory."""
1487
path = self._basis_inventory_name()
1488
return self._control_files.get(path).read()
1491
def read_working_inventory(self):
1492
"""Read the working inventory."""
1493
# ElementTree does its own conversion from UTF-8, so open in
1495
result = bzrlib.xml5.serializer_v5.read_inventory(
1496
self._control_files.get('inventory'))
1497
self._set_inventory(result)
1500
@needs_tree_write_lock
1501
def remove(self, files, verbose=False, to_file=None):
1502
"""Remove nominated files from the working inventory..
1504
This does not remove their text. This does not run on XXX on what? RBC
1506
TODO: Refuse to remove modified files unless --force is given?
1508
TODO: Do something useful with directories.
1510
TODO: Should this remove the text or not? Tough call; not
1511
removing may be useful and the user can just use use rm, and
1512
is the opposite of add. Removing it is consistent with most
1513
other tools. Maybe an option.
1515
## TODO: Normalize names
1516
## TODO: Remove nested loops; better scalability
1517
if isinstance(files, basestring):
1520
inv = self.inventory
1522
# do this before any modifications
1524
fid = inv.path2id(f)
1526
# TODO: Perhaps make this just a warning, and continue?
1527
# This tends to happen when
1528
raise NotVersionedError(path=f)
1530
# having remove it, it must be either ignored or unknown
1531
if self.is_ignored(f):
1535
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1538
self._write_inventory(inv)
1540
@needs_tree_write_lock
1541
def revert(self, filenames, old_tree=None, backups=True,
1542
pb=DummyProgress()):
1543
from transform import revert
1544
from conflicts import resolve
1545
if old_tree is None:
1546
old_tree = self.basis_tree()
1547
conflicts = revert(self, old_tree, filenames, backups, pb)
1548
if not len(filenames):
1549
self.set_parent_ids(self.get_parent_ids()[:1])
1552
resolve(self, filenames, ignore_misses=True)
1555
# XXX: This method should be deprecated in favour of taking in a proper
1556
# new Inventory object.
1557
@needs_tree_write_lock
1558
def set_inventory(self, new_inventory_list):
1559
from bzrlib.inventory import (Inventory,
1564
inv = Inventory(self.get_root_id())
1565
for path, file_id, parent, kind in new_inventory_list:
1566
name = os.path.basename(path)
1569
# fixme, there should be a factory function inv,add_??
1570
if kind == 'directory':
1571
inv.add(InventoryDirectory(file_id, name, parent))
1572
elif kind == 'file':
1573
inv.add(InventoryFile(file_id, name, parent))
1574
elif kind == 'symlink':
1575
inv.add(InventoryLink(file_id, name, parent))
1577
raise BzrError("unknown kind %r" % kind)
1578
self._write_inventory(inv)
1580
@needs_tree_write_lock
1581
def set_root_id(self, file_id):
1582
"""Set the root id for this tree."""
1583
inv = self.read_working_inventory()
1584
orig_root_id = inv.root.file_id
1585
del inv._byid[inv.root.file_id]
1586
inv.root.file_id = file_id
1587
inv._byid[inv.root.file_id] = inv.root
1590
if entry.parent_id == orig_root_id:
1591
entry.parent_id = inv.root.file_id
1592
self._write_inventory(inv)
1595
"""See Branch.unlock.
1597
WorkingTree locking just uses the Branch locking facilities.
1598
This is current because all working trees have an embedded branch
1599
within them. IF in the future, we were to make branch data shareable
1600
between multiple working trees, i.e. via shared storage, then we
1601
would probably want to lock both the local tree, and the branch.
1603
raise NotImplementedError(self.unlock)
1607
"""Update a working tree along its branch.
1609
This will update the branch if its bound too, which means we have multiple trees involved:
1610
The new basis tree of the master.
1611
The old basis tree of the branch.
1612
The old basis tree of the working tree.
1613
The current working tree state.
1614
pathologically all three may be different, and non ancestors of each other.
1615
Conceptually we want to:
1616
Preserve the wt.basis->wt.state changes
1617
Transform the wt.basis to the new master basis.
1618
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1619
Restore the wt.basis->wt.state changes.
1621
There isn't a single operation at the moment to do that, so we:
1622
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1623
Do a 'normal' merge of the old branch basis if it is relevant.
1625
old_tip = self.branch.update()
1626
# here if old_tip is not None, it is the old tip of the branch before
1627
# it was updated from the master branch. This should become a pending
1628
# merge in the working tree to preserve the user existing work. we
1629
# cant set that until we update the working trees last revision to be
1630
# one from the new branch, because it will just get absorbed by the
1631
# parent de-duplication logic.
1633
# We MUST save it even if an error occurs, because otherwise the users
1634
# local work is unreferenced and will appear to have been lost.
1638
last_rev = self.get_parent_ids()[0]
1641
if last_rev != self.branch.last_revision():
1642
# merge tree state up to new branch tip.
1643
basis = self.basis_tree()
1644
to_tree = self.branch.basis_tree()
1645
result += merge_inner(self.branch,
1649
# TODO - dedup parents list with things merged by pull ?
1650
# reuse the tree we've updated to to set the basis:
1651
parent_trees = [(self.branch.last_revision(), to_tree)]
1652
merges = self.get_parent_ids()[1:]
1653
# Ideally we ask the tree for the trees here, that way the working
1654
# tree can decide whether to give us teh entire tree or give us a
1655
# lazy initialised tree. dirstate for instance will have the trees
1656
# in ram already, whereas a last-revision + basis-inventory tree
1657
# will not, but also does not need them when setting parents.
1658
for parent in merges:
1659
parent_trees.append(
1660
(parent, self.branch.repository.revision_tree(parent)))
1661
if old_tip is not None:
1662
parent_trees.append(
1663
(old_tip, self.branch.repository.revision_tree(old_tip)))
1664
self.set_parent_trees(parent_trees)
1665
last_rev = parent_trees[0][0]
1667
# the working tree had the same last-revision as the master
1668
# branch did. We may still have pivot local work from the local
1669
# branch into old_tip:
1670
if old_tip is not None:
1671
self.add_parent_tree_id(old_tip)
1672
if old_tip and old_tip != last_rev:
1673
# our last revision was not the prior branch last revision
1674
# and we have converted that last revision to a pending merge.
1675
# base is somewhere between the branch tip now
1676
# and the now pending merge
1677
from bzrlib.revision import common_ancestor
1679
base_rev_id = common_ancestor(self.branch.last_revision(),
1681
self.branch.repository)
1682
except errors.NoCommonAncestor:
1684
base_tree = self.branch.repository.revision_tree(base_rev_id)
1685
other_tree = self.branch.repository.revision_tree(old_tip)
1686
result += merge_inner(self.branch,
1692
@needs_tree_write_lock
1693
def _write_inventory(self, inv):
1694
"""Write inventory as the current inventory."""
1696
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1698
self._control_files.put('inventory', sio)
1699
self._set_inventory(inv)
1700
mutter('wrote working inventory')
1702
def set_conflicts(self, arg):
1703
raise UnsupportedOperation(self.set_conflicts, self)
1705
def add_conflicts(self, arg):
1706
raise UnsupportedOperation(self.add_conflicts, self)
1709
def conflicts(self):
1710
conflicts = ConflictList()
1711
for conflicted in self._iter_conflicts():
1714
if file_kind(self.abspath(conflicted)) != "file":
1716
except errors.NoSuchFile:
1719
for suffix in ('.THIS', '.OTHER'):
1721
kind = file_kind(self.abspath(conflicted+suffix))
1724
except errors.NoSuchFile:
1728
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1729
conflicts.append(Conflict.factory(ctype, path=conflicted,
1730
file_id=self.path2id(conflicted)))
1734
class WorkingTree2(WorkingTree):
1735
"""This is the Format 2 working tree.
1737
This was the first weave based working tree.
1738
- uses os locks for locking.
1739
- uses the branch last-revision.
1742
def lock_tree_write(self):
1743
"""See WorkingTree.lock_tree_write().
1745
In Format2 WorkingTrees we have a single lock for the branch and tree
1746
so lock_tree_write() degrades to lock_write().
1748
self.branch.lock_write()
1750
return self._control_files.lock_write()
1752
self.branch.unlock()
1756
# we share control files:
1757
if self._hashcache.needs_write and self._control_files._lock_count==3:
1758
self._hashcache.write()
1759
# reverse order of locking.
1761
return self._control_files.unlock()
1763
self.branch.unlock()
1766
class WorkingTree3(WorkingTree):
1767
"""This is the Format 3 working tree.
1769
This differs from the base WorkingTree by:
1770
- having its own file lock
1771
- having its own last-revision property.
1773
This is new in bzr 0.8
1777
def _last_revision(self):
1778
"""See WorkingTree._last_revision."""
1780
return self._control_files.get_utf8('last-revision').read()
1784
def _change_last_revision(self, revision_id):
1785
"""See WorkingTree._change_last_revision."""
1786
if revision_id is None or revision_id == NULL_REVISION:
1788
self._control_files._transport.delete('last-revision')
1789
except errors.NoSuchFile:
1793
self._control_files.put_utf8('last-revision', revision_id)
1796
@needs_tree_write_lock
1797
def set_conflicts(self, conflicts):
1798
self._put_rio('conflicts', conflicts.to_stanzas(),
1801
@needs_tree_write_lock
1802
def add_conflicts(self, new_conflicts):
1803
conflict_set = set(self.conflicts())
1804
conflict_set.update(set(list(new_conflicts)))
1805
self.set_conflicts(ConflictList(sorted(conflict_set,
1806
key=Conflict.sort_key)))
1809
def conflicts(self):
1811
confile = self._control_files.get('conflicts')
1813
return ConflictList()
1815
if confile.next() != CONFLICT_HEADER_1 + '\n':
1816
raise ConflictFormatError()
1817
except StopIteration:
1818
raise ConflictFormatError()
1819
return ConflictList.from_stanzas(RioReader(confile))
1822
if self._hashcache.needs_write and self._control_files._lock_count==1:
1823
self._hashcache.write()
1824
# reverse order of locking.
1826
return self._control_files.unlock()
1828
self.branch.unlock()
1831
def get_conflicted_stem(path):
1832
for suffix in CONFLICT_SUFFIXES:
1833
if path.endswith(suffix):
1834
return path[:-len(suffix)]
1836
@deprecated_function(zero_eight)
1837
def is_control_file(filename):
1838
"""See WorkingTree.is_control_filename(filename)."""
1839
## FIXME: better check
1840
filename = normpath(filename)
1841
while filename != '':
1842
head, tail = os.path.split(filename)
1843
## mutter('check %r for control file' % ((head, tail),))
1846
if filename == head:
1852
class WorkingTreeFormat(object):
1853
"""An encapsulation of the initialization and open routines for a format.
1855
Formats provide three things:
1856
* An initialization routine,
1860
Formats are placed in an dict by their format string for reference
1861
during workingtree opening. Its not required that these be instances, they
1862
can be classes themselves with class methods - it simply depends on
1863
whether state is needed for a given format or not.
1865
Once a format is deprecated, just deprecate the initialize and open
1866
methods on the format class. Do not deprecate the object, as the
1867
object will be created every time regardless.
1870
_default_format = None
1871
"""The default format used for new trees."""
1874
"""The known formats."""
1877
def find_format(klass, a_bzrdir):
1878
"""Return the format for the working tree object in a_bzrdir."""
1880
transport = a_bzrdir.get_workingtree_transport(None)
1881
format_string = transport.get("format").read()
1882
return klass._formats[format_string]
1884
raise errors.NoWorkingTree(base=transport.base)
1886
raise errors.UnknownFormatError(format=format_string)
1889
def get_default_format(klass):
1890
"""Return the current default format."""
1891
return klass._default_format
1893
def get_format_string(self):
1894
"""Return the ASCII format string that identifies this format."""
1895
raise NotImplementedError(self.get_format_string)
1897
def get_format_description(self):
1898
"""Return the short description for this format."""
1899
raise NotImplementedError(self.get_format_description)
1901
def is_supported(self):
1902
"""Is this format supported?
1904
Supported formats can be initialized and opened.
1905
Unsupported formats may not support initialization or committing or
1906
some other features depending on the reason for not being supported.
1911
def register_format(klass, format):
1912
klass._formats[format.get_format_string()] = format
1915
def set_default_format(klass, format):
1916
klass._default_format = format
1919
def unregister_format(klass, format):
1920
assert klass._formats[format.get_format_string()] is format
1921
del klass._formats[format.get_format_string()]
1925
class WorkingTreeFormat2(WorkingTreeFormat):
1926
"""The second working tree format.
1928
This format modified the hash cache from the format 1 hash cache.
1931
def get_format_description(self):
1932
"""See WorkingTreeFormat.get_format_description()."""
1933
return "Working tree format 2"
1935
def stub_initialize_remote(self, control_files):
1936
"""As a special workaround create critical control files for a remote working tree
1938
This ensures that it can later be updated and dealt with locally,
1939
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1940
no working tree. (See bug #43064).
1944
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1946
control_files.put('inventory', sio)
1948
control_files.put_utf8('pending-merges', '')
1951
def initialize(self, a_bzrdir, revision_id=None):
1952
"""See WorkingTreeFormat.initialize()."""
1953
if not isinstance(a_bzrdir.transport, LocalTransport):
1954
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1955
branch = a_bzrdir.open_branch()
1956
if revision_id is not None:
1959
revision_history = branch.revision_history()
1961
position = revision_history.index(revision_id)
1963
raise errors.NoSuchRevision(branch, revision_id)
1964
branch.set_revision_history(revision_history[:position + 1])
1967
revision = branch.last_revision()
1969
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1975
wt._write_inventory(inv)
1976
wt.set_root_id(inv.root.file_id)
1977
basis_tree = branch.repository.revision_tree(revision)
1978
wt.set_parent_trees([(revision, basis_tree)])
1979
build_tree(basis_tree, wt)
1983
super(WorkingTreeFormat2, self).__init__()
1984
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1986
def open(self, a_bzrdir, _found=False):
1987
"""Return the WorkingTree object for a_bzrdir
1989
_found is a private parameter, do not use it. It is used to indicate
1990
if format probing has already been done.
1993
# we are being called directly and must probe.
1994
raise NotImplementedError
1995
if not isinstance(a_bzrdir.transport, LocalTransport):
1996
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1997
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2003
class WorkingTreeFormat3(WorkingTreeFormat):
2004
"""The second working tree format updated to record a format marker.
2007
- exists within a metadir controlling .bzr
2008
- includes an explicit version marker for the workingtree control
2009
files, separate from the BzrDir format
2010
- modifies the hash cache format
2012
- uses a LockDir to guard access for writes.
2015
def get_format_string(self):
2016
"""See WorkingTreeFormat.get_format_string()."""
2017
return "Bazaar-NG Working Tree format 3"
2019
def get_format_description(self):
2020
"""See WorkingTreeFormat.get_format_description()."""
2021
return "Working tree format 3"
2023
_lock_file_name = 'lock'
2024
_lock_class = LockDir
2026
def _open_control_files(self, a_bzrdir):
2027
transport = a_bzrdir.get_workingtree_transport(None)
2028
return LockableFiles(transport, self._lock_file_name,
2031
def initialize(self, a_bzrdir, revision_id=None):
2032
"""See WorkingTreeFormat.initialize().
2034
revision_id allows creating a working tree at a different
2035
revision than the branch is at.
2037
if not isinstance(a_bzrdir.transport, LocalTransport):
2038
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2039
transport = a_bzrdir.get_workingtree_transport(self)
2040
control_files = self._open_control_files(a_bzrdir)
2041
control_files.create_lock()
2042
control_files.lock_write()
2043
control_files.put_utf8('format', self.get_format_string())
2044
branch = a_bzrdir.open_branch()
2045
if revision_id is None:
2046
revision_id = branch.last_revision()
2048
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2054
_control_files=control_files)
2055
wt.lock_tree_write()
2057
wt._write_inventory(inv)
2058
wt.set_root_id(inv.root.file_id)
2059
basis_tree = branch.repository.revision_tree(revision_id)
2060
if revision_id == bzrlib.revision.NULL_REVISION:
2061
wt.set_parent_trees([])
2063
wt.set_parent_trees([(revision_id, basis_tree)])
2064
build_tree(basis_tree, wt)
2067
control_files.unlock()
2071
super(WorkingTreeFormat3, self).__init__()
2072
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2074
def open(self, a_bzrdir, _found=False):
2075
"""Return the WorkingTree object for a_bzrdir
2077
_found is a private parameter, do not use it. It is used to indicate
2078
if format probing has already been done.
2081
# we are being called directly and must probe.
2082
raise NotImplementedError
2083
if not isinstance(a_bzrdir.transport, LocalTransport):
2084
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2085
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2087
def _open(self, a_bzrdir, control_files):
2088
"""Open the tree itself.
2090
:param a_bzrdir: the dir for the tree.
2091
:param control_files: the control files for the tree.
2093
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2097
_control_files=control_files)
2100
return self.get_format_string()
2103
# formats which have no format string are not discoverable
2104
# and not independently creatable, so are not registered.
2105
__default_format = WorkingTreeFormat3()
2106
WorkingTreeFormat.register_format(__default_format)
2107
WorkingTreeFormat.set_default_format(__default_format)
2108
_legacy_formats = [WorkingTreeFormat2(),
2112
class WorkingTreeTestProviderAdapter(object):
2113
"""A tool to generate a suite testing multiple workingtree formats at once.
2115
This is done by copying the test once for each transport and injecting
2116
the transport_server, transport_readonly_server, and workingtree_format
2117
classes into each copy. Each copy is also given a new id() to make it
2121
def __init__(self, transport_server, transport_readonly_server, formats):
2122
self._transport_server = transport_server
2123
self._transport_readonly_server = transport_readonly_server
2124
self._formats = formats
2126
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2127
"""Clone test for adaption."""
2128
new_test = deepcopy(test)
2129
new_test.transport_server = self._transport_server
2130
new_test.transport_readonly_server = self._transport_readonly_server
2131
new_test.bzrdir_format = bzrdir_format
2132
new_test.workingtree_format = workingtree_format
2133
def make_new_test_id():
2134
new_id = "%s(%s)" % (test.id(), variation)
2135
return lambda: new_id
2136
new_test.id = make_new_test_id()
2139
def adapt(self, test):
2140
from bzrlib.tests import TestSuite
2141
result = TestSuite()
2142
for workingtree_format, bzrdir_format in self._formats:
2143
new_test = self._clone_test(
2146
workingtree_format, workingtree_format.__class__.__name__)
2147
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
