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
54
from bzrlib import bzrdir, errors, osutils, urlutils
55
from bzrlib.atomicfile import AtomicFile
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
58
from bzrlib.errors import (BzrCheckError,
61
WeaveRevisionNotPresent,
65
MergeModifiedFormatError,
68
from bzrlib.inventory import InventoryEntry, Inventory
69
from bzrlib.lockable_files import LockableFiles, TransportLock
70
from bzrlib.lockdir import LockDir
71
from bzrlib.merge import merge_inner, transform_tree
72
from bzrlib.osutils import (
89
from bzrlib.progress import DummyProgress, ProgressPhase
90
from bzrlib.revision import NULL_REVISION
91
from bzrlib.rio import RioReader, rio_file, Stanza
92
from bzrlib.symbol_versioning import (deprecated_passed,
99
from bzrlib.textui import show_status
101
from bzrlib.transform import build_tree
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport import get_transport
104
from bzrlib.transport.local import LocalTransport
109
# the regex here does the following:
110
# 1) remove any weird characters; we don't escape them but rather
112
# 2) match leading '.'s to make it not hidden
113
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
114
_gen_id_suffix = None
118
def _next_id_suffix():
119
"""Create a new file id suffix that is reasonably unique.
121
On the first call we combine the current time with 64 bits of randomness
122
to give a highly probably globally unique number. Then each call in the same
123
process adds 1 to a serial number we append to that unique value.
125
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
126
# than having to move the id randomness out of the inner loop like this.
127
# XXX TODO: for the global randomness this uses we should add the thread-id
128
# before the serial #.
129
global _gen_id_suffix, _gen_id_serial
130
if _gen_id_suffix is None:
131
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
133
return _gen_id_suffix + str(_gen_id_serial)
136
def gen_file_id(name):
137
"""Return new file id for the basename 'name'.
139
The uniqueness is supplied from _next_id_suffix.
141
# XXX TODO: squash the filename to lowercase.
142
# XXX TODO: truncate the filename to something like 20 or 30 chars.
143
# XXX TODO: consider what to do with ids that look like illegal filepaths
144
# on platforms we support.
145
return _gen_file_id_re.sub('', name) + _next_id_suffix()
149
"""Return a new tree-root file id."""
150
return gen_file_id('TREE_ROOT')
153
class TreeEntry(object):
154
"""An entry that implements the minimum interface used by commands.
156
This needs further inspection, it may be better to have
157
InventoryEntries without ids - though that seems wrong. For now,
158
this is a parallel hierarchy to InventoryEntry, and needs to become
159
one of several things: decorates to that hierarchy, children of, or
161
Another note is that these objects are currently only used when there is
162
no InventoryEntry available - i.e. for unversioned objects.
163
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
166
def __eq__(self, other):
167
# yes, this us ugly, TODO: best practice __eq__ style.
168
return (isinstance(other, TreeEntry)
169
and other.__class__ == self.__class__)
171
def kind_character(self):
175
class TreeDirectory(TreeEntry):
176
"""See TreeEntry. This is a directory in a working tree."""
178
def __eq__(self, other):
179
return (isinstance(other, TreeDirectory)
180
and other.__class__ == self.__class__)
182
def kind_character(self):
186
class TreeFile(TreeEntry):
187
"""See TreeEntry. This is a regular file in a working tree."""
189
def __eq__(self, other):
190
return (isinstance(other, TreeFile)
191
and other.__class__ == self.__class__)
193
def kind_character(self):
197
class TreeLink(TreeEntry):
198
"""See TreeEntry. This is a symlink in a working tree."""
200
def __eq__(self, other):
201
return (isinstance(other, TreeLink)
202
and other.__class__ == self.__class__)
204
def kind_character(self):
208
class WorkingTree(bzrlib.tree.Tree):
209
"""Working copy tree.
211
The inventory is held in the `Branch` working-inventory, and the
212
files are in a directory on disk.
214
It is possible for a `WorkingTree` to have a filename which is
215
not listed in the Inventory and vice versa.
218
def __init__(self, basedir='.',
219
branch=DEPRECATED_PARAMETER,
225
"""Construct a WorkingTree for basedir.
227
If the branch is not supplied, it is opened automatically.
228
If the branch is supplied, it must be the branch for this basedir.
229
(branch.base is not cross checked, because for remote branches that
230
would be meaningless).
232
self._format = _format
233
self.bzrdir = _bzrdir
235
# not created via open etc.
236
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
237
"Please use bzrdir.open_workingtree or WorkingTree.open().",
240
wt = WorkingTree.open(basedir)
241
self._branch = wt.branch
242
self.basedir = wt.basedir
243
self._control_files = wt._control_files
244
self._hashcache = wt._hashcache
245
self._set_inventory(wt._inventory)
246
self._format = wt._format
247
self.bzrdir = wt.bzrdir
248
from bzrlib.hashcache import HashCache
249
from bzrlib.trace import note, mutter
250
assert isinstance(basedir, basestring), \
251
"base directory %r is not a string" % basedir
252
basedir = safe_unicode(basedir)
253
mutter("opening working tree %r", basedir)
254
if deprecated_passed(branch):
256
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
257
" Please use bzrdir.open_workingtree() or"
258
" WorkingTree.open().",
262
self._branch = branch
264
self._branch = self.bzrdir.open_branch()
265
self.basedir = realpath(basedir)
266
# if branch is at our basedir and is a format 6 or less
267
if isinstance(self._format, WorkingTreeFormat2):
268
# share control object
269
self._control_files = self.branch.control_files
271
# only ready for format 3
272
assert isinstance(self._format, WorkingTreeFormat3)
273
assert isinstance(_control_files, LockableFiles), \
274
"_control_files must be a LockableFiles, not %r" \
276
self._control_files = _control_files
277
# update the whole cache up front and write to disk if anything changed;
278
# in the future we might want to do this more selectively
279
# two possible ways offer themselves : in self._unlock, write the cache
280
# if needed, or, when the cache sees a change, append it to the hash
281
# cache file, and have the parser take the most recent entry for a
283
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
284
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
286
# is this scan needed ? it makes things kinda slow.
293
if _inventory is None:
294
self._set_inventory(self.read_working_inventory())
296
self._set_inventory(_inventory)
299
fget=lambda self: self._branch,
300
doc="""The branch this WorkingTree is connected to.
302
This cannot be set - it is reflective of the actual disk structure
303
the working tree has been constructed from.
306
def break_lock(self):
307
"""Break a lock if one is present from another instance.
309
Uses the ui factory to ask for confirmation if the lock may be from
312
This will probe the repository for its lock as well.
314
self._control_files.break_lock()
315
self.branch.break_lock()
317
def _set_inventory(self, inv):
318
self._inventory = inv
319
self.path2id = self._inventory.path2id
321
def is_control_filename(self, filename):
322
"""True if filename is the name of a control file in this tree.
324
:param filename: A filename within the tree. This is a relative path
325
from the root of this tree.
327
This is true IF and ONLY IF the filename is part of the meta data
328
that bzr controls in this tree. I.E. a random .bzr directory placed
329
on disk will not be a control file for this tree.
331
return self.bzrdir.is_control_filename(filename)
334
def open(path=None, _unsupported=False):
335
"""Open an existing working tree at path.
339
path = os.path.getcwdu()
340
control = bzrdir.BzrDir.open(path, _unsupported)
341
return control.open_workingtree(_unsupported)
344
def open_containing(path=None):
345
"""Open an existing working tree which has its root about path.
347
This probes for a working tree at path and searches upwards from there.
349
Basically we keep looking up until we find the control directory or
350
run into /. If there isn't one, raises NotBranchError.
351
TODO: give this a new exception.
352
If there is one, it is returned, along with the unused portion of path.
354
:return: The WorkingTree that contains 'path', and the rest of path
357
path = osutils.getcwd()
358
control, relpath = bzrdir.BzrDir.open_containing(path)
360
return control.open_workingtree(), relpath
363
def open_downlevel(path=None):
364
"""Open an unsupported working tree.
366
Only intended for advanced situations like upgrading part of a bzrdir.
368
return WorkingTree.open(path, _unsupported=True)
371
"""Iterate through file_ids for this tree.
373
file_ids are in a WorkingTree if they are in the working inventory
374
and the working file exists.
376
inv = self._inventory
377
for path, ie in inv.iter_entries():
378
if bzrlib.osutils.lexists(self.abspath(path)):
382
return "<%s of %s>" % (self.__class__.__name__,
383
getattr(self, 'basedir', None))
385
def abspath(self, filename):
386
return pathjoin(self.basedir, filename)
388
def basis_tree(self):
389
"""Return RevisionTree for the current last revision."""
390
revision_id = self.last_revision()
391
if revision_id is not None:
393
xml = self.read_basis_inventory()
394
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
397
if inv is not None and inv.revision_id == revision_id:
398
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
400
# FIXME? RBC 20060403 should we cache the inventory here ?
401
return self.branch.repository.revision_tree(revision_id)
404
@deprecated_method(zero_eight)
405
def create(branch, directory):
406
"""Create a workingtree for branch at directory.
408
If existing_directory already exists it must have a .bzr directory.
409
If it does not exist, it will be created.
411
This returns a new WorkingTree object for the new checkout.
413
TODO FIXME RBC 20060124 when we have checkout formats in place this
414
should accept an optional revisionid to checkout [and reject this if
415
checking out into the same dir as a pre-checkout-aware branch format.]
417
XXX: When BzrDir is present, these should be created through that
420
warnings.warn('delete WorkingTree.create', stacklevel=3)
421
transport = get_transport(directory)
422
if branch.bzrdir.root_transport.base == transport.base:
424
return branch.bzrdir.create_workingtree()
425
# different directory,
426
# create a branch reference
427
# and now a working tree.
428
raise NotImplementedError
431
@deprecated_method(zero_eight)
432
def create_standalone(directory):
433
"""Create a checkout and a branch and a repo at directory.
435
Directory must exist and be empty.
437
please use BzrDir.create_standalone_workingtree
439
return bzrdir.BzrDir.create_standalone_workingtree(directory)
441
def relpath(self, path):
442
"""Return the local path portion from a given path.
444
The path may be absolute or relative. If its a relative path it is
445
interpreted relative to the python current working directory.
447
return relpath(self.basedir, path)
449
def has_filename(self, filename):
450
return bzrlib.osutils.lexists(self.abspath(filename))
452
def get_file(self, file_id):
453
return self.get_file_byname(self.id2path(file_id))
455
def get_file_byname(self, filename):
456
return file(self.abspath(filename), 'rb')
458
def get_parent_ids(self):
459
"""See Tree.get_parent_ids.
461
This implementation reads the pending merges list and last_revision
462
value and uses that to decide what the parents list should be.
464
last_rev = self.last_revision()
469
other_parents = self.pending_merges()
470
return parents + other_parents
472
def get_root_id(self):
473
"""Return the id of this trees root"""
474
inv = self.read_working_inventory()
475
return inv.root.file_id
477
def _get_store_filename(self, file_id):
478
## XXX: badly named; this is not in the store at all
479
return self.abspath(self.id2path(file_id))
482
def clone(self, to_bzrdir, revision_id=None, basis=None):
483
"""Duplicate this working tree into to_bzr, including all state.
485
Specifically modified files are kept as modified, but
486
ignored and unknown files are discarded.
488
If you want to make a new line of development, see bzrdir.sprout()
491
If not None, the cloned tree will have its last revision set to
492
revision, and and difference between the source trees last revision
493
and this one merged in.
496
If not None, a closer copy of a tree which may have some files in
497
common, and which file content should be preferentially copied from.
499
# assumes the target bzr dir format is compatible.
500
result = self._format.initialize(to_bzrdir)
501
self.copy_content_into(result, revision_id)
505
def copy_content_into(self, tree, revision_id=None):
506
"""Copy the current content and user files of this tree into tree."""
507
if revision_id is None:
508
transform_tree(tree, self)
510
# TODO now merge from tree.last_revision to revision
511
transform_tree(tree, self)
512
tree.set_last_revision(revision_id)
515
def commit(self, message=None, revprops=None, *args, **kwargs):
516
# avoid circular imports
517
from bzrlib.commit import Commit
520
if not 'branch-nick' in revprops:
521
revprops['branch-nick'] = self.branch.nick
522
# args for wt.commit start at message from the Commit.commit method,
523
# but with branch a kwarg now, passing in args as is results in the
524
#message being used for the branch
525
args = (DEPRECATED_PARAMETER, message, ) + args
526
committed_id = Commit().commit( working_tree=self, revprops=revprops,
528
self._set_inventory(self.read_working_inventory())
531
def id2abspath(self, file_id):
532
return self.abspath(self.id2path(file_id))
534
def has_id(self, file_id):
535
# files that have been deleted are excluded
536
inv = self._inventory
537
if not inv.has_id(file_id):
539
path = inv.id2path(file_id)
540
return bzrlib.osutils.lexists(self.abspath(path))
542
def has_or_had_id(self, file_id):
543
if file_id == self.inventory.root.file_id:
545
return self.inventory.has_id(file_id)
547
__contains__ = has_id
549
def get_file_size(self, file_id):
550
return os.path.getsize(self.id2abspath(file_id))
553
def get_file_sha1(self, file_id, path=None):
555
path = self._inventory.id2path(file_id)
556
return self._hashcache.get_sha1(path)
558
def get_file_mtime(self, file_id, path=None):
560
path = self._inventory.id2path(file_id)
561
return os.lstat(self.abspath(path)).st_mtime
563
if not supports_executable():
564
def is_executable(self, file_id, path=None):
565
return self._inventory[file_id].executable
567
def is_executable(self, file_id, path=None):
569
path = self._inventory.id2path(file_id)
570
mode = os.lstat(self.abspath(path)).st_mode
571
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
574
def add(self, files, ids=None):
575
"""Make files versioned.
577
Note that the command line normally calls smart_add instead,
578
which can automatically recurse.
580
This adds the files to the inventory, so that they will be
581
recorded by the next commit.
584
List of paths to add, relative to the base of the tree.
587
If set, use these instead of automatically generated ids.
588
Must be the same length as the list of files, but may
589
contain None for ids that are to be autogenerated.
591
TODO: Perhaps have an option to add the ids even if the files do
594
TODO: Perhaps callback with the ids and paths as they're added.
596
# TODO: Re-adding a file that is removed in the working copy
597
# should probably put it back with the previous ID.
598
if isinstance(files, basestring):
599
assert(ids is None or isinstance(ids, basestring))
605
ids = [None] * len(files)
607
assert(len(ids) == len(files))
609
inv = self.read_working_inventory()
610
for f,file_id in zip(files, ids):
611
if self.is_control_filename(f):
612
raise errors.ForbiddenControlFileError(filename=f)
617
raise BzrError("cannot add top-level %r" % f)
619
fullpath = normpath(self.abspath(f))
621
kind = file_kind(fullpath)
623
if e.errno == errno.ENOENT:
624
raise NoSuchFile(fullpath)
625
if not InventoryEntry.versionable_kind(kind):
626
raise errors.BadFileKindError(filename=f, kind=kind)
628
inv.add_path(f, kind=kind)
630
inv.add_path(f, kind=kind, file_id=file_id)
632
self._write_inventory(inv)
635
def add_pending_merge(self, *revision_ids):
636
# TODO: Perhaps should check at this point that the
637
# history of the revision is actually present?
638
p = self.pending_merges()
640
for rev_id in revision_ids:
646
self.set_pending_merges(p)
649
def pending_merges(self):
650
"""Return a list of pending merges.
652
These are revisions that have been merged into the working
653
directory but not yet committed.
656
merges_file = self._control_files.get_utf8('pending-merges')
660
for l in merges_file.readlines():
661
p.append(l.rstrip('\n'))
665
def set_pending_merges(self, rev_list):
666
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
669
def set_merge_modified(self, modified_hashes):
671
for file_id, hash in modified_hashes.iteritems():
672
yield Stanza(file_id=file_id, hash=hash)
673
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
676
def _put_rio(self, filename, stanzas, header):
677
my_file = rio_file(stanzas, header)
678
self._control_files.put(filename, my_file)
681
def merge_modified(self):
683
hashfile = self._control_files.get('merge-hashes')
688
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
689
raise MergeModifiedFormatError()
690
except StopIteration:
691
raise MergeModifiedFormatError()
692
for s in RioReader(hashfile):
693
file_id = s.get("file_id")
694
if file_id not in self.inventory:
697
if hash == self.get_file_sha1(file_id):
698
merge_hashes[file_id] = hash
701
def get_symlink_target(self, file_id):
702
return os.readlink(self.id2abspath(file_id))
704
def file_class(self, filename):
705
if self.path2id(filename):
707
elif self.is_ignored(filename):
712
def list_files(self):
713
"""Recursively list all files as (path, class, kind, id, entry).
715
Lists, but does not descend into unversioned directories.
717
This does not include files that have been deleted in this
720
Skips the control directory.
722
inv = self._inventory
723
# Convert these into local objects to save lookup times
724
pathjoin = bzrlib.osutils.pathjoin
725
file_kind = bzrlib.osutils.file_kind
727
# transport.base ends in a slash, we want the piece
728
# between the last two slashes
729
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
731
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
733
# directory file_id, relative path, absolute path, reverse sorted children
734
children = os.listdir(self.basedir)
736
# jam 20060527 The kernel sized tree seems equivalent whether we
737
# use a deque and popleft to keep them sorted, or if we use a plain
738
# list and just reverse() them.
739
children = collections.deque(children)
740
stack = [(inv.root.file_id, u'', self.basedir, children)]
742
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
745
f = children.popleft()
746
## TODO: If we find a subdirectory with its own .bzr
747
## directory, then that is a separate tree and we
748
## should exclude it.
750
# the bzrdir for this tree
751
if transport_base_dir == f:
754
# we know that from_dir_relpath and from_dir_abspath never end in a slash
755
# and 'f' doesn't begin with one, we can do a string op, rather
756
# than the checks of pathjoin(), all relative paths will have an extra slash
758
fp = from_dir_relpath + '/' + f
761
fap = from_dir_abspath + '/' + f
763
f_ie = inv.get_child(from_dir_id, f)
766
elif self.is_ignored(fp[1:]):
769
# we may not have found this file, because of a unicode issue
770
f_norm, can_access = osutils.normalized_filename(f)
771
if f == f_norm or not can_access:
772
# No change, so treat this file normally
775
# this file can be accessed by a normalized path
776
# check again if it is versioned
777
# these lines are repeated here for performance
779
fp = from_dir_relpath + '/' + f
780
fap = from_dir_abspath + '/' + f
781
f_ie = inv.get_child(from_dir_id, f)
784
elif self.is_ignored(fp[1:]):
793
raise BzrCheckError("file %r entered as kind %r id %r, "
795
% (fap, f_ie.kind, f_ie.file_id, fk))
797
# make a last minute entry
799
yield fp[1:], c, fk, f_ie.file_id, f_ie
802
yield fp[1:], c, fk, None, fk_entries[fk]()
804
yield fp[1:], c, fk, None, TreeEntry()
807
if fk != 'directory':
810
# But do this child first
811
new_children = os.listdir(fap)
813
new_children = collections.deque(new_children)
814
stack.append((f_ie.file_id, fp, fap, new_children))
815
# Break out of inner loop, so that we start outer loop with child
818
# if we finished all children, pop it off the stack
823
def move(self, from_paths, to_name):
826
to_name must exist in the inventory.
828
If to_name exists and is a directory, the files are moved into
829
it, keeping their old names.
831
Note that to_name is only the last component of the new name;
832
this doesn't change the directory.
834
This returns a list of (from_path, to_path) pairs for each
838
## TODO: Option to move IDs only
839
assert not isinstance(from_paths, basestring)
841
to_abs = self.abspath(to_name)
842
if not isdir(to_abs):
843
raise BzrError("destination %r is not a directory" % to_abs)
844
if not self.has_filename(to_name):
845
raise BzrError("destination %r not in working directory" % to_abs)
846
to_dir_id = inv.path2id(to_name)
847
if to_dir_id == None and to_name != '':
848
raise BzrError("destination %r is not a versioned directory" % to_name)
849
to_dir_ie = inv[to_dir_id]
850
if to_dir_ie.kind not in ('directory', 'root_directory'):
851
raise BzrError("destination %r is not a directory" % to_abs)
853
to_idpath = inv.get_idpath(to_dir_id)
856
if not self.has_filename(f):
857
raise BzrError("%r does not exist in working tree" % f)
858
f_id = inv.path2id(f)
860
raise BzrError("%r is not versioned" % f)
861
name_tail = splitpath(f)[-1]
862
dest_path = pathjoin(to_name, name_tail)
863
if self.has_filename(dest_path):
864
raise BzrError("destination %r already exists" % dest_path)
865
if f_id in to_idpath:
866
raise BzrError("can't move %r to a subdirectory of itself" % f)
868
# OK, so there's a race here, it's possible that someone will
869
# create a file in this interval and then the rename might be
870
# left half-done. But we should have caught most problems.
871
orig_inv = deepcopy(self.inventory)
874
name_tail = splitpath(f)[-1]
875
dest_path = pathjoin(to_name, name_tail)
876
result.append((f, dest_path))
877
inv.rename(inv.path2id(f), to_dir_id, name_tail)
879
rename(self.abspath(f), self.abspath(dest_path))
881
raise BzrError("failed to rename %r to %r: %s" %
882
(f, dest_path, e[1]),
883
["rename rolled back"])
885
# restore the inventory on error
886
self._set_inventory(orig_inv)
888
self._write_inventory(inv)
892
def rename_one(self, from_rel, to_rel):
895
This can change the directory or the filename or both.
898
if not self.has_filename(from_rel):
899
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
900
if self.has_filename(to_rel):
901
raise BzrError("can't rename: new working file %r already exists" % to_rel)
903
file_id = inv.path2id(from_rel)
905
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
908
from_parent = entry.parent_id
909
from_name = entry.name
911
if inv.path2id(to_rel):
912
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
914
to_dir, to_tail = os.path.split(to_rel)
915
to_dir_id = inv.path2id(to_dir)
916
if to_dir_id == None and to_dir != '':
917
raise BzrError("can't determine destination directory id for %r" % to_dir)
919
mutter("rename_one:")
920
mutter(" file_id {%s}" % file_id)
921
mutter(" from_rel %r" % from_rel)
922
mutter(" to_rel %r" % to_rel)
923
mutter(" to_dir %r" % to_dir)
924
mutter(" to_dir_id {%s}" % to_dir_id)
926
inv.rename(file_id, to_dir_id, to_tail)
928
from_abs = self.abspath(from_rel)
929
to_abs = self.abspath(to_rel)
931
rename(from_abs, to_abs)
933
inv.rename(file_id, from_parent, from_name)
934
raise BzrError("failed to rename %r to %r: %s"
935
% (from_abs, to_abs, e[1]),
936
["rename rolled back"])
937
self._write_inventory(inv)
941
"""Return all unknown files.
943
These are files in the working directory that are not versioned or
944
control files or ignored.
946
for subp in self.extras():
947
if not self.is_ignored(subp):
950
@deprecated_method(zero_eight)
951
def iter_conflicts(self):
952
"""List all files in the tree that have text or content conflicts.
953
DEPRECATED. Use conflicts instead."""
954
return self._iter_conflicts()
956
def _iter_conflicts(self):
958
for info in self.list_files():
960
stem = get_conflicted_stem(path)
963
if stem not in conflicted:
968
def pull(self, source, overwrite=False, stop_revision=None):
969
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
972
pp = ProgressPhase("Pull phase", 2, top_pb)
974
old_revision_history = self.branch.revision_history()
975
basis_tree = self.basis_tree()
976
count = self.branch.pull(source, overwrite, stop_revision)
977
new_revision_history = self.branch.revision_history()
978
if new_revision_history != old_revision_history:
980
if len(old_revision_history):
981
other_revision = old_revision_history[-1]
983
other_revision = None
984
repository = self.branch.repository
985
pb = bzrlib.ui.ui_factory.nested_progress_bar()
987
merge_inner(self.branch,
988
self.branch.basis_tree(),
994
self.set_last_revision(self.branch.last_revision())
1001
"""Yield all unknown files in this WorkingTree.
1003
If there are any unknown directories then only the directory is
1004
returned, not all its children. But if there are unknown files
1005
under a versioned subdirectory, they are returned.
1007
Currently returned depth-first, sorted by name within directories.
1009
## TODO: Work from given directory downwards
1010
for path, dir_entry in self.inventory.directories():
1011
mutter("search for unknowns in %r", path)
1012
dirabs = self.abspath(path)
1013
if not isdir(dirabs):
1014
# e.g. directory deleted
1018
for subf in os.listdir(dirabs):
1021
if subf not in dir_entry.children:
1022
subf_norm, can_access = osutils.normalized_filename(subf)
1023
if subf_norm != subf and can_access:
1024
if subf_norm not in dir_entry.children:
1025
fl.append(subf_norm)
1031
subp = pathjoin(path, subf)
1034
def _translate_ignore_rule(self, rule):
1035
"""Translate a single ignore rule to a regex.
1037
There are two types of ignore rules. Those that do not contain a / are
1038
matched against the tail of the filename (that is, they do not care
1039
what directory the file is in.) Rules which do contain a slash must
1040
match the entire path. As a special case, './' at the start of the
1041
string counts as a slash in the string but is removed before matching
1042
(e.g. ./foo.c, ./src/foo.c)
1044
:return: The translated regex.
1046
if rule[:2] in ('./', '.\\'):
1048
result = fnmatch.translate(rule[2:])
1049
elif '/' in rule or '\\' in rule:
1051
result = fnmatch.translate(rule)
1053
# default rule style.
1054
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1055
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1056
return "(" + result + ")"
1058
def _combine_ignore_rules(self, rules):
1059
"""Combine a list of ignore rules into a single regex object.
1061
Each individual rule is combined with | to form a big regex, which then
1062
has $ added to it to form something like ()|()|()$. The group index for
1063
each subregex's outermost group is placed in a dictionary mapping back
1064
to the rule. This allows quick identification of the matching rule that
1066
:return: a list of the compiled regex and the matching-group index
1067
dictionaries. We return a list because python complains if you try to
1068
combine more than 100 regexes.
1073
translated_rules = []
1075
translated_rule = self._translate_ignore_rule(rule)
1076
compiled_rule = re.compile(translated_rule)
1077
groups[next_group] = rule
1078
next_group += compiled_rule.groups
1079
translated_rules.append(translated_rule)
1080
if next_group == 99:
1081
result.append((re.compile("|".join(translated_rules)), groups))
1084
translated_rules = []
1085
if len(translated_rules):
1086
result.append((re.compile("|".join(translated_rules)), groups))
1089
def ignored_files(self):
1090
"""Yield list of PATH, IGNORE_PATTERN"""
1091
for subp in self.extras():
1092
pat = self.is_ignored(subp)
1096
def get_ignore_list(self):
1097
"""Return list of ignore patterns.
1099
Cached in the Tree object after the first call.
1101
if hasattr(self, '_ignorelist'):
1102
return self._ignorelist
1105
if self.has_filename(bzrlib.IGNORE_FILENAME):
1106
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1107
l.extend([line.rstrip("\n\r").decode('utf-8')
1108
for line in f.readlines()])
1109
self._ignorelist = l
1110
self._ignore_regex = self._combine_ignore_rules(l)
1113
def _get_ignore_rules_as_regex(self):
1114
"""Return a regex of the ignore rules and a mapping dict.
1116
:return: (ignore rules compiled regex, dictionary mapping rule group
1117
indices to original rule.)
1119
if getattr(self, '_ignorelist', None) is None:
1120
self.get_ignore_list()
1121
return self._ignore_regex
1123
def is_ignored(self, filename):
1124
r"""Check whether the filename matches an ignore pattern.
1126
Patterns containing '/' or '\' need to match the whole path;
1127
others match against only the last component.
1129
If the file is ignored, returns the pattern which caused it to
1130
be ignored, otherwise None. So this can simply be used as a
1131
boolean if desired."""
1133
# TODO: Use '**' to match directories, and other extended
1134
# globbing stuff from cvs/rsync.
1136
# XXX: fnmatch is actually not quite what we want: it's only
1137
# approximately the same as real Unix fnmatch, and doesn't
1138
# treat dotfiles correctly and allows * to match /.
1139
# Eventually it should be replaced with something more
1142
rules = self._get_ignore_rules_as_regex()
1143
for regex, mapping in rules:
1144
match = regex.match(filename)
1145
if match is not None:
1146
# one or more of the groups in mapping will have a non-None group
1148
groups = match.groups()
1149
rules = [mapping[group] for group in
1150
mapping if groups[group] is not None]
1154
def kind(self, file_id):
1155
return file_kind(self.id2abspath(file_id))
1158
def last_revision(self):
1159
"""Return the last revision id of this working tree.
1161
In early branch formats this was == the branch last_revision,
1162
but that cannot be relied upon - for working tree operations,
1163
always use tree.last_revision().
1165
return self.branch.last_revision()
1167
def is_locked(self):
1168
return self._control_files.is_locked()
1170
def lock_read(self):
1171
"""See Branch.lock_read, and WorkingTree.unlock."""
1172
self.branch.lock_read()
1174
return self._control_files.lock_read()
1176
self.branch.unlock()
1179
def lock_write(self):
1180
"""See Branch.lock_write, and WorkingTree.unlock."""
1181
self.branch.lock_write()
1183
return self._control_files.lock_write()
1185
self.branch.unlock()
1188
def get_physical_lock_status(self):
1189
return self._control_files.get_physical_lock_status()
1191
def _basis_inventory_name(self):
1192
return 'basis-inventory'
1195
def set_last_revision(self, new_revision):
1196
"""Change the last revision in the working tree."""
1197
if self._change_last_revision(new_revision):
1198
self._cache_basis_inventory(new_revision)
1200
def _change_last_revision(self, new_revision):
1201
"""Template method part of set_last_revision to perform the change.
1203
This is used to allow WorkingTree3 instances to not affect branch
1204
when their last revision is set.
1206
if new_revision is None:
1207
self.branch.set_revision_history([])
1209
# current format is locked in with the branch
1210
revision_history = self.branch.revision_history()
1212
position = revision_history.index(new_revision)
1214
raise errors.NoSuchRevision(self.branch, new_revision)
1215
self.branch.set_revision_history(revision_history[:position + 1])
1218
def _cache_basis_inventory(self, new_revision):
1219
"""Cache new_revision as the basis inventory."""
1220
# TODO: this should allow the ready-to-use inventory to be passed in,
1221
# as commit already has that ready-to-use [while the format is the
1224
# this double handles the inventory - unpack and repack -
1225
# but is easier to understand. We can/should put a conditional
1226
# in here based on whether the inventory is in the latest format
1227
# - perhaps we should repack all inventories on a repository
1229
# the fast path is to copy the raw xml from the repository. If the
1230
# xml contains 'revision_id="', then we assume the right
1231
# revision_id is set. We must check for this full string, because a
1232
# root node id can legitimately look like 'revision_id' but cannot
1234
xml = self.branch.repository.get_inventory_xml(new_revision)
1235
if not 'revision_id="' in xml.split('\n', 1)[0]:
1236
inv = self.branch.repository.deserialise_inventory(
1238
inv.revision_id = new_revision
1239
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1240
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1241
path = self._basis_inventory_name()
1243
self._control_files.put(path, sio)
1244
except WeaveRevisionNotPresent:
1247
def read_basis_inventory(self):
1248
"""Read the cached basis inventory."""
1249
path = self._basis_inventory_name()
1250
return self._control_files.get(path).read()
1253
def read_working_inventory(self):
1254
"""Read the working inventory."""
1255
# ElementTree does its own conversion from UTF-8, so open in
1257
result = bzrlib.xml5.serializer_v5.read_inventory(
1258
self._control_files.get('inventory'))
1259
self._set_inventory(result)
1263
def remove(self, files, verbose=False, to_file=None):
1264
"""Remove nominated files from the working inventory..
1266
This does not remove their text. This does not run on XXX on what? RBC
1268
TODO: Refuse to remove modified files unless --force is given?
1270
TODO: Do something useful with directories.
1272
TODO: Should this remove the text or not? Tough call; not
1273
removing may be useful and the user can just use use rm, and
1274
is the opposite of add. Removing it is consistent with most
1275
other tools. Maybe an option.
1277
## TODO: Normalize names
1278
## TODO: Remove nested loops; better scalability
1279
if isinstance(files, basestring):
1282
inv = self.inventory
1284
# do this before any modifications
1286
fid = inv.path2id(f)
1288
# TODO: Perhaps make this just a warning, and continue?
1289
# This tends to happen when
1290
raise NotVersionedError(path=f)
1292
# having remove it, it must be either ignored or unknown
1293
if self.is_ignored(f):
1297
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1300
self._write_inventory(inv)
1303
def revert(self, filenames, old_tree=None, backups=True,
1304
pb=DummyProgress()):
1305
from transform import revert
1306
from conflicts import resolve
1307
if old_tree is None:
1308
old_tree = self.basis_tree()
1309
conflicts = revert(self, old_tree, filenames, backups, pb)
1310
if not len(filenames):
1311
self.set_pending_merges([])
1314
resolve(self, filenames, ignore_misses=True)
1317
# XXX: This method should be deprecated in favour of taking in a proper
1318
# new Inventory object.
1320
def set_inventory(self, new_inventory_list):
1321
from bzrlib.inventory import (Inventory,
1326
inv = Inventory(self.get_root_id())
1327
for path, file_id, parent, kind in new_inventory_list:
1328
name = os.path.basename(path)
1331
# fixme, there should be a factory function inv,add_??
1332
if kind == 'directory':
1333
inv.add(InventoryDirectory(file_id, name, parent))
1334
elif kind == 'file':
1335
inv.add(InventoryFile(file_id, name, parent))
1336
elif kind == 'symlink':
1337
inv.add(InventoryLink(file_id, name, parent))
1339
raise BzrError("unknown kind %r" % kind)
1340
self._write_inventory(inv)
1343
def set_root_id(self, file_id):
1344
"""Set the root id for this tree."""
1345
inv = self.read_working_inventory()
1346
orig_root_id = inv.root.file_id
1347
del inv._byid[inv.root.file_id]
1348
inv.root.file_id = file_id
1349
inv._byid[inv.root.file_id] = inv.root
1352
if entry.parent_id == orig_root_id:
1353
entry.parent_id = inv.root.file_id
1354
self._write_inventory(inv)
1357
"""See Branch.unlock.
1359
WorkingTree locking just uses the Branch locking facilities.
1360
This is current because all working trees have an embedded branch
1361
within them. IF in the future, we were to make branch data shareable
1362
between multiple working trees, i.e. via shared storage, then we
1363
would probably want to lock both the local tree, and the branch.
1365
# FIXME: We want to write out the hashcache only when the last lock on
1366
# this working copy is released. Peeking at the lock count is a bit
1367
# of a nasty hack; probably it's better to have a transaction object,
1368
# which can do some finalization when it's either successfully or
1369
# unsuccessfully completed. (Denys's original patch did that.)
1370
# RBC 20060206 hooking into transaction will couple lock and transaction
1371
# wrongly. Hooking into unlock on the control files object is fine though.
1373
# TODO: split this per format so there is no ugly if block
1374
if self._hashcache.needs_write and (
1375
# dedicated lock files
1376
self._control_files._lock_count==1 or
1378
(self._control_files is self.branch.control_files and
1379
self._control_files._lock_count==3)):
1380
self._hashcache.write()
1381
# reverse order of locking.
1383
return self._control_files.unlock()
1385
self.branch.unlock()
1389
"""Update a working tree along its branch.
1391
This will update the branch if its bound too, which means we have multiple trees involved:
1392
The new basis tree of the master.
1393
The old basis tree of the branch.
1394
The old basis tree of the working tree.
1395
The current working tree state.
1396
pathologically all three may be different, and non ancestors of each other.
1397
Conceptually we want to:
1398
Preserve the wt.basis->wt.state changes
1399
Transform the wt.basis to the new master basis.
1400
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1401
Restore the wt.basis->wt.state changes.
1403
There isn't a single operation at the moment to do that, so we:
1404
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1405
Do a 'normal' merge of the old branch basis if it is relevant.
1407
old_tip = self.branch.update()
1408
if old_tip is not None:
1409
self.add_pending_merge(old_tip)
1410
self.branch.lock_read()
1413
if self.last_revision() != self.branch.last_revision():
1414
# merge tree state up to new branch tip.
1415
basis = self.basis_tree()
1416
to_tree = self.branch.basis_tree()
1417
result += merge_inner(self.branch,
1421
self.set_last_revision(self.branch.last_revision())
1422
if old_tip and old_tip != self.last_revision():
1423
# our last revision was not the prior branch last revision
1424
# and we have converted that last revision to a pending merge.
1425
# base is somewhere between the branch tip now
1426
# and the now pending merge
1427
from bzrlib.revision import common_ancestor
1429
base_rev_id = common_ancestor(self.branch.last_revision(),
1431
self.branch.repository)
1432
except errors.NoCommonAncestor:
1434
base_tree = self.branch.repository.revision_tree(base_rev_id)
1435
other_tree = self.branch.repository.revision_tree(old_tip)
1436
result += merge_inner(self.branch,
1442
self.branch.unlock()
1445
def _write_inventory(self, inv):
1446
"""Write inventory as the current inventory."""
1448
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1450
self._control_files.put('inventory', sio)
1451
self._set_inventory(inv)
1452
mutter('wrote working inventory')
1454
def set_conflicts(self, arg):
1455
raise UnsupportedOperation(self.set_conflicts, self)
1457
def add_conflicts(self, arg):
1458
raise UnsupportedOperation(self.add_conflicts, self)
1461
def conflicts(self):
1462
conflicts = ConflictList()
1463
for conflicted in self._iter_conflicts():
1466
if file_kind(self.abspath(conflicted)) != "file":
1468
except errors.NoSuchFile:
1471
for suffix in ('.THIS', '.OTHER'):
1473
kind = file_kind(self.abspath(conflicted+suffix))
1476
except errors.NoSuchFile:
1480
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1481
conflicts.append(Conflict.factory(ctype, path=conflicted,
1482
file_id=self.path2id(conflicted)))
1486
class WorkingTree3(WorkingTree):
1487
"""This is the Format 3 working tree.
1489
This differs from the base WorkingTree by:
1490
- having its own file lock
1491
- having its own last-revision property.
1493
This is new in bzr 0.8
1497
def last_revision(self):
1498
"""See WorkingTree.last_revision."""
1500
return self._control_files.get_utf8('last-revision').read()
1504
def _change_last_revision(self, revision_id):
1505
"""See WorkingTree._change_last_revision."""
1506
if revision_id is None or revision_id == NULL_REVISION:
1508
self._control_files._transport.delete('last-revision')
1509
except errors.NoSuchFile:
1514
self.branch.revision_history().index(revision_id)
1516
raise errors.NoSuchRevision(self.branch, revision_id)
1517
self._control_files.put_utf8('last-revision', revision_id)
1521
def set_conflicts(self, conflicts):
1522
self._put_rio('conflicts', conflicts.to_stanzas(),
1526
def add_conflicts(self, new_conflicts):
1527
conflict_set = set(self.conflicts())
1528
conflict_set.update(set(list(new_conflicts)))
1529
self.set_conflicts(ConflictList(sorted(conflict_set,
1530
key=Conflict.sort_key)))
1533
def conflicts(self):
1535
confile = self._control_files.get('conflicts')
1537
return ConflictList()
1539
if confile.next() != CONFLICT_HEADER_1 + '\n':
1540
raise ConflictFormatError()
1541
except StopIteration:
1542
raise ConflictFormatError()
1543
return ConflictList.from_stanzas(RioReader(confile))
1546
def get_conflicted_stem(path):
1547
for suffix in CONFLICT_SUFFIXES:
1548
if path.endswith(suffix):
1549
return path[:-len(suffix)]
1551
@deprecated_function(zero_eight)
1552
def is_control_file(filename):
1553
"""See WorkingTree.is_control_filename(filename)."""
1554
## FIXME: better check
1555
filename = normpath(filename)
1556
while filename != '':
1557
head, tail = os.path.split(filename)
1558
## mutter('check %r for control file' % ((head, tail),))
1561
if filename == head:
1567
class WorkingTreeFormat(object):
1568
"""An encapsulation of the initialization and open routines for a format.
1570
Formats provide three things:
1571
* An initialization routine,
1575
Formats are placed in an dict by their format string for reference
1576
during workingtree opening. Its not required that these be instances, they
1577
can be classes themselves with class methods - it simply depends on
1578
whether state is needed for a given format or not.
1580
Once a format is deprecated, just deprecate the initialize and open
1581
methods on the format class. Do not deprecate the object, as the
1582
object will be created every time regardless.
1585
_default_format = None
1586
"""The default format used for new trees."""
1589
"""The known formats."""
1592
def find_format(klass, a_bzrdir):
1593
"""Return the format for the working tree object in a_bzrdir."""
1595
transport = a_bzrdir.get_workingtree_transport(None)
1596
format_string = transport.get("format").read()
1597
return klass._formats[format_string]
1599
raise errors.NoWorkingTree(base=transport.base)
1601
raise errors.UnknownFormatError(format=format_string)
1604
def get_default_format(klass):
1605
"""Return the current default format."""
1606
return klass._default_format
1608
def get_format_string(self):
1609
"""Return the ASCII format string that identifies this format."""
1610
raise NotImplementedError(self.get_format_string)
1612
def get_format_description(self):
1613
"""Return the short description for this format."""
1614
raise NotImplementedError(self.get_format_description)
1616
def is_supported(self):
1617
"""Is this format supported?
1619
Supported formats can be initialized and opened.
1620
Unsupported formats may not support initialization or committing or
1621
some other features depending on the reason for not being supported.
1626
def register_format(klass, format):
1627
klass._formats[format.get_format_string()] = format
1630
def set_default_format(klass, format):
1631
klass._default_format = format
1634
def unregister_format(klass, format):
1635
assert klass._formats[format.get_format_string()] is format
1636
del klass._formats[format.get_format_string()]
1640
class WorkingTreeFormat2(WorkingTreeFormat):
1641
"""The second working tree format.
1643
This format modified the hash cache from the format 1 hash cache.
1646
def get_format_description(self):
1647
"""See WorkingTreeFormat.get_format_description()."""
1648
return "Working tree format 2"
1650
def stub_initialize_remote(self, control_files):
1651
"""As a special workaround create critical control files for a remote working tree
1653
This ensures that it can later be updated and dealt with locally,
1654
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1655
no working tree. (See bug #43064).
1659
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1661
control_files.put('inventory', sio)
1663
control_files.put_utf8('pending-merges', '')
1666
def initialize(self, a_bzrdir, revision_id=None):
1667
"""See WorkingTreeFormat.initialize()."""
1668
if not isinstance(a_bzrdir.transport, LocalTransport):
1669
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1670
branch = a_bzrdir.open_branch()
1671
if revision_id is not None:
1674
revision_history = branch.revision_history()
1676
position = revision_history.index(revision_id)
1678
raise errors.NoSuchRevision(branch, revision_id)
1679
branch.set_revision_history(revision_history[:position + 1])
1682
revision = branch.last_revision()
1684
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1690
wt._write_inventory(inv)
1691
wt.set_root_id(inv.root.file_id)
1692
wt.set_last_revision(revision)
1693
wt.set_pending_merges([])
1694
build_tree(wt.basis_tree(), wt)
1698
super(WorkingTreeFormat2, self).__init__()
1699
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1701
def open(self, a_bzrdir, _found=False):
1702
"""Return the WorkingTree object for a_bzrdir
1704
_found is a private parameter, do not use it. It is used to indicate
1705
if format probing has already been done.
1708
# we are being called directly and must probe.
1709
raise NotImplementedError
1710
if not isinstance(a_bzrdir.transport, LocalTransport):
1711
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1712
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1718
class WorkingTreeFormat3(WorkingTreeFormat):
1719
"""The second working tree format updated to record a format marker.
1722
- exists within a metadir controlling .bzr
1723
- includes an explicit version marker for the workingtree control
1724
files, separate from the BzrDir format
1725
- modifies the hash cache format
1727
- uses a LockDir to guard access to the repository
1730
def get_format_string(self):
1731
"""See WorkingTreeFormat.get_format_string()."""
1732
return "Bazaar-NG Working Tree format 3"
1734
def get_format_description(self):
1735
"""See WorkingTreeFormat.get_format_description()."""
1736
return "Working tree format 3"
1738
_lock_file_name = 'lock'
1739
_lock_class = LockDir
1741
def _open_control_files(self, a_bzrdir):
1742
transport = a_bzrdir.get_workingtree_transport(None)
1743
return LockableFiles(transport, self._lock_file_name,
1746
def initialize(self, a_bzrdir, revision_id=None):
1747
"""See WorkingTreeFormat.initialize().
1749
revision_id allows creating a working tree at a different
1750
revision than the branch is at.
1752
if not isinstance(a_bzrdir.transport, LocalTransport):
1753
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1754
transport = a_bzrdir.get_workingtree_transport(self)
1755
control_files = self._open_control_files(a_bzrdir)
1756
control_files.create_lock()
1757
control_files.lock_write()
1758
control_files.put_utf8('format', self.get_format_string())
1759
branch = a_bzrdir.open_branch()
1760
if revision_id is None:
1761
revision_id = branch.last_revision()
1763
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1769
_control_files=control_files)
1772
wt._write_inventory(inv)
1773
wt.set_root_id(inv.root.file_id)
1774
wt.set_last_revision(revision_id)
1775
wt.set_pending_merges([])
1776
build_tree(wt.basis_tree(), wt)
1779
control_files.unlock()
1783
super(WorkingTreeFormat3, self).__init__()
1784
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1786
def open(self, a_bzrdir, _found=False):
1787
"""Return the WorkingTree object for a_bzrdir
1789
_found is a private parameter, do not use it. It is used to indicate
1790
if format probing has already been done.
1793
# we are being called directly and must probe.
1794
raise NotImplementedError
1795
if not isinstance(a_bzrdir.transport, LocalTransport):
1796
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1797
control_files = self._open_control_files(a_bzrdir)
1798
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1802
_control_files=control_files)
1805
return self.get_format_string()
1808
# formats which have no format string are not discoverable
1809
# and not independently creatable, so are not registered.
1810
__default_format = WorkingTreeFormat3()
1811
WorkingTreeFormat.register_format(__default_format)
1812
WorkingTreeFormat.set_default_format(__default_format)
1813
_legacy_formats = [WorkingTreeFormat2(),
1817
class WorkingTreeTestProviderAdapter(object):
1818
"""A tool to generate a suite testing multiple workingtree formats at once.
1820
This is done by copying the test once for each transport and injecting
1821
the transport_server, transport_readonly_server, and workingtree_format
1822
classes into each copy. Each copy is also given a new id() to make it
1826
def __init__(self, transport_server, transport_readonly_server, formats):
1827
self._transport_server = transport_server
1828
self._transport_readonly_server = transport_readonly_server
1829
self._formats = formats
1831
def adapt(self, test):
1832
from bzrlib.tests import TestSuite
1833
result = TestSuite()
1834
for workingtree_format, bzrdir_format in self._formats:
1835
new_test = deepcopy(test)
1836
new_test.transport_server = self._transport_server
1837
new_test.transport_readonly_server = self._transport_readonly_server
1838
new_test.bzrdir_format = bzrdir_format
1839
new_test.workingtree_format = workingtree_format
1840
def make_new_test_id():
1841
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1842
return lambda: new_id
1843
new_test.id = make_new_test_id()
1844
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
