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,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import *
95
from bzrlib.textui import show_status
97
from bzrlib.transform import build_tree
98
from bzrlib.trace import mutter, note
99
from bzrlib.transport import get_transport
100
from bzrlib.transport.local import LocalTransport
101
import bzrlib.urlutils as urlutils
106
# the regex here does the following:
107
# 1) remove any weird characters; we don't escape them but rather
109
# 2) match leading '.'s to make it not hidden
110
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
111
_gen_id_suffix = None
115
def _next_id_suffix():
116
"""Create a new file id suffix that is reasonably unique.
118
On the first call we combine the current time with 64 bits of randomness
119
to give a highly probably globally unique number. Then each call in the same
120
process adds 1 to a serial number we append to that unique value.
122
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
123
# than having to move the id randomness out of the inner loop like this.
124
# XXX TODO: for the global randomness this uses we should add the thread-id
125
# before the serial #.
126
global _gen_id_suffix, _gen_id_serial
127
if _gen_id_suffix is None:
128
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
130
return _gen_id_suffix + str(_gen_id_serial)
133
def gen_file_id(name):
134
"""Return new file id for the basename 'name'.
136
The uniqueness is supplied from _next_id_suffix.
138
# XXX TODO: squash the filename to lowercase.
139
# XXX TODO: truncate the filename to something like 20 or 30 chars.
140
# XXX TODO: consider what to do with ids that look like illegal filepaths
141
# on platforms we support.
142
return _gen_file_id_re.sub('', name) + _next_id_suffix()
146
"""Return a new tree-root file id."""
147
return gen_file_id('TREE_ROOT')
150
class TreeEntry(object):
151
"""An entry that implements the minimum interface used by commands.
153
This needs further inspection, it may be better to have
154
InventoryEntries without ids - though that seems wrong. For now,
155
this is a parallel hierarchy to InventoryEntry, and needs to become
156
one of several things: decorates to that hierarchy, children of, or
158
Another note is that these objects are currently only used when there is
159
no InventoryEntry available - i.e. for unversioned objects.
160
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
163
def __eq__(self, other):
164
# yes, this us ugly, TODO: best practice __eq__ style.
165
return (isinstance(other, TreeEntry)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeDirectory(TreeEntry):
173
"""See TreeEntry. This is a directory in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeDirectory)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeFile(TreeEntry):
184
"""See TreeEntry. This is a regular file in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeFile)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeLink(TreeEntry):
195
"""See TreeEntry. This is a symlink in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeLink)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class WorkingTree(bzrlib.tree.Tree):
206
"""Working copy tree.
208
The inventory is held in the `Branch` working-inventory, and the
209
files are in a directory on disk.
211
It is possible for a `WorkingTree` to have a filename which is
212
not listed in the Inventory and vice versa.
215
def __init__(self, basedir='.',
216
branch=DEPRECATED_PARAMETER,
222
"""Construct a WorkingTree for basedir.
224
If the branch is not supplied, it is opened automatically.
225
If the branch is supplied, it must be the branch for this basedir.
226
(branch.base is not cross checked, because for remote branches that
227
would be meaningless).
229
self._format = _format
230
self.bzrdir = _bzrdir
232
# not created via open etc.
233
warn("WorkingTree() is deprecated as of bzr version 0.8. "
234
"Please use bzrdir.open_workingtree or WorkingTree.open().",
237
wt = WorkingTree.open(basedir)
238
self._branch = wt.branch
239
self.basedir = wt.basedir
240
self._control_files = wt._control_files
241
self._hashcache = wt._hashcache
242
self._set_inventory(wt._inventory)
243
self._format = wt._format
244
self.bzrdir = wt.bzrdir
245
from bzrlib.hashcache import HashCache
246
from bzrlib.trace import note, mutter
247
assert isinstance(basedir, basestring), \
248
"base directory %r is not a string" % basedir
249
basedir = safe_unicode(basedir)
250
mutter("opening working tree %r", basedir)
251
if deprecated_passed(branch):
253
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
254
" Please use bzrdir.open_workingtree() or"
255
" WorkingTree.open().",
259
self._branch = branch
261
self._branch = self.bzrdir.open_branch()
262
assert isinstance(self.branch, Branch), \
263
"branch %r is not a Branch" % self.branch
264
self.basedir = realpath(basedir)
265
# if branch is at our basedir and is a format 6 or less
266
if isinstance(self._format, WorkingTreeFormat2):
267
# share control object
268
self._control_files = self.branch.control_files
270
# only ready for format 3
271
assert isinstance(self._format, WorkingTreeFormat3)
272
assert isinstance(_control_files, LockableFiles), \
273
"_control_files must be a LockableFiles, not %r" \
275
self._control_files = _control_files
276
# update the whole cache up front and write to disk if anything changed;
277
# in the future we might want to do this more selectively
278
# two possible ways offer themselves : in self._unlock, write the cache
279
# if needed, or, when the cache sees a change, append it to the hash
280
# cache file, and have the parser take the most recent entry for a
282
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
283
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
285
# is this scan needed ? it makes things kinda slow.
292
if _inventory is None:
293
self._set_inventory(self.read_working_inventory())
295
self._set_inventory(_inventory)
298
fget=lambda self: self._branch,
299
doc="""The branch this WorkingTree is connected to.
301
This cannot be set - it is reflective of the actual disk structure
302
the working tree has been constructed from.
305
def break_lock(self):
306
"""Break a lock if one is present from another instance.
308
Uses the ui factory to ask for confirmation if the lock may be from
311
This will probe the repository for its lock as well.
313
self._control_files.break_lock()
314
self.branch.break_lock()
316
def _set_inventory(self, inv):
317
self._inventory = inv
318
self.path2id = self._inventory.path2id
320
def is_control_filename(self, filename):
321
"""True if filename is the name of a control file in this tree.
323
:param filename: A filename within the tree. This is a relative path
324
from the root of this tree.
326
This is true IF and ONLY IF the filename is part of the meta data
327
that bzr controls in this tree. I.E. a random .bzr directory placed
328
on disk will not be a control file for this tree.
330
return self.bzrdir.is_control_filename(filename)
333
def open(path=None, _unsupported=False):
334
"""Open an existing working tree at path.
338
path = os.path.getcwdu()
339
control = bzrdir.BzrDir.open(path, _unsupported)
340
return control.open_workingtree(_unsupported)
343
def open_containing(path=None):
344
"""Open an existing working tree which has its root about path.
346
This probes for a working tree at path and searches upwards from there.
348
Basically we keep looking up until we find the control directory or
349
run into /. If there isn't one, raises NotBranchError.
350
TODO: give this a new exception.
351
If there is one, it is returned, along with the unused portion of path.
353
:return: The WorkingTree that contains 'path', and the rest of path
357
control, relpath = bzrdir.BzrDir.open_containing(path)
359
return control.open_workingtree(), relpath
362
def open_downlevel(path=None):
363
"""Open an unsupported working tree.
365
Only intended for advanced situations like upgrading part of a bzrdir.
367
return WorkingTree.open(path, _unsupported=True)
370
"""Iterate through file_ids for this tree.
372
file_ids are in a WorkingTree if they are in the working inventory
373
and the working file exists.
375
inv = self._inventory
376
for path, ie in inv.iter_entries():
377
if bzrlib.osutils.lexists(self.abspath(path)):
381
return "<%s of %s>" % (self.__class__.__name__,
382
getattr(self, 'basedir', None))
384
def abspath(self, filename):
385
return pathjoin(self.basedir, filename)
387
def basis_tree(self):
388
"""Return RevisionTree for the current last revision."""
389
revision_id = self.last_revision()
390
if revision_id is not None:
392
xml = self.read_basis_inventory()
393
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
396
if inv is not None and inv.revision_id == revision_id:
397
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
399
# FIXME? RBC 20060403 should we cache the inventory here ?
400
return self.branch.repository.revision_tree(revision_id)
403
@deprecated_method(zero_eight)
404
def create(branch, directory):
405
"""Create a workingtree for branch at directory.
407
If existing_directory already exists it must have a .bzr directory.
408
If it does not exist, it will be created.
410
This returns a new WorkingTree object for the new checkout.
412
TODO FIXME RBC 20060124 when we have checkout formats in place this
413
should accept an optional revisionid to checkout [and reject this if
414
checking out into the same dir as a pre-checkout-aware branch format.]
416
XXX: When BzrDir is present, these should be created through that
419
warn('delete WorkingTree.create', stacklevel=3)
420
transport = get_transport(directory)
421
if branch.bzrdir.root_transport.base == transport.base:
423
return branch.bzrdir.create_workingtree()
424
# different directory,
425
# create a branch reference
426
# and now a working tree.
427
raise NotImplementedError
430
@deprecated_method(zero_eight)
431
def create_standalone(directory):
432
"""Create a checkout and a branch and a repo at directory.
434
Directory must exist and be empty.
436
please use BzrDir.create_standalone_workingtree
438
return bzrdir.BzrDir.create_standalone_workingtree(directory)
440
def relpath(self, path):
441
"""Return the local path portion from a given path.
443
The path may be absolute or relative. If its a relative path it is
444
interpreted relative to the python current working directory.
446
return relpath(self.basedir, path)
448
def has_filename(self, filename):
449
return bzrlib.osutils.lexists(self.abspath(filename))
451
def get_file(self, file_id):
452
return self.get_file_byname(self.id2path(file_id))
454
def get_file_byname(self, filename):
455
return file(self.abspath(filename), 'rb')
457
def get_parent_ids(self):
458
"""See Tree.get_parent_ids.
460
This implementation reads the pending merges list and last_revision
461
value and uses that to decide what the parents list should be.
463
last_rev = self.last_revision()
468
other_parents = self.pending_merges()
469
return parents + other_parents
471
def get_root_id(self):
472
"""Return the id of this trees root"""
473
inv = self.read_working_inventory()
474
return inv.root.file_id
476
def _get_store_filename(self, file_id):
477
## XXX: badly named; this is not in the store at all
478
return self.abspath(self.id2path(file_id))
481
def clone(self, to_bzrdir, revision_id=None, basis=None):
482
"""Duplicate this working tree into to_bzr, including all state.
484
Specifically modified files are kept as modified, but
485
ignored and unknown files are discarded.
487
If you want to make a new line of development, see bzrdir.sprout()
490
If not None, the cloned tree will have its last revision set to
491
revision, and and difference between the source trees last revision
492
and this one merged in.
495
If not None, a closer copy of a tree which may have some files in
496
common, and which file content should be preferentially copied from.
498
# assumes the target bzr dir format is compatible.
499
result = self._format.initialize(to_bzrdir)
500
self.copy_content_into(result, revision_id)
504
def copy_content_into(self, tree, revision_id=None):
505
"""Copy the current content and user files of this tree into tree."""
506
if revision_id is None:
507
transform_tree(tree, self)
509
# TODO now merge from tree.last_revision to revision
510
transform_tree(tree, self)
511
tree.set_last_revision(revision_id)
514
def commit(self, message=None, revprops=None, *args, **kwargs):
515
# avoid circular imports
516
from bzrlib.commit import Commit
519
if not 'branch-nick' in revprops:
520
revprops['branch-nick'] = self.branch.nick
521
# args for wt.commit start at message from the Commit.commit method,
522
# but with branch a kwarg now, passing in args as is results in the
523
#message being used for the branch
524
args = (DEPRECATED_PARAMETER, message, ) + args
525
committed_id = Commit().commit( working_tree=self, revprops=revprops,
527
self._set_inventory(self.read_working_inventory())
530
def id2abspath(self, file_id):
531
return self.abspath(self.id2path(file_id))
533
def has_id(self, file_id):
534
# files that have been deleted are excluded
535
inv = self._inventory
536
if not inv.has_id(file_id):
538
path = inv.id2path(file_id)
539
return bzrlib.osutils.lexists(self.abspath(path))
541
def has_or_had_id(self, file_id):
542
if file_id == self.inventory.root.file_id:
544
return self.inventory.has_id(file_id)
546
__contains__ = has_id
548
def get_file_size(self, file_id):
549
return os.path.getsize(self.id2abspath(file_id))
552
def get_file_sha1(self, file_id, path=None):
554
path = self._inventory.id2path(file_id)
555
return self._hashcache.get_sha1(path)
557
def get_file_mtime(self, file_id, path=None):
559
path = self._inventory.id2path(file_id)
560
return os.lstat(self.abspath(path)).st_mtime
562
if not supports_executable():
563
def is_executable(self, file_id, path=None):
564
return self._inventory[file_id].executable
566
def is_executable(self, file_id, path=None):
568
path = self._inventory.id2path(file_id)
569
mode = os.lstat(self.abspath(path)).st_mode
570
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
573
def add(self, files, ids=None):
574
"""Make files versioned.
576
Note that the command line normally calls smart_add instead,
577
which can automatically recurse.
579
This adds the files to the inventory, so that they will be
580
recorded by the next commit.
583
List of paths to add, relative to the base of the tree.
586
If set, use these instead of automatically generated ids.
587
Must be the same length as the list of files, but may
588
contain None for ids that are to be autogenerated.
590
TODO: Perhaps have an option to add the ids even if the files do
593
TODO: Perhaps callback with the ids and paths as they're added.
595
# TODO: Re-adding a file that is removed in the working copy
596
# should probably put it back with the previous ID.
597
if isinstance(files, basestring):
598
assert(ids is None or isinstance(ids, basestring))
604
ids = [None] * len(files)
606
assert(len(ids) == len(files))
608
inv = self.read_working_inventory()
609
for f,file_id in zip(files, ids):
610
if self.is_control_filename(f):
611
raise BzrError("cannot add control file %s" % quotefn(f))
616
raise BzrError("cannot add top-level %r" % f)
618
fullpath = normpath(self.abspath(f))
621
kind = file_kind(fullpath)
623
if e.errno == errno.ENOENT:
624
raise NoSuchFile(fullpath)
625
# maybe something better?
626
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
628
if not InventoryEntry.versionable_kind(kind):
629
raise BzrError('cannot add: not a versionable file ('
630
'i.e. regular file, symlink or directory): %s' % quotefn(f))
633
inv.add_path(f, kind=kind)
635
inv.add_path(f, kind=kind, file_id=file_id)
637
self._write_inventory(inv)
640
def add_pending_merge(self, *revision_ids):
641
# TODO: Perhaps should check at this point that the
642
# history of the revision is actually present?
643
p = self.pending_merges()
645
for rev_id in revision_ids:
651
self.set_pending_merges(p)
654
def pending_merges(self):
655
"""Return a list of pending merges.
657
These are revisions that have been merged into the working
658
directory but not yet committed.
661
merges_file = self._control_files.get_utf8('pending-merges')
663
if e.errno != errno.ENOENT:
667
for l in merges_file.readlines():
668
p.append(l.rstrip('\n'))
672
def set_pending_merges(self, rev_list):
673
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
676
def set_merge_modified(self, modified_hashes):
678
for file_id, hash in modified_hashes.iteritems():
679
yield Stanza(file_id=file_id, hash=hash)
680
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
683
def _put_rio(self, filename, stanzas, header):
684
my_file = rio_file(stanzas, header)
685
self._control_files.put(filename, my_file)
688
def merge_modified(self):
690
hashfile = self._control_files.get('merge-hashes')
695
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
696
raise MergeModifiedFormatError()
697
except StopIteration:
698
raise MergeModifiedFormatError()
699
for s in RioReader(hashfile):
700
file_id = s.get("file_id")
701
if file_id not in self.inventory:
704
if hash == self.get_file_sha1(file_id):
705
merge_hashes[file_id] = hash
708
def get_symlink_target(self, file_id):
709
return os.readlink(self.id2abspath(file_id))
711
def file_class(self, filename):
712
if self.path2id(filename):
714
elif self.is_ignored(filename):
719
def list_files(self):
720
"""Recursively list all files as (path, class, kind, id, entry).
722
Lists, but does not descend into unversioned directories.
724
This does not include files that have been deleted in this
727
Skips the control directory.
729
inv = self._inventory
730
# Convert these into local objects to save lookup times
731
pathjoin = bzrlib.osutils.pathjoin
732
file_kind = bzrlib.osutils.file_kind
734
# transport.base ends in a slash, we want the piece
735
# between the last two slashes
736
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
738
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
740
# directory file_id, relative path, absolute path, reverse sorted children
741
children = os.listdir(self.basedir)
743
# jam 20060527 The kernel sized tree seems equivalent whether we
744
# use a deque and popleft to keep them sorted, or if we use a plain
745
# list and just reverse() them.
746
children = collections.deque(children)
747
stack = [(inv.root.file_id, u'', self.basedir, children)]
749
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
752
f = children.popleft()
753
## TODO: If we find a subdirectory with its own .bzr
754
## directory, then that is a separate tree and we
755
## should exclude it.
757
# the bzrdir for this tree
758
if transport_base_dir == f:
761
# we know that from_dir_relpath and from_dir_abspath never end in a slash
762
# and 'f' doesn't begin with one, we can do a string op, rather
763
# than the checks of pathjoin(), all relative paths will have an extra slash
765
fp = from_dir_relpath + '/' + f
768
fap = from_dir_abspath + '/' + f
770
f_ie = inv.get_child(from_dir_id, f)
773
elif self.is_ignored(fp[1:]):
782
raise BzrCheckError("file %r entered as kind %r id %r, "
784
% (fap, f_ie.kind, f_ie.file_id, fk))
786
# make a last minute entry
788
yield fp[1:], c, fk, f_ie.file_id, f_ie
791
yield fp[1:], c, fk, None, fk_entries[fk]()
793
yield fp[1:], c, fk, None, TreeEntry()
796
if fk != 'directory':
799
# But do this child first
800
new_children = os.listdir(fap)
802
new_children = collections.deque(new_children)
803
stack.append((f_ie.file_id, fp, fap, new_children))
804
# Break out of inner loop, so that we start outer loop with child
807
# if we finished all children, pop it off the stack
812
def move(self, from_paths, to_name):
815
to_name must exist in the inventory.
817
If to_name exists and is a directory, the files are moved into
818
it, keeping their old names.
820
Note that to_name is only the last component of the new name;
821
this doesn't change the directory.
823
This returns a list of (from_path, to_path) pairs for each
827
## TODO: Option to move IDs only
828
assert not isinstance(from_paths, basestring)
830
to_abs = self.abspath(to_name)
831
if not isdir(to_abs):
832
raise BzrError("destination %r is not a directory" % to_abs)
833
if not self.has_filename(to_name):
834
raise BzrError("destination %r not in working directory" % to_abs)
835
to_dir_id = inv.path2id(to_name)
836
if to_dir_id == None and to_name != '':
837
raise BzrError("destination %r is not a versioned directory" % to_name)
838
to_dir_ie = inv[to_dir_id]
839
if to_dir_ie.kind not in ('directory', 'root_directory'):
840
raise BzrError("destination %r is not a directory" % to_abs)
842
to_idpath = inv.get_idpath(to_dir_id)
845
if not self.has_filename(f):
846
raise BzrError("%r does not exist in working tree" % f)
847
f_id = inv.path2id(f)
849
raise BzrError("%r is not versioned" % f)
850
name_tail = splitpath(f)[-1]
851
dest_path = pathjoin(to_name, name_tail)
852
if self.has_filename(dest_path):
853
raise BzrError("destination %r already exists" % dest_path)
854
if f_id in to_idpath:
855
raise BzrError("can't move %r to a subdirectory of itself" % f)
857
# OK, so there's a race here, it's possible that someone will
858
# create a file in this interval and then the rename might be
859
# left half-done. But we should have caught most problems.
860
orig_inv = deepcopy(self.inventory)
863
name_tail = splitpath(f)[-1]
864
dest_path = pathjoin(to_name, name_tail)
865
result.append((f, dest_path))
866
inv.rename(inv.path2id(f), to_dir_id, name_tail)
868
rename(self.abspath(f), self.abspath(dest_path))
870
raise BzrError("failed to rename %r to %r: %s" %
871
(f, dest_path, e[1]),
872
["rename rolled back"])
874
# restore the inventory on error
875
self._set_inventory(orig_inv)
877
self._write_inventory(inv)
881
def rename_one(self, from_rel, to_rel):
884
This can change the directory or the filename or both.
887
if not self.has_filename(from_rel):
888
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
889
if self.has_filename(to_rel):
890
raise BzrError("can't rename: new working file %r already exists" % to_rel)
892
file_id = inv.path2id(from_rel)
894
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
897
from_parent = entry.parent_id
898
from_name = entry.name
900
if inv.path2id(to_rel):
901
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
903
to_dir, to_tail = os.path.split(to_rel)
904
to_dir_id = inv.path2id(to_dir)
905
if to_dir_id == None and to_dir != '':
906
raise BzrError("can't determine destination directory id for %r" % to_dir)
908
mutter("rename_one:")
909
mutter(" file_id {%s}" % file_id)
910
mutter(" from_rel %r" % from_rel)
911
mutter(" to_rel %r" % to_rel)
912
mutter(" to_dir %r" % to_dir)
913
mutter(" to_dir_id {%s}" % to_dir_id)
915
inv.rename(file_id, to_dir_id, to_tail)
917
from_abs = self.abspath(from_rel)
918
to_abs = self.abspath(to_rel)
920
rename(from_abs, to_abs)
922
inv.rename(file_id, from_parent, from_name)
923
raise BzrError("failed to rename %r to %r: %s"
924
% (from_abs, to_abs, e[1]),
925
["rename rolled back"])
926
self._write_inventory(inv)
930
"""Return all unknown files.
932
These are files in the working directory that are not versioned or
933
control files or ignored.
935
>>> from bzrlib.bzrdir import ScratchDir
936
>>> d = ScratchDir(files=['foo', 'foo~'])
937
>>> b = d.open_branch()
938
>>> tree = d.open_workingtree()
939
>>> map(str, tree.unknowns())
942
>>> list(b.unknowns())
944
>>> tree.remove('foo')
945
>>> list(b.unknowns())
948
for subp in self.extras():
949
if not self.is_ignored(subp):
952
@deprecated_method(zero_eight)
953
def iter_conflicts(self):
954
"""List all files in the tree that have text or content conflicts.
955
DEPRECATED. Use conflicts instead."""
956
return self._iter_conflicts()
958
def _iter_conflicts(self):
960
for info in self.list_files():
962
stem = get_conflicted_stem(path)
965
if stem not in conflicted:
970
def pull(self, source, overwrite=False, stop_revision=None):
971
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
974
pp = ProgressPhase("Pull phase", 2, top_pb)
976
old_revision_history = self.branch.revision_history()
977
basis_tree = self.basis_tree()
978
count = self.branch.pull(source, overwrite, stop_revision)
979
new_revision_history = self.branch.revision_history()
980
if new_revision_history != old_revision_history:
982
if len(old_revision_history):
983
other_revision = old_revision_history[-1]
985
other_revision = None
986
repository = self.branch.repository
987
pb = bzrlib.ui.ui_factory.nested_progress_bar()
989
merge_inner(self.branch,
990
self.branch.basis_tree(),
996
self.set_last_revision(self.branch.last_revision())
1003
"""Yield all unknown files in this WorkingTree.
1005
If there are any unknown directories then only the directory is
1006
returned, not all its children. But if there are unknown files
1007
under a versioned subdirectory, they are returned.
1009
Currently returned depth-first, sorted by name within directories.
1011
## TODO: Work from given directory downwards
1012
for path, dir_entry in self.inventory.directories():
1013
mutter("search for unknowns in %r", path)
1014
dirabs = self.abspath(path)
1015
if not isdir(dirabs):
1016
# e.g. directory deleted
1020
for subf in os.listdir(dirabs):
1022
and (subf not in dir_entry.children)):
1027
subp = pathjoin(path, subf)
1030
def _translate_ignore_rule(self, rule):
1031
"""Translate a single ignore rule to a regex.
1033
There are two types of ignore rules. Those that do not contain a / are
1034
matched against the tail of the filename (that is, they do not care
1035
what directory the file is in.) Rules which do contain a slash must
1036
match the entire path. As a special case, './' at the start of the
1037
string counts as a slash in the string but is removed before matching
1038
(e.g. ./foo.c, ./src/foo.c)
1040
:return: The translated regex.
1042
if rule[:2] in ('./', '.\\'):
1044
result = fnmatch.translate(rule[2:])
1045
elif '/' in rule or '\\' in rule:
1047
result = fnmatch.translate(rule)
1049
# default rule style.
1050
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1051
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1052
return "(" + result + ")"
1054
def _combine_ignore_rules(self, rules):
1055
"""Combine a list of ignore rules into a single regex object.
1057
Each individual rule is combined with | to form a big regex, which then
1058
has $ added to it to form something like ()|()|()$. The group index for
1059
each subregex's outermost group is placed in a dictionary mapping back
1060
to the rule. This allows quick identification of the matching rule that
1062
:return: a list of the compiled regex and the matching-group index
1063
dictionaries. We return a list because python complains if you try to
1064
combine more than 100 regexes.
1069
translated_rules = []
1071
translated_rule = self._translate_ignore_rule(rule)
1072
compiled_rule = re.compile(translated_rule)
1073
groups[next_group] = rule
1074
next_group += compiled_rule.groups
1075
translated_rules.append(translated_rule)
1076
if next_group == 99:
1077
result.append((re.compile("|".join(translated_rules)), groups))
1080
translated_rules = []
1081
if len(translated_rules):
1082
result.append((re.compile("|".join(translated_rules)), groups))
1085
def ignored_files(self):
1086
"""Yield list of PATH, IGNORE_PATTERN"""
1087
for subp in self.extras():
1088
pat = self.is_ignored(subp)
1092
def get_ignore_list(self):
1093
"""Return list of ignore patterns.
1095
Cached in the Tree object after the first call.
1097
if hasattr(self, '_ignorelist'):
1098
return self._ignorelist
1100
l = bzrlib.DEFAULT_IGNORE[:]
1101
if self.has_filename(bzrlib.IGNORE_FILENAME):
1102
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1103
l.extend([line.rstrip("\n\r").decode('utf-8')
1104
for line in f.readlines()])
1105
self._ignorelist = l
1106
self._ignore_regex = self._combine_ignore_rules(l)
1109
def _get_ignore_rules_as_regex(self):
1110
"""Return a regex of the ignore rules and a mapping dict.
1112
:return: (ignore rules compiled regex, dictionary mapping rule group
1113
indices to original rule.)
1115
if getattr(self, '_ignorelist', None) is None:
1116
self.get_ignore_list()
1117
return self._ignore_regex
1119
def is_ignored(self, filename):
1120
r"""Check whether the filename matches an ignore pattern.
1122
Patterns containing '/' or '\' need to match the whole path;
1123
others match against only the last component.
1125
If the file is ignored, returns the pattern which caused it to
1126
be ignored, otherwise None. So this can simply be used as a
1127
boolean if desired."""
1129
# TODO: Use '**' to match directories, and other extended
1130
# globbing stuff from cvs/rsync.
1132
# XXX: fnmatch is actually not quite what we want: it's only
1133
# approximately the same as real Unix fnmatch, and doesn't
1134
# treat dotfiles correctly and allows * to match /.
1135
# Eventually it should be replaced with something more
1138
rules = self._get_ignore_rules_as_regex()
1139
for regex, mapping in rules:
1140
match = regex.match(filename)
1141
if match is not None:
1142
# one or more of the groups in mapping will have a non-None group
1144
groups = match.groups()
1145
rules = [mapping[group] for group in
1146
mapping if groups[group] is not None]
1150
def kind(self, file_id):
1151
return file_kind(self.id2abspath(file_id))
1154
def last_revision(self):
1155
"""Return the last revision id of this working tree.
1157
In early branch formats this was == the branch last_revision,
1158
but that cannot be relied upon - for working tree operations,
1159
always use tree.last_revision().
1161
return self.branch.last_revision()
1163
def is_locked(self):
1164
return self._control_files.is_locked()
1166
def lock_read(self):
1167
"""See Branch.lock_read, and WorkingTree.unlock."""
1168
self.branch.lock_read()
1170
return self._control_files.lock_read()
1172
self.branch.unlock()
1175
def lock_write(self):
1176
"""See Branch.lock_write, and WorkingTree.unlock."""
1177
self.branch.lock_write()
1179
return self._control_files.lock_write()
1181
self.branch.unlock()
1184
def get_physical_lock_status(self):
1185
return self._control_files.get_physical_lock_status()
1187
def _basis_inventory_name(self):
1188
return 'basis-inventory'
1191
def set_last_revision(self, new_revision):
1192
"""Change the last revision in the working tree."""
1193
if self._change_last_revision(new_revision):
1194
self._cache_basis_inventory(new_revision)
1196
def _change_last_revision(self, new_revision):
1197
"""Template method part of set_last_revision to perform the change.
1199
This is used to allow WorkingTree3 instances to not affect branch
1200
when their last revision is set.
1202
if new_revision is None:
1203
self.branch.set_revision_history([])
1205
# current format is locked in with the branch
1206
revision_history = self.branch.revision_history()
1208
position = revision_history.index(new_revision)
1210
raise errors.NoSuchRevision(self.branch, new_revision)
1211
self.branch.set_revision_history(revision_history[:position + 1])
1214
def _cache_basis_inventory(self, new_revision):
1215
"""Cache new_revision as the basis inventory."""
1216
# TODO: this should allow the ready-to-use inventory to be passed in,
1217
# as commit already has that ready-to-use [while the format is the
1220
# this double handles the inventory - unpack and repack -
1221
# but is easier to understand. We can/should put a conditional
1222
# in here based on whether the inventory is in the latest format
1223
# - perhaps we should repack all inventories on a repository
1225
# the fast path is to copy the raw xml from the repository. If the
1226
# xml contains 'revision_id="', then we assume the right
1227
# revision_id is set. We must check for this full string, because a
1228
# root node id can legitimately look like 'revision_id' but cannot
1230
xml = self.branch.repository.get_inventory_xml(new_revision)
1231
if not 'revision_id="' in xml.split('\n', 1)[0]:
1232
inv = self.branch.repository.deserialise_inventory(
1234
inv.revision_id = new_revision
1235
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1236
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1237
path = self._basis_inventory_name()
1239
self._control_files.put(path, sio)
1240
except WeaveRevisionNotPresent:
1243
def read_basis_inventory(self):
1244
"""Read the cached basis inventory."""
1245
path = self._basis_inventory_name()
1246
return self._control_files.get(path).read()
1249
def read_working_inventory(self):
1250
"""Read the working inventory."""
1251
# ElementTree does its own conversion from UTF-8, so open in
1253
result = bzrlib.xml5.serializer_v5.read_inventory(
1254
self._control_files.get('inventory'))
1255
self._set_inventory(result)
1259
def remove(self, files, verbose=False, to_file=None):
1260
"""Remove nominated files from the working inventory..
1262
This does not remove their text. This does not run on XXX on what? RBC
1264
TODO: Refuse to remove modified files unless --force is given?
1266
TODO: Do something useful with directories.
1268
TODO: Should this remove the text or not? Tough call; not
1269
removing may be useful and the user can just use use rm, and
1270
is the opposite of add. Removing it is consistent with most
1271
other tools. Maybe an option.
1273
## TODO: Normalize names
1274
## TODO: Remove nested loops; better scalability
1275
if isinstance(files, basestring):
1278
inv = self.inventory
1280
# do this before any modifications
1282
fid = inv.path2id(f)
1284
# TODO: Perhaps make this just a warning, and continue?
1285
# This tends to happen when
1286
raise NotVersionedError(path=f)
1287
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1289
# having remove it, it must be either ignored or unknown
1290
if self.is_ignored(f):
1294
show_status(new_status, inv[fid].kind, quotefn(f), to_file=to_file)
1297
self._write_inventory(inv)
1300
def revert(self, filenames, old_tree=None, backups=True,
1301
pb=DummyProgress()):
1302
from transform import revert
1303
from conflicts import resolve
1304
if old_tree is None:
1305
old_tree = self.basis_tree()
1306
conflicts = revert(self, old_tree, filenames, backups, pb)
1307
if not len(filenames):
1308
self.set_pending_merges([])
1311
resolve(self, filenames, ignore_misses=True)
1314
# XXX: This method should be deprecated in favour of taking in a proper
1315
# new Inventory object.
1317
def set_inventory(self, new_inventory_list):
1318
from bzrlib.inventory import (Inventory,
1323
inv = Inventory(self.get_root_id())
1324
for path, file_id, parent, kind in new_inventory_list:
1325
name = os.path.basename(path)
1328
# fixme, there should be a factory function inv,add_??
1329
if kind == 'directory':
1330
inv.add(InventoryDirectory(file_id, name, parent))
1331
elif kind == 'file':
1332
inv.add(InventoryFile(file_id, name, parent))
1333
elif kind == 'symlink':
1334
inv.add(InventoryLink(file_id, name, parent))
1336
raise BzrError("unknown kind %r" % kind)
1337
self._write_inventory(inv)
1340
def set_root_id(self, file_id):
1341
"""Set the root id for this tree."""
1342
inv = self.read_working_inventory()
1343
orig_root_id = inv.root.file_id
1344
del inv._byid[inv.root.file_id]
1345
inv.root.file_id = file_id
1346
inv._byid[inv.root.file_id] = inv.root
1349
if entry.parent_id == orig_root_id:
1350
entry.parent_id = inv.root.file_id
1351
self._write_inventory(inv)
1354
"""See Branch.unlock.
1356
WorkingTree locking just uses the Branch locking facilities.
1357
This is current because all working trees have an embedded branch
1358
within them. IF in the future, we were to make branch data shareable
1359
between multiple working trees, i.e. via shared storage, then we
1360
would probably want to lock both the local tree, and the branch.
1362
# FIXME: We want to write out the hashcache only when the last lock on
1363
# this working copy is released. Peeking at the lock count is a bit
1364
# of a nasty hack; probably it's better to have a transaction object,
1365
# which can do some finalization when it's either successfully or
1366
# unsuccessfully completed. (Denys's original patch did that.)
1367
# RBC 20060206 hooking into transaction will couple lock and transaction
1368
# wrongly. Hooking into unlock on the control files object is fine though.
1370
# TODO: split this per format so there is no ugly if block
1371
if self._hashcache.needs_write and (
1372
# dedicated lock files
1373
self._control_files._lock_count==1 or
1375
(self._control_files is self.branch.control_files and
1376
self._control_files._lock_count==3)):
1377
self._hashcache.write()
1378
# reverse order of locking.
1380
return self._control_files.unlock()
1382
self.branch.unlock()
1386
"""Update a working tree along its branch.
1388
This will update the branch if its bound too, which means we have multiple trees involved:
1389
The new basis tree of the master.
1390
The old basis tree of the branch.
1391
The old basis tree of the working tree.
1392
The current working tree state.
1393
pathologically all three may be different, and non ancestors of each other.
1394
Conceptually we want to:
1395
Preserve the wt.basis->wt.state changes
1396
Transform the wt.basis to the new master basis.
1397
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1398
Restore the wt.basis->wt.state changes.
1400
There isn't a single operation at the moment to do that, so we:
1401
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1402
Do a 'normal' merge of the old branch basis if it is relevant.
1404
old_tip = self.branch.update()
1405
if old_tip is not None:
1406
self.add_pending_merge(old_tip)
1407
self.branch.lock_read()
1410
if self.last_revision() != self.branch.last_revision():
1411
# merge tree state up to new branch tip.
1412
basis = self.basis_tree()
1413
to_tree = self.branch.basis_tree()
1414
result += merge_inner(self.branch,
1418
self.set_last_revision(self.branch.last_revision())
1419
if old_tip and old_tip != self.last_revision():
1420
# our last revision was not the prior branch last revision
1421
# and we have converted that last revision to a pending merge.
1422
# base is somewhere between the branch tip now
1423
# and the now pending merge
1424
from bzrlib.revision import common_ancestor
1426
base_rev_id = common_ancestor(self.branch.last_revision(),
1428
self.branch.repository)
1429
except errors.NoCommonAncestor:
1431
base_tree = self.branch.repository.revision_tree(base_rev_id)
1432
other_tree = self.branch.repository.revision_tree(old_tip)
1433
result += merge_inner(self.branch,
1439
self.branch.unlock()
1442
def _write_inventory(self, inv):
1443
"""Write inventory as the current inventory."""
1445
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1447
self._control_files.put('inventory', sio)
1448
self._set_inventory(inv)
1449
mutter('wrote working inventory')
1451
def set_conflicts(self, arg):
1452
raise UnsupportedOperation(self.set_conflicts, self)
1455
def conflicts(self):
1456
conflicts = ConflictList()
1457
for conflicted in self._iter_conflicts():
1460
if file_kind(self.abspath(conflicted)) != "file":
1462
except errors.NoSuchFile:
1465
for suffix in ('.THIS', '.OTHER'):
1467
kind = file_kind(self.abspath(conflicted+suffix))
1470
except errors.NoSuchFile:
1474
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1475
conflicts.append(Conflict.factory(ctype, path=conflicted,
1476
file_id=self.path2id(conflicted)))
1480
class WorkingTree3(WorkingTree):
1481
"""This is the Format 3 working tree.
1483
This differs from the base WorkingTree by:
1484
- having its own file lock
1485
- having its own last-revision property.
1487
This is new in bzr 0.8
1491
def last_revision(self):
1492
"""See WorkingTree.last_revision."""
1494
return self._control_files.get_utf8('last-revision').read()
1498
def _change_last_revision(self, revision_id):
1499
"""See WorkingTree._change_last_revision."""
1500
if revision_id is None or revision_id == NULL_REVISION:
1502
self._control_files._transport.delete('last-revision')
1503
except errors.NoSuchFile:
1508
self.branch.revision_history().index(revision_id)
1510
raise errors.NoSuchRevision(self.branch, revision_id)
1511
self._control_files.put_utf8('last-revision', revision_id)
1515
def set_conflicts(self, conflicts):
1516
self._put_rio('conflicts', conflicts.to_stanzas(),
1520
def conflicts(self):
1522
confile = self._control_files.get('conflicts')
1524
return ConflictList()
1526
if confile.next() != CONFLICT_HEADER_1 + '\n':
1527
raise ConflictFormatError()
1528
except StopIteration:
1529
raise ConflictFormatError()
1530
return ConflictList.from_stanzas(RioReader(confile))
1533
def get_conflicted_stem(path):
1534
for suffix in CONFLICT_SUFFIXES:
1535
if path.endswith(suffix):
1536
return path[:-len(suffix)]
1538
@deprecated_function(zero_eight)
1539
def is_control_file(filename):
1540
"""See WorkingTree.is_control_filename(filename)."""
1541
## FIXME: better check
1542
filename = normpath(filename)
1543
while filename != '':
1544
head, tail = os.path.split(filename)
1545
## mutter('check %r for control file' % ((head, tail),))
1548
if filename == head:
1554
class WorkingTreeFormat(object):
1555
"""An encapsulation of the initialization and open routines for a format.
1557
Formats provide three things:
1558
* An initialization routine,
1562
Formats are placed in an dict by their format string for reference
1563
during workingtree opening. Its not required that these be instances, they
1564
can be classes themselves with class methods - it simply depends on
1565
whether state is needed for a given format or not.
1567
Once a format is deprecated, just deprecate the initialize and open
1568
methods on the format class. Do not deprecate the object, as the
1569
object will be created every time regardless.
1572
_default_format = None
1573
"""The default format used for new trees."""
1576
"""The known formats."""
1579
def find_format(klass, a_bzrdir):
1580
"""Return the format for the working tree object in a_bzrdir."""
1582
transport = a_bzrdir.get_workingtree_transport(None)
1583
format_string = transport.get("format").read()
1584
return klass._formats[format_string]
1586
raise errors.NoWorkingTree(base=transport.base)
1588
raise errors.UnknownFormatError(format=format_string)
1591
def get_default_format(klass):
1592
"""Return the current default format."""
1593
return klass._default_format
1595
def get_format_string(self):
1596
"""Return the ASCII format string that identifies this format."""
1597
raise NotImplementedError(self.get_format_string)
1599
def get_format_description(self):
1600
"""Return the short description for this format."""
1601
raise NotImplementedError(self.get_format_description)
1603
def is_supported(self):
1604
"""Is this format supported?
1606
Supported formats can be initialized and opened.
1607
Unsupported formats may not support initialization or committing or
1608
some other features depending on the reason for not being supported.
1613
def register_format(klass, format):
1614
klass._formats[format.get_format_string()] = format
1617
def set_default_format(klass, format):
1618
klass._default_format = format
1621
def unregister_format(klass, format):
1622
assert klass._formats[format.get_format_string()] is format
1623
del klass._formats[format.get_format_string()]
1627
class WorkingTreeFormat2(WorkingTreeFormat):
1628
"""The second working tree format.
1630
This format modified the hash cache from the format 1 hash cache.
1633
def get_format_description(self):
1634
"""See WorkingTreeFormat.get_format_description()."""
1635
return "Working tree format 2"
1637
def stub_initialize_remote(self, control_files):
1638
"""As a special workaround create critical control files for a remote working tree
1640
This ensures that it can later be updated and dealt with locally,
1641
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1642
no working tree. (See bug #43064).
1646
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1648
control_files.put('inventory', sio)
1650
control_files.put_utf8('pending-merges', '')
1653
def initialize(self, a_bzrdir, revision_id=None):
1654
"""See WorkingTreeFormat.initialize()."""
1655
if not isinstance(a_bzrdir.transport, LocalTransport):
1656
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1657
branch = a_bzrdir.open_branch()
1658
if revision_id is not None:
1661
revision_history = branch.revision_history()
1663
position = revision_history.index(revision_id)
1665
raise errors.NoSuchRevision(branch, revision_id)
1666
branch.set_revision_history(revision_history[:position + 1])
1669
revision = branch.last_revision()
1671
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1677
wt._write_inventory(inv)
1678
wt.set_root_id(inv.root.file_id)
1679
wt.set_last_revision(revision)
1680
wt.set_pending_merges([])
1681
build_tree(wt.basis_tree(), wt)
1685
super(WorkingTreeFormat2, self).__init__()
1686
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1688
def open(self, a_bzrdir, _found=False):
1689
"""Return the WorkingTree object for a_bzrdir
1691
_found is a private parameter, do not use it. It is used to indicate
1692
if format probing has already been done.
1695
# we are being called directly and must probe.
1696
raise NotImplementedError
1697
if not isinstance(a_bzrdir.transport, LocalTransport):
1698
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1699
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1705
class WorkingTreeFormat3(WorkingTreeFormat):
1706
"""The second working tree format updated to record a format marker.
1709
- exists within a metadir controlling .bzr
1710
- includes an explicit version marker for the workingtree control
1711
files, separate from the BzrDir format
1712
- modifies the hash cache format
1714
- uses a LockDir to guard access to the repository
1717
def get_format_string(self):
1718
"""See WorkingTreeFormat.get_format_string()."""
1719
return "Bazaar-NG Working Tree format 3"
1721
def get_format_description(self):
1722
"""See WorkingTreeFormat.get_format_description()."""
1723
return "Working tree format 3"
1725
_lock_file_name = 'lock'
1726
_lock_class = LockDir
1728
def _open_control_files(self, a_bzrdir):
1729
transport = a_bzrdir.get_workingtree_transport(None)
1730
return LockableFiles(transport, self._lock_file_name,
1733
def initialize(self, a_bzrdir, revision_id=None):
1734
"""See WorkingTreeFormat.initialize().
1736
revision_id allows creating a working tree at a different
1737
revision than the branch is at.
1739
if not isinstance(a_bzrdir.transport, LocalTransport):
1740
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1741
transport = a_bzrdir.get_workingtree_transport(self)
1742
control_files = self._open_control_files(a_bzrdir)
1743
control_files.create_lock()
1744
control_files.lock_write()
1745
control_files.put_utf8('format', self.get_format_string())
1746
branch = a_bzrdir.open_branch()
1747
if revision_id is None:
1748
revision_id = branch.last_revision()
1750
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1756
_control_files=control_files)
1759
wt._write_inventory(inv)
1760
wt.set_root_id(inv.root.file_id)
1761
wt.set_last_revision(revision_id)
1762
wt.set_pending_merges([])
1763
build_tree(wt.basis_tree(), wt)
1766
control_files.unlock()
1770
super(WorkingTreeFormat3, self).__init__()
1771
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1773
def open(self, a_bzrdir, _found=False):
1774
"""Return the WorkingTree object for a_bzrdir
1776
_found is a private parameter, do not use it. It is used to indicate
1777
if format probing has already been done.
1780
# we are being called directly and must probe.
1781
raise NotImplementedError
1782
if not isinstance(a_bzrdir.transport, LocalTransport):
1783
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1784
control_files = self._open_control_files(a_bzrdir)
1785
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1789
_control_files=control_files)
1792
return self.get_format_string()
1795
# formats which have no format string are not discoverable
1796
# and not independently creatable, so are not registered.
1797
__default_format = WorkingTreeFormat3()
1798
WorkingTreeFormat.register_format(__default_format)
1799
WorkingTreeFormat.set_default_format(__default_format)
1800
_legacy_formats = [WorkingTreeFormat2(),
1804
class WorkingTreeTestProviderAdapter(object):
1805
"""A tool to generate a suite testing multiple workingtree formats at once.
1807
This is done by copying the test once for each transport and injecting
1808
the transport_server, transport_readonly_server, and workingtree_format
1809
classes into each copy. Each copy is also given a new id() to make it
1813
def __init__(self, transport_server, transport_readonly_server, formats):
1814
self._transport_server = transport_server
1815
self._transport_readonly_server = transport_readonly_server
1816
self._formats = formats
1818
def adapt(self, test):
1819
from bzrlib.tests import TestSuite
1820
result = TestSuite()
1821
for workingtree_format, bzrdir_format in self._formats:
1822
new_test = deepcopy(test)
1823
new_test.transport_server = self._transport_server
1824
new_test.transport_readonly_server = self._transport_readonly_server
1825
new_test.bzrdir_format = bzrdir_format
1826
new_test.workingtree_format = workingtree_format
1827
def make_new_test_id():
1828
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1829
return lambda: new_id
1830
new_test.id = make_new_test_id()
1831
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
