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
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.trace import mutter, note
101
from bzrlib.transform import build_tree
102
from bzrlib.transport import get_transport
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.textui import show_status
110
# the regex removes any weird characters; we don't escape them
111
# but rather just pull them out
112
_gen_file_id_re = re.compile(r'[^\w.]')
113
_gen_id_suffix = None
117
def _next_id_suffix():
118
"""Create a new file id suffix that is reasonably unique.
120
On the first call we combine the current time with 64 bits of randomness
121
to give a highly probably globally unique number. Then each call in the same
122
process adds 1 to a serial number we append to that unique value.
124
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
125
# than having to move the id randomness out of the inner loop like this.
126
# XXX TODO: for the global randomness this uses we should add the thread-id
127
# before the serial #.
128
global _gen_id_suffix, _gen_id_serial
129
if _gen_id_suffix is None:
130
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
132
return _gen_id_suffix + str(_gen_id_serial)
135
def gen_file_id(name):
136
"""Return new file id for the basename 'name'.
138
The uniqueness is supplied from _next_id_suffix.
140
# The real randomness is in the _next_id_suffix, the
141
# rest of the identifier is just to be nice.
143
# 1) Remove non-ascii word characters to keep the ids portable
144
# 2) squash to lowercase, so the file id doesn't have to
145
# be escaped (case insensitive filesystems would bork for ids
146
# that only differred in case without escaping).
147
# 3) truncate the filename to 20 chars. Long filenames also bork on some
149
# 4) Removing starting '.' characters to prevent the file ids from
150
# being considered hidden.
151
ascii_word_only = _gen_file_id_re.sub('', name.lower())
152
short_no_dots = ascii_word_only.lstrip('.')[:20]
153
return short_no_dots + _next_id_suffix()
157
"""Return a new tree-root file id."""
158
return gen_file_id('TREE_ROOT')
161
class TreeEntry(object):
162
"""An entry that implements the minimum interface used by commands.
164
This needs further inspection, it may be better to have
165
InventoryEntries without ids - though that seems wrong. For now,
166
this is a parallel hierarchy to InventoryEntry, and needs to become
167
one of several things: decorates to that hierarchy, children of, or
169
Another note is that these objects are currently only used when there is
170
no InventoryEntry available - i.e. for unversioned objects.
171
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
174
def __eq__(self, other):
175
# yes, this us ugly, TODO: best practice __eq__ style.
176
return (isinstance(other, TreeEntry)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeDirectory(TreeEntry):
184
"""See TreeEntry. This is a directory in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeDirectory)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeFile(TreeEntry):
195
"""See TreeEntry. This is a regular file in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeFile)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class TreeLink(TreeEntry):
206
"""See TreeEntry. This is a symlink in a working tree."""
208
def __eq__(self, other):
209
return (isinstance(other, TreeLink)
210
and other.__class__ == self.__class__)
212
def kind_character(self):
216
class WorkingTree(bzrlib.tree.Tree):
217
"""Working copy tree.
219
The inventory is held in the `Branch` working-inventory, and the
220
files are in a directory on disk.
222
It is possible for a `WorkingTree` to have a filename which is
223
not listed in the Inventory and vice versa.
226
def __init__(self, basedir='.',
227
branch=DEPRECATED_PARAMETER,
233
"""Construct a WorkingTree for basedir.
235
If the branch is not supplied, it is opened automatically.
236
If the branch is supplied, it must be the branch for this basedir.
237
(branch.base is not cross checked, because for remote branches that
238
would be meaningless).
240
self._format = _format
241
self.bzrdir = _bzrdir
243
# not created via open etc.
244
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
245
"Please use bzrdir.open_workingtree or WorkingTree.open().",
248
wt = WorkingTree.open(basedir)
249
self._branch = wt.branch
250
self.basedir = wt.basedir
251
self._control_files = wt._control_files
252
self._hashcache = wt._hashcache
253
self._set_inventory(wt._inventory)
254
self._format = wt._format
255
self.bzrdir = wt.bzrdir
256
from bzrlib.hashcache import HashCache
257
from bzrlib.trace import note, mutter
258
assert isinstance(basedir, basestring), \
259
"base directory %r is not a string" % basedir
260
basedir = safe_unicode(basedir)
261
mutter("opening working tree %r", basedir)
262
if deprecated_passed(branch):
264
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
265
" Please use bzrdir.open_workingtree() or"
266
" WorkingTree.open().",
270
self._branch = branch
272
self._branch = self.bzrdir.open_branch()
273
self.basedir = realpath(basedir)
274
# if branch is at our basedir and is a format 6 or less
275
if isinstance(self._format, WorkingTreeFormat2):
276
# share control object
277
self._control_files = self.branch.control_files
279
# assume all other formats have their own control files.
280
assert isinstance(_control_files, LockableFiles), \
281
"_control_files must be a LockableFiles, not %r" \
283
self._control_files = _control_files
284
# update the whole cache up front and write to disk if anything changed;
285
# in the future we might want to do this more selectively
286
# two possible ways offer themselves : in self._unlock, write the cache
287
# if needed, or, when the cache sees a change, append it to the hash
288
# cache file, and have the parser take the most recent entry for a
290
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
291
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
293
# is this scan needed ? it makes things kinda slow.
300
if _inventory is None:
301
self._set_inventory(self.read_working_inventory())
303
self._set_inventory(_inventory)
306
fget=lambda self: self._branch,
307
doc="""The branch this WorkingTree is connected to.
309
This cannot be set - it is reflective of the actual disk structure
310
the working tree has been constructed from.
313
def break_lock(self):
314
"""Break a lock if one is present from another instance.
316
Uses the ui factory to ask for confirmation if the lock may be from
319
This will probe the repository for its lock as well.
321
self._control_files.break_lock()
322
self.branch.break_lock()
324
def _set_inventory(self, inv):
325
self._inventory = inv
326
self.path2id = self._inventory.path2id
328
def is_control_filename(self, filename):
329
"""True if filename is the name of a control file in this tree.
331
:param filename: A filename within the tree. This is a relative path
332
from the root of this tree.
334
This is true IF and ONLY IF the filename is part of the meta data
335
that bzr controls in this tree. I.E. a random .bzr directory placed
336
on disk will not be a control file for this tree.
338
return self.bzrdir.is_control_filename(filename)
341
def open(path=None, _unsupported=False):
342
"""Open an existing working tree at path.
346
path = os.path.getcwdu()
347
control = bzrdir.BzrDir.open(path, _unsupported)
348
return control.open_workingtree(_unsupported)
351
def open_containing(path=None):
352
"""Open an existing working tree which has its root about path.
354
This probes for a working tree at path and searches upwards from there.
356
Basically we keep looking up until we find the control directory or
357
run into /. If there isn't one, raises NotBranchError.
358
TODO: give this a new exception.
359
If there is one, it is returned, along with the unused portion of path.
361
:return: The WorkingTree that contains 'path', and the rest of path
364
path = osutils.getcwd()
365
control, relpath = bzrdir.BzrDir.open_containing(path)
367
return control.open_workingtree(), relpath
370
def open_downlevel(path=None):
371
"""Open an unsupported working tree.
373
Only intended for advanced situations like upgrading part of a bzrdir.
375
return WorkingTree.open(path, _unsupported=True)
378
"""Iterate through file_ids for this tree.
380
file_ids are in a WorkingTree if they are in the working inventory
381
and the working file exists.
383
inv = self._inventory
384
for path, ie in inv.iter_entries():
385
if osutils.lexists(self.abspath(path)):
389
return "<%s of %s>" % (self.__class__.__name__,
390
getattr(self, 'basedir', None))
392
def abspath(self, filename):
393
return pathjoin(self.basedir, filename)
395
def basis_tree(self):
396
"""Return RevisionTree for the current last revision."""
397
revision_id = self.last_revision()
398
if revision_id is not None:
400
xml = self.read_basis_inventory()
401
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
404
if inv is not None and inv.revision_id == revision_id:
405
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
407
# FIXME? RBC 20060403 should we cache the inventory here ?
408
return self.branch.repository.revision_tree(revision_id)
411
@deprecated_method(zero_eight)
412
def create(branch, directory):
413
"""Create a workingtree for branch at directory.
415
If existing_directory already exists it must have a .bzr directory.
416
If it does not exist, it will be created.
418
This returns a new WorkingTree object for the new checkout.
420
TODO FIXME RBC 20060124 when we have checkout formats in place this
421
should accept an optional revisionid to checkout [and reject this if
422
checking out into the same dir as a pre-checkout-aware branch format.]
424
XXX: When BzrDir is present, these should be created through that
427
warnings.warn('delete WorkingTree.create', stacklevel=3)
428
transport = get_transport(directory)
429
if branch.bzrdir.root_transport.base == transport.base:
431
return branch.bzrdir.create_workingtree()
432
# different directory,
433
# create a branch reference
434
# and now a working tree.
435
raise NotImplementedError
438
@deprecated_method(zero_eight)
439
def create_standalone(directory):
440
"""Create a checkout and a branch and a repo at directory.
442
Directory must exist and be empty.
444
please use BzrDir.create_standalone_workingtree
446
return bzrdir.BzrDir.create_standalone_workingtree(directory)
448
def relpath(self, path):
449
"""Return the local path portion from a given path.
451
The path may be absolute or relative. If its a relative path it is
452
interpreted relative to the python current working directory.
454
return relpath(self.basedir, path)
456
def has_filename(self, filename):
457
return osutils.lexists(self.abspath(filename))
459
def get_file(self, file_id):
460
return self.get_file_byname(self.id2path(file_id))
462
def get_file_byname(self, filename):
463
return file(self.abspath(filename), 'rb')
465
def get_parent_ids(self):
466
"""See Tree.get_parent_ids.
468
This implementation reads the pending merges list and last_revision
469
value and uses that to decide what the parents list should be.
471
last_rev = self.last_revision()
476
other_parents = self.pending_merges()
477
return parents + other_parents
479
def get_root_id(self):
480
"""Return the id of this trees root"""
481
inv = self.read_working_inventory()
482
return inv.root.file_id
484
def _get_store_filename(self, file_id):
485
## XXX: badly named; this is not in the store at all
486
return self.abspath(self.id2path(file_id))
489
def clone(self, to_bzrdir, revision_id=None, basis=None):
490
"""Duplicate this working tree into to_bzr, including all state.
492
Specifically modified files are kept as modified, but
493
ignored and unknown files are discarded.
495
If you want to make a new line of development, see bzrdir.sprout()
498
If not None, the cloned tree will have its last revision set to
499
revision, and and difference between the source trees last revision
500
and this one merged in.
503
If not None, a closer copy of a tree which may have some files in
504
common, and which file content should be preferentially copied from.
506
# assumes the target bzr dir format is compatible.
507
result = self._format.initialize(to_bzrdir)
508
self.copy_content_into(result, revision_id)
512
def copy_content_into(self, tree, revision_id=None):
513
"""Copy the current content and user files of this tree into tree."""
514
if revision_id is None:
515
transform_tree(tree, self)
517
# TODO now merge from tree.last_revision to revision
518
transform_tree(tree, self)
519
tree.set_last_revision(revision_id)
522
def commit(self, message=None, revprops=None, *args, **kwargs):
523
# avoid circular imports
524
from bzrlib.commit import Commit
527
if not 'branch-nick' in revprops:
528
revprops['branch-nick'] = self.branch.nick
529
# args for wt.commit start at message from the Commit.commit method,
530
# but with branch a kwarg now, passing in args as is results in the
531
#message being used for the branch
532
args = (DEPRECATED_PARAMETER, message, ) + args
533
committed_id = Commit().commit( working_tree=self, revprops=revprops,
535
self._set_inventory(self.read_working_inventory())
538
def id2abspath(self, file_id):
539
return self.abspath(self.id2path(file_id))
541
def has_id(self, file_id):
542
# files that have been deleted are excluded
543
inv = self._inventory
544
if not inv.has_id(file_id):
546
path = inv.id2path(file_id)
547
return osutils.lexists(self.abspath(path))
549
def has_or_had_id(self, file_id):
550
if file_id == self.inventory.root.file_id:
552
return self.inventory.has_id(file_id)
554
__contains__ = has_id
556
def get_file_size(self, file_id):
557
return os.path.getsize(self.id2abspath(file_id))
560
def get_file_sha1(self, file_id, path=None):
562
path = self._inventory.id2path(file_id)
563
return self._hashcache.get_sha1(path)
565
def get_file_mtime(self, file_id, path=None):
567
path = self._inventory.id2path(file_id)
568
return os.lstat(self.abspath(path)).st_mtime
570
if not supports_executable():
571
def is_executable(self, file_id, path=None):
572
return self._inventory[file_id].executable
574
def is_executable(self, file_id, path=None):
576
path = self._inventory.id2path(file_id)
577
mode = os.lstat(self.abspath(path)).st_mode
578
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
581
def add(self, files, ids=None):
582
"""Make files versioned.
584
Note that the command line normally calls smart_add instead,
585
which can automatically recurse.
587
This adds the files to the inventory, so that they will be
588
recorded by the next commit.
591
List of paths to add, relative to the base of the tree.
594
If set, use these instead of automatically generated ids.
595
Must be the same length as the list of files, but may
596
contain None for ids that are to be autogenerated.
598
TODO: Perhaps have an option to add the ids even if the files do
601
TODO: Perhaps callback with the ids and paths as they're added.
603
# TODO: Re-adding a file that is removed in the working copy
604
# should probably put it back with the previous ID.
605
if isinstance(files, basestring):
606
assert(ids is None or isinstance(ids, basestring))
612
ids = [None] * len(files)
614
assert(len(ids) == len(files))
616
inv = self.read_working_inventory()
617
for f,file_id in zip(files, ids):
618
if self.is_control_filename(f):
619
raise errors.ForbiddenControlFileError(filename=f)
624
raise BzrError("cannot add top-level %r" % f)
626
fullpath = normpath(self.abspath(f))
628
kind = file_kind(fullpath)
630
if e.errno == errno.ENOENT:
631
raise NoSuchFile(fullpath)
632
if not InventoryEntry.versionable_kind(kind):
633
raise errors.BadFileKindError(filename=f, kind=kind)
635
inv.add_path(f, kind=kind)
637
inv.add_path(f, kind=kind, file_id=file_id)
639
self._write_inventory(inv)
642
def add_pending_merge(self, *revision_ids):
643
# TODO: Perhaps should check at this point that the
644
# history of the revision is actually present?
645
p = self.pending_merges()
647
for rev_id in revision_ids:
653
self.set_pending_merges(p)
656
def pending_merges(self):
657
"""Return a list of pending merges.
659
These are revisions that have been merged into the working
660
directory but not yet committed.
663
merges_file = self._control_files.get_utf8('pending-merges')
667
for l in merges_file.readlines():
668
p.append(l.rstrip('\n'))
672
def set_pending_merges(self, rev_list):
673
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
676
def set_merge_modified(self, modified_hashes):
678
for file_id, hash in modified_hashes.iteritems():
679
yield Stanza(file_id=file_id, hash=hash)
680
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
683
def _put_rio(self, filename, stanzas, header):
684
my_file = rio_file(stanzas, header)
685
self._control_files.put(filename, my_file)
688
def merge_modified(self):
690
hashfile = self._control_files.get('merge-hashes')
695
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
696
raise MergeModifiedFormatError()
697
except StopIteration:
698
raise MergeModifiedFormatError()
699
for s in RioReader(hashfile):
700
file_id = s.get("file_id")
701
if file_id not in self.inventory:
704
if hash == self.get_file_sha1(file_id):
705
merge_hashes[file_id] = hash
708
def get_symlink_target(self, file_id):
709
return os.readlink(self.id2abspath(file_id))
711
def file_class(self, filename):
712
if self.path2id(filename):
714
elif self.is_ignored(filename):
719
def list_files(self):
720
"""Recursively list all files as (path, class, kind, id, entry).
722
Lists, but does not descend into unversioned directories.
724
This does not include files that have been deleted in this
727
Skips the control directory.
729
inv = self._inventory
730
# Convert these into local objects to save lookup times
731
pathjoin = osutils.pathjoin
732
file_kind = osutils.file_kind
734
# transport.base ends in a slash, we want the piece
735
# between the last two slashes
736
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
738
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
740
# directory file_id, relative path, absolute path, reverse sorted children
741
children = os.listdir(self.basedir)
743
# jam 20060527 The kernel sized tree seems equivalent whether we
744
# use a deque and popleft to keep them sorted, or if we use a plain
745
# list and just reverse() them.
746
children = collections.deque(children)
747
stack = [(inv.root.file_id, u'', self.basedir, children)]
749
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
752
f = children.popleft()
753
## TODO: If we find a subdirectory with its own .bzr
754
## directory, then that is a separate tree and we
755
## should exclude it.
757
# the bzrdir for this tree
758
if transport_base_dir == f:
761
# we know that from_dir_relpath and from_dir_abspath never end in a slash
762
# and 'f' doesn't begin with one, we can do a string op, rather
763
# than the checks of pathjoin(), all relative paths will have an extra slash
765
fp = from_dir_relpath + '/' + f
768
fap = from_dir_abspath + '/' + f
770
f_ie = inv.get_child(from_dir_id, f)
773
elif self.is_ignored(fp[1:]):
776
# we may not have found this file, because of a unicode issue
777
f_norm, can_access = osutils.normalized_filename(f)
778
if f == f_norm or not can_access:
779
# No change, so treat this file normally
782
# this file can be accessed by a normalized path
783
# check again if it is versioned
784
# these lines are repeated here for performance
786
fp = from_dir_relpath + '/' + f
787
fap = from_dir_abspath + '/' + f
788
f_ie = inv.get_child(from_dir_id, f)
791
elif self.is_ignored(fp[1:]):
800
raise BzrCheckError("file %r entered as kind %r id %r, "
802
% (fap, f_ie.kind, f_ie.file_id, fk))
804
# make a last minute entry
806
yield fp[1:], c, fk, f_ie.file_id, f_ie
809
yield fp[1:], c, fk, None, fk_entries[fk]()
811
yield fp[1:], c, fk, None, TreeEntry()
814
if fk != 'directory':
817
# But do this child first
818
new_children = os.listdir(fap)
820
new_children = collections.deque(new_children)
821
stack.append((f_ie.file_id, fp, fap, new_children))
822
# Break out of inner loop, so that we start outer loop with child
825
# if we finished all children, pop it off the stack
830
def move(self, from_paths, to_name):
833
to_name must exist in the inventory.
835
If to_name exists and is a directory, the files are moved into
836
it, keeping their old names.
838
Note that to_name is only the last component of the new name;
839
this doesn't change the directory.
841
This returns a list of (from_path, to_path) pairs for each
845
## TODO: Option to move IDs only
846
assert not isinstance(from_paths, basestring)
848
to_abs = self.abspath(to_name)
849
if not isdir(to_abs):
850
raise BzrError("destination %r is not a directory" % to_abs)
851
if not self.has_filename(to_name):
852
raise BzrError("destination %r not in working directory" % to_abs)
853
to_dir_id = inv.path2id(to_name)
854
if to_dir_id == None and to_name != '':
855
raise BzrError("destination %r is not a versioned directory" % to_name)
856
to_dir_ie = inv[to_dir_id]
857
if to_dir_ie.kind not in ('directory', 'root_directory'):
858
raise BzrError("destination %r is not a directory" % to_abs)
860
to_idpath = inv.get_idpath(to_dir_id)
863
if not self.has_filename(f):
864
raise BzrError("%r does not exist in working tree" % f)
865
f_id = inv.path2id(f)
867
raise BzrError("%r is not versioned" % f)
868
name_tail = splitpath(f)[-1]
869
dest_path = pathjoin(to_name, name_tail)
870
if self.has_filename(dest_path):
871
raise BzrError("destination %r already exists" % dest_path)
872
if f_id in to_idpath:
873
raise BzrError("can't move %r to a subdirectory of itself" % f)
875
# OK, so there's a race here, it's possible that someone will
876
# create a file in this interval and then the rename might be
877
# left half-done. But we should have caught most problems.
878
orig_inv = deepcopy(self.inventory)
881
name_tail = splitpath(f)[-1]
882
dest_path = pathjoin(to_name, name_tail)
883
result.append((f, dest_path))
884
inv.rename(inv.path2id(f), to_dir_id, name_tail)
886
rename(self.abspath(f), self.abspath(dest_path))
888
raise BzrError("failed to rename %r to %r: %s" %
889
(f, dest_path, e[1]),
890
["rename rolled back"])
892
# restore the inventory on error
893
self._set_inventory(orig_inv)
895
self._write_inventory(inv)
899
def rename_one(self, from_rel, to_rel):
902
This can change the directory or the filename or both.
905
if not self.has_filename(from_rel):
906
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
907
if self.has_filename(to_rel):
908
raise BzrError("can't rename: new working file %r already exists" % to_rel)
910
file_id = inv.path2id(from_rel)
912
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
915
from_parent = entry.parent_id
916
from_name = entry.name
918
if inv.path2id(to_rel):
919
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
921
to_dir, to_tail = os.path.split(to_rel)
922
to_dir_id = inv.path2id(to_dir)
923
if to_dir_id == None and to_dir != '':
924
raise BzrError("can't determine destination directory id for %r" % to_dir)
926
mutter("rename_one:")
927
mutter(" file_id {%s}" % file_id)
928
mutter(" from_rel %r" % from_rel)
929
mutter(" to_rel %r" % to_rel)
930
mutter(" to_dir %r" % to_dir)
931
mutter(" to_dir_id {%s}" % to_dir_id)
933
inv.rename(file_id, to_dir_id, to_tail)
935
from_abs = self.abspath(from_rel)
936
to_abs = self.abspath(to_rel)
938
rename(from_abs, to_abs)
940
inv.rename(file_id, from_parent, from_name)
941
raise BzrError("failed to rename %r to %r: %s"
942
% (from_abs, to_abs, e[1]),
943
["rename rolled back"])
944
self._write_inventory(inv)
948
"""Return all unknown files.
950
These are files in the working directory that are not versioned or
951
control files or ignored.
953
for subp in self.extras():
954
if not self.is_ignored(subp):
957
@deprecated_method(zero_eight)
958
def iter_conflicts(self):
959
"""List all files in the tree that have text or content conflicts.
960
DEPRECATED. Use conflicts instead."""
961
return self._iter_conflicts()
963
def _iter_conflicts(self):
965
for info in self.list_files():
967
stem = get_conflicted_stem(path)
970
if stem not in conflicted:
975
def pull(self, source, overwrite=False, stop_revision=None):
976
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
979
pp = ProgressPhase("Pull phase", 2, top_pb)
981
old_revision_history = self.branch.revision_history()
982
basis_tree = self.basis_tree()
983
count = self.branch.pull(source, overwrite, stop_revision)
984
new_revision_history = self.branch.revision_history()
985
if new_revision_history != old_revision_history:
987
if len(old_revision_history):
988
other_revision = old_revision_history[-1]
990
other_revision = None
991
repository = self.branch.repository
992
pb = bzrlib.ui.ui_factory.nested_progress_bar()
994
merge_inner(self.branch,
995
self.branch.basis_tree(),
1001
self.set_last_revision(self.branch.last_revision())
1008
"""Yield all unknown files in this WorkingTree.
1010
If there are any unknown directories then only the directory is
1011
returned, not all its children. But if there are unknown files
1012
under a versioned subdirectory, they are returned.
1014
Currently returned depth-first, sorted by name within directories.
1016
## TODO: Work from given directory downwards
1017
for path, dir_entry in self.inventory.directories():
1018
mutter("search for unknowns in %r", path)
1019
dirabs = self.abspath(path)
1020
if not isdir(dirabs):
1021
# e.g. directory deleted
1025
for subf in os.listdir(dirabs):
1028
if subf not in dir_entry.children:
1029
subf_norm, can_access = osutils.normalized_filename(subf)
1030
if subf_norm != subf and can_access:
1031
if subf_norm not in dir_entry.children:
1032
fl.append(subf_norm)
1038
subp = pathjoin(path, subf)
1041
def _translate_ignore_rule(self, rule):
1042
"""Translate a single ignore rule to a regex.
1044
There are two types of ignore rules. Those that do not contain a / are
1045
matched against the tail of the filename (that is, they do not care
1046
what directory the file is in.) Rules which do contain a slash must
1047
match the entire path. As a special case, './' at the start of the
1048
string counts as a slash in the string but is removed before matching
1049
(e.g. ./foo.c, ./src/foo.c)
1051
:return: The translated regex.
1053
if rule[:2] in ('./', '.\\'):
1055
result = fnmatch.translate(rule[2:])
1056
elif '/' in rule or '\\' in rule:
1058
result = fnmatch.translate(rule)
1060
# default rule style.
1061
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1062
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1063
return "(" + result + ")"
1065
def _combine_ignore_rules(self, rules):
1066
"""Combine a list of ignore rules into a single regex object.
1068
Each individual rule is combined with | to form a big regex, which then
1069
has $ added to it to form something like ()|()|()$. The group index for
1070
each subregex's outermost group is placed in a dictionary mapping back
1071
to the rule. This allows quick identification of the matching rule that
1073
:return: a list of the compiled regex and the matching-group index
1074
dictionaries. We return a list because python complains if you try to
1075
combine more than 100 regexes.
1080
translated_rules = []
1082
translated_rule = self._translate_ignore_rule(rule)
1083
compiled_rule = re.compile(translated_rule)
1084
groups[next_group] = rule
1085
next_group += compiled_rule.groups
1086
translated_rules.append(translated_rule)
1087
if next_group == 99:
1088
result.append((re.compile("|".join(translated_rules)), groups))
1091
translated_rules = []
1092
if len(translated_rules):
1093
result.append((re.compile("|".join(translated_rules)), groups))
1096
def ignored_files(self):
1097
"""Yield list of PATH, IGNORE_PATTERN"""
1098
for subp in self.extras():
1099
pat = self.is_ignored(subp)
1103
def get_ignore_list(self):
1104
"""Return list of ignore patterns.
1106
Cached in the Tree object after the first call.
1108
ignorelist = getattr(self, '_ignorelist', None)
1109
if ignorelist is not None:
1112
ignore_globs = bzrlib.DEFAULT_IGNORE[:]
1114
ignore_globs.extend(ignores.get_user_ignores())
1116
if self.has_filename(bzrlib.IGNORE_FILENAME):
1117
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1119
ignore_globs.extend(ignores.parse_ignore_file(f))
1123
self._ignorelist = ignore_globs
1124
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1127
def _get_ignore_rules_as_regex(self):
1128
"""Return a regex of the ignore rules and a mapping dict.
1130
:return: (ignore rules compiled regex, dictionary mapping rule group
1131
indices to original rule.)
1133
if getattr(self, '_ignorelist', None) is None:
1134
self.get_ignore_list()
1135
return self._ignore_regex
1137
def is_ignored(self, filename):
1138
r"""Check whether the filename matches an ignore pattern.
1140
Patterns containing '/' or '\' need to match the whole path;
1141
others match against only the last component.
1143
If the file is ignored, returns the pattern which caused it to
1144
be ignored, otherwise None. So this can simply be used as a
1145
boolean if desired."""
1147
# TODO: Use '**' to match directories, and other extended
1148
# globbing stuff from cvs/rsync.
1150
# XXX: fnmatch is actually not quite what we want: it's only
1151
# approximately the same as real Unix fnmatch, and doesn't
1152
# treat dotfiles correctly and allows * to match /.
1153
# Eventually it should be replaced with something more
1156
rules = self._get_ignore_rules_as_regex()
1157
for regex, mapping in rules:
1158
match = regex.match(filename)
1159
if match is not None:
1160
# one or more of the groups in mapping will have a non-None group
1162
groups = match.groups()
1163
rules = [mapping[group] for group in
1164
mapping if groups[group] is not None]
1168
def kind(self, file_id):
1169
return file_kind(self.id2abspath(file_id))
1172
def last_revision(self):
1173
"""Return the last revision id of this working tree.
1175
In early branch formats this was == the branch last_revision,
1176
but that cannot be relied upon - for working tree operations,
1177
always use tree.last_revision().
1179
return self.branch.last_revision()
1181
def is_locked(self):
1182
return self._control_files.is_locked()
1184
def lock_read(self):
1185
"""See Branch.lock_read, and WorkingTree.unlock."""
1186
self.branch.lock_read()
1188
return self._control_files.lock_read()
1190
self.branch.unlock()
1193
def lock_write(self):
1194
"""See Branch.lock_write, and WorkingTree.unlock."""
1195
self.branch.lock_write()
1197
return self._control_files.lock_write()
1199
self.branch.unlock()
1202
def get_physical_lock_status(self):
1203
return self._control_files.get_physical_lock_status()
1205
def _basis_inventory_name(self):
1206
return 'basis-inventory'
1209
def set_last_revision(self, new_revision):
1210
"""Change the last revision in the working tree."""
1211
if self._change_last_revision(new_revision):
1212
self._cache_basis_inventory(new_revision)
1214
def _change_last_revision(self, new_revision):
1215
"""Template method part of set_last_revision to perform the change.
1217
This is used to allow WorkingTree3 instances to not affect branch
1218
when their last revision is set.
1220
if new_revision is None:
1221
self.branch.set_revision_history([])
1223
# current format is locked in with the branch
1224
revision_history = self.branch.revision_history()
1226
position = revision_history.index(new_revision)
1228
raise errors.NoSuchRevision(self.branch, new_revision)
1229
self.branch.set_revision_history(revision_history[:position + 1])
1232
def _cache_basis_inventory(self, new_revision):
1233
"""Cache new_revision as the basis inventory."""
1234
# TODO: this should allow the ready-to-use inventory to be passed in,
1235
# as commit already has that ready-to-use [while the format is the
1238
# this double handles the inventory - unpack and repack -
1239
# but is easier to understand. We can/should put a conditional
1240
# in here based on whether the inventory is in the latest format
1241
# - perhaps we should repack all inventories on a repository
1243
# the fast path is to copy the raw xml from the repository. If the
1244
# xml contains 'revision_id="', then we assume the right
1245
# revision_id is set. We must check for this full string, because a
1246
# root node id can legitimately look like 'revision_id' but cannot
1248
xml = self.branch.repository.get_inventory_xml(new_revision)
1249
if not 'revision_id="' in xml.split('\n', 1)[0]:
1250
inv = self.branch.repository.deserialise_inventory(
1252
inv.revision_id = new_revision
1253
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1254
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1255
path = self._basis_inventory_name()
1257
self._control_files.put(path, sio)
1258
except WeaveRevisionNotPresent:
1261
def read_basis_inventory(self):
1262
"""Read the cached basis inventory."""
1263
path = self._basis_inventory_name()
1264
return self._control_files.get(path).read()
1267
def read_working_inventory(self):
1268
"""Read the working inventory."""
1269
# ElementTree does its own conversion from UTF-8, so open in
1271
result = bzrlib.xml5.serializer_v5.read_inventory(
1272
self._control_files.get('inventory'))
1273
self._set_inventory(result)
1277
def remove(self, files, verbose=False, to_file=None):
1278
"""Remove nominated files from the working inventory..
1280
This does not remove their text. This does not run on XXX on what? RBC
1282
TODO: Refuse to remove modified files unless --force is given?
1284
TODO: Do something useful with directories.
1286
TODO: Should this remove the text or not? Tough call; not
1287
removing may be useful and the user can just use use rm, and
1288
is the opposite of add. Removing it is consistent with most
1289
other tools. Maybe an option.
1291
## TODO: Normalize names
1292
## TODO: Remove nested loops; better scalability
1293
if isinstance(files, basestring):
1296
inv = self.inventory
1298
# do this before any modifications
1300
fid = inv.path2id(f)
1302
# TODO: Perhaps make this just a warning, and continue?
1303
# This tends to happen when
1304
raise NotVersionedError(path=f)
1306
# having remove it, it must be either ignored or unknown
1307
if self.is_ignored(f):
1311
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1314
self._write_inventory(inv)
1317
def revert(self, filenames, old_tree=None, backups=True,
1318
pb=DummyProgress()):
1319
from transform import revert
1320
from conflicts import resolve
1321
if old_tree is None:
1322
old_tree = self.basis_tree()
1323
conflicts = revert(self, old_tree, filenames, backups, pb)
1324
if not len(filenames):
1325
self.set_pending_merges([])
1328
resolve(self, filenames, ignore_misses=True)
1331
# XXX: This method should be deprecated in favour of taking in a proper
1332
# new Inventory object.
1334
def set_inventory(self, new_inventory_list):
1335
from bzrlib.inventory import (Inventory,
1340
inv = Inventory(self.get_root_id())
1341
for path, file_id, parent, kind in new_inventory_list:
1342
name = os.path.basename(path)
1345
# fixme, there should be a factory function inv,add_??
1346
if kind == 'directory':
1347
inv.add(InventoryDirectory(file_id, name, parent))
1348
elif kind == 'file':
1349
inv.add(InventoryFile(file_id, name, parent))
1350
elif kind == 'symlink':
1351
inv.add(InventoryLink(file_id, name, parent))
1353
raise BzrError("unknown kind %r" % kind)
1354
self._write_inventory(inv)
1357
def set_root_id(self, file_id):
1358
"""Set the root id for this tree."""
1359
inv = self.read_working_inventory()
1360
orig_root_id = inv.root.file_id
1361
del inv._byid[inv.root.file_id]
1362
inv.root.file_id = file_id
1363
inv._byid[inv.root.file_id] = inv.root
1366
if entry.parent_id == orig_root_id:
1367
entry.parent_id = inv.root.file_id
1368
self._write_inventory(inv)
1371
"""See Branch.unlock.
1373
WorkingTree locking just uses the Branch locking facilities.
1374
This is current because all working trees have an embedded branch
1375
within them. IF in the future, we were to make branch data shareable
1376
between multiple working trees, i.e. via shared storage, then we
1377
would probably want to lock both the local tree, and the branch.
1379
# FIXME: We want to write out the hashcache only when the last lock on
1380
# this working copy is released. Peeking at the lock count is a bit
1381
# of a nasty hack; probably it's better to have a transaction object,
1382
# which can do some finalization when it's either successfully or
1383
# unsuccessfully completed. (Denys's original patch did that.)
1384
# RBC 20060206 hooking into transaction will couple lock and transaction
1385
# wrongly. Hooking into unlock on the control files object is fine though.
1387
# TODO: split this per format so there is no ugly if block
1388
if self._hashcache.needs_write and (
1389
# dedicated lock files
1390
self._control_files._lock_count==1 or
1392
(self._control_files is self.branch.control_files and
1393
self._control_files._lock_count==3)):
1394
self._hashcache.write()
1395
# reverse order of locking.
1397
return self._control_files.unlock()
1399
self.branch.unlock()
1403
"""Update a working tree along its branch.
1405
This will update the branch if its bound too, which means we have multiple trees involved:
1406
The new basis tree of the master.
1407
The old basis tree of the branch.
1408
The old basis tree of the working tree.
1409
The current working tree state.
1410
pathologically all three may be different, and non ancestors of each other.
1411
Conceptually we want to:
1412
Preserve the wt.basis->wt.state changes
1413
Transform the wt.basis to the new master basis.
1414
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1415
Restore the wt.basis->wt.state changes.
1417
There isn't a single operation at the moment to do that, so we:
1418
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1419
Do a 'normal' merge of the old branch basis if it is relevant.
1421
old_tip = self.branch.update()
1422
if old_tip is not None:
1423
self.add_pending_merge(old_tip)
1424
self.branch.lock_read()
1427
if self.last_revision() != self.branch.last_revision():
1428
# merge tree state up to new branch tip.
1429
basis = self.basis_tree()
1430
to_tree = self.branch.basis_tree()
1431
result += merge_inner(self.branch,
1435
self.set_last_revision(self.branch.last_revision())
1436
if old_tip and old_tip != self.last_revision():
1437
# our last revision was not the prior branch last revision
1438
# and we have converted that last revision to a pending merge.
1439
# base is somewhere between the branch tip now
1440
# and the now pending merge
1441
from bzrlib.revision import common_ancestor
1443
base_rev_id = common_ancestor(self.branch.last_revision(),
1445
self.branch.repository)
1446
except errors.NoCommonAncestor:
1448
base_tree = self.branch.repository.revision_tree(base_rev_id)
1449
other_tree = self.branch.repository.revision_tree(old_tip)
1450
result += merge_inner(self.branch,
1456
self.branch.unlock()
1459
def _write_inventory(self, inv):
1460
"""Write inventory as the current inventory."""
1462
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1464
self._control_files.put('inventory', sio)
1465
self._set_inventory(inv)
1466
mutter('wrote working inventory')
1468
def set_conflicts(self, arg):
1469
raise UnsupportedOperation(self.set_conflicts, self)
1471
def add_conflicts(self, arg):
1472
raise UnsupportedOperation(self.add_conflicts, self)
1475
def conflicts(self):
1476
conflicts = ConflictList()
1477
for conflicted in self._iter_conflicts():
1480
if file_kind(self.abspath(conflicted)) != "file":
1482
except errors.NoSuchFile:
1485
for suffix in ('.THIS', '.OTHER'):
1487
kind = file_kind(self.abspath(conflicted+suffix))
1490
except errors.NoSuchFile:
1494
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1495
conflicts.append(Conflict.factory(ctype, path=conflicted,
1496
file_id=self.path2id(conflicted)))
1500
class WorkingTree3(WorkingTree):
1501
"""This is the Format 3 working tree.
1503
This differs from the base WorkingTree by:
1504
- having its own file lock
1505
- having its own last-revision property.
1507
This is new in bzr 0.8
1511
def last_revision(self):
1512
"""See WorkingTree.last_revision."""
1514
return self._control_files.get_utf8('last-revision').read()
1518
def _change_last_revision(self, revision_id):
1519
"""See WorkingTree._change_last_revision."""
1520
if revision_id is None or revision_id == NULL_REVISION:
1522
self._control_files._transport.delete('last-revision')
1523
except errors.NoSuchFile:
1528
self.branch.revision_history().index(revision_id)
1530
raise errors.NoSuchRevision(self.branch, revision_id)
1531
self._control_files.put_utf8('last-revision', revision_id)
1535
def set_conflicts(self, conflicts):
1536
self._put_rio('conflicts', conflicts.to_stanzas(),
1540
def add_conflicts(self, new_conflicts):
1541
conflict_set = set(self.conflicts())
1542
conflict_set.update(set(list(new_conflicts)))
1543
self.set_conflicts(ConflictList(sorted(conflict_set,
1544
key=Conflict.sort_key)))
1547
def conflicts(self):
1549
confile = self._control_files.get('conflicts')
1551
return ConflictList()
1553
if confile.next() != CONFLICT_HEADER_1 + '\n':
1554
raise ConflictFormatError()
1555
except StopIteration:
1556
raise ConflictFormatError()
1557
return ConflictList.from_stanzas(RioReader(confile))
1560
def get_conflicted_stem(path):
1561
for suffix in CONFLICT_SUFFIXES:
1562
if path.endswith(suffix):
1563
return path[:-len(suffix)]
1565
@deprecated_function(zero_eight)
1566
def is_control_file(filename):
1567
"""See WorkingTree.is_control_filename(filename)."""
1568
## FIXME: better check
1569
filename = normpath(filename)
1570
while filename != '':
1571
head, tail = os.path.split(filename)
1572
## mutter('check %r for control file' % ((head, tail),))
1575
if filename == head:
1581
class WorkingTreeFormat(object):
1582
"""An encapsulation of the initialization and open routines for a format.
1584
Formats provide three things:
1585
* An initialization routine,
1589
Formats are placed in an dict by their format string for reference
1590
during workingtree opening. Its not required that these be instances, they
1591
can be classes themselves with class methods - it simply depends on
1592
whether state is needed for a given format or not.
1594
Once a format is deprecated, just deprecate the initialize and open
1595
methods on the format class. Do not deprecate the object, as the
1596
object will be created every time regardless.
1599
_default_format = None
1600
"""The default format used for new trees."""
1603
"""The known formats."""
1606
def find_format(klass, a_bzrdir):
1607
"""Return the format for the working tree object in a_bzrdir."""
1609
transport = a_bzrdir.get_workingtree_transport(None)
1610
format_string = transport.get("format").read()
1611
return klass._formats[format_string]
1613
raise errors.NoWorkingTree(base=transport.base)
1615
raise errors.UnknownFormatError(format=format_string)
1618
def get_default_format(klass):
1619
"""Return the current default format."""
1620
return klass._default_format
1622
def get_format_string(self):
1623
"""Return the ASCII format string that identifies this format."""
1624
raise NotImplementedError(self.get_format_string)
1626
def get_format_description(self):
1627
"""Return the short description for this format."""
1628
raise NotImplementedError(self.get_format_description)
1630
def is_supported(self):
1631
"""Is this format supported?
1633
Supported formats can be initialized and opened.
1634
Unsupported formats may not support initialization or committing or
1635
some other features depending on the reason for not being supported.
1640
def register_format(klass, format):
1641
klass._formats[format.get_format_string()] = format
1644
def set_default_format(klass, format):
1645
klass._default_format = format
1648
def unregister_format(klass, format):
1649
assert klass._formats[format.get_format_string()] is format
1650
del klass._formats[format.get_format_string()]
1654
class WorkingTreeFormat2(WorkingTreeFormat):
1655
"""The second working tree format.
1657
This format modified the hash cache from the format 1 hash cache.
1660
def get_format_description(self):
1661
"""See WorkingTreeFormat.get_format_description()."""
1662
return "Working tree format 2"
1664
def stub_initialize_remote(self, control_files):
1665
"""As a special workaround create critical control files for a remote working tree
1667
This ensures that it can later be updated and dealt with locally,
1668
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1669
no working tree. (See bug #43064).
1673
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1675
control_files.put('inventory', sio)
1677
control_files.put_utf8('pending-merges', '')
1680
def initialize(self, a_bzrdir, revision_id=None):
1681
"""See WorkingTreeFormat.initialize()."""
1682
if not isinstance(a_bzrdir.transport, LocalTransport):
1683
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1684
branch = a_bzrdir.open_branch()
1685
if revision_id is not None:
1688
revision_history = branch.revision_history()
1690
position = revision_history.index(revision_id)
1692
raise errors.NoSuchRevision(branch, revision_id)
1693
branch.set_revision_history(revision_history[:position + 1])
1696
revision = branch.last_revision()
1698
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1704
wt._write_inventory(inv)
1705
wt.set_root_id(inv.root.file_id)
1706
wt.set_last_revision(revision)
1707
wt.set_pending_merges([])
1708
build_tree(wt.basis_tree(), wt)
1712
super(WorkingTreeFormat2, self).__init__()
1713
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1715
def open(self, a_bzrdir, _found=False):
1716
"""Return the WorkingTree object for a_bzrdir
1718
_found is a private parameter, do not use it. It is used to indicate
1719
if format probing has already been done.
1722
# we are being called directly and must probe.
1723
raise NotImplementedError
1724
if not isinstance(a_bzrdir.transport, LocalTransport):
1725
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1726
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1732
class WorkingTreeFormat3(WorkingTreeFormat):
1733
"""The second working tree format updated to record a format marker.
1736
- exists within a metadir controlling .bzr
1737
- includes an explicit version marker for the workingtree control
1738
files, separate from the BzrDir format
1739
- modifies the hash cache format
1741
- uses a LockDir to guard access for writes.
1744
def get_format_string(self):
1745
"""See WorkingTreeFormat.get_format_string()."""
1746
return "Bazaar-NG Working Tree format 3"
1748
def get_format_description(self):
1749
"""See WorkingTreeFormat.get_format_description()."""
1750
return "Working tree format 3"
1752
_lock_file_name = 'lock'
1753
_lock_class = LockDir
1755
def _open_control_files(self, a_bzrdir):
1756
transport = a_bzrdir.get_workingtree_transport(None)
1757
return LockableFiles(transport, self._lock_file_name,
1760
def initialize(self, a_bzrdir, revision_id=None):
1761
"""See WorkingTreeFormat.initialize().
1763
revision_id allows creating a working tree at a different
1764
revision than the branch is at.
1766
if not isinstance(a_bzrdir.transport, LocalTransport):
1767
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1768
transport = a_bzrdir.get_workingtree_transport(self)
1769
control_files = self._open_control_files(a_bzrdir)
1770
control_files.create_lock()
1771
control_files.lock_write()
1772
control_files.put_utf8('format', self.get_format_string())
1773
branch = a_bzrdir.open_branch()
1774
if revision_id is None:
1775
revision_id = branch.last_revision()
1777
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1783
_control_files=control_files)
1786
wt._write_inventory(inv)
1787
wt.set_root_id(inv.root.file_id)
1788
wt.set_last_revision(revision_id)
1789
wt.set_pending_merges([])
1790
build_tree(wt.basis_tree(), wt)
1793
control_files.unlock()
1797
super(WorkingTreeFormat3, self).__init__()
1798
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1800
def open(self, a_bzrdir, _found=False):
1801
"""Return the WorkingTree object for a_bzrdir
1803
_found is a private parameter, do not use it. It is used to indicate
1804
if format probing has already been done.
1807
# we are being called directly and must probe.
1808
raise NotImplementedError
1809
if not isinstance(a_bzrdir.transport, LocalTransport):
1810
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1811
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1813
def _open(self, a_bzrdir, control_files):
1814
"""Open the tree itself.
1816
:param a_bzrdir: the dir for the tree.
1817
:param control_files: the control files for the tree.
1819
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1823
_control_files=control_files)
1826
return self.get_format_string()
1829
# formats which have no format string are not discoverable
1830
# and not independently creatable, so are not registered.
1831
__default_format = WorkingTreeFormat3()
1832
WorkingTreeFormat.register_format(__default_format)
1833
WorkingTreeFormat.set_default_format(__default_format)
1834
_legacy_formats = [WorkingTreeFormat2(),
1838
class WorkingTreeTestProviderAdapter(object):
1839
"""A tool to generate a suite testing multiple workingtree formats at once.
1841
This is done by copying the test once for each transport and injecting
1842
the transport_server, transport_readonly_server, and workingtree_format
1843
classes into each copy. Each copy is also given a new id() to make it
1847
def __init__(self, transport_server, transport_readonly_server, formats):
1848
self._transport_server = transport_server
1849
self._transport_readonly_server = transport_readonly_server
1850
self._formats = formats
1852
def adapt(self, test):
1853
from bzrlib.tests import TestSuite
1854
result = TestSuite()
1855
for workingtree_format, bzrdir_format in self._formats:
1856
new_test = deepcopy(test)
1857
new_test.transport_server = self._transport_server
1858
new_test.transport_readonly_server = self._transport_readonly_server
1859
new_test.bzrdir_format = bzrdir_format
1860
new_test.workingtree_format = workingtree_format
1861
def make_new_test_id():
1862
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1863
return lambda: new_id
1864
new_test.id = make_new_test_id()
1865
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
