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
tree.set_root_id(self.get_root_id())
547
if revision_id is None:
548
transform_tree(tree, self)
550
# TODO now merge from tree.last_revision to revision (to preserve
551
# user local changes)
552
transform_tree(tree, self)
553
tree.set_parent_ids([revision_id])
556
def commit(self, message=None, revprops=None, *args, **kwargs):
557
# avoid circular imports
558
from bzrlib.commit import Commit
561
if not 'branch-nick' in revprops:
562
revprops['branch-nick'] = self.branch.nick
563
# args for wt.commit start at message from the Commit.commit method,
564
# but with branch a kwarg now, passing in args as is results in the
565
#message being used for the branch
566
args = (DEPRECATED_PARAMETER, message, ) + args
567
committed_id = Commit().commit( working_tree=self, revprops=revprops,
571
def id2abspath(self, file_id):
572
return self.abspath(self.id2path(file_id))
574
def has_id(self, file_id):
575
# files that have been deleted are excluded
576
inv = self._inventory
577
if not inv.has_id(file_id):
579
path = inv.id2path(file_id)
580
return osutils.lexists(self.abspath(path))
582
def has_or_had_id(self, file_id):
583
if file_id == self.inventory.root.file_id:
585
return self.inventory.has_id(file_id)
587
__contains__ = has_id
589
def get_file_size(self, file_id):
590
return os.path.getsize(self.id2abspath(file_id))
593
def get_file_sha1(self, file_id, path=None):
595
path = self._inventory.id2path(file_id)
596
return self._hashcache.get_sha1(path)
598
def get_file_mtime(self, file_id, path=None):
600
path = self._inventory.id2path(file_id)
601
return os.lstat(self.abspath(path)).st_mtime
603
if not supports_executable():
604
def is_executable(self, file_id, path=None):
605
return self._inventory[file_id].executable
607
def is_executable(self, file_id, path=None):
609
path = self._inventory.id2path(file_id)
610
mode = os.lstat(self.abspath(path)).st_mode
611
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
614
def add(self, files, ids=None):
615
"""Make files versioned.
617
Note that the command line normally calls smart_add instead,
618
which can automatically recurse.
620
This adds the files to the inventory, so that they will be
621
recorded by the next commit.
624
List of paths to add, relative to the base of the tree.
627
If set, use these instead of automatically generated ids.
628
Must be the same length as the list of files, but may
629
contain None for ids that are to be autogenerated.
631
TODO: Perhaps have an option to add the ids even if the files do
634
TODO: Perhaps callback with the ids and paths as they're added.
636
# TODO: Re-adding a file that is removed in the working copy
637
# should probably put it back with the previous ID.
638
if isinstance(files, basestring):
639
assert(ids is None or isinstance(ids, basestring))
645
ids = [None] * len(files)
647
assert(len(ids) == len(files))
649
inv = self.read_working_inventory()
650
for f,file_id in zip(files, ids):
651
if self.is_control_filename(f):
652
raise errors.ForbiddenControlFileError(filename=f)
657
raise BzrError("cannot add top-level %r" % f)
659
fullpath = normpath(self.abspath(f))
661
kind = file_kind(fullpath)
663
if e.errno == errno.ENOENT:
664
raise NoSuchFile(fullpath)
665
if not InventoryEntry.versionable_kind(kind):
666
raise errors.BadFileKindError(filename=f, kind=kind)
668
inv.add_path(f, kind=kind)
670
inv.add_path(f, kind=kind, file_id=file_id)
672
self._write_inventory(inv)
675
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
676
"""Add revision_id as a parent.
678
This is equivalent to retrieving the current list of parent ids
679
and setting the list to its value plus revision_id.
681
:param revision_id: The revision id to add to the parent list. It may
682
be a ghost revision as long as its not the first parent to be added,
683
or the allow_leftmost_as_ghost parameter is set True.
684
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
686
parents = self.get_parent_ids() + [revision_id]
687
self.set_parent_ids(parents,
688
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
691
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
692
"""Add revision_id, tree tuple as a parent.
694
This is equivalent to retrieving the current list of parent trees
695
and setting the list to its value plus parent_tuple. See also
696
add_parent_tree_id - if you only have a parent id available it will be
697
simpler to use that api. If you have the parent already available, using
698
this api is preferred.
700
:param parent_tuple: The (revision id, tree) to add to the parent list.
701
If the revision_id is a ghost, pass None for the tree.
702
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
704
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
705
if len(parent_ids) > 1:
706
# the leftmost may have already been a ghost, preserve that if it
708
allow_leftmost_as_ghost = True
709
self.set_parent_ids(parent_ids,
710
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
713
def add_pending_merge(self, *revision_ids):
714
# TODO: Perhaps should check at this point that the
715
# history of the revision is actually present?
716
parents = self.get_parent_ids()
718
for rev_id in revision_ids:
719
if rev_id in parents:
721
parents.append(rev_id)
724
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
726
@deprecated_method(zero_eleven)
728
def pending_merges(self):
729
"""Return a list of pending merges.
731
These are revisions that have been merged into the working
732
directory but not yet committed.
734
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
735
instead - which is available on all tree objects.
737
return self.get_parent_ids()[1:]
740
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
741
"""Set the parent ids to revision_ids.
743
See also set_parent_trees. This api will try to retrieve the tree data
744
for each element of revision_ids from the trees repository. If you have
745
tree data already available, it is more efficient to use
746
set_parent_trees rather than set_parent_ids. set_parent_ids is however
747
an easier API to use.
749
:param revision_ids: The revision_ids to set as the parent ids of this
750
working tree. Any of these may be ghosts.
752
if len(revision_ids) > 0:
753
leftmost_id = revision_ids[0]
754
if (not allow_leftmost_as_ghost and not
755
self.branch.repository.has_revision(leftmost_id)):
756
raise errors.GhostRevisionUnusableHere(leftmost_id)
757
self.set_last_revision(leftmost_id)
759
self.set_last_revision(None)
760
merges = revision_ids[1:]
761
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
764
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
765
"""Set the parents of the working tree.
767
:param parents_list: A list of (revision_id, tree) tuples.
768
If tree is None, then that element is treated as an unreachable
769
parent tree - i.e. a ghost.
771
# parent trees are not used in current format trees, delegate to
773
self.set_parent_ids([rev for (rev, tree) in parents_list],
774
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
777
def set_pending_merges(self, rev_list):
778
parents = self.get_parent_ids()
779
leftmost = parents[:1]
780
new_parents = leftmost + rev_list
781
self.set_parent_ids(new_parents)
784
def set_merge_modified(self, modified_hashes):
786
for file_id, hash in modified_hashes.iteritems():
787
yield Stanza(file_id=file_id, hash=hash)
788
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
791
def _put_rio(self, filename, stanzas, header):
792
my_file = rio_file(stanzas, header)
793
self._control_files.put(filename, my_file)
796
def merge_from_branch(self, branch, to_revision=None):
797
"""Merge from a branch into this working tree.
799
:param branch: The branch to merge from.
800
:param to_revision: If non-None, the merge will merge to to_revision, but
801
not beyond it. to_revision does not need to be in the history of
802
the branch when it is supplied. If None, to_revision defaults to
803
branch.last_revision().
805
from bzrlib.merge import Merger, Merge3Merger
806
pb = bzrlib.ui.ui_factory.nested_progress_bar()
808
merger = Merger(self.branch, this_tree=self, pb=pb)
809
merger.pp = ProgressPhase("Merge phase", 5, pb)
810
merger.pp.next_phase()
811
# check that there are no
813
merger.check_basis(check_clean=True, require_commits=False)
814
if to_revision is None:
815
to_revision = branch.last_revision()
816
merger.other_rev_id = to_revision
817
if merger.other_rev_id is None:
818
raise error.NoCommits(branch)
819
self.branch.fetch(branch, last_revision=merger.other_rev_id)
820
merger.other_basis = merger.other_rev_id
821
merger.other_tree = self.branch.repository.revision_tree(
823
merger.pp.next_phase()
825
if merger.base_rev_id == merger.other_rev_id:
826
raise errors.PointlessMerge
827
merger.backup_files = False
828
merger.merge_type = Merge3Merger
829
merger.set_interesting_files(None)
830
merger.show_base = False
831
merger.reprocess = False
832
conflicts = merger.do_merge()
839
def merge_modified(self):
841
hashfile = self._control_files.get('merge-hashes')
846
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
847
raise MergeModifiedFormatError()
848
except StopIteration:
849
raise MergeModifiedFormatError()
850
for s in RioReader(hashfile):
851
file_id = s.get("file_id")
852
if file_id not in self.inventory:
855
if hash == self.get_file_sha1(file_id):
856
merge_hashes[file_id] = hash
859
def get_symlink_target(self, file_id):
860
return os.readlink(self.id2abspath(file_id))
862
def file_class(self, filename):
863
if self.path2id(filename):
865
elif self.is_ignored(filename):
870
def list_files(self, include_root=False):
871
"""Recursively list all files as (path, class, kind, id, entry).
873
Lists, but does not descend into unversioned directories.
875
This does not include files that have been deleted in this
878
Skips the control directory.
880
inv = self._inventory
881
# Convert these into local objects to save lookup times
882
pathjoin = osutils.pathjoin
883
file_kind = osutils.file_kind
885
# transport.base ends in a slash, we want the piece
886
# between the last two slashes
887
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
889
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
891
# directory file_id, relative path, absolute path, reverse sorted children
892
children = os.listdir(self.basedir)
894
# jam 20060527 The kernel sized tree seems equivalent whether we
895
# use a deque and popleft to keep them sorted, or if we use a plain
896
# list and just reverse() them.
897
children = collections.deque(children)
898
stack = [(inv.root.file_id, u'', self.basedir, children)]
900
yield u'', 'V', 'directory', inv.root.file_id, inv.root
902
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
905
f = children.popleft()
906
## TODO: If we find a subdirectory with its own .bzr
907
## directory, then that is a separate tree and we
908
## should exclude it.
910
# the bzrdir for this tree
911
if transport_base_dir == f:
914
# we know that from_dir_relpath and from_dir_abspath never end in a slash
915
# and 'f' doesn't begin with one, we can do a string op, rather
916
# than the checks of pathjoin(), all relative paths will have an extra slash
918
fp = from_dir_relpath + '/' + f
921
fap = from_dir_abspath + '/' + f
923
f_ie = inv.get_child(from_dir_id, f)
926
elif self.is_ignored(fp[1:]):
929
# we may not have found this file, because of a unicode issue
930
f_norm, can_access = osutils.normalized_filename(f)
931
if f == f_norm or not can_access:
932
# No change, so treat this file normally
935
# this file can be accessed by a normalized path
936
# check again if it is versioned
937
# these lines are repeated here for performance
939
fp = from_dir_relpath + '/' + f
940
fap = from_dir_abspath + '/' + f
941
f_ie = inv.get_child(from_dir_id, f)
944
elif self.is_ignored(fp[1:]):
953
raise BzrCheckError("file %r entered as kind %r id %r, "
955
% (fap, f_ie.kind, f_ie.file_id, fk))
957
# make a last minute entry
959
yield fp[1:], c, fk, f_ie.file_id, f_ie
962
yield fp[1:], c, fk, None, fk_entries[fk]()
964
yield fp[1:], c, fk, None, TreeEntry()
967
if fk != 'directory':
970
# But do this child first
971
new_children = os.listdir(fap)
973
new_children = collections.deque(new_children)
974
stack.append((f_ie.file_id, fp, fap, new_children))
975
# Break out of inner loop, so that we start outer loop with child
978
# if we finished all children, pop it off the stack
983
def move(self, from_paths, to_name):
986
to_name must exist in the inventory.
988
If to_name exists and is a directory, the files are moved into
989
it, keeping their old names.
991
Note that to_name is only the last component of the new name;
992
this doesn't change the directory.
994
This returns a list of (from_path, to_path) pairs for each
998
## TODO: Option to move IDs only
999
assert not isinstance(from_paths, basestring)
1000
inv = self.inventory
1001
to_abs = self.abspath(to_name)
1002
if not isdir(to_abs):
1003
raise BzrError("destination %r is not a directory" % to_abs)
1004
if not self.has_filename(to_name):
1005
raise BzrError("destination %r not in working directory" % to_abs)
1006
to_dir_id = inv.path2id(to_name)
1007
if to_dir_id is None and to_name != '':
1008
raise BzrError("destination %r is not a versioned directory" % to_name)
1009
to_dir_ie = inv[to_dir_id]
1010
if to_dir_ie.kind != 'directory':
1011
raise BzrError("destination %r is not a directory" % to_abs)
1013
to_idpath = inv.get_idpath(to_dir_id)
1015
for f in from_paths:
1016
if not self.has_filename(f):
1017
raise BzrError("%r does not exist in working tree" % f)
1018
f_id = inv.path2id(f)
1020
raise BzrError("%r is not versioned" % f)
1021
name_tail = splitpath(f)[-1]
1022
dest_path = pathjoin(to_name, name_tail)
1023
if self.has_filename(dest_path):
1024
raise BzrError("destination %r already exists" % dest_path)
1025
if f_id in to_idpath:
1026
raise BzrError("can't move %r to a subdirectory of itself" % f)
1028
# OK, so there's a race here, it's possible that someone will
1029
# create a file in this interval and then the rename might be
1030
# left half-done. But we should have caught most problems.
1031
orig_inv = deepcopy(self.inventory)
1033
for f in from_paths:
1034
name_tail = splitpath(f)[-1]
1035
dest_path = pathjoin(to_name, name_tail)
1036
result.append((f, dest_path))
1037
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1039
rename(self.abspath(f), self.abspath(dest_path))
1041
raise BzrError("failed to rename %r to %r: %s" %
1042
(f, dest_path, e[1]),
1043
["rename rolled back"])
1045
# restore the inventory on error
1046
self._set_inventory(orig_inv)
1048
self._write_inventory(inv)
1052
def rename_one(self, from_rel, to_rel):
1055
This can change the directory or the filename or both.
1057
inv = self.inventory
1058
if not self.has_filename(from_rel):
1059
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1060
if self.has_filename(to_rel):
1061
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1063
file_id = inv.path2id(from_rel)
1065
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1067
entry = inv[file_id]
1068
from_parent = entry.parent_id
1069
from_name = entry.name
1071
if inv.path2id(to_rel):
1072
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1074
to_dir, to_tail = os.path.split(to_rel)
1075
to_dir_id = inv.path2id(to_dir)
1076
if to_dir_id is None and to_dir != '':
1077
raise BzrError("can't determine destination directory id for %r" % to_dir)
1079
mutter("rename_one:")
1080
mutter(" file_id {%s}" % file_id)
1081
mutter(" from_rel %r" % from_rel)
1082
mutter(" to_rel %r" % to_rel)
1083
mutter(" to_dir %r" % to_dir)
1084
mutter(" to_dir_id {%s}" % to_dir_id)
1086
inv.rename(file_id, to_dir_id, to_tail)
1088
from_abs = self.abspath(from_rel)
1089
to_abs = self.abspath(to_rel)
1091
rename(from_abs, to_abs)
1093
inv.rename(file_id, from_parent, from_name)
1094
raise BzrError("failed to rename %r to %r: %s"
1095
% (from_abs, to_abs, e[1]),
1096
["rename rolled back"])
1097
self._write_inventory(inv)
1101
"""Return all unknown files.
1103
These are files in the working directory that are not versioned or
1104
control files or ignored.
1106
for subp in self.extras():
1107
if not self.is_ignored(subp):
1111
def unversion(self, file_ids):
1112
"""Remove the file ids in file_ids from the current versioned set.
1114
When a file_id is unversioned, all of its children are automatically
1117
:param file_ids: The file ids to stop versioning.
1118
:raises: NoSuchId if any fileid is not currently versioned.
1120
for file_id in file_ids:
1121
if self._inventory.has_id(file_id):
1122
self._inventory.remove_recursive_id(file_id)
1124
raise errors.NoSuchId(self, file_id)
1126
# in the future this should just set a dirty bit to wait for the
1127
# final unlock. However, until all methods of workingtree start
1128
# with the current in -memory inventory rather than triggering
1129
# a read, it is more complex - we need to teach read_inventory
1130
# to know when to read, and when to not read first... and possibly
1131
# to save first when the in memory one may be corrupted.
1132
# so for now, we just only write it if it is indeed dirty.
1134
self._write_inventory(self._inventory)
1136
@deprecated_method(zero_eight)
1137
def iter_conflicts(self):
1138
"""List all files in the tree that have text or content conflicts.
1139
DEPRECATED. Use conflicts instead."""
1140
return self._iter_conflicts()
1142
def _iter_conflicts(self):
1144
for info in self.list_files():
1146
stem = get_conflicted_stem(path)
1149
if stem not in conflicted:
1150
conflicted.add(stem)
1154
def pull(self, source, overwrite=False, stop_revision=None):
1155
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1158
pp = ProgressPhase("Pull phase", 2, top_pb)
1160
old_revision_history = self.branch.revision_history()
1161
basis_tree = self.basis_tree()
1162
count = self.branch.pull(source, overwrite, stop_revision)
1163
new_revision_history = self.branch.revision_history()
1164
if new_revision_history != old_revision_history:
1166
if len(old_revision_history):
1167
other_revision = old_revision_history[-1]
1169
other_revision = None
1170
repository = self.branch.repository
1171
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1173
new_basis_tree = self.branch.basis_tree()
1174
merge_inner(self.branch,
1179
if (basis_tree.inventory.root is None and
1180
new_basis_tree.inventory.root is not None):
1181
self.set_root_id(new_basis_tree.inventory.root.file_id)
1184
# TODO - dedup parents list with things merged by pull ?
1185
# reuse the revisiontree we merged against to set the new
1187
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1188
# we have to pull the merge trees out again, because
1189
# merge_inner has set the ids. - this corner is not yet
1190
# layered well enough to prevent double handling.
1191
merges = self.get_parent_ids()[1:]
1192
parent_trees.extend([
1193
(parent, repository.revision_tree(parent)) for
1195
self.set_parent_trees(parent_trees)
1202
"""Yield all unknown files in this WorkingTree.
1204
If there are any unknown directories then only the directory is
1205
returned, not all its children. But if there are unknown files
1206
under a versioned subdirectory, they are returned.
1208
Currently returned depth-first, sorted by name within directories.
1210
## TODO: Work from given directory downwards
1211
for path, dir_entry in self.inventory.directories():
1212
# mutter("search for unknowns in %r", path)
1213
dirabs = self.abspath(path)
1214
if not isdir(dirabs):
1215
# e.g. directory deleted
1219
for subf in os.listdir(dirabs):
1222
if subf not in dir_entry.children:
1223
subf_norm, can_access = osutils.normalized_filename(subf)
1224
if subf_norm != subf and can_access:
1225
if subf_norm not in dir_entry.children:
1226
fl.append(subf_norm)
1232
subp = pathjoin(path, subf)
1235
def _translate_ignore_rule(self, rule):
1236
"""Translate a single ignore rule to a regex.
1238
There are two types of ignore rules. Those that do not contain a / are
1239
matched against the tail of the filename (that is, they do not care
1240
what directory the file is in.) Rules which do contain a slash must
1241
match the entire path. As a special case, './' at the start of the
1242
string counts as a slash in the string but is removed before matching
1243
(e.g. ./foo.c, ./src/foo.c)
1245
:return: The translated regex.
1247
if rule[:2] in ('./', '.\\'):
1249
result = fnmatch.translate(rule[2:])
1250
elif '/' in rule or '\\' in rule:
1252
result = fnmatch.translate(rule)
1254
# default rule style.
1255
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1256
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1257
return "(" + result + ")"
1259
def _combine_ignore_rules(self, rules):
1260
"""Combine a list of ignore rules into a single regex object.
1262
Each individual rule is combined with | to form a big regex, which then
1263
has $ added to it to form something like ()|()|()$. The group index for
1264
each subregex's outermost group is placed in a dictionary mapping back
1265
to the rule. This allows quick identification of the matching rule that
1267
:return: a list of the compiled regex and the matching-group index
1268
dictionaries. We return a list because python complains if you try to
1269
combine more than 100 regexes.
1274
translated_rules = []
1276
translated_rule = self._translate_ignore_rule(rule)
1277
compiled_rule = re.compile(translated_rule)
1278
groups[next_group] = rule
1279
next_group += compiled_rule.groups
1280
translated_rules.append(translated_rule)
1281
if next_group == 99:
1282
result.append((re.compile("|".join(translated_rules)), groups))
1285
translated_rules = []
1286
if len(translated_rules):
1287
result.append((re.compile("|".join(translated_rules)), groups))
1290
def ignored_files(self):
1291
"""Yield list of PATH, IGNORE_PATTERN"""
1292
for subp in self.extras():
1293
pat = self.is_ignored(subp)
1297
def get_ignore_list(self):
1298
"""Return list of ignore patterns.
1300
Cached in the Tree object after the first call.
1302
ignoreset = getattr(self, '_ignoreset', None)
1303
if ignoreset is not None:
1306
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1307
ignore_globs.update(ignores.get_runtime_ignores())
1309
ignore_globs.update(ignores.get_user_ignores())
1311
if self.has_filename(bzrlib.IGNORE_FILENAME):
1312
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1314
ignore_globs.update(ignores.parse_ignore_file(f))
1318
self._ignoreset = ignore_globs
1319
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1322
def _get_ignore_rules_as_regex(self):
1323
"""Return a regex of the ignore rules and a mapping dict.
1325
:return: (ignore rules compiled regex, dictionary mapping rule group
1326
indices to original rule.)
1328
if getattr(self, '_ignoreset', None) is None:
1329
self.get_ignore_list()
1330
return self._ignore_regex
1332
def is_ignored(self, filename):
1333
r"""Check whether the filename matches an ignore pattern.
1335
Patterns containing '/' or '\' need to match the whole path;
1336
others match against only the last component.
1338
If the file is ignored, returns the pattern which caused it to
1339
be ignored, otherwise None. So this can simply be used as a
1340
boolean if desired."""
1342
# TODO: Use '**' to match directories, and other extended
1343
# globbing stuff from cvs/rsync.
1345
# XXX: fnmatch is actually not quite what we want: it's only
1346
# approximately the same as real Unix fnmatch, and doesn't
1347
# treat dotfiles correctly and allows * to match /.
1348
# Eventually it should be replaced with something more
1351
rules = self._get_ignore_rules_as_regex()
1352
for regex, mapping in rules:
1353
match = regex.match(filename)
1354
if match is not None:
1355
# one or more of the groups in mapping will have a non-None
1357
groups = match.groups()
1358
rules = [mapping[group] for group in
1359
mapping if groups[group] is not None]
1363
def kind(self, file_id):
1364
return file_kind(self.id2abspath(file_id))
1366
def last_revision(self):
1367
"""Return the last revision id of this working tree.
1369
In early branch formats this was the same as the branch last_revision,
1370
but that cannot be relied upon - for working tree operations,
1371
always use tree.last_revision(). This returns the left most parent id,
1372
or None if there are no parents.
1374
This was deprecated as of 0.11. Please use get_parent_ids instead.
1376
return self._last_revision()
1379
def _last_revision(self):
1380
"""helper for get_parent_ids."""
1381
return self.branch.last_revision()
1383
def is_locked(self):
1384
return self._control_files.is_locked()
1386
def lock_read(self):
1387
"""See Branch.lock_read, and WorkingTree.unlock."""
1388
self.branch.lock_read()
1390
return self._control_files.lock_read()
1392
self.branch.unlock()
1395
def lock_write(self):
1396
"""See Branch.lock_write, and WorkingTree.unlock."""
1397
self.branch.lock_write()
1399
return self._control_files.lock_write()
1401
self.branch.unlock()
1404
def get_physical_lock_status(self):
1405
return self._control_files.get_physical_lock_status()
1407
def _basis_inventory_name(self):
1408
return 'basis-inventory-cache'
1411
def set_last_revision(self, new_revision):
1412
"""Change the last revision in the working tree."""
1413
if self._change_last_revision(new_revision):
1414
self._cache_basis_inventory(new_revision)
1416
def _change_last_revision(self, new_revision):
1417
"""Template method part of set_last_revision to perform the change.
1419
This is used to allow WorkingTree3 instances to not affect branch
1420
when their last revision is set.
1422
if new_revision is None:
1423
self.branch.set_revision_history([])
1426
self.branch.generate_revision_history(new_revision)
1427
except errors.NoSuchRevision:
1428
# not present in the repo - dont try to set it deeper than the tip
1429
self.branch.set_revision_history([new_revision])
1432
def _cache_basis_inventory(self, new_revision):
1433
"""Cache new_revision as the basis inventory."""
1434
# TODO: this should allow the ready-to-use inventory to be passed in,
1435
# as commit already has that ready-to-use [while the format is the
1438
# this double handles the inventory - unpack and repack -
1439
# but is easier to understand. We can/should put a conditional
1440
# in here based on whether the inventory is in the latest format
1441
# - perhaps we should repack all inventories on a repository
1443
# the fast path is to copy the raw xml from the repository. If the
1444
# xml contains 'revision_id="', then we assume the right
1445
# revision_id is set. We must check for this full string, because a
1446
# root node id can legitimately look like 'revision_id' but cannot
1448
xml = self.branch.repository.get_inventory_xml(new_revision)
1449
firstline = xml.split('\n', 1)[0]
1450
if (not 'revision_id="' in firstline or
1451
'format="6"' not in firstline):
1452
inv = self.branch.repository.deserialise_inventory(
1454
inv.revision_id = new_revision
1455
xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
1456
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1457
path = self._basis_inventory_name()
1459
self._control_files.put(path, sio)
1460
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1463
def read_basis_inventory(self):
1464
"""Read the cached basis inventory."""
1465
path = self._basis_inventory_name()
1466
return self._control_files.get(path).read()
1469
def read_working_inventory(self):
1470
"""Read the working inventory."""
1471
# ElementTree does its own conversion from UTF-8, so open in
1473
result = bzrlib.xml5.serializer_v5.read_inventory(
1474
self._control_files.get('inventory'))
1475
self._set_inventory(result)
1479
def remove(self, files, verbose=False, to_file=None):
1480
"""Remove nominated files from the working inventory..
1482
This does not remove their text. This does not run on XXX on what? RBC
1484
TODO: Refuse to remove modified files unless --force is given?
1486
TODO: Do something useful with directories.
1488
TODO: Should this remove the text or not? Tough call; not
1489
removing may be useful and the user can just use use rm, and
1490
is the opposite of add. Removing it is consistent with most
1491
other tools. Maybe an option.
1493
## TODO: Normalize names
1494
## TODO: Remove nested loops; better scalability
1495
if isinstance(files, basestring):
1498
inv = self.inventory
1500
# do this before any modifications
1502
fid = inv.path2id(f)
1504
# TODO: Perhaps make this just a warning, and continue?
1505
# This tends to happen when
1506
raise NotVersionedError(path=f)
1508
# having remove it, it must be either ignored or unknown
1509
if self.is_ignored(f):
1513
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1516
self._write_inventory(inv)
1519
def revert(self, filenames, old_tree=None, backups=True,
1520
pb=DummyProgress()):
1521
from transform import revert
1522
from conflicts import resolve
1523
if old_tree is None:
1524
old_tree = self.basis_tree()
1525
conflicts = revert(self, old_tree, filenames, backups, pb)
1526
if not len(filenames):
1527
self.set_parent_ids(self.get_parent_ids()[:1])
1530
resolve(self, filenames, ignore_misses=True)
1533
# XXX: This method should be deprecated in favour of taking in a proper
1534
# new Inventory object.
1536
def set_inventory(self, new_inventory_list):
1537
from bzrlib.inventory import (Inventory,
1542
inv = Inventory(self.get_root_id())
1543
for path, file_id, parent, kind in new_inventory_list:
1544
name = os.path.basename(path)
1547
# fixme, there should be a factory function inv,add_??
1548
if kind == 'directory':
1549
inv.add(InventoryDirectory(file_id, name, parent))
1550
elif kind == 'file':
1551
inv.add(InventoryFile(file_id, name, parent))
1552
elif kind == 'symlink':
1553
inv.add(InventoryLink(file_id, name, parent))
1555
raise BzrError("unknown kind %r" % kind)
1556
self._write_inventory(inv)
1559
def set_root_id(self, file_id):
1560
"""Set the root id for this tree."""
1561
inv = self.read_working_inventory()
1562
orig_root_id = inv.root.file_id
1563
del inv._byid[inv.root.file_id]
1564
inv.root.file_id = file_id
1565
inv._byid[inv.root.file_id] = inv.root
1568
if entry.parent_id == orig_root_id:
1569
entry.parent_id = inv.root.file_id
1570
self._write_inventory(inv)
1573
"""See Branch.unlock.
1575
WorkingTree locking just uses the Branch locking facilities.
1576
This is current because all working trees have an embedded branch
1577
within them. IF in the future, we were to make branch data shareable
1578
between multiple working trees, i.e. via shared storage, then we
1579
would probably want to lock both the local tree, and the branch.
1581
raise NotImplementedError(self.unlock)
1585
"""Update a working tree along its branch.
1587
This will update the branch if its bound too, which means we have
1588
multiple trees involved:
1590
- The new basis tree of the master.
1591
- The old basis tree of the branch.
1592
- The old basis tree of the working tree.
1593
- The current working tree state.
1595
Pathologically, all three may be different, and non-ancestors of each
1596
other. Conceptually we want to:
1598
- Preserve the wt.basis->wt.state changes
1599
- Transform the wt.basis to the new master basis.
1600
- Apply a merge of the old branch basis to get any 'local' changes from
1602
- Restore the wt.basis->wt.state changes.
1604
There isn't a single operation at the moment to do that, so we:
1605
- Merge current state -> basis tree of the master w.r.t. the old tree
1607
- Do a 'normal' merge of the old branch basis if it is relevant.
1609
old_tip = self.branch.update()
1611
# here if old_tip is not None, it is the old tip of the branch before
1612
# it was updated from the master branch. This should become a pending
1613
# merge in the working tree to preserve the user existing work. we
1614
# cant set that until we update the working trees last revision to be
1615
# one from the new branch, because it will just get absorbed by the
1616
# parent de-duplication logic.
1618
# We MUST save it even if an error occurs, because otherwise the users
1619
# local work is unreferenced and will appear to have been lost.
1623
last_rev = self.get_parent_ids()[0]
1626
if last_rev != self.branch.last_revision():
1627
# merge tree state up to new branch tip.
1628
basis = self.basis_tree()
1629
to_tree = self.branch.basis_tree()
1630
if basis.inventory.root is None:
1631
self.set_root_id(to_tree.inventory.root.file_id)
1632
result += merge_inner(self.branch,
1636
# TODO - dedup parents list with things merged by pull ?
1637
# reuse the tree we've updated to to set the basis:
1638
parent_trees = [(self.branch.last_revision(), to_tree)]
1639
merges = self.get_parent_ids()[1:]
1640
# Ideally we ask the tree for the trees here, that way the working
1641
# tree can decide whether to give us teh entire tree or give us a
1642
# lazy initialised tree. dirstate for instance will have the trees
1643
# in ram already, whereas a last-revision + basis-inventory tree
1644
# will not, but also does not need them when setting parents.
1645
for parent in merges:
1646
parent_trees.append(
1647
(parent, self.branch.repository.revision_tree(parent)))
1648
if old_tip is not None:
1649
parent_trees.append(
1650
(old_tip, self.branch.repository.revision_tree(old_tip)))
1651
self.set_parent_trees(parent_trees)
1652
last_rev = parent_trees[0][0]
1654
# the working tree had the same last-revision as the master
1655
# branch did. We may still have pivot local work from the local
1656
# branch into old_tip:
1657
if old_tip is not None:
1658
self.add_parent_tree_id(old_tip)
1659
if old_tip and old_tip != last_rev:
1660
# our last revision was not the prior branch last revision
1661
# and we have converted that last revision to a pending merge.
1662
# base is somewhere between the branch tip now
1663
# and the now pending merge
1664
from bzrlib.revision import common_ancestor
1666
base_rev_id = common_ancestor(self.branch.last_revision(),
1668
self.branch.repository)
1669
except errors.NoCommonAncestor:
1671
base_tree = self.branch.repository.revision_tree(base_rev_id)
1672
other_tree = self.branch.repository.revision_tree(old_tip)
1673
result += merge_inner(self.branch,
1680
def _write_inventory(self, inv):
1681
"""Write inventory as the current inventory."""
1683
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1685
self._control_files.put('inventory', sio)
1686
self._set_inventory(inv)
1687
mutter('wrote working inventory')
1689
def set_conflicts(self, arg):
1690
raise UnsupportedOperation(self.set_conflicts, self)
1692
def add_conflicts(self, arg):
1693
raise UnsupportedOperation(self.add_conflicts, self)
1696
def conflicts(self):
1697
conflicts = ConflictList()
1698
for conflicted in self._iter_conflicts():
1701
if file_kind(self.abspath(conflicted)) != "file":
1703
except errors.NoSuchFile:
1706
for suffix in ('.THIS', '.OTHER'):
1708
kind = file_kind(self.abspath(conflicted+suffix))
1711
except errors.NoSuchFile:
1715
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1716
conflicts.append(Conflict.factory(ctype, path=conflicted,
1717
file_id=self.path2id(conflicted)))
1721
class WorkingTree2(WorkingTree):
1722
"""This is the Format 2 working tree.
1724
This was the first weave based working tree.
1725
- uses os locks for locking.
1726
- uses the branch last-revision.
1730
# we share control files:
1731
if self._hashcache.needs_write and self._control_files._lock_count==3:
1732
self._hashcache.write()
1733
# reverse order of locking.
1735
return self._control_files.unlock()
1737
self.branch.unlock()
1740
class WorkingTree3(WorkingTree):
1741
"""This is the Format 3 working tree.
1743
This differs from the base WorkingTree by:
1744
- having its own file lock
1745
- having its own last-revision property.
1747
This is new in bzr 0.8
1751
def _last_revision(self):
1752
"""See WorkingTree._last_revision."""
1754
return self._control_files.get_utf8('last-revision').read()
1758
def _change_last_revision(self, revision_id):
1759
"""See WorkingTree._change_last_revision."""
1760
if revision_id is None or revision_id == NULL_REVISION:
1762
self._control_files._transport.delete('last-revision')
1763
except errors.NoSuchFile:
1767
self._control_files.put_utf8('last-revision', revision_id)
1771
def set_conflicts(self, conflicts):
1772
self._put_rio('conflicts', conflicts.to_stanzas(),
1776
def add_conflicts(self, new_conflicts):
1777
conflict_set = set(self.conflicts())
1778
conflict_set.update(set(list(new_conflicts)))
1779
self.set_conflicts(ConflictList(sorted(conflict_set,
1780
key=Conflict.sort_key)))
1783
def conflicts(self):
1785
confile = self._control_files.get('conflicts')
1787
return ConflictList()
1789
if confile.next() != CONFLICT_HEADER_1 + '\n':
1790
raise ConflictFormatError()
1791
except StopIteration:
1792
raise ConflictFormatError()
1793
return ConflictList.from_stanzas(RioReader(confile))
1796
if self._hashcache.needs_write and self._control_files._lock_count==1:
1797
self._hashcache.write()
1798
# reverse order of locking.
1800
return self._control_files.unlock()
1802
self.branch.unlock()
1805
def get_conflicted_stem(path):
1806
for suffix in CONFLICT_SUFFIXES:
1807
if path.endswith(suffix):
1808
return path[:-len(suffix)]
1810
@deprecated_function(zero_eight)
1811
def is_control_file(filename):
1812
"""See WorkingTree.is_control_filename(filename)."""
1813
## FIXME: better check
1814
filename = normpath(filename)
1815
while filename != '':
1816
head, tail = os.path.split(filename)
1817
## mutter('check %r for control file' % ((head, tail),))
1820
if filename == head:
1826
class WorkingTreeFormat(object):
1827
"""An encapsulation of the initialization and open routines for a format.
1829
Formats provide three things:
1830
* An initialization routine,
1834
Formats are placed in an dict by their format string for reference
1835
during workingtree opening. Its not required that these be instances, they
1836
can be classes themselves with class methods - it simply depends on
1837
whether state is needed for a given format or not.
1839
Once a format is deprecated, just deprecate the initialize and open
1840
methods on the format class. Do not deprecate the object, as the
1841
object will be created every time regardless.
1844
_default_format = None
1845
"""The default format used for new trees."""
1848
"""The known formats."""
1851
def find_format(klass, a_bzrdir):
1852
"""Return the format for the working tree object in a_bzrdir."""
1854
transport = a_bzrdir.get_workingtree_transport(None)
1855
format_string = transport.get("format").read()
1856
return klass._formats[format_string]
1858
raise errors.NoWorkingTree(base=transport.base)
1860
raise errors.UnknownFormatError(format=format_string)
1863
def get_default_format(klass):
1864
"""Return the current default format."""
1865
return klass._default_format
1867
def get_format_string(self):
1868
"""Return the ASCII format string that identifies this format."""
1869
raise NotImplementedError(self.get_format_string)
1871
def get_format_description(self):
1872
"""Return the short description for this format."""
1873
raise NotImplementedError(self.get_format_description)
1875
def is_supported(self):
1876
"""Is this format supported?
1878
Supported formats can be initialized and opened.
1879
Unsupported formats may not support initialization or committing or
1880
some other features depending on the reason for not being supported.
1885
def register_format(klass, format):
1886
klass._formats[format.get_format_string()] = format
1889
def set_default_format(klass, format):
1890
klass._default_format = format
1893
def unregister_format(klass, format):
1894
assert klass._formats[format.get_format_string()] is format
1895
del klass._formats[format.get_format_string()]
1899
class WorkingTreeFormat2(WorkingTreeFormat):
1900
"""The second working tree format.
1902
This format modified the hash cache from the format 1 hash cache.
1905
def get_format_description(self):
1906
"""See WorkingTreeFormat.get_format_description()."""
1907
return "Working tree format 2"
1909
def stub_initialize_remote(self, control_files):
1910
"""As a special workaround create critical control files for a remote working tree
1912
This ensures that it can later be updated and dealt with locally,
1913
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1914
no working tree. (See bug #43064).
1918
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1920
control_files.put('inventory', sio)
1922
control_files.put_utf8('pending-merges', '')
1925
def initialize(self, a_bzrdir, revision_id=None):
1926
"""See WorkingTreeFormat.initialize()."""
1927
if not isinstance(a_bzrdir.transport, LocalTransport):
1928
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1929
branch = a_bzrdir.open_branch()
1930
if revision_id is not None:
1933
revision_history = branch.revision_history()
1935
position = revision_history.index(revision_id)
1937
raise errors.NoSuchRevision(branch, revision_id)
1938
branch.set_revision_history(revision_history[:position + 1])
1941
revision = branch.last_revision()
1943
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1949
wt.set_last_revision(revision)
1950
basis_tree = wt.basis_tree()
1951
if basis_tree.inventory.root is not None:
1952
inv.root.file_id = basis_tree.inventory.root.file_id
1953
wt._write_inventory(inv)
1954
wt.set_parent_trees([(revision, basis_tree)])
1955
build_tree(basis_tree, wt)
1959
super(WorkingTreeFormat2, self).__init__()
1960
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1962
def open(self, a_bzrdir, _found=False):
1963
"""Return the WorkingTree object for a_bzrdir
1965
_found is a private parameter, do not use it. It is used to indicate
1966
if format probing has already been done.
1969
# we are being called directly and must probe.
1970
raise NotImplementedError
1971
if not isinstance(a_bzrdir.transport, LocalTransport):
1972
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1973
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1979
class WorkingTreeFormat3(WorkingTreeFormat):
1980
"""The second working tree format updated to record a format marker.
1983
- exists within a metadir controlling .bzr
1984
- includes an explicit version marker for the workingtree control
1985
files, separate from the BzrDir format
1986
- modifies the hash cache format
1988
- uses a LockDir to guard access for writes.
1991
def get_format_string(self):
1992
"""See WorkingTreeFormat.get_format_string()."""
1993
return "Bazaar-NG Working Tree format 3"
1995
def get_format_description(self):
1996
"""See WorkingTreeFormat.get_format_description()."""
1997
return "Working tree format 3"
1999
_lock_file_name = 'lock'
2000
_lock_class = LockDir
2002
def _open_control_files(self, a_bzrdir):
2003
transport = a_bzrdir.get_workingtree_transport(None)
2004
return LockableFiles(transport, self._lock_file_name,
2007
def initialize(self, a_bzrdir, revision_id=None):
2008
"""See WorkingTreeFormat.initialize().
2010
revision_id allows creating a working tree at a different
2011
revision than the branch is at.
2013
if not isinstance(a_bzrdir.transport, LocalTransport):
2014
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2015
transport = a_bzrdir.get_workingtree_transport(self)
2016
control_files = self._open_control_files(a_bzrdir)
2017
control_files.create_lock()
2018
control_files.lock_write()
2019
control_files.put_utf8('format', self.get_format_string())
2020
branch = a_bzrdir.open_branch()
2021
if revision_id is None:
2022
revision_id = branch.last_revision()
2023
inv = Inventory(root_id=gen_root_id())
2024
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2030
_control_files=control_files)
2033
wt.set_last_revision(revision_id)
2034
basis_tree = wt.basis_tree()
2035
wt._write_inventory(inv)
2036
wt.set_pending_merges([])
2037
if revision_id == bzrlib.revision.NULL_REVISION:
2038
wt.set_parent_trees([])
2040
wt.set_parent_trees([(revision_id, basis_tree)])
2041
build_tree(basis_tree, wt)
2044
control_files.unlock()
2048
super(WorkingTreeFormat3, self).__init__()
2049
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2051
def open(self, a_bzrdir, _found=False):
2052
"""Return the WorkingTree object for a_bzrdir
2054
_found is a private parameter, do not use it. It is used to indicate
2055
if format probing has already been done.
2058
# we are being called directly and must probe.
2059
raise NotImplementedError
2060
if not isinstance(a_bzrdir.transport, LocalTransport):
2061
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2062
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2064
def _open(self, a_bzrdir, control_files):
2065
"""Open the tree itself.
2067
:param a_bzrdir: the dir for the tree.
2068
:param control_files: the control files for the tree.
2070
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2074
_control_files=control_files)
2077
return self.get_format_string()
2080
# formats which have no format string are not discoverable
2081
# and not independently creatable, so are not registered.
2082
__default_format = WorkingTreeFormat3()
2083
WorkingTreeFormat.register_format(__default_format)
2084
WorkingTreeFormat.set_default_format(__default_format)
2085
_legacy_formats = [WorkingTreeFormat2(),
2089
class WorkingTreeTestProviderAdapter(object):
2090
"""A tool to generate a suite testing multiple workingtree formats at once.
2092
This is done by copying the test once for each transport and injecting
2093
the transport_server, transport_readonly_server, and workingtree_format
2094
classes into each copy. Each copy is also given a new id() to make it
2098
def __init__(self, transport_server, transport_readonly_server, formats):
2099
self._transport_server = transport_server
2100
self._transport_readonly_server = transport_readonly_server
2101
self._formats = formats
2103
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2104
"""Clone test for adaption."""
2105
new_test = deepcopy(test)
2106
new_test.transport_server = self._transport_server
2107
new_test.transport_readonly_server = self._transport_readonly_server
2108
new_test.bzrdir_format = bzrdir_format
2109
new_test.workingtree_format = workingtree_format
2110
def make_new_test_id():
2111
new_id = "%s(%s)" % (test.id(), variation)
2112
return lambda: new_id
2113
new_test.id = make_new_test_id()
2116
def adapt(self, test):
2117
from bzrlib.tests import TestSuite
2118
result = TestSuite()
2119
for workingtree_format, bzrdir_format in self._formats:
2120
new_test = self._clone_test(
2123
workingtree_format, workingtree_format.__class__.__name__)
2124
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
