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
53
from bzrlib.branch import (Branch,
55
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
56
import bzrlib.bzrdir as bzrdir
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
58
import bzrlib.errors as errors
59
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 *
95
from bzrlib.textui import show_status
97
from bzrlib.transform import build_tree
98
from bzrlib.trace import mutter, note
99
from bzrlib.transport import get_transport
100
from bzrlib.transport.local import LocalTransport
101
import bzrlib.urlutils as urlutils
106
# the regex here does the following:
107
# 1) remove any weird characters; we don't escape them but rather
109
# 2) match leading '.'s to make it not hidden
110
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
111
_gen_id_suffix = None
115
def _next_id_suffix():
116
"""Create a new file id suffix that is reasonably unique.
118
On the first call we combine the current time with 64 bits of randomness
119
to give a highly probably globally unique number. Then each call in the same
120
process adds 1 to a serial number we append to that unique value.
122
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
123
# than having to move the id randomness out of the inner loop like this.
124
# XXX TODO: for the global randomness this uses we should add the thread-id
125
# before the serial #.
126
global _gen_id_suffix, _gen_id_serial
127
if _gen_id_suffix is None:
128
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
130
return _gen_id_suffix + str(_gen_id_serial)
133
def gen_file_id(name):
134
"""Return new file id for the basename 'name'.
136
The uniqueness is supplied from _next_id_suffix.
138
# XXX TODO: squash the filename to lowercase.
139
# XXX TODO: truncate the filename to something like 20 or 30 chars.
140
# XXX TODO: consider what to do with ids that look like illegal filepaths
141
# on platforms we support.
142
return _gen_file_id_re.sub('', name) + _next_id_suffix()
146
"""Return a new tree-root file id."""
147
return gen_file_id('TREE_ROOT')
150
class TreeEntry(object):
151
"""An entry that implements the minium interface used by commands.
153
This needs further inspection, it may be better to have
154
InventoryEntries without ids - though that seems wrong. For now,
155
this is a parallel hierarchy to InventoryEntry, and needs to become
156
one of several things: decorates to that hierarchy, children of, or
158
Another note is that these objects are currently only used when there is
159
no InventoryEntry available - i.e. for unversioned objects.
160
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
163
def __eq__(self, other):
164
# yes, this us ugly, TODO: best practice __eq__ style.
165
return (isinstance(other, TreeEntry)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeDirectory(TreeEntry):
173
"""See TreeEntry. This is a directory in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeDirectory)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeFile(TreeEntry):
184
"""See TreeEntry. This is a regular file in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeFile)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeLink(TreeEntry):
195
"""See TreeEntry. This is a symlink in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeLink)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class WorkingTree(bzrlib.tree.Tree):
206
"""Working copy tree.
208
The inventory is held in the `Branch` working-inventory, and the
209
files are in a directory on disk.
211
It is possible for a `WorkingTree` to have a filename which is
212
not listed in the Inventory and vice versa.
215
def __init__(self, basedir='.',
216
branch=DEPRECATED_PARAMETER,
222
"""Construct a WorkingTree for basedir.
224
If the branch is not supplied, it is opened automatically.
225
If the branch is supplied, it must be the branch for this basedir.
226
(branch.base is not cross checked, because for remote branches that
227
would be meaningless).
229
self._format = _format
230
self.bzrdir = _bzrdir
232
# not created via open etc.
233
warn("WorkingTree() is deprecated as of bzr version 0.8. "
234
"Please use bzrdir.open_workingtree or WorkingTree.open().",
237
wt = WorkingTree.open(basedir)
238
self._branch = wt.branch
239
self.basedir = wt.basedir
240
self._control_files = wt._control_files
241
self._hashcache = wt._hashcache
242
self._set_inventory(wt._inventory)
243
self._format = wt._format
244
self.bzrdir = wt.bzrdir
245
from bzrlib.hashcache import HashCache
246
from bzrlib.trace import note, mutter
247
assert isinstance(basedir, basestring), \
248
"base directory %r is not a string" % basedir
249
basedir = safe_unicode(basedir)
250
mutter("opening working tree %r", basedir)
251
if deprecated_passed(branch):
253
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
254
" Please use bzrdir.open_workingtree() or"
255
" WorkingTree.open().",
259
self._branch = branch
261
self._branch = self.bzrdir.open_branch()
262
assert isinstance(self.branch, Branch), \
263
"branch %r is not a Branch" % self.branch
264
self.basedir = realpath(basedir)
265
# if branch is at our basedir and is a format 6 or less
266
if isinstance(self._format, WorkingTreeFormat2):
267
# share control object
268
self._control_files = self.branch.control_files
270
# only ready for format 3
271
assert isinstance(self._format, WorkingTreeFormat3)
272
assert isinstance(_control_files, LockableFiles), \
273
"_control_files must be a LockableFiles, not %r" \
275
self._control_files = _control_files
276
# update the whole cache up front and write to disk if anything changed;
277
# in the future we might want to do this more selectively
278
# two possible ways offer themselves : in self._unlock, write the cache
279
# if needed, or, when the cache sees a change, append it to the hash
280
# cache file, and have the parser take the most recent entry for a
282
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
283
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
285
# is this scan needed ? it makes things kinda slow.
292
if _inventory is None:
293
self._set_inventory(self.read_working_inventory())
295
self._set_inventory(_inventory)
298
fget=lambda self: self._branch,
299
doc="""The branch this WorkingTree is connected to.
301
This cannot be set - it is reflective of the actual disk structure
302
the working tree has been constructed from.
305
def break_lock(self):
306
"""Break a lock if one is present from another instance.
308
Uses the ui factory to ask for confirmation if the lock may be from
311
This will probe the repository for its lock as well.
313
self._control_files.break_lock()
314
self.branch.break_lock()
316
def _set_inventory(self, inv):
317
self._inventory = inv
318
self.path2id = self._inventory.path2id
320
def is_control_filename(self, filename):
321
"""True if filename is the name of a control file in this tree.
323
:param filename: A filename within the tree. This is a relative path
324
from the root of this tree.
326
This is true IF and ONLY IF the filename is part of the meta data
327
that bzr controls in this tree. I.E. a random .bzr directory placed
328
on disk will not be a control file for this tree.
330
return self.bzrdir.is_control_filename(filename)
333
def open(path=None, _unsupported=False):
334
"""Open an existing working tree at path.
338
path = os.path.getcwdu()
339
control = bzrdir.BzrDir.open(path, _unsupported)
340
return control.open_workingtree(_unsupported)
343
def open_containing(path=None):
344
"""Open an existing working tree which has its root about path.
346
This probes for a working tree at path and searches upwards from there.
348
Basically we keep looking up until we find the control directory or
349
run into /. If there isn't one, raises NotBranchError.
350
TODO: give this a new exception.
351
If there is one, it is returned, along with the unused portion of path.
353
:return: The WorkingTree that contains 'path', and the rest of path
357
control, relpath = bzrdir.BzrDir.open_containing(path)
359
return control.open_workingtree(), relpath
362
def open_downlevel(path=None):
363
"""Open an unsupported working tree.
365
Only intended for advanced situations like upgrading part of a bzrdir.
367
return WorkingTree.open(path, _unsupported=True)
370
"""Iterate through file_ids for this tree.
372
file_ids are in a WorkingTree if they are in the working inventory
373
and the working file exists.
375
inv = self._inventory
376
for path, ie in inv.iter_entries():
377
if bzrlib.osutils.lexists(self.abspath(path)):
381
return "<%s of %s>" % (self.__class__.__name__,
382
getattr(self, 'basedir', None))
384
def abspath(self, filename):
385
return pathjoin(self.basedir, filename)
387
def basis_tree(self):
388
"""Return RevisionTree for the current last revision."""
389
revision_id = self.last_revision()
390
if revision_id is not None:
392
xml = self.read_basis_inventory()
393
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
396
if inv is not None and inv.revision_id == revision_id:
397
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
399
# FIXME? RBC 20060403 should we cache the inventory here ?
400
return self.branch.repository.revision_tree(revision_id)
403
@deprecated_method(zero_eight)
404
def create(branch, directory):
405
"""Create a workingtree for branch at directory.
407
If existing_directory already exists it must have a .bzr directory.
408
If it does not exist, it will be created.
410
This returns a new WorkingTree object for the new checkout.
412
TODO FIXME RBC 20060124 when we have checkout formats in place this
413
should accept an optional revisionid to checkout [and reject this if
414
checking out into the same dir as a pre-checkout-aware branch format.]
416
XXX: When BzrDir is present, these should be created through that
419
warn('delete WorkingTree.create', stacklevel=3)
420
transport = get_transport(directory)
421
if branch.bzrdir.root_transport.base == transport.base:
423
return branch.bzrdir.create_workingtree()
424
# different directory,
425
# create a branch reference
426
# and now a working tree.
427
raise NotImplementedError
430
@deprecated_method(zero_eight)
431
def create_standalone(directory):
432
"""Create a checkout and a branch and a repo at directory.
434
Directory must exist and be empty.
436
please use BzrDir.create_standalone_workingtree
438
return bzrdir.BzrDir.create_standalone_workingtree(directory)
440
def relpath(self, path):
441
"""Return the local path portion from a given path.
443
The path may be absolute or relative. If its a relative path it is
444
interpreted relative to the python current working directory.
446
return relpath(self.basedir, path)
448
def has_filename(self, filename):
449
return bzrlib.osutils.lexists(self.abspath(filename))
451
def get_file(self, file_id):
452
return self.get_file_byname(self.id2path(file_id))
454
def get_file_byname(self, filename):
455
return file(self.abspath(filename), 'rb')
457
def get_root_id(self):
458
"""Return the id of this trees root"""
459
inv = self.read_working_inventory()
460
return inv.root.file_id
462
def _get_store_filename(self, file_id):
463
## XXX: badly named; this is not in the store at all
464
return self.abspath(self.id2path(file_id))
467
def clone(self, to_bzrdir, revision_id=None, basis=None):
468
"""Duplicate this working tree into to_bzr, including all state.
470
Specifically modified files are kept as modified, but
471
ignored and unknown files are discarded.
473
If you want to make a new line of development, see bzrdir.sprout()
476
If not None, the cloned tree will have its last revision set to
477
revision, and and difference between the source trees last revision
478
and this one merged in.
481
If not None, a closer copy of a tree which may have some files in
482
common, and which file content should be preferentially copied from.
484
# assumes the target bzr dir format is compatible.
485
result = self._format.initialize(to_bzrdir)
486
self.copy_content_into(result, revision_id)
490
def copy_content_into(self, tree, revision_id=None):
491
"""Copy the current content and user files of this tree into tree."""
492
if revision_id is None:
493
transform_tree(tree, self)
495
# TODO now merge from tree.last_revision to revision
496
transform_tree(tree, self)
497
tree.set_last_revision(revision_id)
500
def commit(self, message=None, revprops=None, *args, **kwargs):
501
# avoid circular imports
502
from bzrlib.commit import Commit
505
if not 'branch-nick' in revprops:
506
revprops['branch-nick'] = self.branch.nick
507
# args for wt.commit start at message from the Commit.commit method,
508
# but with branch a kwarg now, passing in args as is results in the
509
#message being used for the branch
510
args = (DEPRECATED_PARAMETER, message, ) + args
511
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
512
self._set_inventory(self.read_working_inventory())
514
def id2abspath(self, file_id):
515
return self.abspath(self.id2path(file_id))
517
def has_id(self, file_id):
518
# files that have been deleted are excluded
519
inv = self._inventory
520
if not inv.has_id(file_id):
522
path = inv.id2path(file_id)
523
return bzrlib.osutils.lexists(self.abspath(path))
525
def has_or_had_id(self, file_id):
526
if file_id == self.inventory.root.file_id:
528
return self.inventory.has_id(file_id)
530
__contains__ = has_id
532
def get_file_size(self, file_id):
533
return os.path.getsize(self.id2abspath(file_id))
536
def get_file_sha1(self, file_id, path=None):
538
path = self._inventory.id2path(file_id)
539
return self._hashcache.get_sha1(path)
541
def get_file_mtime(self, file_id, path=None):
543
path = self._inventory.id2path(file_id)
544
return os.lstat(self.abspath(path)).st_mtime
546
if not supports_executable():
547
def is_executable(self, file_id, path=None):
548
return self._inventory[file_id].executable
550
def is_executable(self, file_id, path=None):
552
path = self._inventory.id2path(file_id)
553
mode = os.lstat(self.abspath(path)).st_mode
554
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
557
def add(self, files, ids=None):
558
"""Make files versioned.
560
Note that the command line normally calls smart_add instead,
561
which can automatically recurse.
563
This adds the files to the inventory, so that they will be
564
recorded by the next commit.
567
List of paths to add, relative to the base of the tree.
570
If set, use these instead of automatically generated ids.
571
Must be the same length as the list of files, but may
572
contain None for ids that are to be autogenerated.
574
TODO: Perhaps have an option to add the ids even if the files do
577
TODO: Perhaps callback with the ids and paths as they're added.
579
# TODO: Re-adding a file that is removed in the working copy
580
# should probably put it back with the previous ID.
581
if isinstance(files, basestring):
582
assert(ids is None or isinstance(ids, basestring))
588
ids = [None] * len(files)
590
assert(len(ids) == len(files))
592
inv = self.read_working_inventory()
593
for f,file_id in zip(files, ids):
594
if self.is_control_filename(f):
595
raise BzrError("cannot add control file %s" % quotefn(f))
600
raise BzrError("cannot add top-level %r" % f)
602
fullpath = normpath(self.abspath(f))
605
kind = file_kind(fullpath)
607
if e.errno == errno.ENOENT:
608
raise NoSuchFile(fullpath)
609
# maybe something better?
610
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
612
if not InventoryEntry.versionable_kind(kind):
613
raise BzrError('cannot add: not a versionable file ('
614
'i.e. regular file, symlink or directory): %s' % quotefn(f))
617
inv.add_path(f, kind=kind)
619
inv.add_path(f, kind=kind, file_id=file_id)
621
self._write_inventory(inv)
624
def add_pending_merge(self, *revision_ids):
625
# TODO: Perhaps should check at this point that the
626
# history of the revision is actually present?
627
p = self.pending_merges()
629
for rev_id in revision_ids:
635
self.set_pending_merges(p)
638
def pending_merges(self):
639
"""Return a list of pending merges.
641
These are revisions that have been merged into the working
642
directory but not yet committed.
645
merges_file = self._control_files.get_utf8('pending-merges')
647
if e.errno != errno.ENOENT:
651
for l in merges_file.readlines():
652
p.append(l.rstrip('\n'))
656
def set_pending_merges(self, rev_list):
657
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
660
def set_merge_modified(self, modified_hashes):
662
for file_id, hash in modified_hashes.iteritems():
663
yield Stanza(file_id=file_id, hash=hash)
664
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
667
def _put_rio(self, filename, stanzas, header):
668
my_file = rio_file(stanzas, header)
669
self._control_files.put(filename, my_file)
672
def merge_modified(self):
674
hashfile = self._control_files.get('merge-hashes')
679
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
680
raise MergeModifiedFormatError()
681
except StopIteration:
682
raise MergeModifiedFormatError()
683
for s in RioReader(hashfile):
684
file_id = s.get("file_id")
685
if file_id not in self.inventory:
688
if hash == self.get_file_sha1(file_id):
689
merge_hashes[file_id] = hash
692
def get_symlink_target(self, file_id):
693
return os.readlink(self.id2abspath(file_id))
695
def file_class(self, filename):
696
if self.path2id(filename):
698
elif self.is_ignored(filename):
703
def list_files(self):
704
"""Recursively list all files as (path, class, kind, id, entry).
706
Lists, but does not descend into unversioned directories.
708
This does not include files that have been deleted in this
711
Skips the control directory.
713
inv = self._inventory
714
# Convert these into local objects to save lookup times
715
pathjoin = bzrlib.osutils.pathjoin
716
file_kind = bzrlib.osutils.file_kind
718
# transport.base ends in a slash, we want the piece
719
# between the last two slashes
720
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
722
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
724
# directory file_id, relative path, absolute path, reverse sorted children
725
children = os.listdir(self.basedir)
727
# jam 20060527 The kernel sized tree seems equivalent whether we
728
# use a deque and popleft to keep them sorted, or if we use a plain
729
# list and just reverse() them.
730
children = collections.deque(children)
731
stack = [(inv.root.file_id, u'', self.basedir, children)]
733
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
736
f = children.popleft()
737
## TODO: If we find a subdirectory with its own .bzr
738
## directory, then that is a separate tree and we
739
## should exclude it.
741
# the bzrdir for this tree
742
if transport_base_dir == f:
745
# we know that from_dir_relpath and from_dir_abspath never end in a slash
746
# and 'f' doesn't begin with one, we can do a string op, rather
747
# than the checks of pathjoin(), all relative paths will have an extra slash
749
fp = from_dir_relpath + '/' + f
752
fap = from_dir_abspath + '/' + f
754
f_ie = inv.get_child(from_dir_id, f)
757
elif self.is_ignored(fp[1:]):
766
raise BzrCheckError("file %r entered as kind %r id %r, "
768
% (fap, f_ie.kind, f_ie.file_id, fk))
770
# make a last minute entry
772
yield fp[1:], c, fk, f_ie.file_id, f_ie
775
yield fp[1:], c, fk, None, fk_entries[fk]()
777
yield fp[1:], c, fk, None, TreeEntry()
780
if fk != 'directory':
783
# But do this child first
784
new_children = os.listdir(fap)
786
new_children = collections.deque(new_children)
787
stack.append((f_ie.file_id, fp, fap, new_children))
788
# Break out of inner loop, so that we start outer loop with child
791
# if we finished all children, pop it off the stack
796
def move(self, from_paths, to_name):
799
to_name must exist in the inventory.
801
If to_name exists and is a directory, the files are moved into
802
it, keeping their old names.
804
Note that to_name is only the last component of the new name;
805
this doesn't change the directory.
807
This returns a list of (from_path, to_path) pairs for each
811
## TODO: Option to move IDs only
812
assert not isinstance(from_paths, basestring)
814
to_abs = self.abspath(to_name)
815
if not isdir(to_abs):
816
raise BzrError("destination %r is not a directory" % to_abs)
817
if not self.has_filename(to_name):
818
raise BzrError("destination %r not in working directory" % to_abs)
819
to_dir_id = inv.path2id(to_name)
820
if to_dir_id == None and to_name != '':
821
raise BzrError("destination %r is not a versioned directory" % to_name)
822
to_dir_ie = inv[to_dir_id]
823
if to_dir_ie.kind not in ('directory', 'root_directory'):
824
raise BzrError("destination %r is not a directory" % to_abs)
826
to_idpath = inv.get_idpath(to_dir_id)
829
if not self.has_filename(f):
830
raise BzrError("%r does not exist in working tree" % f)
831
f_id = inv.path2id(f)
833
raise BzrError("%r is not versioned" % f)
834
name_tail = splitpath(f)[-1]
835
dest_path = pathjoin(to_name, name_tail)
836
if self.has_filename(dest_path):
837
raise BzrError("destination %r already exists" % dest_path)
838
if f_id in to_idpath:
839
raise BzrError("can't move %r to a subdirectory of itself" % f)
841
# OK, so there's a race here, it's possible that someone will
842
# create a file in this interval and then the rename might be
843
# left half-done. But we should have caught most problems.
844
orig_inv = deepcopy(self.inventory)
847
name_tail = splitpath(f)[-1]
848
dest_path = pathjoin(to_name, name_tail)
849
result.append((f, dest_path))
850
inv.rename(inv.path2id(f), to_dir_id, name_tail)
852
rename(self.abspath(f), self.abspath(dest_path))
854
raise BzrError("failed to rename %r to %r: %s" %
855
(f, dest_path, e[1]),
856
["rename rolled back"])
858
# restore the inventory on error
859
self._set_inventory(orig_inv)
861
self._write_inventory(inv)
865
def rename_one(self, from_rel, to_rel):
868
This can change the directory or the filename or both.
871
if not self.has_filename(from_rel):
872
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
873
if self.has_filename(to_rel):
874
raise BzrError("can't rename: new working file %r already exists" % to_rel)
876
file_id = inv.path2id(from_rel)
878
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
881
from_parent = entry.parent_id
882
from_name = entry.name
884
if inv.path2id(to_rel):
885
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
887
to_dir, to_tail = os.path.split(to_rel)
888
to_dir_id = inv.path2id(to_dir)
889
if to_dir_id == None and to_dir != '':
890
raise BzrError("can't determine destination directory id for %r" % to_dir)
892
mutter("rename_one:")
893
mutter(" file_id {%s}" % file_id)
894
mutter(" from_rel %r" % from_rel)
895
mutter(" to_rel %r" % to_rel)
896
mutter(" to_dir %r" % to_dir)
897
mutter(" to_dir_id {%s}" % to_dir_id)
899
inv.rename(file_id, to_dir_id, to_tail)
901
from_abs = self.abspath(from_rel)
902
to_abs = self.abspath(to_rel)
904
rename(from_abs, to_abs)
906
inv.rename(file_id, from_parent, from_name)
907
raise BzrError("failed to rename %r to %r: %s"
908
% (from_abs, to_abs, e[1]),
909
["rename rolled back"])
910
self._write_inventory(inv)
914
"""Return all unknown files.
916
These are files in the working directory that are not versioned or
917
control files or ignored.
919
>>> from bzrlib.bzrdir import ScratchDir
920
>>> d = ScratchDir(files=['foo', 'foo~'])
921
>>> b = d.open_branch()
922
>>> tree = d.open_workingtree()
923
>>> map(str, tree.unknowns())
926
>>> list(b.unknowns())
928
>>> tree.remove('foo')
929
>>> list(b.unknowns())
932
for subp in self.extras():
933
if not self.is_ignored(subp):
936
@deprecated_method(zero_eight)
937
def iter_conflicts(self):
938
"""List all files in the tree that have text or content conflicts.
939
DEPRECATED. Use conflicts instead."""
940
return self._iter_conflicts()
942
def _iter_conflicts(self):
944
for info in self.list_files():
946
stem = get_conflicted_stem(path)
949
if stem not in conflicted:
954
def pull(self, source, overwrite=False, stop_revision=None):
955
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
958
pp = ProgressPhase("Pull phase", 2, top_pb)
960
old_revision_history = self.branch.revision_history()
961
basis_tree = self.basis_tree()
962
count = self.branch.pull(source, overwrite, stop_revision)
963
new_revision_history = self.branch.revision_history()
964
if new_revision_history != old_revision_history:
966
if len(old_revision_history):
967
other_revision = old_revision_history[-1]
969
other_revision = None
970
repository = self.branch.repository
971
pb = bzrlib.ui.ui_factory.nested_progress_bar()
973
merge_inner(self.branch,
974
self.branch.basis_tree(),
980
self.set_last_revision(self.branch.last_revision())
987
"""Yield all unknown files in this WorkingTree.
989
If there are any unknown directories then only the directory is
990
returned, not all its children. But if there are unknown files
991
under a versioned subdirectory, they are returned.
993
Currently returned depth-first, sorted by name within directories.
995
## TODO: Work from given directory downwards
996
for path, dir_entry in self.inventory.directories():
997
mutter("search for unknowns in %r", path)
998
dirabs = self.abspath(path)
999
if not isdir(dirabs):
1000
# e.g. directory deleted
1004
for subf in os.listdir(dirabs):
1006
and (subf not in dir_entry.children)):
1011
subp = pathjoin(path, subf)
1014
def _translate_ignore_rule(self, rule):
1015
"""Translate a single ignore rule to a regex.
1017
There are two types of ignore rules. Those that do not contain a / are
1018
matched against the tail of the filename (that is, they do not care
1019
what directory the file is in.) Rules which do contain a slash must
1020
match the entire path. As a special case, './' at the start of the
1021
string counts as a slash in the string but is removed before matching
1022
(e.g. ./foo.c, ./src/foo.c)
1024
:return: The translated regex.
1026
if rule[:2] in ('./', '.\\'):
1028
result = fnmatch.translate(rule[2:])
1029
elif '/' in rule or '\\' in rule:
1031
result = fnmatch.translate(rule)
1033
# default rule style.
1034
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1035
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1036
return "(" + result + ")"
1038
def _combine_ignore_rules(self, rules):
1039
"""Combine a list of ignore rules into a single regex object.
1041
Each individual rule is combined with | to form a big regex, which then
1042
has $ added to it to form something like ()|()|()$. The group index for
1043
each subregex's outermost group is placed in a dictionary mapping back
1044
to the rule. This allows quick identification of the matching rule that
1046
:return: a list of the compiled regex and the matching-group index
1047
dictionaries. We return a list because python complains if you try to
1048
combine more than 100 regexes.
1053
translated_rules = []
1055
translated_rule = self._translate_ignore_rule(rule)
1056
compiled_rule = re.compile(translated_rule)
1057
groups[next_group] = rule
1058
next_group += compiled_rule.groups
1059
translated_rules.append(translated_rule)
1060
if next_group == 99:
1061
result.append((re.compile("|".join(translated_rules)), groups))
1064
translated_rules = []
1065
if len(translated_rules):
1066
result.append((re.compile("|".join(translated_rules)), groups))
1069
def ignored_files(self):
1070
"""Yield list of PATH, IGNORE_PATTERN"""
1071
for subp in self.extras():
1072
pat = self.is_ignored(subp)
1076
def get_ignore_list(self):
1077
"""Return list of ignore patterns.
1079
Cached in the Tree object after the first call.
1081
if hasattr(self, '_ignorelist'):
1082
return self._ignorelist
1084
l = bzrlib.DEFAULT_IGNORE[:]
1085
if self.has_filename(bzrlib.IGNORE_FILENAME):
1086
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1087
l.extend([line.rstrip("\n\r").decode('utf-8')
1088
for line in f.readlines()])
1089
self._ignorelist = l
1090
self._ignore_regex = self._combine_ignore_rules(l)
1093
def _get_ignore_rules_as_regex(self):
1094
"""Return a regex of the ignore rules and a mapping dict.
1096
:return: (ignore rules compiled regex, dictionary mapping rule group
1097
indices to original rule.)
1099
if getattr(self, '_ignorelist', None) is None:
1100
self.get_ignore_list()
1101
return self._ignore_regex
1103
def is_ignored(self, filename):
1104
r"""Check whether the filename matches an ignore pattern.
1106
Patterns containing '/' or '\' need to match the whole path;
1107
others match against only the last component.
1109
If the file is ignored, returns the pattern which caused it to
1110
be ignored, otherwise None. So this can simply be used as a
1111
boolean if desired."""
1113
# TODO: Use '**' to match directories, and other extended
1114
# globbing stuff from cvs/rsync.
1116
# XXX: fnmatch is actually not quite what we want: it's only
1117
# approximately the same as real Unix fnmatch, and doesn't
1118
# treat dotfiles correctly and allows * to match /.
1119
# Eventually it should be replaced with something more
1122
rules = self._get_ignore_rules_as_regex()
1123
for regex, mapping in rules:
1124
match = regex.match(filename)
1125
if match is not None:
1126
# one or more of the groups in mapping will have a non-None group
1128
groups = match.groups()
1129
rules = [mapping[group] for group in
1130
mapping if groups[group] is not None]
1134
def kind(self, file_id):
1135
return file_kind(self.id2abspath(file_id))
1138
def last_revision(self):
1139
"""Return the last revision id of this working tree.
1141
In early branch formats this was == the branch last_revision,
1142
but that cannot be relied upon - for working tree operations,
1143
always use tree.last_revision().
1145
return self.branch.last_revision()
1147
def is_locked(self):
1148
return self._control_files.is_locked()
1150
def lock_read(self):
1151
"""See Branch.lock_read, and WorkingTree.unlock."""
1152
self.branch.lock_read()
1154
return self._control_files.lock_read()
1156
self.branch.unlock()
1159
def lock_write(self):
1160
"""See Branch.lock_write, and WorkingTree.unlock."""
1161
self.branch.lock_write()
1163
return self._control_files.lock_write()
1165
self.branch.unlock()
1168
def get_physical_lock_status(self):
1169
return self._control_files.get_physical_lock_status()
1171
def _basis_inventory_name(self):
1172
return 'basis-inventory'
1175
def set_last_revision(self, new_revision):
1176
"""Change the last revision in the working tree."""
1177
if self._change_last_revision(new_revision):
1178
self._cache_basis_inventory(new_revision)
1180
def _change_last_revision(self, new_revision):
1181
"""Template method part of set_last_revision to perform the change.
1183
This is used to allow WorkingTree3 instances to not affect branch
1184
when their last revision is set.
1186
if new_revision is None:
1187
self.branch.set_revision_history([])
1189
# current format is locked in with the branch
1190
revision_history = self.branch.revision_history()
1192
position = revision_history.index(new_revision)
1194
raise errors.NoSuchRevision(self.branch, new_revision)
1195
self.branch.set_revision_history(revision_history[:position + 1])
1198
def _cache_basis_inventory(self, new_revision):
1199
"""Cache new_revision as the basis inventory."""
1200
# TODO: this should allow the ready-to-use inventory to be passed in,
1201
# as commit already has that ready-to-use [while the format is the
1204
# this double handles the inventory - unpack and repack -
1205
# but is easier to understand. We can/should put a conditional
1206
# in here based on whether the inventory is in the latest format
1207
# - perhaps we should repack all inventories on a repository
1209
# the fast path is to copy the raw xml from the repository. If the
1210
# xml contains 'revision_id="', then we assume the right
1211
# revision_id is set. We must check for this full string, because a
1212
# root node id can legitimately look like 'revision_id' but cannot
1214
xml = self.branch.repository.get_inventory_xml(new_revision)
1215
if not 'revision_id="' in xml.split('\n', 1)[0]:
1216
inv = self.branch.repository.deserialise_inventory(
1218
inv.revision_id = new_revision
1219
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1221
path = self._basis_inventory_name()
1222
self._control_files.put_utf8(path, xml)
1223
except WeaveRevisionNotPresent:
1226
def read_basis_inventory(self):
1227
"""Read the cached basis inventory."""
1228
path = self._basis_inventory_name()
1229
return self._control_files.get_utf8(path).read()
1232
def read_working_inventory(self):
1233
"""Read the working inventory."""
1234
# ElementTree does its own conversion from UTF-8, so open in
1236
result = bzrlib.xml5.serializer_v5.read_inventory(
1237
self._control_files.get('inventory'))
1238
self._set_inventory(result)
1242
def remove(self, files, verbose=False, to_file=None):
1243
"""Remove nominated files from the working inventory..
1245
This does not remove their text. This does not run on XXX on what? RBC
1247
TODO: Refuse to remove modified files unless --force is given?
1249
TODO: Do something useful with directories.
1251
TODO: Should this remove the text or not? Tough call; not
1252
removing may be useful and the user can just use use rm, and
1253
is the opposite of add. Removing it is consistent with most
1254
other tools. Maybe an option.
1256
## TODO: Normalize names
1257
## TODO: Remove nested loops; better scalability
1258
if isinstance(files, basestring):
1261
inv = self.inventory
1263
# do this before any modifications
1265
fid = inv.path2id(f)
1267
# TODO: Perhaps make this just a warning, and continue?
1268
# This tends to happen when
1269
raise NotVersionedError(path=f)
1270
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1272
# having remove it, it must be either ignored or unknown
1273
if self.is_ignored(f):
1277
show_status(new_status, inv[fid].kind, quotefn(f), to_file=to_file)
1280
self._write_inventory(inv)
1283
def revert(self, filenames, old_tree=None, backups=True,
1284
pb=DummyProgress()):
1285
from transform import revert
1286
from conflicts import resolve
1287
if old_tree is None:
1288
old_tree = self.basis_tree()
1289
conflicts = revert(self, old_tree, filenames, backups, pb)
1290
if not len(filenames):
1291
self.set_pending_merges([])
1294
resolve(self, filenames, ignore_misses=True)
1297
# XXX: This method should be deprecated in favour of taking in a proper
1298
# new Inventory object.
1300
def set_inventory(self, new_inventory_list):
1301
from bzrlib.inventory import (Inventory,
1306
inv = Inventory(self.get_root_id())
1307
for path, file_id, parent, kind in new_inventory_list:
1308
name = os.path.basename(path)
1311
# fixme, there should be a factory function inv,add_??
1312
if kind == 'directory':
1313
inv.add(InventoryDirectory(file_id, name, parent))
1314
elif kind == 'file':
1315
inv.add(InventoryFile(file_id, name, parent))
1316
elif kind == 'symlink':
1317
inv.add(InventoryLink(file_id, name, parent))
1319
raise BzrError("unknown kind %r" % kind)
1320
self._write_inventory(inv)
1323
def set_root_id(self, file_id):
1324
"""Set the root id for this tree."""
1325
inv = self.read_working_inventory()
1326
orig_root_id = inv.root.file_id
1327
del inv._byid[inv.root.file_id]
1328
inv.root.file_id = file_id
1329
inv._byid[inv.root.file_id] = inv.root
1332
if entry.parent_id == orig_root_id:
1333
entry.parent_id = inv.root.file_id
1334
self._write_inventory(inv)
1337
"""See Branch.unlock.
1339
WorkingTree locking just uses the Branch locking facilities.
1340
This is current because all working trees have an embedded branch
1341
within them. IF in the future, we were to make branch data shareable
1342
between multiple working trees, i.e. via shared storage, then we
1343
would probably want to lock both the local tree, and the branch.
1345
# FIXME: We want to write out the hashcache only when the last lock on
1346
# this working copy is released. Peeking at the lock count is a bit
1347
# of a nasty hack; probably it's better to have a transaction object,
1348
# which can do some finalization when it's either successfully or
1349
# unsuccessfully completed. (Denys's original patch did that.)
1350
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1351
# wrongly. Hookinh into unllock on the control files object is fine though.
1353
# TODO: split this per format so there is no ugly if block
1354
if self._hashcache.needs_write and (
1355
# dedicated lock files
1356
self._control_files._lock_count==1 or
1358
(self._control_files is self.branch.control_files and
1359
self._control_files._lock_count==3)):
1360
self._hashcache.write()
1361
# reverse order of locking.
1363
return self._control_files.unlock()
1365
self.branch.unlock()
1369
"""Update a working tree along its branch.
1371
This will update the branch if its bound too, which means we have multiple trees involved:
1372
The new basis tree of the master.
1373
The old basis tree of the branch.
1374
The old basis tree of the working tree.
1375
The current working tree state.
1376
pathologically all three may be different, and non ancestors of each other.
1377
Conceptually we want to:
1378
Preserve the wt.basis->wt.state changes
1379
Transform the wt.basis to the new master basis.
1380
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1381
Restore the wt.basis->wt.state changes.
1383
There isn't a single operation at the moment to do that, so we:
1384
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1385
Do a 'normal' merge of the old branch basis if it is relevant.
1387
old_tip = self.branch.update()
1388
if old_tip is not None:
1389
self.add_pending_merge(old_tip)
1390
self.branch.lock_read()
1393
if self.last_revision() != self.branch.last_revision():
1394
# merge tree state up to new branch tip.
1395
basis = self.basis_tree()
1396
to_tree = self.branch.basis_tree()
1397
result += merge_inner(self.branch,
1401
self.set_last_revision(self.branch.last_revision())
1402
if old_tip and old_tip != self.last_revision():
1403
# our last revision was not the prior branch last reivison
1404
# and we have converted that last revision to a pending merge.
1405
# base is somewhere between the branch tip now
1406
# and the now pending merge
1407
from bzrlib.revision import common_ancestor
1409
base_rev_id = common_ancestor(self.branch.last_revision(),
1411
self.branch.repository)
1412
except errors.NoCommonAncestor:
1414
base_tree = self.branch.repository.revision_tree(base_rev_id)
1415
other_tree = self.branch.repository.revision_tree(old_tip)
1416
result += merge_inner(self.branch,
1422
self.branch.unlock()
1425
def _write_inventory(self, inv):
1426
"""Write inventory as the current inventory."""
1428
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1430
self._control_files.put('inventory', sio)
1431
self._set_inventory(inv)
1432
mutter('wrote working inventory')
1434
def set_conflicts(self, arg):
1435
raise UnsupportedOperation(self.set_conflicts, self)
1438
def conflicts(self):
1439
conflicts = ConflictList()
1440
for conflicted in self._iter_conflicts():
1443
if file_kind(self.abspath(conflicted)) != "file":
1446
if e.errno == errno.ENOENT:
1451
for suffix in ('.THIS', '.OTHER'):
1453
kind = file_kind(self.abspath(conflicted+suffix))
1455
if e.errno == errno.ENOENT:
1463
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1464
conflicts.append(Conflict.factory(ctype, path=conflicted,
1465
file_id=self.path2id(conflicted)))
1469
class WorkingTree3(WorkingTree):
1470
"""This is the Format 3 working tree.
1472
This differs from the base WorkingTree by:
1473
- having its own file lock
1474
- having its own last-revision property.
1476
This is new in bzr 0.8
1480
def last_revision(self):
1481
"""See WorkingTree.last_revision."""
1483
return self._control_files.get_utf8('last-revision').read()
1487
def _change_last_revision(self, revision_id):
1488
"""See WorkingTree._change_last_revision."""
1489
if revision_id is None or revision_id == NULL_REVISION:
1491
self._control_files._transport.delete('last-revision')
1492
except errors.NoSuchFile:
1497
self.branch.revision_history().index(revision_id)
1499
raise errors.NoSuchRevision(self.branch, revision_id)
1500
self._control_files.put_utf8('last-revision', revision_id)
1504
def set_conflicts(self, conflicts):
1505
self._put_rio('conflicts', conflicts.to_stanzas(),
1509
def conflicts(self):
1511
confile = self._control_files.get('conflicts')
1513
return ConflictList()
1515
if confile.next() != CONFLICT_HEADER_1 + '\n':
1516
raise ConflictFormatError()
1517
except StopIteration:
1518
raise ConflictFormatError()
1519
return ConflictList.from_stanzas(RioReader(confile))
1522
def get_conflicted_stem(path):
1523
for suffix in CONFLICT_SUFFIXES:
1524
if path.endswith(suffix):
1525
return path[:-len(suffix)]
1527
@deprecated_function(zero_eight)
1528
def is_control_file(filename):
1529
"""See WorkingTree.is_control_filename(filename)."""
1530
## FIXME: better check
1531
filename = normpath(filename)
1532
while filename != '':
1533
head, tail = os.path.split(filename)
1534
## mutter('check %r for control file' % ((head, tail),))
1537
if filename == head:
1543
class WorkingTreeFormat(object):
1544
"""An encapsulation of the initialization and open routines for a format.
1546
Formats provide three things:
1547
* An initialization routine,
1551
Formats are placed in an dict by their format string for reference
1552
during workingtree opening. Its not required that these be instances, they
1553
can be classes themselves with class methods - it simply depends on
1554
whether state is needed for a given format or not.
1556
Once a format is deprecated, just deprecate the initialize and open
1557
methods on the format class. Do not deprecate the object, as the
1558
object will be created every time regardless.
1561
_default_format = None
1562
"""The default format used for new trees."""
1565
"""The known formats."""
1568
def find_format(klass, a_bzrdir):
1569
"""Return the format for the working tree object in a_bzrdir."""
1571
transport = a_bzrdir.get_workingtree_transport(None)
1572
format_string = transport.get("format").read()
1573
return klass._formats[format_string]
1575
raise errors.NoWorkingTree(base=transport.base)
1577
raise errors.UnknownFormatError(format_string)
1580
def get_default_format(klass):
1581
"""Return the current default format."""
1582
return klass._default_format
1584
def get_format_string(self):
1585
"""Return the ASCII format string that identifies this format."""
1586
raise NotImplementedError(self.get_format_string)
1588
def get_format_description(self):
1589
"""Return the short description for this format."""
1590
raise NotImplementedError(self.get_format_description)
1592
def is_supported(self):
1593
"""Is this format supported?
1595
Supported formats can be initialized and opened.
1596
Unsupported formats may not support initialization or committing or
1597
some other features depending on the reason for not being supported.
1602
def register_format(klass, format):
1603
klass._formats[format.get_format_string()] = format
1606
def set_default_format(klass, format):
1607
klass._default_format = format
1610
def unregister_format(klass, format):
1611
assert klass._formats[format.get_format_string()] is format
1612
del klass._formats[format.get_format_string()]
1616
class WorkingTreeFormat2(WorkingTreeFormat):
1617
"""The second working tree format.
1619
This format modified the hash cache from the format 1 hash cache.
1622
def get_format_description(self):
1623
"""See WorkingTreeFormat.get_format_description()."""
1624
return "Working tree format 2"
1626
def stub_initialize_remote(self, control_files):
1627
"""As a special workaround create critical control files for a remote working tree
1629
This ensures that it can later be updated and dealt with locally,
1630
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1631
no working tree. (See bug #43064).
1635
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1637
control_files.put('inventory', sio)
1639
control_files.put_utf8('pending-merges', '')
1642
def initialize(self, a_bzrdir, revision_id=None):
1643
"""See WorkingTreeFormat.initialize()."""
1644
if not isinstance(a_bzrdir.transport, LocalTransport):
1645
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1646
branch = a_bzrdir.open_branch()
1647
if revision_id is not None:
1650
revision_history = branch.revision_history()
1652
position = revision_history.index(revision_id)
1654
raise errors.NoSuchRevision(branch, revision_id)
1655
branch.set_revision_history(revision_history[:position + 1])
1658
revision = branch.last_revision()
1660
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1666
wt._write_inventory(inv)
1667
wt.set_root_id(inv.root.file_id)
1668
wt.set_last_revision(revision)
1669
wt.set_pending_merges([])
1670
build_tree(wt.basis_tree(), wt)
1674
super(WorkingTreeFormat2, self).__init__()
1675
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1677
def open(self, a_bzrdir, _found=False):
1678
"""Return the WorkingTree object for a_bzrdir
1680
_found is a private parameter, do not use it. It is used to indicate
1681
if format probing has already been done.
1684
# we are being called directly and must probe.
1685
raise NotImplementedError
1686
if not isinstance(a_bzrdir.transport, LocalTransport):
1687
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1688
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1694
class WorkingTreeFormat3(WorkingTreeFormat):
1695
"""The second working tree format updated to record a format marker.
1698
- exists within a metadir controlling .bzr
1699
- includes an explicit version marker for the workingtree control
1700
files, separate from the BzrDir format
1701
- modifies the hash cache format
1703
- uses a LockDir to guard access to the repository
1706
def get_format_string(self):
1707
"""See WorkingTreeFormat.get_format_string()."""
1708
return "Bazaar-NG Working Tree format 3"
1710
def get_format_description(self):
1711
"""See WorkingTreeFormat.get_format_description()."""
1712
return "Working tree format 3"
1714
_lock_file_name = 'lock'
1715
_lock_class = LockDir
1717
def _open_control_files(self, a_bzrdir):
1718
transport = a_bzrdir.get_workingtree_transport(None)
1719
return LockableFiles(transport, self._lock_file_name,
1722
def initialize(self, a_bzrdir, revision_id=None):
1723
"""See WorkingTreeFormat.initialize().
1725
revision_id allows creating a working tree at a differnet
1726
revision than the branch is at.
1728
if not isinstance(a_bzrdir.transport, LocalTransport):
1729
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1730
transport = a_bzrdir.get_workingtree_transport(self)
1731
control_files = self._open_control_files(a_bzrdir)
1732
control_files.create_lock()
1733
control_files.lock_write()
1734
control_files.put_utf8('format', self.get_format_string())
1735
branch = a_bzrdir.open_branch()
1736
if revision_id is None:
1737
revision_id = branch.last_revision()
1739
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1745
_control_files=control_files)
1748
wt._write_inventory(inv)
1749
wt.set_root_id(inv.root.file_id)
1750
wt.set_last_revision(revision_id)
1751
wt.set_pending_merges([])
1752
build_tree(wt.basis_tree(), wt)
1755
control_files.unlock()
1759
super(WorkingTreeFormat3, self).__init__()
1760
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1762
def open(self, a_bzrdir, _found=False):
1763
"""Return the WorkingTree object for a_bzrdir
1765
_found is a private parameter, do not use it. It is used to indicate
1766
if format probing has already been done.
1769
# we are being called directly and must probe.
1770
raise NotImplementedError
1771
if not isinstance(a_bzrdir.transport, LocalTransport):
1772
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1773
control_files = self._open_control_files(a_bzrdir)
1774
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1778
_control_files=control_files)
1781
return self.get_format_string()
1784
# formats which have no format string are not discoverable
1785
# and not independently creatable, so are not registered.
1786
__default_format = WorkingTreeFormat3()
1787
WorkingTreeFormat.register_format(__default_format)
1788
WorkingTreeFormat.set_default_format(__default_format)
1789
_legacy_formats = [WorkingTreeFormat2(),
1793
class WorkingTreeTestProviderAdapter(object):
1794
"""A tool to generate a suite testing multiple workingtree formats at once.
1796
This is done by copying the test once for each transport and injecting
1797
the transport_server, transport_readonly_server, and workingtree_format
1798
classes into each copy. Each copy is also given a new id() to make it
1802
def __init__(self, transport_server, transport_readonly_server, formats):
1803
self._transport_server = transport_server
1804
self._transport_readonly_server = transport_readonly_server
1805
self._formats = formats
1807
def adapt(self, test):
1808
from bzrlib.tests import TestSuite
1809
result = TestSuite()
1810
for workingtree_format, bzrdir_format in self._formats:
1811
new_test = deepcopy(test)
1812
new_test.transport_server = self._transport_server
1813
new_test.transport_readonly_server = self._transport_readonly_server
1814
new_test.bzrdir_format = bzrdir_format
1815
new_test.workingtree_format = workingtree_format
1816
def make_new_test_id():
1817
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1818
return lambda: new_id
1819
new_test.id = make_new_test_id()
1820
result.addTest(new_test)