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
from bzrlib.merge import merge_inner, transform_tree
87
import bzrlib.mutabletree
88
from bzrlib.mutabletree import needs_tree_write_lock
89
from bzrlib.osutils import (
101
from bzrlib.trace import mutter, note
102
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION
106
import bzrlib.revisiontree
107
from bzrlib.rio import RioReader, rio_file, Stanza
108
from bzrlib.symbol_versioning import (deprecated_passed,
111
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
# the regex removes any weird characters; we don't escape them
121
# but rather just pull them out
122
_gen_file_id_re = re.compile(r'[^\w.]')
123
_gen_id_suffix = None
127
def _next_id_suffix():
128
"""Create a new file id suffix that is reasonably unique.
130
On the first call we combine the current time with 64 bits of randomness
131
to give a highly probably globally unique number. Then each call in the same
132
process adds 1 to a serial number we append to that unique value.
134
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
135
# than having to move the id randomness out of the inner loop like this.
136
# XXX TODO: for the global randomness this uses we should add the thread-id
137
# before the serial #.
138
global _gen_id_suffix, _gen_id_serial
139
if _gen_id_suffix is None:
140
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
142
return _gen_id_suffix + str(_gen_id_serial)
145
def gen_file_id(name):
146
"""Return new file id for the basename 'name'.
148
The uniqueness is supplied from _next_id_suffix.
150
# The real randomness is in the _next_id_suffix, the
151
# rest of the identifier is just to be nice.
153
# 1) Remove non-ascii word characters to keep the ids portable
154
# 2) squash to lowercase, so the file id doesn't have to
155
# be escaped (case insensitive filesystems would bork for ids
156
# that only differred in case without escaping).
157
# 3) truncate the filename to 20 chars. Long filenames also bork on some
159
# 4) Removing starting '.' characters to prevent the file ids from
160
# being considered hidden.
161
ascii_word_only = _gen_file_id_re.sub('', name.lower())
162
short_no_dots = ascii_word_only.lstrip('.')[:20]
163
return short_no_dots + _next_id_suffix()
167
"""Return a new tree-root file id."""
168
return gen_file_id('TREE_ROOT')
171
class TreeEntry(object):
172
"""An entry that implements the minimum interface used by commands.
174
This needs further inspection, it may be better to have
175
InventoryEntries without ids - though that seems wrong. For now,
176
this is a parallel hierarchy to InventoryEntry, and needs to become
177
one of several things: decorates to that hierarchy, children of, or
179
Another note is that these objects are currently only used when there is
180
no InventoryEntry available - i.e. for unversioned objects.
181
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
184
def __eq__(self, other):
185
# yes, this us ugly, TODO: best practice __eq__ style.
186
return (isinstance(other, TreeEntry)
187
and other.__class__ == self.__class__)
189
def kind_character(self):
193
class TreeDirectory(TreeEntry):
194
"""See TreeEntry. This is a directory in a working tree."""
196
def __eq__(self, other):
197
return (isinstance(other, TreeDirectory)
198
and other.__class__ == self.__class__)
200
def kind_character(self):
204
class TreeFile(TreeEntry):
205
"""See TreeEntry. This is a regular file in a working tree."""
207
def __eq__(self, other):
208
return (isinstance(other, TreeFile)
209
and other.__class__ == self.__class__)
211
def kind_character(self):
215
class TreeLink(TreeEntry):
216
"""See TreeEntry. This is a symlink in a working tree."""
218
def __eq__(self, other):
219
return (isinstance(other, TreeLink)
220
and other.__class__ == self.__class__)
222
def kind_character(self):
226
class WorkingTree(bzrlib.mutabletree.MutableTree):
227
"""Working copy tree.
229
The inventory is held in the `Branch` working-inventory, and the
230
files are in a directory on disk.
232
It is possible for a `WorkingTree` to have a filename which is
233
not listed in the Inventory and vice versa.
236
def __init__(self, basedir='.',
237
branch=DEPRECATED_PARAMETER,
243
"""Construct a WorkingTree for basedir.
245
If the branch is not supplied, it is opened automatically.
246
If the branch is supplied, it must be the branch for this basedir.
247
(branch.base is not cross checked, because for remote branches that
248
would be meaningless).
250
self._format = _format
251
self.bzrdir = _bzrdir
253
# not created via open etc.
254
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
255
"Please use bzrdir.open_workingtree or WorkingTree.open().",
258
wt = WorkingTree.open(basedir)
259
self._branch = wt.branch
260
self.basedir = wt.basedir
261
self._control_files = wt._control_files
262
self._hashcache = wt._hashcache
263
self._set_inventory(wt._inventory)
264
self._format = wt._format
265
self.bzrdir = wt.bzrdir
266
from bzrlib.hashcache import HashCache
267
from bzrlib.trace import note, mutter
268
assert isinstance(basedir, basestring), \
269
"base directory %r is not a string" % basedir
270
basedir = safe_unicode(basedir)
271
mutter("opening working tree %r", basedir)
272
if deprecated_passed(branch):
274
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
275
" Please use bzrdir.open_workingtree() or"
276
" WorkingTree.open().",
280
self._branch = branch
282
self._branch = self.bzrdir.open_branch()
283
self.basedir = realpath(basedir)
284
# if branch is at our basedir and is a format 6 or less
285
if isinstance(self._format, WorkingTreeFormat2):
286
# share control object
287
self._control_files = self.branch.control_files
289
# assume all other formats have their own control files.
290
assert isinstance(_control_files, LockableFiles), \
291
"_control_files must be a LockableFiles, not %r" \
293
self._control_files = _control_files
294
# update the whole cache up front and write to disk if anything changed;
295
# in the future we might want to do this more selectively
296
# two possible ways offer themselves : in self._unlock, write the cache
297
# if needed, or, when the cache sees a change, append it to the hash
298
# cache file, and have the parser take the most recent entry for a
300
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
301
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
303
# is this scan needed ? it makes things kinda slow.
310
if _inventory is None:
311
self._set_inventory(self.read_working_inventory())
313
self._set_inventory(_inventory)
316
fget=lambda self: self._branch,
317
doc="""The branch this WorkingTree is connected to.
319
This cannot be set - it is reflective of the actual disk structure
320
the working tree has been constructed from.
323
def break_lock(self):
324
"""Break a lock if one is present from another instance.
326
Uses the ui factory to ask for confirmation if the lock may be from
329
This will probe the repository for its lock as well.
331
self._control_files.break_lock()
332
self.branch.break_lock()
334
def _set_inventory(self, inv):
335
assert inv.root is not None
336
self._inventory = inv
339
def open(path=None, _unsupported=False):
340
"""Open an existing working tree at path.
344
path = os.path.getcwdu()
345
control = bzrdir.BzrDir.open(path, _unsupported)
346
return control.open_workingtree(_unsupported)
349
def open_containing(path=None):
350
"""Open an existing working tree which has its root about path.
352
This probes for a working tree at path and searches upwards from there.
354
Basically we keep looking up until we find the control directory or
355
run into /. If there isn't one, raises NotBranchError.
356
TODO: give this a new exception.
357
If there is one, it is returned, along with the unused portion of path.
359
:return: The WorkingTree that contains 'path', and the rest of path
362
path = osutils.getcwd()
363
control, relpath = bzrdir.BzrDir.open_containing(path)
365
return control.open_workingtree(), relpath
368
def open_downlevel(path=None):
369
"""Open an unsupported working tree.
371
Only intended for advanced situations like upgrading part of a bzrdir.
373
return WorkingTree.open(path, _unsupported=True)
376
"""Iterate through file_ids for this tree.
378
file_ids are in a WorkingTree if they are in the working inventory
379
and the working file exists.
381
inv = self._inventory
382
for path, ie in inv.iter_entries():
383
if osutils.lexists(self.abspath(path)):
387
return "<%s of %s>" % (self.__class__.__name__,
388
getattr(self, 'basedir', None))
390
def abspath(self, filename):
391
return pathjoin(self.basedir, filename)
393
def basis_tree(self):
394
"""Return RevisionTree for the current last revision.
396
If the left most parent is a ghost then the returned tree will be an
397
empty tree - one obtained by calling repository.revision_tree(None).
400
revision_id = self.get_parent_ids()[0]
402
# no parents, return an empty revision tree.
403
# in the future this should return the tree for
404
# 'empty:' - the implicit root empty tree.
405
return self.branch.repository.revision_tree(None)
408
xml = self.read_basis_inventory()
409
inv = xml6.serializer_v6.read_inventory_from_string(xml)
410
if inv is not None and inv.revision_id == revision_id:
411
return bzrlib.tree.RevisionTree(self.branch.repository,
413
except (NoSuchFile, errors.BadInventoryFormat):
415
# No cached copy available, retrieve from the repository.
416
# FIXME? RBC 20060403 should we cache the inventory locally
419
return self.branch.repository.revision_tree(revision_id)
420
except errors.RevisionNotPresent:
421
# the basis tree *may* be a ghost or a low level error may have
422
# occured. If the revision is present, its a problem, if its not
424
if self.branch.repository.has_revision(revision_id):
426
# the basis tree is a ghost so return an empty tree.
427
return self.branch.repository.revision_tree(None)
430
@deprecated_method(zero_eight)
431
def create(branch, directory):
432
"""Create a workingtree for branch at directory.
434
If existing_directory already exists it must have a .bzr directory.
435
If it does not exist, it will be created.
437
This returns a new WorkingTree object for the new checkout.
439
TODO FIXME RBC 20060124 when we have checkout formats in place this
440
should accept an optional revisionid to checkout [and reject this if
441
checking out into the same dir as a pre-checkout-aware branch format.]
443
XXX: When BzrDir is present, these should be created through that
446
warnings.warn('delete WorkingTree.create', stacklevel=3)
447
transport = get_transport(directory)
448
if branch.bzrdir.root_transport.base == transport.base:
450
return branch.bzrdir.create_workingtree()
451
# different directory,
452
# create a branch reference
453
# and now a working tree.
454
raise NotImplementedError
457
@deprecated_method(zero_eight)
458
def create_standalone(directory):
459
"""Create a checkout and a branch and a repo at directory.
461
Directory must exist and be empty.
463
please use BzrDir.create_standalone_workingtree
465
return bzrdir.BzrDir.create_standalone_workingtree(directory)
467
def relpath(self, path):
468
"""Return the local path portion from a given path.
470
The path may be absolute or relative. If its a relative path it is
471
interpreted relative to the python current working directory.
473
return osutils.relpath(self.basedir, path)
475
def has_filename(self, filename):
476
return osutils.lexists(self.abspath(filename))
478
def get_file(self, file_id):
479
return self.get_file_byname(self.id2path(file_id))
481
def get_file_text(self, file_id):
482
return self.get_file(file_id).read()
484
def get_file_byname(self, filename):
485
return file(self.abspath(filename), 'rb')
487
def get_parent_ids(self):
488
"""See Tree.get_parent_ids.
490
This implementation reads the pending merges list and last_revision
491
value and uses that to decide what the parents list should be.
493
last_rev = self._last_revision()
499
merges_file = self._control_files.get_utf8('pending-merges')
503
for l in merges_file.readlines():
504
parents.append(l.rstrip('\n'))
507
def get_root_id(self):
508
"""Return the id of this trees root"""
509
inv = self.read_working_inventory()
510
return inv.root.file_id
512
def _get_store_filename(self, file_id):
513
## XXX: badly named; this is not in the store at all
514
return self.abspath(self.id2path(file_id))
517
def clone(self, to_bzrdir, revision_id=None, basis=None):
518
"""Duplicate this working tree into to_bzr, including all state.
520
Specifically modified files are kept as modified, but
521
ignored and unknown files are discarded.
523
If you want to make a new line of development, see bzrdir.sprout()
526
If not None, the cloned tree will have its last revision set to
527
revision, and and difference between the source trees last revision
528
and this one merged in.
531
If not None, a closer copy of a tree which may have some files in
532
common, and which file content should be preferentially copied from.
534
# assumes the target bzr dir format is compatible.
535
result = self._format.initialize(to_bzrdir)
536
self.copy_content_into(result, revision_id)
540
def copy_content_into(self, tree, revision_id=None):
541
"""Copy the current content and user files of this tree into tree."""
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()
1164
# TODO - dedup parents list with things merged by pull ?
1165
# reuse the revisiontree we merged against to set the new
1167
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1168
# we have to pull the merge trees out again, because
1169
# merge_inner has set the ids. - this corner is not yet
1170
# layered well enough to prevent double handling.
1171
merges = self.get_parent_ids()[1:]
1172
parent_trees.extend([
1173
(parent, repository.revision_tree(parent)) for
1175
self.set_parent_trees(parent_trees)
1182
def put_file_bytes_non_atomic(self, file_id, bytes):
1183
"""See MutableTree.put_file_bytes_non_atomic."""
1184
stream = file(self.id2abspath(file_id), 'wb')
1189
# TODO: update the hashcache here ?
1192
"""Yield all unknown files in this WorkingTree.
1194
If there are any unknown directories then only the directory is
1195
returned, not all its children. But if there are unknown files
1196
under a versioned subdirectory, they are returned.
1198
Currently returned depth-first, sorted by name within directories.
1200
## TODO: Work from given directory downwards
1201
for path, dir_entry in self.inventory.directories():
1202
# mutter("search for unknowns in %r", path)
1203
dirabs = self.abspath(path)
1204
if not isdir(dirabs):
1205
# e.g. directory deleted
1209
for subf in os.listdir(dirabs):
1212
if subf not in dir_entry.children:
1213
subf_norm, can_access = osutils.normalized_filename(subf)
1214
if subf_norm != subf and can_access:
1215
if subf_norm not in dir_entry.children:
1216
fl.append(subf_norm)
1222
subp = pathjoin(path, subf)
1225
def _translate_ignore_rule(self, rule):
1226
"""Translate a single ignore rule to a regex.
1228
There are two types of ignore rules. Those that do not contain a / are
1229
matched against the tail of the filename (that is, they do not care
1230
what directory the file is in.) Rules which do contain a slash must
1231
match the entire path. As a special case, './' at the start of the
1232
string counts as a slash in the string but is removed before matching
1233
(e.g. ./foo.c, ./src/foo.c)
1235
:return: The translated regex.
1237
if rule[:2] in ('./', '.\\'):
1239
result = fnmatch.translate(rule[2:])
1240
elif '/' in rule or '\\' in rule:
1242
result = fnmatch.translate(rule)
1244
# default rule style.
1245
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1246
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1247
return "(" + result + ")"
1249
def _combine_ignore_rules(self, rules):
1250
"""Combine a list of ignore rules into a single regex object.
1252
Each individual rule is combined with | to form a big regex, which then
1253
has $ added to it to form something like ()|()|()$. The group index for
1254
each subregex's outermost group is placed in a dictionary mapping back
1255
to the rule. This allows quick identification of the matching rule that
1257
:return: a list of the compiled regex and the matching-group index
1258
dictionaries. We return a list because python complains if you try to
1259
combine more than 100 regexes.
1264
translated_rules = []
1266
translated_rule = self._translate_ignore_rule(rule)
1267
compiled_rule = re.compile(translated_rule)
1268
groups[next_group] = rule
1269
next_group += compiled_rule.groups
1270
translated_rules.append(translated_rule)
1271
if next_group == 99:
1272
result.append((re.compile("|".join(translated_rules)), groups))
1275
translated_rules = []
1276
if len(translated_rules):
1277
result.append((re.compile("|".join(translated_rules)), groups))
1280
def ignored_files(self):
1281
"""Yield list of PATH, IGNORE_PATTERN"""
1282
for subp in self.extras():
1283
pat = self.is_ignored(subp)
1287
def get_ignore_list(self):
1288
"""Return list of ignore patterns.
1290
Cached in the Tree object after the first call.
1292
ignoreset = getattr(self, '_ignoreset', None)
1293
if ignoreset is not None:
1296
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1297
ignore_globs.update(ignores.get_runtime_ignores())
1299
ignore_globs.update(ignores.get_user_ignores())
1301
if self.has_filename(bzrlib.IGNORE_FILENAME):
1302
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1304
ignore_globs.update(ignores.parse_ignore_file(f))
1308
self._ignoreset = ignore_globs
1309
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1312
def _get_ignore_rules_as_regex(self):
1313
"""Return a regex of the ignore rules and a mapping dict.
1315
:return: (ignore rules compiled regex, dictionary mapping rule group
1316
indices to original rule.)
1318
if getattr(self, '_ignoreset', None) is None:
1319
self.get_ignore_list()
1320
return self._ignore_regex
1322
def is_ignored(self, filename):
1323
r"""Check whether the filename matches an ignore pattern.
1325
Patterns containing '/' or '\' need to match the whole path;
1326
others match against only the last component.
1328
If the file is ignored, returns the pattern which caused it to
1329
be ignored, otherwise None. So this can simply be used as a
1330
boolean if desired."""
1332
# TODO: Use '**' to match directories, and other extended
1333
# globbing stuff from cvs/rsync.
1335
# XXX: fnmatch is actually not quite what we want: it's only
1336
# approximately the same as real Unix fnmatch, and doesn't
1337
# treat dotfiles correctly and allows * to match /.
1338
# Eventually it should be replaced with something more
1341
rules = self._get_ignore_rules_as_regex()
1342
for regex, mapping in rules:
1343
match = regex.match(filename)
1344
if match is not None:
1345
# one or more of the groups in mapping will have a non-None
1347
groups = match.groups()
1348
rules = [mapping[group] for group in
1349
mapping if groups[group] is not None]
1353
def kind(self, file_id):
1354
return file_kind(self.id2abspath(file_id))
1356
def last_revision(self):
1357
"""Return the last revision of the branch for this tree.
1359
This format tree does not support a separate marker for last-revision
1360
compared to the branch.
1362
See MutableTree.last_revision
1364
return self._last_revision()
1367
def _last_revision(self):
1368
"""helper for get_parent_ids."""
1369
return self.branch.last_revision()
1371
def is_locked(self):
1372
return self._control_files.is_locked()
1374
def lock_read(self):
1375
"""See Branch.lock_read, and WorkingTree.unlock."""
1376
self.branch.lock_read()
1378
return self._control_files.lock_read()
1380
self.branch.unlock()
1383
def lock_tree_write(self):
1384
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1385
self.branch.lock_read()
1387
return self._control_files.lock_write()
1389
self.branch.unlock()
1392
def lock_write(self):
1393
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1394
self.branch.lock_write()
1396
return self._control_files.lock_write()
1398
self.branch.unlock()
1401
def get_physical_lock_status(self):
1402
return self._control_files.get_physical_lock_status()
1404
def _basis_inventory_name(self):
1405
return 'basis-inventory-cache'
1407
@needs_tree_write_lock
1408
def set_last_revision(self, new_revision):
1409
"""Change the last revision in the working tree."""
1410
if self._change_last_revision(new_revision):
1411
self._cache_basis_inventory(new_revision)
1413
def _change_last_revision(self, new_revision):
1414
"""Template method part of set_last_revision to perform the change.
1416
This is used to allow WorkingTree3 instances to not affect branch
1417
when their last revision is set.
1419
if new_revision is None:
1420
self.branch.set_revision_history([])
1423
self.branch.generate_revision_history(new_revision)
1424
except errors.NoSuchRevision:
1425
# not present in the repo - dont try to set it deeper than the tip
1426
self.branch.set_revision_history([new_revision])
1429
def _write_basis_inventory(self, xml):
1430
"""Write the basis inventory XML to the basis-inventory file"""
1431
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1432
path = self._basis_inventory_name()
1434
self._control_files.put(path, sio)
1436
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1437
"""Create the text that will be saved in basis-inventory"""
1438
inventory.revision_id = revision_id
1439
return xml6.serializer_v6.write_inventory_to_string(inventory)
1441
def _cache_basis_inventory(self, new_revision):
1442
"""Cache new_revision as the basis inventory."""
1443
# TODO: this should allow the ready-to-use inventory to be passed in,
1444
# as commit already has that ready-to-use [while the format is the
1447
# this double handles the inventory - unpack and repack -
1448
# but is easier to understand. We can/should put a conditional
1449
# in here based on whether the inventory is in the latest format
1450
# - perhaps we should repack all inventories on a repository
1452
# the fast path is to copy the raw xml from the repository. If the
1453
# xml contains 'revision_id="', then we assume the right
1454
# revision_id is set. We must check for this full string, because a
1455
# root node id can legitimately look like 'revision_id' but cannot
1457
xml = self.branch.repository.get_inventory_xml(new_revision)
1458
firstline = xml.split('\n', 1)[0]
1459
if (not 'revision_id="' in firstline or
1460
'format="6"' not in firstline):
1461
inv = self.branch.repository.deserialise_inventory(
1463
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1464
self._write_basis_inventory(xml)
1465
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1468
def read_basis_inventory(self):
1469
"""Read the cached basis inventory."""
1470
path = self._basis_inventory_name()
1471
return self._control_files.get(path).read()
1474
def read_working_inventory(self):
1475
"""Read the working inventory."""
1476
# ElementTree does its own conversion from UTF-8, so open in
1478
result = xml5.serializer_v5.read_inventory(
1479
self._control_files.get('inventory'))
1480
self._set_inventory(result)
1483
@needs_tree_write_lock
1484
def remove(self, files, verbose=False, to_file=None):
1485
"""Remove nominated files from the working inventory..
1487
This does not remove their text. This does not run on XXX on what? RBC
1489
TODO: Refuse to remove modified files unless --force is given?
1491
TODO: Do something useful with directories.
1493
TODO: Should this remove the text or not? Tough call; not
1494
removing may be useful and the user can just use use rm, and
1495
is the opposite of add. Removing it is consistent with most
1496
other tools. Maybe an option.
1498
## TODO: Normalize names
1499
## TODO: Remove nested loops; better scalability
1500
if isinstance(files, basestring):
1503
inv = self.inventory
1505
# do this before any modifications
1507
fid = inv.path2id(f)
1509
# TODO: Perhaps make this just a warning, and continue?
1510
# This tends to happen when
1511
raise NotVersionedError(path=f)
1513
# having remove it, it must be either ignored or unknown
1514
if self.is_ignored(f):
1518
textui.show_status(new_status, inv[fid].kind, f,
1522
self._write_inventory(inv)
1524
@needs_tree_write_lock
1525
def revert(self, filenames, old_tree=None, backups=True,
1526
pb=DummyProgress()):
1527
from bzrlib.conflicts import resolve
1528
if old_tree is None:
1529
old_tree = self.basis_tree()
1530
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1531
if not len(filenames):
1532
self.set_parent_ids(self.get_parent_ids()[:1])
1535
resolve(self, filenames, ignore_misses=True)
1538
# XXX: This method should be deprecated in favour of taking in a proper
1539
# new Inventory object.
1540
@needs_tree_write_lock
1541
def set_inventory(self, new_inventory_list):
1542
from bzrlib.inventory import (Inventory,
1547
inv = Inventory(self.get_root_id())
1548
for path, file_id, parent, kind in new_inventory_list:
1549
name = os.path.basename(path)
1552
# fixme, there should be a factory function inv,add_??
1553
if kind == 'directory':
1554
inv.add(InventoryDirectory(file_id, name, parent))
1555
elif kind == 'file':
1556
inv.add(InventoryFile(file_id, name, parent))
1557
elif kind == 'symlink':
1558
inv.add(InventoryLink(file_id, name, parent))
1560
raise BzrError("unknown kind %r" % kind)
1561
self._write_inventory(inv)
1563
@needs_tree_write_lock
1564
def set_root_id(self, file_id):
1565
"""Set the root id for this tree."""
1566
inv = self.read_working_inventory()
1567
orig_root_id = inv.root.file_id
1568
del inv._byid[inv.root.file_id]
1569
inv.root.file_id = file_id
1570
inv._byid[inv.root.file_id] = inv.root
1573
if entry.parent_id == orig_root_id:
1574
entry.parent_id = inv.root.file_id
1575
self._write_inventory(inv)
1578
"""See Branch.unlock.
1580
WorkingTree locking just uses the Branch locking facilities.
1581
This is current because all working trees have an embedded branch
1582
within them. IF in the future, we were to make branch data shareable
1583
between multiple working trees, i.e. via shared storage, then we
1584
would probably want to lock both the local tree, and the branch.
1586
raise NotImplementedError(self.unlock)
1590
"""Update a working tree along its branch.
1592
This will update the branch if its bound too, which means we have multiple trees involved:
1593
The new basis tree of the master.
1594
The old basis tree of the branch.
1595
The old basis tree of the working tree.
1596
The current working tree state.
1597
pathologically all three may be different, and non ancestors of each other.
1598
Conceptually we want to:
1599
Preserve the wt.basis->wt.state changes
1600
Transform the wt.basis to the new master basis.
1601
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1602
Restore the wt.basis->wt.state changes.
1604
There isn't a single operation at the moment to do that, so we:
1605
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1606
Do a 'normal' merge of the old branch basis if it is relevant.
1608
old_tip = self.branch.update()
1609
# here if old_tip is not None, it is the old tip of the branch before
1610
# it was updated from the master branch. This should become a pending
1611
# merge in the working tree to preserve the user existing work. we
1612
# cant set that until we update the working trees last revision to be
1613
# one from the new branch, because it will just get absorbed by the
1614
# parent de-duplication logic.
1616
# We MUST save it even if an error occurs, because otherwise the users
1617
# local work is unreferenced and will appear to have been lost.
1621
last_rev = self.get_parent_ids()[0]
1624
if last_rev != self.branch.last_revision():
1625
# merge tree state up to new branch tip.
1626
basis = self.basis_tree()
1627
to_tree = self.branch.basis_tree()
1628
result += merge.merge_inner(
1633
# TODO - dedup parents list with things merged by pull ?
1634
# reuse the tree we've updated to to set the basis:
1635
parent_trees = [(self.branch.last_revision(), to_tree)]
1636
merges = self.get_parent_ids()[1:]
1637
# Ideally we ask the tree for the trees here, that way the working
1638
# tree can decide whether to give us teh entire tree or give us a
1639
# lazy initialised tree. dirstate for instance will have the trees
1640
# in ram already, whereas a last-revision + basis-inventory tree
1641
# will not, but also does not need them when setting parents.
1642
for parent in merges:
1643
parent_trees.append(
1644
(parent, self.branch.repository.revision_tree(parent)))
1645
if old_tip is not None:
1646
parent_trees.append(
1647
(old_tip, self.branch.repository.revision_tree(old_tip)))
1648
self.set_parent_trees(parent_trees)
1649
last_rev = parent_trees[0][0]
1651
# the working tree had the same last-revision as the master
1652
# branch did. We may still have pivot local work from the local
1653
# branch into old_tip:
1654
if old_tip is not None:
1655
self.add_parent_tree_id(old_tip)
1656
if old_tip and old_tip != last_rev:
1657
# our last revision was not the prior branch last revision
1658
# and we have converted that last revision to a pending merge.
1659
# base is somewhere between the branch tip now
1660
# and the now pending merge
1661
from bzrlib.revision import common_ancestor
1663
base_rev_id = common_ancestor(self.branch.last_revision(),
1665
self.branch.repository)
1666
except errors.NoCommonAncestor:
1668
base_tree = self.branch.repository.revision_tree(base_rev_id)
1669
other_tree = self.branch.repository.revision_tree(old_tip)
1670
result += merge.merge_inner(
1677
@needs_tree_write_lock
1678
def _write_inventory(self, inv):
1679
"""Write inventory as the current inventory."""
1681
xml5.serializer_v5.write_inventory(inv, sio)
1683
self._control_files.put('inventory', sio)
1684
self._set_inventory(inv)
1685
mutter('wrote working inventory')
1687
def set_conflicts(self, arg):
1688
raise UnsupportedOperation(self.set_conflicts, self)
1690
def add_conflicts(self, arg):
1691
raise UnsupportedOperation(self.add_conflicts, self)
1694
def conflicts(self):
1695
conflicts = _mod_conflicts.ConflictList()
1696
for conflicted in self._iter_conflicts():
1699
if file_kind(self.abspath(conflicted)) != "file":
1701
except errors.NoSuchFile:
1704
for suffix in ('.THIS', '.OTHER'):
1706
kind = file_kind(self.abspath(conflicted+suffix))
1709
except errors.NoSuchFile:
1713
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1714
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1716
file_id=self.path2id(conflicted)))
1720
class WorkingTree2(WorkingTree):
1721
"""This is the Format 2 working tree.
1723
This was the first weave based working tree.
1724
- uses os locks for locking.
1725
- uses the branch last-revision.
1728
def lock_tree_write(self):
1729
"""See WorkingTree.lock_tree_write().
1731
In Format2 WorkingTrees we have a single lock for the branch and tree
1732
so lock_tree_write() degrades to lock_write().
1734
self.branch.lock_write()
1736
return self._control_files.lock_write()
1738
self.branch.unlock()
1742
# we share control files:
1743
if self._hashcache.needs_write and self._control_files._lock_count==3:
1744
self._hashcache.write()
1745
# reverse order of locking.
1747
return self._control_files.unlock()
1749
self.branch.unlock()
1752
class WorkingTree3(WorkingTree):
1753
"""This is the Format 3 working tree.
1755
This differs from the base WorkingTree by:
1756
- having its own file lock
1757
- having its own last-revision property.
1759
This is new in bzr 0.8
1763
def _last_revision(self):
1764
"""See Mutable.last_revision."""
1766
return self._control_files.get_utf8('last-revision').read()
1770
def _change_last_revision(self, revision_id):
1771
"""See WorkingTree._change_last_revision."""
1772
if revision_id is None or revision_id == NULL_REVISION:
1774
self._control_files._transport.delete('last-revision')
1775
except errors.NoSuchFile:
1779
self._control_files.put_utf8('last-revision', revision_id)
1782
@needs_tree_write_lock
1783
def set_conflicts(self, conflicts):
1784
self._put_rio('conflicts', conflicts.to_stanzas(),
1787
@needs_tree_write_lock
1788
def add_conflicts(self, new_conflicts):
1789
conflict_set = set(self.conflicts())
1790
conflict_set.update(set(list(new_conflicts)))
1791
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1792
key=_mod_conflicts.Conflict.sort_key)))
1795
def conflicts(self):
1797
confile = self._control_files.get('conflicts')
1799
return _mod_conflicts.ConflictList()
1801
if confile.next() != CONFLICT_HEADER_1 + '\n':
1802
raise ConflictFormatError()
1803
except StopIteration:
1804
raise ConflictFormatError()
1805
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1808
if self._hashcache.needs_write and self._control_files._lock_count==1:
1809
self._hashcache.write()
1810
# reverse order of locking.
1812
return self._control_files.unlock()
1814
self.branch.unlock()
1817
def get_conflicted_stem(path):
1818
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1819
if path.endswith(suffix):
1820
return path[:-len(suffix)]
1822
@deprecated_function(zero_eight)
1823
def is_control_file(filename):
1824
"""See WorkingTree.is_control_filename(filename)."""
1825
## FIXME: better check
1826
filename = normpath(filename)
1827
while filename != '':
1828
head, tail = os.path.split(filename)
1829
## mutter('check %r for control file' % ((head, tail),))
1832
if filename == head:
1838
class WorkingTreeFormat(object):
1839
"""An encapsulation of the initialization and open routines for a format.
1841
Formats provide three things:
1842
* An initialization routine,
1846
Formats are placed in an dict by their format string for reference
1847
during workingtree opening. Its not required that these be instances, they
1848
can be classes themselves with class methods - it simply depends on
1849
whether state is needed for a given format or not.
1851
Once a format is deprecated, just deprecate the initialize and open
1852
methods on the format class. Do not deprecate the object, as the
1853
object will be created every time regardless.
1856
_default_format = None
1857
"""The default format used for new trees."""
1860
"""The known formats."""
1863
def find_format(klass, a_bzrdir):
1864
"""Return the format for the working tree object in a_bzrdir."""
1866
transport = a_bzrdir.get_workingtree_transport(None)
1867
format_string = transport.get("format").read()
1868
return klass._formats[format_string]
1870
raise errors.NoWorkingTree(base=transport.base)
1872
raise errors.UnknownFormatError(format=format_string)
1875
def get_default_format(klass):
1876
"""Return the current default format."""
1877
return klass._default_format
1879
def get_format_string(self):
1880
"""Return the ASCII format string that identifies this format."""
1881
raise NotImplementedError(self.get_format_string)
1883
def get_format_description(self):
1884
"""Return the short description for this format."""
1885
raise NotImplementedError(self.get_format_description)
1887
def is_supported(self):
1888
"""Is this format supported?
1890
Supported formats can be initialized and opened.
1891
Unsupported formats may not support initialization or committing or
1892
some other features depending on the reason for not being supported.
1897
def register_format(klass, format):
1898
klass._formats[format.get_format_string()] = format
1901
def set_default_format(klass, format):
1902
klass._default_format = format
1905
def unregister_format(klass, format):
1906
assert klass._formats[format.get_format_string()] is format
1907
del klass._formats[format.get_format_string()]
1911
class WorkingTreeFormat2(WorkingTreeFormat):
1912
"""The second working tree format.
1914
This format modified the hash cache from the format 1 hash cache.
1917
def get_format_description(self):
1918
"""See WorkingTreeFormat.get_format_description()."""
1919
return "Working tree format 2"
1921
def stub_initialize_remote(self, control_files):
1922
"""As a special workaround create critical control files for a remote working tree
1924
This ensures that it can later be updated and dealt with locally,
1925
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1926
no working tree. (See bug #43064).
1930
xml5.serializer_v5.write_inventory(inv, sio)
1932
control_files.put('inventory', sio)
1934
control_files.put_utf8('pending-merges', '')
1937
def initialize(self, a_bzrdir, revision_id=None):
1938
"""See WorkingTreeFormat.initialize()."""
1939
if not isinstance(a_bzrdir.transport, LocalTransport):
1940
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1941
branch = a_bzrdir.open_branch()
1942
if revision_id is not None:
1945
revision_history = branch.revision_history()
1947
position = revision_history.index(revision_id)
1949
raise errors.NoSuchRevision(branch, revision_id)
1950
branch.set_revision_history(revision_history[:position + 1])
1953
revision = branch.last_revision()
1955
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1961
wt._write_inventory(inv)
1962
wt.set_root_id(inv.root.file_id)
1963
basis_tree = branch.repository.revision_tree(revision)
1964
wt.set_parent_trees([(revision, basis_tree)])
1965
transform.build_tree(basis_tree, wt)
1969
super(WorkingTreeFormat2, self).__init__()
1970
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1972
def open(self, a_bzrdir, _found=False):
1973
"""Return the WorkingTree object for a_bzrdir
1975
_found is a private parameter, do not use it. It is used to indicate
1976
if format probing has already been done.
1979
# we are being called directly and must probe.
1980
raise NotImplementedError
1981
if not isinstance(a_bzrdir.transport, LocalTransport):
1982
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1983
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1989
class WorkingTreeFormat3(WorkingTreeFormat):
1990
"""The second working tree format updated to record a format marker.
1993
- exists within a metadir controlling .bzr
1994
- includes an explicit version marker for the workingtree control
1995
files, separate from the BzrDir format
1996
- modifies the hash cache format
1998
- uses a LockDir to guard access for writes.
2001
def get_format_string(self):
2002
"""See WorkingTreeFormat.get_format_string()."""
2003
return "Bazaar-NG Working Tree format 3"
2005
def get_format_description(self):
2006
"""See WorkingTreeFormat.get_format_description()."""
2007
return "Working tree format 3"
2009
_lock_file_name = 'lock'
2010
_lock_class = LockDir
2012
def _open_control_files(self, a_bzrdir):
2013
transport = a_bzrdir.get_workingtree_transport(None)
2014
return LockableFiles(transport, self._lock_file_name,
2017
def initialize(self, a_bzrdir, revision_id=None):
2018
"""See WorkingTreeFormat.initialize().
2020
revision_id allows creating a working tree at a different
2021
revision than the branch is at.
2023
if not isinstance(a_bzrdir.transport, LocalTransport):
2024
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2025
transport = a_bzrdir.get_workingtree_transport(self)
2026
control_files = self._open_control_files(a_bzrdir)
2027
control_files.create_lock()
2028
control_files.lock_write()
2029
control_files.put_utf8('format', self.get_format_string())
2030
branch = a_bzrdir.open_branch()
2031
if revision_id is None:
2032
revision_id = branch.last_revision()
2034
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2040
_control_files=control_files)
2041
wt.lock_tree_write()
2043
wt._write_inventory(inv)
2044
wt.set_root_id(inv.root.file_id)
2045
basis_tree = branch.repository.revision_tree(revision_id)
2046
if revision_id == NULL_REVISION:
2047
wt.set_parent_trees([])
2049
wt.set_parent_trees([(revision_id, basis_tree)])
2050
transform.build_tree(basis_tree, wt)
2053
control_files.unlock()
2057
super(WorkingTreeFormat3, self).__init__()
2058
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2060
def open(self, a_bzrdir, _found=False):
2061
"""Return the WorkingTree object for a_bzrdir
2063
_found is a private parameter, do not use it. It is used to indicate
2064
if format probing has already been done.
2067
# we are being called directly and must probe.
2068
raise NotImplementedError
2069
if not isinstance(a_bzrdir.transport, LocalTransport):
2070
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2071
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2073
def _open(self, a_bzrdir, control_files):
2074
"""Open the tree itself.
2076
:param a_bzrdir: the dir for the tree.
2077
:param control_files: the control files for the tree.
2079
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2083
_control_files=control_files)
2086
return self.get_format_string()
2089
# formats which have no format string are not discoverable
2090
# and not independently creatable, so are not registered.
2091
__default_format = WorkingTreeFormat3()
2092
WorkingTreeFormat.register_format(__default_format)
2093
WorkingTreeFormat.set_default_format(__default_format)
2094
_legacy_formats = [WorkingTreeFormat2(),
2098
class WorkingTreeTestProviderAdapter(object):
2099
"""A tool to generate a suite testing multiple workingtree formats at once.
2101
This is done by copying the test once for each transport and injecting
2102
the transport_server, transport_readonly_server, and workingtree_format
2103
classes into each copy. Each copy is also given a new id() to make it
2107
def __init__(self, transport_server, transport_readonly_server, formats):
2108
self._transport_server = transport_server
2109
self._transport_readonly_server = transport_readonly_server
2110
self._formats = formats
2112
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2113
"""Clone test for adaption."""
2114
new_test = deepcopy(test)
2115
new_test.transport_server = self._transport_server
2116
new_test.transport_readonly_server = self._transport_readonly_server
2117
new_test.bzrdir_format = bzrdir_format
2118
new_test.workingtree_format = workingtree_format
2119
def make_new_test_id():
2120
new_id = "%s(%s)" % (test.id(), variation)
2121
return lambda: new_id
2122
new_test.id = make_new_test_id()
2125
def adapt(self, test):
2126
from bzrlib.tests import TestSuite
2127
result = TestSuite()
2128
for workingtree_format, bzrdir_format in self._formats:
2129
new_test = self._clone_test(
2132
workingtree_format, workingtree_format.__class__.__name__)
2133
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
