1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
101
from bzrlib.trace import mutter, note
102
from bzrlib.transform import build_tree
103
from bzrlib.transport import get_transport
104
from bzrlib.transport.local import LocalTransport
105
from bzrlib.textui import show_status
111
# the regex removes any weird characters; we don't escape them
112
# but rather just pull them out
113
_gen_file_id_re = re.compile(r'[^\w.]')
114
_gen_id_suffix = None
118
def _next_id_suffix():
119
"""Create a new file id suffix that is reasonably unique.
121
On the first call we combine the current time with 64 bits of randomness
122
to give a highly probably globally unique number. Then each call in the same
123
process adds 1 to a serial number we append to that unique value.
125
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
126
# than having to move the id randomness out of the inner loop like this.
127
# XXX TODO: for the global randomness this uses we should add the thread-id
128
# before the serial #.
129
global _gen_id_suffix, _gen_id_serial
130
if _gen_id_suffix is None:
131
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
133
return _gen_id_suffix + str(_gen_id_serial)
136
def gen_file_id(name):
137
"""Return new file id for the basename 'name'.
139
The uniqueness is supplied from _next_id_suffix.
141
# The real randomness is in the _next_id_suffix, the
142
# rest of the identifier is just to be nice.
144
# 1) Remove non-ascii word characters to keep the ids portable
145
# 2) squash to lowercase, so the file id doesn't have to
146
# be escaped (case insensitive filesystems would bork for ids
147
# that only differred in case without escaping).
148
# 3) truncate the filename to 20 chars. Long filenames also bork on some
150
# 4) Removing starting '.' characters to prevent the file ids from
151
# being considered hidden.
152
ascii_word_only = _gen_file_id_re.sub('', name.lower())
153
short_no_dots = ascii_word_only.lstrip('.')[:20]
154
return short_no_dots + _next_id_suffix()
158
"""Return a new tree-root file id."""
159
return gen_file_id('TREE_ROOT')
162
class TreeEntry(object):
163
"""An entry that implements the minimum interface used by commands.
165
This needs further inspection, it may be better to have
166
InventoryEntries without ids - though that seems wrong. For now,
167
this is a parallel hierarchy to InventoryEntry, and needs to become
168
one of several things: decorates to that hierarchy, children of, or
170
Another note is that these objects are currently only used when there is
171
no InventoryEntry available - i.e. for unversioned objects.
172
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
175
def __eq__(self, other):
176
# yes, this us ugly, TODO: best practice __eq__ style.
177
return (isinstance(other, TreeEntry)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeDirectory(TreeEntry):
185
"""See TreeEntry. This is a directory in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeDirectory)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class TreeFile(TreeEntry):
196
"""See TreeEntry. This is a regular file in a working tree."""
198
def __eq__(self, other):
199
return (isinstance(other, TreeFile)
200
and other.__class__ == self.__class__)
202
def kind_character(self):
206
class TreeLink(TreeEntry):
207
"""See TreeEntry. This is a symlink in a working tree."""
209
def __eq__(self, other):
210
return (isinstance(other, TreeLink)
211
and other.__class__ == self.__class__)
213
def kind_character(self):
217
class WorkingTree(bzrlib.tree.Tree):
218
"""Working copy tree.
220
The inventory is held in the `Branch` working-inventory, and the
221
files are in a directory on disk.
223
It is possible for a `WorkingTree` to have a filename which is
224
not listed in the Inventory and vice versa.
227
def __init__(self, basedir='.',
228
branch=DEPRECATED_PARAMETER,
234
"""Construct a WorkingTree for basedir.
236
If the branch is not supplied, it is opened automatically.
237
If the branch is supplied, it must be the branch for this basedir.
238
(branch.base is not cross checked, because for remote branches that
239
would be meaningless).
241
self._format = _format
242
self.bzrdir = _bzrdir
244
# not created via open etc.
245
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
246
"Please use bzrdir.open_workingtree or WorkingTree.open().",
249
wt = WorkingTree.open(basedir)
250
self._branch = wt.branch
251
self.basedir = wt.basedir
252
self._control_files = wt._control_files
253
self._hashcache = wt._hashcache
254
self._set_inventory(wt._inventory)
255
self._format = wt._format
256
self.bzrdir = wt.bzrdir
257
from bzrlib.hashcache import HashCache
258
from bzrlib.trace import note, mutter
259
assert isinstance(basedir, basestring), \
260
"base directory %r is not a string" % basedir
261
basedir = safe_unicode(basedir)
262
mutter("opening working tree %r", basedir)
263
if deprecated_passed(branch):
265
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
266
" Please use bzrdir.open_workingtree() or"
267
" WorkingTree.open().",
271
self._branch = branch
273
self._branch = self.bzrdir.open_branch()
274
self.basedir = realpath(basedir)
275
# if branch is at our basedir and is a format 6 or less
276
if isinstance(self._format, WorkingTreeFormat2):
277
# share control object
278
self._control_files = self.branch.control_files
280
# assume all other formats have their own control files.
281
assert isinstance(_control_files, LockableFiles), \
282
"_control_files must be a LockableFiles, not %r" \
284
self._control_files = _control_files
285
# update the whole cache up front and write to disk if anything changed;
286
# in the future we might want to do this more selectively
287
# two possible ways offer themselves : in self._unlock, write the cache
288
# if needed, or, when the cache sees a change, append it to the hash
289
# cache file, and have the parser take the most recent entry for a
291
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
292
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
294
# is this scan needed ? it makes things kinda slow.
301
if _inventory is None:
302
self._set_inventory(self.read_working_inventory())
304
self._set_inventory(_inventory)
307
fget=lambda self: self._branch,
308
doc="""The branch this WorkingTree is connected to.
310
This cannot be set - it is reflective of the actual disk structure
311
the working tree has been constructed from.
314
def break_lock(self):
315
"""Break a lock if one is present from another instance.
317
Uses the ui factory to ask for confirmation if the lock may be from
320
This will probe the repository for its lock as well.
322
self._control_files.break_lock()
323
self.branch.break_lock()
325
def _set_inventory(self, inv):
326
assert inv.root is not None
327
self._inventory = inv
328
self.path2id = self._inventory.path2id
330
def is_control_filename(self, filename):
331
"""True if filename is the name of a control file in this tree.
333
:param filename: A filename within the tree. This is a relative path
334
from the root of this tree.
336
This is true IF and ONLY IF the filename is part of the meta data
337
that bzr controls in this tree. I.E. a random .bzr directory placed
338
on disk will not be a control file for this tree.
340
return self.bzrdir.is_control_filename(filename)
343
def open(path=None, _unsupported=False):
344
"""Open an existing working tree at path.
348
path = os.path.getcwdu()
349
control = bzrdir.BzrDir.open(path, _unsupported)
350
return control.open_workingtree(_unsupported)
353
def open_containing(path=None):
354
"""Open an existing working tree which has its root about path.
356
This probes for a working tree at path and searches upwards from there.
358
Basically we keep looking up until we find the control directory or
359
run into /. If there isn't one, raises NotBranchError.
360
TODO: give this a new exception.
361
If there is one, it is returned, along with the unused portion of path.
363
:return: The WorkingTree that contains 'path', and the rest of path
366
path = osutils.getcwd()
367
control, relpath = bzrdir.BzrDir.open_containing(path)
369
return control.open_workingtree(), relpath
372
def open_downlevel(path=None):
373
"""Open an unsupported working tree.
375
Only intended for advanced situations like upgrading part of a bzrdir.
377
return WorkingTree.open(path, _unsupported=True)
380
"""Iterate through file_ids for this tree.
382
file_ids are in a WorkingTree if they are in the working inventory
383
and the working file exists.
385
inv = self._inventory
386
for path, ie in inv.iter_entries():
387
if osutils.lexists(self.abspath(path)):
391
return "<%s of %s>" % (self.__class__.__name__,
392
getattr(self, 'basedir', None))
394
def abspath(self, filename):
395
return pathjoin(self.basedir, filename)
397
def basis_tree(self):
398
"""Return RevisionTree for the current last revision.
400
If the left most parent is a ghost then the returned tree will be an
401
empty tree - one obtained by calling repository.revision_tree(None).
404
revision_id = self.get_parent_ids()[0]
406
# no parents, return an empty revision tree.
407
# in the future this should return the tree for
408
# 'empty:' - the implicit root empty tree.
409
return self.branch.repository.revision_tree(None)
412
xml = self.read_basis_inventory()
413
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
414
inv.root.revision = revision_id
417
if inv is not None and inv.revision_id == revision_id:
418
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
420
# No cached copy available, retrieve from the repository.
421
# FIXME? RBC 20060403 should we cache the inventory locally
424
return self.branch.repository.revision_tree(revision_id)
425
except errors.RevisionNotPresent:
426
# the basis tree *may* be a ghost or a low level error may have
427
# occured. If the revision is present, its a problem, if its not
429
if self.branch.repository.has_revision(revision_id):
431
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(None)
435
@deprecated_method(zero_eight)
436
def create(branch, directory):
437
"""Create a workingtree for branch at directory.
439
If existing_directory already exists it must have a .bzr directory.
440
If it does not exist, it will be created.
442
This returns a new WorkingTree object for the new checkout.
444
TODO FIXME RBC 20060124 when we have checkout formats in place this
445
should accept an optional revisionid to checkout [and reject this if
446
checking out into the same dir as a pre-checkout-aware branch format.]
448
XXX: When BzrDir is present, these should be created through that
451
warnings.warn('delete WorkingTree.create', stacklevel=3)
452
transport = get_transport(directory)
453
if branch.bzrdir.root_transport.base == transport.base:
455
return branch.bzrdir.create_workingtree()
456
# different directory,
457
# create a branch reference
458
# and now a working tree.
459
raise NotImplementedError
462
@deprecated_method(zero_eight)
463
def create_standalone(directory):
464
"""Create a checkout and a branch and a repo at directory.
466
Directory must exist and be empty.
468
please use BzrDir.create_standalone_workingtree
470
return bzrdir.BzrDir.create_standalone_workingtree(directory)
472
def relpath(self, path):
473
"""Return the local path portion from a given path.
475
The path may be absolute or relative. If its a relative path it is
476
interpreted relative to the python current working directory.
478
return relpath(self.basedir, path)
480
def has_filename(self, filename):
481
return osutils.lexists(self.abspath(filename))
483
def get_file(self, file_id):
484
return self.get_file_byname(self.id2path(file_id))
486
def get_file_text(self, file_id):
487
return self.get_file(file_id).read()
489
def get_file_byname(self, filename):
490
return file(self.abspath(filename), 'rb')
492
def get_parent_ids(self):
493
"""See Tree.get_parent_ids.
495
This implementation reads the pending merges list and last_revision
496
value and uses that to decide what the parents list should be.
498
last_rev = self._last_revision()
504
merges_file = self._control_files.get_utf8('pending-merges')
508
for l in merges_file.readlines():
509
parents.append(l.rstrip('\n'))
512
def get_root_id(self):
513
"""Return the id of this trees root"""
514
inv = self.read_working_inventory()
515
return inv.root.file_id
517
def _get_store_filename(self, file_id):
518
## XXX: badly named; this is not in the store at all
519
return self.abspath(self.id2path(file_id))
522
def clone(self, to_bzrdir, revision_id=None, basis=None):
523
"""Duplicate this working tree into to_bzr, including all state.
525
Specifically modified files are kept as modified, but
526
ignored and unknown files are discarded.
528
If you want to make a new line of development, see bzrdir.sprout()
531
If not None, the cloned tree will have its last revision set to
532
revision, and and difference between the source trees last revision
533
and this one merged in.
536
If not None, a closer copy of a tree which may have some files in
537
common, and which file content should be preferentially copied from.
539
# assumes the target bzr dir format is compatible.
540
result = self._format.initialize(to_bzrdir)
541
self.copy_content_into(result, revision_id)
545
def copy_content_into(self, tree, revision_id=None):
546
"""Copy the current content and user files of this tree into tree."""
547
tree.set_root_id(self.get_root_id())
548
if revision_id is None:
549
transform_tree(tree, self)
551
# TODO now merge from tree.last_revision to revision (to preserve
552
# user local changes)
553
transform_tree(tree, self)
554
tree.set_parent_ids([revision_id])
557
def commit(self, message=None, revprops=None, *args, **kwargs):
558
# avoid circular imports
559
from bzrlib.commit import Commit
562
if not 'branch-nick' in revprops:
563
revprops['branch-nick'] = self.branch.nick
564
# args for wt.commit start at message from the Commit.commit method,
565
# but with branch a kwarg now, passing in args as is results in the
566
#message being used for the branch
567
args = (DEPRECATED_PARAMETER, message, ) + args
568
committed_id = Commit().commit( working_tree=self, revprops=revprops,
572
def id2abspath(self, file_id):
573
return self.abspath(self.id2path(file_id))
575
def has_id(self, file_id):
576
# files that have been deleted are excluded
577
inv = self._inventory
578
if not inv.has_id(file_id):
580
path = inv.id2path(file_id)
581
return osutils.lexists(self.abspath(path))
583
def has_or_had_id(self, file_id):
584
if file_id == self.inventory.root.file_id:
586
return self.inventory.has_id(file_id)
588
__contains__ = has_id
590
def get_file_size(self, file_id):
591
return os.path.getsize(self.id2abspath(file_id))
594
def get_file_sha1(self, file_id, path=None):
596
path = self._inventory.id2path(file_id)
597
return self._hashcache.get_sha1(path)
599
def get_file_mtime(self, file_id, path=None):
601
path = self._inventory.id2path(file_id)
602
return os.lstat(self.abspath(path)).st_mtime
604
if not supports_executable():
605
def is_executable(self, file_id, path=None):
606
return self._inventory[file_id].executable
608
def is_executable(self, file_id, path=None):
610
path = self._inventory.id2path(file_id)
611
mode = os.lstat(self.abspath(path)).st_mode
612
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
615
def add(self, files, ids=None):
616
"""Make files versioned.
618
Note that the command line normally calls smart_add instead,
619
which can automatically recurse.
621
This adds the files to the inventory, so that they will be
622
recorded by the next commit.
625
List of paths to add, relative to the base of the tree.
628
If set, use these instead of automatically generated ids.
629
Must be the same length as the list of files, but may
630
contain None for ids that are to be autogenerated.
632
TODO: Perhaps have an option to add the ids even if the files do
635
TODO: Perhaps callback with the ids and paths as they're added.
637
# TODO: Re-adding a file that is removed in the working copy
638
# should probably put it back with the previous ID.
639
if isinstance(files, basestring):
640
assert(ids is None or isinstance(ids, basestring))
646
ids = [None] * len(files)
648
assert(len(ids) == len(files))
650
inv = self.read_working_inventory()
651
for f,file_id in zip(files, ids):
652
if self.is_control_filename(f):
653
raise errors.ForbiddenControlFileError(filename=f)
658
raise BzrError("cannot add top-level %r" % f)
660
fullpath = normpath(self.abspath(f))
662
kind = file_kind(fullpath)
664
if e.errno == errno.ENOENT:
665
raise NoSuchFile(fullpath)
666
if not InventoryEntry.versionable_kind(kind):
667
raise errors.BadFileKindError(filename=f, kind=kind)
669
inv.add_path(f, kind=kind)
671
inv.add_path(f, kind=kind, file_id=file_id)
673
self._write_inventory(inv)
676
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
677
"""Add revision_id as a parent.
679
This is equivalent to retrieving the current list of parent ids
680
and setting the list to its value plus revision_id.
682
:param revision_id: The revision id to add to the parent list. It may
683
be a ghost revision as long as its not the first parent to be added,
684
or the allow_leftmost_as_ghost parameter is set True.
685
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
687
parents = self.get_parent_ids() + [revision_id]
688
self.set_parent_ids(parents,
689
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
692
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
693
"""Add revision_id, tree tuple as a parent.
695
This is equivalent to retrieving the current list of parent trees
696
and setting the list to its value plus parent_tuple. See also
697
add_parent_tree_id - if you only have a parent id available it will be
698
simpler to use that api. If you have the parent already available, using
699
this api is preferred.
701
:param parent_tuple: The (revision id, tree) to add to the parent list.
702
If the revision_id is a ghost, pass None for the tree.
703
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
705
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
706
if len(parent_ids) > 1:
707
# the leftmost may have already been a ghost, preserve that if it
709
allow_leftmost_as_ghost = True
710
self.set_parent_ids(parent_ids,
711
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
714
def add_pending_merge(self, *revision_ids):
715
# TODO: Perhaps should check at this point that the
716
# history of the revision is actually present?
717
parents = self.get_parent_ids()
719
for rev_id in revision_ids:
720
if rev_id in parents:
722
parents.append(rev_id)
725
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
727
@deprecated_method(zero_eleven)
729
def pending_merges(self):
730
"""Return a list of pending merges.
732
These are revisions that have been merged into the working
733
directory but not yet committed.
735
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
736
instead - which is available on all tree objects.
738
return self.get_parent_ids()[1:]
741
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
742
"""Set the parent ids to revision_ids.
744
See also set_parent_trees. This api will try to retrieve the tree data
745
for each element of revision_ids from the trees repository. If you have
746
tree data already available, it is more efficient to use
747
set_parent_trees rather than set_parent_ids. set_parent_ids is however
748
an easier API to use.
750
:param revision_ids: The revision_ids to set as the parent ids of this
751
working tree. Any of these may be ghosts.
753
if len(revision_ids) > 0:
754
leftmost_id = revision_ids[0]
755
if (not allow_leftmost_as_ghost and not
756
self.branch.repository.has_revision(leftmost_id)):
757
raise errors.GhostRevisionUnusableHere(leftmost_id)
758
self.set_last_revision(leftmost_id)
760
self.set_last_revision(None)
761
merges = revision_ids[1:]
762
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
765
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
766
"""Set the parents of the working tree.
768
:param parents_list: A list of (revision_id, tree) tuples.
769
If tree is None, then that element is treated as an unreachable
770
parent tree - i.e. a ghost.
772
# parent trees are not used in current format trees, delegate to
774
self.set_parent_ids([rev for (rev, tree) in parents_list],
775
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
778
def set_pending_merges(self, rev_list):
779
parents = self.get_parent_ids()
780
leftmost = parents[:1]
781
new_parents = leftmost + rev_list
782
self.set_parent_ids(new_parents)
785
def set_merge_modified(self, modified_hashes):
787
for file_id, hash in modified_hashes.iteritems():
788
yield Stanza(file_id=file_id, hash=hash)
789
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
792
def _put_rio(self, filename, stanzas, header):
793
my_file = rio_file(stanzas, header)
794
self._control_files.put(filename, my_file)
797
def merge_from_branch(self, branch, to_revision=None):
798
"""Merge from a branch into this working tree.
800
:param branch: The branch to merge from.
801
:param to_revision: If non-None, the merge will merge to to_revision, but
802
not beyond it. to_revision does not need to be in the history of
803
the branch when it is supplied. If None, to_revision defaults to
804
branch.last_revision().
806
from bzrlib.merge import Merger, Merge3Merger
807
pb = bzrlib.ui.ui_factory.nested_progress_bar()
809
merger = Merger(self.branch, this_tree=self, pb=pb)
810
merger.pp = ProgressPhase("Merge phase", 5, pb)
811
merger.pp.next_phase()
812
# check that there are no
814
merger.check_basis(check_clean=True, require_commits=False)
815
if to_revision is None:
816
to_revision = branch.last_revision()
817
merger.other_rev_id = to_revision
818
if merger.other_rev_id is None:
819
raise error.NoCommits(branch)
820
self.branch.fetch(branch, last_revision=merger.other_rev_id)
821
merger.other_basis = merger.other_rev_id
822
merger.other_tree = self.branch.repository.revision_tree(
824
merger.pp.next_phase()
826
if merger.base_rev_id == merger.other_rev_id:
827
raise errors.PointlessMerge
828
merger.backup_files = False
829
merger.merge_type = Merge3Merger
830
merger.set_interesting_files(None)
831
merger.show_base = False
832
merger.reprocess = False
833
conflicts = merger.do_merge()
840
def merge_modified(self):
842
hashfile = self._control_files.get('merge-hashes')
847
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
848
raise MergeModifiedFormatError()
849
except StopIteration:
850
raise MergeModifiedFormatError()
851
for s in RioReader(hashfile):
852
file_id = s.get("file_id")
853
if file_id not in self.inventory:
856
if hash == self.get_file_sha1(file_id):
857
merge_hashes[file_id] = hash
860
def get_symlink_target(self, file_id):
861
return os.readlink(self.id2abspath(file_id))
863
def file_class(self, filename):
864
if self.path2id(filename):
866
elif self.is_ignored(filename):
871
def list_files(self, include_root=False):
872
"""Recursively list all files as (path, class, kind, id, entry).
874
Lists, but does not descend into unversioned directories.
876
This does not include files that have been deleted in this
879
Skips the control directory.
881
inv = self._inventory
882
# Convert these into local objects to save lookup times
883
pathjoin = osutils.pathjoin
884
file_kind = osutils.file_kind
886
# transport.base ends in a slash, we want the piece
887
# between the last two slashes
888
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
890
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
892
# directory file_id, relative path, absolute path, reverse sorted children
893
children = os.listdir(self.basedir)
895
# jam 20060527 The kernel sized tree seems equivalent whether we
896
# use a deque and popleft to keep them sorted, or if we use a plain
897
# list and just reverse() them.
898
children = collections.deque(children)
899
stack = [(inv.root.file_id, u'', self.basedir, children)]
901
yield u'', 'V', 'directory', inv.root.file_id, inv.root
903
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
906
f = children.popleft()
907
## TODO: If we find a subdirectory with its own .bzr
908
## directory, then that is a separate tree and we
909
## should exclude it.
911
# the bzrdir for this tree
912
if transport_base_dir == f:
915
# we know that from_dir_relpath and from_dir_abspath never end in a slash
916
# and 'f' doesn't begin with one, we can do a string op, rather
917
# than the checks of pathjoin(), all relative paths will have an extra slash
919
fp = from_dir_relpath + '/' + f
922
fap = from_dir_abspath + '/' + f
924
f_ie = inv.get_child(from_dir_id, f)
927
elif self.is_ignored(fp[1:]):
930
# we may not have found this file, because of a unicode issue
931
f_norm, can_access = osutils.normalized_filename(f)
932
if f == f_norm or not can_access:
933
# No change, so treat this file normally
936
# this file can be accessed by a normalized path
937
# check again if it is versioned
938
# these lines are repeated here for performance
940
fp = from_dir_relpath + '/' + f
941
fap = from_dir_abspath + '/' + f
942
f_ie = inv.get_child(from_dir_id, f)
945
elif self.is_ignored(fp[1:]):
954
raise BzrCheckError("file %r entered as kind %r id %r, "
956
% (fap, f_ie.kind, f_ie.file_id, fk))
958
# make a last minute entry
960
yield fp[1:], c, fk, f_ie.file_id, f_ie
963
yield fp[1:], c, fk, None, fk_entries[fk]()
965
yield fp[1:], c, fk, None, TreeEntry()
968
if fk != 'directory':
971
# But do this child first
972
new_children = os.listdir(fap)
974
new_children = collections.deque(new_children)
975
stack.append((f_ie.file_id, fp, fap, new_children))
976
# Break out of inner loop, so that we start outer loop with child
979
# if we finished all children, pop it off the stack
984
def move(self, from_paths, to_name):
987
to_name must exist in the inventory.
989
If to_name exists and is a directory, the files are moved into
990
it, keeping their old names.
992
Note that to_name is only the last component of the new name;
993
this doesn't change the directory.
995
This returns a list of (from_path, to_path) pairs for each
999
## TODO: Option to move IDs only
1000
assert not isinstance(from_paths, basestring)
1001
inv = self.inventory
1002
to_abs = self.abspath(to_name)
1003
if not isdir(to_abs):
1004
raise BzrError("destination %r is not a directory" % to_abs)
1005
if not self.has_filename(to_name):
1006
raise BzrError("destination %r not in working directory" % to_abs)
1007
to_dir_id = inv.path2id(to_name)
1008
if to_dir_id is None and to_name != '':
1009
raise BzrError("destination %r is not a versioned directory" % to_name)
1010
to_dir_ie = inv[to_dir_id]
1011
if to_dir_ie.kind != 'directory':
1012
raise BzrError("destination %r is not a directory" % to_abs)
1014
to_idpath = inv.get_idpath(to_dir_id)
1016
for f in from_paths:
1017
if not self.has_filename(f):
1018
raise BzrError("%r does not exist in working tree" % f)
1019
f_id = inv.path2id(f)
1021
raise BzrError("%r is not versioned" % f)
1022
name_tail = splitpath(f)[-1]
1023
dest_path = pathjoin(to_name, name_tail)
1024
if self.has_filename(dest_path):
1025
raise BzrError("destination %r already exists" % dest_path)
1026
if f_id in to_idpath:
1027
raise BzrError("can't move %r to a subdirectory of itself" % f)
1029
# OK, so there's a race here, it's possible that someone will
1030
# create a file in this interval and then the rename might be
1031
# left half-done. But we should have caught most problems.
1032
orig_inv = deepcopy(self.inventory)
1034
for f in from_paths:
1035
name_tail = splitpath(f)[-1]
1036
dest_path = pathjoin(to_name, name_tail)
1037
result.append((f, dest_path))
1038
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1040
rename(self.abspath(f), self.abspath(dest_path))
1042
raise BzrError("failed to rename %r to %r: %s" %
1043
(f, dest_path, e[1]),
1044
["rename rolled back"])
1046
# restore the inventory on error
1047
self._set_inventory(orig_inv)
1049
self._write_inventory(inv)
1053
def rename_one(self, from_rel, to_rel):
1056
This can change the directory or the filename or both.
1058
inv = self.inventory
1059
if not self.has_filename(from_rel):
1060
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1061
if self.has_filename(to_rel):
1062
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1064
file_id = inv.path2id(from_rel)
1066
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1068
entry = inv[file_id]
1069
from_parent = entry.parent_id
1070
from_name = entry.name
1072
if inv.path2id(to_rel):
1073
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1075
to_dir, to_tail = os.path.split(to_rel)
1076
to_dir_id = inv.path2id(to_dir)
1077
if to_dir_id is None and to_dir != '':
1078
raise BzrError("can't determine destination directory id for %r" % to_dir)
1080
mutter("rename_one:")
1081
mutter(" file_id {%s}" % file_id)
1082
mutter(" from_rel %r" % from_rel)
1083
mutter(" to_rel %r" % to_rel)
1084
mutter(" to_dir %r" % to_dir)
1085
mutter(" to_dir_id {%s}" % to_dir_id)
1087
inv.rename(file_id, to_dir_id, to_tail)
1089
from_abs = self.abspath(from_rel)
1090
to_abs = self.abspath(to_rel)
1092
rename(from_abs, to_abs)
1094
inv.rename(file_id, from_parent, from_name)
1095
raise BzrError("failed to rename %r to %r: %s"
1096
% (from_abs, to_abs, e[1]),
1097
["rename rolled back"])
1098
self._write_inventory(inv)
1102
"""Return all unknown files.
1104
These are files in the working directory that are not versioned or
1105
control files or ignored.
1107
for subp in self.extras():
1108
if not self.is_ignored(subp):
1112
def unversion(self, file_ids):
1113
"""Remove the file ids in file_ids from the current versioned set.
1115
When a file_id is unversioned, all of its children are automatically
1118
:param file_ids: The file ids to stop versioning.
1119
:raises: NoSuchId if any fileid is not currently versioned.
1121
for file_id in file_ids:
1122
if self._inventory.has_id(file_id):
1123
self._inventory.remove_recursive_id(file_id)
1125
raise errors.NoSuchId(self, file_id)
1127
# in the future this should just set a dirty bit to wait for the
1128
# final unlock. However, until all methods of workingtree start
1129
# with the current in -memory inventory rather than triggering
1130
# a read, it is more complex - we need to teach read_inventory
1131
# to know when to read, and when to not read first... and possibly
1132
# to save first when the in memory one may be corrupted.
1133
# so for now, we just only write it if it is indeed dirty.
1135
self._write_inventory(self._inventory)
1137
@deprecated_method(zero_eight)
1138
def iter_conflicts(self):
1139
"""List all files in the tree that have text or content conflicts.
1140
DEPRECATED. Use conflicts instead."""
1141
return self._iter_conflicts()
1143
def _iter_conflicts(self):
1145
for info in self.list_files():
1147
stem = get_conflicted_stem(path)
1150
if stem not in conflicted:
1151
conflicted.add(stem)
1155
def pull(self, source, overwrite=False, stop_revision=None):
1156
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1159
pp = ProgressPhase("Pull phase", 2, top_pb)
1161
old_revision_history = self.branch.revision_history()
1162
basis_tree = self.basis_tree()
1163
count = self.branch.pull(source, overwrite, stop_revision)
1164
new_revision_history = self.branch.revision_history()
1165
if new_revision_history != old_revision_history:
1167
if len(old_revision_history):
1168
other_revision = old_revision_history[-1]
1170
other_revision = None
1171
repository = self.branch.repository
1172
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1174
new_basis_tree = self.branch.basis_tree()
1175
merge_inner(self.branch,
1180
if (basis_tree.inventory.root is None and
1181
new_basis_tree.inventory.root is not None):
1182
self.set_root_id(new_basis_tree.inventory.root.file_id)
1185
# TODO - dedup parents list with things merged by pull ?
1186
# reuse the revisiontree we merged against to set the new
1188
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1189
# we have to pull the merge trees out again, because
1190
# merge_inner has set the ids. - this corner is not yet
1191
# layered well enough to prevent double handling.
1192
merges = self.get_parent_ids()[1:]
1193
parent_trees.extend([
1194
(parent, repository.revision_tree(parent)) for
1196
self.set_parent_trees(parent_trees)
1203
"""Yield all unknown files in this WorkingTree.
1205
If there are any unknown directories then only the directory is
1206
returned, not all its children. But if there are unknown files
1207
under a versioned subdirectory, they are returned.
1209
Currently returned depth-first, sorted by name within directories.
1211
## TODO: Work from given directory downwards
1212
for path, dir_entry in self.inventory.directories():
1213
# mutter("search for unknowns in %r", path)
1214
dirabs = self.abspath(path)
1215
if not isdir(dirabs):
1216
# e.g. directory deleted
1220
for subf in os.listdir(dirabs):
1223
if subf not in dir_entry.children:
1224
subf_norm, can_access = osutils.normalized_filename(subf)
1225
if subf_norm != subf and can_access:
1226
if subf_norm not in dir_entry.children:
1227
fl.append(subf_norm)
1233
subp = pathjoin(path, subf)
1236
def _translate_ignore_rule(self, rule):
1237
"""Translate a single ignore rule to a regex.
1239
There are two types of ignore rules. Those that do not contain a / are
1240
matched against the tail of the filename (that is, they do not care
1241
what directory the file is in.) Rules which do contain a slash must
1242
match the entire path. As a special case, './' at the start of the
1243
string counts as a slash in the string but is removed before matching
1244
(e.g. ./foo.c, ./src/foo.c)
1246
:return: The translated regex.
1248
if rule[:2] in ('./', '.\\'):
1250
result = fnmatch.translate(rule[2:])
1251
elif '/' in rule or '\\' in rule:
1253
result = fnmatch.translate(rule)
1255
# default rule style.
1256
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1257
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1258
return "(" + result + ")"
1260
def _combine_ignore_rules(self, rules):
1261
"""Combine a list of ignore rules into a single regex object.
1263
Each individual rule is combined with | to form a big regex, which then
1264
has $ added to it to form something like ()|()|()$. The group index for
1265
each subregex's outermost group is placed in a dictionary mapping back
1266
to the rule. This allows quick identification of the matching rule that
1268
:return: a list of the compiled regex and the matching-group index
1269
dictionaries. We return a list because python complains if you try to
1270
combine more than 100 regexes.
1275
translated_rules = []
1277
translated_rule = self._translate_ignore_rule(rule)
1278
compiled_rule = re.compile(translated_rule)
1279
groups[next_group] = rule
1280
next_group += compiled_rule.groups
1281
translated_rules.append(translated_rule)
1282
if next_group == 99:
1283
result.append((re.compile("|".join(translated_rules)), groups))
1286
translated_rules = []
1287
if len(translated_rules):
1288
result.append((re.compile("|".join(translated_rules)), groups))
1291
def ignored_files(self):
1292
"""Yield list of PATH, IGNORE_PATTERN"""
1293
for subp in self.extras():
1294
pat = self.is_ignored(subp)
1298
def get_ignore_list(self):
1299
"""Return list of ignore patterns.
1301
Cached in the Tree object after the first call.
1303
ignoreset = getattr(self, '_ignoreset', None)
1304
if ignoreset is not None:
1307
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1308
ignore_globs.update(ignores.get_runtime_ignores())
1310
ignore_globs.update(ignores.get_user_ignores())
1312
if self.has_filename(bzrlib.IGNORE_FILENAME):
1313
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1315
ignore_globs.update(ignores.parse_ignore_file(f))
1319
self._ignoreset = ignore_globs
1320
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1323
def _get_ignore_rules_as_regex(self):
1324
"""Return a regex of the ignore rules and a mapping dict.
1326
:return: (ignore rules compiled regex, dictionary mapping rule group
1327
indices to original rule.)
1329
if getattr(self, '_ignoreset', None) is None:
1330
self.get_ignore_list()
1331
return self._ignore_regex
1333
def is_ignored(self, filename):
1334
r"""Check whether the filename matches an ignore pattern.
1336
Patterns containing '/' or '\' need to match the whole path;
1337
others match against only the last component.
1339
If the file is ignored, returns the pattern which caused it to
1340
be ignored, otherwise None. So this can simply be used as a
1341
boolean if desired."""
1343
# TODO: Use '**' to match directories, and other extended
1344
# globbing stuff from cvs/rsync.
1346
# XXX: fnmatch is actually not quite what we want: it's only
1347
# approximately the same as real Unix fnmatch, and doesn't
1348
# treat dotfiles correctly and allows * to match /.
1349
# Eventually it should be replaced with something more
1352
rules = self._get_ignore_rules_as_regex()
1353
for regex, mapping in rules:
1354
match = regex.match(filename)
1355
if match is not None:
1356
# one or more of the groups in mapping will have a non-None
1358
groups = match.groups()
1359
rules = [mapping[group] for group in
1360
mapping if groups[group] is not None]
1364
def kind(self, file_id):
1365
return file_kind(self.id2abspath(file_id))
1367
def last_revision(self):
1368
"""Return the last revision id of this working tree.
1370
In early branch formats this was the same as the branch last_revision,
1371
but that cannot be relied upon - for working tree operations,
1372
always use tree.last_revision(). This returns the left most parent id,
1373
or None if there are no parents.
1375
This was deprecated as of 0.11. Please use get_parent_ids instead.
1377
return self._last_revision()
1380
def _last_revision(self):
1381
"""helper for get_parent_ids."""
1382
return self.branch.last_revision()
1384
def is_locked(self):
1385
return self._control_files.is_locked()
1387
def lock_read(self):
1388
"""See Branch.lock_read, and WorkingTree.unlock."""
1389
self.branch.lock_read()
1391
return self._control_files.lock_read()
1393
self.branch.unlock()
1396
def lock_write(self):
1397
"""See Branch.lock_write, and WorkingTree.unlock."""
1398
self.branch.lock_write()
1400
return self._control_files.lock_write()
1402
self.branch.unlock()
1405
def get_physical_lock_status(self):
1406
return self._control_files.get_physical_lock_status()
1408
def _basis_inventory_name(self):
1409
return 'basis-inventory'
1412
def set_last_revision(self, new_revision):
1413
"""Change the last revision in the working tree."""
1414
if self._change_last_revision(new_revision):
1415
self._cache_basis_inventory(new_revision)
1417
def _change_last_revision(self, new_revision):
1418
"""Template method part of set_last_revision to perform the change.
1420
This is used to allow WorkingTree3 instances to not affect branch
1421
when their last revision is set.
1423
if new_revision is None:
1424
self.branch.set_revision_history([])
1427
self.branch.generate_revision_history(new_revision)
1428
except errors.NoSuchRevision:
1429
# not present in the repo - dont try to set it deeper than the tip
1430
self.branch.set_revision_history([new_revision])
1433
def _cache_basis_inventory(self, new_revision):
1434
"""Cache new_revision as the basis inventory."""
1435
# TODO: this should allow the ready-to-use inventory to be passed in,
1436
# as commit already has that ready-to-use [while the format is the
1439
# this double handles the inventory - unpack and repack -
1440
# but is easier to understand. We can/should put a conditional
1441
# in here based on whether the inventory is in the latest format
1442
# - perhaps we should repack all inventories on a repository
1444
# the fast path is to copy the raw xml from the repository. If the
1445
# xml contains 'revision_id="', then we assume the right
1446
# revision_id is set. We must check for this full string, because a
1447
# root node id can legitimately look like 'revision_id' but cannot
1449
xml = self.branch.repository.get_inventory_xml(new_revision)
1450
if not 'revision_id="' in xml.split('\n', 1)[0]:
1451
inv = self.branch.repository.deserialise_inventory(
1453
inv.revision_id = new_revision
1454
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1455
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1456
path = self._basis_inventory_name()
1458
self._control_files.put(path, sio)
1459
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1462
def read_basis_inventory(self):
1463
"""Read the cached basis inventory."""
1464
path = self._basis_inventory_name()
1465
return self._control_files.get(path).read()
1468
def read_working_inventory(self):
1469
"""Read the working inventory."""
1470
# ElementTree does its own conversion from UTF-8, so open in
1472
result = bzrlib.xml5.serializer_v5.read_inventory(
1473
self._control_files.get('inventory'))
1474
self._set_inventory(result)
1478
def remove(self, files, verbose=False, to_file=None):
1479
"""Remove nominated files from the working inventory..
1481
This does not remove their text. This does not run on XXX on what? RBC
1483
TODO: Refuse to remove modified files unless --force is given?
1485
TODO: Do something useful with directories.
1487
TODO: Should this remove the text or not? Tough call; not
1488
removing may be useful and the user can just use use rm, and
1489
is the opposite of add. Removing it is consistent with most
1490
other tools. Maybe an option.
1492
## TODO: Normalize names
1493
## TODO: Remove nested loops; better scalability
1494
if isinstance(files, basestring):
1497
inv = self.inventory
1499
# do this before any modifications
1501
fid = inv.path2id(f)
1503
# TODO: Perhaps make this just a warning, and continue?
1504
# This tends to happen when
1505
raise NotVersionedError(path=f)
1507
# having remove it, it must be either ignored or unknown
1508
if self.is_ignored(f):
1512
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1515
self._write_inventory(inv)
1518
def revert(self, filenames, old_tree=None, backups=True,
1519
pb=DummyProgress()):
1520
from transform import revert
1521
from conflicts import resolve
1522
if old_tree is None:
1523
old_tree = self.basis_tree()
1524
conflicts = revert(self, old_tree, filenames, backups, pb)
1525
if not len(filenames):
1526
self.set_parent_ids(self.get_parent_ids()[:1])
1529
resolve(self, filenames, ignore_misses=True)
1532
# XXX: This method should be deprecated in favour of taking in a proper
1533
# new Inventory object.
1535
def set_inventory(self, new_inventory_list):
1536
from bzrlib.inventory import (Inventory,
1541
inv = Inventory(self.get_root_id())
1542
for path, file_id, parent, kind in new_inventory_list:
1543
name = os.path.basename(path)
1546
# fixme, there should be a factory function inv,add_??
1547
if kind == 'directory':
1548
inv.add(InventoryDirectory(file_id, name, parent))
1549
elif kind == 'file':
1550
inv.add(InventoryFile(file_id, name, parent))
1551
elif kind == 'symlink':
1552
inv.add(InventoryLink(file_id, name, parent))
1554
raise BzrError("unknown kind %r" % kind)
1555
self._write_inventory(inv)
1558
def set_root_id(self, file_id):
1559
"""Set the root id for this tree."""
1560
inv = self.read_working_inventory()
1561
orig_root_id = inv.root.file_id
1562
del inv._byid[inv.root.file_id]
1563
inv.root.file_id = file_id
1564
inv._byid[inv.root.file_id] = inv.root
1567
if entry.parent_id == orig_root_id:
1568
entry.parent_id = inv.root.file_id
1569
self._write_inventory(inv)
1572
"""See Branch.unlock.
1574
WorkingTree locking just uses the Branch locking facilities.
1575
This is current because all working trees have an embedded branch
1576
within them. IF in the future, we were to make branch data shareable
1577
between multiple working trees, i.e. via shared storage, then we
1578
would probably want to lock both the local tree, and the branch.
1580
raise NotImplementedError(self.unlock)
1584
"""Update a working tree along its branch.
1586
This will update the branch if its bound too, which means we have
1587
multiple trees involved:
1589
- The new basis tree of the master.
1590
- The old basis tree of the branch.
1591
- The old basis tree of the working tree.
1592
- The current working tree state.
1594
Pathologically, all three may be different, and non-ancestors of each
1595
other. Conceptually we want to:
1597
- Preserve the wt.basis->wt.state changes
1598
- Transform the wt.basis to the new master basis.
1599
- Apply a merge of the old branch basis to get any 'local' changes from
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
1606
- Do a 'normal' merge of the old branch basis if it is relevant.
1608
old_tip = self.branch.update()
1610
# here if old_tip is not None, it is the old tip of the branch before
1611
# it was updated from the master branch. This should become a pending
1612
# merge in the working tree to preserve the user existing work. we
1613
# cant set that until we update the working trees last revision to be
1614
# one from the new branch, because it will just get absorbed by the
1615
# parent de-duplication logic.
1617
# We MUST save it even if an error occurs, because otherwise the users
1618
# local work is unreferenced and will appear to have been lost.
1622
last_rev = self.get_parent_ids()[0]
1625
if last_rev != self.branch.last_revision():
1626
# merge tree state up to new branch tip.
1627
basis = self.basis_tree()
1628
to_tree = self.branch.basis_tree()
1629
if basis.inventory.root is None:
1630
self.set_root_id(to_tree.inventory.root.file_id)
1631
result += merge_inner(self.branch,
1635
# TODO - dedup parents list with things merged by pull ?
1636
# reuse the tree we've updated to to set the basis:
1637
parent_trees = [(self.branch.last_revision(), to_tree)]
1638
merges = self.get_parent_ids()[1:]
1639
# Ideally we ask the tree for the trees here, that way the working
1640
# tree can decide whether to give us teh entire tree or give us a
1641
# lazy initialised tree. dirstate for instance will have the trees
1642
# in ram already, whereas a last-revision + basis-inventory tree
1643
# will not, but also does not need them when setting parents.
1644
for parent in merges:
1645
parent_trees.append(
1646
(parent, self.branch.repository.revision_tree(parent)))
1647
if old_tip is not None:
1648
parent_trees.append(
1649
(old_tip, self.branch.repository.revision_tree(old_tip)))
1650
self.set_parent_trees(parent_trees)
1651
last_rev = parent_trees[0][0]
1653
# the working tree had the same last-revision as the master
1654
# branch did. We may still have pivot local work from the local
1655
# branch into old_tip:
1656
if old_tip is not None:
1657
self.add_parent_tree_id(old_tip)
1658
if old_tip and old_tip != last_rev:
1659
# our last revision was not the prior branch last revision
1660
# and we have converted that last revision to a pending merge.
1661
# base is somewhere between the branch tip now
1662
# and the now pending merge
1663
from bzrlib.revision import common_ancestor
1665
base_rev_id = common_ancestor(self.branch.last_revision(),
1667
self.branch.repository)
1668
except errors.NoCommonAncestor:
1670
base_tree = self.branch.repository.revision_tree(base_rev_id)
1671
other_tree = self.branch.repository.revision_tree(old_tip)
1672
result += merge_inner(self.branch,
1679
def _write_inventory(self, inv):
1680
"""Write inventory as the current inventory."""
1682
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1684
self._control_files.put('inventory', sio)
1685
self._set_inventory(inv)
1686
mutter('wrote working inventory')
1688
def set_conflicts(self, arg):
1689
raise UnsupportedOperation(self.set_conflicts, self)
1691
def add_conflicts(self, arg):
1692
raise UnsupportedOperation(self.add_conflicts, self)
1695
def conflicts(self):
1696
conflicts = ConflictList()
1697
for conflicted in self._iter_conflicts():
1700
if file_kind(self.abspath(conflicted)) != "file":
1702
except errors.NoSuchFile:
1705
for suffix in ('.THIS', '.OTHER'):
1707
kind = file_kind(self.abspath(conflicted+suffix))
1710
except errors.NoSuchFile:
1714
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1715
conflicts.append(Conflict.factory(ctype, path=conflicted,
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.
1729
# we share control files:
1730
if self._hashcache.needs_write and self._control_files._lock_count==3:
1731
self._hashcache.write()
1732
# reverse order of locking.
1734
return self._control_files.unlock()
1736
self.branch.unlock()
1739
class WorkingTree3(WorkingTree):
1740
"""This is the Format 3 working tree.
1742
This differs from the base WorkingTree by:
1743
- having its own file lock
1744
- having its own last-revision property.
1746
This is new in bzr 0.8
1750
def _last_revision(self):
1751
"""See WorkingTree._last_revision."""
1753
return self._control_files.get_utf8('last-revision').read()
1757
def _change_last_revision(self, revision_id):
1758
"""See WorkingTree._change_last_revision."""
1759
if revision_id is None or revision_id == NULL_REVISION:
1761
self._control_files._transport.delete('last-revision')
1762
except errors.NoSuchFile:
1766
self._control_files.put_utf8('last-revision', revision_id)
1770
def set_conflicts(self, conflicts):
1771
self._put_rio('conflicts', conflicts.to_stanzas(),
1775
def add_conflicts(self, new_conflicts):
1776
conflict_set = set(self.conflicts())
1777
conflict_set.update(set(list(new_conflicts)))
1778
self.set_conflicts(ConflictList(sorted(conflict_set,
1779
key=Conflict.sort_key)))
1782
def conflicts(self):
1784
confile = self._control_files.get('conflicts')
1786
return ConflictList()
1788
if confile.next() != CONFLICT_HEADER_1 + '\n':
1789
raise ConflictFormatError()
1790
except StopIteration:
1791
raise ConflictFormatError()
1792
return ConflictList.from_stanzas(RioReader(confile))
1795
if self._hashcache.needs_write and self._control_files._lock_count==1:
1796
self._hashcache.write()
1797
# reverse order of locking.
1799
return self._control_files.unlock()
1801
self.branch.unlock()
1804
def get_conflicted_stem(path):
1805
for suffix in CONFLICT_SUFFIXES:
1806
if path.endswith(suffix):
1807
return path[:-len(suffix)]
1809
@deprecated_function(zero_eight)
1810
def is_control_file(filename):
1811
"""See WorkingTree.is_control_filename(filename)."""
1812
## FIXME: better check
1813
filename = normpath(filename)
1814
while filename != '':
1815
head, tail = os.path.split(filename)
1816
## mutter('check %r for control file' % ((head, tail),))
1819
if filename == head:
1825
class WorkingTreeFormat(object):
1826
"""An encapsulation of the initialization and open routines for a format.
1828
Formats provide three things:
1829
* An initialization routine,
1833
Formats are placed in an dict by their format string for reference
1834
during workingtree opening. Its not required that these be instances, they
1835
can be classes themselves with class methods - it simply depends on
1836
whether state is needed for a given format or not.
1838
Once a format is deprecated, just deprecate the initialize and open
1839
methods on the format class. Do not deprecate the object, as the
1840
object will be created every time regardless.
1843
_default_format = None
1844
"""The default format used for new trees."""
1847
"""The known formats."""
1850
def find_format(klass, a_bzrdir):
1851
"""Return the format for the working tree object in a_bzrdir."""
1853
transport = a_bzrdir.get_workingtree_transport(None)
1854
format_string = transport.get("format").read()
1855
return klass._formats[format_string]
1857
raise errors.NoWorkingTree(base=transport.base)
1859
raise errors.UnknownFormatError(format=format_string)
1862
def get_default_format(klass):
1863
"""Return the current default format."""
1864
return klass._default_format
1866
def get_format_string(self):
1867
"""Return the ASCII format string that identifies this format."""
1868
raise NotImplementedError(self.get_format_string)
1870
def get_format_description(self):
1871
"""Return the short description for this format."""
1872
raise NotImplementedError(self.get_format_description)
1874
def is_supported(self):
1875
"""Is this format supported?
1877
Supported formats can be initialized and opened.
1878
Unsupported formats may not support initialization or committing or
1879
some other features depending on the reason for not being supported.
1884
def register_format(klass, format):
1885
klass._formats[format.get_format_string()] = format
1888
def set_default_format(klass, format):
1889
klass._default_format = format
1892
def unregister_format(klass, format):
1893
assert klass._formats[format.get_format_string()] is format
1894
del klass._formats[format.get_format_string()]
1898
class WorkingTreeFormat2(WorkingTreeFormat):
1899
"""The second working tree format.
1901
This format modified the hash cache from the format 1 hash cache.
1904
def get_format_description(self):
1905
"""See WorkingTreeFormat.get_format_description()."""
1906
return "Working tree format 2"
1908
def stub_initialize_remote(self, control_files):
1909
"""As a special workaround create critical control files for a remote working tree
1911
This ensures that it can later be updated and dealt with locally,
1912
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1913
no working tree. (See bug #43064).
1917
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1919
control_files.put('inventory', sio)
1921
control_files.put_utf8('pending-merges', '')
1924
def initialize(self, a_bzrdir, revision_id=None):
1925
"""See WorkingTreeFormat.initialize()."""
1926
if not isinstance(a_bzrdir.transport, LocalTransport):
1927
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1928
branch = a_bzrdir.open_branch()
1929
if revision_id is not None:
1932
revision_history = branch.revision_history()
1934
position = revision_history.index(revision_id)
1936
raise errors.NoSuchRevision(branch, revision_id)
1937
branch.set_revision_history(revision_history[:position + 1])
1940
revision = branch.last_revision()
1942
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1948
wt.set_last_revision(revision)
1949
basis_tree = wt.basis_tree()
1950
if basis_tree.inventory.root is not None:
1951
inv.root.file_id = basis_tree.inventory.root.file_id
1952
wt._write_inventory(inv)
1953
wt.set_parent_trees([(revision, basis_tree)])
1954
build_tree(basis_tree, wt)
1958
super(WorkingTreeFormat2, self).__init__()
1959
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1961
def open(self, a_bzrdir, _found=False):
1962
"""Return the WorkingTree object for a_bzrdir
1964
_found is a private parameter, do not use it. It is used to indicate
1965
if format probing has already been done.
1968
# we are being called directly and must probe.
1969
raise NotImplementedError
1970
if not isinstance(a_bzrdir.transport, LocalTransport):
1971
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1972
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1978
class WorkingTreeFormat3(WorkingTreeFormat):
1979
"""The second working tree format updated to record a format marker.
1982
- exists within a metadir controlling .bzr
1983
- includes an explicit version marker for the workingtree control
1984
files, separate from the BzrDir format
1985
- modifies the hash cache format
1987
- uses a LockDir to guard access for writes.
1990
def get_format_string(self):
1991
"""See WorkingTreeFormat.get_format_string()."""
1992
return "Bazaar-NG Working Tree format 3"
1994
def get_format_description(self):
1995
"""See WorkingTreeFormat.get_format_description()."""
1996
return "Working tree format 3"
1998
_lock_file_name = 'lock'
1999
_lock_class = LockDir
2001
def _open_control_files(self, a_bzrdir):
2002
transport = a_bzrdir.get_workingtree_transport(None)
2003
return LockableFiles(transport, self._lock_file_name,
2006
def initialize(self, a_bzrdir, revision_id=None):
2007
"""See WorkingTreeFormat.initialize().
2009
revision_id allows creating a working tree at a different
2010
revision than the branch is at.
2012
if not isinstance(a_bzrdir.transport, LocalTransport):
2013
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2014
transport = a_bzrdir.get_workingtree_transport(self)
2015
control_files = self._open_control_files(a_bzrdir)
2016
control_files.create_lock()
2017
control_files.lock_write()
2018
control_files.put_utf8('format', self.get_format_string())
2019
branch = a_bzrdir.open_branch()
2020
if revision_id is None:
2021
revision_id = branch.last_revision()
2022
inv = Inventory(root_id=gen_root_id())
2023
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2029
_control_files=control_files)
2032
wt.set_last_revision(revision_id)
2033
basis_tree = wt.basis_tree()
2034
wt._write_inventory(inv)
2035
wt.set_pending_merges([])
2036
if revision_id == bzrlib.revision.NULL_REVISION:
2037
wt.set_parent_trees([])
2039
wt.set_parent_trees([(revision_id, basis_tree)])
2040
build_tree(basis_tree, wt)
2043
control_files.unlock()
2047
super(WorkingTreeFormat3, self).__init__()
2048
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2050
def open(self, a_bzrdir, _found=False):
2051
"""Return the WorkingTree object for a_bzrdir
2053
_found is a private parameter, do not use it. It is used to indicate
2054
if format probing has already been done.
2057
# we are being called directly and must probe.
2058
raise NotImplementedError
2059
if not isinstance(a_bzrdir.transport, LocalTransport):
2060
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2061
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2063
def _open(self, a_bzrdir, control_files):
2064
"""Open the tree itself.
2066
:param a_bzrdir: the dir for the tree.
2067
:param control_files: the control files for the tree.
2069
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2073
_control_files=control_files)
2076
return self.get_format_string()
2079
# formats which have no format string are not discoverable
2080
# and not independently creatable, so are not registered.
2081
__default_format = WorkingTreeFormat3()
2082
WorkingTreeFormat.register_format(__default_format)
2083
WorkingTreeFormat.set_default_format(__default_format)
2084
_legacy_formats = [WorkingTreeFormat2(),
2088
class WorkingTreeTestProviderAdapter(object):
2089
"""A tool to generate a suite testing multiple workingtree formats at once.
2091
This is done by copying the test once for each transport and injecting
2092
the transport_server, transport_readonly_server, and workingtree_format
2093
classes into each copy. Each copy is also given a new id() to make it
2097
def __init__(self, transport_server, transport_readonly_server, formats):
2098
self._transport_server = transport_server
2099
self._transport_readonly_server = transport_readonly_server
2100
self._formats = formats
2102
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2103
"""Clone test for adaption."""
2104
new_test = deepcopy(test)
2105
new_test.transport_server = self._transport_server
2106
new_test.transport_readonly_server = self._transport_readonly_server
2107
new_test.bzrdir_format = bzrdir_format
2108
new_test.workingtree_format = workingtree_format
2109
def make_new_test_id():
2110
new_id = "%s(%s)" % (test.id(), variation)
2111
return lambda: new_id
2112
new_test.id = make_new_test_id()
2115
def adapt(self, test):
2116
from bzrlib.tests import TestSuite
2117
result = TestSuite()
2118
for workingtree_format, bzrdir_format in self._formats:
2119
new_test = self._clone_test(
2122
workingtree_format, workingtree_format.__class__.__name__)
2123
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
