1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
46
from copy import deepcopy
56
conflicts as _mod_conflicts,
67
from bzrlib.transport import get_transport
71
from bzrlib.decorators import needs_read_lock, needs_write_lock
72
from bzrlib.errors import (BzrCheckError,
75
WeaveRevisionNotPresent,
79
MergeModifiedFormatError,
82
from bzrlib.inventory import InventoryEntry, Inventory
83
from bzrlib.lockable_files import LockableFiles, TransportLock
84
from bzrlib.lockdir import LockDir
85
from bzrlib.osutils import (
97
from bzrlib.trace import mutter, note
98
from bzrlib.transport.local import LocalTransport
100
from bzrlib.progress import DummyProgress, ProgressPhase
101
from bzrlib.revision import NULL_REVISION
102
from bzrlib.rio import RioReader, rio_file, Stanza
103
from bzrlib.symbol_versioning import (deprecated_passed,
106
DEPRECATED_PARAMETER,
112
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
113
CONFLICT_HEADER_1 = "BZR conflict list format 1"
115
# the regex removes any weird characters; we don't escape them
116
# but rather just pull them out
117
_gen_file_id_re = re.compile(r'[^\w.]')
118
_gen_id_suffix = None
122
def _next_id_suffix():
123
"""Create a new file id suffix that is reasonably unique.
125
On the first call we combine the current time with 64 bits of randomness
126
to give a highly probably globally unique number. Then each call in the same
127
process adds 1 to a serial number we append to that unique value.
129
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
130
# than having to move the id randomness out of the inner loop like this.
131
# XXX TODO: for the global randomness this uses we should add the thread-id
132
# before the serial #.
133
global _gen_id_suffix, _gen_id_serial
134
if _gen_id_suffix is None:
135
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
137
return _gen_id_suffix + str(_gen_id_serial)
140
def gen_file_id(name):
141
"""Return new file id for the basename 'name'.
143
The uniqueness is supplied from _next_id_suffix.
145
# The real randomness is in the _next_id_suffix, the
146
# rest of the identifier is just to be nice.
148
# 1) Remove non-ascii word characters to keep the ids portable
149
# 2) squash to lowercase, so the file id doesn't have to
150
# be escaped (case insensitive filesystems would bork for ids
151
# that only differred in case without escaping).
152
# 3) truncate the filename to 20 chars. Long filenames also bork on some
154
# 4) Removing starting '.' characters to prevent the file ids from
155
# being considered hidden.
156
ascii_word_only = _gen_file_id_re.sub('', name.lower())
157
short_no_dots = ascii_word_only.lstrip('.')[:20]
158
return short_no_dots + _next_id_suffix()
162
"""Return a new tree-root file id."""
163
return gen_file_id('TREE_ROOT')
166
class TreeEntry(object):
167
"""An entry that implements the minimum interface used by commands.
169
This needs further inspection, it may be better to have
170
InventoryEntries without ids - though that seems wrong. For now,
171
this is a parallel hierarchy to InventoryEntry, and needs to become
172
one of several things: decorates to that hierarchy, children of, or
174
Another note is that these objects are currently only used when there is
175
no InventoryEntry available - i.e. for unversioned objects.
176
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
179
def __eq__(self, other):
180
# yes, this us ugly, TODO: best practice __eq__ style.
181
return (isinstance(other, TreeEntry)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeDirectory(TreeEntry):
189
"""See TreeEntry. This is a directory in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeDirectory)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class TreeFile(TreeEntry):
200
"""See TreeEntry. This is a regular file in a working tree."""
202
def __eq__(self, other):
203
return (isinstance(other, TreeFile)
204
and other.__class__ == self.__class__)
206
def kind_character(self):
210
class TreeLink(TreeEntry):
211
"""See TreeEntry. This is a symlink in a working tree."""
213
def __eq__(self, other):
214
return (isinstance(other, TreeLink)
215
and other.__class__ == self.__class__)
217
def kind_character(self):
221
class WorkingTree(bzrlib.tree.Tree):
222
"""Working copy tree.
224
The inventory is held in the `Branch` working-inventory, and the
225
files are in a directory on disk.
227
It is possible for a `WorkingTree` to have a filename which is
228
not listed in the Inventory and vice versa.
231
def __init__(self, basedir='.',
232
branch=DEPRECATED_PARAMETER,
238
"""Construct a WorkingTree for basedir.
240
If the branch is not supplied, it is opened automatically.
241
If the branch is supplied, it must be the branch for this basedir.
242
(branch.base is not cross checked, because for remote branches that
243
would be meaningless).
245
self._format = _format
246
self.bzrdir = _bzrdir
248
# not created via open etc.
249
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
250
"Please use bzrdir.open_workingtree or WorkingTree.open().",
253
wt = WorkingTree.open(basedir)
254
self._branch = wt.branch
255
self.basedir = wt.basedir
256
self._control_files = wt._control_files
257
self._hashcache = wt._hashcache
258
self._set_inventory(wt._inventory)
259
self._format = wt._format
260
self.bzrdir = wt.bzrdir
261
from bzrlib.hashcache import HashCache
262
from bzrlib.trace import note, mutter
263
assert isinstance(basedir, basestring), \
264
"base directory %r is not a string" % basedir
265
basedir = safe_unicode(basedir)
266
mutter("opening working tree %r", basedir)
267
if deprecated_passed(branch):
269
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
270
" Please use bzrdir.open_workingtree() or"
271
" WorkingTree.open().",
275
self._branch = branch
277
self._branch = self.bzrdir.open_branch()
278
self.basedir = realpath(basedir)
279
# if branch is at our basedir and is a format 6 or less
280
if isinstance(self._format, WorkingTreeFormat2):
281
# share control object
282
self._control_files = self.branch.control_files
284
# assume all other formats have their own control files.
285
assert isinstance(_control_files, LockableFiles), \
286
"_control_files must be a LockableFiles, not %r" \
288
self._control_files = _control_files
289
# update the whole cache up front and write to disk if anything changed;
290
# in the future we might want to do this more selectively
291
# two possible ways offer themselves : in self._unlock, write the cache
292
# if needed, or, when the cache sees a change, append it to the hash
293
# cache file, and have the parser take the most recent entry for a
295
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
296
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
298
# is this scan needed ? it makes things kinda slow.
305
if _inventory is None:
306
self._set_inventory(self.read_working_inventory())
308
self._set_inventory(_inventory)
311
fget=lambda self: self._branch,
312
doc="""The branch this WorkingTree is connected to.
314
This cannot be set - it is reflective of the actual disk structure
315
the working tree has been constructed from.
318
def break_lock(self):
319
"""Break a lock if one is present from another instance.
321
Uses the ui factory to ask for confirmation if the lock may be from
324
This will probe the repository for its lock as well.
326
self._control_files.break_lock()
327
self.branch.break_lock()
329
def _set_inventory(self, inv):
330
assert inv.root is not None
331
self._inventory = inv
332
self.path2id = self._inventory.path2id
334
def is_control_filename(self, filename):
335
"""True if filename is the name of a control file in this tree.
337
:param filename: A filename within the tree. This is a relative path
338
from the root of this tree.
340
This is true IF and ONLY IF the filename is part of the meta data
341
that bzr controls in this tree. I.E. a random .bzr directory placed
342
on disk will not be a control file for this tree.
344
return self.bzrdir.is_control_filename(filename)
347
def open(path=None, _unsupported=False):
348
"""Open an existing working tree at path.
352
path = os.path.getcwdu()
353
control = bzrdir.BzrDir.open(path, _unsupported)
354
return control.open_workingtree(_unsupported)
357
def open_containing(path=None):
358
"""Open an existing working tree which has its root about path.
360
This probes for a working tree at path and searches upwards from there.
362
Basically we keep looking up until we find the control directory or
363
run into /. If there isn't one, raises NotBranchError.
364
TODO: give this a new exception.
365
If there is one, it is returned, along with the unused portion of path.
367
:return: The WorkingTree that contains 'path', and the rest of path
370
path = osutils.getcwd()
371
control, relpath = bzrdir.BzrDir.open_containing(path)
373
return control.open_workingtree(), relpath
376
def open_downlevel(path=None):
377
"""Open an unsupported working tree.
379
Only intended for advanced situations like upgrading part of a bzrdir.
381
return WorkingTree.open(path, _unsupported=True)
384
"""Iterate through file_ids for this tree.
386
file_ids are in a WorkingTree if they are in the working inventory
387
and the working file exists.
389
inv = self._inventory
390
for path, ie in inv.iter_entries():
391
if osutils.lexists(self.abspath(path)):
395
return "<%s of %s>" % (self.__class__.__name__,
396
getattr(self, 'basedir', None))
398
def abspath(self, filename):
399
return pathjoin(self.basedir, filename)
401
def basis_tree(self):
402
"""Return RevisionTree for the current last revision.
404
If the left most parent is a ghost then the returned tree will be an
405
empty tree - one obtained by calling repository.revision_tree(None).
408
revision_id = self.get_parent_ids()[0]
410
# no parents, return an empty revision tree.
411
# in the future this should return the tree for
412
# 'empty:' - the implicit root empty tree.
413
return self.branch.repository.revision_tree(None)
416
xml = self.read_basis_inventory()
417
inv = xml5.serializer_v5.read_inventory_from_string(xml)
418
inv.root.revision = revision_id
421
if inv is not None and inv.revision_id == revision_id:
422
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
424
# No cached copy available, retrieve from the repository.
425
# FIXME? RBC 20060403 should we cache the inventory locally
428
return self.branch.repository.revision_tree(revision_id)
429
except errors.RevisionNotPresent:
430
# the basis tree *may* be a ghost or a low level error may have
431
# occured. If the revision is present, its a problem, if its not
433
if self.branch.repository.has_revision(revision_id):
435
# the basis tree is a ghost so return an empty tree.
436
return self.branch.repository.revision_tree(None)
439
@deprecated_method(zero_eight)
440
def create(branch, directory):
441
"""Create a workingtree for branch at directory.
443
If existing_directory already exists it must have a .bzr directory.
444
If it does not exist, it will be created.
446
This returns a new WorkingTree object for the new checkout.
448
TODO FIXME RBC 20060124 when we have checkout formats in place this
449
should accept an optional revisionid to checkout [and reject this if
450
checking out into the same dir as a pre-checkout-aware branch format.]
452
XXX: When BzrDir is present, these should be created through that
455
warnings.warn('delete WorkingTree.create', stacklevel=3)
456
transport = get_transport(directory)
457
if branch.bzrdir.root_transport.base == transport.base:
459
return branch.bzrdir.create_workingtree()
460
# different directory,
461
# create a branch reference
462
# and now a working tree.
463
raise NotImplementedError
466
@deprecated_method(zero_eight)
467
def create_standalone(directory):
468
"""Create a checkout and a branch and a repo at directory.
470
Directory must exist and be empty.
472
please use BzrDir.create_standalone_workingtree
474
return bzrdir.BzrDir.create_standalone_workingtree(directory)
476
def relpath(self, path):
477
"""Return the local path portion from a given path.
479
The path may be absolute or relative. If its a relative path it is
480
interpreted relative to the python current working directory.
482
return osutils.relpath(self.basedir, path)
484
def has_filename(self, filename):
485
return osutils.lexists(self.abspath(filename))
487
def get_file(self, file_id):
488
return self.get_file_byname(self.id2path(file_id))
490
def get_file_text(self, file_id):
491
return self.get_file(file_id).read()
493
def get_file_byname(self, filename):
494
return file(self.abspath(filename), 'rb')
496
def get_parent_ids(self):
497
"""See Tree.get_parent_ids.
499
This implementation reads the pending merges list and last_revision
500
value and uses that to decide what the parents list should be.
502
last_rev = self._last_revision()
508
merges_file = self._control_files.get_utf8('pending-merges')
512
for l in merges_file.readlines():
513
parents.append(l.rstrip('\n'))
516
def get_root_id(self):
517
"""Return the id of this trees root"""
518
inv = self.read_working_inventory()
519
return inv.root.file_id
521
def _get_store_filename(self, file_id):
522
## XXX: badly named; this is not in the store at all
523
return self.abspath(self.id2path(file_id))
526
def clone(self, to_bzrdir, revision_id=None, basis=None):
527
"""Duplicate this working tree into to_bzr, including all state.
529
Specifically modified files are kept as modified, but
530
ignored and unknown files are discarded.
532
If you want to make a new line of development, see bzrdir.sprout()
535
If not None, the cloned tree will have its last revision set to
536
revision, and and difference between the source trees last revision
537
and this one merged in.
540
If not None, a closer copy of a tree which may have some files in
541
common, and which file content should be preferentially copied from.
543
# assumes the target bzr dir format is compatible.
544
result = self._format.initialize(to_bzrdir)
545
self.copy_content_into(result, revision_id)
549
def copy_content_into(self, tree, revision_id=None):
550
"""Copy the current content and user files of this tree into tree."""
551
if revision_id is None:
552
merge.transform_tree(tree, self)
554
# TODO now merge from tree.last_revision to revision (to preserve
555
# user local changes)
556
merge.transform_tree(tree, self)
557
tree.set_parent_ids([revision_id])
560
def commit(self, message=None, revprops=None, *args, **kwargs):
561
# avoid circular imports
562
from bzrlib.commit import Commit
565
if not 'branch-nick' in revprops:
566
revprops['branch-nick'] = self.branch.nick
567
# args for wt.commit start at message from the Commit.commit method,
568
# but with branch a kwarg now, passing in args as is results in the
569
#message being used for the branch
570
args = (DEPRECATED_PARAMETER, message, ) + args
571
committed_id = Commit().commit( working_tree=self, revprops=revprops,
575
def id2abspath(self, file_id):
576
return self.abspath(self.id2path(file_id))
578
def has_id(self, file_id):
579
# files that have been deleted are excluded
580
inv = self._inventory
581
if not inv.has_id(file_id):
583
path = inv.id2path(file_id)
584
return osutils.lexists(self.abspath(path))
586
def has_or_had_id(self, file_id):
587
if file_id == self.inventory.root.file_id:
589
return self.inventory.has_id(file_id)
591
__contains__ = has_id
593
def get_file_size(self, file_id):
594
return os.path.getsize(self.id2abspath(file_id))
597
def get_file_sha1(self, file_id, path=None):
599
path = self._inventory.id2path(file_id)
600
return self._hashcache.get_sha1(path)
602
def get_file_mtime(self, file_id, path=None):
604
path = self._inventory.id2path(file_id)
605
return os.lstat(self.abspath(path)).st_mtime
607
if not supports_executable():
608
def is_executable(self, file_id, path=None):
609
return self._inventory[file_id].executable
611
def is_executable(self, file_id, path=None):
613
path = self._inventory.id2path(file_id)
614
mode = os.lstat(self.abspath(path)).st_mode
615
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
618
def add(self, files, ids=None):
619
"""Make files versioned.
621
Note that the command line normally calls smart_add instead,
622
which can automatically recurse.
624
This adds the files to the inventory, so that they will be
625
recorded by the next commit.
628
List of paths to add, relative to the base of the tree.
631
If set, use these instead of automatically generated ids.
632
Must be the same length as the list of files, but may
633
contain None for ids that are to be autogenerated.
635
TODO: Perhaps have an option to add the ids even if the files do
638
TODO: Perhaps callback with the ids and paths as they're added.
640
# TODO: Re-adding a file that is removed in the working copy
641
# should probably put it back with the previous ID.
642
if isinstance(files, basestring):
643
assert(ids is None or isinstance(ids, basestring))
649
ids = [None] * len(files)
651
assert(len(ids) == len(files))
653
inv = self.read_working_inventory()
654
for f,file_id in zip(files, ids):
655
if self.is_control_filename(f):
656
raise errors.ForbiddenControlFileError(filename=f)
661
raise BzrError("cannot add top-level %r" % f)
663
fullpath = normpath(self.abspath(f))
665
kind = file_kind(fullpath)
667
if e.errno == errno.ENOENT:
668
raise NoSuchFile(fullpath)
669
if not InventoryEntry.versionable_kind(kind):
670
raise errors.BadFileKindError(filename=f, kind=kind)
672
inv.add_path(f, kind=kind)
674
inv.add_path(f, kind=kind, file_id=file_id)
676
self._write_inventory(inv)
679
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
680
"""Add revision_id as a parent.
682
This is equivalent to retrieving the current list of parent ids
683
and setting the list to its value plus revision_id.
685
:param revision_id: The revision id to add to the parent list. It may
686
be a ghost revision as long as its not the first parent to be added,
687
or the allow_leftmost_as_ghost parameter is set True.
688
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
690
parents = self.get_parent_ids() + [revision_id]
691
self.set_parent_ids(parents,
692
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
695
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
696
"""Add revision_id, tree tuple as a parent.
698
This is equivalent to retrieving the current list of parent trees
699
and setting the list to its value plus parent_tuple. See also
700
add_parent_tree_id - if you only have a parent id available it will be
701
simpler to use that api. If you have the parent already available, using
702
this api is preferred.
704
:param parent_tuple: The (revision id, tree) to add to the parent list.
705
If the revision_id is a ghost, pass None for the tree.
706
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
708
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
709
if len(parent_ids) > 1:
710
# the leftmost may have already been a ghost, preserve that if it
712
allow_leftmost_as_ghost = True
713
self.set_parent_ids(parent_ids,
714
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
717
def add_pending_merge(self, *revision_ids):
718
# TODO: Perhaps should check at this point that the
719
# history of the revision is actually present?
720
parents = self.get_parent_ids()
722
for rev_id in revision_ids:
723
if rev_id in parents:
725
parents.append(rev_id)
728
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
730
@deprecated_method(zero_eleven)
732
def pending_merges(self):
733
"""Return a list of pending merges.
735
These are revisions that have been merged into the working
736
directory but not yet committed.
738
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
739
instead - which is available on all tree objects.
741
return self.get_parent_ids()[1:]
744
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
745
"""Set the parent ids to revision_ids.
747
See also set_parent_trees. This api will try to retrieve the tree data
748
for each element of revision_ids from the trees repository. If you have
749
tree data already available, it is more efficient to use
750
set_parent_trees rather than set_parent_ids. set_parent_ids is however
751
an easier API to use.
753
:param revision_ids: The revision_ids to set as the parent ids of this
754
working tree. Any of these may be ghosts.
756
if len(revision_ids) > 0:
757
leftmost_id = revision_ids[0]
758
if (not allow_leftmost_as_ghost and not
759
self.branch.repository.has_revision(leftmost_id)):
760
raise errors.GhostRevisionUnusableHere(leftmost_id)
761
self.set_last_revision(leftmost_id)
763
self.set_last_revision(None)
764
merges = revision_ids[1:]
765
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
768
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
769
"""Set the parents of the working tree.
771
:param parents_list: A list of (revision_id, tree) tuples.
772
If tree is None, then that element is treated as an unreachable
773
parent tree - i.e. a ghost.
775
# parent trees are not used in current format trees, delegate to
777
self.set_parent_ids([rev for (rev, tree) in parents_list],
778
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
781
def set_pending_merges(self, rev_list):
782
parents = self.get_parent_ids()
783
leftmost = parents[:1]
784
new_parents = leftmost + rev_list
785
self.set_parent_ids(new_parents)
788
def set_merge_modified(self, modified_hashes):
790
for file_id, hash in modified_hashes.iteritems():
791
yield Stanza(file_id=file_id, hash=hash)
792
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
795
def _put_rio(self, filename, stanzas, header):
796
my_file = rio_file(stanzas, header)
797
self._control_files.put(filename, my_file)
800
def merge_from_branch(self, branch, to_revision=None):
801
"""Merge from a branch into this working tree.
803
:param branch: The branch to merge from.
804
:param to_revision: If non-None, the merge will merge to to_revision, but
805
not beyond it. to_revision does not need to be in the history of
806
the branch when it is supplied. If None, to_revision defaults to
807
branch.last_revision().
809
from bzrlib.merge import Merger, Merge3Merger
810
pb = bzrlib.ui.ui_factory.nested_progress_bar()
812
merger = Merger(self.branch, this_tree=self, pb=pb)
813
merger.pp = ProgressPhase("Merge phase", 5, pb)
814
merger.pp.next_phase()
815
# check that there are no
817
merger.check_basis(check_clean=True, require_commits=False)
818
if to_revision is None:
819
to_revision = branch.last_revision()
820
merger.other_rev_id = to_revision
821
if merger.other_rev_id is None:
822
raise error.NoCommits(branch)
823
self.branch.fetch(branch, last_revision=merger.other_rev_id)
824
merger.other_basis = merger.other_rev_id
825
merger.other_tree = self.branch.repository.revision_tree(
827
merger.pp.next_phase()
829
if merger.base_rev_id == merger.other_rev_id:
830
raise errors.PointlessMerge
831
merger.backup_files = False
832
merger.merge_type = Merge3Merger
833
merger.set_interesting_files(None)
834
merger.show_base = False
835
merger.reprocess = False
836
conflicts = merger.do_merge()
843
def merge_modified(self):
845
hashfile = self._control_files.get('merge-hashes')
850
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
851
raise MergeModifiedFormatError()
852
except StopIteration:
853
raise MergeModifiedFormatError()
854
for s in RioReader(hashfile):
855
file_id = s.get("file_id")
856
if file_id not in self.inventory:
859
if hash == self.get_file_sha1(file_id):
860
merge_hashes[file_id] = hash
863
def get_symlink_target(self, file_id):
864
return os.readlink(self.id2abspath(file_id))
866
def file_class(self, filename):
867
if self.path2id(filename):
869
elif self.is_ignored(filename):
874
def list_files(self):
875
"""Recursively list all files as (path, class, kind, id, entry).
877
Lists, but does not descend into unversioned directories.
879
This does not include files that have been deleted in this
882
Skips the control directory.
884
inv = self._inventory
885
# Convert these into local objects to save lookup times
886
pathjoin = osutils.pathjoin
887
file_kind = osutils.file_kind
889
# transport.base ends in a slash, we want the piece
890
# between the last two slashes
891
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
893
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
895
# directory file_id, relative path, absolute path, reverse sorted children
896
children = os.listdir(self.basedir)
898
# jam 20060527 The kernel sized tree seems equivalent whether we
899
# use a deque and popleft to keep them sorted, or if we use a plain
900
# list and just reverse() them.
901
children = collections.deque(children)
902
stack = [(inv.root.file_id, u'', self.basedir, children)]
904
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
907
f = children.popleft()
908
## TODO: If we find a subdirectory with its own .bzr
909
## directory, then that is a separate tree and we
910
## should exclude it.
912
# the bzrdir for this tree
913
if transport_base_dir == f:
916
# we know that from_dir_relpath and from_dir_abspath never end in a slash
917
# and 'f' doesn't begin with one, we can do a string op, rather
918
# than the checks of pathjoin(), all relative paths will have an extra slash
920
fp = from_dir_relpath + '/' + f
923
fap = from_dir_abspath + '/' + f
925
f_ie = inv.get_child(from_dir_id, f)
928
elif self.is_ignored(fp[1:]):
931
# we may not have found this file, because of a unicode issue
932
f_norm, can_access = osutils.normalized_filename(f)
933
if f == f_norm or not can_access:
934
# No change, so treat this file normally
937
# this file can be accessed by a normalized path
938
# check again if it is versioned
939
# these lines are repeated here for performance
941
fp = from_dir_relpath + '/' + f
942
fap = from_dir_abspath + '/' + f
943
f_ie = inv.get_child(from_dir_id, f)
946
elif self.is_ignored(fp[1:]):
955
raise BzrCheckError("file %r entered as kind %r id %r, "
957
% (fap, f_ie.kind, f_ie.file_id, fk))
959
# make a last minute entry
961
yield fp[1:], c, fk, f_ie.file_id, f_ie
964
yield fp[1:], c, fk, None, fk_entries[fk]()
966
yield fp[1:], c, fk, None, TreeEntry()
969
if fk != 'directory':
972
# But do this child first
973
new_children = os.listdir(fap)
975
new_children = collections.deque(new_children)
976
stack.append((f_ie.file_id, fp, fap, new_children))
977
# Break out of inner loop, so that we start outer loop with child
980
# if we finished all children, pop it off the stack
985
def move(self, from_paths, to_name):
988
to_name must exist in the inventory.
990
If to_name exists and is a directory, the files are moved into
991
it, keeping their old names.
993
Note that to_name is only the last component of the new name;
994
this doesn't change the directory.
996
This returns a list of (from_path, to_path) pairs for each
1000
## TODO: Option to move IDs only
1001
assert not isinstance(from_paths, basestring)
1002
inv = self.inventory
1003
to_abs = self.abspath(to_name)
1004
if not isdir(to_abs):
1005
raise BzrError("destination %r is not a directory" % to_abs)
1006
if not self.has_filename(to_name):
1007
raise BzrError("destination %r not in working directory" % to_abs)
1008
to_dir_id = inv.path2id(to_name)
1009
if to_dir_id is None and to_name != '':
1010
raise BzrError("destination %r is not a versioned directory" % to_name)
1011
to_dir_ie = inv[to_dir_id]
1012
if to_dir_ie.kind != 'directory':
1013
raise BzrError("destination %r is not a directory" % to_abs)
1015
to_idpath = inv.get_idpath(to_dir_id)
1017
for f in from_paths:
1018
if not self.has_filename(f):
1019
raise BzrError("%r does not exist in working tree" % f)
1020
f_id = inv.path2id(f)
1022
raise BzrError("%r is not versioned" % f)
1023
name_tail = splitpath(f)[-1]
1024
dest_path = pathjoin(to_name, name_tail)
1025
if self.has_filename(dest_path):
1026
raise BzrError("destination %r already exists" % dest_path)
1027
if f_id in to_idpath:
1028
raise BzrError("can't move %r to a subdirectory of itself" % f)
1030
# OK, so there's a race here, it's possible that someone will
1031
# create a file in this interval and then the rename might be
1032
# left half-done. But we should have caught most problems.
1033
orig_inv = deepcopy(self.inventory)
1035
for f in from_paths:
1036
name_tail = splitpath(f)[-1]
1037
dest_path = pathjoin(to_name, name_tail)
1038
result.append((f, dest_path))
1039
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1041
osutils.rename(self.abspath(f), self.abspath(dest_path))
1043
raise BzrError("failed to rename %r to %r: %s" %
1044
(f, dest_path, e[1]),
1045
["rename rolled back"])
1047
# restore the inventory on error
1048
self._set_inventory(orig_inv)
1050
self._write_inventory(inv)
1054
def rename_one(self, from_rel, to_rel):
1057
This can change the directory or the filename or both.
1059
inv = self.inventory
1060
if not self.has_filename(from_rel):
1061
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1062
if self.has_filename(to_rel):
1063
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1065
file_id = inv.path2id(from_rel)
1067
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1069
entry = inv[file_id]
1070
from_parent = entry.parent_id
1071
from_name = entry.name
1073
if inv.path2id(to_rel):
1074
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1076
to_dir, to_tail = os.path.split(to_rel)
1077
to_dir_id = inv.path2id(to_dir)
1078
if to_dir_id is None and to_dir != '':
1079
raise BzrError("can't determine destination directory id for %r" % to_dir)
1081
mutter("rename_one:")
1082
mutter(" file_id {%s}" % file_id)
1083
mutter(" from_rel %r" % from_rel)
1084
mutter(" to_rel %r" % to_rel)
1085
mutter(" to_dir %r" % to_dir)
1086
mutter(" to_dir_id {%s}" % to_dir_id)
1088
inv.rename(file_id, to_dir_id, to_tail)
1090
from_abs = self.abspath(from_rel)
1091
to_abs = self.abspath(to_rel)
1093
osutils.rename(from_abs, to_abs)
1095
inv.rename(file_id, from_parent, from_name)
1096
raise BzrError("failed to rename %r to %r: %s"
1097
% (from_abs, to_abs, e[1]),
1098
["rename rolled back"])
1099
self._write_inventory(inv)
1103
"""Return all unknown files.
1105
These are files in the working directory that are not versioned or
1106
control files or ignored.
1108
for subp in self.extras():
1109
if not self.is_ignored(subp):
1113
def unversion(self, file_ids):
1114
"""Remove the file ids in file_ids from the current versioned set.
1116
When a file_id is unversioned, all of its children are automatically
1119
:param file_ids: The file ids to stop versioning.
1120
:raises: NoSuchId if any fileid is not currently versioned.
1122
for file_id in file_ids:
1123
if self._inventory.has_id(file_id):
1124
self._inventory.remove_recursive_id(file_id)
1126
raise errors.NoSuchId(self, file_id)
1128
# in the future this should just set a dirty bit to wait for the
1129
# final unlock. However, until all methods of workingtree start
1130
# with the current in -memory inventory rather than triggering
1131
# a read, it is more complex - we need to teach read_inventory
1132
# to know when to read, and when to not read first... and possibly
1133
# to save first when the in memory one may be corrupted.
1134
# so for now, we just only write it if it is indeed dirty.
1136
self._write_inventory(self._inventory)
1138
@deprecated_method(zero_eight)
1139
def iter_conflicts(self):
1140
"""List all files in the tree that have text or content conflicts.
1141
DEPRECATED. Use conflicts instead."""
1142
return self._iter_conflicts()
1144
def _iter_conflicts(self):
1146
for info in self.list_files():
1148
stem = get_conflicted_stem(path)
1151
if stem not in conflicted:
1152
conflicted.add(stem)
1156
def pull(self, source, overwrite=False, stop_revision=None):
1157
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1160
pp = ProgressPhase("Pull phase", 2, top_pb)
1162
old_revision_history = self.branch.revision_history()
1163
basis_tree = self.basis_tree()
1164
count = self.branch.pull(source, overwrite, stop_revision)
1165
new_revision_history = self.branch.revision_history()
1166
if new_revision_history != old_revision_history:
1168
if len(old_revision_history):
1169
other_revision = old_revision_history[-1]
1171
other_revision = None
1172
repository = self.branch.repository
1173
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1175
new_basis_tree = self.branch.basis_tree()
1184
# TODO - dedup parents list with things merged by pull ?
1185
# reuse the revisiontree we merged against to set the new
1187
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1188
# we have to pull the merge trees out again, because
1189
# merge_inner has set the ids. - this corner is not yet
1190
# layered well enough to prevent double handling.
1191
merges = self.get_parent_ids()[1:]
1192
parent_trees.extend([
1193
(parent, repository.revision_tree(parent)) for
1195
self.set_parent_trees(parent_trees)
1202
"""Yield all unknown files in this WorkingTree.
1204
If there are any unknown directories then only the directory is
1205
returned, not all its children. But if there are unknown files
1206
under a versioned subdirectory, they are returned.
1208
Currently returned depth-first, sorted by name within directories.
1210
## TODO: Work from given directory downwards
1211
for path, dir_entry in self.inventory.directories():
1212
# mutter("search for unknowns in %r", path)
1213
dirabs = self.abspath(path)
1214
if not isdir(dirabs):
1215
# e.g. directory deleted
1219
for subf in os.listdir(dirabs):
1222
if subf not in dir_entry.children:
1223
subf_norm, can_access = osutils.normalized_filename(subf)
1224
if subf_norm != subf and can_access:
1225
if subf_norm not in dir_entry.children:
1226
fl.append(subf_norm)
1232
subp = pathjoin(path, subf)
1235
def _translate_ignore_rule(self, rule):
1236
"""Translate a single ignore rule to a regex.
1238
There are two types of ignore rules. Those that do not contain a / are
1239
matched against the tail of the filename (that is, they do not care
1240
what directory the file is in.) Rules which do contain a slash must
1241
match the entire path. As a special case, './' at the start of the
1242
string counts as a slash in the string but is removed before matching
1243
(e.g. ./foo.c, ./src/foo.c)
1245
:return: The translated regex.
1247
if rule[:2] in ('./', '.\\'):
1249
result = fnmatch.translate(rule[2:])
1250
elif '/' in rule or '\\' in rule:
1252
result = fnmatch.translate(rule)
1254
# default rule style.
1255
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1256
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1257
return "(" + result + ")"
1259
def _combine_ignore_rules(self, rules):
1260
"""Combine a list of ignore rules into a single regex object.
1262
Each individual rule is combined with | to form a big regex, which then
1263
has $ added to it to form something like ()|()|()$. The group index for
1264
each subregex's outermost group is placed in a dictionary mapping back
1265
to the rule. This allows quick identification of the matching rule that
1267
:return: a list of the compiled regex and the matching-group index
1268
dictionaries. We return a list because python complains if you try to
1269
combine more than 100 regexes.
1274
translated_rules = []
1276
translated_rule = self._translate_ignore_rule(rule)
1277
compiled_rule = re.compile(translated_rule)
1278
groups[next_group] = rule
1279
next_group += compiled_rule.groups
1280
translated_rules.append(translated_rule)
1281
if next_group == 99:
1282
result.append((re.compile("|".join(translated_rules)), groups))
1285
translated_rules = []
1286
if len(translated_rules):
1287
result.append((re.compile("|".join(translated_rules)), groups))
1290
def ignored_files(self):
1291
"""Yield list of PATH, IGNORE_PATTERN"""
1292
for subp in self.extras():
1293
pat = self.is_ignored(subp)
1297
def get_ignore_list(self):
1298
"""Return list of ignore patterns.
1300
Cached in the Tree object after the first call.
1302
ignoreset = getattr(self, '_ignoreset', None)
1303
if ignoreset is not None:
1306
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1307
ignore_globs.update(ignores.get_runtime_ignores())
1309
ignore_globs.update(ignores.get_user_ignores())
1311
if self.has_filename(bzrlib.IGNORE_FILENAME):
1312
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1314
ignore_globs.update(ignores.parse_ignore_file(f))
1318
self._ignoreset = ignore_globs
1319
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1322
def _get_ignore_rules_as_regex(self):
1323
"""Return a regex of the ignore rules and a mapping dict.
1325
:return: (ignore rules compiled regex, dictionary mapping rule group
1326
indices to original rule.)
1328
if getattr(self, '_ignoreset', None) is None:
1329
self.get_ignore_list()
1330
return self._ignore_regex
1332
def is_ignored(self, filename):
1333
r"""Check whether the filename matches an ignore pattern.
1335
Patterns containing '/' or '\' need to match the whole path;
1336
others match against only the last component.
1338
If the file is ignored, returns the pattern which caused it to
1339
be ignored, otherwise None. So this can simply be used as a
1340
boolean if desired."""
1342
# TODO: Use '**' to match directories, and other extended
1343
# globbing stuff from cvs/rsync.
1345
# XXX: fnmatch is actually not quite what we want: it's only
1346
# approximately the same as real Unix fnmatch, and doesn't
1347
# treat dotfiles correctly and allows * to match /.
1348
# Eventually it should be replaced with something more
1351
rules = self._get_ignore_rules_as_regex()
1352
for regex, mapping in rules:
1353
match = regex.match(filename)
1354
if match is not None:
1355
# one or more of the groups in mapping will have a non-None
1357
groups = match.groups()
1358
rules = [mapping[group] for group in
1359
mapping if groups[group] is not None]
1363
def kind(self, file_id):
1364
return file_kind(self.id2abspath(file_id))
1366
def last_revision(self):
1367
"""Return the last revision id of this working tree.
1369
In early branch formats this was the same as the branch last_revision,
1370
but that cannot be relied upon - for working tree operations,
1371
always use tree.last_revision(). This returns the left most parent id,
1372
or None if there are no parents.
1374
This was deprecated as of 0.11. Please use get_parent_ids instead.
1376
return self._last_revision()
1379
def _last_revision(self):
1380
"""helper for get_parent_ids."""
1381
return self.branch.last_revision()
1383
def is_locked(self):
1384
return self._control_files.is_locked()
1386
def lock_read(self):
1387
"""See Branch.lock_read, and WorkingTree.unlock."""
1388
self.branch.lock_read()
1390
return self._control_files.lock_read()
1392
self.branch.unlock()
1395
def lock_write(self):
1396
"""See Branch.lock_write, and WorkingTree.unlock."""
1397
self.branch.lock_write()
1399
return self._control_files.lock_write()
1401
self.branch.unlock()
1404
def get_physical_lock_status(self):
1405
return self._control_files.get_physical_lock_status()
1407
def _basis_inventory_name(self):
1408
return 'basis-inventory'
1411
def set_last_revision(self, new_revision):
1412
"""Change the last revision in the working tree."""
1413
if self._change_last_revision(new_revision):
1414
self._cache_basis_inventory(new_revision)
1416
def _change_last_revision(self, new_revision):
1417
"""Template method part of set_last_revision to perform the change.
1419
This is used to allow WorkingTree3 instances to not affect branch
1420
when their last revision is set.
1422
if new_revision is None:
1423
self.branch.set_revision_history([])
1426
self.branch.generate_revision_history(new_revision)
1427
except errors.NoSuchRevision:
1428
# not present in the repo - dont try to set it deeper than the tip
1429
self.branch.set_revision_history([new_revision])
1432
def _cache_basis_inventory(self, new_revision):
1433
"""Cache new_revision as the basis inventory."""
1434
# TODO: this should allow the ready-to-use inventory to be passed in,
1435
# as commit already has that ready-to-use [while the format is the
1438
# this double handles the inventory - unpack and repack -
1439
# but is easier to understand. We can/should put a conditional
1440
# in here based on whether the inventory is in the latest format
1441
# - perhaps we should repack all inventories on a repository
1443
# the fast path is to copy the raw xml from the repository. If the
1444
# xml contains 'revision_id="', then we assume the right
1445
# revision_id is set. We must check for this full string, because a
1446
# root node id can legitimately look like 'revision_id' but cannot
1448
xml = self.branch.repository.get_inventory_xml(new_revision)
1449
if not 'revision_id="' in xml.split('\n', 1)[0]:
1450
inv = self.branch.repository.deserialise_inventory(
1452
inv.revision_id = new_revision
1453
xml = xml5.serializer_v5.write_inventory_to_string(inv)
1454
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1455
path = self._basis_inventory_name()
1457
self._control_files.put(path, sio)
1458
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1461
def read_basis_inventory(self):
1462
"""Read the cached basis inventory."""
1463
path = self._basis_inventory_name()
1464
return self._control_files.get(path).read()
1467
def read_working_inventory(self):
1468
"""Read the working inventory."""
1469
# ElementTree does its own conversion from UTF-8, so open in
1471
result = xml5.serializer_v5.read_inventory(
1472
self._control_files.get('inventory'))
1473
self._set_inventory(result)
1477
def remove(self, files, verbose=False, to_file=None):
1478
"""Remove nominated files from the working inventory..
1480
This does not remove their text. This does not run on XXX on what? RBC
1482
TODO: Refuse to remove modified files unless --force is given?
1484
TODO: Do something useful with directories.
1486
TODO: Should this remove the text or not? Tough call; not
1487
removing may be useful and the user can just use use rm, and
1488
is the opposite of add. Removing it is consistent with most
1489
other tools. Maybe an option.
1491
## TODO: Normalize names
1492
## TODO: Remove nested loops; better scalability
1493
if isinstance(files, basestring):
1496
inv = self.inventory
1498
# do this before any modifications
1500
fid = inv.path2id(f)
1502
# TODO: Perhaps make this just a warning, and continue?
1503
# This tends to happen when
1504
raise NotVersionedError(path=f)
1506
# having remove it, it must be either ignored or unknown
1507
if self.is_ignored(f):
1511
textui.show_status(new_status, inv[fid].kind, f,
1515
self._write_inventory(inv)
1518
def revert(self, filenames, old_tree=None, backups=True,
1519
pb=DummyProgress()):
1520
from bzrlib.conflicts import resolve
1521
if old_tree is None:
1522
old_tree = self.basis_tree()
1523
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1524
if not len(filenames):
1525
self.set_parent_ids(self.get_parent_ids()[:1])
1528
resolve(self, filenames, ignore_misses=True)
1531
# XXX: This method should be deprecated in favour of taking in a proper
1532
# new Inventory object.
1534
def set_inventory(self, new_inventory_list):
1535
from bzrlib.inventory import (Inventory,
1540
inv = Inventory(self.get_root_id())
1541
for path, file_id, parent, kind in new_inventory_list:
1542
name = os.path.basename(path)
1545
# fixme, there should be a factory function inv,add_??
1546
if kind == 'directory':
1547
inv.add(InventoryDirectory(file_id, name, parent))
1548
elif kind == 'file':
1549
inv.add(InventoryFile(file_id, name, parent))
1550
elif kind == 'symlink':
1551
inv.add(InventoryLink(file_id, name, parent))
1553
raise BzrError("unknown kind %r" % kind)
1554
self._write_inventory(inv)
1557
def set_root_id(self, file_id):
1558
"""Set the root id for this tree."""
1559
inv = self.read_working_inventory()
1560
orig_root_id = inv.root.file_id
1561
del inv._byid[inv.root.file_id]
1562
inv.root.file_id = file_id
1563
inv._byid[inv.root.file_id] = inv.root
1566
if entry.parent_id == orig_root_id:
1567
entry.parent_id = inv.root.file_id
1568
self._write_inventory(inv)
1571
"""See Branch.unlock.
1573
WorkingTree locking just uses the Branch locking facilities.
1574
This is current because all working trees have an embedded branch
1575
within them. IF in the future, we were to make branch data shareable
1576
between multiple working trees, i.e. via shared storage, then we
1577
would probably want to lock both the local tree, and the branch.
1579
raise NotImplementedError(self.unlock)
1583
"""Update a working tree along its branch.
1585
This will update the branch if its bound too, which means we have multiple trees involved:
1586
The new basis tree of the master.
1587
The old basis tree of the branch.
1588
The old basis tree of the working tree.
1589
The current working tree state.
1590
pathologically all three may be different, and non ancestors of each other.
1591
Conceptually we want to:
1592
Preserve the wt.basis->wt.state changes
1593
Transform the wt.basis to the new master basis.
1594
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1595
Restore the wt.basis->wt.state changes.
1597
There isn't a single operation at the moment to do that, so we:
1598
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1599
Do a 'normal' merge of the old branch basis if it is relevant.
1601
old_tip = self.branch.update()
1602
# here if old_tip is not None, it is the old tip of the branch before
1603
# it was updated from the master branch. This should become a pending
1604
# merge in the working tree to preserve the user existing work. we
1605
# cant set that until we update the working trees last revision to be
1606
# one from the new branch, because it will just get absorbed by the
1607
# parent de-duplication logic.
1609
# We MUST save it even if an error occurs, because otherwise the users
1610
# local work is unreferenced and will appear to have been lost.
1614
last_rev = self.get_parent_ids()[0]
1617
if last_rev != self.branch.last_revision():
1618
# merge tree state up to new branch tip.
1619
basis = self.basis_tree()
1620
to_tree = self.branch.basis_tree()
1621
result += merge.merge_inner(
1626
# TODO - dedup parents list with things merged by pull ?
1627
# reuse the tree we've updated to to set the basis:
1628
parent_trees = [(self.branch.last_revision(), to_tree)]
1629
merges = self.get_parent_ids()[1:]
1630
# Ideally we ask the tree for the trees here, that way the working
1631
# tree can decide whether to give us teh entire tree or give us a
1632
# lazy initialised tree. dirstate for instance will have the trees
1633
# in ram already, whereas a last-revision + basis-inventory tree
1634
# will not, but also does not need them when setting parents.
1635
for parent in merges:
1636
parent_trees.append(
1637
(parent, self.branch.repository.revision_tree(parent)))
1638
if old_tip is not None:
1639
parent_trees.append(
1640
(old_tip, self.branch.repository.revision_tree(old_tip)))
1641
self.set_parent_trees(parent_trees)
1642
last_rev = parent_trees[0][0]
1644
# the working tree had the same last-revision as the master
1645
# branch did. We may still have pivot local work from the local
1646
# branch into old_tip:
1647
if old_tip is not None:
1648
self.add_parent_tree_id(old_tip)
1649
if old_tip and old_tip != last_rev:
1650
# our last revision was not the prior branch last revision
1651
# and we have converted that last revision to a pending merge.
1652
# base is somewhere between the branch tip now
1653
# and the now pending merge
1654
from bzrlib.revision import common_ancestor
1656
base_rev_id = common_ancestor(self.branch.last_revision(),
1658
self.branch.repository)
1659
except errors.NoCommonAncestor:
1661
base_tree = self.branch.repository.revision_tree(base_rev_id)
1662
other_tree = self.branch.repository.revision_tree(old_tip)
1663
result += merge.merge_inner(
1671
def _write_inventory(self, inv):
1672
"""Write inventory as the current inventory."""
1674
xml5.serializer_v5.write_inventory(inv, sio)
1676
self._control_files.put('inventory', sio)
1677
self._set_inventory(inv)
1678
mutter('wrote working inventory')
1680
def set_conflicts(self, arg):
1681
raise UnsupportedOperation(self.set_conflicts, self)
1683
def add_conflicts(self, arg):
1684
raise UnsupportedOperation(self.add_conflicts, self)
1687
def conflicts(self):
1688
conflicts = _mod_conflicts.ConflictList()
1689
for conflicted in self._iter_conflicts():
1692
if file_kind(self.abspath(conflicted)) != "file":
1694
except errors.NoSuchFile:
1697
for suffix in ('.THIS', '.OTHER'):
1699
kind = file_kind(self.abspath(conflicted+suffix))
1702
except errors.NoSuchFile:
1706
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1707
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1709
file_id=self.path2id(conflicted)))
1713
class WorkingTree2(WorkingTree):
1714
"""This is the Format 2 working tree.
1716
This was the first weave based working tree.
1717
- uses os locks for locking.
1718
- uses the branch last-revision.
1722
# we share control files:
1723
if self._hashcache.needs_write and self._control_files._lock_count==3:
1724
self._hashcache.write()
1725
# reverse order of locking.
1727
return self._control_files.unlock()
1729
self.branch.unlock()
1732
class WorkingTree3(WorkingTree):
1733
"""This is the Format 3 working tree.
1735
This differs from the base WorkingTree by:
1736
- having its own file lock
1737
- having its own last-revision property.
1739
This is new in bzr 0.8
1743
def _last_revision(self):
1744
"""See WorkingTree._last_revision."""
1746
return self._control_files.get_utf8('last-revision').read()
1750
def _change_last_revision(self, revision_id):
1751
"""See WorkingTree._change_last_revision."""
1752
if revision_id is None or revision_id == NULL_REVISION:
1754
self._control_files._transport.delete('last-revision')
1755
except errors.NoSuchFile:
1759
self._control_files.put_utf8('last-revision', revision_id)
1763
def set_conflicts(self, conflicts):
1764
self._put_rio('conflicts', conflicts.to_stanzas(),
1768
def add_conflicts(self, new_conflicts):
1769
conflict_set = set(self.conflicts())
1770
conflict_set.update(set(list(new_conflicts)))
1771
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1772
key=_mod_conflicts.Conflict.sort_key)))
1775
def conflicts(self):
1777
confile = self._control_files.get('conflicts')
1779
return _mod_conflicts.ConflictList()
1781
if confile.next() != CONFLICT_HEADER_1 + '\n':
1782
raise ConflictFormatError()
1783
except StopIteration:
1784
raise ConflictFormatError()
1785
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1788
if self._hashcache.needs_write and self._control_files._lock_count==1:
1789
self._hashcache.write()
1790
# reverse order of locking.
1792
return self._control_files.unlock()
1794
self.branch.unlock()
1797
def get_conflicted_stem(path):
1798
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1799
if path.endswith(suffix):
1800
return path[:-len(suffix)]
1802
@deprecated_function(zero_eight)
1803
def is_control_file(filename):
1804
"""See WorkingTree.is_control_filename(filename)."""
1805
## FIXME: better check
1806
filename = normpath(filename)
1807
while filename != '':
1808
head, tail = os.path.split(filename)
1809
## mutter('check %r for control file' % ((head, tail),))
1812
if filename == head:
1818
class WorkingTreeFormat(object):
1819
"""An encapsulation of the initialization and open routines for a format.
1821
Formats provide three things:
1822
* An initialization routine,
1826
Formats are placed in an dict by their format string for reference
1827
during workingtree opening. Its not required that these be instances, they
1828
can be classes themselves with class methods - it simply depends on
1829
whether state is needed for a given format or not.
1831
Once a format is deprecated, just deprecate the initialize and open
1832
methods on the format class. Do not deprecate the object, as the
1833
object will be created every time regardless.
1836
_default_format = None
1837
"""The default format used for new trees."""
1840
"""The known formats."""
1843
def find_format(klass, a_bzrdir):
1844
"""Return the format for the working tree object in a_bzrdir."""
1846
transport = a_bzrdir.get_workingtree_transport(None)
1847
format_string = transport.get("format").read()
1848
return klass._formats[format_string]
1850
raise errors.NoWorkingTree(base=transport.base)
1852
raise errors.UnknownFormatError(format=format_string)
1855
def get_default_format(klass):
1856
"""Return the current default format."""
1857
return klass._default_format
1859
def get_format_string(self):
1860
"""Return the ASCII format string that identifies this format."""
1861
raise NotImplementedError(self.get_format_string)
1863
def get_format_description(self):
1864
"""Return the short description for this format."""
1865
raise NotImplementedError(self.get_format_description)
1867
def is_supported(self):
1868
"""Is this format supported?
1870
Supported formats can be initialized and opened.
1871
Unsupported formats may not support initialization or committing or
1872
some other features depending on the reason for not being supported.
1877
def register_format(klass, format):
1878
klass._formats[format.get_format_string()] = format
1881
def set_default_format(klass, format):
1882
klass._default_format = format
1885
def unregister_format(klass, format):
1886
assert klass._formats[format.get_format_string()] is format
1887
del klass._formats[format.get_format_string()]
1891
class WorkingTreeFormat2(WorkingTreeFormat):
1892
"""The second working tree format.
1894
This format modified the hash cache from the format 1 hash cache.
1897
def get_format_description(self):
1898
"""See WorkingTreeFormat.get_format_description()."""
1899
return "Working tree format 2"
1901
def stub_initialize_remote(self, control_files):
1902
"""As a special workaround create critical control files for a remote working tree
1904
This ensures that it can later be updated and dealt with locally,
1905
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1906
no working tree. (See bug #43064).
1910
xml5.serializer_v5.write_inventory(inv, sio)
1912
control_files.put('inventory', sio)
1914
control_files.put_utf8('pending-merges', '')
1917
def initialize(self, a_bzrdir, revision_id=None):
1918
"""See WorkingTreeFormat.initialize()."""
1919
if not isinstance(a_bzrdir.transport, LocalTransport):
1920
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1921
branch = a_bzrdir.open_branch()
1922
if revision_id is not None:
1925
revision_history = branch.revision_history()
1927
position = revision_history.index(revision_id)
1929
raise errors.NoSuchRevision(branch, revision_id)
1930
branch.set_revision_history(revision_history[:position + 1])
1933
revision = branch.last_revision()
1935
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1941
wt._write_inventory(inv)
1942
wt.set_root_id(inv.root.file_id)
1943
basis_tree = branch.repository.revision_tree(revision)
1944
wt.set_parent_trees([(revision, basis_tree)])
1945
transform.build_tree(basis_tree, wt)
1949
super(WorkingTreeFormat2, self).__init__()
1950
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1952
def open(self, a_bzrdir, _found=False):
1953
"""Return the WorkingTree object for a_bzrdir
1955
_found is a private parameter, do not use it. It is used to indicate
1956
if format probing has already been done.
1959
# we are being called directly and must probe.
1960
raise NotImplementedError
1961
if not isinstance(a_bzrdir.transport, LocalTransport):
1962
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1963
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1969
class WorkingTreeFormat3(WorkingTreeFormat):
1970
"""The second working tree format updated to record a format marker.
1973
- exists within a metadir controlling .bzr
1974
- includes an explicit version marker for the workingtree control
1975
files, separate from the BzrDir format
1976
- modifies the hash cache format
1978
- uses a LockDir to guard access for writes.
1981
def get_format_string(self):
1982
"""See WorkingTreeFormat.get_format_string()."""
1983
return "Bazaar-NG Working Tree format 3"
1985
def get_format_description(self):
1986
"""See WorkingTreeFormat.get_format_description()."""
1987
return "Working tree format 3"
1989
_lock_file_name = 'lock'
1990
_lock_class = LockDir
1992
def _open_control_files(self, a_bzrdir):
1993
transport = a_bzrdir.get_workingtree_transport(None)
1994
return LockableFiles(transport, self._lock_file_name,
1997
def initialize(self, a_bzrdir, revision_id=None):
1998
"""See WorkingTreeFormat.initialize().
2000
revision_id allows creating a working tree at a different
2001
revision than the branch is at.
2003
if not isinstance(a_bzrdir.transport, LocalTransport):
2004
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2005
transport = a_bzrdir.get_workingtree_transport(self)
2006
control_files = self._open_control_files(a_bzrdir)
2007
control_files.create_lock()
2008
control_files.lock_write()
2009
control_files.put_utf8('format', self.get_format_string())
2010
branch = a_bzrdir.open_branch()
2011
if revision_id is None:
2012
revision_id = branch.last_revision()
2014
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2020
_control_files=control_files)
2023
wt._write_inventory(inv)
2024
wt.set_root_id(inv.root.file_id)
2025
basis_tree = branch.repository.revision_tree(revision_id)
2026
if revision_id == NULL_REVISION:
2027
wt.set_parent_trees([])
2029
wt.set_parent_trees([(revision_id, basis_tree)])
2030
transform.build_tree(basis_tree, wt)
2033
control_files.unlock()
2037
super(WorkingTreeFormat3, self).__init__()
2038
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2040
def open(self, a_bzrdir, _found=False):
2041
"""Return the WorkingTree object for a_bzrdir
2043
_found is a private parameter, do not use it. It is used to indicate
2044
if format probing has already been done.
2047
# we are being called directly and must probe.
2048
raise NotImplementedError
2049
if not isinstance(a_bzrdir.transport, LocalTransport):
2050
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2051
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2053
def _open(self, a_bzrdir, control_files):
2054
"""Open the tree itself.
2056
:param a_bzrdir: the dir for the tree.
2057
:param control_files: the control files for the tree.
2059
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2063
_control_files=control_files)
2066
return self.get_format_string()
2069
# formats which have no format string are not discoverable
2070
# and not independently creatable, so are not registered.
2071
__default_format = WorkingTreeFormat3()
2072
WorkingTreeFormat.register_format(__default_format)
2073
WorkingTreeFormat.set_default_format(__default_format)
2074
_legacy_formats = [WorkingTreeFormat2(),
2078
class WorkingTreeTestProviderAdapter(object):
2079
"""A tool to generate a suite testing multiple workingtree formats at once.
2081
This is done by copying the test once for each transport and injecting
2082
the transport_server, transport_readonly_server, and workingtree_format
2083
classes into each copy. Each copy is also given a new id() to make it
2087
def __init__(self, transport_server, transport_readonly_server, formats):
2088
self._transport_server = transport_server
2089
self._transport_readonly_server = transport_readonly_server
2090
self._formats = formats
2092
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2093
"""Clone test for adaption."""
2094
new_test = deepcopy(test)
2095
new_test.transport_server = self._transport_server
2096
new_test.transport_readonly_server = self._transport_readonly_server
2097
new_test.bzrdir_format = bzrdir_format
2098
new_test.workingtree_format = workingtree_format
2099
def make_new_test_id():
2100
new_id = "%s(%s)" % (test.id(), variation)
2101
return lambda: new_id
2102
new_test.id = make_new_test_id()
2105
def adapt(self, test):
2106
from bzrlib.tests import TestSuite
2107
result = TestSuite()
2108
for workingtree_format, bzrdir_format in self._formats:
2109
new_test = self._clone_test(
2112
workingtree_format, workingtree_format.__class__.__name__)
2113
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
