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,
100
from bzrlib.trace import mutter, note
101
from bzrlib.transform import build_tree
102
from bzrlib.transport import get_transport
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.textui import show_status
110
# the regex removes any weird characters; we don't escape them
111
# but rather just pull them out
112
_gen_file_id_re = re.compile(r'[^\w.]')
113
_gen_id_suffix = None
117
def _next_id_suffix():
118
"""Create a new file id suffix that is reasonably unique.
120
On the first call we combine the current time with 64 bits of randomness
121
to give a highly probably globally unique number. Then each call in the same
122
process adds 1 to a serial number we append to that unique value.
124
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
125
# than having to move the id randomness out of the inner loop like this.
126
# XXX TODO: for the global randomness this uses we should add the thread-id
127
# before the serial #.
128
global _gen_id_suffix, _gen_id_serial
129
if _gen_id_suffix is None:
130
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
132
return _gen_id_suffix + str(_gen_id_serial)
135
def gen_file_id(name):
136
"""Return new file id for the basename 'name'.
138
The uniqueness is supplied from _next_id_suffix.
140
# The real randomness is in the _next_id_suffix, the
141
# rest of the identifier is just to be nice.
143
# 1) Remove non-ascii word characters to keep the ids portable
144
# 2) squash to lowercase, so the file id doesn't have to
145
# be escaped (case insensitive filesystems would bork for ids
146
# that only differred in case without escaping).
147
# 3) truncate the filename to 20 chars. Long filenames also bork on some
149
# 4) Removing starting '.' characters to prevent the file ids from
150
# being considered hidden.
151
ascii_word_only = _gen_file_id_re.sub('', name.lower())
152
short_no_dots = ascii_word_only.lstrip('.')[:20]
153
return short_no_dots + _next_id_suffix()
157
"""Return a new tree-root file id."""
158
return gen_file_id('TREE_ROOT')
161
class TreeEntry(object):
162
"""An entry that implements the minimum interface used by commands.
164
This needs further inspection, it may be better to have
165
InventoryEntries without ids - though that seems wrong. For now,
166
this is a parallel hierarchy to InventoryEntry, and needs to become
167
one of several things: decorates to that hierarchy, children of, or
169
Another note is that these objects are currently only used when there is
170
no InventoryEntry available - i.e. for unversioned objects.
171
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
174
def __eq__(self, other):
175
# yes, this us ugly, TODO: best practice __eq__ style.
176
return (isinstance(other, TreeEntry)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeDirectory(TreeEntry):
184
"""See TreeEntry. This is a directory in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeDirectory)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeFile(TreeEntry):
195
"""See TreeEntry. This is a regular file in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeFile)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class TreeLink(TreeEntry):
206
"""See TreeEntry. This is a symlink in a working tree."""
208
def __eq__(self, other):
209
return (isinstance(other, TreeLink)
210
and other.__class__ == self.__class__)
212
def kind_character(self):
216
class WorkingTree(bzrlib.tree.Tree):
217
"""Working copy tree.
219
The inventory is held in the `Branch` working-inventory, and the
220
files are in a directory on disk.
222
It is possible for a `WorkingTree` to have a filename which is
223
not listed in the Inventory and vice versa.
226
def __init__(self, basedir='.',
227
branch=DEPRECATED_PARAMETER,
233
"""Construct a WorkingTree for basedir.
235
If the branch is not supplied, it is opened automatically.
236
If the branch is supplied, it must be the branch for this basedir.
237
(branch.base is not cross checked, because for remote branches that
238
would be meaningless).
240
self._format = _format
241
self.bzrdir = _bzrdir
243
# not created via open etc.
244
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
245
"Please use bzrdir.open_workingtree or WorkingTree.open().",
248
wt = WorkingTree.open(basedir)
249
self._branch = wt.branch
250
self.basedir = wt.basedir
251
self._control_files = wt._control_files
252
self._hashcache = wt._hashcache
253
self._set_inventory(wt._inventory)
254
self._format = wt._format
255
self.bzrdir = wt.bzrdir
256
from bzrlib.hashcache import HashCache
257
from bzrlib.trace import note, mutter
258
assert isinstance(basedir, basestring), \
259
"base directory %r is not a string" % basedir
260
basedir = safe_unicode(basedir)
261
mutter("opening working tree %r", basedir)
262
if deprecated_passed(branch):
264
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
265
" Please use bzrdir.open_workingtree() or"
266
" WorkingTree.open().",
270
self._branch = branch
272
self._branch = self.bzrdir.open_branch()
273
self.basedir = realpath(basedir)
274
# if branch is at our basedir and is a format 6 or less
275
if isinstance(self._format, WorkingTreeFormat2):
276
# share control object
277
self._control_files = self.branch.control_files
279
# assume all other formats have their own control files.
280
assert isinstance(_control_files, LockableFiles), \
281
"_control_files must be a LockableFiles, not %r" \
283
self._control_files = _control_files
284
# update the whole cache up front and write to disk if anything changed;
285
# in the future we might want to do this more selectively
286
# two possible ways offer themselves : in self._unlock, write the cache
287
# if needed, or, when the cache sees a change, append it to the hash
288
# cache file, and have the parser take the most recent entry for a
290
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
291
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
293
# is this scan needed ? it makes things kinda slow.
300
if _inventory is None:
301
self._set_inventory(self.read_working_inventory())
303
self._set_inventory(_inventory)
306
fget=lambda self: self._branch,
307
doc="""The branch this WorkingTree is connected to.
309
This cannot be set - it is reflective of the actual disk structure
310
the working tree has been constructed from.
313
def break_lock(self):
314
"""Break a lock if one is present from another instance.
316
Uses the ui factory to ask for confirmation if the lock may be from
319
This will probe the repository for its lock as well.
321
self._control_files.break_lock()
322
self.branch.break_lock()
324
def _set_inventory(self, inv):
325
assert inv.root is not None
326
self._inventory = inv
327
self.path2id = self._inventory.path2id
329
def is_control_filename(self, filename):
330
"""True if filename is the name of a control file in this tree.
332
:param filename: A filename within the tree. This is a relative path
333
from the root of this tree.
335
This is true IF and ONLY IF the filename is part of the meta data
336
that bzr controls in this tree. I.E. a random .bzr directory placed
337
on disk will not be a control file for this tree.
339
return self.bzrdir.is_control_filename(filename)
342
def open(path=None, _unsupported=False):
343
"""Open an existing working tree at path.
347
path = os.path.getcwdu()
348
control = bzrdir.BzrDir.open(path, _unsupported)
349
return control.open_workingtree(_unsupported)
352
def open_containing(path=None):
353
"""Open an existing working tree which has its root about path.
355
This probes for a working tree at path and searches upwards from there.
357
Basically we keep looking up until we find the control directory or
358
run into /. If there isn't one, raises NotBranchError.
359
TODO: give this a new exception.
360
If there is one, it is returned, along with the unused portion of path.
362
:return: The WorkingTree that contains 'path', and the rest of path
365
path = osutils.getcwd()
366
control, relpath = bzrdir.BzrDir.open_containing(path)
368
return control.open_workingtree(), relpath
371
def open_downlevel(path=None):
372
"""Open an unsupported working tree.
374
Only intended for advanced situations like upgrading part of a bzrdir.
376
return WorkingTree.open(path, _unsupported=True)
379
"""Iterate through file_ids for this tree.
381
file_ids are in a WorkingTree if they are in the working inventory
382
and the working file exists.
384
inv = self._inventory
385
for path, ie in inv.iter_entries():
386
if osutils.lexists(self.abspath(path)):
390
return "<%s of %s>" % (self.__class__.__name__,
391
getattr(self, 'basedir', None))
393
def abspath(self, filename):
394
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision.
399
If the left most parent is a ghost then the returned tree will be an
400
empty tree - one obtained by calling repository.revision_tree(None).
402
revision_id = self.last_revision()
403
if revision_id is not None:
405
xml = self.read_basis_inventory()
406
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
407
inv.root.revision = revision_id
410
if inv is not None and inv.revision_id == revision_id:
411
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
413
# FIXME? RBC 20060403 should we cache the inventory here ?
415
return self.branch.repository.revision_tree(revision_id)
416
except errors.RevisionNotPresent:
417
# the basis tree *may* be a ghost or a low level error may have
418
# occured. If the revision is present, its a problem, if its not
420
if self.branch.repository.has_revision(revision_id):
422
# the basis tree is a ghost so return an empty tree.
423
return self.branch.repository.revision_tree(None)
426
@deprecated_method(zero_eight)
427
def create(branch, directory):
428
"""Create a workingtree for branch at directory.
430
If existing_directory already exists it must have a .bzr directory.
431
If it does not exist, it will be created.
433
This returns a new WorkingTree object for the new checkout.
435
TODO FIXME RBC 20060124 when we have checkout formats in place this
436
should accept an optional revisionid to checkout [and reject this if
437
checking out into the same dir as a pre-checkout-aware branch format.]
439
XXX: When BzrDir is present, these should be created through that
442
warnings.warn('delete WorkingTree.create', stacklevel=3)
443
transport = get_transport(directory)
444
if branch.bzrdir.root_transport.base == transport.base:
446
return branch.bzrdir.create_workingtree()
447
# different directory,
448
# create a branch reference
449
# and now a working tree.
450
raise NotImplementedError
453
@deprecated_method(zero_eight)
454
def create_standalone(directory):
455
"""Create a checkout and a branch and a repo at directory.
457
Directory must exist and be empty.
459
please use BzrDir.create_standalone_workingtree
461
return bzrdir.BzrDir.create_standalone_workingtree(directory)
463
def relpath(self, path):
464
"""Return the local path portion from a given path.
466
The path may be absolute or relative. If its a relative path it is
467
interpreted relative to the python current working directory.
469
return relpath(self.basedir, path)
471
def has_filename(self, filename):
472
return osutils.lexists(self.abspath(filename))
474
def get_file(self, file_id):
475
return self.get_file_byname(self.id2path(file_id))
477
def get_file_text(self, file_id):
478
return self.get_file(file_id).read()
480
def get_file_byname(self, filename):
481
return file(self.abspath(filename), 'rb')
483
def get_parent_ids(self):
484
"""See Tree.get_parent_ids.
486
This implementation reads the pending merges list and last_revision
487
value and uses that to decide what the parents list should be.
489
last_rev = self.last_revision()
495
merges_file = self._control_files.get_utf8('pending-merges')
499
for l in merges_file.readlines():
500
parents.append(l.rstrip('\n'))
503
def get_root_id(self):
504
"""Return the id of this trees root"""
505
inv = self.read_working_inventory()
506
return inv.root.file_id
508
def _get_store_filename(self, file_id):
509
## XXX: badly named; this is not in the store at all
510
return self.abspath(self.id2path(file_id))
513
def clone(self, to_bzrdir, revision_id=None, basis=None):
514
"""Duplicate this working tree into to_bzr, including all state.
516
Specifically modified files are kept as modified, but
517
ignored and unknown files are discarded.
519
If you want to make a new line of development, see bzrdir.sprout()
522
If not None, the cloned tree will have its last revision set to
523
revision, and and difference between the source trees last revision
524
and this one merged in.
527
If not None, a closer copy of a tree which may have some files in
528
common, and which file content should be preferentially copied from.
530
# assumes the target bzr dir format is compatible.
531
result = self._format.initialize(to_bzrdir)
532
self.copy_content_into(result, revision_id)
536
def copy_content_into(self, tree, revision_id=None):
537
"""Copy the current content and user files of this tree into tree."""
538
if revision_id is None:
539
transform_tree(tree, self)
541
# TODO now merge from tree.last_revision to revision (to preserve
542
# user local changes)
543
transform_tree(tree, self)
544
tree.set_parent_ids([revision_id])
547
def commit(self, message=None, revprops=None, *args, **kwargs):
548
# avoid circular imports
549
from bzrlib.commit import Commit
552
if not 'branch-nick' in revprops:
553
revprops['branch-nick'] = self.branch.nick
554
# args for wt.commit start at message from the Commit.commit method,
555
# but with branch a kwarg now, passing in args as is results in the
556
#message being used for the branch
557
args = (DEPRECATED_PARAMETER, message, ) + args
558
committed_id = Commit().commit( working_tree=self, revprops=revprops,
562
def id2abspath(self, file_id):
563
return self.abspath(self.id2path(file_id))
565
def has_id(self, file_id):
566
# files that have been deleted are excluded
567
inv = self._inventory
568
if not inv.has_id(file_id):
570
path = inv.id2path(file_id)
571
return osutils.lexists(self.abspath(path))
573
def has_or_had_id(self, file_id):
574
if file_id == self.inventory.root.file_id:
576
return self.inventory.has_id(file_id)
578
__contains__ = has_id
580
def get_file_size(self, file_id):
581
return os.path.getsize(self.id2abspath(file_id))
584
def get_file_sha1(self, file_id, path=None):
586
path = self._inventory.id2path(file_id)
587
return self._hashcache.get_sha1(path)
589
def get_file_mtime(self, file_id, path=None):
591
path = self._inventory.id2path(file_id)
592
return os.lstat(self.abspath(path)).st_mtime
594
if not supports_executable():
595
def is_executable(self, file_id, path=None):
596
return self._inventory[file_id].executable
598
def is_executable(self, file_id, path=None):
600
path = self._inventory.id2path(file_id)
601
mode = os.lstat(self.abspath(path)).st_mode
602
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
605
def add(self, files, ids=None):
606
"""Make files versioned.
608
Note that the command line normally calls smart_add instead,
609
which can automatically recurse.
611
This adds the files to the inventory, so that they will be
612
recorded by the next commit.
615
List of paths to add, relative to the base of the tree.
618
If set, use these instead of automatically generated ids.
619
Must be the same length as the list of files, but may
620
contain None for ids that are to be autogenerated.
622
TODO: Perhaps have an option to add the ids even if the files do
625
TODO: Perhaps callback with the ids and paths as they're added.
627
# TODO: Re-adding a file that is removed in the working copy
628
# should probably put it back with the previous ID.
629
if isinstance(files, basestring):
630
assert(ids is None or isinstance(ids, basestring))
636
ids = [None] * len(files)
638
assert(len(ids) == len(files))
640
inv = self.read_working_inventory()
641
for f,file_id in zip(files, ids):
642
if self.is_control_filename(f):
643
raise errors.ForbiddenControlFileError(filename=f)
648
raise BzrError("cannot add top-level %r" % f)
650
fullpath = normpath(self.abspath(f))
652
kind = file_kind(fullpath)
654
if e.errno == errno.ENOENT:
655
raise NoSuchFile(fullpath)
656
if not InventoryEntry.versionable_kind(kind):
657
raise errors.BadFileKindError(filename=f, kind=kind)
659
inv.add_path(f, kind=kind)
661
inv.add_path(f, kind=kind, file_id=file_id)
663
self._write_inventory(inv)
666
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
667
"""Add revision_id as a parent.
669
This is equivalent to retrieving the current list of parent ids
670
and setting the list to its value plus revision_id.
672
:param revision_id: The revision id to add to the parent list. It may
673
be a ghost revision as long as its not the first parent to be added,
674
or the allow_leftmost_as_ghost parameter is set True.
675
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
677
parents = self.get_parent_ids() + [revision_id]
678
self.set_parent_ids(parents,
679
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
682
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
683
"""Add revision_id, tree tuple as a parent.
685
This is equivalent to retrieving the current list of parent trees
686
and setting the list to its value plus parent_tuple. See also
687
add_parent_tree_id - if you only have a parent id available it will be
688
simpler to use that api. If you have the parent already available, using
689
this api is preferred.
691
:param parent_tuple: The (revision id, tree) to add to the parent list.
692
If the revision_id is a ghost, pass None for the tree.
693
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
695
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
696
if len(parent_ids) > 1:
697
# the leftmost may have already been a ghost, preserve that if it
699
allow_leftmost_as_ghost = True
700
self.set_parent_ids(parent_ids,
701
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
704
def add_pending_merge(self, *revision_ids):
705
# TODO: Perhaps should check at this point that the
706
# history of the revision is actually present?
707
parents = self.get_parent_ids()
709
for rev_id in revision_ids:
710
if rev_id in parents:
712
parents.append(rev_id)
715
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
718
def pending_merges(self):
719
"""Return a list of pending merges.
721
These are revisions that have been merged into the working
722
directory but not yet committed.
724
return self.get_parent_ids()[1:]
727
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
728
"""Set the parent ids to revision_ids.
730
See also set_parent_trees. This api will try to retrieve the tree data
731
for each element of revision_ids from the trees repository. If you have
732
tree data already available, it is more efficient to use
733
set_parent_trees rather than set_parent_ids. set_parent_ids is however
734
an easier API to use.
736
:param revision_ids: The revision_ids to set as the parent ids of this
737
working tree. Any of these may be ghosts.
739
if len(revision_ids) > 0:
740
leftmost_id = revision_ids[0]
741
if (not allow_leftmost_as_ghost and not
742
self.branch.repository.has_revision(leftmost_id)):
743
raise errors.GhostRevisionUnusableHere(leftmost_id)
744
self.set_last_revision(leftmost_id)
746
self.set_last_revision(None)
747
merges = revision_ids[1:]
748
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
751
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
752
"""Set the parents of the working tree.
754
:param parents_list: A list of (revision_id, tree) tuples.
755
If tree is None, then that element is treated as an unreachable
756
parent tree - i.e. a ghost.
758
# parent trees are not used in current format trees, delegate to
760
self.set_parent_ids([rev for (rev, tree) in parents_list],
761
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
764
def set_pending_merges(self, rev_list):
765
parents = self.get_parent_ids()
766
leftmost = parents[:1]
767
new_parents = leftmost + rev_list
768
self.set_parent_ids(new_parents)
771
def set_merge_modified(self, modified_hashes):
773
for file_id, hash in modified_hashes.iteritems():
774
yield Stanza(file_id=file_id, hash=hash)
775
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
778
def _put_rio(self, filename, stanzas, header):
779
my_file = rio_file(stanzas, header)
780
self._control_files.put(filename, my_file)
783
def merge_from_branch(self, branch, to_revision=None):
784
"""Merge from a branch into this working tree.
786
:param branch: The branch to merge from.
787
:param to_revision: If non-None, the merge will merge to to_revision, but
788
not beyond it. to_revision does not need to be in the history of
789
the branch when it is supplied. If None, to_revision defaults to
790
branch.last_revision().
792
from bzrlib.merge import Merger, Merge3Merger
793
pb = bzrlib.ui.ui_factory.nested_progress_bar()
795
merger = Merger(self.branch, this_tree=self, pb=pb)
796
merger.pp = ProgressPhase("Merge phase", 5, pb)
797
merger.pp.next_phase()
798
# check that there are no
800
merger.check_basis(check_clean=True, require_commits=False)
801
if to_revision is None:
802
to_revision = branch.last_revision()
803
merger.other_rev_id = to_revision
804
if merger.other_rev_id is None:
805
raise error.NoCommits(branch)
806
self.branch.fetch(branch, last_revision=merger.other_rev_id)
807
merger.other_basis = merger.other_rev_id
808
merger.other_tree = self.branch.repository.revision_tree(
810
merger.pp.next_phase()
812
if merger.base_rev_id == merger.other_rev_id:
813
raise errors.PointlessMerge
814
merger.backup_files = False
815
merger.merge_type = Merge3Merger
816
merger.set_interesting_files(None)
817
merger.show_base = False
818
merger.reprocess = False
819
conflicts = merger.do_merge()
826
def merge_modified(self):
828
hashfile = self._control_files.get('merge-hashes')
833
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
834
raise MergeModifiedFormatError()
835
except StopIteration:
836
raise MergeModifiedFormatError()
837
for s in RioReader(hashfile):
838
file_id = s.get("file_id")
839
if file_id not in self.inventory:
842
if hash == self.get_file_sha1(file_id):
843
merge_hashes[file_id] = hash
846
def get_symlink_target(self, file_id):
847
return os.readlink(self.id2abspath(file_id))
849
def file_class(self, filename):
850
if self.path2id(filename):
852
elif self.is_ignored(filename):
857
def list_files(self):
858
"""Recursively list all files as (path, class, kind, id, entry).
860
Lists, but does not descend into unversioned directories.
862
This does not include files that have been deleted in this
865
Skips the control directory.
867
inv = self._inventory
868
# Convert these into local objects to save lookup times
869
pathjoin = osutils.pathjoin
870
file_kind = osutils.file_kind
872
# transport.base ends in a slash, we want the piece
873
# between the last two slashes
874
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
876
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
878
# directory file_id, relative path, absolute path, reverse sorted children
879
children = os.listdir(self.basedir)
881
# jam 20060527 The kernel sized tree seems equivalent whether we
882
# use a deque and popleft to keep them sorted, or if we use a plain
883
# list and just reverse() them.
884
children = collections.deque(children)
885
stack = [(inv.root.file_id, u'', self.basedir, children)]
887
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
890
f = children.popleft()
891
## TODO: If we find a subdirectory with its own .bzr
892
## directory, then that is a separate tree and we
893
## should exclude it.
895
# the bzrdir for this tree
896
if transport_base_dir == f:
899
# we know that from_dir_relpath and from_dir_abspath never end in a slash
900
# and 'f' doesn't begin with one, we can do a string op, rather
901
# than the checks of pathjoin(), all relative paths will have an extra slash
903
fp = from_dir_relpath + '/' + f
906
fap = from_dir_abspath + '/' + f
908
f_ie = inv.get_child(from_dir_id, f)
911
elif self.is_ignored(fp[1:]):
914
# we may not have found this file, because of a unicode issue
915
f_norm, can_access = osutils.normalized_filename(f)
916
if f == f_norm or not can_access:
917
# No change, so treat this file normally
920
# this file can be accessed by a normalized path
921
# check again if it is versioned
922
# these lines are repeated here for performance
924
fp = from_dir_relpath + '/' + f
925
fap = from_dir_abspath + '/' + f
926
f_ie = inv.get_child(from_dir_id, f)
929
elif self.is_ignored(fp[1:]):
938
raise BzrCheckError("file %r entered as kind %r id %r, "
940
% (fap, f_ie.kind, f_ie.file_id, fk))
942
# make a last minute entry
944
yield fp[1:], c, fk, f_ie.file_id, f_ie
947
yield fp[1:], c, fk, None, fk_entries[fk]()
949
yield fp[1:], c, fk, None, TreeEntry()
952
if fk != 'directory':
955
# But do this child first
956
new_children = os.listdir(fap)
958
new_children = collections.deque(new_children)
959
stack.append((f_ie.file_id, fp, fap, new_children))
960
# Break out of inner loop, so that we start outer loop with child
963
# if we finished all children, pop it off the stack
968
def move(self, from_paths, to_name):
971
to_name must exist in the inventory.
973
If to_name exists and is a directory, the files are moved into
974
it, keeping their old names.
976
Note that to_name is only the last component of the new name;
977
this doesn't change the directory.
979
This returns a list of (from_path, to_path) pairs for each
983
## TODO: Option to move IDs only
984
assert not isinstance(from_paths, basestring)
986
to_abs = self.abspath(to_name)
987
if not isdir(to_abs):
988
raise BzrError("destination %r is not a directory" % to_abs)
989
if not self.has_filename(to_name):
990
raise BzrError("destination %r not in working directory" % to_abs)
991
to_dir_id = inv.path2id(to_name)
992
if to_dir_id == None and to_name != '':
993
raise BzrError("destination %r is not a versioned directory" % to_name)
994
to_dir_ie = inv[to_dir_id]
995
if to_dir_ie.kind != 'directory':
996
raise BzrError("destination %r is not a directory" % to_abs)
998
to_idpath = inv.get_idpath(to_dir_id)
1000
for f in from_paths:
1001
if not self.has_filename(f):
1002
raise BzrError("%r does not exist in working tree" % f)
1003
f_id = inv.path2id(f)
1005
raise BzrError("%r is not versioned" % f)
1006
name_tail = splitpath(f)[-1]
1007
dest_path = pathjoin(to_name, name_tail)
1008
if self.has_filename(dest_path):
1009
raise BzrError("destination %r already exists" % dest_path)
1010
if f_id in to_idpath:
1011
raise BzrError("can't move %r to a subdirectory of itself" % f)
1013
# OK, so there's a race here, it's possible that someone will
1014
# create a file in this interval and then the rename might be
1015
# left half-done. But we should have caught most problems.
1016
orig_inv = deepcopy(self.inventory)
1018
for f in from_paths:
1019
name_tail = splitpath(f)[-1]
1020
dest_path = pathjoin(to_name, name_tail)
1021
result.append((f, dest_path))
1022
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1024
rename(self.abspath(f), self.abspath(dest_path))
1026
raise BzrError("failed to rename %r to %r: %s" %
1027
(f, dest_path, e[1]),
1028
["rename rolled back"])
1030
# restore the inventory on error
1031
self._set_inventory(orig_inv)
1033
self._write_inventory(inv)
1037
def rename_one(self, from_rel, to_rel):
1040
This can change the directory or the filename or both.
1042
inv = self.inventory
1043
if not self.has_filename(from_rel):
1044
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1045
if self.has_filename(to_rel):
1046
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1048
file_id = inv.path2id(from_rel)
1050
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1052
entry = inv[file_id]
1053
from_parent = entry.parent_id
1054
from_name = entry.name
1056
if inv.path2id(to_rel):
1057
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1059
to_dir, to_tail = os.path.split(to_rel)
1060
to_dir_id = inv.path2id(to_dir)
1061
if to_dir_id == None and to_dir != '':
1062
raise BzrError("can't determine destination directory id for %r" % to_dir)
1064
mutter("rename_one:")
1065
mutter(" file_id {%s}" % file_id)
1066
mutter(" from_rel %r" % from_rel)
1067
mutter(" to_rel %r" % to_rel)
1068
mutter(" to_dir %r" % to_dir)
1069
mutter(" to_dir_id {%s}" % to_dir_id)
1071
inv.rename(file_id, to_dir_id, to_tail)
1073
from_abs = self.abspath(from_rel)
1074
to_abs = self.abspath(to_rel)
1076
rename(from_abs, to_abs)
1078
inv.rename(file_id, from_parent, from_name)
1079
raise BzrError("failed to rename %r to %r: %s"
1080
% (from_abs, to_abs, e[1]),
1081
["rename rolled back"])
1082
self._write_inventory(inv)
1086
"""Return all unknown files.
1088
These are files in the working directory that are not versioned or
1089
control files or ignored.
1091
for subp in self.extras():
1092
if not self.is_ignored(subp):
1096
def unversion(self, file_ids):
1097
"""Remove the file ids in file_ids from the current versioned set.
1099
When a file_id is unversioned, all of its children are automatically
1102
:param file_ids: The file ids to stop versioning.
1103
:raises: NoSuchId if any fileid is not currently versioned.
1105
for file_id in file_ids:
1106
if self._inventory.has_id(file_id):
1107
self._inventory.remove_recursive_id(file_id)
1109
raise errors.NoSuchId(self, file_id)
1111
# in the future this should just set a dirty bit to wait for the
1112
# final unlock. However, until all methods of workingtree start
1113
# with the current in -memory inventory rather than triggering
1114
# a read, it is more complex - we need to teach read_inventory
1115
# to know when to read, and when to not read first... and possibly
1116
# to save first when the in memory one may be corrupted.
1117
# so for now, we just only write it if it is indeed dirty.
1119
self._write_inventory(self._inventory)
1121
@deprecated_method(zero_eight)
1122
def iter_conflicts(self):
1123
"""List all files in the tree that have text or content conflicts.
1124
DEPRECATED. Use conflicts instead."""
1125
return self._iter_conflicts()
1127
def _iter_conflicts(self):
1129
for info in self.list_files():
1131
stem = get_conflicted_stem(path)
1134
if stem not in conflicted:
1135
conflicted.add(stem)
1139
def pull(self, source, overwrite=False, stop_revision=None):
1140
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1143
pp = ProgressPhase("Pull phase", 2, top_pb)
1145
old_revision_history = self.branch.revision_history()
1146
basis_tree = self.basis_tree()
1147
count = self.branch.pull(source, overwrite, stop_revision)
1148
new_revision_history = self.branch.revision_history()
1149
if new_revision_history != old_revision_history:
1151
if len(old_revision_history):
1152
other_revision = old_revision_history[-1]
1154
other_revision = None
1155
repository = self.branch.repository
1156
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1158
new_basis_tree = self.branch.basis_tree()
1159
merge_inner(self.branch,
1166
# TODO - dedup parents list with things merged by pull ?
1167
# reuse the revisiontree we merged against to set the new
1169
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1170
# we have to pull the merge trees out again, because
1171
# merge_inner has set the ids. - this corner is not yet
1172
# layered well enough to prevent double handling.
1173
merges = self.get_parent_ids()[1:]
1174
parent_trees.extend([
1175
(parent, repository.revision_tree(parent)) for
1177
self.set_parent_trees(parent_trees)
1184
"""Yield all unknown files in this WorkingTree.
1186
If there are any unknown directories then only the directory is
1187
returned, not all its children. But if there are unknown files
1188
under a versioned subdirectory, they are returned.
1190
Currently returned depth-first, sorted by name within directories.
1192
## TODO: Work from given directory downwards
1193
for path, dir_entry in self.inventory.directories():
1194
# mutter("search for unknowns in %r", path)
1195
dirabs = self.abspath(path)
1196
if not isdir(dirabs):
1197
# e.g. directory deleted
1201
for subf in os.listdir(dirabs):
1204
if subf not in dir_entry.children:
1205
subf_norm, can_access = osutils.normalized_filename(subf)
1206
if subf_norm != subf and can_access:
1207
if subf_norm not in dir_entry.children:
1208
fl.append(subf_norm)
1214
subp = pathjoin(path, subf)
1217
def _translate_ignore_rule(self, rule):
1218
"""Translate a single ignore rule to a regex.
1220
There are two types of ignore rules. Those that do not contain a / are
1221
matched against the tail of the filename (that is, they do not care
1222
what directory the file is in.) Rules which do contain a slash must
1223
match the entire path. As a special case, './' at the start of the
1224
string counts as a slash in the string but is removed before matching
1225
(e.g. ./foo.c, ./src/foo.c)
1227
:return: The translated regex.
1229
if rule[:2] in ('./', '.\\'):
1231
result = fnmatch.translate(rule[2:])
1232
elif '/' in rule or '\\' in rule:
1234
result = fnmatch.translate(rule)
1236
# default rule style.
1237
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1238
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1239
return "(" + result + ")"
1241
def _combine_ignore_rules(self, rules):
1242
"""Combine a list of ignore rules into a single regex object.
1244
Each individual rule is combined with | to form a big regex, which then
1245
has $ added to it to form something like ()|()|()$. The group index for
1246
each subregex's outermost group is placed in a dictionary mapping back
1247
to the rule. This allows quick identification of the matching rule that
1249
:return: a list of the compiled regex and the matching-group index
1250
dictionaries. We return a list because python complains if you try to
1251
combine more than 100 regexes.
1256
translated_rules = []
1258
translated_rule = self._translate_ignore_rule(rule)
1259
compiled_rule = re.compile(translated_rule)
1260
groups[next_group] = rule
1261
next_group += compiled_rule.groups
1262
translated_rules.append(translated_rule)
1263
if next_group == 99:
1264
result.append((re.compile("|".join(translated_rules)), groups))
1267
translated_rules = []
1268
if len(translated_rules):
1269
result.append((re.compile("|".join(translated_rules)), groups))
1272
def ignored_files(self):
1273
"""Yield list of PATH, IGNORE_PATTERN"""
1274
for subp in self.extras():
1275
pat = self.is_ignored(subp)
1279
def get_ignore_list(self):
1280
"""Return list of ignore patterns.
1282
Cached in the Tree object after the first call.
1284
ignoreset = getattr(self, '_ignoreset', None)
1285
if ignoreset is not None:
1288
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1289
ignore_globs.update(ignores.get_runtime_ignores())
1291
ignore_globs.update(ignores.get_user_ignores())
1293
if self.has_filename(bzrlib.IGNORE_FILENAME):
1294
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1296
ignore_globs.update(ignores.parse_ignore_file(f))
1300
self._ignoreset = ignore_globs
1301
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1304
def _get_ignore_rules_as_regex(self):
1305
"""Return a regex of the ignore rules and a mapping dict.
1307
:return: (ignore rules compiled regex, dictionary mapping rule group
1308
indices to original rule.)
1310
if getattr(self, '_ignoreset', None) is None:
1311
self.get_ignore_list()
1312
return self._ignore_regex
1314
def is_ignored(self, filename):
1315
r"""Check whether the filename matches an ignore pattern.
1317
Patterns containing '/' or '\' need to match the whole path;
1318
others match against only the last component.
1320
If the file is ignored, returns the pattern which caused it to
1321
be ignored, otherwise None. So this can simply be used as a
1322
boolean if desired."""
1324
# TODO: Use '**' to match directories, and other extended
1325
# globbing stuff from cvs/rsync.
1327
# XXX: fnmatch is actually not quite what we want: it's only
1328
# approximately the same as real Unix fnmatch, and doesn't
1329
# treat dotfiles correctly and allows * to match /.
1330
# Eventually it should be replaced with something more
1333
rules = self._get_ignore_rules_as_regex()
1334
for regex, mapping in rules:
1335
match = regex.match(filename)
1336
if match is not None:
1337
# one or more of the groups in mapping will have a non-None
1339
groups = match.groups()
1340
rules = [mapping[group] for group in
1341
mapping if groups[group] is not None]
1345
def kind(self, file_id):
1346
return file_kind(self.id2abspath(file_id))
1349
def last_revision(self):
1350
"""Return the last revision id of this working tree.
1352
In early branch formats this was == the branch last_revision,
1353
but that cannot be relied upon - for working tree operations,
1354
always use tree.last_revision().
1356
return self.branch.last_revision()
1358
def is_locked(self):
1359
return self._control_files.is_locked()
1361
def lock_read(self):
1362
"""See Branch.lock_read, and WorkingTree.unlock."""
1363
self.branch.lock_read()
1365
return self._control_files.lock_read()
1367
self.branch.unlock()
1370
def lock_write(self):
1371
"""See Branch.lock_write, and WorkingTree.unlock."""
1372
self.branch.lock_write()
1374
return self._control_files.lock_write()
1376
self.branch.unlock()
1379
def get_physical_lock_status(self):
1380
return self._control_files.get_physical_lock_status()
1382
def _basis_inventory_name(self):
1383
return 'basis-inventory'
1386
def set_last_revision(self, new_revision):
1387
"""Change the last revision in the working tree."""
1388
if self._change_last_revision(new_revision):
1389
self._cache_basis_inventory(new_revision)
1391
def _change_last_revision(self, new_revision):
1392
"""Template method part of set_last_revision to perform the change.
1394
This is used to allow WorkingTree3 instances to not affect branch
1395
when their last revision is set.
1397
if new_revision is None:
1398
self.branch.set_revision_history([])
1401
self.branch.generate_revision_history(new_revision)
1402
except errors.NoSuchRevision:
1403
# not present in the repo - dont try to set it deeper than the tip
1404
self.branch.set_revision_history([new_revision])
1407
def _cache_basis_inventory(self, new_revision):
1408
"""Cache new_revision as the basis inventory."""
1409
# TODO: this should allow the ready-to-use inventory to be passed in,
1410
# as commit already has that ready-to-use [while the format is the
1413
# this double handles the inventory - unpack and repack -
1414
# but is easier to understand. We can/should put a conditional
1415
# in here based on whether the inventory is in the latest format
1416
# - perhaps we should repack all inventories on a repository
1418
# the fast path is to copy the raw xml from the repository. If the
1419
# xml contains 'revision_id="', then we assume the right
1420
# revision_id is set. We must check for this full string, because a
1421
# root node id can legitimately look like 'revision_id' but cannot
1423
xml = self.branch.repository.get_inventory_xml(new_revision)
1424
if not 'revision_id="' in xml.split('\n', 1)[0]:
1425
inv = self.branch.repository.deserialise_inventory(
1427
inv.revision_id = new_revision
1428
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1429
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1430
path = self._basis_inventory_name()
1432
self._control_files.put(path, sio)
1433
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1436
def read_basis_inventory(self):
1437
"""Read the cached basis inventory."""
1438
path = self._basis_inventory_name()
1439
return self._control_files.get(path).read()
1442
def read_working_inventory(self):
1443
"""Read the working inventory."""
1444
# ElementTree does its own conversion from UTF-8, so open in
1446
result = bzrlib.xml5.serializer_v5.read_inventory(
1447
self._control_files.get('inventory'))
1448
self._set_inventory(result)
1452
def remove(self, files, verbose=False, to_file=None):
1453
"""Remove nominated files from the working inventory..
1455
This does not remove their text. This does not run on XXX on what? RBC
1457
TODO: Refuse to remove modified files unless --force is given?
1459
TODO: Do something useful with directories.
1461
TODO: Should this remove the text or not? Tough call; not
1462
removing may be useful and the user can just use use rm, and
1463
is the opposite of add. Removing it is consistent with most
1464
other tools. Maybe an option.
1466
## TODO: Normalize names
1467
## TODO: Remove nested loops; better scalability
1468
if isinstance(files, basestring):
1471
inv = self.inventory
1473
# do this before any modifications
1475
fid = inv.path2id(f)
1477
# TODO: Perhaps make this just a warning, and continue?
1478
# This tends to happen when
1479
raise NotVersionedError(path=f)
1481
# having remove it, it must be either ignored or unknown
1482
if self.is_ignored(f):
1486
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1489
self._write_inventory(inv)
1492
def revert(self, filenames, old_tree=None, backups=True,
1493
pb=DummyProgress()):
1494
from transform import revert
1495
from conflicts import resolve
1496
if old_tree is None:
1497
old_tree = self.basis_tree()
1498
conflicts = revert(self, old_tree, filenames, backups, pb)
1499
if not len(filenames):
1500
self.set_parent_ids(self.get_parent_ids()[:1])
1503
resolve(self, filenames, ignore_misses=True)
1506
# XXX: This method should be deprecated in favour of taking in a proper
1507
# new Inventory object.
1509
def set_inventory(self, new_inventory_list):
1510
from bzrlib.inventory import (Inventory,
1515
inv = Inventory(self.get_root_id())
1516
for path, file_id, parent, kind in new_inventory_list:
1517
name = os.path.basename(path)
1520
# fixme, there should be a factory function inv,add_??
1521
if kind == 'directory':
1522
inv.add(InventoryDirectory(file_id, name, parent))
1523
elif kind == 'file':
1524
inv.add(InventoryFile(file_id, name, parent))
1525
elif kind == 'symlink':
1526
inv.add(InventoryLink(file_id, name, parent))
1528
raise BzrError("unknown kind %r" % kind)
1529
self._write_inventory(inv)
1532
def set_root_id(self, file_id):
1533
"""Set the root id for this tree."""
1534
inv = self.read_working_inventory()
1535
orig_root_id = inv.root.file_id
1536
del inv._byid[inv.root.file_id]
1537
inv.root.file_id = file_id
1538
inv._byid[inv.root.file_id] = inv.root
1541
if entry.parent_id == orig_root_id:
1542
entry.parent_id = inv.root.file_id
1543
self._write_inventory(inv)
1546
"""See Branch.unlock.
1548
WorkingTree locking just uses the Branch locking facilities.
1549
This is current because all working trees have an embedded branch
1550
within them. IF in the future, we were to make branch data shareable
1551
between multiple working trees, i.e. via shared storage, then we
1552
would probably want to lock both the local tree, and the branch.
1554
raise NotImplementedError(self.unlock)
1558
"""Update a working tree along its branch.
1560
This will update the branch if its bound too, which means we have multiple trees involved:
1561
The new basis tree of the master.
1562
The old basis tree of the branch.
1563
The old basis tree of the working tree.
1564
The current working tree state.
1565
pathologically all three may be different, and non ancestors of each other.
1566
Conceptually we want to:
1567
Preserve the wt.basis->wt.state changes
1568
Transform the wt.basis to the new master basis.
1569
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1570
Restore the wt.basis->wt.state changes.
1572
There isn't a single operation at the moment to do that, so we:
1573
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1574
Do a 'normal' merge of the old branch basis if it is relevant.
1576
old_tip = self.branch.update()
1577
# here if old_tip is not None, it is the old tip of the branch before
1578
# it was updated from the master branch. This should become a pending
1579
# merge in the working tree to preserve the user existing work. we
1580
# cant set that until we update the working trees last revision to be
1581
# one from the new branch, because it will just get absorbed by the
1582
# parent de-duplication logic.
1584
# We MUST save it even if an error occurs, because otherwise the users
1585
# local work is unreferenced and will appear to have been lost.
1588
if self.last_revision() != self.branch.last_revision():
1589
# merge tree state up to new branch tip.
1590
basis = self.basis_tree()
1591
to_tree = self.branch.basis_tree()
1592
result += merge_inner(self.branch,
1596
# TODO - dedup parents list with things merged by pull ?
1597
# reuse the tree we've updated to to set the basis:
1598
parent_trees = [(self.branch.last_revision(), to_tree)]
1599
merges = self.get_parent_ids()[1:]
1600
# Ideally we ask the tree for the trees here, that way the working
1601
# tree can decide whether to give us teh entire tree or give us a
1602
# lazy initialised tree. dirstate for instance will have the trees
1603
# in ram already, whereas a last-revision + basis-inventory tree
1604
# will not, but also does not need them when setting parents.
1605
for parent in merges:
1606
parent_trees.append(
1607
(parent, self.branch.repository.revision_tree(parent)))
1608
if old_tip is not None:
1609
parent_trees.append(
1610
(old_tip, self.branch.repository.revision_tree(old_tip)))
1611
self.set_parent_trees(parent_trees)
1613
# the working tree had the same last-revision as the master
1614
# branch did. We may still have pivot local work from the local
1615
# branch into old_tip:
1616
if old_tip is not None:
1617
self.add_parent_tree_id(old_tip)
1618
if old_tip and old_tip != self.last_revision():
1619
# our last revision was not the prior branch last revision
1620
# and we have converted that last revision to a pending merge.
1621
# base is somewhere between the branch tip now
1622
# and the now pending merge
1623
from bzrlib.revision import common_ancestor
1625
base_rev_id = common_ancestor(self.branch.last_revision(),
1627
self.branch.repository)
1628
except errors.NoCommonAncestor:
1630
base_tree = self.branch.repository.revision_tree(base_rev_id)
1631
other_tree = self.branch.repository.revision_tree(old_tip)
1632
result += merge_inner(self.branch,
1639
def _write_inventory(self, inv):
1640
"""Write inventory as the current inventory."""
1642
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1644
self._control_files.put('inventory', sio)
1645
self._set_inventory(inv)
1646
mutter('wrote working inventory')
1648
def set_conflicts(self, arg):
1649
raise UnsupportedOperation(self.set_conflicts, self)
1651
def add_conflicts(self, arg):
1652
raise UnsupportedOperation(self.add_conflicts, self)
1655
def conflicts(self):
1656
conflicts = ConflictList()
1657
for conflicted in self._iter_conflicts():
1660
if file_kind(self.abspath(conflicted)) != "file":
1662
except errors.NoSuchFile:
1665
for suffix in ('.THIS', '.OTHER'):
1667
kind = file_kind(self.abspath(conflicted+suffix))
1670
except errors.NoSuchFile:
1674
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1675
conflicts.append(Conflict.factory(ctype, path=conflicted,
1676
file_id=self.path2id(conflicted)))
1680
class WorkingTree2(WorkingTree):
1681
"""This is the Format 2 working tree.
1683
This was the first weave based working tree.
1684
- uses os locks for locking.
1685
- uses the branch last-revision.
1689
# we share control files:
1690
if self._hashcache.needs_write and self._control_files._lock_count==3:
1691
self._hashcache.write()
1692
# reverse order of locking.
1694
return self._control_files.unlock()
1696
self.branch.unlock()
1699
class WorkingTree3(WorkingTree):
1700
"""This is the Format 3 working tree.
1702
This differs from the base WorkingTree by:
1703
- having its own file lock
1704
- having its own last-revision property.
1706
This is new in bzr 0.8
1710
def last_revision(self):
1711
"""See WorkingTree.last_revision."""
1713
return self._control_files.get_utf8('last-revision').read()
1717
def _change_last_revision(self, revision_id):
1718
"""See WorkingTree._change_last_revision."""
1719
if revision_id is None or revision_id == NULL_REVISION:
1721
self._control_files._transport.delete('last-revision')
1722
except errors.NoSuchFile:
1726
self._control_files.put_utf8('last-revision', revision_id)
1730
def set_conflicts(self, conflicts):
1731
self._put_rio('conflicts', conflicts.to_stanzas(),
1735
def add_conflicts(self, new_conflicts):
1736
conflict_set = set(self.conflicts())
1737
conflict_set.update(set(list(new_conflicts)))
1738
self.set_conflicts(ConflictList(sorted(conflict_set,
1739
key=Conflict.sort_key)))
1742
def conflicts(self):
1744
confile = self._control_files.get('conflicts')
1746
return ConflictList()
1748
if confile.next() != CONFLICT_HEADER_1 + '\n':
1749
raise ConflictFormatError()
1750
except StopIteration:
1751
raise ConflictFormatError()
1752
return ConflictList.from_stanzas(RioReader(confile))
1755
if self._hashcache.needs_write and self._control_files._lock_count==1:
1756
self._hashcache.write()
1757
# reverse order of locking.
1759
return self._control_files.unlock()
1761
self.branch.unlock()
1764
def get_conflicted_stem(path):
1765
for suffix in CONFLICT_SUFFIXES:
1766
if path.endswith(suffix):
1767
return path[:-len(suffix)]
1769
@deprecated_function(zero_eight)
1770
def is_control_file(filename):
1771
"""See WorkingTree.is_control_filename(filename)."""
1772
## FIXME: better check
1773
filename = normpath(filename)
1774
while filename != '':
1775
head, tail = os.path.split(filename)
1776
## mutter('check %r for control file' % ((head, tail),))
1779
if filename == head:
1785
class WorkingTreeFormat(object):
1786
"""An encapsulation of the initialization and open routines for a format.
1788
Formats provide three things:
1789
* An initialization routine,
1793
Formats are placed in an dict by their format string for reference
1794
during workingtree opening. Its not required that these be instances, they
1795
can be classes themselves with class methods - it simply depends on
1796
whether state is needed for a given format or not.
1798
Once a format is deprecated, just deprecate the initialize and open
1799
methods on the format class. Do not deprecate the object, as the
1800
object will be created every time regardless.
1803
_default_format = None
1804
"""The default format used for new trees."""
1807
"""The known formats."""
1810
def find_format(klass, a_bzrdir):
1811
"""Return the format for the working tree object in a_bzrdir."""
1813
transport = a_bzrdir.get_workingtree_transport(None)
1814
format_string = transport.get("format").read()
1815
return klass._formats[format_string]
1817
raise errors.NoWorkingTree(base=transport.base)
1819
raise errors.UnknownFormatError(format=format_string)
1822
def get_default_format(klass):
1823
"""Return the current default format."""
1824
return klass._default_format
1826
def get_format_string(self):
1827
"""Return the ASCII format string that identifies this format."""
1828
raise NotImplementedError(self.get_format_string)
1830
def get_format_description(self):
1831
"""Return the short description for this format."""
1832
raise NotImplementedError(self.get_format_description)
1834
def is_supported(self):
1835
"""Is this format supported?
1837
Supported formats can be initialized and opened.
1838
Unsupported formats may not support initialization or committing or
1839
some other features depending on the reason for not being supported.
1844
def register_format(klass, format):
1845
klass._formats[format.get_format_string()] = format
1848
def set_default_format(klass, format):
1849
klass._default_format = format
1852
def unregister_format(klass, format):
1853
assert klass._formats[format.get_format_string()] is format
1854
del klass._formats[format.get_format_string()]
1858
class WorkingTreeFormat2(WorkingTreeFormat):
1859
"""The second working tree format.
1861
This format modified the hash cache from the format 1 hash cache.
1864
def get_format_description(self):
1865
"""See WorkingTreeFormat.get_format_description()."""
1866
return "Working tree format 2"
1868
def stub_initialize_remote(self, control_files):
1869
"""As a special workaround create critical control files for a remote working tree
1871
This ensures that it can later be updated and dealt with locally,
1872
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1873
no working tree. (See bug #43064).
1877
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1879
control_files.put('inventory', sio)
1881
control_files.put_utf8('pending-merges', '')
1884
def initialize(self, a_bzrdir, revision_id=None):
1885
"""See WorkingTreeFormat.initialize()."""
1886
if not isinstance(a_bzrdir.transport, LocalTransport):
1887
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1888
branch = a_bzrdir.open_branch()
1889
if revision_id is not None:
1892
revision_history = branch.revision_history()
1894
position = revision_history.index(revision_id)
1896
raise errors.NoSuchRevision(branch, revision_id)
1897
branch.set_revision_history(revision_history[:position + 1])
1900
revision = branch.last_revision()
1902
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1908
wt._write_inventory(inv)
1909
wt.set_root_id(inv.root.file_id)
1910
basis_tree = branch.repository.revision_tree(revision)
1911
wt.set_parent_trees([(revision, basis_tree)])
1912
build_tree(basis_tree, wt)
1916
super(WorkingTreeFormat2, self).__init__()
1917
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1919
def open(self, a_bzrdir, _found=False):
1920
"""Return the WorkingTree object for a_bzrdir
1922
_found is a private parameter, do not use it. It is used to indicate
1923
if format probing has already been done.
1926
# we are being called directly and must probe.
1927
raise NotImplementedError
1928
if not isinstance(a_bzrdir.transport, LocalTransport):
1929
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1930
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1936
class WorkingTreeFormat3(WorkingTreeFormat):
1937
"""The second working tree format updated to record a format marker.
1940
- exists within a metadir controlling .bzr
1941
- includes an explicit version marker for the workingtree control
1942
files, separate from the BzrDir format
1943
- modifies the hash cache format
1945
- uses a LockDir to guard access for writes.
1948
def get_format_string(self):
1949
"""See WorkingTreeFormat.get_format_string()."""
1950
return "Bazaar-NG Working Tree format 3"
1952
def get_format_description(self):
1953
"""See WorkingTreeFormat.get_format_description()."""
1954
return "Working tree format 3"
1956
_lock_file_name = 'lock'
1957
_lock_class = LockDir
1959
def _open_control_files(self, a_bzrdir):
1960
transport = a_bzrdir.get_workingtree_transport(None)
1961
return LockableFiles(transport, self._lock_file_name,
1964
def initialize(self, a_bzrdir, revision_id=None):
1965
"""See WorkingTreeFormat.initialize().
1967
revision_id allows creating a working tree at a different
1968
revision than the branch is at.
1970
if not isinstance(a_bzrdir.transport, LocalTransport):
1971
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1972
transport = a_bzrdir.get_workingtree_transport(self)
1973
control_files = self._open_control_files(a_bzrdir)
1974
control_files.create_lock()
1975
control_files.lock_write()
1976
control_files.put_utf8('format', self.get_format_string())
1977
branch = a_bzrdir.open_branch()
1978
if revision_id is None:
1979
revision_id = branch.last_revision()
1981
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1987
_control_files=control_files)
1990
wt._write_inventory(inv)
1991
wt.set_root_id(inv.root.file_id)
1992
basis_tree = branch.repository.revision_tree(revision_id)
1993
if revision_id == bzrlib.revision.NULL_REVISION:
1994
wt.set_parent_trees([])
1996
wt.set_parent_trees([(revision_id, basis_tree)])
1997
build_tree(basis_tree, wt)
2000
control_files.unlock()
2004
super(WorkingTreeFormat3, self).__init__()
2005
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2007
def open(self, a_bzrdir, _found=False):
2008
"""Return the WorkingTree object for a_bzrdir
2010
_found is a private parameter, do not use it. It is used to indicate
2011
if format probing has already been done.
2014
# we are being called directly and must probe.
2015
raise NotImplementedError
2016
if not isinstance(a_bzrdir.transport, LocalTransport):
2017
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2018
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2020
def _open(self, a_bzrdir, control_files):
2021
"""Open the tree itself.
2023
:param a_bzrdir: the dir for the tree.
2024
:param control_files: the control files for the tree.
2026
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2030
_control_files=control_files)
2033
return self.get_format_string()
2036
# formats which have no format string are not discoverable
2037
# and not independently creatable, so are not registered.
2038
__default_format = WorkingTreeFormat3()
2039
WorkingTreeFormat.register_format(__default_format)
2040
WorkingTreeFormat.set_default_format(__default_format)
2041
_legacy_formats = [WorkingTreeFormat2(),
2045
class WorkingTreeTestProviderAdapter(object):
2046
"""A tool to generate a suite testing multiple workingtree formats at once.
2048
This is done by copying the test once for each transport and injecting
2049
the transport_server, transport_readonly_server, and workingtree_format
2050
classes into each copy. Each copy is also given a new id() to make it
2054
def __init__(self, transport_server, transport_readonly_server, formats):
2055
self._transport_server = transport_server
2056
self._transport_readonly_server = transport_readonly_server
2057
self._formats = formats
2059
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2060
"""Clone test for adaption."""
2061
new_test = deepcopy(test)
2062
new_test.transport_server = self._transport_server
2063
new_test.transport_readonly_server = self._transport_readonly_server
2064
new_test.bzrdir_format = bzrdir_format
2065
new_test.workingtree_format = workingtree_format
2066
def make_new_test_id():
2067
new_id = "%s(%s)" % (test.id(), variation)
2068
return lambda: new_id
2069
new_test.id = make_new_test_id()
2072
def adapt(self, test):
2073
from bzrlib.tests import TestSuite
2074
result = TestSuite()
2075
for workingtree_format, bzrdir_format in self._formats:
2076
new_test = self._clone_test(
2079
workingtree_format, workingtree_format.__class__.__name__)
2080
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
