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
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
57
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
59
from bzrlib.errors import (BzrCheckError,
62
WeaveRevisionNotPresent,
66
MergeModifiedFormatError,
69
from bzrlib.inventory import InventoryEntry, Inventory
70
from bzrlib.lockable_files import LockableFiles, TransportLock
71
from bzrlib.lockdir import LockDir
72
from bzrlib.merge import merge_inner, transform_tree
73
from bzrlib.osutils import (
90
from bzrlib.progress import DummyProgress, ProgressPhase
91
from bzrlib.revision import NULL_REVISION
92
from bzrlib.rio import RioReader, rio_file, Stanza
93
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.textui import show_status
102
from bzrlib.transform import build_tree
103
from bzrlib.trace import mutter, note
104
from bzrlib.transport import get_transport
105
from bzrlib.transport.local import LocalTransport
110
# the regex here does the following:
111
# 1) remove any weird characters; we don't escape them but rather
113
# 2) match leading '.'s to make it not hidden
114
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
115
_gen_id_suffix = None
119
def _next_id_suffix():
120
"""Create a new file id suffix that is reasonably unique.
122
On the first call we combine the current time with 64 bits of randomness
123
to give a highly probably globally unique number. Then each call in the same
124
process adds 1 to a serial number we append to that unique value.
126
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
127
# than having to move the id randomness out of the inner loop like this.
128
# XXX TODO: for the global randomness this uses we should add the thread-id
129
# before the serial #.
130
global _gen_id_suffix, _gen_id_serial
131
if _gen_id_suffix is None:
132
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
134
return _gen_id_suffix + str(_gen_id_serial)
137
def gen_file_id(name):
138
"""Return new file id for the basename 'name'.
140
The uniqueness is supplied from _next_id_suffix.
142
# XXX TODO: squash the filename to lowercase.
143
# XXX TODO: truncate the filename to something like 20 or 30 chars.
144
# XXX TODO: consider what to do with ids that look like illegal filepaths
145
# on platforms we support.
146
return _gen_file_id_re.sub('', name) + _next_id_suffix()
150
"""Return a new tree-root file id."""
151
return gen_file_id('TREE_ROOT')
154
class TreeEntry(object):
155
"""An entry that implements the minimum interface used by commands.
157
This needs further inspection, it may be better to have
158
InventoryEntries without ids - though that seems wrong. For now,
159
this is a parallel hierarchy to InventoryEntry, and needs to become
160
one of several things: decorates to that hierarchy, children of, or
162
Another note is that these objects are currently only used when there is
163
no InventoryEntry available - i.e. for unversioned objects.
164
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
167
def __eq__(self, other):
168
# yes, this us ugly, TODO: best practice __eq__ style.
169
return (isinstance(other, TreeEntry)
170
and other.__class__ == self.__class__)
172
def kind_character(self):
176
class TreeDirectory(TreeEntry):
177
"""See TreeEntry. This is a directory in a working tree."""
179
def __eq__(self, other):
180
return (isinstance(other, TreeDirectory)
181
and other.__class__ == self.__class__)
183
def kind_character(self):
187
class TreeFile(TreeEntry):
188
"""See TreeEntry. This is a regular file in a working tree."""
190
def __eq__(self, other):
191
return (isinstance(other, TreeFile)
192
and other.__class__ == self.__class__)
194
def kind_character(self):
198
class TreeLink(TreeEntry):
199
"""See TreeEntry. This is a symlink in a working tree."""
201
def __eq__(self, other):
202
return (isinstance(other, TreeLink)
203
and other.__class__ == self.__class__)
205
def kind_character(self):
209
class WorkingTree(bzrlib.tree.Tree):
210
"""Working copy tree.
212
The inventory is held in the `Branch` working-inventory, and the
213
files are in a directory on disk.
215
It is possible for a `WorkingTree` to have a filename which is
216
not listed in the Inventory and vice versa.
219
def __init__(self, basedir='.',
220
branch=DEPRECATED_PARAMETER,
226
"""Construct a WorkingTree for basedir.
228
If the branch is not supplied, it is opened automatically.
229
If the branch is supplied, it must be the branch for this basedir.
230
(branch.base is not cross checked, because for remote branches that
231
would be meaningless).
233
self._format = _format
234
self.bzrdir = _bzrdir
236
# not created via open etc.
237
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
238
"Please use bzrdir.open_workingtree or WorkingTree.open().",
241
wt = WorkingTree.open(basedir)
242
self._branch = wt.branch
243
self.basedir = wt.basedir
244
self._control_files = wt._control_files
245
self._hashcache = wt._hashcache
246
self._set_inventory(wt._inventory)
247
self._format = wt._format
248
self.bzrdir = wt.bzrdir
249
from bzrlib.hashcache import HashCache
250
from bzrlib.trace import note, mutter
251
assert isinstance(basedir, basestring), \
252
"base directory %r is not a string" % basedir
253
basedir = safe_unicode(basedir)
254
mutter("opening working tree %r", basedir)
255
if deprecated_passed(branch):
257
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
258
" Please use bzrdir.open_workingtree() or"
259
" WorkingTree.open().",
263
self._branch = branch
265
self._branch = self.bzrdir.open_branch()
266
self.basedir = realpath(basedir)
267
# if branch is at our basedir and is a format 6 or less
268
if isinstance(self._format, WorkingTreeFormat2):
269
# share control object
270
self._control_files = self.branch.control_files
272
# only ready for format 3
273
assert isinstance(self._format, WorkingTreeFormat3)
274
assert isinstance(_control_files, LockableFiles), \
275
"_control_files must be a LockableFiles, not %r" \
277
self._control_files = _control_files
278
# update the whole cache up front and write to disk if anything changed;
279
# in the future we might want to do this more selectively
280
# two possible ways offer themselves : in self._unlock, write the cache
281
# if needed, or, when the cache sees a change, append it to the hash
282
# cache file, and have the parser take the most recent entry for a
284
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
285
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
287
# is this scan needed ? it makes things kinda slow.
294
if _inventory is None:
295
self._set_inventory(self.read_working_inventory())
297
self._set_inventory(_inventory)
300
fget=lambda self: self._branch,
301
doc="""The branch this WorkingTree is connected to.
303
This cannot be set - it is reflective of the actual disk structure
304
the working tree has been constructed from.
307
def break_lock(self):
308
"""Break a lock if one is present from another instance.
310
Uses the ui factory to ask for confirmation if the lock may be from
313
This will probe the repository for its lock as well.
315
self._control_files.break_lock()
316
self.branch.break_lock()
318
def _set_inventory(self, inv):
319
self._inventory = inv
320
self.path2id = self._inventory.path2id
322
def is_control_filename(self, filename):
323
"""True if filename is the name of a control file in this tree.
325
:param filename: A filename within the tree. This is a relative path
326
from the root of this tree.
328
This is true IF and ONLY IF the filename is part of the meta data
329
that bzr controls in this tree. I.E. a random .bzr directory placed
330
on disk will not be a control file for this tree.
332
return self.bzrdir.is_control_filename(filename)
335
def open(path=None, _unsupported=False):
336
"""Open an existing working tree at path.
340
path = os.path.getcwdu()
341
control = bzrdir.BzrDir.open(path, _unsupported)
342
return control.open_workingtree(_unsupported)
345
def open_containing(path=None):
346
"""Open an existing working tree which has its root about path.
348
This probes for a working tree at path and searches upwards from there.
350
Basically we keep looking up until we find the control directory or
351
run into /. If there isn't one, raises NotBranchError.
352
TODO: give this a new exception.
353
If there is one, it is returned, along with the unused portion of path.
355
:return: The WorkingTree that contains 'path', and the rest of path
358
path = osutils.getcwd()
359
control, relpath = bzrdir.BzrDir.open_containing(path)
361
return control.open_workingtree(), relpath
364
def open_downlevel(path=None):
365
"""Open an unsupported working tree.
367
Only intended for advanced situations like upgrading part of a bzrdir.
369
return WorkingTree.open(path, _unsupported=True)
372
"""Iterate through file_ids for this tree.
374
file_ids are in a WorkingTree if they are in the working inventory
375
and the working file exists.
377
inv = self._inventory
378
for path, ie in inv.iter_entries():
379
if osutils.lexists(self.abspath(path)):
383
return "<%s of %s>" % (self.__class__.__name__,
384
getattr(self, 'basedir', None))
386
def abspath(self, filename):
387
return pathjoin(self.basedir, filename)
389
def basis_tree(self):
390
"""Return RevisionTree for the current last revision."""
391
revision_id = self.last_revision()
392
if revision_id is not None:
394
xml = self.read_basis_inventory()
395
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
398
if inv is not None and inv.revision_id == revision_id:
399
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
401
# FIXME? RBC 20060403 should we cache the inventory here ?
402
return self.branch.repository.revision_tree(revision_id)
405
@deprecated_method(zero_eight)
406
def create(branch, directory):
407
"""Create a workingtree for branch at directory.
409
If existing_directory already exists it must have a .bzr directory.
410
If it does not exist, it will be created.
412
This returns a new WorkingTree object for the new checkout.
414
TODO FIXME RBC 20060124 when we have checkout formats in place this
415
should accept an optional revisionid to checkout [and reject this if
416
checking out into the same dir as a pre-checkout-aware branch format.]
418
XXX: When BzrDir is present, these should be created through that
421
warnings.warn('delete WorkingTree.create', stacklevel=3)
422
transport = get_transport(directory)
423
if branch.bzrdir.root_transport.base == transport.base:
425
return branch.bzrdir.create_workingtree()
426
# different directory,
427
# create a branch reference
428
# and now a working tree.
429
raise NotImplementedError
432
@deprecated_method(zero_eight)
433
def create_standalone(directory):
434
"""Create a checkout and a branch and a repo at directory.
436
Directory must exist and be empty.
438
please use BzrDir.create_standalone_workingtree
440
return bzrdir.BzrDir.create_standalone_workingtree(directory)
442
def relpath(self, path):
443
"""Return the local path portion from a given path.
445
The path may be absolute or relative. If its a relative path it is
446
interpreted relative to the python current working directory.
448
return relpath(self.basedir, path)
450
def has_filename(self, filename):
451
return osutils.lexists(self.abspath(filename))
453
def get_file(self, file_id):
454
return self.get_file_byname(self.id2path(file_id))
456
def get_file_byname(self, filename):
457
return file(self.abspath(filename), 'rb')
459
def get_parent_ids(self):
460
"""See Tree.get_parent_ids.
462
This implementation reads the pending merges list and last_revision
463
value and uses that to decide what the parents list should be.
465
last_rev = self.last_revision()
470
other_parents = self.pending_merges()
471
return parents + other_parents
473
def get_root_id(self):
474
"""Return the id of this trees root"""
475
inv = self.read_working_inventory()
476
return inv.root.file_id
478
def _get_store_filename(self, file_id):
479
## XXX: badly named; this is not in the store at all
480
return self.abspath(self.id2path(file_id))
483
def clone(self, to_bzrdir, revision_id=None, basis=None):
484
"""Duplicate this working tree into to_bzr, including all state.
486
Specifically modified files are kept as modified, but
487
ignored and unknown files are discarded.
489
If you want to make a new line of development, see bzrdir.sprout()
492
If not None, the cloned tree will have its last revision set to
493
revision, and and difference between the source trees last revision
494
and this one merged in.
497
If not None, a closer copy of a tree which may have some files in
498
common, and which file content should be preferentially copied from.
500
# assumes the target bzr dir format is compatible.
501
result = self._format.initialize(to_bzrdir)
502
self.copy_content_into(result, revision_id)
506
def copy_content_into(self, tree, revision_id=None):
507
"""Copy the current content and user files of this tree into tree."""
508
if revision_id is None:
509
transform_tree(tree, self)
511
# TODO now merge from tree.last_revision to revision
512
transform_tree(tree, self)
513
tree.set_last_revision(revision_id)
516
def commit(self, message=None, revprops=None, *args, **kwargs):
517
# avoid circular imports
518
from bzrlib.commit import Commit
521
if not 'branch-nick' in revprops:
522
revprops['branch-nick'] = self.branch.nick
523
# args for wt.commit start at message from the Commit.commit method,
524
# but with branch a kwarg now, passing in args as is results in the
525
#message being used for the branch
526
args = (DEPRECATED_PARAMETER, message, ) + args
527
committed_id = Commit().commit( working_tree=self, revprops=revprops,
529
self._set_inventory(self.read_working_inventory())
532
def id2abspath(self, file_id):
533
return self.abspath(self.id2path(file_id))
535
def has_id(self, file_id):
536
# files that have been deleted are excluded
537
inv = self._inventory
538
if not inv.has_id(file_id):
540
path = inv.id2path(file_id)
541
return osutils.lexists(self.abspath(path))
543
def has_or_had_id(self, file_id):
544
if file_id == self.inventory.root.file_id:
546
return self.inventory.has_id(file_id)
548
__contains__ = has_id
550
def get_file_size(self, file_id):
551
return os.path.getsize(self.id2abspath(file_id))
554
def get_file_sha1(self, file_id, path=None):
556
path = self._inventory.id2path(file_id)
557
return self._hashcache.get_sha1(path)
559
def get_file_mtime(self, file_id, path=None):
561
path = self._inventory.id2path(file_id)
562
return os.lstat(self.abspath(path)).st_mtime
564
if not supports_executable():
565
def is_executable(self, file_id, path=None):
566
return self._inventory[file_id].executable
568
def is_executable(self, file_id, path=None):
570
path = self._inventory.id2path(file_id)
571
mode = os.lstat(self.abspath(path)).st_mode
572
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
575
def add(self, files, ids=None):
576
"""Make files versioned.
578
Note that the command line normally calls smart_add instead,
579
which can automatically recurse.
581
This adds the files to the inventory, so that they will be
582
recorded by the next commit.
585
List of paths to add, relative to the base of the tree.
588
If set, use these instead of automatically generated ids.
589
Must be the same length as the list of files, but may
590
contain None for ids that are to be autogenerated.
592
TODO: Perhaps have an option to add the ids even if the files do
595
TODO: Perhaps callback with the ids and paths as they're added.
597
# TODO: Re-adding a file that is removed in the working copy
598
# should probably put it back with the previous ID.
599
if isinstance(files, basestring):
600
assert(ids is None or isinstance(ids, basestring))
606
ids = [None] * len(files)
608
assert(len(ids) == len(files))
610
inv = self.read_working_inventory()
611
for f,file_id in zip(files, ids):
612
if self.is_control_filename(f):
613
raise errors.ForbiddenControlFileError(filename=f)
618
raise BzrError("cannot add top-level %r" % f)
620
fullpath = normpath(self.abspath(f))
622
kind = file_kind(fullpath)
624
if e.errno == errno.ENOENT:
625
raise NoSuchFile(fullpath)
626
if not InventoryEntry.versionable_kind(kind):
627
raise errors.BadFileKindError(filename=f, kind=kind)
629
inv.add_path(f, kind=kind)
631
inv.add_path(f, kind=kind, file_id=file_id)
633
self._write_inventory(inv)
636
def add_pending_merge(self, *revision_ids):
637
# TODO: Perhaps should check at this point that the
638
# history of the revision is actually present?
639
p = self.pending_merges()
641
for rev_id in revision_ids:
647
self.set_pending_merges(p)
650
def pending_merges(self):
651
"""Return a list of pending merges.
653
These are revisions that have been merged into the working
654
directory but not yet committed.
657
merges_file = self._control_files.get_utf8('pending-merges')
661
for l in merges_file.readlines():
662
p.append(l.rstrip('\n'))
666
def set_pending_merges(self, rev_list):
667
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
670
def set_merge_modified(self, modified_hashes):
672
for file_id, hash in modified_hashes.iteritems():
673
yield Stanza(file_id=file_id, hash=hash)
674
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
677
def _put_rio(self, filename, stanzas, header):
678
my_file = rio_file(stanzas, header)
679
self._control_files.put(filename, my_file)
682
def merge_modified(self):
684
hashfile = self._control_files.get('merge-hashes')
689
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
690
raise MergeModifiedFormatError()
691
except StopIteration:
692
raise MergeModifiedFormatError()
693
for s in RioReader(hashfile):
694
file_id = s.get("file_id")
695
if file_id not in self.inventory:
698
if hash == self.get_file_sha1(file_id):
699
merge_hashes[file_id] = hash
702
def get_symlink_target(self, file_id):
703
return os.readlink(self.id2abspath(file_id))
705
def file_class(self, filename):
706
if self.path2id(filename):
708
elif self.is_ignored(filename):
713
def list_files(self):
714
"""Recursively list all files as (path, class, kind, id, entry).
716
Lists, but does not descend into unversioned directories.
718
This does not include files that have been deleted in this
721
Skips the control directory.
723
inv = self._inventory
724
# Convert these into local objects to save lookup times
725
pathjoin = osutils.pathjoin
726
file_kind = osutils.file_kind
728
# transport.base ends in a slash, we want the piece
729
# between the last two slashes
730
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
732
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
734
# directory file_id, relative path, absolute path, reverse sorted children
735
children = os.listdir(self.basedir)
737
# jam 20060527 The kernel sized tree seems equivalent whether we
738
# use a deque and popleft to keep them sorted, or if we use a plain
739
# list and just reverse() them.
740
children = collections.deque(children)
741
stack = [(inv.root.file_id, u'', self.basedir, children)]
743
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
746
f = children.popleft()
747
## TODO: If we find a subdirectory with its own .bzr
748
## directory, then that is a separate tree and we
749
## should exclude it.
751
# the bzrdir for this tree
752
if transport_base_dir == f:
755
# we know that from_dir_relpath and from_dir_abspath never end in a slash
756
# and 'f' doesn't begin with one, we can do a string op, rather
757
# than the checks of pathjoin(), all relative paths will have an extra slash
759
fp = from_dir_relpath + '/' + f
762
fap = from_dir_abspath + '/' + f
764
f_ie = inv.get_child(from_dir_id, f)
767
elif self.is_ignored(fp[1:]):
770
# we may not have found this file, because of a unicode issue
771
f_norm, can_access = osutils.normalized_filename(f)
772
if f == f_norm or not can_access:
773
# No change, so treat this file normally
776
# this file can be accessed by a normalized path
777
# check again if it is versioned
778
# these lines are repeated here for performance
780
fp = from_dir_relpath + '/' + f
781
fap = from_dir_abspath + '/' + f
782
f_ie = inv.get_child(from_dir_id, f)
785
elif self.is_ignored(fp[1:]):
794
raise BzrCheckError("file %r entered as kind %r id %r, "
796
% (fap, f_ie.kind, f_ie.file_id, fk))
798
# make a last minute entry
800
yield fp[1:], c, fk, f_ie.file_id, f_ie
803
yield fp[1:], c, fk, None, fk_entries[fk]()
805
yield fp[1:], c, fk, None, TreeEntry()
808
if fk != 'directory':
811
# But do this child first
812
new_children = os.listdir(fap)
814
new_children = collections.deque(new_children)
815
stack.append((f_ie.file_id, fp, fap, new_children))
816
# Break out of inner loop, so that we start outer loop with child
819
# if we finished all children, pop it off the stack
824
def move(self, from_paths, to_name):
827
to_name must exist in the inventory.
829
If to_name exists and is a directory, the files are moved into
830
it, keeping their old names.
832
Note that to_name is only the last component of the new name;
833
this doesn't change the directory.
835
This returns a list of (from_path, to_path) pairs for each
839
## TODO: Option to move IDs only
840
assert not isinstance(from_paths, basestring)
842
to_abs = self.abspath(to_name)
843
if not isdir(to_abs):
844
raise BzrError("destination %r is not a directory" % to_abs)
845
if not self.has_filename(to_name):
846
raise BzrError("destination %r not in working directory" % to_abs)
847
to_dir_id = inv.path2id(to_name)
848
if to_dir_id == None and to_name != '':
849
raise BzrError("destination %r is not a versioned directory" % to_name)
850
to_dir_ie = inv[to_dir_id]
851
if to_dir_ie.kind not in ('directory', 'root_directory'):
852
raise BzrError("destination %r is not a directory" % to_abs)
854
to_idpath = inv.get_idpath(to_dir_id)
857
if not self.has_filename(f):
858
raise BzrError("%r does not exist in working tree" % f)
859
f_id = inv.path2id(f)
861
raise BzrError("%r is not versioned" % f)
862
name_tail = splitpath(f)[-1]
863
dest_path = pathjoin(to_name, name_tail)
864
if self.has_filename(dest_path):
865
raise BzrError("destination %r already exists" % dest_path)
866
if f_id in to_idpath:
867
raise BzrError("can't move %r to a subdirectory of itself" % f)
869
# OK, so there's a race here, it's possible that someone will
870
# create a file in this interval and then the rename might be
871
# left half-done. But we should have caught most problems.
872
orig_inv = deepcopy(self.inventory)
875
name_tail = splitpath(f)[-1]
876
dest_path = pathjoin(to_name, name_tail)
877
result.append((f, dest_path))
878
inv.rename(inv.path2id(f), to_dir_id, name_tail)
880
rename(self.abspath(f), self.abspath(dest_path))
882
raise BzrError("failed to rename %r to %r: %s" %
883
(f, dest_path, e[1]),
884
["rename rolled back"])
886
# restore the inventory on error
887
self._set_inventory(orig_inv)
889
self._write_inventory(inv)
893
def rename_one(self, from_rel, to_rel):
896
This can change the directory or the filename or both.
899
if not self.has_filename(from_rel):
900
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
901
if self.has_filename(to_rel):
902
raise BzrError("can't rename: new working file %r already exists" % to_rel)
904
file_id = inv.path2id(from_rel)
906
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
909
from_parent = entry.parent_id
910
from_name = entry.name
912
if inv.path2id(to_rel):
913
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
915
to_dir, to_tail = os.path.split(to_rel)
916
to_dir_id = inv.path2id(to_dir)
917
if to_dir_id == None and to_dir != '':
918
raise BzrError("can't determine destination directory id for %r" % to_dir)
920
mutter("rename_one:")
921
mutter(" file_id {%s}" % file_id)
922
mutter(" from_rel %r" % from_rel)
923
mutter(" to_rel %r" % to_rel)
924
mutter(" to_dir %r" % to_dir)
925
mutter(" to_dir_id {%s}" % to_dir_id)
927
inv.rename(file_id, to_dir_id, to_tail)
929
from_abs = self.abspath(from_rel)
930
to_abs = self.abspath(to_rel)
932
rename(from_abs, to_abs)
934
inv.rename(file_id, from_parent, from_name)
935
raise BzrError("failed to rename %r to %r: %s"
936
% (from_abs, to_abs, e[1]),
937
["rename rolled back"])
938
self._write_inventory(inv)
942
"""Return all unknown files.
944
These are files in the working directory that are not versioned or
945
control files or ignored.
947
for subp in self.extras():
948
if not self.is_ignored(subp):
951
@deprecated_method(zero_eight)
952
def iter_conflicts(self):
953
"""List all files in the tree that have text or content conflicts.
954
DEPRECATED. Use conflicts instead."""
955
return self._iter_conflicts()
957
def _iter_conflicts(self):
959
for info in self.list_files():
961
stem = get_conflicted_stem(path)
964
if stem not in conflicted:
969
def pull(self, source, overwrite=False, stop_revision=None):
970
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
973
pp = ProgressPhase("Pull phase", 2, top_pb)
975
old_revision_history = self.branch.revision_history()
976
basis_tree = self.basis_tree()
977
count = self.branch.pull(source, overwrite, stop_revision)
978
new_revision_history = self.branch.revision_history()
979
if new_revision_history != old_revision_history:
981
if len(old_revision_history):
982
other_revision = old_revision_history[-1]
984
other_revision = None
985
repository = self.branch.repository
986
pb = bzrlib.ui.ui_factory.nested_progress_bar()
988
merge_inner(self.branch,
989
self.branch.basis_tree(),
995
self.set_last_revision(self.branch.last_revision())
1002
"""Yield all unknown files in this WorkingTree.
1004
If there are any unknown directories then only the directory is
1005
returned, not all its children. But if there are unknown files
1006
under a versioned subdirectory, they are returned.
1008
Currently returned depth-first, sorted by name within directories.
1010
## TODO: Work from given directory downwards
1011
for path, dir_entry in self.inventory.directories():
1012
mutter("search for unknowns in %r", path)
1013
dirabs = self.abspath(path)
1014
if not isdir(dirabs):
1015
# e.g. directory deleted
1019
for subf in os.listdir(dirabs):
1022
if subf not in dir_entry.children:
1023
subf_norm, can_access = osutils.normalized_filename(subf)
1024
if subf_norm != subf and can_access:
1025
if subf_norm not in dir_entry.children:
1026
fl.append(subf_norm)
1032
subp = pathjoin(path, subf)
1035
def _translate_ignore_rule(self, rule):
1036
"""Translate a single ignore rule to a regex.
1038
There are two types of ignore rules. Those that do not contain a / are
1039
matched against the tail of the filename (that is, they do not care
1040
what directory the file is in.) Rules which do contain a slash must
1041
match the entire path. As a special case, './' at the start of the
1042
string counts as a slash in the string but is removed before matching
1043
(e.g. ./foo.c, ./src/foo.c)
1045
:return: The translated regex.
1047
if rule[:2] in ('./', '.\\'):
1049
result = fnmatch.translate(rule[2:])
1050
elif '/' in rule or '\\' in rule:
1052
result = fnmatch.translate(rule)
1054
# default rule style.
1055
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1056
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1057
return "(" + result + ")"
1059
def _combine_ignore_rules(self, rules):
1060
"""Combine a list of ignore rules into a single regex object.
1062
Each individual rule is combined with | to form a big regex, which then
1063
has $ added to it to form something like ()|()|()$. The group index for
1064
each subregex's outermost group is placed in a dictionary mapping back
1065
to the rule. This allows quick identification of the matching rule that
1067
:return: a list of the compiled regex and the matching-group index
1068
dictionaries. We return a list because python complains if you try to
1069
combine more than 100 regexes.
1074
translated_rules = []
1076
translated_rule = self._translate_ignore_rule(rule)
1077
compiled_rule = re.compile(translated_rule)
1078
groups[next_group] = rule
1079
next_group += compiled_rule.groups
1080
translated_rules.append(translated_rule)
1081
if next_group == 99:
1082
result.append((re.compile("|".join(translated_rules)), groups))
1085
translated_rules = []
1086
if len(translated_rules):
1087
result.append((re.compile("|".join(translated_rules)), groups))
1090
def ignored_files(self):
1091
"""Yield list of PATH, IGNORE_PATTERN"""
1092
for subp in self.extras():
1093
pat = self.is_ignored(subp)
1097
def get_ignore_list(self):
1098
"""Return list of ignore patterns.
1100
Cached in the Tree object after the first call.
1102
ignorelist = getattr(self, '_ignorelist', None)
1103
if ignorelist is not None:
1106
ignore_globs = bzrlib.DEFAULT_IGNORE[:]
1108
ignore_globs.extend(ignores.get_user_ignores())
1110
if self.has_filename(bzrlib.IGNORE_FILENAME):
1111
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1113
ignore_globs.extend(ignores.parse_ignore_file(f))
1117
self._ignorelist = ignore_globs
1118
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1121
def _get_ignore_rules_as_regex(self):
1122
"""Return a regex of the ignore rules and a mapping dict.
1124
:return: (ignore rules compiled regex, dictionary mapping rule group
1125
indices to original rule.)
1127
if getattr(self, '_ignorelist', None) is None:
1128
self.get_ignore_list()
1129
return self._ignore_regex
1131
def is_ignored(self, filename):
1132
r"""Check whether the filename matches an ignore pattern.
1134
Patterns containing '/' or '\' need to match the whole path;
1135
others match against only the last component.
1137
If the file is ignored, returns the pattern which caused it to
1138
be ignored, otherwise None. So this can simply be used as a
1139
boolean if desired."""
1141
# TODO: Use '**' to match directories, and other extended
1142
# globbing stuff from cvs/rsync.
1144
# XXX: fnmatch is actually not quite what we want: it's only
1145
# approximately the same as real Unix fnmatch, and doesn't
1146
# treat dotfiles correctly and allows * to match /.
1147
# Eventually it should be replaced with something more
1150
rules = self._get_ignore_rules_as_regex()
1151
for regex, mapping in rules:
1152
match = regex.match(filename)
1153
if match is not None:
1154
# one or more of the groups in mapping will have a non-None group
1156
groups = match.groups()
1157
rules = [mapping[group] for group in
1158
mapping if groups[group] is not None]
1162
def kind(self, file_id):
1163
return file_kind(self.id2abspath(file_id))
1166
def last_revision(self):
1167
"""Return the last revision id of this working tree.
1169
In early branch formats this was == the branch last_revision,
1170
but that cannot be relied upon - for working tree operations,
1171
always use tree.last_revision().
1173
return self.branch.last_revision()
1175
def is_locked(self):
1176
return self._control_files.is_locked()
1178
def lock_read(self):
1179
"""See Branch.lock_read, and WorkingTree.unlock."""
1180
self.branch.lock_read()
1182
return self._control_files.lock_read()
1184
self.branch.unlock()
1187
def lock_write(self):
1188
"""See Branch.lock_write, and WorkingTree.unlock."""
1189
self.branch.lock_write()
1191
return self._control_files.lock_write()
1193
self.branch.unlock()
1196
def get_physical_lock_status(self):
1197
return self._control_files.get_physical_lock_status()
1199
def _basis_inventory_name(self):
1200
return 'basis-inventory'
1203
def set_last_revision(self, new_revision):
1204
"""Change the last revision in the working tree."""
1205
if self._change_last_revision(new_revision):
1206
self._cache_basis_inventory(new_revision)
1208
def _change_last_revision(self, new_revision):
1209
"""Template method part of set_last_revision to perform the change.
1211
This is used to allow WorkingTree3 instances to not affect branch
1212
when their last revision is set.
1214
if new_revision is None:
1215
self.branch.set_revision_history([])
1217
# current format is locked in with the branch
1218
revision_history = self.branch.revision_history()
1220
position = revision_history.index(new_revision)
1222
raise errors.NoSuchRevision(self.branch, new_revision)
1223
self.branch.set_revision_history(revision_history[:position + 1])
1226
def _cache_basis_inventory(self, new_revision):
1227
"""Cache new_revision as the basis inventory."""
1228
# TODO: this should allow the ready-to-use inventory to be passed in,
1229
# as commit already has that ready-to-use [while the format is the
1232
# this double handles the inventory - unpack and repack -
1233
# but is easier to understand. We can/should put a conditional
1234
# in here based on whether the inventory is in the latest format
1235
# - perhaps we should repack all inventories on a repository
1237
# the fast path is to copy the raw xml from the repository. If the
1238
# xml contains 'revision_id="', then we assume the right
1239
# revision_id is set. We must check for this full string, because a
1240
# root node id can legitimately look like 'revision_id' but cannot
1242
xml = self.branch.repository.get_inventory_xml(new_revision)
1243
if not 'revision_id="' in xml.split('\n', 1)[0]:
1244
inv = self.branch.repository.deserialise_inventory(
1246
inv.revision_id = new_revision
1247
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1248
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1249
path = self._basis_inventory_name()
1251
self._control_files.put(path, sio)
1252
except WeaveRevisionNotPresent:
1255
def read_basis_inventory(self):
1256
"""Read the cached basis inventory."""
1257
path = self._basis_inventory_name()
1258
return self._control_files.get(path).read()
1261
def read_working_inventory(self):
1262
"""Read the working inventory."""
1263
# ElementTree does its own conversion from UTF-8, so open in
1265
result = bzrlib.xml5.serializer_v5.read_inventory(
1266
self._control_files.get('inventory'))
1267
self._set_inventory(result)
1271
def remove(self, files, verbose=False, to_file=None):
1272
"""Remove nominated files from the working inventory..
1274
This does not remove their text. This does not run on XXX on what? RBC
1276
TODO: Refuse to remove modified files unless --force is given?
1278
TODO: Do something useful with directories.
1280
TODO: Should this remove the text or not? Tough call; not
1281
removing may be useful and the user can just use use rm, and
1282
is the opposite of add. Removing it is consistent with most
1283
other tools. Maybe an option.
1285
## TODO: Normalize names
1286
## TODO: Remove nested loops; better scalability
1287
if isinstance(files, basestring):
1290
inv = self.inventory
1292
# do this before any modifications
1294
fid = inv.path2id(f)
1296
# TODO: Perhaps make this just a warning, and continue?
1297
# This tends to happen when
1298
raise NotVersionedError(path=f)
1300
# having remove it, it must be either ignored or unknown
1301
if self.is_ignored(f):
1305
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1308
self._write_inventory(inv)
1311
def revert(self, filenames, old_tree=None, backups=True,
1312
pb=DummyProgress()):
1313
from transform import revert
1314
from conflicts import resolve
1315
if old_tree is None:
1316
old_tree = self.basis_tree()
1317
conflicts = revert(self, old_tree, filenames, backups, pb)
1318
if not len(filenames):
1319
self.set_pending_merges([])
1322
resolve(self, filenames, ignore_misses=True)
1325
# XXX: This method should be deprecated in favour of taking in a proper
1326
# new Inventory object.
1328
def set_inventory(self, new_inventory_list):
1329
from bzrlib.inventory import (Inventory,
1334
inv = Inventory(self.get_root_id())
1335
for path, file_id, parent, kind in new_inventory_list:
1336
name = os.path.basename(path)
1339
# fixme, there should be a factory function inv,add_??
1340
if kind == 'directory':
1341
inv.add(InventoryDirectory(file_id, name, parent))
1342
elif kind == 'file':
1343
inv.add(InventoryFile(file_id, name, parent))
1344
elif kind == 'symlink':
1345
inv.add(InventoryLink(file_id, name, parent))
1347
raise BzrError("unknown kind %r" % kind)
1348
self._write_inventory(inv)
1351
def set_root_id(self, file_id):
1352
"""Set the root id for this tree."""
1353
inv = self.read_working_inventory()
1354
orig_root_id = inv.root.file_id
1355
del inv._byid[inv.root.file_id]
1356
inv.root.file_id = file_id
1357
inv._byid[inv.root.file_id] = inv.root
1360
if entry.parent_id == orig_root_id:
1361
entry.parent_id = inv.root.file_id
1362
self._write_inventory(inv)
1365
"""See Branch.unlock.
1367
WorkingTree locking just uses the Branch locking facilities.
1368
This is current because all working trees have an embedded branch
1369
within them. IF in the future, we were to make branch data shareable
1370
between multiple working trees, i.e. via shared storage, then we
1371
would probably want to lock both the local tree, and the branch.
1373
# FIXME: We want to write out the hashcache only when the last lock on
1374
# this working copy is released. Peeking at the lock count is a bit
1375
# of a nasty hack; probably it's better to have a transaction object,
1376
# which can do some finalization when it's either successfully or
1377
# unsuccessfully completed. (Denys's original patch did that.)
1378
# RBC 20060206 hooking into transaction will couple lock and transaction
1379
# wrongly. Hooking into unlock on the control files object is fine though.
1381
# TODO: split this per format so there is no ugly if block
1382
if self._hashcache.needs_write and (
1383
# dedicated lock files
1384
self._control_files._lock_count==1 or
1386
(self._control_files is self.branch.control_files and
1387
self._control_files._lock_count==3)):
1388
self._hashcache.write()
1389
# reverse order of locking.
1391
return self._control_files.unlock()
1393
self.branch.unlock()
1397
"""Update a working tree along its branch.
1399
This will update the branch if its bound too, which means we have multiple trees involved:
1400
The new basis tree of the master.
1401
The old basis tree of the branch.
1402
The old basis tree of the working tree.
1403
The current working tree state.
1404
pathologically all three may be different, and non ancestors of each other.
1405
Conceptually we want to:
1406
Preserve the wt.basis->wt.state changes
1407
Transform the wt.basis to the new master basis.
1408
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1409
Restore the wt.basis->wt.state changes.
1411
There isn't a single operation at the moment to do that, so we:
1412
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1413
Do a 'normal' merge of the old branch basis if it is relevant.
1415
old_tip = self.branch.update()
1416
if old_tip is not None:
1417
self.add_pending_merge(old_tip)
1418
self.branch.lock_read()
1421
if self.last_revision() != self.branch.last_revision():
1422
# merge tree state up to new branch tip.
1423
basis = self.basis_tree()
1424
to_tree = self.branch.basis_tree()
1425
result += merge_inner(self.branch,
1429
self.set_last_revision(self.branch.last_revision())
1430
if old_tip and old_tip != self.last_revision():
1431
# our last revision was not the prior branch last revision
1432
# and we have converted that last revision to a pending merge.
1433
# base is somewhere between the branch tip now
1434
# and the now pending merge
1435
from bzrlib.revision import common_ancestor
1437
base_rev_id = common_ancestor(self.branch.last_revision(),
1439
self.branch.repository)
1440
except errors.NoCommonAncestor:
1442
base_tree = self.branch.repository.revision_tree(base_rev_id)
1443
other_tree = self.branch.repository.revision_tree(old_tip)
1444
result += merge_inner(self.branch,
1450
self.branch.unlock()
1453
def _write_inventory(self, inv):
1454
"""Write inventory as the current inventory."""
1456
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1458
self._control_files.put('inventory', sio)
1459
self._set_inventory(inv)
1460
mutter('wrote working inventory')
1462
def set_conflicts(self, arg):
1463
raise UnsupportedOperation(self.set_conflicts, self)
1465
def add_conflicts(self, arg):
1466
raise UnsupportedOperation(self.add_conflicts, self)
1469
def conflicts(self):
1470
conflicts = ConflictList()
1471
for conflicted in self._iter_conflicts():
1474
if file_kind(self.abspath(conflicted)) != "file":
1476
except errors.NoSuchFile:
1479
for suffix in ('.THIS', '.OTHER'):
1481
kind = file_kind(self.abspath(conflicted+suffix))
1484
except errors.NoSuchFile:
1488
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1489
conflicts.append(Conflict.factory(ctype, path=conflicted,
1490
file_id=self.path2id(conflicted)))
1494
class WorkingTree3(WorkingTree):
1495
"""This is the Format 3 working tree.
1497
This differs from the base WorkingTree by:
1498
- having its own file lock
1499
- having its own last-revision property.
1501
This is new in bzr 0.8
1505
def last_revision(self):
1506
"""See WorkingTree.last_revision."""
1508
return self._control_files.get_utf8('last-revision').read()
1512
def _change_last_revision(self, revision_id):
1513
"""See WorkingTree._change_last_revision."""
1514
if revision_id is None or revision_id == NULL_REVISION:
1516
self._control_files._transport.delete('last-revision')
1517
except errors.NoSuchFile:
1522
self.branch.revision_history().index(revision_id)
1524
raise errors.NoSuchRevision(self.branch, revision_id)
1525
self._control_files.put_utf8('last-revision', revision_id)
1529
def set_conflicts(self, conflicts):
1530
self._put_rio('conflicts', conflicts.to_stanzas(),
1534
def add_conflicts(self, new_conflicts):
1535
conflict_set = set(self.conflicts())
1536
conflict_set.update(set(list(new_conflicts)))
1537
self.set_conflicts(ConflictList(sorted(conflict_set,
1538
key=Conflict.sort_key)))
1541
def conflicts(self):
1543
confile = self._control_files.get('conflicts')
1545
return ConflictList()
1547
if confile.next() != CONFLICT_HEADER_1 + '\n':
1548
raise ConflictFormatError()
1549
except StopIteration:
1550
raise ConflictFormatError()
1551
return ConflictList.from_stanzas(RioReader(confile))
1554
def get_conflicted_stem(path):
1555
for suffix in CONFLICT_SUFFIXES:
1556
if path.endswith(suffix):
1557
return path[:-len(suffix)]
1559
@deprecated_function(zero_eight)
1560
def is_control_file(filename):
1561
"""See WorkingTree.is_control_filename(filename)."""
1562
## FIXME: better check
1563
filename = normpath(filename)
1564
while filename != '':
1565
head, tail = os.path.split(filename)
1566
## mutter('check %r for control file' % ((head, tail),))
1569
if filename == head:
1575
class WorkingTreeFormat(object):
1576
"""An encapsulation of the initialization and open routines for a format.
1578
Formats provide three things:
1579
* An initialization routine,
1583
Formats are placed in an dict by their format string for reference
1584
during workingtree opening. Its not required that these be instances, they
1585
can be classes themselves with class methods - it simply depends on
1586
whether state is needed for a given format or not.
1588
Once a format is deprecated, just deprecate the initialize and open
1589
methods on the format class. Do not deprecate the object, as the
1590
object will be created every time regardless.
1593
_default_format = None
1594
"""The default format used for new trees."""
1597
"""The known formats."""
1600
def find_format(klass, a_bzrdir):
1601
"""Return the format for the working tree object in a_bzrdir."""
1603
transport = a_bzrdir.get_workingtree_transport(None)
1604
format_string = transport.get("format").read()
1605
return klass._formats[format_string]
1607
raise errors.NoWorkingTree(base=transport.base)
1609
raise errors.UnknownFormatError(format=format_string)
1612
def get_default_format(klass):
1613
"""Return the current default format."""
1614
return klass._default_format
1616
def get_format_string(self):
1617
"""Return the ASCII format string that identifies this format."""
1618
raise NotImplementedError(self.get_format_string)
1620
def get_format_description(self):
1621
"""Return the short description for this format."""
1622
raise NotImplementedError(self.get_format_description)
1624
def is_supported(self):
1625
"""Is this format supported?
1627
Supported formats can be initialized and opened.
1628
Unsupported formats may not support initialization or committing or
1629
some other features depending on the reason for not being supported.
1634
def register_format(klass, format):
1635
klass._formats[format.get_format_string()] = format
1638
def set_default_format(klass, format):
1639
klass._default_format = format
1642
def unregister_format(klass, format):
1643
assert klass._formats[format.get_format_string()] is format
1644
del klass._formats[format.get_format_string()]
1648
class WorkingTreeFormat2(WorkingTreeFormat):
1649
"""The second working tree format.
1651
This format modified the hash cache from the format 1 hash cache.
1654
def get_format_description(self):
1655
"""See WorkingTreeFormat.get_format_description()."""
1656
return "Working tree format 2"
1658
def stub_initialize_remote(self, control_files):
1659
"""As a special workaround create critical control files for a remote working tree
1661
This ensures that it can later be updated and dealt with locally,
1662
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1663
no working tree. (See bug #43064).
1667
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1669
control_files.put('inventory', sio)
1671
control_files.put_utf8('pending-merges', '')
1674
def initialize(self, a_bzrdir, revision_id=None):
1675
"""See WorkingTreeFormat.initialize()."""
1676
if not isinstance(a_bzrdir.transport, LocalTransport):
1677
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1678
branch = a_bzrdir.open_branch()
1679
if revision_id is not None:
1682
revision_history = branch.revision_history()
1684
position = revision_history.index(revision_id)
1686
raise errors.NoSuchRevision(branch, revision_id)
1687
branch.set_revision_history(revision_history[:position + 1])
1690
revision = branch.last_revision()
1692
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1698
wt._write_inventory(inv)
1699
wt.set_root_id(inv.root.file_id)
1700
wt.set_last_revision(revision)
1701
wt.set_pending_merges([])
1702
build_tree(wt.basis_tree(), wt)
1706
super(WorkingTreeFormat2, self).__init__()
1707
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1709
def open(self, a_bzrdir, _found=False):
1710
"""Return the WorkingTree object for a_bzrdir
1712
_found is a private parameter, do not use it. It is used to indicate
1713
if format probing has already been done.
1716
# we are being called directly and must probe.
1717
raise NotImplementedError
1718
if not isinstance(a_bzrdir.transport, LocalTransport):
1719
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1720
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1726
class WorkingTreeFormat3(WorkingTreeFormat):
1727
"""The second working tree format updated to record a format marker.
1730
- exists within a metadir controlling .bzr
1731
- includes an explicit version marker for the workingtree control
1732
files, separate from the BzrDir format
1733
- modifies the hash cache format
1735
- uses a LockDir to guard access to the repository
1738
def get_format_string(self):
1739
"""See WorkingTreeFormat.get_format_string()."""
1740
return "Bazaar-NG Working Tree format 3"
1742
def get_format_description(self):
1743
"""See WorkingTreeFormat.get_format_description()."""
1744
return "Working tree format 3"
1746
_lock_file_name = 'lock'
1747
_lock_class = LockDir
1749
def _open_control_files(self, a_bzrdir):
1750
transport = a_bzrdir.get_workingtree_transport(None)
1751
return LockableFiles(transport, self._lock_file_name,
1754
def initialize(self, a_bzrdir, revision_id=None):
1755
"""See WorkingTreeFormat.initialize().
1757
revision_id allows creating a working tree at a different
1758
revision than the branch is at.
1760
if not isinstance(a_bzrdir.transport, LocalTransport):
1761
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1762
transport = a_bzrdir.get_workingtree_transport(self)
1763
control_files = self._open_control_files(a_bzrdir)
1764
control_files.create_lock()
1765
control_files.lock_write()
1766
control_files.put_utf8('format', self.get_format_string())
1767
branch = a_bzrdir.open_branch()
1768
if revision_id is None:
1769
revision_id = branch.last_revision()
1771
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1777
_control_files=control_files)
1780
wt._write_inventory(inv)
1781
wt.set_root_id(inv.root.file_id)
1782
wt.set_last_revision(revision_id)
1783
wt.set_pending_merges([])
1784
build_tree(wt.basis_tree(), wt)
1787
control_files.unlock()
1791
super(WorkingTreeFormat3, self).__init__()
1792
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1794
def open(self, a_bzrdir, _found=False):
1795
"""Return the WorkingTree object for a_bzrdir
1797
_found is a private parameter, do not use it. It is used to indicate
1798
if format probing has already been done.
1801
# we are being called directly and must probe.
1802
raise NotImplementedError
1803
if not isinstance(a_bzrdir.transport, LocalTransport):
1804
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1805
control_files = self._open_control_files(a_bzrdir)
1806
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1810
_control_files=control_files)
1813
return self.get_format_string()
1816
# formats which have no format string are not discoverable
1817
# and not independently creatable, so are not registered.
1818
__default_format = WorkingTreeFormat3()
1819
WorkingTreeFormat.register_format(__default_format)
1820
WorkingTreeFormat.set_default_format(__default_format)
1821
_legacy_formats = [WorkingTreeFormat2(),
1825
class WorkingTreeTestProviderAdapter(object):
1826
"""A tool to generate a suite testing multiple workingtree formats at once.
1828
This is done by copying the test once for each transport and injecting
1829
the transport_server, transport_readonly_server, and workingtree_format
1830
classes into each copy. Each copy is also given a new id() to make it
1834
def __init__(self, transport_server, transport_readonly_server, formats):
1835
self._transport_server = transport_server
1836
self._transport_readonly_server = transport_readonly_server
1837
self._formats = formats
1839
def adapt(self, test):
1840
from bzrlib.tests import TestSuite
1841
result = TestSuite()
1842
for workingtree_format, bzrdir_format in self._formats:
1843
new_test = deepcopy(test)
1844
new_test.transport_server = self._transport_server
1845
new_test.transport_readonly_server = self._transport_readonly_server
1846
new_test.bzrdir_format = bzrdir_format
1847
new_test.workingtree_format = workingtree_format
1848
def make_new_test_id():
1849
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1850
return lambda: new_id
1851
new_test.id = make_new_test_id()
1852
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
