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
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
46
from copy import deepcopy
56
conflicts as _mod_conflicts,
68
from bzrlib.transport import get_transport
72
from bzrlib.decorators import needs_read_lock, needs_write_lock
73
from bzrlib.errors import (BzrCheckError,
76
WeaveRevisionNotPresent,
80
MergeModifiedFormatError,
83
from bzrlib.inventory import InventoryEntry, Inventory
84
from bzrlib.lockable_files import LockableFiles, TransportLock
85
from bzrlib.lockdir import LockDir
86
import bzrlib.mutabletree
87
from bzrlib.mutabletree import needs_tree_write_lock
88
from bzrlib.osutils import (
100
from bzrlib.trace import mutter, note
101
from bzrlib.transport.local import LocalTransport
103
from bzrlib.progress import DummyProgress, ProgressPhase
104
from bzrlib.revision import NULL_REVISION
105
import bzrlib.revisiontree
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (deprecated_passed,
110
DEPRECATED_PARAMETER,
116
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
117
CONFLICT_HEADER_1 = "BZR conflict list format 1"
119
# the regex removes any weird characters; we don't escape them
120
# but rather just pull them out
121
_gen_file_id_re = re.compile(r'[^\w.]')
122
_gen_id_suffix = None
126
def _next_id_suffix():
127
"""Create a new file id suffix that is reasonably unique.
129
On the first call we combine the current time with 64 bits of randomness
130
to give a highly probably globally unique number. Then each call in the same
131
process adds 1 to a serial number we append to that unique value.
133
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
134
# than having to move the id randomness out of the inner loop like this.
135
# XXX TODO: for the global randomness this uses we should add the thread-id
136
# before the serial #.
137
global _gen_id_suffix, _gen_id_serial
138
if _gen_id_suffix is None:
139
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
141
return _gen_id_suffix + str(_gen_id_serial)
144
def gen_file_id(name):
145
"""Return new file id for the basename 'name'.
147
The uniqueness is supplied from _next_id_suffix.
149
# The real randomness is in the _next_id_suffix, the
150
# rest of the identifier is just to be nice.
152
# 1) Remove non-ascii word characters to keep the ids portable
153
# 2) squash to lowercase, so the file id doesn't have to
154
# be escaped (case insensitive filesystems would bork for ids
155
# that only differred in case without escaping).
156
# 3) truncate the filename to 20 chars. Long filenames also bork on some
158
# 4) Removing starting '.' characters to prevent the file ids from
159
# being considered hidden.
160
ascii_word_only = _gen_file_id_re.sub('', name.lower())
161
short_no_dots = ascii_word_only.lstrip('.')[:20]
162
return short_no_dots + _next_id_suffix()
166
"""Return a new tree-root file id."""
167
return gen_file_id('tree_root')
170
class TreeEntry(object):
171
"""An entry that implements the minimum interface used by commands.
173
This needs further inspection, it may be better to have
174
InventoryEntries without ids - though that seems wrong. For now,
175
this is a parallel hierarchy to InventoryEntry, and needs to become
176
one of several things: decorates to that hierarchy, children of, or
178
Another note is that these objects are currently only used when there is
179
no InventoryEntry available - i.e. for unversioned objects.
180
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
183
def __eq__(self, other):
184
# yes, this us ugly, TODO: best practice __eq__ style.
185
return (isinstance(other, TreeEntry)
186
and other.__class__ == self.__class__)
188
def kind_character(self):
192
class TreeDirectory(TreeEntry):
193
"""See TreeEntry. This is a directory in a working tree."""
195
def __eq__(self, other):
196
return (isinstance(other, TreeDirectory)
197
and other.__class__ == self.__class__)
199
def kind_character(self):
203
class TreeFile(TreeEntry):
204
"""See TreeEntry. This is a regular file in a working tree."""
206
def __eq__(self, other):
207
return (isinstance(other, TreeFile)
208
and other.__class__ == self.__class__)
210
def kind_character(self):
214
class TreeLink(TreeEntry):
215
"""See TreeEntry. This is a symlink in a working tree."""
217
def __eq__(self, other):
218
return (isinstance(other, TreeLink)
219
and other.__class__ == self.__class__)
221
def kind_character(self):
225
class WorkingTree(bzrlib.mutabletree.MutableTree):
226
"""Working copy tree.
228
The inventory is held in the `Branch` working-inventory, and the
229
files are in a directory on disk.
231
It is possible for a `WorkingTree` to have a filename which is
232
not listed in the Inventory and vice versa.
235
def __init__(self, basedir='.',
236
branch=DEPRECATED_PARAMETER,
242
"""Construct a WorkingTree for basedir.
244
If the branch is not supplied, it is opened automatically.
245
If the branch is supplied, it must be the branch for this basedir.
246
(branch.base is not cross checked, because for remote branches that
247
would be meaningless).
249
self._format = _format
250
self.bzrdir = _bzrdir
252
# not created via open etc.
253
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
254
"Please use bzrdir.open_workingtree or WorkingTree.open().",
257
wt = WorkingTree.open(basedir)
258
self._branch = wt.branch
259
self.basedir = wt.basedir
260
self._control_files = wt._control_files
261
self._hashcache = wt._hashcache
262
self._set_inventory(wt._inventory)
263
self._format = wt._format
264
self.bzrdir = wt.bzrdir
265
from bzrlib.hashcache import HashCache
266
from bzrlib.trace import note, mutter
267
assert isinstance(basedir, basestring), \
268
"base directory %r is not a string" % basedir
269
basedir = safe_unicode(basedir)
270
mutter("opening working tree %r", basedir)
271
if deprecated_passed(branch):
273
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
274
" Please use bzrdir.open_workingtree() or"
275
" WorkingTree.open().",
279
self._branch = branch
281
self._branch = self.bzrdir.open_branch()
282
self.basedir = realpath(basedir)
283
# if branch is at our basedir and is a format 6 or less
284
if isinstance(self._format, WorkingTreeFormat2):
285
# share control object
286
self._control_files = self.branch.control_files
288
# assume all other formats have their own control files.
289
assert isinstance(_control_files, LockableFiles), \
290
"_control_files must be a LockableFiles, not %r" \
292
self._control_files = _control_files
293
# update the whole cache up front and write to disk if anything changed;
294
# in the future we might want to do this more selectively
295
# two possible ways offer themselves : in self._unlock, write the cache
296
# if needed, or, when the cache sees a change, append it to the hash
297
# cache file, and have the parser take the most recent entry for a
299
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
300
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
302
# is this scan needed ? it makes things kinda slow.
309
if _inventory is None:
310
self._set_inventory(self.read_working_inventory())
312
self._set_inventory(_inventory)
315
fget=lambda self: self._branch,
316
doc="""The branch this WorkingTree is connected to.
318
This cannot be set - it is reflective of the actual disk structure
319
the working tree has been constructed from.
322
def break_lock(self):
323
"""Break a lock if one is present from another instance.
325
Uses the ui factory to ask for confirmation if the lock may be from
328
This will probe the repository for its lock as well.
330
self._control_files.break_lock()
331
self.branch.break_lock()
333
def _set_inventory(self, inv):
334
assert inv.root is not None
335
self._inventory = inv
338
def open(path=None, _unsupported=False):
339
"""Open an existing working tree at path.
343
path = os.path.getcwdu()
344
control = bzrdir.BzrDir.open(path, _unsupported)
345
return control.open_workingtree(_unsupported)
348
def open_containing(path=None):
349
"""Open an existing working tree which has its root about path.
351
This probes for a working tree at path and searches upwards from there.
353
Basically we keep looking up until we find the control directory or
354
run into /. If there isn't one, raises NotBranchError.
355
TODO: give this a new exception.
356
If there is one, it is returned, along with the unused portion of path.
358
:return: The WorkingTree that contains 'path', and the rest of path
361
path = osutils.getcwd()
362
control, relpath = bzrdir.BzrDir.open_containing(path)
364
return control.open_workingtree(), relpath
367
def open_downlevel(path=None):
368
"""Open an unsupported working tree.
370
Only intended for advanced situations like upgrading part of a bzrdir.
372
return WorkingTree.open(path, _unsupported=True)
375
"""Iterate through file_ids for this tree.
377
file_ids are in a WorkingTree if they are in the working inventory
378
and the working file exists.
380
inv = self._inventory
381
for path, ie in inv.iter_entries():
382
if osutils.lexists(self.abspath(path)):
386
return "<%s of %s>" % (self.__class__.__name__,
387
getattr(self, 'basedir', None))
389
def abspath(self, filename):
390
return pathjoin(self.basedir, filename)
392
def basis_tree(self):
393
"""Return RevisionTree for the current last revision.
395
If the left most parent is a ghost then the returned tree will be an
396
empty tree - one obtained by calling repository.revision_tree(None).
399
revision_id = self.get_parent_ids()[0]
401
# no parents, return an empty revision tree.
402
# in the future this should return the tree for
403
# 'empty:' - the implicit root empty tree.
404
return self.branch.repository.revision_tree(None)
407
xml = self.read_basis_inventory()
408
inv = xml6.serializer_v6.read_inventory_from_string(xml)
409
if inv is not None and inv.revision_id == revision_id:
410
return bzrlib.tree.RevisionTree(self.branch.repository,
412
except (NoSuchFile, errors.BadInventoryFormat):
414
# No cached copy available, retrieve from the repository.
415
# FIXME? RBC 20060403 should we cache the inventory locally
418
return self.branch.repository.revision_tree(revision_id)
419
except errors.RevisionNotPresent:
420
# the basis tree *may* be a ghost or a low level error may have
421
# occured. If the revision is present, its a problem, if its not
423
if self.branch.repository.has_revision(revision_id):
425
# the basis tree is a ghost so return an empty tree.
426
return self.branch.repository.revision_tree(None)
429
@deprecated_method(zero_eight)
430
def create(branch, directory):
431
"""Create a workingtree for branch at directory.
433
If existing_directory already exists it must have a .bzr directory.
434
If it does not exist, it will be created.
436
This returns a new WorkingTree object for the new checkout.
438
TODO FIXME RBC 20060124 when we have checkout formats in place this
439
should accept an optional revisionid to checkout [and reject this if
440
checking out into the same dir as a pre-checkout-aware branch format.]
442
XXX: When BzrDir is present, these should be created through that
445
warnings.warn('delete WorkingTree.create', stacklevel=3)
446
transport = get_transport(directory)
447
if branch.bzrdir.root_transport.base == transport.base:
449
return branch.bzrdir.create_workingtree()
450
# different directory,
451
# create a branch reference
452
# and now a working tree.
453
raise NotImplementedError
456
@deprecated_method(zero_eight)
457
def create_standalone(directory):
458
"""Create a checkout and a branch and a repo at directory.
460
Directory must exist and be empty.
462
please use BzrDir.create_standalone_workingtree
464
return bzrdir.BzrDir.create_standalone_workingtree(directory)
466
def relpath(self, path):
467
"""Return the local path portion from a given path.
469
The path may be absolute or relative. If its a relative path it is
470
interpreted relative to the python current working directory.
472
return osutils.relpath(self.basedir, path)
474
def has_filename(self, filename):
475
return osutils.lexists(self.abspath(filename))
477
def get_file(self, file_id):
478
return self.get_file_byname(self.id2path(file_id))
480
def get_file_text(self, file_id):
481
return self.get_file(file_id).read()
483
def get_file_byname(self, filename):
484
return file(self.abspath(filename), 'rb')
486
def get_parent_ids(self):
487
"""See Tree.get_parent_ids.
489
This implementation reads the pending merges list and last_revision
490
value and uses that to decide what the parents list should be.
492
last_rev = self._last_revision()
498
merges_file = self._control_files.get_utf8('pending-merges')
502
for l in merges_file.readlines():
503
parents.append(l.rstrip('\n'))
506
def get_root_id(self):
507
"""Return the id of this trees root"""
508
inv = self.read_working_inventory()
509
return inv.root.file_id
511
def _get_store_filename(self, file_id):
512
## XXX: badly named; this is not in the store at all
513
return self.abspath(self.id2path(file_id))
516
def clone(self, to_bzrdir, revision_id=None, basis=None):
517
"""Duplicate this working tree into to_bzr, including all state.
519
Specifically modified files are kept as modified, but
520
ignored and unknown files are discarded.
522
If you want to make a new line of development, see bzrdir.sprout()
525
If not None, the cloned tree will have its last revision set to
526
revision, and and difference between the source trees last revision
527
and this one merged in.
530
If not None, a closer copy of a tree which may have some files in
531
common, and which file content should be preferentially copied from.
533
# assumes the target bzr dir format is compatible.
534
result = self._format.initialize(to_bzrdir)
535
self.copy_content_into(result, revision_id)
539
def copy_content_into(self, tree, revision_id=None):
540
"""Copy the current content and user files of this tree into tree."""
541
tree.set_root_id(self.get_root_id())
542
if revision_id is None:
543
merge.transform_tree(tree, self)
545
# TODO now merge from tree.last_revision to revision (to preserve
546
# user local changes)
547
merge.transform_tree(tree, self)
548
tree.set_parent_ids([revision_id])
550
def id2abspath(self, file_id):
551
return self.abspath(self.id2path(file_id))
553
def has_id(self, file_id):
554
# files that have been deleted are excluded
555
inv = self._inventory
556
if not inv.has_id(file_id):
558
path = inv.id2path(file_id)
559
return osutils.lexists(self.abspath(path))
561
def has_or_had_id(self, file_id):
562
if file_id == self.inventory.root.file_id:
564
return self.inventory.has_id(file_id)
566
__contains__ = has_id
568
def get_file_size(self, file_id):
569
return os.path.getsize(self.id2abspath(file_id))
572
def get_file_sha1(self, file_id, path=None):
574
path = self._inventory.id2path(file_id)
575
return self._hashcache.get_sha1(path)
577
def get_file_mtime(self, file_id, path=None):
579
path = self._inventory.id2path(file_id)
580
return os.lstat(self.abspath(path)).st_mtime
582
if not supports_executable():
583
def is_executable(self, file_id, path=None):
584
return self._inventory[file_id].executable
586
def is_executable(self, file_id, path=None):
588
path = self._inventory.id2path(file_id)
589
mode = os.lstat(self.abspath(path)).st_mode
590
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
593
def _add(self, files, ids, kinds):
594
"""See MutableTree._add."""
595
# TODO: Re-adding a file that is removed in the working copy
596
# should probably put it back with the previous ID.
597
# the read and write working inventory should not occur in this
598
# function - they should be part of lock_write and unlock.
599
inv = self.read_working_inventory()
600
for f, file_id, kind in zip(files, ids, kinds):
601
assert kind is not None
603
inv.add_path(f, kind=kind)
605
inv.add_path(f, kind=kind, file_id=file_id)
606
self._write_inventory(inv)
608
@needs_tree_write_lock
609
def _gather_kinds(self, files, kinds):
610
"""See MutableTree._gather_kinds."""
611
for pos, f in enumerate(files):
612
if kinds[pos] is None:
613
fullpath = normpath(self.abspath(f))
615
kinds[pos] = file_kind(fullpath)
617
if e.errno == errno.ENOENT:
618
raise NoSuchFile(fullpath)
621
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
622
"""Add revision_id as a parent.
624
This is equivalent to retrieving the current list of parent ids
625
and setting the list to its value plus revision_id.
627
:param revision_id: The revision id to add to the parent list. It may
628
be a ghost revision as long as its not the first parent to be added,
629
or the allow_leftmost_as_ghost parameter is set True.
630
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
632
parents = self.get_parent_ids() + [revision_id]
633
self.set_parent_ids(parents,
634
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
636
@needs_tree_write_lock
637
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
638
"""Add revision_id, tree tuple as a parent.
640
This is equivalent to retrieving the current list of parent trees
641
and setting the list to its value plus parent_tuple. See also
642
add_parent_tree_id - if you only have a parent id available it will be
643
simpler to use that api. If you have the parent already available, using
644
this api is preferred.
646
:param parent_tuple: The (revision id, tree) to add to the parent list.
647
If the revision_id is a ghost, pass None for the tree.
648
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
650
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
651
if len(parent_ids) > 1:
652
# the leftmost may have already been a ghost, preserve that if it
654
allow_leftmost_as_ghost = True
655
self.set_parent_ids(parent_ids,
656
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
658
@needs_tree_write_lock
659
def add_pending_merge(self, *revision_ids):
660
# TODO: Perhaps should check at this point that the
661
# history of the revision is actually present?
662
parents = self.get_parent_ids()
664
for rev_id in revision_ids:
665
if rev_id in parents:
667
parents.append(rev_id)
670
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
672
@deprecated_method(zero_eleven)
674
def pending_merges(self):
675
"""Return a list of pending merges.
677
These are revisions that have been merged into the working
678
directory but not yet committed.
680
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
681
instead - which is available on all tree objects.
683
return self.get_parent_ids()[1:]
685
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
686
"""Common ghost checking functionality from set_parent_*.
688
This checks that the left hand-parent exists if there are any
691
if len(revision_ids) > 0:
692
leftmost_id = revision_ids[0]
693
if (not allow_leftmost_as_ghost and not
694
self.branch.repository.has_revision(leftmost_id)):
695
raise errors.GhostRevisionUnusableHere(leftmost_id)
697
def _set_merges_from_parent_ids(self, parent_ids):
698
merges = parent_ids[1:]
699
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
701
@needs_tree_write_lock
702
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
703
"""Set the parent ids to revision_ids.
705
See also set_parent_trees. This api will try to retrieve the tree data
706
for each element of revision_ids from the trees repository. If you have
707
tree data already available, it is more efficient to use
708
set_parent_trees rather than set_parent_ids. set_parent_ids is however
709
an easier API to use.
711
:param revision_ids: The revision_ids to set as the parent ids of this
712
working tree. Any of these may be ghosts.
714
self._check_parents_for_ghosts(revision_ids,
715
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
717
if len(revision_ids) > 0:
718
self.set_last_revision(revision_ids[0])
720
self.set_last_revision(None)
722
self._set_merges_from_parent_ids(revision_ids)
724
@needs_tree_write_lock
725
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
726
"""See MutableTree.set_parent_trees."""
727
parent_ids = [rev for (rev, tree) in parents_list]
729
self._check_parents_for_ghosts(parent_ids,
730
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
732
if len(parent_ids) == 0:
733
leftmost_parent_id = None
734
leftmost_parent_tree = None
736
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
738
if self._change_last_revision(leftmost_parent_id):
739
if leftmost_parent_tree is None:
740
# If we don't have a tree, fall back to reading the
741
# parent tree from the repository.
742
self._cache_basis_inventory(leftmost_parent_id)
744
inv = leftmost_parent_tree.inventory
745
xml = self._create_basis_xml_from_inventory(
746
leftmost_parent_id, inv)
747
self._write_basis_inventory(xml)
748
self._set_merges_from_parent_ids(parent_ids)
750
@needs_tree_write_lock
751
def set_pending_merges(self, rev_list):
752
parents = self.get_parent_ids()
753
leftmost = parents[:1]
754
new_parents = leftmost + rev_list
755
self.set_parent_ids(new_parents)
757
@needs_tree_write_lock
758
def set_merge_modified(self, modified_hashes):
760
for file_id, hash in modified_hashes.iteritems():
761
yield Stanza(file_id=file_id, hash=hash)
762
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
764
@needs_tree_write_lock
765
def _put_rio(self, filename, stanzas, header):
766
my_file = rio_file(stanzas, header)
767
self._control_files.put(filename, my_file)
769
@needs_write_lock # because merge pulls data into the branch.
770
def merge_from_branch(self, branch, to_revision=None):
771
"""Merge from a branch into this working tree.
773
:param branch: The branch to merge from.
774
:param to_revision: If non-None, the merge will merge to to_revision, but
775
not beyond it. to_revision does not need to be in the history of
776
the branch when it is supplied. If None, to_revision defaults to
777
branch.last_revision().
779
from bzrlib.merge import Merger, Merge3Merger
780
pb = bzrlib.ui.ui_factory.nested_progress_bar()
782
merger = Merger(self.branch, this_tree=self, pb=pb)
783
merger.pp = ProgressPhase("Merge phase", 5, pb)
784
merger.pp.next_phase()
785
# check that there are no
787
merger.check_basis(check_clean=True, require_commits=False)
788
if to_revision is None:
789
to_revision = branch.last_revision()
790
merger.other_rev_id = to_revision
791
if merger.other_rev_id is None:
792
raise error.NoCommits(branch)
793
self.branch.fetch(branch, last_revision=merger.other_rev_id)
794
merger.other_basis = merger.other_rev_id
795
merger.other_tree = self.branch.repository.revision_tree(
797
merger.pp.next_phase()
799
if merger.base_rev_id == merger.other_rev_id:
800
raise errors.PointlessMerge
801
merger.backup_files = False
802
merger.merge_type = Merge3Merger
803
merger.set_interesting_files(None)
804
merger.show_base = False
805
merger.reprocess = False
806
conflicts = merger.do_merge()
813
def merge_modified(self):
815
hashfile = self._control_files.get('merge-hashes')
820
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
821
raise MergeModifiedFormatError()
822
except StopIteration:
823
raise MergeModifiedFormatError()
824
for s in RioReader(hashfile):
825
file_id = s.get("file_id")
826
if file_id not in self.inventory:
829
if hash == self.get_file_sha1(file_id):
830
merge_hashes[file_id] = hash
834
def mkdir(self, path, file_id=None):
835
"""See MutableTree.mkdir()."""
837
file_id = gen_file_id(os.path.basename(path))
838
os.mkdir(self.abspath(path))
839
self.add(path, file_id, 'directory')
842
def get_symlink_target(self, file_id):
843
return os.readlink(self.id2abspath(file_id))
845
def file_class(self, filename):
846
if self.path2id(filename):
848
elif self.is_ignored(filename):
853
def list_files(self, include_root=False):
854
"""Recursively list all files as (path, class, kind, id, entry).
856
Lists, but does not descend into unversioned directories.
858
This does not include files that have been deleted in this
861
Skips the control directory.
863
inv = self._inventory
864
if include_root is True:
865
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
866
# Convert these into local objects to save lookup times
867
pathjoin = osutils.pathjoin
868
file_kind = osutils.file_kind
870
# transport.base ends in a slash, we want the piece
871
# between the last two slashes
872
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
874
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
876
# directory file_id, relative path, absolute path, reverse sorted children
877
children = os.listdir(self.basedir)
879
# jam 20060527 The kernel sized tree seems equivalent whether we
880
# use a deque and popleft to keep them sorted, or if we use a plain
881
# list and just reverse() them.
882
children = collections.deque(children)
883
stack = [(inv.root.file_id, u'', self.basedir, children)]
885
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
888
f = children.popleft()
889
## TODO: If we find a subdirectory with its own .bzr
890
## directory, then that is a separate tree and we
891
## should exclude it.
893
# the bzrdir for this tree
894
if transport_base_dir == f:
897
# we know that from_dir_relpath and from_dir_abspath never end in a slash
898
# and 'f' doesn't begin with one, we can do a string op, rather
899
# than the checks of pathjoin(), all relative paths will have an extra slash
901
fp = from_dir_relpath + '/' + f
904
fap = from_dir_abspath + '/' + f
906
f_ie = inv.get_child(from_dir_id, f)
909
elif self.is_ignored(fp[1:]):
912
# we may not have found this file, because of a unicode issue
913
f_norm, can_access = osutils.normalized_filename(f)
914
if f == f_norm or not can_access:
915
# No change, so treat this file normally
918
# this file can be accessed by a normalized path
919
# check again if it is versioned
920
# these lines are repeated here for performance
922
fp = from_dir_relpath + '/' + f
923
fap = from_dir_abspath + '/' + f
924
f_ie = inv.get_child(from_dir_id, f)
927
elif self.is_ignored(fp[1:]):
936
raise BzrCheckError("file %r entered as kind %r id %r, "
938
% (fap, f_ie.kind, f_ie.file_id, fk))
940
# make a last minute entry
942
yield fp[1:], c, fk, f_ie.file_id, f_ie
945
yield fp[1:], c, fk, None, fk_entries[fk]()
947
yield fp[1:], c, fk, None, TreeEntry()
950
if fk != 'directory':
953
# But do this child first
954
new_children = os.listdir(fap)
956
new_children = collections.deque(new_children)
957
stack.append((f_ie.file_id, fp, fap, new_children))
958
# Break out of inner loop, so that we start outer loop with child
961
# if we finished all children, pop it off the stack
964
@needs_tree_write_lock
965
def move(self, from_paths, to_name):
968
to_name must exist in the inventory.
970
If to_name exists and is a directory, the files are moved into
971
it, keeping their old names.
973
Note that to_name is only the last component of the new name;
974
this doesn't change the directory.
976
This returns a list of (from_path, to_path) pairs for each
980
## TODO: Option to move IDs only
981
assert not isinstance(from_paths, basestring)
983
to_abs = self.abspath(to_name)
984
if not isdir(to_abs):
985
raise BzrError("destination %r is not a directory" % to_abs)
986
if not self.has_filename(to_name):
987
raise BzrError("destination %r not in working directory" % to_abs)
988
to_dir_id = inv.path2id(to_name)
989
if to_dir_id is None and to_name != '':
990
raise BzrError("destination %r is not a versioned directory" % to_name)
991
to_dir_ie = inv[to_dir_id]
992
if to_dir_ie.kind != 'directory':
993
raise BzrError("destination %r is not a directory" % to_abs)
995
to_idpath = inv.get_idpath(to_dir_id)
998
if not self.has_filename(f):
999
raise BzrError("%r does not exist in working tree" % f)
1000
f_id = inv.path2id(f)
1002
raise BzrError("%r is not versioned" % f)
1003
name_tail = splitpath(f)[-1]
1004
dest_path = pathjoin(to_name, name_tail)
1005
if self.has_filename(dest_path):
1006
raise BzrError("destination %r already exists" % dest_path)
1007
if f_id in to_idpath:
1008
raise BzrError("can't move %r to a subdirectory of itself" % f)
1010
# OK, so there's a race here, it's possible that someone will
1011
# create a file in this interval and then the rename might be
1012
# left half-done. But we should have caught most problems.
1013
orig_inv = deepcopy(self.inventory)
1015
for f in from_paths:
1016
name_tail = splitpath(f)[-1]
1017
dest_path = pathjoin(to_name, name_tail)
1018
result.append((f, dest_path))
1019
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1021
osutils.rename(self.abspath(f), self.abspath(dest_path))
1023
raise BzrError("failed to rename %r to %r: %s" %
1024
(f, dest_path, e[1]),
1025
["rename rolled back"])
1027
# restore the inventory on error
1028
self._set_inventory(orig_inv)
1030
self._write_inventory(inv)
1033
@needs_tree_write_lock
1034
def rename_one(self, from_rel, to_rel):
1037
This can change the directory or the filename or both.
1039
inv = self.inventory
1040
if not self.has_filename(from_rel):
1041
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1042
if self.has_filename(to_rel):
1043
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1045
file_id = inv.path2id(from_rel)
1047
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1049
entry = inv[file_id]
1050
from_parent = entry.parent_id
1051
from_name = entry.name
1053
if inv.path2id(to_rel):
1054
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1056
to_dir, to_tail = os.path.split(to_rel)
1057
to_dir_id = inv.path2id(to_dir)
1058
if to_dir_id is None and to_dir != '':
1059
raise BzrError("can't determine destination directory id for %r" % to_dir)
1061
mutter("rename_one:")
1062
mutter(" file_id {%s}" % file_id)
1063
mutter(" from_rel %r" % from_rel)
1064
mutter(" to_rel %r" % to_rel)
1065
mutter(" to_dir %r" % to_dir)
1066
mutter(" to_dir_id {%s}" % to_dir_id)
1068
inv.rename(file_id, to_dir_id, to_tail)
1070
from_abs = self.abspath(from_rel)
1071
to_abs = self.abspath(to_rel)
1073
osutils.rename(from_abs, to_abs)
1075
inv.rename(file_id, from_parent, from_name)
1076
raise BzrError("failed to rename %r to %r: %s"
1077
% (from_abs, to_abs, e[1]),
1078
["rename rolled back"])
1079
self._write_inventory(inv)
1083
"""Return all unknown files.
1085
These are files in the working directory that are not versioned or
1086
control files or ignored.
1088
for subp in self.extras():
1089
if not self.is_ignored(subp):
1092
@needs_tree_write_lock
1093
def unversion(self, file_ids):
1094
"""Remove the file ids in file_ids from the current versioned set.
1096
When a file_id is unversioned, all of its children are automatically
1099
:param file_ids: The file ids to stop versioning.
1100
:raises: NoSuchId if any fileid is not currently versioned.
1102
for file_id in file_ids:
1103
if self._inventory.has_id(file_id):
1104
self._inventory.remove_recursive_id(file_id)
1106
raise errors.NoSuchId(self, file_id)
1108
# in the future this should just set a dirty bit to wait for the
1109
# final unlock. However, until all methods of workingtree start
1110
# with the current in -memory inventory rather than triggering
1111
# a read, it is more complex - we need to teach read_inventory
1112
# to know when to read, and when to not read first... and possibly
1113
# to save first when the in memory one may be corrupted.
1114
# so for now, we just only write it if it is indeed dirty.
1116
self._write_inventory(self._inventory)
1118
@deprecated_method(zero_eight)
1119
def iter_conflicts(self):
1120
"""List all files in the tree that have text or content conflicts.
1121
DEPRECATED. Use conflicts instead."""
1122
return self._iter_conflicts()
1124
def _iter_conflicts(self):
1126
for info in self.list_files():
1128
stem = get_conflicted_stem(path)
1131
if stem not in conflicted:
1132
conflicted.add(stem)
1136
def pull(self, source, overwrite=False, stop_revision=None):
1137
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1140
pp = ProgressPhase("Pull phase", 2, top_pb)
1142
old_revision_history = self.branch.revision_history()
1143
basis_tree = self.basis_tree()
1144
count = self.branch.pull(source, overwrite, stop_revision)
1145
new_revision_history = self.branch.revision_history()
1146
if new_revision_history != old_revision_history:
1148
if len(old_revision_history):
1149
other_revision = old_revision_history[-1]
1151
other_revision = None
1152
repository = self.branch.repository
1153
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1155
new_basis_tree = self.branch.basis_tree()
1162
if (basis_tree.inventory.root is None and
1163
new_basis_tree.inventory.root is not None):
1164
self.set_root_id(new_basis_tree.inventory.root.file_id)
1167
# TODO - dedup parents list with things merged by pull ?
1168
# reuse the revisiontree we merged against to set the new
1170
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1171
# we have to pull the merge trees out again, because
1172
# merge_inner has set the ids. - this corner is not yet
1173
# layered well enough to prevent double handling.
1174
merges = self.get_parent_ids()[1:]
1175
parent_trees.extend([
1176
(parent, repository.revision_tree(parent)) for
1178
self.set_parent_trees(parent_trees)
1185
def put_file_bytes_non_atomic(self, file_id, bytes):
1186
"""See MutableTree.put_file_bytes_non_atomic."""
1187
stream = file(self.id2abspath(file_id), 'wb')
1192
# TODO: update the hashcache here ?
1195
"""Yield all unknown files in this WorkingTree.
1197
If there are any unknown directories then only the directory is
1198
returned, not all its children. But if there are unknown files
1199
under a versioned subdirectory, they are returned.
1201
Currently returned depth-first, sorted by name within directories.
1203
## TODO: Work from given directory downwards
1204
for path, dir_entry in self.inventory.directories():
1205
# mutter("search for unknowns in %r", path)
1206
dirabs = self.abspath(path)
1207
if not isdir(dirabs):
1208
# e.g. directory deleted
1212
for subf in os.listdir(dirabs):
1215
if subf not in dir_entry.children:
1216
subf_norm, can_access = osutils.normalized_filename(subf)
1217
if subf_norm != subf and can_access:
1218
if subf_norm not in dir_entry.children:
1219
fl.append(subf_norm)
1225
subp = pathjoin(path, subf)
1228
def _translate_ignore_rule(self, rule):
1229
"""Translate a single ignore rule to a regex.
1231
There are two types of ignore rules. Those that do not contain a / are
1232
matched against the tail of the filename (that is, they do not care
1233
what directory the file is in.) Rules which do contain a slash must
1234
match the entire path. As a special case, './' at the start of the
1235
string counts as a slash in the string but is removed before matching
1236
(e.g. ./foo.c, ./src/foo.c)
1238
:return: The translated regex.
1240
if rule[:2] in ('./', '.\\'):
1242
result = fnmatch.translate(rule[2:])
1243
elif '/' in rule or '\\' in rule:
1245
result = fnmatch.translate(rule)
1247
# default rule style.
1248
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1249
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1250
return "(" + result + ")"
1252
def _combine_ignore_rules(self, rules):
1253
"""Combine a list of ignore rules into a single regex object.
1255
Each individual rule is combined with | to form a big regex, which then
1256
has $ added to it to form something like ()|()|()$. The group index for
1257
each subregex's outermost group is placed in a dictionary mapping back
1258
to the rule. This allows quick identification of the matching rule that
1260
:return: a list of the compiled regex and the matching-group index
1261
dictionaries. We return a list because python complains if you try to
1262
combine more than 100 regexes.
1267
translated_rules = []
1269
translated_rule = self._translate_ignore_rule(rule)
1270
compiled_rule = re.compile(translated_rule)
1271
groups[next_group] = rule
1272
next_group += compiled_rule.groups
1273
translated_rules.append(translated_rule)
1274
if next_group == 99:
1275
result.append((re.compile("|".join(translated_rules)), groups))
1278
translated_rules = []
1279
if len(translated_rules):
1280
result.append((re.compile("|".join(translated_rules)), groups))
1283
def ignored_files(self):
1284
"""Yield list of PATH, IGNORE_PATTERN"""
1285
for subp in self.extras():
1286
pat = self.is_ignored(subp)
1290
def get_ignore_list(self):
1291
"""Return list of ignore patterns.
1293
Cached in the Tree object after the first call.
1295
ignoreset = getattr(self, '_ignoreset', None)
1296
if ignoreset is not None:
1299
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1300
ignore_globs.update(ignores.get_runtime_ignores())
1302
ignore_globs.update(ignores.get_user_ignores())
1304
if self.has_filename(bzrlib.IGNORE_FILENAME):
1305
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1307
ignore_globs.update(ignores.parse_ignore_file(f))
1311
self._ignoreset = ignore_globs
1312
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1315
def _get_ignore_rules_as_regex(self):
1316
"""Return a regex of the ignore rules and a mapping dict.
1318
:return: (ignore rules compiled regex, dictionary mapping rule group
1319
indices to original rule.)
1321
if getattr(self, '_ignoreset', None) is None:
1322
self.get_ignore_list()
1323
return self._ignore_regex
1325
def is_ignored(self, filename):
1326
r"""Check whether the filename matches an ignore pattern.
1328
Patterns containing '/' or '\' need to match the whole path;
1329
others match against only the last component.
1331
If the file is ignored, returns the pattern which caused it to
1332
be ignored, otherwise None. So this can simply be used as a
1333
boolean if desired."""
1335
# TODO: Use '**' to match directories, and other extended
1336
# globbing stuff from cvs/rsync.
1338
# XXX: fnmatch is actually not quite what we want: it's only
1339
# approximately the same as real Unix fnmatch, and doesn't
1340
# treat dotfiles correctly and allows * to match /.
1341
# Eventually it should be replaced with something more
1344
rules = self._get_ignore_rules_as_regex()
1345
for regex, mapping in rules:
1346
match = regex.match(filename)
1347
if match is not None:
1348
# one or more of the groups in mapping will have a non-None
1350
groups = match.groups()
1351
rules = [mapping[group] for group in
1352
mapping if groups[group] is not None]
1356
def kind(self, file_id):
1357
return file_kind(self.id2abspath(file_id))
1359
def last_revision(self):
1360
"""Return the last revision of the branch for this tree.
1362
This format tree does not support a separate marker for last-revision
1363
compared to the branch.
1365
See MutableTree.last_revision
1367
return self._last_revision()
1370
def _last_revision(self):
1371
"""helper for get_parent_ids."""
1372
return self.branch.last_revision()
1374
def is_locked(self):
1375
return self._control_files.is_locked()
1377
def lock_read(self):
1378
"""See Branch.lock_read, and WorkingTree.unlock."""
1379
self.branch.lock_read()
1381
return self._control_files.lock_read()
1383
self.branch.unlock()
1386
def lock_tree_write(self):
1387
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1388
self.branch.lock_read()
1390
return self._control_files.lock_write()
1392
self.branch.unlock()
1395
def lock_write(self):
1396
"""See MutableTree.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'
1410
@needs_tree_write_lock
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 _write_basis_inventory(self, xml):
1433
"""Write the basis inventory XML to the basis-inventory file"""
1434
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1435
path = self._basis_inventory_name()
1437
self._control_files.put(path, sio)
1439
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1440
"""Create the text that will be saved in basis-inventory"""
1441
inventory.revision_id = revision_id
1442
return xml6.serializer_v6.write_inventory_to_string(inventory)
1444
def _cache_basis_inventory(self, new_revision):
1445
"""Cache new_revision as the basis inventory."""
1446
# TODO: this should allow the ready-to-use inventory to be passed in,
1447
# as commit already has that ready-to-use [while the format is the
1450
# this double handles the inventory - unpack and repack -
1451
# but is easier to understand. We can/should put a conditional
1452
# in here based on whether the inventory is in the latest format
1453
# - perhaps we should repack all inventories on a repository
1455
# the fast path is to copy the raw xml from the repository. If the
1456
# xml contains 'revision_id="', then we assume the right
1457
# revision_id is set. We must check for this full string, because a
1458
# root node id can legitimately look like 'revision_id' but cannot
1460
xml = self.branch.repository.get_inventory_xml(new_revision)
1461
firstline = xml.split('\n', 1)[0]
1462
if (not 'revision_id="' in firstline or
1463
'format="6"' not in firstline):
1464
inv = self.branch.repository.deserialise_inventory(
1466
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1467
self._write_basis_inventory(xml)
1468
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1471
def read_basis_inventory(self):
1472
"""Read the cached basis inventory."""
1473
path = self._basis_inventory_name()
1474
return self._control_files.get(path).read()
1477
def read_working_inventory(self):
1478
"""Read the working inventory."""
1479
# ElementTree does its own conversion from UTF-8, so open in
1481
result = xml5.serializer_v5.read_inventory(
1482
self._control_files.get('inventory'))
1483
self._set_inventory(result)
1486
@needs_tree_write_lock
1487
def remove(self, files, verbose=False, to_file=None):
1488
"""Remove nominated files from the working inventory..
1490
This does not remove their text. This does not run on XXX on what? RBC
1492
TODO: Refuse to remove modified files unless --force is given?
1494
TODO: Do something useful with directories.
1496
TODO: Should this remove the text or not? Tough call; not
1497
removing may be useful and the user can just use use rm, and
1498
is the opposite of add. Removing it is consistent with most
1499
other tools. Maybe an option.
1501
## TODO: Normalize names
1502
## TODO: Remove nested loops; better scalability
1503
if isinstance(files, basestring):
1506
inv = self.inventory
1508
# do this before any modifications
1510
fid = inv.path2id(f)
1512
# TODO: Perhaps make this just a warning, and continue?
1513
# This tends to happen when
1514
raise NotVersionedError(path=f)
1516
# having remove it, it must be either ignored or unknown
1517
if self.is_ignored(f):
1521
textui.show_status(new_status, inv[fid].kind, f,
1525
self._write_inventory(inv)
1527
@needs_tree_write_lock
1528
def revert(self, filenames, old_tree=None, backups=True,
1529
pb=DummyProgress()):
1530
from bzrlib.conflicts import resolve
1531
if old_tree is None:
1532
old_tree = self.basis_tree()
1533
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1534
if not len(filenames):
1535
self.set_parent_ids(self.get_parent_ids()[:1])
1538
resolve(self, filenames, ignore_misses=True)
1541
# XXX: This method should be deprecated in favour of taking in a proper
1542
# new Inventory object.
1543
@needs_tree_write_lock
1544
def set_inventory(self, new_inventory_list):
1545
from bzrlib.inventory import (Inventory,
1550
inv = Inventory(self.get_root_id())
1551
for path, file_id, parent, kind in new_inventory_list:
1552
name = os.path.basename(path)
1555
# fixme, there should be a factory function inv,add_??
1556
if kind == 'directory':
1557
inv.add(InventoryDirectory(file_id, name, parent))
1558
elif kind == 'file':
1559
inv.add(InventoryFile(file_id, name, parent))
1560
elif kind == 'symlink':
1561
inv.add(InventoryLink(file_id, name, parent))
1563
raise BzrError("unknown kind %r" % kind)
1564
self._write_inventory(inv)
1566
@needs_tree_write_lock
1567
def set_root_id(self, file_id):
1568
"""Set the root id for this tree."""
1569
inv = self.read_working_inventory()
1570
orig_root_id = inv.root.file_id
1571
del inv._byid[inv.root.file_id]
1572
inv.root.file_id = file_id
1573
inv._byid[inv.root.file_id] = inv.root
1576
if entry.parent_id == orig_root_id:
1577
entry.parent_id = inv.root.file_id
1578
self._write_inventory(inv)
1581
"""See Branch.unlock.
1583
WorkingTree locking just uses the Branch locking facilities.
1584
This is current because all working trees have an embedded branch
1585
within them. IF in the future, we were to make branch data shareable
1586
between multiple working trees, i.e. via shared storage, then we
1587
would probably want to lock both the local tree, and the branch.
1589
raise NotImplementedError(self.unlock)
1593
"""Update a working tree along its branch.
1595
This will update the branch if its bound too, which means we have
1596
multiple trees involved:
1598
- The new basis tree of the master.
1599
- The old basis tree of the branch.
1600
- The old basis tree of the working tree.
1601
- The current working tree state.
1603
Pathologically, all three may be different, and non-ancestors of each
1604
other. Conceptually we want to:
1606
- Preserve the wt.basis->wt.state changes
1607
- Transform the wt.basis to the new master basis.
1608
- Apply a merge of the old branch basis to get any 'local' changes from
1610
- Restore the wt.basis->wt.state changes.
1612
There isn't a single operation at the moment to do that, so we:
1613
- Merge current state -> basis tree of the master w.r.t. the old tree
1615
- Do a 'normal' merge of the old branch basis if it is relevant.
1617
old_tip = self.branch.update()
1619
# here if old_tip is not None, it is the old tip of the branch before
1620
# it was updated from the master branch. This should become a pending
1621
# merge in the working tree to preserve the user existing work. we
1622
# cant set that until we update the working trees last revision to be
1623
# one from the new branch, because it will just get absorbed by the
1624
# parent de-duplication logic.
1626
# We MUST save it even if an error occurs, because otherwise the users
1627
# local work is unreferenced and will appear to have been lost.
1631
last_rev = self.get_parent_ids()[0]
1634
if last_rev != self.branch.last_revision():
1635
# merge tree state up to new branch tip.
1636
basis = self.basis_tree()
1637
to_tree = self.branch.basis_tree()
1638
if basis.inventory.root is None:
1639
self.set_root_id(to_tree.inventory.root.file_id)
1640
result += merge.merge_inner(
1645
# TODO - dedup parents list with things merged by pull ?
1646
# reuse the tree we've updated to to set the basis:
1647
parent_trees = [(self.branch.last_revision(), to_tree)]
1648
merges = self.get_parent_ids()[1:]
1649
# Ideally we ask the tree for the trees here, that way the working
1650
# tree can decide whether to give us teh entire tree or give us a
1651
# lazy initialised tree. dirstate for instance will have the trees
1652
# in ram already, whereas a last-revision + basis-inventory tree
1653
# will not, but also does not need them when setting parents.
1654
for parent in merges:
1655
parent_trees.append(
1656
(parent, self.branch.repository.revision_tree(parent)))
1657
if old_tip is not None:
1658
parent_trees.append(
1659
(old_tip, self.branch.repository.revision_tree(old_tip)))
1660
self.set_parent_trees(parent_trees)
1661
last_rev = parent_trees[0][0]
1663
# the working tree had the same last-revision as the master
1664
# branch did. We may still have pivot local work from the local
1665
# branch into old_tip:
1666
if old_tip is not None:
1667
self.add_parent_tree_id(old_tip)
1668
if old_tip and old_tip != last_rev:
1669
# our last revision was not the prior branch last revision
1670
# and we have converted that last revision to a pending merge.
1671
# base is somewhere between the branch tip now
1672
# and the now pending merge
1673
from bzrlib.revision import common_ancestor
1675
base_rev_id = common_ancestor(self.branch.last_revision(),
1677
self.branch.repository)
1678
except errors.NoCommonAncestor:
1680
base_tree = self.branch.repository.revision_tree(base_rev_id)
1681
other_tree = self.branch.repository.revision_tree(old_tip)
1682
result += merge.merge_inner(
1689
@needs_tree_write_lock
1690
def _write_inventory(self, inv):
1691
"""Write inventory as the current inventory."""
1693
xml5.serializer_v5.write_inventory(inv, sio)
1695
self._control_files.put('inventory', sio)
1696
self._set_inventory(inv)
1697
mutter('wrote working inventory')
1699
def set_conflicts(self, arg):
1700
raise UnsupportedOperation(self.set_conflicts, self)
1702
def add_conflicts(self, arg):
1703
raise UnsupportedOperation(self.add_conflicts, self)
1706
def conflicts(self):
1707
conflicts = _mod_conflicts.ConflictList()
1708
for conflicted in self._iter_conflicts():
1711
if file_kind(self.abspath(conflicted)) != "file":
1713
except errors.NoSuchFile:
1716
for suffix in ('.THIS', '.OTHER'):
1718
kind = file_kind(self.abspath(conflicted+suffix))
1721
except errors.NoSuchFile:
1725
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1726
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1728
file_id=self.path2id(conflicted)))
1732
class WorkingTree2(WorkingTree):
1733
"""This is the Format 2 working tree.
1735
This was the first weave based working tree.
1736
- uses os locks for locking.
1737
- uses the branch last-revision.
1740
def lock_tree_write(self):
1741
"""See WorkingTree.lock_tree_write().
1743
In Format2 WorkingTrees we have a single lock for the branch and tree
1744
so lock_tree_write() degrades to lock_write().
1746
self.branch.lock_write()
1748
return self._control_files.lock_write()
1750
self.branch.unlock()
1754
# we share control files:
1755
if self._hashcache.needs_write and self._control_files._lock_count==3:
1756
self._hashcache.write()
1757
# reverse order of locking.
1759
return self._control_files.unlock()
1761
self.branch.unlock()
1764
class WorkingTree3(WorkingTree):
1765
"""This is the Format 3 working tree.
1767
This differs from the base WorkingTree by:
1768
- having its own file lock
1769
- having its own last-revision property.
1771
This is new in bzr 0.8
1775
def _last_revision(self):
1776
"""See Mutable.last_revision."""
1778
return self._control_files.get_utf8('last-revision').read()
1782
def _change_last_revision(self, revision_id):
1783
"""See WorkingTree._change_last_revision."""
1784
if revision_id is None or revision_id == NULL_REVISION:
1786
self._control_files._transport.delete('last-revision')
1787
except errors.NoSuchFile:
1791
self._control_files.put_utf8('last-revision', revision_id)
1794
@needs_tree_write_lock
1795
def set_conflicts(self, conflicts):
1796
self._put_rio('conflicts', conflicts.to_stanzas(),
1799
@needs_tree_write_lock
1800
def add_conflicts(self, new_conflicts):
1801
conflict_set = set(self.conflicts())
1802
conflict_set.update(set(list(new_conflicts)))
1803
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1804
key=_mod_conflicts.Conflict.sort_key)))
1807
def conflicts(self):
1809
confile = self._control_files.get('conflicts')
1811
return _mod_conflicts.ConflictList()
1813
if confile.next() != CONFLICT_HEADER_1 + '\n':
1814
raise ConflictFormatError()
1815
except StopIteration:
1816
raise ConflictFormatError()
1817
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1820
if self._hashcache.needs_write and self._control_files._lock_count==1:
1821
self._hashcache.write()
1822
# reverse order of locking.
1824
return self._control_files.unlock()
1826
self.branch.unlock()
1829
def get_conflicted_stem(path):
1830
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1831
if path.endswith(suffix):
1832
return path[:-len(suffix)]
1834
@deprecated_function(zero_eight)
1835
def is_control_file(filename):
1836
"""See WorkingTree.is_control_filename(filename)."""
1837
## FIXME: better check
1838
filename = normpath(filename)
1839
while filename != '':
1840
head, tail = os.path.split(filename)
1841
## mutter('check %r for control file' % ((head, tail),))
1844
if filename == head:
1850
class WorkingTreeFormat(object):
1851
"""An encapsulation of the initialization and open routines for a format.
1853
Formats provide three things:
1854
* An initialization routine,
1858
Formats are placed in an dict by their format string for reference
1859
during workingtree opening. Its not required that these be instances, they
1860
can be classes themselves with class methods - it simply depends on
1861
whether state is needed for a given format or not.
1863
Once a format is deprecated, just deprecate the initialize and open
1864
methods on the format class. Do not deprecate the object, as the
1865
object will be created every time regardless.
1868
_default_format = None
1869
"""The default format used for new trees."""
1872
"""The known formats."""
1875
def find_format(klass, a_bzrdir):
1876
"""Return the format for the working tree object in a_bzrdir."""
1878
transport = a_bzrdir.get_workingtree_transport(None)
1879
format_string = transport.get("format").read()
1880
return klass._formats[format_string]
1882
raise errors.NoWorkingTree(base=transport.base)
1884
raise errors.UnknownFormatError(format=format_string)
1887
def get_default_format(klass):
1888
"""Return the current default format."""
1889
return klass._default_format
1891
def get_format_string(self):
1892
"""Return the ASCII format string that identifies this format."""
1893
raise NotImplementedError(self.get_format_string)
1895
def get_format_description(self):
1896
"""Return the short description for this format."""
1897
raise NotImplementedError(self.get_format_description)
1899
def is_supported(self):
1900
"""Is this format supported?
1902
Supported formats can be initialized and opened.
1903
Unsupported formats may not support initialization or committing or
1904
some other features depending on the reason for not being supported.
1909
def register_format(klass, format):
1910
klass._formats[format.get_format_string()] = format
1913
def set_default_format(klass, format):
1914
klass._default_format = format
1917
def unregister_format(klass, format):
1918
assert klass._formats[format.get_format_string()] is format
1919
del klass._formats[format.get_format_string()]
1923
class WorkingTreeFormat2(WorkingTreeFormat):
1924
"""The second working tree format.
1926
This format modified the hash cache from the format 1 hash cache.
1929
def get_format_description(self):
1930
"""See WorkingTreeFormat.get_format_description()."""
1931
return "Working tree format 2"
1933
def stub_initialize_remote(self, control_files):
1934
"""As a special workaround create critical control files for a remote working tree
1936
This ensures that it can later be updated and dealt with locally,
1937
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1938
no working tree. (See bug #43064).
1942
xml5.serializer_v5.write_inventory(inv, sio)
1944
control_files.put('inventory', sio)
1946
control_files.put_utf8('pending-merges', '')
1949
def initialize(self, a_bzrdir, revision_id=None):
1950
"""See WorkingTreeFormat.initialize()."""
1951
if not isinstance(a_bzrdir.transport, LocalTransport):
1952
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1953
branch = a_bzrdir.open_branch()
1954
if revision_id is not None:
1957
revision_history = branch.revision_history()
1959
position = revision_history.index(revision_id)
1961
raise errors.NoSuchRevision(branch, revision_id)
1962
branch.set_revision_history(revision_history[:position + 1])
1965
revision = branch.last_revision()
1967
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1973
wt.set_last_revision(revision)
1974
basis_tree = wt.basis_tree()
1975
if basis_tree.inventory.root is not None:
1976
inv.root.file_id = basis_tree.inventory.root.file_id
1977
wt._write_inventory(inv)
1978
wt.set_parent_trees([(revision, basis_tree)])
1979
transform.build_tree(basis_tree, wt)
1983
super(WorkingTreeFormat2, self).__init__()
1984
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1986
def open(self, a_bzrdir, _found=False):
1987
"""Return the WorkingTree object for a_bzrdir
1989
_found is a private parameter, do not use it. It is used to indicate
1990
if format probing has already been done.
1993
# we are being called directly and must probe.
1994
raise NotImplementedError
1995
if not isinstance(a_bzrdir.transport, LocalTransport):
1996
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1997
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2003
class WorkingTreeFormat3(WorkingTreeFormat):
2004
"""The second working tree format updated to record a format marker.
2007
- exists within a metadir controlling .bzr
2008
- includes an explicit version marker for the workingtree control
2009
files, separate from the BzrDir format
2010
- modifies the hash cache format
2012
- uses a LockDir to guard access for writes.
2015
def get_format_string(self):
2016
"""See WorkingTreeFormat.get_format_string()."""
2017
return "Bazaar-NG Working Tree format 3"
2019
def get_format_description(self):
2020
"""See WorkingTreeFormat.get_format_description()."""
2021
return "Working tree format 3"
2023
_lock_file_name = 'lock'
2024
_lock_class = LockDir
2026
def _open_control_files(self, a_bzrdir):
2027
transport = a_bzrdir.get_workingtree_transport(None)
2028
return LockableFiles(transport, self._lock_file_name,
2031
def initialize(self, a_bzrdir, revision_id=None):
2032
"""See WorkingTreeFormat.initialize().
2034
revision_id allows creating a working tree at a different
2035
revision than the branch is at.
2037
if not isinstance(a_bzrdir.transport, LocalTransport):
2038
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2039
transport = a_bzrdir.get_workingtree_transport(self)
2040
control_files = self._open_control_files(a_bzrdir)
2041
control_files.create_lock()
2042
control_files.lock_write()
2043
control_files.put_utf8('format', self.get_format_string())
2044
branch = a_bzrdir.open_branch()
2045
if revision_id is None:
2046
revision_id = branch.last_revision()
2047
inv = Inventory(root_id=gen_root_id())
2048
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2054
_control_files=control_files)
2055
wt.lock_tree_write()
2057
wt.set_last_revision(revision_id)
2058
basis_tree = wt.basis_tree()
2059
wt._write_inventory(inv)
2060
wt.set_pending_merges([])
2061
if revision_id == bzrlib.revision.NULL_REVISION:
2062
wt.set_parent_trees([])
2064
wt.set_parent_trees([(revision_id, basis_tree)])
2065
transform.build_tree(basis_tree, wt)
2068
control_files.unlock()
2072
super(WorkingTreeFormat3, self).__init__()
2073
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2075
def open(self, a_bzrdir, _found=False):
2076
"""Return the WorkingTree object for a_bzrdir
2078
_found is a private parameter, do not use it. It is used to indicate
2079
if format probing has already been done.
2082
# we are being called directly and must probe.
2083
raise NotImplementedError
2084
if not isinstance(a_bzrdir.transport, LocalTransport):
2085
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2086
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2088
def _open(self, a_bzrdir, control_files):
2089
"""Open the tree itself.
2091
:param a_bzrdir: the dir for the tree.
2092
:param control_files: the control files for the tree.
2094
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2098
_control_files=control_files)
2101
return self.get_format_string()
2104
# formats which have no format string are not discoverable
2105
# and not independently creatable, so are not registered.
2106
__default_format = WorkingTreeFormat3()
2107
WorkingTreeFormat.register_format(__default_format)
2108
WorkingTreeFormat.set_default_format(__default_format)
2109
_legacy_formats = [WorkingTreeFormat2(),
2113
class WorkingTreeTestProviderAdapter(object):
2114
"""A tool to generate a suite testing multiple workingtree formats at once.
2116
This is done by copying the test once for each transport and injecting
2117
the transport_server, transport_readonly_server, and workingtree_format
2118
classes into each copy. Each copy is also given a new id() to make it
2122
def __init__(self, transport_server, transport_readonly_server, formats):
2123
self._transport_server = transport_server
2124
self._transport_readonly_server = transport_readonly_server
2125
self._formats = formats
2127
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2128
"""Clone test for adaption."""
2129
new_test = deepcopy(test)
2130
new_test.transport_server = self._transport_server
2131
new_test.transport_readonly_server = self._transport_readonly_server
2132
new_test.bzrdir_format = bzrdir_format
2133
new_test.workingtree_format = workingtree_format
2134
def make_new_test_id():
2135
new_id = "%s(%s)" % (test.id(), variation)
2136
return lambda: new_id
2137
new_test.id = make_new_test_id()
2140
def adapt(self, test):
2141
from bzrlib.tests import TestSuite
2142
result = TestSuite()
2143
for workingtree_format, bzrdir_format in self._formats:
2144
new_test = self._clone_test(
2147
workingtree_format, workingtree_format.__class__.__name__)
2148
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
