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.atomicfile import AtomicFile
54
from bzrlib.branch import (Branch,
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
import bzrlib.bzrdir as bzrdir
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
59
import bzrlib.errors as errors
60
from bzrlib.errors import (BzrCheckError,
64
WeaveRevisionNotPresent,
68
MergeModifiedFormatError,
71
from bzrlib.inventory import InventoryEntry, Inventory
72
from bzrlib.lockable_files import LockableFiles, TransportLock
73
from bzrlib.lockdir import LockDir
74
from bzrlib.merge import merge_inner, transform_tree
75
from bzrlib.osutils import (
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
from bzrlib.rio import RioReader, rio_file, Stanza
95
from bzrlib.symbol_versioning import *
96
from bzrlib.textui import show_status
98
from bzrlib.transform import build_tree
99
from bzrlib.trace import mutter, note
100
from bzrlib.transport import get_transport
101
from bzrlib.transport.local import LocalTransport
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).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.
355
control, relpath = bzrdir.BzrDir.open_containing(path)
356
return control.open_workingtree(), relpath
359
def open_downlevel(path=None):
360
"""Open an unsupported working tree.
362
Only intended for advanced situations like upgrading part of a bzrdir.
364
return WorkingTree.open(path, _unsupported=True)
367
"""Iterate through file_ids for this tree.
369
file_ids are in a WorkingTree if they are in the working inventory
370
and the working file exists.
372
inv = self._inventory
373
for path, ie in inv.iter_entries():
374
if bzrlib.osutils.lexists(self.abspath(path)):
378
return "<%s of %s>" % (self.__class__.__name__,
379
getattr(self, 'basedir', None))
381
def abspath(self, filename):
382
return pathjoin(self.basedir, filename)
384
def basis_tree(self):
385
"""Return RevisionTree for the current last revision."""
386
revision_id = self.last_revision()
387
if revision_id is not None:
389
xml = self.read_basis_inventory()
390
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
393
if inv is not None and inv.revision_id == revision_id:
394
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
396
# FIXME? RBC 20060403 should we cache the inventory here ?
397
return self.branch.repository.revision_tree(revision_id)
400
@deprecated_method(zero_eight)
401
def create(branch, directory):
402
"""Create a workingtree for branch at directory.
404
If existing_directory already exists it must have a .bzr directory.
405
If it does not exist, it will be created.
407
This returns a new WorkingTree object for the new checkout.
409
TODO FIXME RBC 20060124 when we have checkout formats in place this
410
should accept an optional revisionid to checkout [and reject this if
411
checking out into the same dir as a pre-checkout-aware branch format.]
413
XXX: When BzrDir is present, these should be created through that
416
warn('delete WorkingTree.create', stacklevel=3)
417
transport = get_transport(directory)
418
if branch.bzrdir.root_transport.base == transport.base:
420
return branch.bzrdir.create_workingtree()
421
# different directory,
422
# create a branch reference
423
# and now a working tree.
424
raise NotImplementedError
427
@deprecated_method(zero_eight)
428
def create_standalone(directory):
429
"""Create a checkout and a branch and a repo at directory.
431
Directory must exist and be empty.
433
please use BzrDir.create_standalone_workingtree
435
return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
def relpath(self, path):
438
"""Return the local path portion from a given path.
440
The path may be absolute or relative. If its a relative path it is
441
interpreted relative to the python current working directory.
443
return relpath(self.basedir, path)
445
def has_filename(self, filename):
446
return bzrlib.osutils.lexists(self.abspath(filename))
448
def get_file(self, file_id):
449
return self.get_file_byname(self.id2path(file_id))
451
def get_file_byname(self, filename):
452
return file(self.abspath(filename), 'rb')
454
def get_root_id(self):
455
"""Return the id of this trees root"""
456
inv = self.read_working_inventory()
457
return inv.root.file_id
459
def _get_store_filename(self, file_id):
460
## XXX: badly named; this is not in the store at all
461
return self.abspath(self.id2path(file_id))
464
def clone(self, to_bzrdir, revision_id=None, basis=None):
465
"""Duplicate this working tree into to_bzr, including all state.
467
Specifically modified files are kept as modified, but
468
ignored and unknown files are discarded.
470
If you want to make a new line of development, see bzrdir.sprout()
473
If not None, the cloned tree will have its last revision set to
474
revision, and and difference between the source trees last revision
475
and this one merged in.
478
If not None, a closer copy of a tree which may have some files in
479
common, and which file content should be preferentially copied from.
481
# assumes the target bzr dir format is compatible.
482
result = self._format.initialize(to_bzrdir)
483
self.copy_content_into(result, revision_id)
487
def copy_content_into(self, tree, revision_id=None):
488
"""Copy the current content and user files of this tree into tree."""
489
if revision_id is None:
490
transform_tree(tree, self)
492
# TODO now merge from tree.last_revision to revision
493
transform_tree(tree, self)
494
tree.set_last_revision(revision_id)
497
def commit(self, message=None, revprops=None, *args, **kwargs):
498
# avoid circular imports
499
from bzrlib.commit import Commit
502
if not 'branch-nick' in revprops:
503
revprops['branch-nick'] = self.branch.nick
504
# args for wt.commit start at message from the Commit.commit method,
505
# but with branch a kwarg now, passing in args as is results in the
506
#message being used for the branch
507
args = (DEPRECATED_PARAMETER, message, ) + args
508
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
509
self._set_inventory(self.read_working_inventory())
511
def id2abspath(self, file_id):
512
return self.abspath(self.id2path(file_id))
514
def has_id(self, file_id):
515
# files that have been deleted are excluded
516
inv = self._inventory
517
if not inv.has_id(file_id):
519
path = inv.id2path(file_id)
520
return bzrlib.osutils.lexists(self.abspath(path))
522
def has_or_had_id(self, file_id):
523
if file_id == self.inventory.root.file_id:
525
return self.inventory.has_id(file_id)
527
__contains__ = has_id
529
def get_file_size(self, file_id):
530
return os.path.getsize(self.id2abspath(file_id))
533
def get_file_sha1(self, file_id, path=None):
535
path = self._inventory.id2path(file_id)
536
return self._hashcache.get_sha1(path)
538
if not supports_executable():
539
def is_executable(self, file_id, path=None):
540
return self._inventory[file_id].executable
542
def is_executable(self, file_id, path=None):
544
path = self._inventory.id2path(file_id)
545
mode = os.lstat(self.abspath(path)).st_mode
546
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
549
def add(self, files, ids=None):
550
"""Make files versioned.
552
Note that the command line normally calls smart_add instead,
553
which can automatically recurse.
555
This adds the files to the inventory, so that they will be
556
recorded by the next commit.
559
List of paths to add, relative to the base of the tree.
562
If set, use these instead of automatically generated ids.
563
Must be the same length as the list of files, but may
564
contain None for ids that are to be autogenerated.
566
TODO: Perhaps have an option to add the ids even if the files do
569
TODO: Perhaps callback with the ids and paths as they're added.
571
# TODO: Re-adding a file that is removed in the working copy
572
# should probably put it back with the previous ID.
573
if isinstance(files, basestring):
574
assert(ids is None or isinstance(ids, basestring))
580
ids = [None] * len(files)
582
assert(len(ids) == len(files))
584
inv = self.read_working_inventory()
585
for f,file_id in zip(files, ids):
586
if self.is_control_filename(f):
587
raise BzrError("cannot add control file %s" % quotefn(f))
592
raise BzrError("cannot add top-level %r" % f)
594
fullpath = normpath(self.abspath(f))
597
kind = file_kind(fullpath)
599
if e.errno == errno.ENOENT:
600
raise NoSuchFile(fullpath)
601
# maybe something better?
602
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
604
if not InventoryEntry.versionable_kind(kind):
605
raise BzrError('cannot add: not a versionable file ('
606
'i.e. regular file, symlink or directory): %s' % quotefn(f))
609
inv.add_path(f, kind=kind)
611
inv.add_path(f, kind=kind, file_id=file_id)
613
self._write_inventory(inv)
616
def add_pending_merge(self, *revision_ids):
617
# TODO: Perhaps should check at this point that the
618
# history of the revision is actually present?
619
p = self.pending_merges()
621
for rev_id in revision_ids:
627
self.set_pending_merges(p)
630
def pending_merges(self):
631
"""Return a list of pending merges.
633
These are revisions that have been merged into the working
634
directory but not yet committed.
637
merges_file = self._control_files.get_utf8('pending-merges')
639
if e.errno != errno.ENOENT:
643
for l in merges_file.readlines():
644
p.append(l.rstrip('\n'))
648
def set_pending_merges(self, rev_list):
649
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
652
def set_merge_modified(self, modified_hashes):
654
for file_id, hash in modified_hashes.iteritems():
655
yield Stanza(file_id=file_id, hash=hash)
656
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
659
def _put_rio(self, filename, stanzas, header):
660
my_file = rio_file(stanzas, header)
661
self._control_files.put(filename, my_file)
664
def merge_modified(self):
666
hashfile = self._control_files.get('merge-hashes')
671
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
672
raise MergeModifiedFormatError()
673
except StopIteration:
674
raise MergeModifiedFormatError()
675
for s in RioReader(hashfile):
676
file_id = s.get("file_id")
677
if file_id not in self.inventory:
680
if hash == self.get_file_sha1(file_id):
681
merge_hashes[file_id] = hash
684
def get_symlink_target(self, file_id):
685
return os.readlink(self.id2abspath(file_id))
687
def file_class(self, filename):
688
if self.path2id(filename):
690
elif self.is_ignored(filename):
695
def list_files(self):
696
"""Recursively list all files as (path, class, kind, id, entry).
698
Lists, but does not descend into unversioned directories.
700
This does not include files that have been deleted in this
703
Skips the control directory.
705
inv = self._inventory
706
# Convert these into local objects to save lookup times
707
pathjoin = bzrlib.osutils.pathjoin
708
file_kind = bzrlib.osutils.file_kind
710
# transport.base ends in a slash, we want the piece
711
# between the last two slashes
712
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
714
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
716
# directory file_id, relative path, absolute path, reverse sorted children
717
children = os.listdir(self.basedir)
719
# jam 20060527 The kernel sized tree seems equivalent whether we
720
# use a deque and popleft to keep them sorted, or if we use a plain
721
# list and just reverse() them.
722
children = collections.deque(children)
723
stack = [(inv.root.file_id, u'', self.basedir, children)]
725
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
728
f = children.popleft()
729
## TODO: If we find a subdirectory with its own .bzr
730
## directory, then that is a separate tree and we
731
## should exclude it.
733
# the bzrdir for this tree
734
if transport_base_dir == f:
737
# we know that from_dir_relpath and from_dir_abspath never end in a slash
738
# and 'f' doesn't begin with one, we can do a string op, rather
739
# than the checks of pathjoin(), all relative paths will have an extra slash
741
fp = from_dir_relpath + '/' + f
744
fap = from_dir_abspath + '/' + f
746
f_ie = inv.get_child(from_dir_id, f)
749
elif self.is_ignored(fp[1:]):
758
raise BzrCheckError("file %r entered as kind %r id %r, "
760
% (fap, f_ie.kind, f_ie.file_id, fk))
762
# make a last minute entry
764
yield fp[1:], c, fk, f_ie.file_id, f_ie
767
yield fp[1:], c, fk, None, fk_entries[fk]()
769
yield fp[1:], c, fk, None, TreeEntry()
772
if fk != 'directory':
775
# But do this child first
776
new_children = os.listdir(fap)
778
new_children = collections.deque(new_children)
779
stack.append((f_ie.file_id, fp, fap, new_children))
780
# Break out of inner loop, so that we start outer loop with child
783
# if we finished all children, pop it off the stack
788
def move(self, from_paths, to_name):
791
to_name must exist in the inventory.
793
If to_name exists and is a directory, the files are moved into
794
it, keeping their old names.
796
Note that to_name is only the last component of the new name;
797
this doesn't change the directory.
799
This returns a list of (from_path, to_path) pairs for each
803
## TODO: Option to move IDs only
804
assert not isinstance(from_paths, basestring)
806
to_abs = self.abspath(to_name)
807
if not isdir(to_abs):
808
raise BzrError("destination %r is not a directory" % to_abs)
809
if not self.has_filename(to_name):
810
raise BzrError("destination %r not in working directory" % to_abs)
811
to_dir_id = inv.path2id(to_name)
812
if to_dir_id == None and to_name != '':
813
raise BzrError("destination %r is not a versioned directory" % to_name)
814
to_dir_ie = inv[to_dir_id]
815
if to_dir_ie.kind not in ('directory', 'root_directory'):
816
raise BzrError("destination %r is not a directory" % to_abs)
818
to_idpath = inv.get_idpath(to_dir_id)
821
if not self.has_filename(f):
822
raise BzrError("%r does not exist in working tree" % f)
823
f_id = inv.path2id(f)
825
raise BzrError("%r is not versioned" % f)
826
name_tail = splitpath(f)[-1]
827
dest_path = pathjoin(to_name, name_tail)
828
if self.has_filename(dest_path):
829
raise BzrError("destination %r already exists" % dest_path)
830
if f_id in to_idpath:
831
raise BzrError("can't move %r to a subdirectory of itself" % f)
833
# OK, so there's a race here, it's possible that someone will
834
# create a file in this interval and then the rename might be
835
# left half-done. But we should have caught most problems.
836
orig_inv = deepcopy(self.inventory)
839
name_tail = splitpath(f)[-1]
840
dest_path = pathjoin(to_name, name_tail)
841
result.append((f, dest_path))
842
inv.rename(inv.path2id(f), to_dir_id, name_tail)
844
rename(self.abspath(f), self.abspath(dest_path))
846
raise BzrError("failed to rename %r to %r: %s" %
847
(f, dest_path, e[1]),
848
["rename rolled back"])
850
# restore the inventory on error
851
self._set_inventory(orig_inv)
853
self._write_inventory(inv)
857
def rename_one(self, from_rel, to_rel):
860
This can change the directory or the filename or both.
863
if not self.has_filename(from_rel):
864
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
865
if self.has_filename(to_rel):
866
raise BzrError("can't rename: new working file %r already exists" % to_rel)
868
file_id = inv.path2id(from_rel)
870
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
873
from_parent = entry.parent_id
874
from_name = entry.name
876
if inv.path2id(to_rel):
877
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
879
to_dir, to_tail = os.path.split(to_rel)
880
to_dir_id = inv.path2id(to_dir)
881
if to_dir_id == None and to_dir != '':
882
raise BzrError("can't determine destination directory id for %r" % to_dir)
884
mutter("rename_one:")
885
mutter(" file_id {%s}" % file_id)
886
mutter(" from_rel %r" % from_rel)
887
mutter(" to_rel %r" % to_rel)
888
mutter(" to_dir %r" % to_dir)
889
mutter(" to_dir_id {%s}" % to_dir_id)
891
inv.rename(file_id, to_dir_id, to_tail)
893
from_abs = self.abspath(from_rel)
894
to_abs = self.abspath(to_rel)
896
rename(from_abs, to_abs)
898
inv.rename(file_id, from_parent, from_name)
899
raise BzrError("failed to rename %r to %r: %s"
900
% (from_abs, to_abs, e[1]),
901
["rename rolled back"])
902
self._write_inventory(inv)
906
"""Return all unknown files.
908
These are files in the working directory that are not versioned or
909
control files or ignored.
911
>>> from bzrlib.bzrdir import ScratchDir
912
>>> d = ScratchDir(files=['foo', 'foo~'])
913
>>> b = d.open_branch()
914
>>> tree = d.open_workingtree()
915
>>> map(str, tree.unknowns())
918
>>> list(b.unknowns())
920
>>> tree.remove('foo')
921
>>> list(b.unknowns())
924
for subp in self.extras():
925
if not self.is_ignored(subp):
928
@deprecated_method(zero_eight)
929
def iter_conflicts(self):
930
"""List all files in the tree that have text or content conflicts.
931
DEPRECATED. Use conflicts instead."""
932
return self._iter_conflicts()
934
def _iter_conflicts(self):
936
for info in self.list_files():
938
stem = get_conflicted_stem(path)
941
if stem not in conflicted:
946
def pull(self, source, overwrite=False, stop_revision=None):
947
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
950
pp = ProgressPhase("Pull phase", 2, top_pb)
952
old_revision_history = self.branch.revision_history()
953
basis_tree = self.basis_tree()
954
count = self.branch.pull(source, overwrite, stop_revision)
955
new_revision_history = self.branch.revision_history()
956
if new_revision_history != old_revision_history:
958
if len(old_revision_history):
959
other_revision = old_revision_history[-1]
961
other_revision = None
962
repository = self.branch.repository
963
pb = bzrlib.ui.ui_factory.nested_progress_bar()
965
merge_inner(self.branch,
966
self.branch.basis_tree(),
972
self.set_last_revision(self.branch.last_revision())
979
"""Yield all unknown files in this WorkingTree.
981
If there are any unknown directories then only the directory is
982
returned, not all its children. But if there are unknown files
983
under a versioned subdirectory, they are returned.
985
Currently returned depth-first, sorted by name within directories.
987
## TODO: Work from given directory downwards
988
for path, dir_entry in self.inventory.directories():
989
mutter("search for unknowns in %r", path)
990
dirabs = self.abspath(path)
991
if not isdir(dirabs):
992
# e.g. directory deleted
996
for subf in os.listdir(dirabs):
998
and (subf not in dir_entry.children)):
1003
subp = pathjoin(path, subf)
1006
def _translate_ignore_rule(self, rule):
1007
"""Translate a single ignore rule to a regex.
1009
There are two types of ignore rules. Those that do not contain a / are
1010
matched against the tail of the filename (that is, they do not care
1011
what directory the file is in.) Rules which do contain a slash must
1012
match the entire path. As a special case, './' at the start of the
1013
string counts as a slash in the string but is removed before matching
1014
(e.g. ./foo.c, ./src/foo.c)
1016
:return: The translated regex.
1018
if rule[:2] in ('./', '.\\'):
1020
result = fnmatch.translate(rule[2:])
1021
elif '/' in rule or '\\' in rule:
1023
result = fnmatch.translate(rule)
1025
# default rule style.
1026
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1027
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1028
return "(" + result + ")"
1030
def _combine_ignore_rules(self, rules):
1031
"""Combine a list of ignore rules into a single regex object.
1033
Each individual rule is combined with | to form a big regex, which then
1034
has $ added to it to form something like ()|()|()$. The group index for
1035
each subregex's outermost group is placed in a dictionary mapping back
1036
to the rule. This allows quick identification of the matching rule that
1038
:return: a list of the compiled regex and the matching-group index
1039
dictionaries. We return a list because python complains if you try to
1040
combine more than 100 regexes.
1045
translated_rules = []
1047
translated_rule = self._translate_ignore_rule(rule)
1048
compiled_rule = re.compile(translated_rule)
1049
groups[next_group] = rule
1050
next_group += compiled_rule.groups
1051
translated_rules.append(translated_rule)
1052
if next_group == 99:
1053
result.append((re.compile("|".join(translated_rules)), groups))
1056
translated_rules = []
1057
if len(translated_rules):
1058
result.append((re.compile("|".join(translated_rules)), groups))
1061
def ignored_files(self):
1062
"""Yield list of PATH, IGNORE_PATTERN"""
1063
for subp in self.extras():
1064
pat = self.is_ignored(subp)
1068
def get_ignore_list(self):
1069
"""Return list of ignore patterns.
1071
Cached in the Tree object after the first call.
1073
if hasattr(self, '_ignorelist'):
1074
return self._ignorelist
1076
l = bzrlib.DEFAULT_IGNORE[:]
1077
if self.has_filename(bzrlib.IGNORE_FILENAME):
1078
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1079
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1080
self._ignorelist = l
1081
self._ignore_regex = self._combine_ignore_rules(l)
1084
def _get_ignore_rules_as_regex(self):
1085
"""Return a regex of the ignore rules and a mapping dict.
1087
:return: (ignore rules compiled regex, dictionary mapping rule group
1088
indices to original rule.)
1090
if getattr(self, '_ignorelist', None) is None:
1091
self.get_ignore_list()
1092
return self._ignore_regex
1094
def is_ignored(self, filename):
1095
r"""Check whether the filename matches an ignore pattern.
1097
Patterns containing '/' or '\' need to match the whole path;
1098
others match against only the last component.
1100
If the file is ignored, returns the pattern which caused it to
1101
be ignored, otherwise None. So this can simply be used as a
1102
boolean if desired."""
1104
# TODO: Use '**' to match directories, and other extended
1105
# globbing stuff from cvs/rsync.
1107
# XXX: fnmatch is actually not quite what we want: it's only
1108
# approximately the same as real Unix fnmatch, and doesn't
1109
# treat dotfiles correctly and allows * to match /.
1110
# Eventually it should be replaced with something more
1113
rules = self._get_ignore_rules_as_regex()
1114
for regex, mapping in rules:
1115
match = regex.match(filename)
1116
if match is not None:
1117
# one or more of the groups in mapping will have a non-None group
1119
groups = match.groups()
1120
rules = [mapping[group] for group in
1121
mapping if groups[group] is not None]
1125
def kind(self, file_id):
1126
return file_kind(self.id2abspath(file_id))
1129
def last_revision(self):
1130
"""Return the last revision id of this working tree.
1132
In early branch formats this was == the branch last_revision,
1133
but that cannot be relied upon - for working tree operations,
1134
always use tree.last_revision().
1136
return self.branch.last_revision()
1138
def is_locked(self):
1139
return self._control_files.is_locked()
1141
def lock_read(self):
1142
"""See Branch.lock_read, and WorkingTree.unlock."""
1143
self.branch.lock_read()
1145
return self._control_files.lock_read()
1147
self.branch.unlock()
1150
def lock_write(self):
1151
"""See Branch.lock_write, and WorkingTree.unlock."""
1152
self.branch.lock_write()
1154
return self._control_files.lock_write()
1156
self.branch.unlock()
1159
def get_physical_lock_status(self):
1160
return self._control_files.get_physical_lock_status()
1162
def _basis_inventory_name(self):
1163
return 'basis-inventory'
1166
def set_last_revision(self, new_revision):
1167
"""Change the last revision in the working tree."""
1168
if self._change_last_revision(new_revision):
1169
self._cache_basis_inventory(new_revision)
1171
def _change_last_revision(self, new_revision):
1172
"""Template method part of set_last_revision to perform the change.
1174
This is used to allow WorkingTree3 instances to not affect branch
1175
when their last revision is set.
1177
if new_revision is None:
1178
self.branch.set_revision_history([])
1180
# current format is locked in with the branch
1181
revision_history = self.branch.revision_history()
1183
position = revision_history.index(new_revision)
1185
raise errors.NoSuchRevision(self.branch, new_revision)
1186
self.branch.set_revision_history(revision_history[:position + 1])
1189
def _cache_basis_inventory(self, new_revision):
1190
"""Cache new_revision as the basis inventory."""
1191
# TODO: this should allow the ready-to-use inventory to be passed in,
1192
# as commit already has that ready-to-use [while the format is the
1195
# this double handles the inventory - unpack and repack -
1196
# but is easier to understand. We can/should put a conditional
1197
# in here based on whether the inventory is in the latest format
1198
# - perhaps we should repack all inventories on a repository
1200
# the fast path is to copy the raw xml from the repository. If the
1201
# xml contains 'revision_id="', then we assume the right
1202
# revision_id is set. We must check for this full string, because a
1203
# root node id can legitimately look like 'revision_id' but cannot
1205
xml = self.branch.repository.get_inventory_xml(new_revision)
1206
if not 'revision_id="' in xml.split('\n', 1)[0]:
1207
inv = self.branch.repository.deserialise_inventory(
1209
inv.revision_id = new_revision
1210
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1212
path = self._basis_inventory_name()
1213
self._control_files.put_utf8(path, xml)
1214
except WeaveRevisionNotPresent:
1217
def read_basis_inventory(self):
1218
"""Read the cached basis inventory."""
1219
path = self._basis_inventory_name()
1220
return self._control_files.get_utf8(path).read()
1223
def read_working_inventory(self):
1224
"""Read the working inventory."""
1225
# ElementTree does its own conversion from UTF-8, so open in
1227
result = bzrlib.xml5.serializer_v5.read_inventory(
1228
self._control_files.get('inventory'))
1229
self._set_inventory(result)
1233
def remove(self, files, verbose=False):
1234
"""Remove nominated files from the working inventory..
1236
This does not remove their text. This does not run on XXX on what? RBC
1238
TODO: Refuse to remove modified files unless --force is given?
1240
TODO: Do something useful with directories.
1242
TODO: Should this remove the text or not? Tough call; not
1243
removing may be useful and the user can just use use rm, and
1244
is the opposite of add. Removing it is consistent with most
1245
other tools. Maybe an option.
1247
## TODO: Normalize names
1248
## TODO: Remove nested loops; better scalability
1249
if isinstance(files, basestring):
1252
inv = self.inventory
1254
# do this before any modifications
1256
fid = inv.path2id(f)
1258
# TODO: Perhaps make this just a warning, and continue?
1259
# This tends to happen when
1260
raise NotVersionedError(path=f)
1261
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1263
# having remove it, it must be either ignored or unknown
1264
if self.is_ignored(f):
1268
show_status(new_status, inv[fid].kind, quotefn(f))
1271
self._write_inventory(inv)
1274
def revert(self, filenames, old_tree=None, backups=True,
1275
pb=DummyProgress()):
1276
from transform import revert
1277
from conflicts import resolve
1278
if old_tree is None:
1279
old_tree = self.basis_tree()
1280
conflicts = revert(self, old_tree, filenames, backups, pb)
1281
if not len(filenames):
1282
self.set_pending_merges([])
1285
resolve(self, filenames, ignore_misses=True)
1288
# XXX: This method should be deprecated in favour of taking in a proper
1289
# new Inventory object.
1291
def set_inventory(self, new_inventory_list):
1292
from bzrlib.inventory import (Inventory,
1297
inv = Inventory(self.get_root_id())
1298
for path, file_id, parent, kind in new_inventory_list:
1299
name = os.path.basename(path)
1302
# fixme, there should be a factory function inv,add_??
1303
if kind == 'directory':
1304
inv.add(InventoryDirectory(file_id, name, parent))
1305
elif kind == 'file':
1306
inv.add(InventoryFile(file_id, name, parent))
1307
elif kind == 'symlink':
1308
inv.add(InventoryLink(file_id, name, parent))
1310
raise BzrError("unknown kind %r" % kind)
1311
self._write_inventory(inv)
1314
def set_root_id(self, file_id):
1315
"""Set the root id for this tree."""
1316
inv = self.read_working_inventory()
1317
orig_root_id = inv.root.file_id
1318
del inv._byid[inv.root.file_id]
1319
inv.root.file_id = file_id
1320
inv._byid[inv.root.file_id] = inv.root
1323
if entry.parent_id == orig_root_id:
1324
entry.parent_id = inv.root.file_id
1325
self._write_inventory(inv)
1328
"""See Branch.unlock.
1330
WorkingTree locking just uses the Branch locking facilities.
1331
This is current because all working trees have an embedded branch
1332
within them. IF in the future, we were to make branch data shareable
1333
between multiple working trees, i.e. via shared storage, then we
1334
would probably want to lock both the local tree, and the branch.
1336
# FIXME: We want to write out the hashcache only when the last lock on
1337
# this working copy is released. Peeking at the lock count is a bit
1338
# of a nasty hack; probably it's better to have a transaction object,
1339
# which can do some finalization when it's either successfully or
1340
# unsuccessfully completed. (Denys's original patch did that.)
1341
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1342
# wrongly. Hookinh into unllock on the control files object is fine though.
1344
# TODO: split this per format so there is no ugly if block
1345
if self._hashcache.needs_write and (
1346
# dedicated lock files
1347
self._control_files._lock_count==1 or
1349
(self._control_files is self.branch.control_files and
1350
self._control_files._lock_count==3)):
1351
self._hashcache.write()
1352
# reverse order of locking.
1354
return self._control_files.unlock()
1356
self.branch.unlock()
1360
"""Update a working tree along its branch.
1362
This will update the branch if its bound too, which means we have multiple trees involved:
1363
The new basis tree of the master.
1364
The old basis tree of the branch.
1365
The old basis tree of the working tree.
1366
The current working tree state.
1367
pathologically all three may be different, and non ancestors of each other.
1368
Conceptually we want to:
1369
Preserve the wt.basis->wt.state changes
1370
Transform the wt.basis to the new master basis.
1371
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1372
Restore the wt.basis->wt.state changes.
1374
There isn't a single operation at the moment to do that, so we:
1375
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1376
Do a 'normal' merge of the old branch basis if it is relevant.
1378
old_tip = self.branch.update()
1379
if old_tip is not None:
1380
self.add_pending_merge(old_tip)
1381
self.branch.lock_read()
1384
if self.last_revision() != self.branch.last_revision():
1385
# merge tree state up to new branch tip.
1386
basis = self.basis_tree()
1387
to_tree = self.branch.basis_tree()
1388
result += merge_inner(self.branch,
1392
self.set_last_revision(self.branch.last_revision())
1393
if old_tip and old_tip != self.last_revision():
1394
# our last revision was not the prior branch last reivison
1395
# and we have converted that last revision to a pending merge.
1396
# base is somewhere between the branch tip now
1397
# and the now pending merge
1398
from bzrlib.revision import common_ancestor
1400
base_rev_id = common_ancestor(self.branch.last_revision(),
1402
self.branch.repository)
1403
except errors.NoCommonAncestor:
1405
base_tree = self.branch.repository.revision_tree(base_rev_id)
1406
other_tree = self.branch.repository.revision_tree(old_tip)
1407
result += merge_inner(self.branch,
1413
self.branch.unlock()
1416
def _write_inventory(self, inv):
1417
"""Write inventory as the current inventory."""
1419
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1421
self._control_files.put('inventory', sio)
1422
self._set_inventory(inv)
1423
mutter('wrote working inventory')
1425
def set_conflicts(self, arg):
1426
raise UnsupportedOperation(self.set_conflicts, self)
1429
def conflicts(self):
1430
conflicts = ConflictList()
1431
for conflicted in self._iter_conflicts():
1434
if file_kind(self.abspath(conflicted)) != "file":
1437
if e.errno == errno.ENOENT:
1442
for suffix in ('.THIS', '.OTHER'):
1444
kind = file_kind(self.abspath(conflicted+suffix))
1446
if e.errno == errno.ENOENT:
1454
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1455
conflicts.append(Conflict.factory(ctype, path=conflicted,
1456
file_id=self.path2id(conflicted)))
1460
class WorkingTree3(WorkingTree):
1461
"""This is the Format 3 working tree.
1463
This differs from the base WorkingTree by:
1464
- having its own file lock
1465
- having its own last-revision property.
1467
This is new in bzr 0.8
1471
def last_revision(self):
1472
"""See WorkingTree.last_revision."""
1474
return self._control_files.get_utf8('last-revision').read()
1478
def _change_last_revision(self, revision_id):
1479
"""See WorkingTree._change_last_revision."""
1480
if revision_id is None or revision_id == NULL_REVISION:
1482
self._control_files._transport.delete('last-revision')
1483
except errors.NoSuchFile:
1488
self.branch.revision_history().index(revision_id)
1490
raise errors.NoSuchRevision(self.branch, revision_id)
1491
self._control_files.put_utf8('last-revision', revision_id)
1495
def set_conflicts(self, conflicts):
1496
self._put_rio('conflicts', conflicts.to_stanzas(),
1500
def conflicts(self):
1502
confile = self._control_files.get('conflicts')
1504
return ConflictList()
1506
if confile.next() != CONFLICT_HEADER_1 + '\n':
1507
raise ConflictFormatError()
1508
except StopIteration:
1509
raise ConflictFormatError()
1510
return ConflictList.from_stanzas(RioReader(confile))
1513
def get_conflicted_stem(path):
1514
for suffix in CONFLICT_SUFFIXES:
1515
if path.endswith(suffix):
1516
return path[:-len(suffix)]
1518
@deprecated_function(zero_eight)
1519
def is_control_file(filename):
1520
"""See WorkingTree.is_control_filename(filename)."""
1521
## FIXME: better check
1522
filename = normpath(filename)
1523
while filename != '':
1524
head, tail = os.path.split(filename)
1525
## mutter('check %r for control file' % ((head, tail),))
1528
if filename == head:
1534
class WorkingTreeFormat(object):
1535
"""An encapsulation of the initialization and open routines for a format.
1537
Formats provide three things:
1538
* An initialization routine,
1542
Formats are placed in an dict by their format string for reference
1543
during workingtree opening. Its not required that these be instances, they
1544
can be classes themselves with class methods - it simply depends on
1545
whether state is needed for a given format or not.
1547
Once a format is deprecated, just deprecate the initialize and open
1548
methods on the format class. Do not deprecate the object, as the
1549
object will be created every time regardless.
1552
_default_format = None
1553
"""The default format used for new trees."""
1556
"""The known formats."""
1559
def find_format(klass, a_bzrdir):
1560
"""Return the format for the working tree object in a_bzrdir."""
1562
transport = a_bzrdir.get_workingtree_transport(None)
1563
format_string = transport.get("format").read()
1564
return klass._formats[format_string]
1566
raise errors.NoWorkingTree(base=transport.base)
1568
raise errors.UnknownFormatError(format_string)
1571
def get_default_format(klass):
1572
"""Return the current default format."""
1573
return klass._default_format
1575
def get_format_string(self):
1576
"""Return the ASCII format string that identifies this format."""
1577
raise NotImplementedError(self.get_format_string)
1579
def get_format_description(self):
1580
"""Return the short description for this format."""
1581
raise NotImplementedError(self.get_format_description)
1583
def is_supported(self):
1584
"""Is this format supported?
1586
Supported formats can be initialized and opened.
1587
Unsupported formats may not support initialization or committing or
1588
some other features depending on the reason for not being supported.
1593
def register_format(klass, format):
1594
klass._formats[format.get_format_string()] = format
1597
def set_default_format(klass, format):
1598
klass._default_format = format
1601
def unregister_format(klass, format):
1602
assert klass._formats[format.get_format_string()] is format
1603
del klass._formats[format.get_format_string()]
1607
class WorkingTreeFormat2(WorkingTreeFormat):
1608
"""The second working tree format.
1610
This format modified the hash cache from the format 1 hash cache.
1613
def get_format_description(self):
1614
"""See WorkingTreeFormat.get_format_description()."""
1615
return "Working tree format 2"
1617
def stub_initialize_remote(self, control_files):
1618
"""As a special workaround create critical control files for a remote working tree
1620
This ensures that it can later be updated and dealt with locally,
1621
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1622
no working tree. (See bug #43064).
1626
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1628
control_files.put('inventory', sio)
1630
control_files.put_utf8('pending-merges', '')
1633
def initialize(self, a_bzrdir, revision_id=None):
1634
"""See WorkingTreeFormat.initialize()."""
1635
if not isinstance(a_bzrdir.transport, LocalTransport):
1636
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1637
branch = a_bzrdir.open_branch()
1638
if revision_id is not None:
1641
revision_history = branch.revision_history()
1643
position = revision_history.index(revision_id)
1645
raise errors.NoSuchRevision(branch, revision_id)
1646
branch.set_revision_history(revision_history[:position + 1])
1649
revision = branch.last_revision()
1651
wt = WorkingTree(a_bzrdir.root_transport.base,
1657
wt._write_inventory(inv)
1658
wt.set_root_id(inv.root.file_id)
1659
wt.set_last_revision(revision)
1660
wt.set_pending_merges([])
1661
build_tree(wt.basis_tree(), wt)
1665
super(WorkingTreeFormat2, self).__init__()
1666
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1668
def open(self, a_bzrdir, _found=False):
1669
"""Return the WorkingTree object for a_bzrdir
1671
_found is a private parameter, do not use it. It is used to indicate
1672
if format probing has already been done.
1675
# we are being called directly and must probe.
1676
raise NotImplementedError
1677
if not isinstance(a_bzrdir.transport, LocalTransport):
1678
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1679
return WorkingTree(a_bzrdir.root_transport.base,
1685
class WorkingTreeFormat3(WorkingTreeFormat):
1686
"""The second working tree format updated to record a format marker.
1689
- exists within a metadir controlling .bzr
1690
- includes an explicit version marker for the workingtree control
1691
files, separate from the BzrDir format
1692
- modifies the hash cache format
1694
- uses a LockDir to guard access to the repository
1697
def get_format_string(self):
1698
"""See WorkingTreeFormat.get_format_string()."""
1699
return "Bazaar-NG Working Tree format 3"
1701
def get_format_description(self):
1702
"""See WorkingTreeFormat.get_format_description()."""
1703
return "Working tree format 3"
1705
_lock_file_name = 'lock'
1706
_lock_class = LockDir
1708
def _open_control_files(self, a_bzrdir):
1709
transport = a_bzrdir.get_workingtree_transport(None)
1710
return LockableFiles(transport, self._lock_file_name,
1713
def initialize(self, a_bzrdir, revision_id=None):
1714
"""See WorkingTreeFormat.initialize().
1716
revision_id allows creating a working tree at a differnet
1717
revision than the branch is at.
1719
if not isinstance(a_bzrdir.transport, LocalTransport):
1720
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1721
transport = a_bzrdir.get_workingtree_transport(self)
1722
control_files = self._open_control_files(a_bzrdir)
1723
control_files.create_lock()
1724
control_files.lock_write()
1725
control_files.put_utf8('format', self.get_format_string())
1726
branch = a_bzrdir.open_branch()
1727
if revision_id is None:
1728
revision_id = branch.last_revision()
1730
wt = WorkingTree3(a_bzrdir.root_transport.base,
1736
_control_files=control_files)
1739
wt._write_inventory(inv)
1740
wt.set_root_id(inv.root.file_id)
1741
wt.set_last_revision(revision_id)
1742
wt.set_pending_merges([])
1743
build_tree(wt.basis_tree(), wt)
1746
control_files.unlock()
1750
super(WorkingTreeFormat3, self).__init__()
1751
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1753
def open(self, a_bzrdir, _found=False):
1754
"""Return the WorkingTree object for a_bzrdir
1756
_found is a private parameter, do not use it. It is used to indicate
1757
if format probing has already been done.
1760
# we are being called directly and must probe.
1761
raise NotImplementedError
1762
if not isinstance(a_bzrdir.transport, LocalTransport):
1763
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1764
control_files = self._open_control_files(a_bzrdir)
1765
return WorkingTree3(a_bzrdir.root_transport.base,
1769
_control_files=control_files)
1772
return self.get_format_string()
1775
# formats which have no format string are not discoverable
1776
# and not independently creatable, so are not registered.
1777
__default_format = WorkingTreeFormat3()
1778
WorkingTreeFormat.register_format(__default_format)
1779
WorkingTreeFormat.set_default_format(__default_format)
1780
_legacy_formats = [WorkingTreeFormat2(),
1784
class WorkingTreeTestProviderAdapter(object):
1785
"""A tool to generate a suite testing multiple workingtree formats at once.
1787
This is done by copying the test once for each transport and injecting
1788
the transport_server, transport_readonly_server, and workingtree_format
1789
classes into each copy. Each copy is also given a new id() to make it
1793
def __init__(self, transport_server, transport_readonly_server, formats):
1794
self._transport_server = transport_server
1795
self._transport_readonly_server = transport_readonly_server
1796
self._formats = formats
1798
def adapt(self, test):
1799
from bzrlib.tests import TestSuite
1800
result = TestSuite()
1801
for workingtree_format, bzrdir_format in self._formats:
1802
new_test = deepcopy(test)
1803
new_test.transport_server = self._transport_server
1804
new_test.transport_readonly_server = self._transport_readonly_server
1805
new_test.bzrdir_format = bzrdir_format
1806
new_test.workingtree_format = workingtree_format
1807
def make_new_test_id():
1808
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1809
return lambda: new_id
1810
new_test.id = make_new_test_id()
1811
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
