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
assert inv.root is not None
326
self._inventory = inv
327
self.path2id = self._inventory.path2id
329
def is_control_filename(self, filename):
330
"""True if filename is the name of a control file in this tree.
332
:param filename: A filename within the tree. This is a relative path
333
from the root of this tree.
335
This is true IF and ONLY IF the filename is part of the meta data
336
that bzr controls in this tree. I.E. a random .bzr directory placed
337
on disk will not be a control file for this tree.
339
return self.bzrdir.is_control_filename(filename)
342
def open(path=None, _unsupported=False):
343
"""Open an existing working tree at path.
347
path = os.path.getcwdu()
348
control = bzrdir.BzrDir.open(path, _unsupported)
349
return control.open_workingtree(_unsupported)
352
def open_containing(path=None):
353
"""Open an existing working tree which has its root about path.
355
This probes for a working tree at path and searches upwards from there.
357
Basically we keep looking up until we find the control directory or
358
run into /. If there isn't one, raises NotBranchError.
359
TODO: give this a new exception.
360
If there is one, it is returned, along with the unused portion of path.
362
:return: The WorkingTree that contains 'path', and the rest of path
365
path = osutils.getcwd()
366
control, relpath = bzrdir.BzrDir.open_containing(path)
368
return control.open_workingtree(), relpath
371
def open_downlevel(path=None):
372
"""Open an unsupported working tree.
374
Only intended for advanced situations like upgrading part of a bzrdir.
376
return WorkingTree.open(path, _unsupported=True)
379
"""Iterate through file_ids for this tree.
381
file_ids are in a WorkingTree if they are in the working inventory
382
and the working file exists.
384
inv = self._inventory
385
for path, ie in inv.iter_entries():
386
if osutils.lexists(self.abspath(path)):
390
return "<%s of %s>" % (self.__class__.__name__,
391
getattr(self, 'basedir', None))
393
def abspath(self, filename):
394
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision."""
398
revision_id = self.last_revision()
399
if revision_id is not None:
401
xml = self.read_basis_inventory()
402
inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
403
if inv is not None and inv.revision_id == revision_id:
404
return bzrlib.tree.RevisionTree(self.branch.repository,
406
except (NoSuchFile, errors.BadInventoryFormat):
408
# FIXME? RBC 20060403 should we cache the inventory here ?
409
return self.branch.repository.revision_tree(revision_id)
412
@deprecated_method(zero_eight)
413
def create(branch, directory):
414
"""Create a workingtree for branch at directory.
416
If existing_directory already exists it must have a .bzr directory.
417
If it does not exist, it will be created.
419
This returns a new WorkingTree object for the new checkout.
421
TODO FIXME RBC 20060124 when we have checkout formats in place this
422
should accept an optional revisionid to checkout [and reject this if
423
checking out into the same dir as a pre-checkout-aware branch format.]
425
XXX: When BzrDir is present, these should be created through that
428
warnings.warn('delete WorkingTree.create', stacklevel=3)
429
transport = get_transport(directory)
430
if branch.bzrdir.root_transport.base == transport.base:
432
return branch.bzrdir.create_workingtree()
433
# different directory,
434
# create a branch reference
435
# and now a working tree.
436
raise NotImplementedError
439
@deprecated_method(zero_eight)
440
def create_standalone(directory):
441
"""Create a checkout and a branch and a repo at directory.
443
Directory must exist and be empty.
445
please use BzrDir.create_standalone_workingtree
447
return bzrdir.BzrDir.create_standalone_workingtree(directory)
449
def relpath(self, path):
450
"""Return the local path portion from a given path.
452
The path may be absolute or relative. If its a relative path it is
453
interpreted relative to the python current working directory.
455
return relpath(self.basedir, path)
457
def has_filename(self, filename):
458
return osutils.lexists(self.abspath(filename))
460
def get_file(self, file_id):
461
return self.get_file_byname(self.id2path(file_id))
463
def get_file_text(self, file_id):
464
return self.get_file(file_id).read()
466
def get_file_byname(self, filename):
467
return file(self.abspath(filename), 'rb')
469
def get_parent_ids(self):
470
"""See Tree.get_parent_ids.
472
This implementation reads the pending merges list and last_revision
473
value and uses that to decide what the parents list should be.
475
last_rev = self.last_revision()
480
other_parents = self.pending_merges()
481
return parents + other_parents
483
def get_root_id(self):
484
"""Return the id of this trees root"""
485
inv = self.read_working_inventory()
486
return inv.root.file_id
488
def _get_store_filename(self, file_id):
489
## XXX: badly named; this is not in the store at all
490
return self.abspath(self.id2path(file_id))
493
def clone(self, to_bzrdir, revision_id=None, basis=None):
494
"""Duplicate this working tree into to_bzr, including all state.
496
Specifically modified files are kept as modified, but
497
ignored and unknown files are discarded.
499
If you want to make a new line of development, see bzrdir.sprout()
502
If not None, the cloned tree will have its last revision set to
503
revision, and and difference between the source trees last revision
504
and this one merged in.
507
If not None, a closer copy of a tree which may have some files in
508
common, and which file content should be preferentially copied from.
510
# assumes the target bzr dir format is compatible.
511
result = self._format.initialize(to_bzrdir)
512
self.copy_content_into(result, revision_id)
516
def copy_content_into(self, tree, revision_id=None):
517
"""Copy the current content and user files of this tree into tree."""
518
if revision_id is None:
519
transform_tree(tree, self)
521
# TODO now merge from tree.last_revision to revision
522
transform_tree(tree, self)
523
tree.set_last_revision(revision_id)
526
def commit(self, message=None, revprops=None, *args, **kwargs):
527
# avoid circular imports
528
from bzrlib.commit import Commit
531
if not 'branch-nick' in revprops:
532
revprops['branch-nick'] = self.branch.nick
533
# args for wt.commit start at message from the Commit.commit method,
534
# but with branch a kwarg now, passing in args as is results in the
535
#message being used for the branch
536
args = (DEPRECATED_PARAMETER, message, ) + args
537
committed_id = Commit().commit( working_tree=self, revprops=revprops,
539
self._set_inventory(self.read_working_inventory())
542
def id2abspath(self, file_id):
543
return self.abspath(self.id2path(file_id))
545
def has_id(self, file_id):
546
# files that have been deleted are excluded
547
inv = self._inventory
548
if not inv.has_id(file_id):
550
path = inv.id2path(file_id)
551
return osutils.lexists(self.abspath(path))
553
def has_or_had_id(self, file_id):
554
if file_id == self.inventory.root.file_id:
556
return self.inventory.has_id(file_id)
558
__contains__ = has_id
560
def get_file_size(self, file_id):
561
return os.path.getsize(self.id2abspath(file_id))
564
def get_file_sha1(self, file_id, path=None):
566
path = self._inventory.id2path(file_id)
567
return self._hashcache.get_sha1(path)
569
def get_file_mtime(self, file_id, path=None):
571
path = self._inventory.id2path(file_id)
572
return os.lstat(self.abspath(path)).st_mtime
574
if not supports_executable():
575
def is_executable(self, file_id, path=None):
576
return self._inventory[file_id].executable
578
def is_executable(self, file_id, path=None):
580
path = self._inventory.id2path(file_id)
581
mode = os.lstat(self.abspath(path)).st_mode
582
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
585
def add(self, files, ids=None):
586
"""Make files versioned.
588
Note that the command line normally calls smart_add instead,
589
which can automatically recurse.
591
This adds the files to the inventory, so that they will be
592
recorded by the next commit.
595
List of paths to add, relative to the base of the tree.
598
If set, use these instead of automatically generated ids.
599
Must be the same length as the list of files, but may
600
contain None for ids that are to be autogenerated.
602
TODO: Perhaps have an option to add the ids even if the files do
605
TODO: Perhaps callback with the ids and paths as they're added.
607
# TODO: Re-adding a file that is removed in the working copy
608
# should probably put it back with the previous ID.
609
if isinstance(files, basestring):
610
assert(ids is None or isinstance(ids, basestring))
616
ids = [None] * len(files)
618
assert(len(ids) == len(files))
620
inv = self.read_working_inventory()
621
for f,file_id in zip(files, ids):
622
if self.is_control_filename(f):
623
raise errors.ForbiddenControlFileError(filename=f)
628
raise BzrError("cannot add top-level %r" % f)
630
fullpath = normpath(self.abspath(f))
632
kind = file_kind(fullpath)
634
if e.errno == errno.ENOENT:
635
raise NoSuchFile(fullpath)
636
if not InventoryEntry.versionable_kind(kind):
637
raise errors.BadFileKindError(filename=f, kind=kind)
639
inv.add_path(f, kind=kind)
641
inv.add_path(f, kind=kind, file_id=file_id)
643
self._write_inventory(inv)
646
def add_pending_merge(self, *revision_ids):
647
# TODO: Perhaps should check at this point that the
648
# history of the revision is actually present?
649
p = self.pending_merges()
651
for rev_id in revision_ids:
657
self.set_pending_merges(p)
660
def pending_merges(self):
661
"""Return a list of pending merges.
663
These are revisions that have been merged into the working
664
directory but not yet committed.
667
merges_file = self._control_files.get_utf8('pending-merges')
671
for l in merges_file.readlines():
672
p.append(l.rstrip('\n'))
676
def set_pending_merges(self, rev_list):
677
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
680
def set_merge_modified(self, modified_hashes):
682
for file_id, hash in modified_hashes.iteritems():
683
yield Stanza(file_id=file_id, hash=hash)
684
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
687
def _put_rio(self, filename, stanzas, header):
688
my_file = rio_file(stanzas, header)
689
self._control_files.put(filename, my_file)
692
def merge_modified(self):
694
hashfile = self._control_files.get('merge-hashes')
699
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
700
raise MergeModifiedFormatError()
701
except StopIteration:
702
raise MergeModifiedFormatError()
703
for s in RioReader(hashfile):
704
file_id = s.get("file_id")
705
if file_id not in self.inventory:
708
if hash == self.get_file_sha1(file_id):
709
merge_hashes[file_id] = hash
712
def get_symlink_target(self, file_id):
713
return os.readlink(self.id2abspath(file_id))
715
def file_class(self, filename):
716
if self.path2id(filename):
718
elif self.is_ignored(filename):
723
def list_files(self):
724
"""Recursively list all files as (path, class, kind, id, entry).
726
Lists, but does not descend into unversioned directories.
728
This does not include files that have been deleted in this
731
Skips the control directory.
733
inv = self._inventory
734
# Convert these into local objects to save lookup times
735
pathjoin = osutils.pathjoin
736
file_kind = osutils.file_kind
738
# transport.base ends in a slash, we want the piece
739
# between the last two slashes
740
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
742
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
744
# directory file_id, relative path, absolute path, reverse sorted children
745
children = os.listdir(self.basedir)
747
# jam 20060527 The kernel sized tree seems equivalent whether we
748
# use a deque and popleft to keep them sorted, or if we use a plain
749
# list and just reverse() them.
750
children = collections.deque(children)
751
stack = [(inv.root.file_id, u'', self.basedir, children)]
753
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
756
f = children.popleft()
757
## TODO: If we find a subdirectory with its own .bzr
758
## directory, then that is a separate tree and we
759
## should exclude it.
761
# the bzrdir for this tree
762
if transport_base_dir == f:
765
# we know that from_dir_relpath and from_dir_abspath never end in a slash
766
# and 'f' doesn't begin with one, we can do a string op, rather
767
# than the checks of pathjoin(), all relative paths will have an extra slash
769
fp = from_dir_relpath + '/' + f
772
fap = from_dir_abspath + '/' + f
774
f_ie = inv.get_child(from_dir_id, f)
777
elif self.is_ignored(fp[1:]):
780
# we may not have found this file, because of a unicode issue
781
f_norm, can_access = osutils.normalized_filename(f)
782
if f == f_norm or not can_access:
783
# No change, so treat this file normally
786
# this file can be accessed by a normalized path
787
# check again if it is versioned
788
# these lines are repeated here for performance
790
fp = from_dir_relpath + '/' + f
791
fap = from_dir_abspath + '/' + f
792
f_ie = inv.get_child(from_dir_id, f)
795
elif self.is_ignored(fp[1:]):
804
raise BzrCheckError("file %r entered as kind %r id %r, "
806
% (fap, f_ie.kind, f_ie.file_id, fk))
808
# make a last minute entry
810
yield fp[1:], c, fk, f_ie.file_id, f_ie
813
yield fp[1:], c, fk, None, fk_entries[fk]()
815
yield fp[1:], c, fk, None, TreeEntry()
818
if fk != 'directory':
821
# But do this child first
822
new_children = os.listdir(fap)
824
new_children = collections.deque(new_children)
825
stack.append((f_ie.file_id, fp, fap, new_children))
826
# Break out of inner loop, so that we start outer loop with child
829
# if we finished all children, pop it off the stack
834
def move(self, from_paths, to_name):
837
to_name must exist in the inventory.
839
If to_name exists and is a directory, the files are moved into
840
it, keeping their old names.
842
Note that to_name is only the last component of the new name;
843
this doesn't change the directory.
845
This returns a list of (from_path, to_path) pairs for each
849
## TODO: Option to move IDs only
850
assert not isinstance(from_paths, basestring)
852
to_abs = self.abspath(to_name)
853
if not isdir(to_abs):
854
raise BzrError("destination %r is not a directory" % to_abs)
855
if not self.has_filename(to_name):
856
raise BzrError("destination %r not in working directory" % to_abs)
857
to_dir_id = inv.path2id(to_name)
858
if to_dir_id == None and to_name != '':
859
raise BzrError("destination %r is not a versioned directory" % to_name)
860
to_dir_ie = inv[to_dir_id]
861
if to_dir_ie.kind != 'directory':
862
raise BzrError("destination %r is not a directory" % to_abs)
864
to_idpath = inv.get_idpath(to_dir_id)
867
if not self.has_filename(f):
868
raise BzrError("%r does not exist in working tree" % f)
869
f_id = inv.path2id(f)
871
raise BzrError("%r is not versioned" % f)
872
name_tail = splitpath(f)[-1]
873
dest_path = pathjoin(to_name, name_tail)
874
if self.has_filename(dest_path):
875
raise BzrError("destination %r already exists" % dest_path)
876
if f_id in to_idpath:
877
raise BzrError("can't move %r to a subdirectory of itself" % f)
879
# OK, so there's a race here, it's possible that someone will
880
# create a file in this interval and then the rename might be
881
# left half-done. But we should have caught most problems.
882
orig_inv = deepcopy(self.inventory)
885
name_tail = splitpath(f)[-1]
886
dest_path = pathjoin(to_name, name_tail)
887
result.append((f, dest_path))
888
inv.rename(inv.path2id(f), to_dir_id, name_tail)
890
rename(self.abspath(f), self.abspath(dest_path))
892
raise BzrError("failed to rename %r to %r: %s" %
893
(f, dest_path, e[1]),
894
["rename rolled back"])
896
# restore the inventory on error
897
self._set_inventory(orig_inv)
899
self._write_inventory(inv)
903
def rename_one(self, from_rel, to_rel):
906
This can change the directory or the filename or both.
909
if not self.has_filename(from_rel):
910
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
911
if self.has_filename(to_rel):
912
raise BzrError("can't rename: new working file %r already exists" % to_rel)
914
file_id = inv.path2id(from_rel)
916
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
919
from_parent = entry.parent_id
920
from_name = entry.name
922
if inv.path2id(to_rel):
923
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
925
to_dir, to_tail = os.path.split(to_rel)
926
to_dir_id = inv.path2id(to_dir)
927
if to_dir_id == None and to_dir != '':
928
raise BzrError("can't determine destination directory id for %r" % to_dir)
930
mutter("rename_one:")
931
mutter(" file_id {%s}" % file_id)
932
mutter(" from_rel %r" % from_rel)
933
mutter(" to_rel %r" % to_rel)
934
mutter(" to_dir %r" % to_dir)
935
mutter(" to_dir_id {%s}" % to_dir_id)
937
inv.rename(file_id, to_dir_id, to_tail)
939
from_abs = self.abspath(from_rel)
940
to_abs = self.abspath(to_rel)
942
rename(from_abs, to_abs)
944
inv.rename(file_id, from_parent, from_name)
945
raise BzrError("failed to rename %r to %r: %s"
946
% (from_abs, to_abs, e[1]),
947
["rename rolled back"])
948
self._write_inventory(inv)
952
"""Return all unknown files.
954
These are files in the working directory that are not versioned or
955
control files or ignored.
957
for subp in self.extras():
958
if not self.is_ignored(subp):
961
@deprecated_method(zero_eight)
962
def iter_conflicts(self):
963
"""List all files in the tree that have text or content conflicts.
964
DEPRECATED. Use conflicts instead."""
965
return self._iter_conflicts()
967
def _iter_conflicts(self):
969
for info in self.list_files():
971
stem = get_conflicted_stem(path)
974
if stem not in conflicted:
979
def pull(self, source, overwrite=False, stop_revision=None):
980
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
983
pp = ProgressPhase("Pull phase", 2, top_pb)
985
old_revision_history = self.branch.revision_history()
986
basis_tree = self.basis_tree()
987
count = self.branch.pull(source, overwrite, stop_revision)
988
new_revision_history = self.branch.revision_history()
989
if new_revision_history != old_revision_history:
991
if len(old_revision_history):
992
other_revision = old_revision_history[-1]
994
other_revision = None
995
repository = self.branch.repository
996
pb = bzrlib.ui.ui_factory.nested_progress_bar()
998
merge_inner(self.branch,
999
self.branch.basis_tree(),
1005
self.set_last_revision(self.branch.last_revision())
1012
"""Yield all unknown files in this WorkingTree.
1014
If there are any unknown directories then only the directory is
1015
returned, not all its children. But if there are unknown files
1016
under a versioned subdirectory, they are returned.
1018
Currently returned depth-first, sorted by name within directories.
1020
## TODO: Work from given directory downwards
1021
for path, dir_entry in self.inventory.directories():
1022
# mutter("search for unknowns in %r", path)
1023
dirabs = self.abspath(path)
1024
if not isdir(dirabs):
1025
# e.g. directory deleted
1029
for subf in os.listdir(dirabs):
1032
if subf not in dir_entry.children:
1033
subf_norm, can_access = osutils.normalized_filename(subf)
1034
if subf_norm != subf and can_access:
1035
if subf_norm not in dir_entry.children:
1036
fl.append(subf_norm)
1042
subp = pathjoin(path, subf)
1045
def _translate_ignore_rule(self, rule):
1046
"""Translate a single ignore rule to a regex.
1048
There are two types of ignore rules. Those that do not contain a / are
1049
matched against the tail of the filename (that is, they do not care
1050
what directory the file is in.) Rules which do contain a slash must
1051
match the entire path. As a special case, './' at the start of the
1052
string counts as a slash in the string but is removed before matching
1053
(e.g. ./foo.c, ./src/foo.c)
1055
:return: The translated regex.
1057
if rule[:2] in ('./', '.\\'):
1059
result = fnmatch.translate(rule[2:])
1060
elif '/' in rule or '\\' in rule:
1062
result = fnmatch.translate(rule)
1064
# default rule style.
1065
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1066
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1067
return "(" + result + ")"
1069
def _combine_ignore_rules(self, rules):
1070
"""Combine a list of ignore rules into a single regex object.
1072
Each individual rule is combined with | to form a big regex, which then
1073
has $ added to it to form something like ()|()|()$. The group index for
1074
each subregex's outermost group is placed in a dictionary mapping back
1075
to the rule. This allows quick identification of the matching rule that
1077
:return: a list of the compiled regex and the matching-group index
1078
dictionaries. We return a list because python complains if you try to
1079
combine more than 100 regexes.
1084
translated_rules = []
1086
translated_rule = self._translate_ignore_rule(rule)
1087
compiled_rule = re.compile(translated_rule)
1088
groups[next_group] = rule
1089
next_group += compiled_rule.groups
1090
translated_rules.append(translated_rule)
1091
if next_group == 99:
1092
result.append((re.compile("|".join(translated_rules)), groups))
1095
translated_rules = []
1096
if len(translated_rules):
1097
result.append((re.compile("|".join(translated_rules)), groups))
1100
def ignored_files(self):
1101
"""Yield list of PATH, IGNORE_PATTERN"""
1102
for subp in self.extras():
1103
pat = self.is_ignored(subp)
1107
def get_ignore_list(self):
1108
"""Return list of ignore patterns.
1110
Cached in the Tree object after the first call.
1112
ignoreset = getattr(self, '_ignoreset', None)
1113
if ignoreset is not None:
1116
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1117
ignore_globs.update(ignores.get_runtime_ignores())
1119
ignore_globs.update(ignores.get_user_ignores())
1121
if self.has_filename(bzrlib.IGNORE_FILENAME):
1122
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1124
ignore_globs.update(ignores.parse_ignore_file(f))
1128
self._ignoreset = ignore_globs
1129
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1132
def _get_ignore_rules_as_regex(self):
1133
"""Return a regex of the ignore rules and a mapping dict.
1135
:return: (ignore rules compiled regex, dictionary mapping rule group
1136
indices to original rule.)
1138
if getattr(self, '_ignoreset', None) is None:
1139
self.get_ignore_list()
1140
return self._ignore_regex
1142
def is_ignored(self, filename):
1143
r"""Check whether the filename matches an ignore pattern.
1145
Patterns containing '/' or '\' need to match the whole path;
1146
others match against only the last component.
1148
If the file is ignored, returns the pattern which caused it to
1149
be ignored, otherwise None. So this can simply be used as a
1150
boolean if desired."""
1152
# TODO: Use '**' to match directories, and other extended
1153
# globbing stuff from cvs/rsync.
1155
# XXX: fnmatch is actually not quite what we want: it's only
1156
# approximately the same as real Unix fnmatch, and doesn't
1157
# treat dotfiles correctly and allows * to match /.
1158
# Eventually it should be replaced with something more
1161
rules = self._get_ignore_rules_as_regex()
1162
for regex, mapping in rules:
1163
match = regex.match(filename)
1164
if match is not None:
1165
# one or more of the groups in mapping will have a non-None group
1167
groups = match.groups()
1168
rules = [mapping[group] for group in
1169
mapping if groups[group] is not None]
1173
def kind(self, file_id):
1174
return file_kind(self.id2abspath(file_id))
1177
def last_revision(self):
1178
"""Return the last revision id of this working tree.
1180
In early branch formats this was == the branch last_revision,
1181
but that cannot be relied upon - for working tree operations,
1182
always use tree.last_revision().
1184
return self.branch.last_revision()
1186
def is_locked(self):
1187
return self._control_files.is_locked()
1189
def lock_read(self):
1190
"""See Branch.lock_read, and WorkingTree.unlock."""
1191
self.branch.lock_read()
1193
return self._control_files.lock_read()
1195
self.branch.unlock()
1198
def lock_write(self):
1199
"""See Branch.lock_write, and WorkingTree.unlock."""
1200
self.branch.lock_write()
1202
return self._control_files.lock_write()
1204
self.branch.unlock()
1207
def get_physical_lock_status(self):
1208
return self._control_files.get_physical_lock_status()
1210
def _basis_inventory_name(self):
1211
return 'basis-inventory-cache'
1214
def set_last_revision(self, new_revision):
1215
"""Change the last revision in the working tree."""
1216
if self._change_last_revision(new_revision):
1217
self._cache_basis_inventory(new_revision)
1219
def _change_last_revision(self, new_revision):
1220
"""Template method part of set_last_revision to perform the change.
1222
This is used to allow WorkingTree3 instances to not affect branch
1223
when their last revision is set.
1225
if new_revision is None:
1226
self.branch.set_revision_history([])
1229
self.branch.generate_revision_history(new_revision)
1230
except errors.NoSuchRevision:
1231
# not present in the repo - dont try to set it deeper than the tip
1232
self.branch.set_revision_history([new_revision])
1235
def _cache_basis_inventory(self, new_revision):
1236
"""Cache new_revision as the basis inventory."""
1237
# TODO: this should allow the ready-to-use inventory to be passed in,
1238
# as commit already has that ready-to-use [while the format is the
1241
# this double handles the inventory - unpack and repack -
1242
# but is easier to understand. We can/should put a conditional
1243
# in here based on whether the inventory is in the latest format
1244
# - perhaps we should repack all inventories on a repository
1246
# the fast path is to copy the raw xml from the repository. If the
1247
# xml contains 'revision_id="', then we assume the right
1248
# revision_id is set. We must check for this full string, because a
1249
# root node id can legitimately look like 'revision_id' but cannot
1251
xml = self.branch.repository.get_inventory_xml(new_revision)
1252
firstline = xml.split('\n', 1)[0]
1253
if (not 'revision_id="' in firstline or
1254
'format="6"' not in firstline):
1255
inv = self.branch.repository.deserialise_inventory(
1257
inv.revision_id = new_revision
1258
xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
1259
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1260
path = self._basis_inventory_name()
1262
self._control_files.put(path, sio)
1263
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1266
def read_basis_inventory(self):
1267
"""Read the cached basis inventory."""
1268
path = self._basis_inventory_name()
1269
return self._control_files.get(path).read()
1272
def read_working_inventory(self):
1273
"""Read the working inventory."""
1274
# ElementTree does its own conversion from UTF-8, so open in
1276
result = bzrlib.xml5.serializer_v5.read_inventory(
1277
self._control_files.get('inventory'))
1278
self._set_inventory(result)
1282
def remove(self, files, verbose=False, to_file=None):
1283
"""Remove nominated files from the working inventory..
1285
This does not remove their text. This does not run on XXX on what? RBC
1287
TODO: Refuse to remove modified files unless --force is given?
1289
TODO: Do something useful with directories.
1291
TODO: Should this remove the text or not? Tough call; not
1292
removing may be useful and the user can just use use rm, and
1293
is the opposite of add. Removing it is consistent with most
1294
other tools. Maybe an option.
1296
## TODO: Normalize names
1297
## TODO: Remove nested loops; better scalability
1298
if isinstance(files, basestring):
1301
inv = self.inventory
1303
# do this before any modifications
1305
fid = inv.path2id(f)
1307
# TODO: Perhaps make this just a warning, and continue?
1308
# This tends to happen when
1309
raise NotVersionedError(path=f)
1311
# having remove it, it must be either ignored or unknown
1312
if self.is_ignored(f):
1316
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1319
self._write_inventory(inv)
1322
def revert(self, filenames, old_tree=None, backups=True,
1323
pb=DummyProgress()):
1324
from transform import revert
1325
from conflicts import resolve
1326
if old_tree is None:
1327
old_tree = self.basis_tree()
1328
conflicts = revert(self, old_tree, filenames, backups, pb)
1329
if not len(filenames):
1330
self.set_pending_merges([])
1333
resolve(self, filenames, ignore_misses=True)
1336
# XXX: This method should be deprecated in favour of taking in a proper
1337
# new Inventory object.
1339
def set_inventory(self, new_inventory_list):
1340
from bzrlib.inventory import (Inventory,
1345
inv = Inventory(self.get_root_id())
1346
for path, file_id, parent, kind in new_inventory_list:
1347
name = os.path.basename(path)
1350
# fixme, there should be a factory function inv,add_??
1351
if kind == 'directory':
1352
inv.add(InventoryDirectory(file_id, name, parent))
1353
elif kind == 'file':
1354
inv.add(InventoryFile(file_id, name, parent))
1355
elif kind == 'symlink':
1356
inv.add(InventoryLink(file_id, name, parent))
1358
raise BzrError("unknown kind %r" % kind)
1359
self._write_inventory(inv)
1362
def set_root_id(self, file_id):
1363
"""Set the root id for this tree."""
1364
inv = self.read_working_inventory()
1365
orig_root_id = inv.root.file_id
1366
del inv._byid[inv.root.file_id]
1367
inv.root.file_id = file_id
1368
inv._byid[inv.root.file_id] = inv.root
1371
if entry.parent_id == orig_root_id:
1372
entry.parent_id = inv.root.file_id
1373
self._write_inventory(inv)
1376
"""See Branch.unlock.
1378
WorkingTree locking just uses the Branch locking facilities.
1379
This is current because all working trees have an embedded branch
1380
within them. IF in the future, we were to make branch data shareable
1381
between multiple working trees, i.e. via shared storage, then we
1382
would probably want to lock both the local tree, and the branch.
1384
raise NotImplementedError(self.unlock)
1388
"""Update a working tree along its branch.
1390
This will update the branch if its bound too, which means we have multiple trees involved:
1391
The new basis tree of the master.
1392
The old basis tree of the branch.
1393
The old basis tree of the working tree.
1394
The current working tree state.
1395
pathologically all three may be different, and non ancestors of each other.
1396
Conceptually we want to:
1397
Preserve the wt.basis->wt.state changes
1398
Transform the wt.basis to the new master basis.
1399
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1400
Restore the wt.basis->wt.state changes.
1402
There isn't a single operation at the moment to do that, so we:
1403
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1404
Do a 'normal' merge of the old branch basis if it is relevant.
1406
old_tip = self.branch.update()
1407
if old_tip is not None:
1408
self.add_pending_merge(old_tip)
1409
self.branch.lock_read()
1412
if self.last_revision() != self.branch.last_revision():
1413
# merge tree state up to new branch tip.
1414
basis = self.basis_tree()
1415
to_tree = self.branch.basis_tree()
1416
result += merge_inner(self.branch,
1420
self.set_last_revision(self.branch.last_revision())
1421
if old_tip and old_tip != self.last_revision():
1422
# our last revision was not the prior branch last revision
1423
# and we have converted that last revision to a pending merge.
1424
# base is somewhere between the branch tip now
1425
# and the now pending merge
1426
from bzrlib.revision import common_ancestor
1428
base_rev_id = common_ancestor(self.branch.last_revision(),
1430
self.branch.repository)
1431
except errors.NoCommonAncestor:
1433
base_tree = self.branch.repository.revision_tree(base_rev_id)
1434
other_tree = self.branch.repository.revision_tree(old_tip)
1435
result += merge_inner(self.branch,
1441
self.branch.unlock()
1444
def _write_inventory(self, inv):
1445
"""Write inventory as the current inventory."""
1447
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1449
self._control_files.put('inventory', sio)
1450
self._set_inventory(inv)
1451
mutter('wrote working inventory')
1453
def set_conflicts(self, arg):
1454
raise UnsupportedOperation(self.set_conflicts, self)
1456
def add_conflicts(self, arg):
1457
raise UnsupportedOperation(self.add_conflicts, self)
1460
def conflicts(self):
1461
conflicts = ConflictList()
1462
for conflicted in self._iter_conflicts():
1465
if file_kind(self.abspath(conflicted)) != "file":
1467
except errors.NoSuchFile:
1470
for suffix in ('.THIS', '.OTHER'):
1472
kind = file_kind(self.abspath(conflicted+suffix))
1475
except errors.NoSuchFile:
1479
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1480
conflicts.append(Conflict.factory(ctype, path=conflicted,
1481
file_id=self.path2id(conflicted)))
1485
class WorkingTree2(WorkingTree):
1486
"""This is the Format 2 working tree.
1488
This was the first weave based working tree.
1489
- uses os locks for locking.
1490
- uses the branch last-revision.
1494
# we share control files:
1495
if self._hashcache.needs_write and self._control_files._lock_count==3:
1496
self._hashcache.write()
1497
# reverse order of locking.
1499
return self._control_files.unlock()
1501
self.branch.unlock()
1504
class WorkingTree3(WorkingTree):
1505
"""This is the Format 3 working tree.
1507
This differs from the base WorkingTree by:
1508
- having its own file lock
1509
- having its own last-revision property.
1511
This is new in bzr 0.8
1515
def last_revision(self):
1516
"""See WorkingTree.last_revision."""
1518
return self._control_files.get_utf8('last-revision').read()
1522
def _change_last_revision(self, revision_id):
1523
"""See WorkingTree._change_last_revision."""
1524
if revision_id is None or revision_id == NULL_REVISION:
1526
self._control_files._transport.delete('last-revision')
1527
except errors.NoSuchFile:
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
if self._hashcache.needs_write and self._control_files._lock_count==1:
1561
self._hashcache.write()
1562
# reverse order of locking.
1564
return self._control_files.unlock()
1566
self.branch.unlock()
1569
def get_conflicted_stem(path):
1570
for suffix in CONFLICT_SUFFIXES:
1571
if path.endswith(suffix):
1572
return path[:-len(suffix)]
1574
@deprecated_function(zero_eight)
1575
def is_control_file(filename):
1576
"""See WorkingTree.is_control_filename(filename)."""
1577
## FIXME: better check
1578
filename = normpath(filename)
1579
while filename != '':
1580
head, tail = os.path.split(filename)
1581
## mutter('check %r for control file' % ((head, tail),))
1584
if filename == head:
1590
class WorkingTreeFormat(object):
1591
"""An encapsulation of the initialization and open routines for a format.
1593
Formats provide three things:
1594
* An initialization routine,
1598
Formats are placed in an dict by their format string for reference
1599
during workingtree opening. Its not required that these be instances, they
1600
can be classes themselves with class methods - it simply depends on
1601
whether state is needed for a given format or not.
1603
Once a format is deprecated, just deprecate the initialize and open
1604
methods on the format class. Do not deprecate the object, as the
1605
object will be created every time regardless.
1608
_default_format = None
1609
"""The default format used for new trees."""
1612
"""The known formats."""
1615
def find_format(klass, a_bzrdir):
1616
"""Return the format for the working tree object in a_bzrdir."""
1618
transport = a_bzrdir.get_workingtree_transport(None)
1619
format_string = transport.get("format").read()
1620
return klass._formats[format_string]
1622
raise errors.NoWorkingTree(base=transport.base)
1624
raise errors.UnknownFormatError(format=format_string)
1627
def get_default_format(klass):
1628
"""Return the current default format."""
1629
return klass._default_format
1631
def get_format_string(self):
1632
"""Return the ASCII format string that identifies this format."""
1633
raise NotImplementedError(self.get_format_string)
1635
def get_format_description(self):
1636
"""Return the short description for this format."""
1637
raise NotImplementedError(self.get_format_description)
1639
def is_supported(self):
1640
"""Is this format supported?
1642
Supported formats can be initialized and opened.
1643
Unsupported formats may not support initialization or committing or
1644
some other features depending on the reason for not being supported.
1649
def register_format(klass, format):
1650
klass._formats[format.get_format_string()] = format
1653
def set_default_format(klass, format):
1654
klass._default_format = format
1657
def unregister_format(klass, format):
1658
assert klass._formats[format.get_format_string()] is format
1659
del klass._formats[format.get_format_string()]
1663
class WorkingTreeFormat2(WorkingTreeFormat):
1664
"""The second working tree format.
1666
This format modified the hash cache from the format 1 hash cache.
1669
def get_format_description(self):
1670
"""See WorkingTreeFormat.get_format_description()."""
1671
return "Working tree format 2"
1673
def stub_initialize_remote(self, control_files):
1674
"""As a special workaround create critical control files for a remote working tree
1676
This ensures that it can later be updated and dealt with locally,
1677
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1678
no working tree. (See bug #43064).
1682
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1684
control_files.put('inventory', sio)
1686
control_files.put_utf8('pending-merges', '')
1689
def initialize(self, a_bzrdir, revision_id=None):
1690
"""See WorkingTreeFormat.initialize()."""
1691
if not isinstance(a_bzrdir.transport, LocalTransport):
1692
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1693
branch = a_bzrdir.open_branch()
1694
if revision_id is not None:
1697
revision_history = branch.revision_history()
1699
position = revision_history.index(revision_id)
1701
raise errors.NoSuchRevision(branch, revision_id)
1702
branch.set_revision_history(revision_history[:position + 1])
1705
revision = branch.last_revision()
1707
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1713
wt._write_inventory(inv)
1714
wt.set_root_id(inv.root.file_id)
1715
wt.set_last_revision(revision)
1716
wt.set_pending_merges([])
1717
build_tree(wt.basis_tree(), wt)
1721
super(WorkingTreeFormat2, self).__init__()
1722
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1724
def open(self, a_bzrdir, _found=False):
1725
"""Return the WorkingTree object for a_bzrdir
1727
_found is a private parameter, do not use it. It is used to indicate
1728
if format probing has already been done.
1731
# we are being called directly and must probe.
1732
raise NotImplementedError
1733
if not isinstance(a_bzrdir.transport, LocalTransport):
1734
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1735
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1741
class WorkingTreeFormat3(WorkingTreeFormat):
1742
"""The second working tree format updated to record a format marker.
1745
- exists within a metadir controlling .bzr
1746
- includes an explicit version marker for the workingtree control
1747
files, separate from the BzrDir format
1748
- modifies the hash cache format
1750
- uses a LockDir to guard access for writes.
1753
def get_format_string(self):
1754
"""See WorkingTreeFormat.get_format_string()."""
1755
return "Bazaar-NG Working Tree format 3"
1757
def get_format_description(self):
1758
"""See WorkingTreeFormat.get_format_description()."""
1759
return "Working tree format 3"
1761
_lock_file_name = 'lock'
1762
_lock_class = LockDir
1764
def _open_control_files(self, a_bzrdir):
1765
transport = a_bzrdir.get_workingtree_transport(None)
1766
return LockableFiles(transport, self._lock_file_name,
1769
def initialize(self, a_bzrdir, revision_id=None):
1770
"""See WorkingTreeFormat.initialize().
1772
revision_id allows creating a working tree at a different
1773
revision than the branch is at.
1775
if not isinstance(a_bzrdir.transport, LocalTransport):
1776
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1777
transport = a_bzrdir.get_workingtree_transport(self)
1778
control_files = self._open_control_files(a_bzrdir)
1779
control_files.create_lock()
1780
control_files.lock_write()
1781
control_files.put_utf8('format', self.get_format_string())
1782
branch = a_bzrdir.open_branch()
1783
if revision_id is None:
1784
revision_id = branch.last_revision()
1786
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1792
_control_files=control_files)
1795
wt._write_inventory(inv)
1796
wt.set_root_id(inv.root.file_id)
1797
wt.set_last_revision(revision_id)
1798
wt.set_pending_merges([])
1799
build_tree(wt.basis_tree(), wt)
1802
control_files.unlock()
1806
super(WorkingTreeFormat3, self).__init__()
1807
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1809
def open(self, a_bzrdir, _found=False):
1810
"""Return the WorkingTree object for a_bzrdir
1812
_found is a private parameter, do not use it. It is used to indicate
1813
if format probing has already been done.
1816
# we are being called directly and must probe.
1817
raise NotImplementedError
1818
if not isinstance(a_bzrdir.transport, LocalTransport):
1819
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1820
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1822
def _open(self, a_bzrdir, control_files):
1823
"""Open the tree itself.
1825
:param a_bzrdir: the dir for the tree.
1826
:param control_files: the control files for the tree.
1828
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1832
_control_files=control_files)
1835
return self.get_format_string()
1838
# formats which have no format string are not discoverable
1839
# and not independently creatable, so are not registered.
1840
__default_format = WorkingTreeFormat3()
1841
WorkingTreeFormat.register_format(__default_format)
1842
WorkingTreeFormat.set_default_format(__default_format)
1843
_legacy_formats = [WorkingTreeFormat2(),
1847
class WorkingTreeTestProviderAdapter(object):
1848
"""A tool to generate a suite testing multiple workingtree formats at once.
1850
This is done by copying the test once for each transport and injecting
1851
the transport_server, transport_readonly_server, and workingtree_format
1852
classes into each copy. Each copy is also given a new id() to make it
1856
def __init__(self, transport_server, transport_readonly_server, formats):
1857
self._transport_server = transport_server
1858
self._transport_readonly_server = transport_readonly_server
1859
self._formats = formats
1861
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1862
"""Clone test for adaption."""
1863
new_test = deepcopy(test)
1864
new_test.transport_server = self._transport_server
1865
new_test.transport_readonly_server = self._transport_readonly_server
1866
new_test.bzrdir_format = bzrdir_format
1867
new_test.workingtree_format = workingtree_format
1868
def make_new_test_id():
1869
new_id = "%s(%s)" % (test.id(), variation)
1870
return lambda: new_id
1871
new_test.id = make_new_test_id()
1874
def adapt(self, test):
1875
from bzrlib.tests import TestSuite
1876
result = TestSuite()
1877
for workingtree_format, bzrdir_format in self._formats:
1878
new_test = self._clone_test(
1881
workingtree_format, workingtree_format.__class__.__name__)
1882
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
