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
if revision_id is None:
542
merge.transform_tree(tree, self)
544
# TODO now merge from tree.last_revision to revision (to preserve
545
# user local changes)
546
merge.transform_tree(tree, self)
547
tree.set_parent_ids([revision_id])
549
def id2abspath(self, file_id):
550
return self.abspath(self.id2path(file_id))
552
def has_id(self, file_id):
553
# files that have been deleted are excluded
554
inv = self._inventory
555
if not inv.has_id(file_id):
557
path = inv.id2path(file_id)
558
return osutils.lexists(self.abspath(path))
560
def has_or_had_id(self, file_id):
561
if file_id == self.inventory.root.file_id:
563
return self.inventory.has_id(file_id)
565
__contains__ = has_id
567
def get_file_size(self, file_id):
568
return os.path.getsize(self.id2abspath(file_id))
571
def get_file_sha1(self, file_id, path=None):
573
path = self._inventory.id2path(file_id)
574
return self._hashcache.get_sha1(path)
576
def get_file_mtime(self, file_id, path=None):
578
path = self._inventory.id2path(file_id)
579
return os.lstat(self.abspath(path)).st_mtime
581
if not supports_executable():
582
def is_executable(self, file_id, path=None):
583
return self._inventory[file_id].executable
585
def is_executable(self, file_id, path=None):
587
path = self._inventory.id2path(file_id)
588
mode = os.lstat(self.abspath(path)).st_mode
589
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
592
def _add(self, files, ids, kinds):
593
"""See MutableTree._add."""
594
# TODO: Re-adding a file that is removed in the working copy
595
# should probably put it back with the previous ID.
596
# the read and write working inventory should not occur in this
597
# function - they should be part of lock_write and unlock.
598
inv = self.read_working_inventory()
599
for f, file_id, kind in zip(files, ids, kinds):
600
assert kind is not None
602
inv.add_path(f, kind=kind)
604
inv.add_path(f, kind=kind, file_id=file_id)
605
self._write_inventory(inv)
607
@needs_tree_write_lock
608
def _gather_kinds(self, files, kinds):
609
"""See MutableTree._gather_kinds."""
610
for pos, f in enumerate(files):
611
if kinds[pos] is None:
612
fullpath = normpath(self.abspath(f))
614
kinds[pos] = file_kind(fullpath)
616
if e.errno == errno.ENOENT:
617
raise NoSuchFile(fullpath)
620
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
621
"""Add revision_id as a parent.
623
This is equivalent to retrieving the current list of parent ids
624
and setting the list to its value plus revision_id.
626
:param revision_id: The revision id to add to the parent list. It may
627
be a ghost revision as long as its not the first parent to be added,
628
or the allow_leftmost_as_ghost parameter is set True.
629
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
631
parents = self.get_parent_ids() + [revision_id]
632
self.set_parent_ids(parents,
633
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
635
@needs_tree_write_lock
636
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
637
"""Add revision_id, tree tuple as a parent.
639
This is equivalent to retrieving the current list of parent trees
640
and setting the list to its value plus parent_tuple. See also
641
add_parent_tree_id - if you only have a parent id available it will be
642
simpler to use that api. If you have the parent already available, using
643
this api is preferred.
645
:param parent_tuple: The (revision id, tree) to add to the parent list.
646
If the revision_id is a ghost, pass None for the tree.
647
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
649
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
650
if len(parent_ids) > 1:
651
# the leftmost may have already been a ghost, preserve that if it
653
allow_leftmost_as_ghost = True
654
self.set_parent_ids(parent_ids,
655
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
657
@needs_tree_write_lock
658
def add_pending_merge(self, *revision_ids):
659
# TODO: Perhaps should check at this point that the
660
# history of the revision is actually present?
661
parents = self.get_parent_ids()
663
for rev_id in revision_ids:
664
if rev_id in parents:
666
parents.append(rev_id)
669
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
671
@deprecated_method(zero_eleven)
673
def pending_merges(self):
674
"""Return a list of pending merges.
676
These are revisions that have been merged into the working
677
directory but not yet committed.
679
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
680
instead - which is available on all tree objects.
682
return self.get_parent_ids()[1:]
684
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
685
"""Common ghost checking functionality from set_parent_*.
687
This checks that the left hand-parent exists if there are any
690
if len(revision_ids) > 0:
691
leftmost_id = revision_ids[0]
692
if (not allow_leftmost_as_ghost and not
693
self.branch.repository.has_revision(leftmost_id)):
694
raise errors.GhostRevisionUnusableHere(leftmost_id)
696
def _set_merges_from_parent_ids(self, parent_ids):
697
merges = parent_ids[1:]
698
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
700
@needs_tree_write_lock
701
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
702
"""Set the parent ids to revision_ids.
704
See also set_parent_trees. This api will try to retrieve the tree data
705
for each element of revision_ids from the trees repository. If you have
706
tree data already available, it is more efficient to use
707
set_parent_trees rather than set_parent_ids. set_parent_ids is however
708
an easier API to use.
710
:param revision_ids: The revision_ids to set as the parent ids of this
711
working tree. Any of these may be ghosts.
713
self._check_parents_for_ghosts(revision_ids,
714
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
716
if len(revision_ids) > 0:
717
self.set_last_revision(revision_ids[0])
719
self.set_last_revision(None)
721
self._set_merges_from_parent_ids(revision_ids)
723
@needs_tree_write_lock
724
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
725
"""See MutableTree.set_parent_trees."""
726
parent_ids = [rev for (rev, tree) in parents_list]
728
self._check_parents_for_ghosts(parent_ids,
729
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
731
if len(parent_ids) == 0:
732
leftmost_parent_id = None
733
leftmost_parent_tree = None
735
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
737
if self._change_last_revision(leftmost_parent_id):
738
if leftmost_parent_tree is None:
739
# If we don't have a tree, fall back to reading the
740
# parent tree from the repository.
741
self._cache_basis_inventory(leftmost_parent_id)
743
inv = leftmost_parent_tree.inventory
744
xml = self._create_basis_xml_from_inventory(
745
leftmost_parent_id, inv)
746
self._write_basis_inventory(xml)
747
self._set_merges_from_parent_ids(parent_ids)
749
@needs_tree_write_lock
750
def set_pending_merges(self, rev_list):
751
parents = self.get_parent_ids()
752
leftmost = parents[:1]
753
new_parents = leftmost + rev_list
754
self.set_parent_ids(new_parents)
756
@needs_tree_write_lock
757
def set_merge_modified(self, modified_hashes):
759
for file_id, hash in modified_hashes.iteritems():
760
yield Stanza(file_id=file_id, hash=hash)
761
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
763
@needs_tree_write_lock
764
def _put_rio(self, filename, stanzas, header):
765
my_file = rio_file(stanzas, header)
766
self._control_files.put(filename, my_file)
768
@needs_write_lock # because merge pulls data into the branch.
769
def merge_from_branch(self, branch, to_revision=None):
770
"""Merge from a branch into this working tree.
772
:param branch: The branch to merge from.
773
:param to_revision: If non-None, the merge will merge to to_revision, but
774
not beyond it. to_revision does not need to be in the history of
775
the branch when it is supplied. If None, to_revision defaults to
776
branch.last_revision().
778
from bzrlib.merge import Merger, Merge3Merger
779
pb = bzrlib.ui.ui_factory.nested_progress_bar()
781
merger = Merger(self.branch, this_tree=self, pb=pb)
782
merger.pp = ProgressPhase("Merge phase", 5, pb)
783
merger.pp.next_phase()
784
# check that there are no
786
merger.check_basis(check_clean=True, require_commits=False)
787
if to_revision is None:
788
to_revision = branch.last_revision()
789
merger.other_rev_id = to_revision
790
if merger.other_rev_id is None:
791
raise error.NoCommits(branch)
792
self.branch.fetch(branch, last_revision=merger.other_rev_id)
793
merger.other_basis = merger.other_rev_id
794
merger.other_tree = self.branch.repository.revision_tree(
796
merger.pp.next_phase()
798
if merger.base_rev_id == merger.other_rev_id:
799
raise errors.PointlessMerge
800
merger.backup_files = False
801
merger.merge_type = Merge3Merger
802
merger.set_interesting_files(None)
803
merger.show_base = False
804
merger.reprocess = False
805
conflicts = merger.do_merge()
812
def merge_modified(self):
814
hashfile = self._control_files.get('merge-hashes')
819
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
820
raise MergeModifiedFormatError()
821
except StopIteration:
822
raise MergeModifiedFormatError()
823
for s in RioReader(hashfile):
824
file_id = s.get("file_id")
825
if file_id not in self.inventory:
828
if hash == self.get_file_sha1(file_id):
829
merge_hashes[file_id] = hash
833
def mkdir(self, path, file_id=None):
834
"""See MutableTree.mkdir()."""
836
file_id = gen_file_id(os.path.basename(path))
837
os.mkdir(self.abspath(path))
838
self.add(path, file_id, 'directory')
841
def get_symlink_target(self, file_id):
842
return os.readlink(self.id2abspath(file_id))
844
def file_class(self, filename):
845
if self.path2id(filename):
847
elif self.is_ignored(filename):
852
def list_files(self, include_root=False):
853
"""Recursively list all files as (path, class, kind, id, entry).
855
Lists, but does not descend into unversioned directories.
857
This does not include files that have been deleted in this
860
Skips the control directory.
862
inv = self._inventory
863
if include_root is True:
864
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
865
# Convert these into local objects to save lookup times
866
pathjoin = osutils.pathjoin
867
file_kind = osutils.file_kind
869
# transport.base ends in a slash, we want the piece
870
# between the last two slashes
871
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
873
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
875
# directory file_id, relative path, absolute path, reverse sorted children
876
children = os.listdir(self.basedir)
878
# jam 20060527 The kernel sized tree seems equivalent whether we
879
# use a deque and popleft to keep them sorted, or if we use a plain
880
# list and just reverse() them.
881
children = collections.deque(children)
882
stack = [(inv.root.file_id, u'', self.basedir, children)]
884
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
887
f = children.popleft()
888
## TODO: If we find a subdirectory with its own .bzr
889
## directory, then that is a separate tree and we
890
## should exclude it.
892
# the bzrdir for this tree
893
if transport_base_dir == f:
896
# we know that from_dir_relpath and from_dir_abspath never end in a slash
897
# and 'f' doesn't begin with one, we can do a string op, rather
898
# than the checks of pathjoin(), all relative paths will have an extra slash
900
fp = from_dir_relpath + '/' + f
903
fap = from_dir_abspath + '/' + f
905
f_ie = inv.get_child(from_dir_id, f)
908
elif self.is_ignored(fp[1:]):
911
# we may not have found this file, because of a unicode issue
912
f_norm, can_access = osutils.normalized_filename(f)
913
if f == f_norm or not can_access:
914
# No change, so treat this file normally
917
# this file can be accessed by a normalized path
918
# check again if it is versioned
919
# these lines are repeated here for performance
921
fp = from_dir_relpath + '/' + f
922
fap = from_dir_abspath + '/' + f
923
f_ie = inv.get_child(from_dir_id, f)
926
elif self.is_ignored(fp[1:]):
935
raise BzrCheckError("file %r entered as kind %r id %r, "
937
% (fap, f_ie.kind, f_ie.file_id, fk))
939
# make a last minute entry
941
yield fp[1:], c, fk, f_ie.file_id, f_ie
944
yield fp[1:], c, fk, None, fk_entries[fk]()
946
yield fp[1:], c, fk, None, TreeEntry()
949
if fk != 'directory':
952
# But do this child first
953
new_children = os.listdir(fap)
955
new_children = collections.deque(new_children)
956
stack.append((f_ie.file_id, fp, fap, new_children))
957
# Break out of inner loop, so that we start outer loop with child
960
# if we finished all children, pop it off the stack
963
@needs_tree_write_lock
964
def move(self, from_paths, to_name):
967
to_name must exist in the inventory.
969
If to_name exists and is a directory, the files are moved into
970
it, keeping their old names.
972
Note that to_name is only the last component of the new name;
973
this doesn't change the directory.
975
This returns a list of (from_path, to_path) pairs for each
979
## TODO: Option to move IDs only
980
assert not isinstance(from_paths, basestring)
982
to_abs = self.abspath(to_name)
983
if not isdir(to_abs):
984
raise BzrError("destination %r is not a directory" % to_abs)
985
if not self.has_filename(to_name):
986
raise BzrError("destination %r not in working directory" % to_abs)
987
to_dir_id = inv.path2id(to_name)
988
if to_dir_id is None and to_name != '':
989
raise BzrError("destination %r is not a versioned directory" % to_name)
990
to_dir_ie = inv[to_dir_id]
991
if to_dir_ie.kind != 'directory':
992
raise BzrError("destination %r is not a directory" % to_abs)
994
to_idpath = inv.get_idpath(to_dir_id)
997
if not self.has_filename(f):
998
raise BzrError("%r does not exist in working tree" % f)
999
f_id = inv.path2id(f)
1001
raise BzrError("%r is not versioned" % f)
1002
name_tail = splitpath(f)[-1]
1003
dest_path = pathjoin(to_name, name_tail)
1004
if self.has_filename(dest_path):
1005
raise BzrError("destination %r already exists" % dest_path)
1006
if f_id in to_idpath:
1007
raise BzrError("can't move %r to a subdirectory of itself" % f)
1009
# OK, so there's a race here, it's possible that someone will
1010
# create a file in this interval and then the rename might be
1011
# left half-done. But we should have caught most problems.
1012
orig_inv = deepcopy(self.inventory)
1014
for f in from_paths:
1015
name_tail = splitpath(f)[-1]
1016
dest_path = pathjoin(to_name, name_tail)
1017
result.append((f, dest_path))
1018
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1020
osutils.rename(self.abspath(f), self.abspath(dest_path))
1022
raise BzrError("failed to rename %r to %r: %s" %
1023
(f, dest_path, e[1]),
1024
["rename rolled back"])
1026
# restore the inventory on error
1027
self._set_inventory(orig_inv)
1029
self._write_inventory(inv)
1032
@needs_tree_write_lock
1033
def rename_one(self, from_rel, to_rel):
1036
This can change the directory or the filename or both.
1038
inv = self.inventory
1039
if not self.has_filename(from_rel):
1040
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1041
if self.has_filename(to_rel):
1042
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1044
file_id = inv.path2id(from_rel)
1046
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1048
entry = inv[file_id]
1049
from_parent = entry.parent_id
1050
from_name = entry.name
1052
if inv.path2id(to_rel):
1053
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1055
to_dir, to_tail = os.path.split(to_rel)
1056
to_dir_id = inv.path2id(to_dir)
1057
if to_dir_id is None and to_dir != '':
1058
raise BzrError("can't determine destination directory id for %r" % to_dir)
1060
mutter("rename_one:")
1061
mutter(" file_id {%s}" % file_id)
1062
mutter(" from_rel %r" % from_rel)
1063
mutter(" to_rel %r" % to_rel)
1064
mutter(" to_dir %r" % to_dir)
1065
mutter(" to_dir_id {%s}" % to_dir_id)
1067
inv.rename(file_id, to_dir_id, to_tail)
1069
from_abs = self.abspath(from_rel)
1070
to_abs = self.abspath(to_rel)
1072
osutils.rename(from_abs, to_abs)
1074
inv.rename(file_id, from_parent, from_name)
1075
raise BzrError("failed to rename %r to %r: %s"
1076
% (from_abs, to_abs, e[1]),
1077
["rename rolled back"])
1078
self._write_inventory(inv)
1082
"""Return all unknown files.
1084
These are files in the working directory that are not versioned or
1085
control files or ignored.
1087
for subp in self.extras():
1088
if not self.is_ignored(subp):
1091
@needs_tree_write_lock
1092
def unversion(self, file_ids):
1093
"""Remove the file ids in file_ids from the current versioned set.
1095
When a file_id is unversioned, all of its children are automatically
1098
:param file_ids: The file ids to stop versioning.
1099
:raises: NoSuchId if any fileid is not currently versioned.
1101
for file_id in file_ids:
1102
if self._inventory.has_id(file_id):
1103
self._inventory.remove_recursive_id(file_id)
1105
raise errors.NoSuchId(self, file_id)
1107
# in the future this should just set a dirty bit to wait for the
1108
# final unlock. However, until all methods of workingtree start
1109
# with the current in -memory inventory rather than triggering
1110
# a read, it is more complex - we need to teach read_inventory
1111
# to know when to read, and when to not read first... and possibly
1112
# to save first when the in memory one may be corrupted.
1113
# so for now, we just only write it if it is indeed dirty.
1115
self._write_inventory(self._inventory)
1117
@deprecated_method(zero_eight)
1118
def iter_conflicts(self):
1119
"""List all files in the tree that have text or content conflicts.
1120
DEPRECATED. Use conflicts instead."""
1121
return self._iter_conflicts()
1123
def _iter_conflicts(self):
1125
for info in self.list_files():
1127
stem = get_conflicted_stem(path)
1130
if stem not in conflicted:
1131
conflicted.add(stem)
1135
def pull(self, source, overwrite=False, stop_revision=None):
1136
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1139
pp = ProgressPhase("Pull phase", 2, top_pb)
1141
old_revision_history = self.branch.revision_history()
1142
basis_tree = self.basis_tree()
1143
count = self.branch.pull(source, overwrite, stop_revision)
1144
new_revision_history = self.branch.revision_history()
1145
if new_revision_history != old_revision_history:
1147
if len(old_revision_history):
1148
other_revision = old_revision_history[-1]
1150
other_revision = None
1151
repository = self.branch.repository
1152
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1154
new_basis_tree = self.branch.basis_tree()
1163
# TODO - dedup parents list with things merged by pull ?
1164
# reuse the revisiontree we merged against to set the new
1166
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1167
# we have to pull the merge trees out again, because
1168
# merge_inner has set the ids. - this corner is not yet
1169
# layered well enough to prevent double handling.
1170
merges = self.get_parent_ids()[1:]
1171
parent_trees.extend([
1172
(parent, repository.revision_tree(parent)) for
1174
self.set_parent_trees(parent_trees)
1181
def put_file_bytes_non_atomic(self, file_id, bytes):
1182
"""See MutableTree.put_file_bytes_non_atomic."""
1183
stream = file(self.id2abspath(file_id), 'wb')
1188
# TODO: update the hashcache here ?
1191
"""Yield all unknown files in this WorkingTree.
1193
If there are any unknown directories then only the directory is
1194
returned, not all its children. But if there are unknown files
1195
under a versioned subdirectory, they are returned.
1197
Currently returned depth-first, sorted by name within directories.
1199
## TODO: Work from given directory downwards
1200
for path, dir_entry in self.inventory.directories():
1201
# mutter("search for unknowns in %r", path)
1202
dirabs = self.abspath(path)
1203
if not isdir(dirabs):
1204
# e.g. directory deleted
1208
for subf in os.listdir(dirabs):
1211
if subf not in dir_entry.children:
1212
subf_norm, can_access = osutils.normalized_filename(subf)
1213
if subf_norm != subf and can_access:
1214
if subf_norm not in dir_entry.children:
1215
fl.append(subf_norm)
1221
subp = pathjoin(path, subf)
1224
def _translate_ignore_rule(self, rule):
1225
"""Translate a single ignore rule to a regex.
1227
There are two types of ignore rules. Those that do not contain a / are
1228
matched against the tail of the filename (that is, they do not care
1229
what directory the file is in.) Rules which do contain a slash must
1230
match the entire path. As a special case, './' at the start of the
1231
string counts as a slash in the string but is removed before matching
1232
(e.g. ./foo.c, ./src/foo.c)
1234
:return: The translated regex.
1236
if rule[:2] in ('./', '.\\'):
1238
result = fnmatch.translate(rule[2:])
1239
elif '/' in rule or '\\' in rule:
1241
result = fnmatch.translate(rule)
1243
# default rule style.
1244
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1245
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1246
return "(" + result + ")"
1248
def _combine_ignore_rules(self, rules):
1249
"""Combine a list of ignore rules into a single regex object.
1251
Each individual rule is combined with | to form a big regex, which then
1252
has $ added to it to form something like ()|()|()$. The group index for
1253
each subregex's outermost group is placed in a dictionary mapping back
1254
to the rule. This allows quick identification of the matching rule that
1256
:return: a list of the compiled regex and the matching-group index
1257
dictionaries. We return a list because python complains if you try to
1258
combine more than 100 regexes.
1263
translated_rules = []
1265
translated_rule = self._translate_ignore_rule(rule)
1266
compiled_rule = re.compile(translated_rule)
1267
groups[next_group] = rule
1268
next_group += compiled_rule.groups
1269
translated_rules.append(translated_rule)
1270
if next_group == 99:
1271
result.append((re.compile("|".join(translated_rules)), groups))
1274
translated_rules = []
1275
if len(translated_rules):
1276
result.append((re.compile("|".join(translated_rules)), groups))
1279
def ignored_files(self):
1280
"""Yield list of PATH, IGNORE_PATTERN"""
1281
for subp in self.extras():
1282
pat = self.is_ignored(subp)
1286
def get_ignore_list(self):
1287
"""Return list of ignore patterns.
1289
Cached in the Tree object after the first call.
1291
ignoreset = getattr(self, '_ignoreset', None)
1292
if ignoreset is not None:
1295
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1296
ignore_globs.update(ignores.get_runtime_ignores())
1298
ignore_globs.update(ignores.get_user_ignores())
1300
if self.has_filename(bzrlib.IGNORE_FILENAME):
1301
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1303
ignore_globs.update(ignores.parse_ignore_file(f))
1307
self._ignoreset = ignore_globs
1308
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1311
def _get_ignore_rules_as_regex(self):
1312
"""Return a regex of the ignore rules and a mapping dict.
1314
:return: (ignore rules compiled regex, dictionary mapping rule group
1315
indices to original rule.)
1317
if getattr(self, '_ignoreset', None) is None:
1318
self.get_ignore_list()
1319
return self._ignore_regex
1321
def is_ignored(self, filename):
1322
r"""Check whether the filename matches an ignore pattern.
1324
Patterns containing '/' or '\' need to match the whole path;
1325
others match against only the last component.
1327
If the file is ignored, returns the pattern which caused it to
1328
be ignored, otherwise None. So this can simply be used as a
1329
boolean if desired."""
1331
# TODO: Use '**' to match directories, and other extended
1332
# globbing stuff from cvs/rsync.
1334
# XXX: fnmatch is actually not quite what we want: it's only
1335
# approximately the same as real Unix fnmatch, and doesn't
1336
# treat dotfiles correctly and allows * to match /.
1337
# Eventually it should be replaced with something more
1340
rules = self._get_ignore_rules_as_regex()
1341
for regex, mapping in rules:
1342
match = regex.match(filename)
1343
if match is not None:
1344
# one or more of the groups in mapping will have a non-None
1346
groups = match.groups()
1347
rules = [mapping[group] for group in
1348
mapping if groups[group] is not None]
1352
def kind(self, file_id):
1353
return file_kind(self.id2abspath(file_id))
1355
def last_revision(self):
1356
"""Return the last revision of the branch for this tree.
1358
This format tree does not support a separate marker for last-revision
1359
compared to the branch.
1361
See MutableTree.last_revision
1363
return self._last_revision()
1366
def _last_revision(self):
1367
"""helper for get_parent_ids."""
1368
return self.branch.last_revision()
1370
def is_locked(self):
1371
return self._control_files.is_locked()
1373
def lock_read(self):
1374
"""See Branch.lock_read, and WorkingTree.unlock."""
1375
self.branch.lock_read()
1377
return self._control_files.lock_read()
1379
self.branch.unlock()
1382
def lock_tree_write(self):
1383
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1384
self.branch.lock_read()
1386
return self._control_files.lock_write()
1388
self.branch.unlock()
1391
def lock_write(self):
1392
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1393
self.branch.lock_write()
1395
return self._control_files.lock_write()
1397
self.branch.unlock()
1400
def get_physical_lock_status(self):
1401
return self._control_files.get_physical_lock_status()
1403
def _basis_inventory_name(self):
1404
return 'basis-inventory-cache'
1406
@needs_tree_write_lock
1407
def set_last_revision(self, new_revision):
1408
"""Change the last revision in the working tree."""
1409
if self._change_last_revision(new_revision):
1410
self._cache_basis_inventory(new_revision)
1412
def _change_last_revision(self, new_revision):
1413
"""Template method part of set_last_revision to perform the change.
1415
This is used to allow WorkingTree3 instances to not affect branch
1416
when their last revision is set.
1418
if new_revision is None:
1419
self.branch.set_revision_history([])
1422
self.branch.generate_revision_history(new_revision)
1423
except errors.NoSuchRevision:
1424
# not present in the repo - dont try to set it deeper than the tip
1425
self.branch.set_revision_history([new_revision])
1428
def _write_basis_inventory(self, xml):
1429
"""Write the basis inventory XML to the basis-inventory file"""
1430
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1431
path = self._basis_inventory_name()
1433
self._control_files.put(path, sio)
1435
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1436
"""Create the text that will be saved in basis-inventory"""
1437
inventory.revision_id = revision_id
1438
return xml6.serializer_v6.write_inventory_to_string(inventory)
1440
def _cache_basis_inventory(self, new_revision):
1441
"""Cache new_revision as the basis inventory."""
1442
# TODO: this should allow the ready-to-use inventory to be passed in,
1443
# as commit already has that ready-to-use [while the format is the
1446
# this double handles the inventory - unpack and repack -
1447
# but is easier to understand. We can/should put a conditional
1448
# in here based on whether the inventory is in the latest format
1449
# - perhaps we should repack all inventories on a repository
1451
# the fast path is to copy the raw xml from the repository. If the
1452
# xml contains 'revision_id="', then we assume the right
1453
# revision_id is set. We must check for this full string, because a
1454
# root node id can legitimately look like 'revision_id' but cannot
1456
xml = self.branch.repository.get_inventory_xml(new_revision)
1457
firstline = xml.split('\n', 1)[0]
1458
if (not 'revision_id="' in firstline or
1459
'format="6"' not in firstline):
1460
inv = self.branch.repository.deserialise_inventory(
1462
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1463
self._write_basis_inventory(xml)
1464
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1467
def read_basis_inventory(self):
1468
"""Read the cached basis inventory."""
1469
path = self._basis_inventory_name()
1470
return self._control_files.get(path).read()
1473
def read_working_inventory(self):
1474
"""Read the working inventory."""
1475
# ElementTree does its own conversion from UTF-8, so open in
1477
result = xml5.serializer_v5.read_inventory(
1478
self._control_files.get('inventory'))
1479
self._set_inventory(result)
1482
@needs_tree_write_lock
1483
def remove(self, files, verbose=False, to_file=None):
1484
"""Remove nominated files from the working inventory..
1486
This does not remove their text. This does not run on XXX on what? RBC
1488
TODO: Refuse to remove modified files unless --force is given?
1490
TODO: Do something useful with directories.
1492
TODO: Should this remove the text or not? Tough call; not
1493
removing may be useful and the user can just use use rm, and
1494
is the opposite of add. Removing it is consistent with most
1495
other tools. Maybe an option.
1497
## TODO: Normalize names
1498
## TODO: Remove nested loops; better scalability
1499
if isinstance(files, basestring):
1502
inv = self.inventory
1504
# do this before any modifications
1506
fid = inv.path2id(f)
1508
# TODO: Perhaps make this just a warning, and continue?
1509
# This tends to happen when
1510
raise NotVersionedError(path=f)
1512
# having remove it, it must be either ignored or unknown
1513
if self.is_ignored(f):
1517
textui.show_status(new_status, inv[fid].kind, f,
1521
self._write_inventory(inv)
1523
@needs_tree_write_lock
1524
def revert(self, filenames, old_tree=None, backups=True,
1525
pb=DummyProgress()):
1526
from bzrlib.conflicts import resolve
1527
if old_tree is None:
1528
old_tree = self.basis_tree()
1529
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1530
if not len(filenames):
1531
self.set_parent_ids(self.get_parent_ids()[:1])
1534
resolve(self, filenames, ignore_misses=True)
1537
# XXX: This method should be deprecated in favour of taking in a proper
1538
# new Inventory object.
1539
@needs_tree_write_lock
1540
def set_inventory(self, new_inventory_list):
1541
from bzrlib.inventory import (Inventory,
1546
inv = Inventory(self.get_root_id())
1547
for path, file_id, parent, kind in new_inventory_list:
1548
name = os.path.basename(path)
1551
# fixme, there should be a factory function inv,add_??
1552
if kind == 'directory':
1553
inv.add(InventoryDirectory(file_id, name, parent))
1554
elif kind == 'file':
1555
inv.add(InventoryFile(file_id, name, parent))
1556
elif kind == 'symlink':
1557
inv.add(InventoryLink(file_id, name, parent))
1559
raise BzrError("unknown kind %r" % kind)
1560
self._write_inventory(inv)
1562
@needs_tree_write_lock
1563
def set_root_id(self, file_id):
1564
"""Set the root id for this tree."""
1565
inv = self.read_working_inventory()
1566
orig_root_id = inv.root.file_id
1567
del inv._byid[inv.root.file_id]
1568
inv.root.file_id = file_id
1569
inv._byid[inv.root.file_id] = inv.root
1572
if entry.parent_id == orig_root_id:
1573
entry.parent_id = inv.root.file_id
1574
self._write_inventory(inv)
1577
"""See Branch.unlock.
1579
WorkingTree locking just uses the Branch locking facilities.
1580
This is current because all working trees have an embedded branch
1581
within them. IF in the future, we were to make branch data shareable
1582
between multiple working trees, i.e. via shared storage, then we
1583
would probably want to lock both the local tree, and the branch.
1585
raise NotImplementedError(self.unlock)
1589
"""Update a working tree along its branch.
1591
This will update the branch if its bound too, which means we have multiple trees involved:
1592
The new basis tree of the master.
1593
The old basis tree of the branch.
1594
The old basis tree of the working tree.
1595
The current working tree state.
1596
pathologically all three may be different, and non ancestors of each other.
1597
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 it into the tree.
1601
Restore the wt.basis->wt.state changes.
1603
There isn't a single operation at the moment to do that, so we:
1604
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1605
Do a 'normal' merge of the old branch basis if it is relevant.
1607
old_tip = self.branch.update()
1608
# here if old_tip is not None, it is the old tip of the branch before
1609
# it was updated from the master branch. This should become a pending
1610
# merge in the working tree to preserve the user existing work. we
1611
# cant set that until we update the working trees last revision to be
1612
# one from the new branch, because it will just get absorbed by the
1613
# parent de-duplication logic.
1615
# We MUST save it even if an error occurs, because otherwise the users
1616
# local work is unreferenced and will appear to have been lost.
1620
last_rev = self.get_parent_ids()[0]
1623
if last_rev != self.branch.last_revision():
1624
# merge tree state up to new branch tip.
1625
basis = self.basis_tree()
1626
to_tree = self.branch.basis_tree()
1627
result += merge.merge_inner(
1632
# TODO - dedup parents list with things merged by pull ?
1633
# reuse the tree we've updated to to set the basis:
1634
parent_trees = [(self.branch.last_revision(), to_tree)]
1635
merges = self.get_parent_ids()[1:]
1636
# Ideally we ask the tree for the trees here, that way the working
1637
# tree can decide whether to give us teh entire tree or give us a
1638
# lazy initialised tree. dirstate for instance will have the trees
1639
# in ram already, whereas a last-revision + basis-inventory tree
1640
# will not, but also does not need them when setting parents.
1641
for parent in merges:
1642
parent_trees.append(
1643
(parent, self.branch.repository.revision_tree(parent)))
1644
if old_tip is not None:
1645
parent_trees.append(
1646
(old_tip, self.branch.repository.revision_tree(old_tip)))
1647
self.set_parent_trees(parent_trees)
1648
last_rev = parent_trees[0][0]
1650
# the working tree had the same last-revision as the master
1651
# branch did. We may still have pivot local work from the local
1652
# branch into old_tip:
1653
if old_tip is not None:
1654
self.add_parent_tree_id(old_tip)
1655
if old_tip and old_tip != last_rev:
1656
# our last revision was not the prior branch last revision
1657
# and we have converted that last revision to a pending merge.
1658
# base is somewhere between the branch tip now
1659
# and the now pending merge
1660
from bzrlib.revision import common_ancestor
1662
base_rev_id = common_ancestor(self.branch.last_revision(),
1664
self.branch.repository)
1665
except errors.NoCommonAncestor:
1667
base_tree = self.branch.repository.revision_tree(base_rev_id)
1668
other_tree = self.branch.repository.revision_tree(old_tip)
1669
result += merge.merge_inner(
1676
@needs_tree_write_lock
1677
def _write_inventory(self, inv):
1678
"""Write inventory as the current inventory."""
1680
xml5.serializer_v5.write_inventory(inv, sio)
1682
self._control_files.put('inventory', sio)
1683
self._set_inventory(inv)
1684
mutter('wrote working inventory')
1686
def set_conflicts(self, arg):
1687
raise UnsupportedOperation(self.set_conflicts, self)
1689
def add_conflicts(self, arg):
1690
raise UnsupportedOperation(self.add_conflicts, self)
1693
def conflicts(self):
1694
conflicts = _mod_conflicts.ConflictList()
1695
for conflicted in self._iter_conflicts():
1698
if file_kind(self.abspath(conflicted)) != "file":
1700
except errors.NoSuchFile:
1703
for suffix in ('.THIS', '.OTHER'):
1705
kind = file_kind(self.abspath(conflicted+suffix))
1708
except errors.NoSuchFile:
1712
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1713
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1715
file_id=self.path2id(conflicted)))
1719
class WorkingTree2(WorkingTree):
1720
"""This is the Format 2 working tree.
1722
This was the first weave based working tree.
1723
- uses os locks for locking.
1724
- uses the branch last-revision.
1727
def lock_tree_write(self):
1728
"""See WorkingTree.lock_tree_write().
1730
In Format2 WorkingTrees we have a single lock for the branch and tree
1731
so lock_tree_write() degrades to lock_write().
1733
self.branch.lock_write()
1735
return self._control_files.lock_write()
1737
self.branch.unlock()
1741
# we share control files:
1742
if self._hashcache.needs_write and self._control_files._lock_count==3:
1743
self._hashcache.write()
1744
# reverse order of locking.
1746
return self._control_files.unlock()
1748
self.branch.unlock()
1751
class WorkingTree3(WorkingTree):
1752
"""This is the Format 3 working tree.
1754
This differs from the base WorkingTree by:
1755
- having its own file lock
1756
- having its own last-revision property.
1758
This is new in bzr 0.8
1762
def _last_revision(self):
1763
"""See Mutable.last_revision."""
1765
return self._control_files.get_utf8('last-revision').read()
1769
def _change_last_revision(self, revision_id):
1770
"""See WorkingTree._change_last_revision."""
1771
if revision_id is None or revision_id == NULL_REVISION:
1773
self._control_files._transport.delete('last-revision')
1774
except errors.NoSuchFile:
1778
self._control_files.put_utf8('last-revision', revision_id)
1781
@needs_tree_write_lock
1782
def set_conflicts(self, conflicts):
1783
self._put_rio('conflicts', conflicts.to_stanzas(),
1786
@needs_tree_write_lock
1787
def add_conflicts(self, new_conflicts):
1788
conflict_set = set(self.conflicts())
1789
conflict_set.update(set(list(new_conflicts)))
1790
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1791
key=_mod_conflicts.Conflict.sort_key)))
1794
def conflicts(self):
1796
confile = self._control_files.get('conflicts')
1798
return _mod_conflicts.ConflictList()
1800
if confile.next() != CONFLICT_HEADER_1 + '\n':
1801
raise ConflictFormatError()
1802
except StopIteration:
1803
raise ConflictFormatError()
1804
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1807
if self._hashcache.needs_write and self._control_files._lock_count==1:
1808
self._hashcache.write()
1809
# reverse order of locking.
1811
return self._control_files.unlock()
1813
self.branch.unlock()
1816
def get_conflicted_stem(path):
1817
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1818
if path.endswith(suffix):
1819
return path[:-len(suffix)]
1821
@deprecated_function(zero_eight)
1822
def is_control_file(filename):
1823
"""See WorkingTree.is_control_filename(filename)."""
1824
## FIXME: better check
1825
filename = normpath(filename)
1826
while filename != '':
1827
head, tail = os.path.split(filename)
1828
## mutter('check %r for control file' % ((head, tail),))
1831
if filename == head:
1837
class WorkingTreeFormat(object):
1838
"""An encapsulation of the initialization and open routines for a format.
1840
Formats provide three things:
1841
* An initialization routine,
1845
Formats are placed in an dict by their format string for reference
1846
during workingtree opening. Its not required that these be instances, they
1847
can be classes themselves with class methods - it simply depends on
1848
whether state is needed for a given format or not.
1850
Once a format is deprecated, just deprecate the initialize and open
1851
methods on the format class. Do not deprecate the object, as the
1852
object will be created every time regardless.
1855
_default_format = None
1856
"""The default format used for new trees."""
1859
"""The known formats."""
1862
def find_format(klass, a_bzrdir):
1863
"""Return the format for the working tree object in a_bzrdir."""
1865
transport = a_bzrdir.get_workingtree_transport(None)
1866
format_string = transport.get("format").read()
1867
return klass._formats[format_string]
1869
raise errors.NoWorkingTree(base=transport.base)
1871
raise errors.UnknownFormatError(format=format_string)
1874
def get_default_format(klass):
1875
"""Return the current default format."""
1876
return klass._default_format
1878
def get_format_string(self):
1879
"""Return the ASCII format string that identifies this format."""
1880
raise NotImplementedError(self.get_format_string)
1882
def get_format_description(self):
1883
"""Return the short description for this format."""
1884
raise NotImplementedError(self.get_format_description)
1886
def is_supported(self):
1887
"""Is this format supported?
1889
Supported formats can be initialized and opened.
1890
Unsupported formats may not support initialization or committing or
1891
some other features depending on the reason for not being supported.
1896
def register_format(klass, format):
1897
klass._formats[format.get_format_string()] = format
1900
def set_default_format(klass, format):
1901
klass._default_format = format
1904
def unregister_format(klass, format):
1905
assert klass._formats[format.get_format_string()] is format
1906
del klass._formats[format.get_format_string()]
1910
class WorkingTreeFormat2(WorkingTreeFormat):
1911
"""The second working tree format.
1913
This format modified the hash cache from the format 1 hash cache.
1916
def get_format_description(self):
1917
"""See WorkingTreeFormat.get_format_description()."""
1918
return "Working tree format 2"
1920
def stub_initialize_remote(self, control_files):
1921
"""As a special workaround create critical control files for a remote working tree
1923
This ensures that it can later be updated and dealt with locally,
1924
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1925
no working tree. (See bug #43064).
1929
xml5.serializer_v5.write_inventory(inv, sio)
1931
control_files.put('inventory', sio)
1933
control_files.put_utf8('pending-merges', '')
1936
def initialize(self, a_bzrdir, revision_id=None):
1937
"""See WorkingTreeFormat.initialize()."""
1938
if not isinstance(a_bzrdir.transport, LocalTransport):
1939
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1940
branch = a_bzrdir.open_branch()
1941
if revision_id is not None:
1944
revision_history = branch.revision_history()
1946
position = revision_history.index(revision_id)
1948
raise errors.NoSuchRevision(branch, revision_id)
1949
branch.set_revision_history(revision_history[:position + 1])
1952
revision = branch.last_revision()
1954
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1960
wt._write_inventory(inv)
1961
wt.set_root_id(inv.root.file_id)
1962
basis_tree = branch.repository.revision_tree(revision)
1963
wt.set_parent_trees([(revision, basis_tree)])
1964
transform.build_tree(basis_tree, wt)
1968
super(WorkingTreeFormat2, self).__init__()
1969
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1971
def open(self, a_bzrdir, _found=False):
1972
"""Return the WorkingTree object for a_bzrdir
1974
_found is a private parameter, do not use it. It is used to indicate
1975
if format probing has already been done.
1978
# we are being called directly and must probe.
1979
raise NotImplementedError
1980
if not isinstance(a_bzrdir.transport, LocalTransport):
1981
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1982
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1988
class WorkingTreeFormat3(WorkingTreeFormat):
1989
"""The second working tree format updated to record a format marker.
1992
- exists within a metadir controlling .bzr
1993
- includes an explicit version marker for the workingtree control
1994
files, separate from the BzrDir format
1995
- modifies the hash cache format
1997
- uses a LockDir to guard access for writes.
2000
def get_format_string(self):
2001
"""See WorkingTreeFormat.get_format_string()."""
2002
return "Bazaar-NG Working Tree format 3"
2004
def get_format_description(self):
2005
"""See WorkingTreeFormat.get_format_description()."""
2006
return "Working tree format 3"
2008
_lock_file_name = 'lock'
2009
_lock_class = LockDir
2011
def _open_control_files(self, a_bzrdir):
2012
transport = a_bzrdir.get_workingtree_transport(None)
2013
return LockableFiles(transport, self._lock_file_name,
2016
def initialize(self, a_bzrdir, revision_id=None):
2017
"""See WorkingTreeFormat.initialize().
2019
revision_id allows creating a working tree at a different
2020
revision than the branch is at.
2022
if not isinstance(a_bzrdir.transport, LocalTransport):
2023
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2024
transport = a_bzrdir.get_workingtree_transport(self)
2025
control_files = self._open_control_files(a_bzrdir)
2026
control_files.create_lock()
2027
control_files.lock_write()
2028
control_files.put_utf8('format', self.get_format_string())
2029
branch = a_bzrdir.open_branch()
2030
if revision_id is None:
2031
revision_id = branch.last_revision()
2033
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2039
_control_files=control_files)
2040
wt.lock_tree_write()
2042
wt._write_inventory(inv)
2043
wt.set_root_id(inv.root.file_id)
2044
basis_tree = branch.repository.revision_tree(revision_id)
2045
if revision_id == NULL_REVISION:
2046
wt.set_parent_trees([])
2048
wt.set_parent_trees([(revision_id, basis_tree)])
2049
transform.build_tree(basis_tree, wt)
2052
control_files.unlock()
2056
super(WorkingTreeFormat3, self).__init__()
2057
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2059
def open(self, a_bzrdir, _found=False):
2060
"""Return the WorkingTree object for a_bzrdir
2062
_found is a private parameter, do not use it. It is used to indicate
2063
if format probing has already been done.
2066
# we are being called directly and must probe.
2067
raise NotImplementedError
2068
if not isinstance(a_bzrdir.transport, LocalTransport):
2069
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2070
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2072
def _open(self, a_bzrdir, control_files):
2073
"""Open the tree itself.
2075
:param a_bzrdir: the dir for the tree.
2076
:param control_files: the control files for the tree.
2078
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2082
_control_files=control_files)
2085
return self.get_format_string()
2088
# formats which have no format string are not discoverable
2089
# and not independently creatable, so are not registered.
2090
__default_format = WorkingTreeFormat3()
2091
WorkingTreeFormat.register_format(__default_format)
2092
WorkingTreeFormat.set_default_format(__default_format)
2093
_legacy_formats = [WorkingTreeFormat2(),
2097
class WorkingTreeTestProviderAdapter(object):
2098
"""A tool to generate a suite testing multiple workingtree formats at once.
2100
This is done by copying the test once for each transport and injecting
2101
the transport_server, transport_readonly_server, and workingtree_format
2102
classes into each copy. Each copy is also given a new id() to make it
2106
def __init__(self, transport_server, transport_readonly_server, formats):
2107
self._transport_server = transport_server
2108
self._transport_readonly_server = transport_readonly_server
2109
self._formats = formats
2111
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2112
"""Clone test for adaption."""
2113
new_test = deepcopy(test)
2114
new_test.transport_server = self._transport_server
2115
new_test.transport_readonly_server = self._transport_readonly_server
2116
new_test.bzrdir_format = bzrdir_format
2117
new_test.workingtree_format = workingtree_format
2118
def make_new_test_id():
2119
new_id = "%s(%s)" % (test.id(), variation)
2120
return lambda: new_id
2121
new_test.id = make_new_test_id()
2124
def adapt(self, test):
2125
from bzrlib.tests import TestSuite
2126
result = TestSuite()
2127
for workingtree_format, bzrdir_format in self._formats:
2128
new_test = self._clone_test(
2131
workingtree_format, workingtree_format.__class__.__name__)
2132
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
