1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
53
from bzrlib.atomicfile import AtomicFile
54
from bzrlib.branch import (Branch,
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
import bzrlib.bzrdir as bzrdir
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
59
import bzrlib.errors as errors
60
from bzrlib.errors import (BzrCheckError,
64
WeaveRevisionNotPresent,
68
MergeModifiedFormatError,
71
from bzrlib.inventory import InventoryEntry, Inventory
72
from bzrlib.lockable_files import LockableFiles, TransportLock
73
from bzrlib.lockdir import LockDir
74
from bzrlib.merge import merge_inner, transform_tree
75
from bzrlib.osutils import (
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
from bzrlib.rio import RioReader, rio_file, Stanza
95
from bzrlib.symbol_versioning import *
96
from bzrlib.textui import show_status
98
from bzrlib.transform import build_tree
99
from bzrlib.trace import mutter, note
100
from bzrlib.transport import get_transport
101
from bzrlib.transport.local import LocalTransport
102
import bzrlib.urlutils as urlutils
107
# the regex here does the following:
108
# 1) remove any weird characters; we don't escape them but rather
110
# 2) match leading '.'s to make it not hidden
111
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
112
_gen_id_suffix = None
116
def _next_id_suffix():
117
"""Create a new file id suffix that is reasonably unique.
119
On the first call we combine the current time with 64 bits of randomness
120
to give a highly probably globally unique number. Then each call in the same
121
process adds 1 to a serial number we append to that unique value.
123
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
124
# than having to move the id randomness out of the inner loop like this.
125
# XXX TODO: for the global randomness this uses we should add the thread-id
126
# before the serial #.
127
global _gen_id_suffix, _gen_id_serial
128
if _gen_id_suffix is None:
129
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
131
return _gen_id_suffix + str(_gen_id_serial)
134
def gen_file_id(name):
135
"""Return new file id for the basename 'name'.
137
The uniqueness is supplied from _next_id_suffix.
139
# XXX TODO: squash the filename to lowercase.
140
# XXX TODO: truncate the filename to something like 20 or 30 chars.
141
# XXX TODO: consider what to do with ids that look like illegal filepaths
142
# on platforms we support.
143
return _gen_file_id_re.sub('', name) + _next_id_suffix()
147
"""Return a new tree-root file id."""
148
return gen_file_id('TREE_ROOT')
151
class TreeEntry(object):
152
"""An entry that implements the minium interface used by commands.
154
This needs further inspection, it may be better to have
155
InventoryEntries without ids - though that seems wrong. For now,
156
this is a parallel hierarchy to InventoryEntry, and needs to become
157
one of several things: decorates to that hierarchy, children of, or
159
Another note is that these objects are currently only used when there is
160
no InventoryEntry available - i.e. for unversioned objects.
161
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
164
def __eq__(self, other):
165
# yes, this us ugly, TODO: best practice __eq__ style.
166
return (isinstance(other, TreeEntry)
167
and other.__class__ == self.__class__)
169
def kind_character(self):
173
class TreeDirectory(TreeEntry):
174
"""See TreeEntry. This is a directory in a working tree."""
176
def __eq__(self, other):
177
return (isinstance(other, TreeDirectory)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeFile(TreeEntry):
185
"""See TreeEntry. This is a regular file in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeFile)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class TreeLink(TreeEntry):
196
"""See TreeEntry. This is a symlink in a working tree."""
198
def __eq__(self, other):
199
return (isinstance(other, TreeLink)
200
and other.__class__ == self.__class__)
202
def kind_character(self):
206
class WorkingTree(bzrlib.tree.Tree):
207
"""Working copy tree.
209
The inventory is held in the `Branch` working-inventory, and the
210
files are in a directory on disk.
212
It is possible for a `WorkingTree` to have a filename which is
213
not listed in the Inventory and vice versa.
216
def __init__(self, basedir='.',
217
branch=DEPRECATED_PARAMETER,
223
"""Construct a WorkingTree for basedir.
225
If the branch is not supplied, it is opened automatically.
226
If the branch is supplied, it must be the branch for this basedir.
227
(branch.base is not cross checked, because for remote branches that
228
would be meaningless).
230
self._format = _format
231
self.bzrdir = _bzrdir
233
# not created via open etc.
234
warn("WorkingTree() is deprecated as of bzr version 0.8. "
235
"Please use bzrdir.open_workingtree or WorkingTree.open().",
238
wt = WorkingTree.open(basedir)
239
self._branch = wt.branch
240
self.basedir = wt.basedir
241
self._control_files = wt._control_files
242
self._hashcache = wt._hashcache
243
self._set_inventory(wt._inventory)
244
self._format = wt._format
245
self.bzrdir = wt.bzrdir
246
from bzrlib.hashcache import HashCache
247
from bzrlib.trace import note, mutter
248
assert isinstance(basedir, basestring), \
249
"base directory %r is not a string" % basedir
250
basedir = safe_unicode(basedir)
251
mutter("opening working tree %r", basedir)
252
if deprecated_passed(branch):
254
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
255
" Please use bzrdir.open_workingtree() or"
256
" WorkingTree.open().",
260
self._branch = branch
262
self._branch = self.bzrdir.open_branch()
263
assert isinstance(self.branch, Branch), \
264
"branch %r is not a Branch" % self.branch
265
self.basedir = realpath(basedir)
266
# if branch is at our basedir and is a format 6 or less
267
if isinstance(self._format, WorkingTreeFormat2):
268
# share control object
269
self._control_files = self.branch.control_files
271
# only ready for format 3
272
assert isinstance(self._format, WorkingTreeFormat3)
273
assert isinstance(_control_files, LockableFiles), \
274
"_control_files must be a LockableFiles, not %r" \
276
self._control_files = _control_files
277
# update the whole cache up front and write to disk if anything changed;
278
# in the future we might want to do this more selectively
279
# two possible ways offer themselves : in self._unlock, write the cache
280
# if needed, or, when the cache sees a change, append it to the hash
281
# cache file, and have the parser take the most recent entry for a
283
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
284
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
286
# is this scan needed ? it makes things kinda slow.
293
if _inventory is None:
294
self._set_inventory(self.read_working_inventory())
296
self._set_inventory(_inventory)
299
fget=lambda self: self._branch,
300
doc="""The branch this WorkingTree is connected to.
302
This cannot be set - it is reflective of the actual disk structure
303
the working tree has been constructed from.
306
def break_lock(self):
307
"""Break a lock if one is present from another instance.
309
Uses the ui factory to ask for confirmation if the lock may be from
312
This will probe the repository for its lock as well.
314
self._control_files.break_lock()
315
self.branch.break_lock()
317
def _set_inventory(self, inv):
318
self._inventory = inv
319
self.path2id = self._inventory.path2id
321
def is_control_filename(self, filename):
322
"""True if filename is the name of a control file in this tree.
324
:param filename: A filename within the tree. This is a relative path
325
from the root of this tree.
327
This is true IF and ONLY IF the filename is part of the meta data
328
that bzr controls in this tree. I.E. a random .bzr directory placed
329
on disk will not be a control file for this tree.
331
return self.bzrdir.is_control_filename(filename)
334
def open(path=None, _unsupported=False):
335
"""Open an existing working tree at path.
339
path = os.path.getcwdu()
340
control = bzrdir.BzrDir.open(path, _unsupported)
341
return control.open_workingtree(_unsupported)
344
def open_containing(path=None):
345
"""Open an existing working tree which has its root about path.
347
This probes for a working tree at path and searches upwards from there.
349
Basically we keep looking up until we find the control directory or
350
run into /. If there isn't one, raises NotBranchError.
351
TODO: give this a new exception.
352
If there is one, it is returned, along with the unused portion of path.
354
:return: The WorkingTree that contains 'path', and the rest of path
358
control, relpath = bzrdir.BzrDir.open_containing(path)
360
return control.open_workingtree(), relpath
363
def open_downlevel(path=None):
364
"""Open an unsupported working tree.
366
Only intended for advanced situations like upgrading part of a bzrdir.
368
return WorkingTree.open(path, _unsupported=True)
371
"""Iterate through file_ids for this tree.
373
file_ids are in a WorkingTree if they are in the working inventory
374
and the working file exists.
376
inv = self._inventory
377
for path, ie in inv.iter_entries():
378
if bzrlib.osutils.lexists(self.abspath(path)):
382
return "<%s of %s>" % (self.__class__.__name__,
383
getattr(self, 'basedir', None))
385
def abspath(self, filename):
386
return pathjoin(self.basedir, filename)
388
def basis_tree(self):
389
"""Return RevisionTree for the current last revision."""
390
revision_id = self.last_revision()
391
if revision_id is not None:
393
xml = self.read_basis_inventory()
394
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
397
if inv is not None and inv.revision_id == revision_id:
398
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
400
# FIXME? RBC 20060403 should we cache the inventory here ?
401
return self.branch.repository.revision_tree(revision_id)
404
@deprecated_method(zero_eight)
405
def create(branch, directory):
406
"""Create a workingtree for branch at directory.
408
If existing_directory already exists it must have a .bzr directory.
409
If it does not exist, it will be created.
411
This returns a new WorkingTree object for the new checkout.
413
TODO FIXME RBC 20060124 when we have checkout formats in place this
414
should accept an optional revisionid to checkout [and reject this if
415
checking out into the same dir as a pre-checkout-aware branch format.]
417
XXX: When BzrDir is present, these should be created through that
420
warn('delete WorkingTree.create', stacklevel=3)
421
transport = get_transport(directory)
422
if branch.bzrdir.root_transport.base == transport.base:
424
return branch.bzrdir.create_workingtree()
425
# different directory,
426
# create a branch reference
427
# and now a working tree.
428
raise NotImplementedError
431
@deprecated_method(zero_eight)
432
def create_standalone(directory):
433
"""Create a checkout and a branch and a repo at directory.
435
Directory must exist and be empty.
437
please use BzrDir.create_standalone_workingtree
439
return bzrdir.BzrDir.create_standalone_workingtree(directory)
441
def relpath(self, path):
442
"""Return the local path portion from a given path.
444
The path may be absolute or relative. If its a relative path it is
445
interpreted relative to the python current working directory.
447
return relpath(self.basedir, path)
449
def has_filename(self, filename):
450
return bzrlib.osutils.lexists(self.abspath(filename))
452
def get_file(self, file_id):
453
return self.get_file_byname(self.id2path(file_id))
455
def get_file_byname(self, filename):
456
return file(self.abspath(filename), 'rb')
458
def get_root_id(self):
459
"""Return the id of this trees root"""
460
inv = self.read_working_inventory()
461
return inv.root.file_id
463
def _get_store_filename(self, file_id):
464
## XXX: badly named; this is not in the store at all
465
return self.abspath(self.id2path(file_id))
468
def clone(self, to_bzrdir, revision_id=None, basis=None):
469
"""Duplicate this working tree into to_bzr, including all state.
471
Specifically modified files are kept as modified, but
472
ignored and unknown files are discarded.
474
If you want to make a new line of development, see bzrdir.sprout()
477
If not None, the cloned tree will have its last revision set to
478
revision, and and difference between the source trees last revision
479
and this one merged in.
482
If not None, a closer copy of a tree which may have some files in
483
common, and which file content should be preferentially copied from.
485
# assumes the target bzr dir format is compatible.
486
result = self._format.initialize(to_bzrdir)
487
self.copy_content_into(result, revision_id)
491
def copy_content_into(self, tree, revision_id=None):
492
"""Copy the current content and user files of this tree into tree."""
493
tree.set_root_id(self.get_root_id())
494
if revision_id is None:
495
transform_tree(tree, self)
497
# TODO now merge from tree.last_revision to revision
498
transform_tree(tree, self)
499
tree.set_last_revision(revision_id)
502
def commit(self, message=None, revprops=None, *args, **kwargs):
503
# avoid circular imports
504
from bzrlib.commit import Commit
507
if not 'branch-nick' in revprops:
508
revprops['branch-nick'] = self.branch.nick
509
# args for wt.commit start at message from the Commit.commit method,
510
# but with branch a kwarg now, passing in args as is results in the
511
#message being used for the branch
512
args = (DEPRECATED_PARAMETER, message, ) + args
513
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
514
self._set_inventory(self.read_working_inventory())
516
def id2abspath(self, file_id):
517
return self.abspath(self.id2path(file_id))
519
def has_id(self, file_id):
520
# files that have been deleted are excluded
521
inv = self._inventory
522
if not inv.has_id(file_id):
524
path = inv.id2path(file_id)
525
return bzrlib.osutils.lexists(self.abspath(path))
527
def has_or_had_id(self, file_id):
528
if file_id == self.inventory.root.file_id:
530
return self.inventory.has_id(file_id)
532
__contains__ = has_id
534
def get_file_size(self, file_id):
535
return os.path.getsize(self.id2abspath(file_id))
538
def get_file_sha1(self, file_id, path=None):
540
path = self._inventory.id2path(file_id)
541
return self._hashcache.get_sha1(path)
543
def get_file_mtime(self, file_id, path=None):
545
path = self._inventory.id2path(file_id)
546
return os.lstat(self.abspath(path)).st_mtime
548
if not supports_executable():
549
def is_executable(self, file_id, path=None):
550
return self._inventory[file_id].executable
552
def is_executable(self, file_id, path=None):
554
path = self._inventory.id2path(file_id)
555
mode = os.lstat(self.abspath(path)).st_mode
556
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
559
def add(self, files, ids=None):
560
"""Make files versioned.
562
Note that the command line normally calls smart_add instead,
563
which can automatically recurse.
565
This adds the files to the inventory, so that they will be
566
recorded by the next commit.
569
List of paths to add, relative to the base of the tree.
572
If set, use these instead of automatically generated ids.
573
Must be the same length as the list of files, but may
574
contain None for ids that are to be autogenerated.
576
TODO: Perhaps have an option to add the ids even if the files do
579
TODO: Perhaps callback with the ids and paths as they're added.
581
# TODO: Re-adding a file that is removed in the working copy
582
# should probably put it back with the previous ID.
583
if isinstance(files, basestring):
584
assert(ids is None or isinstance(ids, basestring))
590
ids = [None] * len(files)
592
assert(len(ids) == len(files))
594
inv = self.read_working_inventory()
595
for f,file_id in zip(files, ids):
596
if self.is_control_filename(f):
597
raise BzrError("cannot add control file %s" % quotefn(f))
602
raise BzrError("cannot add top-level %r" % f)
604
fullpath = normpath(self.abspath(f))
607
kind = file_kind(fullpath)
609
if e.errno == errno.ENOENT:
610
raise NoSuchFile(fullpath)
611
# maybe something better?
612
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
614
if not InventoryEntry.versionable_kind(kind):
615
raise BzrError('cannot add: not a versionable file ('
616
'i.e. regular file, symlink or directory): %s' % quotefn(f))
619
inv.add_path(f, kind=kind)
621
inv.add_path(f, kind=kind, file_id=file_id)
623
self._write_inventory(inv)
626
def add_pending_merge(self, *revision_ids):
627
# TODO: Perhaps should check at this point that the
628
# history of the revision is actually present?
629
p = self.pending_merges()
631
for rev_id in revision_ids:
637
self.set_pending_merges(p)
640
def pending_merges(self):
641
"""Return a list of pending merges.
643
These are revisions that have been merged into the working
644
directory but not yet committed.
647
merges_file = self._control_files.get_utf8('pending-merges')
649
if e.errno != errno.ENOENT:
653
for l in merges_file.readlines():
654
p.append(l.rstrip('\n'))
658
def set_pending_merges(self, rev_list):
659
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
662
def set_merge_modified(self, modified_hashes):
664
for file_id, hash in modified_hashes.iteritems():
665
yield Stanza(file_id=file_id, hash=hash)
666
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
669
def _put_rio(self, filename, stanzas, header):
670
my_file = rio_file(stanzas, header)
671
self._control_files.put(filename, my_file)
674
def merge_modified(self):
676
hashfile = self._control_files.get('merge-hashes')
681
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
682
raise MergeModifiedFormatError()
683
except StopIteration:
684
raise MergeModifiedFormatError()
685
for s in RioReader(hashfile):
686
file_id = s.get("file_id")
687
if file_id not in self.inventory:
690
if hash == self.get_file_sha1(file_id):
691
merge_hashes[file_id] = hash
694
def get_symlink_target(self, file_id):
695
return os.readlink(self.id2abspath(file_id))
697
def file_class(self, filename):
698
if self.path2id(filename):
700
elif self.is_ignored(filename):
705
def list_files(self, include_root=False):
706
"""Recursively list all files as (path, class, kind, id, entry).
708
Lists, but does not descend into unversioned directories.
710
This does not include files that have been deleted in this
713
Skips the control directory.
715
inv = self._inventory
716
# Convert these into local objects to save lookup times
717
pathjoin = bzrlib.osutils.pathjoin
718
file_kind = bzrlib.osutils.file_kind
720
# transport.base ends in a slash, we want the piece
721
# between the last two slashes
722
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
724
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
726
# directory file_id, relative path, absolute path, reverse sorted children
727
children = os.listdir(self.basedir)
729
# jam 20060527 The kernel sized tree seems equivalent whether we
730
# use a deque and popleft to keep them sorted, or if we use a plain
731
# list and just reverse() them.
732
children = collections.deque(children)
733
stack = [(inv.root.file_id, u'', self.basedir, children)]
735
yield u'', 'V', 'directory', inv.root.file_id, inv.root
737
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
740
f = children.popleft()
741
## TODO: If we find a subdirectory with its own .bzr
742
## directory, then that is a separate tree and we
743
## should exclude it.
745
# the bzrdir for this tree
746
if transport_base_dir == f:
749
# we know that from_dir_relpath and from_dir_abspath never end in a slash
750
# and 'f' doesn't begin with one, we can do a string op, rather
751
# than the checks of pathjoin(), all relative paths will have an extra slash
753
fp = from_dir_relpath + '/' + f
756
fap = from_dir_abspath + '/' + f
758
f_ie = inv.get_child(from_dir_id, f)
761
elif self.is_ignored(fp[1:]):
770
raise BzrCheckError("file %r entered as kind %r id %r, "
772
% (fap, f_ie.kind, f_ie.file_id, fk))
774
# make a last minute entry
776
yield fp[1:], c, fk, f_ie.file_id, f_ie
779
yield fp[1:], c, fk, None, fk_entries[fk]()
781
yield fp[1:], c, fk, None, TreeEntry()
784
if fk != 'directory':
787
# But do this child first
788
new_children = os.listdir(fap)
790
new_children = collections.deque(new_children)
791
stack.append((f_ie.file_id, fp, fap, new_children))
792
# Break out of inner loop, so that we start outer loop with child
795
# if we finished all children, pop it off the stack
800
def move(self, from_paths, to_name):
803
to_name must exist in the inventory.
805
If to_name exists and is a directory, the files are moved into
806
it, keeping their old names.
808
Note that to_name is only the last component of the new name;
809
this doesn't change the directory.
811
This returns a list of (from_path, to_path) pairs for each
815
## TODO: Option to move IDs only
816
assert not isinstance(from_paths, basestring)
818
to_abs = self.abspath(to_name)
819
if not isdir(to_abs):
820
raise BzrError("destination %r is not a directory" % to_abs)
821
if not self.has_filename(to_name):
822
raise BzrError("destination %r not in working directory" % to_abs)
823
to_dir_id = inv.path2id(to_name)
824
if to_dir_id == None and to_name != '':
825
raise BzrError("destination %r is not a versioned directory" % to_name)
826
to_dir_ie = inv[to_dir_id]
827
if to_dir_ie.kind != 'directory':
828
raise BzrError("destination %r is not a directory" % to_abs)
830
to_idpath = inv.get_idpath(to_dir_id)
833
if not self.has_filename(f):
834
raise BzrError("%r does not exist in working tree" % f)
835
f_id = inv.path2id(f)
837
raise BzrError("%r is not versioned" % f)
838
name_tail = splitpath(f)[-1]
839
dest_path = pathjoin(to_name, name_tail)
840
if self.has_filename(dest_path):
841
raise BzrError("destination %r already exists" % dest_path)
842
if f_id in to_idpath:
843
raise BzrError("can't move %r to a subdirectory of itself" % f)
845
# OK, so there's a race here, it's possible that someone will
846
# create a file in this interval and then the rename might be
847
# left half-done. But we should have caught most problems.
848
orig_inv = deepcopy(self.inventory)
851
name_tail = splitpath(f)[-1]
852
dest_path = pathjoin(to_name, name_tail)
853
result.append((f, dest_path))
854
inv.rename(inv.path2id(f), to_dir_id, name_tail)
856
rename(self.abspath(f), self.abspath(dest_path))
858
raise BzrError("failed to rename %r to %r: %s" %
859
(f, dest_path, e[1]),
860
["rename rolled back"])
862
# restore the inventory on error
863
self._set_inventory(orig_inv)
865
self._write_inventory(inv)
869
def rename_one(self, from_rel, to_rel):
872
This can change the directory or the filename or both.
875
if not self.has_filename(from_rel):
876
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
877
if self.has_filename(to_rel):
878
raise BzrError("can't rename: new working file %r already exists" % to_rel)
880
file_id = inv.path2id(from_rel)
882
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
885
from_parent = entry.parent_id
886
from_name = entry.name
888
if inv.path2id(to_rel):
889
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
891
to_dir, to_tail = os.path.split(to_rel)
892
to_dir_id = inv.path2id(to_dir)
893
if to_dir_id == None and to_dir != '':
894
raise BzrError("can't determine destination directory id for %r" % to_dir)
896
mutter("rename_one:")
897
mutter(" file_id {%s}" % file_id)
898
mutter(" from_rel %r" % from_rel)
899
mutter(" to_rel %r" % to_rel)
900
mutter(" to_dir %r" % to_dir)
901
mutter(" to_dir_id {%s}" % to_dir_id)
903
inv.rename(file_id, to_dir_id, to_tail)
905
from_abs = self.abspath(from_rel)
906
to_abs = self.abspath(to_rel)
908
rename(from_abs, to_abs)
910
inv.rename(file_id, from_parent, from_name)
911
raise BzrError("failed to rename %r to %r: %s"
912
% (from_abs, to_abs, e[1]),
913
["rename rolled back"])
914
self._write_inventory(inv)
918
"""Return all unknown files.
920
These are files in the working directory that are not versioned or
921
control files or ignored.
923
>>> from bzrlib.bzrdir import ScratchDir
924
>>> d = ScratchDir(files=['foo', 'foo~'])
925
>>> b = d.open_branch()
926
>>> tree = d.open_workingtree()
927
>>> map(str, tree.unknowns())
930
>>> list(b.unknowns())
932
>>> tree.remove('foo')
933
>>> list(b.unknowns())
936
for subp in self.extras():
937
if not self.is_ignored(subp):
940
@deprecated_method(zero_eight)
941
def iter_conflicts(self):
942
"""List all files in the tree that have text or content conflicts.
943
DEPRECATED. Use conflicts instead."""
944
return self._iter_conflicts()
946
def _iter_conflicts(self):
948
for info in self.list_files():
950
stem = get_conflicted_stem(path)
953
if stem not in conflicted:
958
def pull(self, source, overwrite=False, stop_revision=None):
959
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
962
pp = ProgressPhase("Pull phase", 2, top_pb)
964
old_revision_history = self.branch.revision_history()
965
basis_tree = self.basis_tree()
966
count = self.branch.pull(source, overwrite, stop_revision)
967
new_revision_history = self.branch.revision_history()
968
if new_revision_history != old_revision_history:
970
if len(old_revision_history):
971
other_revision = old_revision_history[-1]
973
other_revision = None
974
repository = self.branch.repository
975
pb = bzrlib.ui.ui_factory.nested_progress_bar()
977
branch_basis = self.branch.basis_tree()
978
merge_inner(self.branch, branch_basis, basis_tree,
979
this_tree=self, pb=pb)
980
if (basis_tree.inventory.root is None and
981
branch_basis.inventory.root is not None):
982
self.set_root_id(branch_basis.inventory.root.file_id)
985
self.set_last_revision(self.branch.last_revision())
992
"""Yield all unknown files in this WorkingTree.
994
If there are any unknown directories then only the directory is
995
returned, not all its children. But if there are unknown files
996
under a versioned subdirectory, they are returned.
998
Currently returned depth-first, sorted by name within directories.
1000
## TODO: Work from given directory downwards
1001
for path, dir_entry in self.inventory.directories():
1002
mutter("search for unknowns in %r", path)
1003
dirabs = self.abspath(path)
1004
if not isdir(dirabs):
1005
# e.g. directory deleted
1009
for subf in os.listdir(dirabs):
1011
and (subf not in dir_entry.children)):
1016
subp = pathjoin(path, subf)
1019
def _translate_ignore_rule(self, rule):
1020
"""Translate a single ignore rule to a regex.
1022
There are two types of ignore rules. Those that do not contain a / are
1023
matched against the tail of the filename (that is, they do not care
1024
what directory the file is in.) Rules which do contain a slash must
1025
match the entire path. As a special case, './' at the start of the
1026
string counts as a slash in the string but is removed before matching
1027
(e.g. ./foo.c, ./src/foo.c)
1029
:return: The translated regex.
1031
if rule[:2] in ('./', '.\\'):
1033
result = fnmatch.translate(rule[2:])
1034
elif '/' in rule or '\\' in rule:
1036
result = fnmatch.translate(rule)
1038
# default rule style.
1039
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1040
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1041
return "(" + result + ")"
1043
def _combine_ignore_rules(self, rules):
1044
"""Combine a list of ignore rules into a single regex object.
1046
Each individual rule is combined with | to form a big regex, which then
1047
has $ added to it to form something like ()|()|()$. The group index for
1048
each subregex's outermost group is placed in a dictionary mapping back
1049
to the rule. This allows quick identification of the matching rule that
1051
:return: a list of the compiled regex and the matching-group index
1052
dictionaries. We return a list because python complains if you try to
1053
combine more than 100 regexes.
1058
translated_rules = []
1060
translated_rule = self._translate_ignore_rule(rule)
1061
compiled_rule = re.compile(translated_rule)
1062
groups[next_group] = rule
1063
next_group += compiled_rule.groups
1064
translated_rules.append(translated_rule)
1065
if next_group == 99:
1066
result.append((re.compile("|".join(translated_rules)), groups))
1069
translated_rules = []
1070
if len(translated_rules):
1071
result.append((re.compile("|".join(translated_rules)), groups))
1074
def ignored_files(self):
1075
"""Yield list of PATH, IGNORE_PATTERN"""
1076
for subp in self.extras():
1077
pat = self.is_ignored(subp)
1081
def get_ignore_list(self):
1082
"""Return list of ignore patterns.
1084
Cached in the Tree object after the first call.
1086
if hasattr(self, '_ignorelist'):
1087
return self._ignorelist
1089
l = bzrlib.DEFAULT_IGNORE[:]
1090
if self.has_filename(bzrlib.IGNORE_FILENAME):
1091
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1092
l.extend([line.rstrip("\n\r").decode('utf-8')
1093
for line in f.readlines()])
1094
self._ignorelist = l
1095
self._ignore_regex = self._combine_ignore_rules(l)
1098
def _get_ignore_rules_as_regex(self):
1099
"""Return a regex of the ignore rules and a mapping dict.
1101
:return: (ignore rules compiled regex, dictionary mapping rule group
1102
indices to original rule.)
1104
if getattr(self, '_ignorelist', None) is None:
1105
self.get_ignore_list()
1106
return self._ignore_regex
1108
def is_ignored(self, filename):
1109
r"""Check whether the filename matches an ignore pattern.
1111
Patterns containing '/' or '\' need to match the whole path;
1112
others match against only the last component.
1114
If the file is ignored, returns the pattern which caused it to
1115
be ignored, otherwise None. So this can simply be used as a
1116
boolean if desired."""
1118
# TODO: Use '**' to match directories, and other extended
1119
# globbing stuff from cvs/rsync.
1121
# XXX: fnmatch is actually not quite what we want: it's only
1122
# approximately the same as real Unix fnmatch, and doesn't
1123
# treat dotfiles correctly and allows * to match /.
1124
# Eventually it should be replaced with something more
1127
rules = self._get_ignore_rules_as_regex()
1128
for regex, mapping in rules:
1129
match = regex.match(filename)
1130
if match is not None:
1131
# one or more of the groups in mapping will have a non-None group
1133
groups = match.groups()
1134
rules = [mapping[group] for group in
1135
mapping if groups[group] is not None]
1139
def kind(self, file_id):
1140
return file_kind(self.id2abspath(file_id))
1143
def last_revision(self):
1144
"""Return the last revision id of this working tree.
1146
In early branch formats this was == the branch last_revision,
1147
but that cannot be relied upon - for working tree operations,
1148
always use tree.last_revision().
1150
return self.branch.last_revision()
1152
def is_locked(self):
1153
return self._control_files.is_locked()
1155
def lock_read(self):
1156
"""See Branch.lock_read, and WorkingTree.unlock."""
1157
self.branch.lock_read()
1159
return self._control_files.lock_read()
1161
self.branch.unlock()
1164
def lock_write(self):
1165
"""See Branch.lock_write, and WorkingTree.unlock."""
1166
self.branch.lock_write()
1168
return self._control_files.lock_write()
1170
self.branch.unlock()
1173
def get_physical_lock_status(self):
1174
return self._control_files.get_physical_lock_status()
1176
def _basis_inventory_name(self):
1177
return 'basis-inventory'
1180
def set_last_revision(self, new_revision):
1181
"""Change the last revision in the working tree."""
1182
if self._change_last_revision(new_revision):
1183
self._cache_basis_inventory(new_revision)
1185
def _change_last_revision(self, new_revision):
1186
"""Template method part of set_last_revision to perform the change.
1188
This is used to allow WorkingTree3 instances to not affect branch
1189
when their last revision is set.
1191
if new_revision is None:
1192
self.branch.set_revision_history([])
1194
# current format is locked in with the branch
1195
revision_history = self.branch.revision_history()
1197
position = revision_history.index(new_revision)
1199
raise errors.NoSuchRevision(self.branch, new_revision)
1200
self.branch.set_revision_history(revision_history[:position + 1])
1203
def _cache_basis_inventory(self, new_revision):
1204
"""Cache new_revision as the basis inventory."""
1205
# TODO: this should allow the ready-to-use inventory to be passed in,
1206
# as commit already has that ready-to-use [while the format is the
1209
# this double handles the inventory - unpack and repack -
1210
# but is easier to understand. We can/should put a conditional
1211
# in here based on whether the inventory is in the latest format
1212
# - perhaps we should repack all inventories on a repository
1214
# the fast path is to copy the raw xml from the repository. If the
1215
# xml contains 'revision_id="', then we assume the right
1216
# revision_id is set. We must check for this full string, because a
1217
# root node id can legitimately look like 'revision_id' but cannot
1219
xml = self.branch.repository.get_inventory_xml(new_revision)
1220
if not 'revision_id="' in xml.split('\n', 1)[0]:
1221
inv = self.branch.repository.deserialise_inventory(
1223
inv.revision_id = new_revision
1224
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1226
path = self._basis_inventory_name()
1227
self._control_files.put_utf8(path, xml)
1228
except WeaveRevisionNotPresent:
1231
def read_basis_inventory(self):
1232
"""Read the cached basis inventory."""
1233
path = self._basis_inventory_name()
1234
return self._control_files.get_utf8(path).read()
1237
def read_working_inventory(self):
1238
"""Read the working inventory."""
1239
# ElementTree does its own conversion from UTF-8, so open in
1241
result = bzrlib.xml5.serializer_v5.read_inventory(
1242
self._control_files.get('inventory'))
1243
self._set_inventory(result)
1247
def remove(self, files, verbose=False, to_file=None):
1248
"""Remove nominated files from the working inventory..
1250
This does not remove their text. This does not run on XXX on what? RBC
1252
TODO: Refuse to remove modified files unless --force is given?
1254
TODO: Do something useful with directories.
1256
TODO: Should this remove the text or not? Tough call; not
1257
removing may be useful and the user can just use use rm, and
1258
is the opposite of add. Removing it is consistent with most
1259
other tools. Maybe an option.
1261
## TODO: Normalize names
1262
## TODO: Remove nested loops; better scalability
1263
if isinstance(files, basestring):
1266
inv = self.inventory
1268
# do this before any modifications
1270
fid = inv.path2id(f)
1272
# TODO: Perhaps make this just a warning, and continue?
1273
# This tends to happen when
1274
raise NotVersionedError(path=f)
1275
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1277
# having remove it, it must be either ignored or unknown
1278
if self.is_ignored(f):
1282
show_status(new_status, inv[fid].kind, quotefn(f), to_file=to_file)
1285
self._write_inventory(inv)
1288
def revert(self, filenames, old_tree=None, backups=True,
1289
pb=DummyProgress()):
1290
from transform import revert
1291
from conflicts import resolve
1292
if old_tree is None:
1293
old_tree = self.basis_tree()
1294
conflicts = revert(self, old_tree, filenames, backups, pb)
1295
if not len(filenames):
1296
self.set_pending_merges([])
1299
resolve(self, filenames, ignore_misses=True)
1302
# XXX: This method should be deprecated in favour of taking in a proper
1303
# new Inventory object.
1305
def set_inventory(self, new_inventory_list):
1306
from bzrlib.inventory import (Inventory,
1311
inv = Inventory(self.get_root_id())
1312
for path, file_id, parent, kind in new_inventory_list:
1313
name = os.path.basename(path)
1316
# fixme, there should be a factory function inv,add_??
1317
if kind == 'directory':
1318
inv.add(InventoryDirectory(file_id, name, parent))
1319
elif kind == 'file':
1320
inv.add(InventoryFile(file_id, name, parent))
1321
elif kind == 'symlink':
1322
inv.add(InventoryLink(file_id, name, parent))
1324
raise BzrError("unknown kind %r" % kind)
1325
self._write_inventory(inv)
1328
def set_root_id(self, file_id):
1329
"""Set the root id for this tree."""
1330
inv = self.read_working_inventory()
1331
orig_root_id = inv.root.file_id
1332
del inv._byid[inv.root.file_id]
1333
inv.root.file_id = file_id
1334
inv._byid[inv.root.file_id] = inv.root
1337
if entry.parent_id == orig_root_id:
1338
entry.parent_id = inv.root.file_id
1339
self._write_inventory(inv)
1342
"""See Branch.unlock.
1344
WorkingTree locking just uses the Branch locking facilities.
1345
This is current because all working trees have an embedded branch
1346
within them. IF in the future, we were to make branch data shareable
1347
between multiple working trees, i.e. via shared storage, then we
1348
would probably want to lock both the local tree, and the branch.
1350
# FIXME: We want to write out the hashcache only when the last lock on
1351
# this working copy is released. Peeking at the lock count is a bit
1352
# of a nasty hack; probably it's better to have a transaction object,
1353
# which can do some finalization when it's either successfully or
1354
# unsuccessfully completed. (Denys's original patch did that.)
1355
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1356
# wrongly. Hookinh into unllock on the control files object is fine though.
1358
# TODO: split this per format so there is no ugly if block
1359
if self._hashcache.needs_write and (
1360
# dedicated lock files
1361
self._control_files._lock_count==1 or
1363
(self._control_files is self.branch.control_files and
1364
self._control_files._lock_count==3)):
1365
self._hashcache.write()
1366
# reverse order of locking.
1368
return self._control_files.unlock()
1370
self.branch.unlock()
1374
"""Update a working tree along its branch.
1376
This will update the branch if its bound too, which means we have
1377
multiple trees involved:
1379
- The new basis tree of the master.
1380
- The old basis tree of the branch.
1381
- The old basis tree of the working tree.
1382
- The current working tree state.
1384
Pathologically, all three may be different, and non-ancestors of each
1385
other. Conceptually we want to:
1387
- Preserve the wt.basis->wt.state changes
1388
- Transform the wt.basis to the new master basis.
1389
- Apply a merge of the old branch basis to get any 'local' changes from
1391
- Restore the wt.basis->wt.state changes.
1393
There isn't a single operation at the moment to do that, so we:
1394
- Merge current state -> basis tree of the master w.r.t. the old tree
1396
- Do a 'normal' merge of the old branch basis if it is relevant.
1398
old_tip = self.branch.update()
1399
if old_tip is not None:
1400
self.add_pending_merge(old_tip)
1401
self.branch.lock_read()
1404
if self.last_revision() != self.branch.last_revision():
1405
# merge tree state up to new branch tip.
1406
basis = self.basis_tree()
1407
to_tree = self.branch.basis_tree()
1408
if basis.inventory.root is None:
1409
self.set_root_id(to_tree.inventory.root.file_id)
1410
result += merge_inner(self.branch,
1414
self.set_last_revision(self.branch.last_revision())
1415
if old_tip and old_tip != self.last_revision():
1416
# our last revision was not the prior branch last reivison
1417
# and we have converted that last revision to a pending merge.
1418
# base is somewhere between the branch tip now
1419
# and the now pending merge
1420
from bzrlib.revision import common_ancestor
1422
base_rev_id = common_ancestor(self.branch.last_revision(),
1424
self.branch.repository)
1425
except errors.NoCommonAncestor:
1427
base_tree = self.branch.repository.revision_tree(base_rev_id)
1428
other_tree = self.branch.repository.revision_tree(old_tip)
1429
result += merge_inner(self.branch,
1435
self.branch.unlock()
1438
def _write_inventory(self, inv):
1439
"""Write inventory as the current inventory."""
1441
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1443
self._control_files.put('inventory', sio)
1444
self._set_inventory(inv)
1445
mutter('wrote working inventory')
1447
def set_conflicts(self, arg):
1448
raise UnsupportedOperation(self.set_conflicts, self)
1451
def conflicts(self):
1452
conflicts = ConflictList()
1453
for conflicted in self._iter_conflicts():
1456
if file_kind(self.abspath(conflicted)) != "file":
1459
if e.errno == errno.ENOENT:
1464
for suffix in ('.THIS', '.OTHER'):
1466
kind = file_kind(self.abspath(conflicted+suffix))
1468
if e.errno == errno.ENOENT:
1476
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1477
conflicts.append(Conflict.factory(ctype, path=conflicted,
1478
file_id=self.path2id(conflicted)))
1482
class WorkingTree3(WorkingTree):
1483
"""This is the Format 3 working tree.
1485
This differs from the base WorkingTree by:
1486
- having its own file lock
1487
- having its own last-revision property.
1489
This is new in bzr 0.8
1493
def last_revision(self):
1494
"""See WorkingTree.last_revision."""
1496
return self._control_files.get_utf8('last-revision').read()
1500
def _change_last_revision(self, revision_id):
1501
"""See WorkingTree._change_last_revision."""
1502
if revision_id is None or revision_id == NULL_REVISION:
1504
self._control_files._transport.delete('last-revision')
1505
except errors.NoSuchFile:
1510
self.branch.revision_history().index(revision_id)
1512
raise errors.NoSuchRevision(self.branch, revision_id)
1513
self._control_files.put_utf8('last-revision', revision_id)
1517
def set_conflicts(self, conflicts):
1518
self._put_rio('conflicts', conflicts.to_stanzas(),
1522
def conflicts(self):
1524
confile = self._control_files.get('conflicts')
1526
return ConflictList()
1528
if confile.next() != CONFLICT_HEADER_1 + '\n':
1529
raise ConflictFormatError()
1530
except StopIteration:
1531
raise ConflictFormatError()
1532
return ConflictList.from_stanzas(RioReader(confile))
1535
def get_conflicted_stem(path):
1536
for suffix in CONFLICT_SUFFIXES:
1537
if path.endswith(suffix):
1538
return path[:-len(suffix)]
1540
@deprecated_function(zero_eight)
1541
def is_control_file(filename):
1542
"""See WorkingTree.is_control_filename(filename)."""
1543
## FIXME: better check
1544
filename = normpath(filename)
1545
while filename != '':
1546
head, tail = os.path.split(filename)
1547
## mutter('check %r for control file' % ((head, tail),))
1550
if filename == head:
1556
class WorkingTreeFormat(object):
1557
"""An encapsulation of the initialization and open routines for a format.
1559
Formats provide three things:
1560
* An initialization routine,
1564
Formats are placed in an dict by their format string for reference
1565
during workingtree opening. Its not required that these be instances, they
1566
can be classes themselves with class methods - it simply depends on
1567
whether state is needed for a given format or not.
1569
Once a format is deprecated, just deprecate the initialize and open
1570
methods on the format class. Do not deprecate the object, as the
1571
object will be created every time regardless.
1574
_default_format = None
1575
"""The default format used for new trees."""
1578
"""The known formats."""
1581
def find_format(klass, a_bzrdir):
1582
"""Return the format for the working tree object in a_bzrdir."""
1584
transport = a_bzrdir.get_workingtree_transport(None)
1585
format_string = transport.get("format").read()
1586
return klass._formats[format_string]
1588
raise errors.NoWorkingTree(base=transport.base)
1590
raise errors.UnknownFormatError(format_string)
1593
def get_default_format(klass):
1594
"""Return the current default format."""
1595
return klass._default_format
1597
def get_format_string(self):
1598
"""Return the ASCII format string that identifies this format."""
1599
raise NotImplementedError(self.get_format_string)
1601
def get_format_description(self):
1602
"""Return the short description for this format."""
1603
raise NotImplementedError(self.get_format_description)
1605
def is_supported(self):
1606
"""Is this format supported?
1608
Supported formats can be initialized and opened.
1609
Unsupported formats may not support initialization or committing or
1610
some other features depending on the reason for not being supported.
1615
def register_format(klass, format):
1616
klass._formats[format.get_format_string()] = format
1619
def set_default_format(klass, format):
1620
klass._default_format = format
1623
def unregister_format(klass, format):
1624
assert klass._formats[format.get_format_string()] is format
1625
del klass._formats[format.get_format_string()]
1629
class WorkingTreeFormat2(WorkingTreeFormat):
1630
"""The second working tree format.
1632
This format modified the hash cache from the format 1 hash cache.
1635
def get_format_description(self):
1636
"""See WorkingTreeFormat.get_format_description()."""
1637
return "Working tree format 2"
1639
def stub_initialize_remote(self, control_files):
1640
"""As a special workaround create critical control files for a remote working tree
1642
This ensures that it can later be updated and dealt with locally,
1643
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1644
no working tree. (See bug #43064).
1648
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1650
control_files.put('inventory', sio)
1652
control_files.put_utf8('pending-merges', '')
1655
def initialize(self, a_bzrdir, revision_id=None):
1656
"""See WorkingTreeFormat.initialize()."""
1657
if not isinstance(a_bzrdir.transport, LocalTransport):
1658
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1659
branch = a_bzrdir.open_branch()
1660
if revision_id is not None:
1663
revision_history = branch.revision_history()
1665
position = revision_history.index(revision_id)
1667
raise errors.NoSuchRevision(branch, revision_id)
1668
branch.set_revision_history(revision_history[:position + 1])
1671
revision = branch.last_revision()
1672
inv = Inventory(root_id=gen_root_id())
1673
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1679
wt.set_last_revision(revision)
1680
basis_tree = wt.basis_tree()
1681
if basis_tree.inventory.root is not None:
1682
inv.root.file_id = basis_tree.inventory.root.file_id
1683
wt._write_inventory(inv)
1684
wt.set_pending_merges([])
1685
build_tree(basis_tree, wt)
1689
super(WorkingTreeFormat2, self).__init__()
1690
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1692
def open(self, a_bzrdir, _found=False):
1693
"""Return the WorkingTree object for a_bzrdir
1695
_found is a private parameter, do not use it. It is used to indicate
1696
if format probing has already been done.
1699
# we are being called directly and must probe.
1700
raise NotImplementedError
1701
if not isinstance(a_bzrdir.transport, LocalTransport):
1702
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1703
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1709
class WorkingTreeFormat3(WorkingTreeFormat):
1710
"""The second working tree format updated to record a format marker.
1713
- exists within a metadir controlling .bzr
1714
- includes an explicit version marker for the workingtree control
1715
files, separate from the BzrDir format
1716
- modifies the hash cache format
1718
- uses a LockDir to guard access to the repository
1721
def get_format_string(self):
1722
"""See WorkingTreeFormat.get_format_string()."""
1723
return "Bazaar-NG Working Tree format 3"
1725
def get_format_description(self):
1726
"""See WorkingTreeFormat.get_format_description()."""
1727
return "Working tree format 3"
1729
_lock_file_name = 'lock'
1730
_lock_class = LockDir
1732
def _open_control_files(self, a_bzrdir):
1733
transport = a_bzrdir.get_workingtree_transport(None)
1734
return LockableFiles(transport, self._lock_file_name,
1737
def initialize(self, a_bzrdir, revision_id=None):
1738
"""See WorkingTreeFormat.initialize().
1740
revision_id allows creating a working tree at a differnet
1741
revision than the branch is at.
1743
if not isinstance(a_bzrdir.transport, LocalTransport):
1744
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1745
transport = a_bzrdir.get_workingtree_transport(self)
1746
control_files = self._open_control_files(a_bzrdir)
1747
control_files.create_lock()
1748
control_files.lock_write()
1749
control_files.put_utf8('format', self.get_format_string())
1750
branch = a_bzrdir.open_branch()
1751
if revision_id is None:
1752
revision_id = branch.last_revision()
1753
inv = Inventory(root_id=gen_root_id())
1754
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1760
_control_files=control_files)
1763
wt.set_last_revision(revision_id)
1764
basis_tree = wt.basis_tree()
1765
wt._write_inventory(inv)
1766
if basis_tree.inventory.root is not None:
1767
inv.root.file_id = basis_tree.inventory.root.file_id
1768
wt.set_pending_merges([])
1769
build_tree(basis_tree, wt)
1772
control_files.unlock()
1776
super(WorkingTreeFormat3, self).__init__()
1777
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1779
def open(self, a_bzrdir, _found=False):
1780
"""Return the WorkingTree object for a_bzrdir
1782
_found is a private parameter, do not use it. It is used to indicate
1783
if format probing has already been done.
1786
# we are being called directly and must probe.
1787
raise NotImplementedError
1788
if not isinstance(a_bzrdir.transport, LocalTransport):
1789
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1790
control_files = self._open_control_files(a_bzrdir)
1791
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1795
_control_files=control_files)
1798
return self.get_format_string()
1801
# formats which have no format string are not discoverable
1802
# and not independently creatable, so are not registered.
1803
__default_format = WorkingTreeFormat3()
1804
WorkingTreeFormat.register_format(__default_format)
1805
WorkingTreeFormat.set_default_format(__default_format)
1806
_legacy_formats = [WorkingTreeFormat2(),
1810
class WorkingTreeTestProviderAdapter(object):
1811
"""A tool to generate a suite testing multiple workingtree formats at once.
1813
This is done by copying the test once for each transport and injecting
1814
the transport_server, transport_readonly_server, and workingtree_format
1815
classes into each copy. Each copy is also given a new id() to make it
1819
def __init__(self, transport_server, transport_readonly_server, formats):
1820
self._transport_server = transport_server
1821
self._transport_readonly_server = transport_readonly_server
1822
self._formats = formats
1824
def adapt(self, test):
1825
from bzrlib.tests import TestSuite
1826
result = TestSuite()
1827
for workingtree_format, bzrdir_format in self._formats:
1828
new_test = deepcopy(test)
1829
new_test.transport_server = self._transport_server
1830
new_test.transport_readonly_server = self._transport_readonly_server
1831
new_test.bzrdir_format = bzrdir_format
1832
new_test.workingtree_format = workingtree_format
1833
def make_new_test_id():
1834
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1835
return lambda: new_id
1836
new_test.id = make_new_test_id()
1837
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
