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
class TreeEntry(object):
163
"""An entry that implements the minimum interface used by commands.
165
This needs further inspection, it may be better to have
166
InventoryEntries without ids - though that seems wrong. For now,
167
this is a parallel hierarchy to InventoryEntry, and needs to become
168
one of several things: decorates to that hierarchy, children of, or
170
Another note is that these objects are currently only used when there is
171
no InventoryEntry available - i.e. for unversioned objects.
172
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
175
def __eq__(self, other):
176
# yes, this us ugly, TODO: best practice __eq__ style.
177
return (isinstance(other, TreeEntry)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeDirectory(TreeEntry):
185
"""See TreeEntry. This is a directory in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeDirectory)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class TreeFile(TreeEntry):
196
"""See TreeEntry. This is a regular file in a working tree."""
198
def __eq__(self, other):
199
return (isinstance(other, TreeFile)
200
and other.__class__ == self.__class__)
202
def kind_character(self):
206
class TreeLink(TreeEntry):
207
"""See TreeEntry. This is a symlink in a working tree."""
209
def __eq__(self, other):
210
return (isinstance(other, TreeLink)
211
and other.__class__ == self.__class__)
213
def kind_character(self):
217
class WorkingTree(bzrlib.tree.Tree):
218
"""Working copy tree.
220
The inventory is held in the `Branch` working-inventory, and the
221
files are in a directory on disk.
223
It is possible for a `WorkingTree` to have a filename which is
224
not listed in the Inventory and vice versa.
227
def __init__(self, basedir='.',
228
branch=DEPRECATED_PARAMETER,
234
"""Construct a WorkingTree for basedir.
236
If the branch is not supplied, it is opened automatically.
237
If the branch is supplied, it must be the branch for this basedir.
238
(branch.base is not cross checked, because for remote branches that
239
would be meaningless).
241
self._format = _format
242
self.bzrdir = _bzrdir
244
# not created via open etc.
245
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
246
"Please use bzrdir.open_workingtree or WorkingTree.open().",
249
wt = WorkingTree.open(basedir)
250
self._branch = wt.branch
251
self.basedir = wt.basedir
252
self._control_files = wt._control_files
253
self._hashcache = wt._hashcache
254
self._set_inventory(wt._inventory)
255
self._format = wt._format
256
self.bzrdir = wt.bzrdir
257
from bzrlib.hashcache import HashCache
258
from bzrlib.trace import note, mutter
259
assert isinstance(basedir, basestring), \
260
"base directory %r is not a string" % basedir
261
basedir = safe_unicode(basedir)
262
mutter("opening working tree %r", basedir)
263
if deprecated_passed(branch):
265
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
266
" Please use bzrdir.open_workingtree() or"
267
" WorkingTree.open().",
271
self._branch = branch
273
self._branch = self.bzrdir.open_branch()
274
self.basedir = realpath(basedir)
275
# if branch is at our basedir and is a format 6 or less
276
if isinstance(self._format, WorkingTreeFormat2):
277
# share control object
278
self._control_files = self.branch.control_files
280
# assume all other formats have their own control files.
281
assert isinstance(_control_files, LockableFiles), \
282
"_control_files must be a LockableFiles, not %r" \
284
self._control_files = _control_files
285
# update the whole cache up front and write to disk if anything changed;
286
# in the future we might want to do this more selectively
287
# two possible ways offer themselves : in self._unlock, write the cache
288
# if needed, or, when the cache sees a change, append it to the hash
289
# cache file, and have the parser take the most recent entry for a
291
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
292
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
294
# is this scan needed ? it makes things kinda slow.
301
if _inventory is None:
302
self._set_inventory(self.read_working_inventory())
304
self._set_inventory(_inventory)
307
fget=lambda self: self._branch,
308
doc="""The branch this WorkingTree is connected to.
310
This cannot be set - it is reflective of the actual disk structure
311
the working tree has been constructed from.
314
def break_lock(self):
315
"""Break a lock if one is present from another instance.
317
Uses the ui factory to ask for confirmation if the lock may be from
320
This will probe the repository for its lock as well.
322
self._control_files.break_lock()
323
self.branch.break_lock()
325
def _set_inventory(self, inv):
326
assert inv.root is not None
327
self._inventory = inv
328
self.path2id = self._inventory.path2id
330
def is_control_filename(self, filename):
331
"""True if filename is the name of a control file in this tree.
333
:param filename: A filename within the tree. This is a relative path
334
from the root of this tree.
336
This is true IF and ONLY IF the filename is part of the meta data
337
that bzr controls in this tree. I.E. a random .bzr directory placed
338
on disk will not be a control file for this tree.
340
return self.bzrdir.is_control_filename(filename)
343
def open(path=None, _unsupported=False):
344
"""Open an existing working tree at path.
348
path = os.path.getcwdu()
349
control = bzrdir.BzrDir.open(path, _unsupported)
350
return control.open_workingtree(_unsupported)
353
def open_containing(path=None):
354
"""Open an existing working tree which has its root about path.
356
This probes for a working tree at path and searches upwards from there.
358
Basically we keep looking up until we find the control directory or
359
run into /. If there isn't one, raises NotBranchError.
360
TODO: give this a new exception.
361
If there is one, it is returned, along with the unused portion of path.
363
:return: The WorkingTree that contains 'path', and the rest of path
366
path = osutils.getcwd()
367
control, relpath = bzrdir.BzrDir.open_containing(path)
369
return control.open_workingtree(), relpath
372
def open_downlevel(path=None):
373
"""Open an unsupported working tree.
375
Only intended for advanced situations like upgrading part of a bzrdir.
377
return WorkingTree.open(path, _unsupported=True)
380
"""Iterate through file_ids for this tree.
382
file_ids are in a WorkingTree if they are in the working inventory
383
and the working file exists.
385
inv = self._inventory
386
for path, ie in inv.iter_entries():
387
if osutils.lexists(self.abspath(path)):
391
return "<%s of %s>" % (self.__class__.__name__,
392
getattr(self, 'basedir', None))
394
def abspath(self, filename):
395
return pathjoin(self.basedir, filename)
397
def basis_tree(self):
398
"""Return RevisionTree for the current last revision.
400
If the left most parent is a ghost then the returned tree will be an
401
empty tree - one obtained by calling repository.revision_tree(None).
404
revision_id = self.get_parent_ids()[0]
406
# no parents, return an empty revision tree.
407
# in the future this should return the tree for
408
# 'empty:' - the implicit root empty tree.
409
return self.branch.repository.revision_tree(None)
412
xml = self.read_basis_inventory()
413
inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
414
if inv is not None and inv.revision_id == revision_id:
415
return bzrlib.tree.RevisionTree(self.branch.repository,
417
except (NoSuchFile, errors.BadInventoryFormat):
419
# No cached copy available, retrieve from the repository.
420
# FIXME? RBC 20060403 should we cache the inventory locally
423
return self.branch.repository.revision_tree(revision_id)
424
except errors.RevisionNotPresent:
425
# the basis tree *may* be a ghost or a low level error may have
426
# occured. If the revision is present, its a problem, if its not
428
if self.branch.repository.has_revision(revision_id):
430
# the basis tree is a ghost so return an empty tree.
431
return self.branch.repository.revision_tree(None)
434
@deprecated_method(zero_eight)
435
def create(branch, directory):
436
"""Create a workingtree for branch at directory.
438
If existing_directory already exists it must have a .bzr directory.
439
If it does not exist, it will be created.
441
This returns a new WorkingTree object for the new checkout.
443
TODO FIXME RBC 20060124 when we have checkout formats in place this
444
should accept an optional revisionid to checkout [and reject this if
445
checking out into the same dir as a pre-checkout-aware branch format.]
447
XXX: When BzrDir is present, these should be created through that
450
warnings.warn('delete WorkingTree.create', stacklevel=3)
451
transport = get_transport(directory)
452
if branch.bzrdir.root_transport.base == transport.base:
454
return branch.bzrdir.create_workingtree()
455
# different directory,
456
# create a branch reference
457
# and now a working tree.
458
raise NotImplementedError
461
@deprecated_method(zero_eight)
462
def create_standalone(directory):
463
"""Create a checkout and a branch and a repo at directory.
465
Directory must exist and be empty.
467
please use BzrDir.create_standalone_workingtree
469
return bzrdir.BzrDir.create_standalone_workingtree(directory)
471
def relpath(self, path):
472
"""Return the local path portion from a given path.
474
The path may be absolute or relative. If its a relative path it is
475
interpreted relative to the python current working directory.
477
return relpath(self.basedir, path)
479
def has_filename(self, filename):
480
return osutils.lexists(self.abspath(filename))
482
def get_file(self, file_id):
483
return self.get_file_byname(self.id2path(file_id))
485
def get_file_text(self, file_id):
486
return self.get_file(file_id).read()
488
def get_file_byname(self, filename):
489
return file(self.abspath(filename), 'rb')
491
def get_parent_ids(self):
492
"""See Tree.get_parent_ids.
494
This implementation reads the pending merges list and last_revision
495
value and uses that to decide what the parents list should be.
497
last_rev = self._last_revision()
503
merges_file = self._control_files.get_utf8('pending-merges')
507
for l in merges_file.readlines():
508
parents.append(l.rstrip('\n'))
511
def get_root_id(self):
512
"""Return the id of this trees root"""
513
inv = self.read_working_inventory()
514
return inv.root.file_id
516
def _get_store_filename(self, file_id):
517
## XXX: badly named; this is not in the store at all
518
return self.abspath(self.id2path(file_id))
521
def clone(self, to_bzrdir, revision_id=None, basis=None):
522
"""Duplicate this working tree into to_bzr, including all state.
524
Specifically modified files are kept as modified, but
525
ignored and unknown files are discarded.
527
If you want to make a new line of development, see bzrdir.sprout()
530
If not None, the cloned tree will have its last revision set to
531
revision, and and difference between the source trees last revision
532
and this one merged in.
535
If not None, a closer copy of a tree which may have some files in
536
common, and which file content should be preferentially copied from.
538
# assumes the target bzr dir format is compatible.
539
result = self._format.initialize(to_bzrdir)
540
self.copy_content_into(result, revision_id)
544
def copy_content_into(self, tree, revision_id=None):
545
"""Copy the current content and user files of this tree into tree."""
546
if revision_id is None:
547
transform_tree(tree, self)
549
# TODO now merge from tree.last_revision to revision (to preserve
550
# user local changes)
551
transform_tree(tree, self)
552
tree.set_parent_ids([revision_id])
555
def commit(self, message=None, revprops=None, *args, **kwargs):
556
# avoid circular imports
557
from bzrlib.commit import Commit
560
if not 'branch-nick' in revprops:
561
revprops['branch-nick'] = self.branch.nick
562
# args for wt.commit start at message from the Commit.commit method,
563
# but with branch a kwarg now, passing in args as is results in the
564
#message being used for the branch
565
args = (DEPRECATED_PARAMETER, message, ) + args
566
committed_id = Commit().commit( working_tree=self, revprops=revprops,
570
def id2abspath(self, file_id):
571
return self.abspath(self.id2path(file_id))
573
def has_id(self, file_id):
574
# files that have been deleted are excluded
575
inv = self._inventory
576
if not inv.has_id(file_id):
578
path = inv.id2path(file_id)
579
return osutils.lexists(self.abspath(path))
581
def has_or_had_id(self, file_id):
582
if file_id == self.inventory.root.file_id:
584
return self.inventory.has_id(file_id)
586
__contains__ = has_id
588
def get_file_size(self, file_id):
589
return os.path.getsize(self.id2abspath(file_id))
592
def get_file_sha1(self, file_id, path=None):
594
path = self._inventory.id2path(file_id)
595
return self._hashcache.get_sha1(path)
597
def get_file_mtime(self, file_id, path=None):
599
path = self._inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
if not supports_executable():
603
def is_executable(self, file_id, path=None):
604
return self._inventory[file_id].executable
606
def is_executable(self, file_id, path=None):
608
path = self._inventory.id2path(file_id)
609
mode = os.lstat(self.abspath(path)).st_mode
610
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
613
def add(self, files, ids=None):
614
"""Make files versioned.
616
Note that the command line normally calls smart_add instead,
617
which can automatically recurse.
619
This adds the files to the inventory, so that they will be
620
recorded by the next commit.
623
List of paths to add, relative to the base of the tree.
626
If set, use these instead of automatically generated ids.
627
Must be the same length as the list of files, but may
628
contain None for ids that are to be autogenerated.
630
TODO: Perhaps have an option to add the ids even if the files do
633
TODO: Perhaps callback with the ids and paths as they're added.
635
# TODO: Re-adding a file that is removed in the working copy
636
# should probably put it back with the previous ID.
637
if isinstance(files, basestring):
638
assert(ids is None or isinstance(ids, basestring))
644
ids = [None] * len(files)
646
assert(len(ids) == len(files))
648
inv = self.read_working_inventory()
649
for f,file_id in zip(files, ids):
650
if self.is_control_filename(f):
651
raise errors.ForbiddenControlFileError(filename=f)
656
raise BzrError("cannot add top-level %r" % f)
658
fullpath = normpath(self.abspath(f))
660
kind = file_kind(fullpath)
662
if e.errno == errno.ENOENT:
663
raise NoSuchFile(fullpath)
664
if not InventoryEntry.versionable_kind(kind):
665
raise errors.BadFileKindError(filename=f, kind=kind)
667
inv.add_path(f, kind=kind)
669
inv.add_path(f, kind=kind, file_id=file_id)
671
self._write_inventory(inv)
674
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
675
"""Add revision_id as a parent.
677
This is equivalent to retrieving the current list of parent ids
678
and setting the list to its value plus revision_id.
680
:param revision_id: The revision id to add to the parent list. It may
681
be a ghost revision as long as its not the first parent to be added,
682
or the allow_leftmost_as_ghost parameter is set True.
683
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
685
parents = self.get_parent_ids() + [revision_id]
686
self.set_parent_ids(parents,
687
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
690
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
691
"""Add revision_id, tree tuple as a parent.
693
This is equivalent to retrieving the current list of parent trees
694
and setting the list to its value plus parent_tuple. See also
695
add_parent_tree_id - if you only have a parent id available it will be
696
simpler to use that api. If you have the parent already available, using
697
this api is preferred.
699
:param parent_tuple: The (revision id, tree) to add to the parent list.
700
If the revision_id is a ghost, pass None for the tree.
701
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
703
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
704
if len(parent_ids) > 1:
705
# the leftmost may have already been a ghost, preserve that if it
707
allow_leftmost_as_ghost = True
708
self.set_parent_ids(parent_ids,
709
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
712
def add_pending_merge(self, *revision_ids):
713
# TODO: Perhaps should check at this point that the
714
# history of the revision is actually present?
715
parents = self.get_parent_ids()
717
for rev_id in revision_ids:
718
if rev_id in parents:
720
parents.append(rev_id)
723
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
725
@deprecated_method(zero_eleven)
727
def pending_merges(self):
728
"""Return a list of pending merges.
730
These are revisions that have been merged into the working
731
directory but not yet committed.
733
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
734
instead - which is available on all tree objects.
736
return self.get_parent_ids()[1:]
739
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
740
"""Set the parent ids to revision_ids.
742
See also set_parent_trees. This api will try to retrieve the tree data
743
for each element of revision_ids from the trees repository. If you have
744
tree data already available, it is more efficient to use
745
set_parent_trees rather than set_parent_ids. set_parent_ids is however
746
an easier API to use.
748
:param revision_ids: The revision_ids to set as the parent ids of this
749
working tree. Any of these may be ghosts.
751
if len(revision_ids) > 0:
752
leftmost_id = revision_ids[0]
753
if (not allow_leftmost_as_ghost and not
754
self.branch.repository.has_revision(leftmost_id)):
755
raise errors.GhostRevisionUnusableHere(leftmost_id)
756
self.set_last_revision(leftmost_id)
758
self.set_last_revision(None)
759
merges = revision_ids[1:]
760
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
763
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
764
"""Set the parents of the working tree.
766
:param parents_list: A list of (revision_id, tree) tuples.
767
If tree is None, then that element is treated as an unreachable
768
parent tree - i.e. a ghost.
770
# parent trees are not used in current format trees, delegate to
772
self.set_parent_ids([rev for (rev, tree) in parents_list],
773
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
776
def set_pending_merges(self, rev_list):
777
parents = self.get_parent_ids()
778
leftmost = parents[:1]
779
new_parents = leftmost + rev_list
780
self.set_parent_ids(new_parents)
783
def set_merge_modified(self, modified_hashes):
785
for file_id, hash in modified_hashes.iteritems():
786
yield Stanza(file_id=file_id, hash=hash)
787
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
790
def _put_rio(self, filename, stanzas, header):
791
my_file = rio_file(stanzas, header)
792
self._control_files.put(filename, my_file)
795
def merge_from_branch(self, branch, to_revision=None):
796
"""Merge from a branch into this working tree.
798
:param branch: The branch to merge from.
799
:param to_revision: If non-None, the merge will merge to to_revision, but
800
not beyond it. to_revision does not need to be in the history of
801
the branch when it is supplied. If None, to_revision defaults to
802
branch.last_revision().
804
from bzrlib.merge import Merger, Merge3Merger
805
pb = bzrlib.ui.ui_factory.nested_progress_bar()
807
merger = Merger(self.branch, this_tree=self, pb=pb)
808
merger.pp = ProgressPhase("Merge phase", 5, pb)
809
merger.pp.next_phase()
810
# check that there are no
812
merger.check_basis(check_clean=True, require_commits=False)
813
if to_revision is None:
814
to_revision = branch.last_revision()
815
merger.other_rev_id = to_revision
816
if merger.other_rev_id is None:
817
raise error.NoCommits(branch)
818
self.branch.fetch(branch, last_revision=merger.other_rev_id)
819
merger.other_basis = merger.other_rev_id
820
merger.other_tree = self.branch.repository.revision_tree(
822
merger.pp.next_phase()
824
if merger.base_rev_id == merger.other_rev_id:
825
raise errors.PointlessMerge
826
merger.backup_files = False
827
merger.merge_type = Merge3Merger
828
merger.set_interesting_files(None)
829
merger.show_base = False
830
merger.reprocess = False
831
conflicts = merger.do_merge()
838
def merge_modified(self):
840
hashfile = self._control_files.get('merge-hashes')
845
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
846
raise MergeModifiedFormatError()
847
except StopIteration:
848
raise MergeModifiedFormatError()
849
for s in RioReader(hashfile):
850
file_id = s.get("file_id")
851
if file_id not in self.inventory:
854
if hash == self.get_file_sha1(file_id):
855
merge_hashes[file_id] = hash
858
def get_symlink_target(self, file_id):
859
return os.readlink(self.id2abspath(file_id))
861
def file_class(self, filename):
862
if self.path2id(filename):
864
elif self.is_ignored(filename):
869
def list_files(self):
870
"""Recursively list all files as (path, class, kind, id, entry).
872
Lists, but does not descend into unversioned directories.
874
This does not include files that have been deleted in this
877
Skips the control directory.
879
inv = self._inventory
880
# Convert these into local objects to save lookup times
881
pathjoin = osutils.pathjoin
882
file_kind = osutils.file_kind
884
# transport.base ends in a slash, we want the piece
885
# between the last two slashes
886
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
888
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
890
# directory file_id, relative path, absolute path, reverse sorted children
891
children = os.listdir(self.basedir)
893
# jam 20060527 The kernel sized tree seems equivalent whether we
894
# use a deque and popleft to keep them sorted, or if we use a plain
895
# list and just reverse() them.
896
children = collections.deque(children)
897
stack = [(inv.root.file_id, u'', self.basedir, children)]
899
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
902
f = children.popleft()
903
## TODO: If we find a subdirectory with its own .bzr
904
## directory, then that is a separate tree and we
905
## should exclude it.
907
# the bzrdir for this tree
908
if transport_base_dir == f:
911
# we know that from_dir_relpath and from_dir_abspath never end in a slash
912
# and 'f' doesn't begin with one, we can do a string op, rather
913
# than the checks of pathjoin(), all relative paths will have an extra slash
915
fp = from_dir_relpath + '/' + f
918
fap = from_dir_abspath + '/' + f
920
f_ie = inv.get_child(from_dir_id, f)
923
elif self.is_ignored(fp[1:]):
926
# we may not have found this file, because of a unicode issue
927
f_norm, can_access = osutils.normalized_filename(f)
928
if f == f_norm or not can_access:
929
# No change, so treat this file normally
932
# this file can be accessed by a normalized path
933
# check again if it is versioned
934
# these lines are repeated here for performance
936
fp = from_dir_relpath + '/' + f
937
fap = from_dir_abspath + '/' + f
938
f_ie = inv.get_child(from_dir_id, f)
941
elif self.is_ignored(fp[1:]):
950
raise BzrCheckError("file %r entered as kind %r id %r, "
952
% (fap, f_ie.kind, f_ie.file_id, fk))
954
# make a last minute entry
956
yield fp[1:], c, fk, f_ie.file_id, f_ie
959
yield fp[1:], c, fk, None, fk_entries[fk]()
961
yield fp[1:], c, fk, None, TreeEntry()
964
if fk != 'directory':
967
# But do this child first
968
new_children = os.listdir(fap)
970
new_children = collections.deque(new_children)
971
stack.append((f_ie.file_id, fp, fap, new_children))
972
# Break out of inner loop, so that we start outer loop with child
975
# if we finished all children, pop it off the stack
980
def move(self, from_paths, to_name):
983
to_name must exist in the inventory.
985
If to_name exists and is a directory, the files are moved into
986
it, keeping their old names.
988
Note that to_name is only the last component of the new name;
989
this doesn't change the directory.
991
This returns a list of (from_path, to_path) pairs for each
995
## TODO: Option to move IDs only
996
assert not isinstance(from_paths, basestring)
998
to_abs = self.abspath(to_name)
999
if not isdir(to_abs):
1000
raise BzrError("destination %r is not a directory" % to_abs)
1001
if not self.has_filename(to_name):
1002
raise BzrError("destination %r not in working directory" % to_abs)
1003
to_dir_id = inv.path2id(to_name)
1004
if to_dir_id is None and to_name != '':
1005
raise BzrError("destination %r is not a versioned directory" % to_name)
1006
to_dir_ie = inv[to_dir_id]
1007
if to_dir_ie.kind != 'directory':
1008
raise BzrError("destination %r is not a directory" % to_abs)
1010
to_idpath = inv.get_idpath(to_dir_id)
1012
for f in from_paths:
1013
if not self.has_filename(f):
1014
raise BzrError("%r does not exist in working tree" % f)
1015
f_id = inv.path2id(f)
1017
raise BzrError("%r is not versioned" % f)
1018
name_tail = splitpath(f)[-1]
1019
dest_path = pathjoin(to_name, name_tail)
1020
if self.has_filename(dest_path):
1021
raise BzrError("destination %r already exists" % dest_path)
1022
if f_id in to_idpath:
1023
raise BzrError("can't move %r to a subdirectory of itself" % f)
1025
# OK, so there's a race here, it's possible that someone will
1026
# create a file in this interval and then the rename might be
1027
# left half-done. But we should have caught most problems.
1028
orig_inv = deepcopy(self.inventory)
1030
for f in from_paths:
1031
name_tail = splitpath(f)[-1]
1032
dest_path = pathjoin(to_name, name_tail)
1033
result.append((f, dest_path))
1034
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1036
rename(self.abspath(f), self.abspath(dest_path))
1038
raise BzrError("failed to rename %r to %r: %s" %
1039
(f, dest_path, e[1]),
1040
["rename rolled back"])
1042
# restore the inventory on error
1043
self._set_inventory(orig_inv)
1045
self._write_inventory(inv)
1049
def rename_one(self, from_rel, to_rel):
1052
This can change the directory or the filename or both.
1054
inv = self.inventory
1055
if not self.has_filename(from_rel):
1056
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1057
if self.has_filename(to_rel):
1058
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1060
file_id = inv.path2id(from_rel)
1062
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1064
entry = inv[file_id]
1065
from_parent = entry.parent_id
1066
from_name = entry.name
1068
if inv.path2id(to_rel):
1069
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1071
to_dir, to_tail = os.path.split(to_rel)
1072
to_dir_id = inv.path2id(to_dir)
1073
if to_dir_id is None and to_dir != '':
1074
raise BzrError("can't determine destination directory id for %r" % to_dir)
1076
mutter("rename_one:")
1077
mutter(" file_id {%s}" % file_id)
1078
mutter(" from_rel %r" % from_rel)
1079
mutter(" to_rel %r" % to_rel)
1080
mutter(" to_dir %r" % to_dir)
1081
mutter(" to_dir_id {%s}" % to_dir_id)
1083
inv.rename(file_id, to_dir_id, to_tail)
1085
from_abs = self.abspath(from_rel)
1086
to_abs = self.abspath(to_rel)
1088
rename(from_abs, to_abs)
1090
inv.rename(file_id, from_parent, from_name)
1091
raise BzrError("failed to rename %r to %r: %s"
1092
% (from_abs, to_abs, e[1]),
1093
["rename rolled back"])
1094
self._write_inventory(inv)
1098
"""Return all unknown files.
1100
These are files in the working directory that are not versioned or
1101
control files or ignored.
1103
for subp in self.extras():
1104
if not self.is_ignored(subp):
1108
def unversion(self, file_ids):
1109
"""Remove the file ids in file_ids from the current versioned set.
1111
When a file_id is unversioned, all of its children are automatically
1114
:param file_ids: The file ids to stop versioning.
1115
:raises: NoSuchId if any fileid is not currently versioned.
1117
for file_id in file_ids:
1118
if self._inventory.has_id(file_id):
1119
self._inventory.remove_recursive_id(file_id)
1121
raise errors.NoSuchId(self, file_id)
1123
# in the future this should just set a dirty bit to wait for the
1124
# final unlock. However, until all methods of workingtree start
1125
# with the current in -memory inventory rather than triggering
1126
# a read, it is more complex - we need to teach read_inventory
1127
# to know when to read, and when to not read first... and possibly
1128
# to save first when the in memory one may be corrupted.
1129
# so for now, we just only write it if it is indeed dirty.
1131
self._write_inventory(self._inventory)
1133
@deprecated_method(zero_eight)
1134
def iter_conflicts(self):
1135
"""List all files in the tree that have text or content conflicts.
1136
DEPRECATED. Use conflicts instead."""
1137
return self._iter_conflicts()
1139
def _iter_conflicts(self):
1141
for info in self.list_files():
1143
stem = get_conflicted_stem(path)
1146
if stem not in conflicted:
1147
conflicted.add(stem)
1151
def pull(self, source, overwrite=False, stop_revision=None):
1152
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1155
pp = ProgressPhase("Pull phase", 2, top_pb)
1157
old_revision_history = self.branch.revision_history()
1158
basis_tree = self.basis_tree()
1159
count = self.branch.pull(source, overwrite, stop_revision)
1160
new_revision_history = self.branch.revision_history()
1161
if new_revision_history != old_revision_history:
1163
if len(old_revision_history):
1164
other_revision = old_revision_history[-1]
1166
other_revision = None
1167
repository = self.branch.repository
1168
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1170
new_basis_tree = self.branch.basis_tree()
1171
merge_inner(self.branch,
1178
# TODO - dedup parents list with things merged by pull ?
1179
# reuse the revisiontree we merged against to set the new
1181
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1182
# we have to pull the merge trees out again, because
1183
# merge_inner has set the ids. - this corner is not yet
1184
# layered well enough to prevent double handling.
1185
merges = self.get_parent_ids()[1:]
1186
parent_trees.extend([
1187
(parent, repository.revision_tree(parent)) for
1189
self.set_parent_trees(parent_trees)
1196
"""Yield all unknown files in this WorkingTree.
1198
If there are any unknown directories then only the directory is
1199
returned, not all its children. But if there are unknown files
1200
under a versioned subdirectory, they are returned.
1202
Currently returned depth-first, sorted by name within directories.
1204
## TODO: Work from given directory downwards
1205
for path, dir_entry in self.inventory.directories():
1206
# mutter("search for unknowns in %r", path)
1207
dirabs = self.abspath(path)
1208
if not isdir(dirabs):
1209
# e.g. directory deleted
1213
for subf in os.listdir(dirabs):
1216
if subf not in dir_entry.children:
1217
subf_norm, can_access = osutils.normalized_filename(subf)
1218
if subf_norm != subf and can_access:
1219
if subf_norm not in dir_entry.children:
1220
fl.append(subf_norm)
1226
subp = pathjoin(path, subf)
1229
def _translate_ignore_rule(self, rule):
1230
"""Translate a single ignore rule to a regex.
1232
There are two types of ignore rules. Those that do not contain a / are
1233
matched against the tail of the filename (that is, they do not care
1234
what directory the file is in.) Rules which do contain a slash must
1235
match the entire path. As a special case, './' at the start of the
1236
string counts as a slash in the string but is removed before matching
1237
(e.g. ./foo.c, ./src/foo.c)
1239
:return: The translated regex.
1241
if rule[:2] in ('./', '.\\'):
1243
result = fnmatch.translate(rule[2:])
1244
elif '/' in rule or '\\' in rule:
1246
result = fnmatch.translate(rule)
1248
# default rule style.
1249
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1250
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1251
return "(" + result + ")"
1253
def _combine_ignore_rules(self, rules):
1254
"""Combine a list of ignore rules into a single regex object.
1256
Each individual rule is combined with | to form a big regex, which then
1257
has $ added to it to form something like ()|()|()$. The group index for
1258
each subregex's outermost group is placed in a dictionary mapping back
1259
to the rule. This allows quick identification of the matching rule that
1261
:return: a list of the compiled regex and the matching-group index
1262
dictionaries. We return a list because python complains if you try to
1263
combine more than 100 regexes.
1268
translated_rules = []
1270
translated_rule = self._translate_ignore_rule(rule)
1271
compiled_rule = re.compile(translated_rule)
1272
groups[next_group] = rule
1273
next_group += compiled_rule.groups
1274
translated_rules.append(translated_rule)
1275
if next_group == 99:
1276
result.append((re.compile("|".join(translated_rules)), groups))
1279
translated_rules = []
1280
if len(translated_rules):
1281
result.append((re.compile("|".join(translated_rules)), groups))
1284
def ignored_files(self):
1285
"""Yield list of PATH, IGNORE_PATTERN"""
1286
for subp in self.extras():
1287
pat = self.is_ignored(subp)
1291
def get_ignore_list(self):
1292
"""Return list of ignore patterns.
1294
Cached in the Tree object after the first call.
1296
ignoreset = getattr(self, '_ignoreset', None)
1297
if ignoreset is not None:
1300
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1301
ignore_globs.update(ignores.get_runtime_ignores())
1303
ignore_globs.update(ignores.get_user_ignores())
1305
if self.has_filename(bzrlib.IGNORE_FILENAME):
1306
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1308
ignore_globs.update(ignores.parse_ignore_file(f))
1312
self._ignoreset = ignore_globs
1313
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1316
def _get_ignore_rules_as_regex(self):
1317
"""Return a regex of the ignore rules and a mapping dict.
1319
:return: (ignore rules compiled regex, dictionary mapping rule group
1320
indices to original rule.)
1322
if getattr(self, '_ignoreset', None) is None:
1323
self.get_ignore_list()
1324
return self._ignore_regex
1326
def is_ignored(self, filename):
1327
r"""Check whether the filename matches an ignore pattern.
1329
Patterns containing '/' or '\' need to match the whole path;
1330
others match against only the last component.
1332
If the file is ignored, returns the pattern which caused it to
1333
be ignored, otherwise None. So this can simply be used as a
1334
boolean if desired."""
1336
# TODO: Use '**' to match directories, and other extended
1337
# globbing stuff from cvs/rsync.
1339
# XXX: fnmatch is actually not quite what we want: it's only
1340
# approximately the same as real Unix fnmatch, and doesn't
1341
# treat dotfiles correctly and allows * to match /.
1342
# Eventually it should be replaced with something more
1345
rules = self._get_ignore_rules_as_regex()
1346
for regex, mapping in rules:
1347
match = regex.match(filename)
1348
if match is not None:
1349
# one or more of the groups in mapping will have a non-None
1351
groups = match.groups()
1352
rules = [mapping[group] for group in
1353
mapping if groups[group] is not None]
1357
def kind(self, file_id):
1358
return file_kind(self.id2abspath(file_id))
1360
def last_revision(self):
1361
"""Return the last revision id of this working tree.
1363
In early branch formats this was the same as the branch last_revision,
1364
but that cannot be relied upon - for working tree operations,
1365
always use tree.last_revision(). This returns the left most parent id,
1366
or None if there are no parents.
1368
This was deprecated as of 0.11. Please use get_parent_ids instead.
1370
return self._last_revision()
1373
def _last_revision(self):
1374
"""helper for get_parent_ids."""
1375
return self.branch.last_revision()
1377
def is_locked(self):
1378
return self._control_files.is_locked()
1380
def lock_read(self):
1381
"""See Branch.lock_read, and WorkingTree.unlock."""
1382
self.branch.lock_read()
1384
return self._control_files.lock_read()
1386
self.branch.unlock()
1389
def lock_write(self):
1390
"""See Branch.lock_write, and WorkingTree.unlock."""
1391
self.branch.lock_write()
1393
return self._control_files.lock_write()
1395
self.branch.unlock()
1398
def get_physical_lock_status(self):
1399
return self._control_files.get_physical_lock_status()
1401
def _basis_inventory_name(self):
1402
return 'basis-inventory-cache'
1405
def set_last_revision(self, new_revision):
1406
"""Change the last revision in the working tree."""
1407
if self._change_last_revision(new_revision):
1408
self._cache_basis_inventory(new_revision)
1410
def _change_last_revision(self, new_revision):
1411
"""Template method part of set_last_revision to perform the change.
1413
This is used to allow WorkingTree3 instances to not affect branch
1414
when their last revision is set.
1416
if new_revision is None:
1417
self.branch.set_revision_history([])
1420
self.branch.generate_revision_history(new_revision)
1421
except errors.NoSuchRevision:
1422
# not present in the repo - dont try to set it deeper than the tip
1423
self.branch.set_revision_history([new_revision])
1426
def _cache_basis_inventory(self, new_revision):
1427
"""Cache new_revision as the basis inventory."""
1428
# TODO: this should allow the ready-to-use inventory to be passed in,
1429
# as commit already has that ready-to-use [while the format is the
1432
# this double handles the inventory - unpack and repack -
1433
# but is easier to understand. We can/should put a conditional
1434
# in here based on whether the inventory is in the latest format
1435
# - perhaps we should repack all inventories on a repository
1437
# the fast path is to copy the raw xml from the repository. If the
1438
# xml contains 'revision_id="', then we assume the right
1439
# revision_id is set. We must check for this full string, because a
1440
# root node id can legitimately look like 'revision_id' but cannot
1442
xml = self.branch.repository.get_inventory_xml(new_revision)
1443
firstline = xml.split('\n', 1)[0]
1444
if (not 'revision_id="' in firstline or
1445
'format="6"' not in firstline):
1446
inv = self.branch.repository.deserialise_inventory(
1448
inv.revision_id = new_revision
1449
xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
1450
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1451
path = self._basis_inventory_name()
1453
self._control_files.put(path, sio)
1454
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1457
def read_basis_inventory(self):
1458
"""Read the cached basis inventory."""
1459
path = self._basis_inventory_name()
1460
return self._control_files.get(path).read()
1463
def read_working_inventory(self):
1464
"""Read the working inventory."""
1465
# ElementTree does its own conversion from UTF-8, so open in
1467
result = bzrlib.xml5.serializer_v5.read_inventory(
1468
self._control_files.get('inventory'))
1469
self._set_inventory(result)
1473
def remove(self, files, verbose=False, to_file=None):
1474
"""Remove nominated files from the working inventory..
1476
This does not remove their text. This does not run on XXX on what? RBC
1478
TODO: Refuse to remove modified files unless --force is given?
1480
TODO: Do something useful with directories.
1482
TODO: Should this remove the text or not? Tough call; not
1483
removing may be useful and the user can just use use rm, and
1484
is the opposite of add. Removing it is consistent with most
1485
other tools. Maybe an option.
1487
## TODO: Normalize names
1488
## TODO: Remove nested loops; better scalability
1489
if isinstance(files, basestring):
1492
inv = self.inventory
1494
# do this before any modifications
1496
fid = inv.path2id(f)
1498
# TODO: Perhaps make this just a warning, and continue?
1499
# This tends to happen when
1500
raise NotVersionedError(path=f)
1502
# having remove it, it must be either ignored or unknown
1503
if self.is_ignored(f):
1507
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1510
self._write_inventory(inv)
1513
def revert(self, filenames, old_tree=None, backups=True,
1514
pb=DummyProgress()):
1515
from transform import revert
1516
from conflicts import resolve
1517
if old_tree is None:
1518
old_tree = self.basis_tree()
1519
conflicts = revert(self, old_tree, filenames, backups, pb)
1520
if not len(filenames):
1521
self.set_parent_ids(self.get_parent_ids()[:1])
1524
resolve(self, filenames, ignore_misses=True)
1527
# XXX: This method should be deprecated in favour of taking in a proper
1528
# new Inventory object.
1530
def set_inventory(self, new_inventory_list):
1531
from bzrlib.inventory import (Inventory,
1536
inv = Inventory(self.get_root_id())
1537
for path, file_id, parent, kind in new_inventory_list:
1538
name = os.path.basename(path)
1541
# fixme, there should be a factory function inv,add_??
1542
if kind == 'directory':
1543
inv.add(InventoryDirectory(file_id, name, parent))
1544
elif kind == 'file':
1545
inv.add(InventoryFile(file_id, name, parent))
1546
elif kind == 'symlink':
1547
inv.add(InventoryLink(file_id, name, parent))
1549
raise BzrError("unknown kind %r" % kind)
1550
self._write_inventory(inv)
1553
def set_root_id(self, file_id):
1554
"""Set the root id for this tree."""
1555
inv = self.read_working_inventory()
1556
orig_root_id = inv.root.file_id
1557
del inv._byid[inv.root.file_id]
1558
inv.root.file_id = file_id
1559
inv._byid[inv.root.file_id] = inv.root
1562
if entry.parent_id == orig_root_id:
1563
entry.parent_id = inv.root.file_id
1564
self._write_inventory(inv)
1567
"""See Branch.unlock.
1569
WorkingTree locking just uses the Branch locking facilities.
1570
This is current because all working trees have an embedded branch
1571
within them. IF in the future, we were to make branch data shareable
1572
between multiple working trees, i.e. via shared storage, then we
1573
would probably want to lock both the local tree, and the branch.
1575
raise NotImplementedError(self.unlock)
1579
"""Update a working tree along its branch.
1581
This will update the branch if its bound too, which means we have multiple trees involved:
1582
The new basis tree of the master.
1583
The old basis tree of the branch.
1584
The old basis tree of the working tree.
1585
The current working tree state.
1586
pathologically all three may be different, and non ancestors of each other.
1587
Conceptually we want to:
1588
Preserve the wt.basis->wt.state changes
1589
Transform the wt.basis to the new master basis.
1590
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1591
Restore the wt.basis->wt.state changes.
1593
There isn't a single operation at the moment to do that, so we:
1594
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1595
Do a 'normal' merge of the old branch basis if it is relevant.
1597
old_tip = self.branch.update()
1598
# here if old_tip is not None, it is the old tip of the branch before
1599
# it was updated from the master branch. This should become a pending
1600
# merge in the working tree to preserve the user existing work. we
1601
# cant set that until we update the working trees last revision to be
1602
# one from the new branch, because it will just get absorbed by the
1603
# parent de-duplication logic.
1605
# We MUST save it even if an error occurs, because otherwise the users
1606
# local work is unreferenced and will appear to have been lost.
1610
last_rev = self.get_parent_ids()[0]
1613
if last_rev != self.branch.last_revision():
1614
# merge tree state up to new branch tip.
1615
basis = self.basis_tree()
1616
to_tree = self.branch.basis_tree()
1617
result += merge_inner(self.branch,
1621
# TODO - dedup parents list with things merged by pull ?
1622
# reuse the tree we've updated to to set the basis:
1623
parent_trees = [(self.branch.last_revision(), to_tree)]
1624
merges = self.get_parent_ids()[1:]
1625
# Ideally we ask the tree for the trees here, that way the working
1626
# tree can decide whether to give us teh entire tree or give us a
1627
# lazy initialised tree. dirstate for instance will have the trees
1628
# in ram already, whereas a last-revision + basis-inventory tree
1629
# will not, but also does not need them when setting parents.
1630
for parent in merges:
1631
parent_trees.append(
1632
(parent, self.branch.repository.revision_tree(parent)))
1633
if old_tip is not None:
1634
parent_trees.append(
1635
(old_tip, self.branch.repository.revision_tree(old_tip)))
1636
self.set_parent_trees(parent_trees)
1637
last_rev = parent_trees[0][0]
1639
# the working tree had the same last-revision as the master
1640
# branch did. We may still have pivot local work from the local
1641
# branch into old_tip:
1642
if old_tip is not None:
1643
self.add_parent_tree_id(old_tip)
1644
if old_tip and old_tip != last_rev:
1645
# our last revision was not the prior branch last revision
1646
# and we have converted that last revision to a pending merge.
1647
# base is somewhere between the branch tip now
1648
# and the now pending merge
1649
from bzrlib.revision import common_ancestor
1651
base_rev_id = common_ancestor(self.branch.last_revision(),
1653
self.branch.repository)
1654
except errors.NoCommonAncestor:
1656
base_tree = self.branch.repository.revision_tree(base_rev_id)
1657
other_tree = self.branch.repository.revision_tree(old_tip)
1658
result += merge_inner(self.branch,
1665
def _write_inventory(self, inv):
1666
"""Write inventory as the current inventory."""
1668
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1670
self._control_files.put('inventory', sio)
1671
self._set_inventory(inv)
1672
mutter('wrote working inventory')
1674
def set_conflicts(self, arg):
1675
raise UnsupportedOperation(self.set_conflicts, self)
1677
def add_conflicts(self, arg):
1678
raise UnsupportedOperation(self.add_conflicts, self)
1681
def conflicts(self):
1682
conflicts = ConflictList()
1683
for conflicted in self._iter_conflicts():
1686
if file_kind(self.abspath(conflicted)) != "file":
1688
except errors.NoSuchFile:
1691
for suffix in ('.THIS', '.OTHER'):
1693
kind = file_kind(self.abspath(conflicted+suffix))
1696
except errors.NoSuchFile:
1700
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1701
conflicts.append(Conflict.factory(ctype, path=conflicted,
1702
file_id=self.path2id(conflicted)))
1706
class WorkingTree2(WorkingTree):
1707
"""This is the Format 2 working tree.
1709
This was the first weave based working tree.
1710
- uses os locks for locking.
1711
- uses the branch last-revision.
1715
# we share control files:
1716
if self._hashcache.needs_write and self._control_files._lock_count==3:
1717
self._hashcache.write()
1718
# reverse order of locking.
1720
return self._control_files.unlock()
1722
self.branch.unlock()
1725
class WorkingTree3(WorkingTree):
1726
"""This is the Format 3 working tree.
1728
This differs from the base WorkingTree by:
1729
- having its own file lock
1730
- having its own last-revision property.
1732
This is new in bzr 0.8
1736
def _last_revision(self):
1737
"""See WorkingTree._last_revision."""
1739
return self._control_files.get_utf8('last-revision').read()
1743
def _change_last_revision(self, revision_id):
1744
"""See WorkingTree._change_last_revision."""
1745
if revision_id is None or revision_id == NULL_REVISION:
1747
self._control_files._transport.delete('last-revision')
1748
except errors.NoSuchFile:
1752
self._control_files.put_utf8('last-revision', revision_id)
1756
def set_conflicts(self, conflicts):
1757
self._put_rio('conflicts', conflicts.to_stanzas(),
1761
def add_conflicts(self, new_conflicts):
1762
conflict_set = set(self.conflicts())
1763
conflict_set.update(set(list(new_conflicts)))
1764
self.set_conflicts(ConflictList(sorted(conflict_set,
1765
key=Conflict.sort_key)))
1768
def conflicts(self):
1770
confile = self._control_files.get('conflicts')
1772
return ConflictList()
1774
if confile.next() != CONFLICT_HEADER_1 + '\n':
1775
raise ConflictFormatError()
1776
except StopIteration:
1777
raise ConflictFormatError()
1778
return ConflictList.from_stanzas(RioReader(confile))
1781
if self._hashcache.needs_write and self._control_files._lock_count==1:
1782
self._hashcache.write()
1783
# reverse order of locking.
1785
return self._control_files.unlock()
1787
self.branch.unlock()
1790
def get_conflicted_stem(path):
1791
for suffix in CONFLICT_SUFFIXES:
1792
if path.endswith(suffix):
1793
return path[:-len(suffix)]
1795
@deprecated_function(zero_eight)
1796
def is_control_file(filename):
1797
"""See WorkingTree.is_control_filename(filename)."""
1798
## FIXME: better check
1799
filename = normpath(filename)
1800
while filename != '':
1801
head, tail = os.path.split(filename)
1802
## mutter('check %r for control file' % ((head, tail),))
1805
if filename == head:
1811
class WorkingTreeFormat(object):
1812
"""An encapsulation of the initialization and open routines for a format.
1814
Formats provide three things:
1815
* An initialization routine,
1819
Formats are placed in an dict by their format string for reference
1820
during workingtree opening. Its not required that these be instances, they
1821
can be classes themselves with class methods - it simply depends on
1822
whether state is needed for a given format or not.
1824
Once a format is deprecated, just deprecate the initialize and open
1825
methods on the format class. Do not deprecate the object, as the
1826
object will be created every time regardless.
1829
_default_format = None
1830
"""The default format used for new trees."""
1833
"""The known formats."""
1836
def find_format(klass, a_bzrdir):
1837
"""Return the format for the working tree object in a_bzrdir."""
1839
transport = a_bzrdir.get_workingtree_transport(None)
1840
format_string = transport.get("format").read()
1841
return klass._formats[format_string]
1843
raise errors.NoWorkingTree(base=transport.base)
1845
raise errors.UnknownFormatError(format=format_string)
1848
def get_default_format(klass):
1849
"""Return the current default format."""
1850
return klass._default_format
1852
def get_format_string(self):
1853
"""Return the ASCII format string that identifies this format."""
1854
raise NotImplementedError(self.get_format_string)
1856
def get_format_description(self):
1857
"""Return the short description for this format."""
1858
raise NotImplementedError(self.get_format_description)
1860
def is_supported(self):
1861
"""Is this format supported?
1863
Supported formats can be initialized and opened.
1864
Unsupported formats may not support initialization or committing or
1865
some other features depending on the reason for not being supported.
1870
def register_format(klass, format):
1871
klass._formats[format.get_format_string()] = format
1874
def set_default_format(klass, format):
1875
klass._default_format = format
1878
def unregister_format(klass, format):
1879
assert klass._formats[format.get_format_string()] is format
1880
del klass._formats[format.get_format_string()]
1884
class WorkingTreeFormat2(WorkingTreeFormat):
1885
"""The second working tree format.
1887
This format modified the hash cache from the format 1 hash cache.
1890
def get_format_description(self):
1891
"""See WorkingTreeFormat.get_format_description()."""
1892
return "Working tree format 2"
1894
def stub_initialize_remote(self, control_files):
1895
"""As a special workaround create critical control files for a remote working tree
1897
This ensures that it can later be updated and dealt with locally,
1898
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1899
no working tree. (See bug #43064).
1903
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1905
control_files.put('inventory', sio)
1907
control_files.put_utf8('pending-merges', '')
1910
def initialize(self, a_bzrdir, revision_id=None):
1911
"""See WorkingTreeFormat.initialize()."""
1912
if not isinstance(a_bzrdir.transport, LocalTransport):
1913
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1914
branch = a_bzrdir.open_branch()
1915
if revision_id is not None:
1918
revision_history = branch.revision_history()
1920
position = revision_history.index(revision_id)
1922
raise errors.NoSuchRevision(branch, revision_id)
1923
branch.set_revision_history(revision_history[:position + 1])
1926
revision = branch.last_revision()
1928
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1934
wt._write_inventory(inv)
1935
wt.set_root_id(inv.root.file_id)
1936
basis_tree = branch.repository.revision_tree(revision)
1937
wt.set_parent_trees([(revision, basis_tree)])
1938
build_tree(basis_tree, wt)
1942
super(WorkingTreeFormat2, self).__init__()
1943
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1945
def open(self, a_bzrdir, _found=False):
1946
"""Return the WorkingTree object for a_bzrdir
1948
_found is a private parameter, do not use it. It is used to indicate
1949
if format probing has already been done.
1952
# we are being called directly and must probe.
1953
raise NotImplementedError
1954
if not isinstance(a_bzrdir.transport, LocalTransport):
1955
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1956
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1962
class WorkingTreeFormat3(WorkingTreeFormat):
1963
"""The second working tree format updated to record a format marker.
1966
- exists within a metadir controlling .bzr
1967
- includes an explicit version marker for the workingtree control
1968
files, separate from the BzrDir format
1969
- modifies the hash cache format
1971
- uses a LockDir to guard access for writes.
1974
def get_format_string(self):
1975
"""See WorkingTreeFormat.get_format_string()."""
1976
return "Bazaar-NG Working Tree format 3"
1978
def get_format_description(self):
1979
"""See WorkingTreeFormat.get_format_description()."""
1980
return "Working tree format 3"
1982
_lock_file_name = 'lock'
1983
_lock_class = LockDir
1985
def _open_control_files(self, a_bzrdir):
1986
transport = a_bzrdir.get_workingtree_transport(None)
1987
return LockableFiles(transport, self._lock_file_name,
1990
def initialize(self, a_bzrdir, revision_id=None):
1991
"""See WorkingTreeFormat.initialize().
1993
revision_id allows creating a working tree at a different
1994
revision than the branch is at.
1996
if not isinstance(a_bzrdir.transport, LocalTransport):
1997
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1998
transport = a_bzrdir.get_workingtree_transport(self)
1999
control_files = self._open_control_files(a_bzrdir)
2000
control_files.create_lock()
2001
control_files.lock_write()
2002
control_files.put_utf8('format', self.get_format_string())
2003
branch = a_bzrdir.open_branch()
2004
if revision_id is None:
2005
revision_id = branch.last_revision()
2007
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2013
_control_files=control_files)
2016
wt._write_inventory(inv)
2017
wt.set_root_id(inv.root.file_id)
2018
basis_tree = branch.repository.revision_tree(revision_id)
2019
if revision_id == bzrlib.revision.NULL_REVISION:
2020
wt.set_parent_trees([])
2022
wt.set_parent_trees([(revision_id, basis_tree)])
2023
build_tree(basis_tree, wt)
2026
control_files.unlock()
2030
super(WorkingTreeFormat3, self).__init__()
2031
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2033
def open(self, a_bzrdir, _found=False):
2034
"""Return the WorkingTree object for a_bzrdir
2036
_found is a private parameter, do not use it. It is used to indicate
2037
if format probing has already been done.
2040
# we are being called directly and must probe.
2041
raise NotImplementedError
2042
if not isinstance(a_bzrdir.transport, LocalTransport):
2043
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2044
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2046
def _open(self, a_bzrdir, control_files):
2047
"""Open the tree itself.
2049
:param a_bzrdir: the dir for the tree.
2050
:param control_files: the control files for the tree.
2052
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2056
_control_files=control_files)
2059
return self.get_format_string()
2062
# formats which have no format string are not discoverable
2063
# and not independently creatable, so are not registered.
2064
__default_format = WorkingTreeFormat3()
2065
WorkingTreeFormat.register_format(__default_format)
2066
WorkingTreeFormat.set_default_format(__default_format)
2067
_legacy_formats = [WorkingTreeFormat2(),
2071
class WorkingTreeTestProviderAdapter(object):
2072
"""A tool to generate a suite testing multiple workingtree formats at once.
2074
This is done by copying the test once for each transport and injecting
2075
the transport_server, transport_readonly_server, and workingtree_format
2076
classes into each copy. Each copy is also given a new id() to make it
2080
def __init__(self, transport_server, transport_readonly_server, formats):
2081
self._transport_server = transport_server
2082
self._transport_readonly_server = transport_readonly_server
2083
self._formats = formats
2085
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2086
"""Clone test for adaption."""
2087
new_test = deepcopy(test)
2088
new_test.transport_server = self._transport_server
2089
new_test.transport_readonly_server = self._transport_readonly_server
2090
new_test.bzrdir_format = bzrdir_format
2091
new_test.workingtree_format = workingtree_format
2092
def make_new_test_id():
2093
new_id = "%s(%s)" % (test.id(), variation)
2094
return lambda: new_id
2095
new_test.id = make_new_test_id()
2098
def adapt(self, test):
2099
from bzrlib.tests import TestSuite
2100
result = TestSuite()
2101
for workingtree_format, bzrdir_format in self._formats:
2102
new_test = self._clone_test(
2105
workingtree_format, workingtree_format.__class__.__name__)
2106
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
