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.xml5.serializer_v5.read_inventory_from_string(xml)
403
inv.root.revision = revision_id
406
if inv is not None and inv.revision_id == revision_id:
407
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
409
# FIXME? RBC 20060403 should we cache the inventory here ?
410
return self.branch.repository.revision_tree(revision_id)
413
@deprecated_method(zero_eight)
414
def create(branch, directory):
415
"""Create a workingtree for branch at directory.
417
If existing_directory already exists it must have a .bzr directory.
418
If it does not exist, it will be created.
420
This returns a new WorkingTree object for the new checkout.
422
TODO FIXME RBC 20060124 when we have checkout formats in place this
423
should accept an optional revisionid to checkout [and reject this if
424
checking out into the same dir as a pre-checkout-aware branch format.]
426
XXX: When BzrDir is present, these should be created through that
429
warnings.warn('delete WorkingTree.create', stacklevel=3)
430
transport = get_transport(directory)
431
if branch.bzrdir.root_transport.base == transport.base:
433
return branch.bzrdir.create_workingtree()
434
# different directory,
435
# create a branch reference
436
# and now a working tree.
437
raise NotImplementedError
440
@deprecated_method(zero_eight)
441
def create_standalone(directory):
442
"""Create a checkout and a branch and a repo at directory.
444
Directory must exist and be empty.
446
please use BzrDir.create_standalone_workingtree
448
return bzrdir.BzrDir.create_standalone_workingtree(directory)
450
def relpath(self, path):
451
"""Return the local path portion from a given path.
453
The path may be absolute or relative. If its a relative path it is
454
interpreted relative to the python current working directory.
456
return relpath(self.basedir, path)
458
def has_filename(self, filename):
459
return osutils.lexists(self.abspath(filename))
461
def get_file(self, file_id):
462
return self.get_file_byname(self.id2path(file_id))
464
def get_file_text(self, file_id):
465
return self.get_file(file_id).read()
467
def get_file_byname(self, filename):
468
return file(self.abspath(filename), 'rb')
470
def get_parent_ids(self):
471
"""See Tree.get_parent_ids.
473
This implementation reads the pending merges list and last_revision
474
value and uses that to decide what the parents list should be.
476
last_rev = self.last_revision()
481
other_parents = self.pending_merges()
482
return parents + other_parents
484
def get_root_id(self):
485
"""Return the id of this trees root"""
486
inv = self.read_working_inventory()
487
return inv.root.file_id
489
def _get_store_filename(self, file_id):
490
## XXX: badly named; this is not in the store at all
491
return self.abspath(self.id2path(file_id))
494
def clone(self, to_bzrdir, revision_id=None, basis=None):
495
"""Duplicate this working tree into to_bzr, including all state.
497
Specifically modified files are kept as modified, but
498
ignored and unknown files are discarded.
500
If you want to make a new line of development, see bzrdir.sprout()
503
If not None, the cloned tree will have its last revision set to
504
revision, and and difference between the source trees last revision
505
and this one merged in.
508
If not None, a closer copy of a tree which may have some files in
509
common, and which file content should be preferentially copied from.
511
# assumes the target bzr dir format is compatible.
512
result = self._format.initialize(to_bzrdir)
513
self.copy_content_into(result, revision_id)
517
def copy_content_into(self, tree, revision_id=None):
518
"""Copy the current content and user files of this tree into tree."""
519
if revision_id is None:
520
transform_tree(tree, self)
522
# TODO now merge from tree.last_revision to revision
523
transform_tree(tree, self)
524
tree.set_last_revision(revision_id)
527
def commit(self, message=None, revprops=None, *args, **kwargs):
528
# avoid circular imports
529
from bzrlib.commit import Commit
532
if not 'branch-nick' in revprops:
533
revprops['branch-nick'] = self.branch.nick
534
# args for wt.commit start at message from the Commit.commit method,
535
# but with branch a kwarg now, passing in args as is results in the
536
#message being used for the branch
537
args = (DEPRECATED_PARAMETER, message, ) + args
538
committed_id = Commit().commit( working_tree=self, revprops=revprops,
540
self._set_inventory(self.read_working_inventory())
543
def id2abspath(self, file_id):
544
return self.abspath(self.id2path(file_id))
546
def has_id(self, file_id):
547
# files that have been deleted are excluded
548
inv = self._inventory
549
if not inv.has_id(file_id):
551
path = inv.id2path(file_id)
552
return osutils.lexists(self.abspath(path))
554
def has_or_had_id(self, file_id):
555
if file_id == self.inventory.root.file_id:
557
return self.inventory.has_id(file_id)
559
__contains__ = has_id
561
def get_file_size(self, file_id):
562
return os.path.getsize(self.id2abspath(file_id))
565
def get_file_sha1(self, file_id, path=None):
567
path = self._inventory.id2path(file_id)
568
return self._hashcache.get_sha1(path)
570
def get_file_mtime(self, file_id, path=None):
572
path = self._inventory.id2path(file_id)
573
return os.lstat(self.abspath(path)).st_mtime
575
if not supports_executable():
576
def is_executable(self, file_id, path=None):
577
return self._inventory[file_id].executable
579
def is_executable(self, file_id, path=None):
581
path = self._inventory.id2path(file_id)
582
mode = os.lstat(self.abspath(path)).st_mode
583
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
586
def add(self, files, ids=None):
587
"""Make files versioned.
589
Note that the command line normally calls smart_add instead,
590
which can automatically recurse.
592
This adds the files to the inventory, so that they will be
593
recorded by the next commit.
596
List of paths to add, relative to the base of the tree.
599
If set, use these instead of automatically generated ids.
600
Must be the same length as the list of files, but may
601
contain None for ids that are to be autogenerated.
603
TODO: Perhaps have an option to add the ids even if the files do
606
TODO: Perhaps callback with the ids and paths as they're added.
608
# TODO: Re-adding a file that is removed in the working copy
609
# should probably put it back with the previous ID.
610
if isinstance(files, basestring):
611
assert(ids is None or isinstance(ids, basestring))
617
ids = [None] * len(files)
619
assert(len(ids) == len(files))
621
inv = self.read_working_inventory()
622
for f,file_id in zip(files, ids):
623
if self.is_control_filename(f):
624
raise errors.ForbiddenControlFileError(filename=f)
629
raise BzrError("cannot add top-level %r" % f)
631
fullpath = normpath(self.abspath(f))
633
kind = file_kind(fullpath)
635
if e.errno == errno.ENOENT:
636
raise NoSuchFile(fullpath)
637
if not InventoryEntry.versionable_kind(kind):
638
raise errors.BadFileKindError(filename=f, kind=kind)
640
inv.add_path(f, kind=kind)
642
inv.add_path(f, kind=kind, file_id=file_id)
644
self._write_inventory(inv)
647
def add_pending_merge(self, *revision_ids):
648
# TODO: Perhaps should check at this point that the
649
# history of the revision is actually present?
650
p = self.pending_merges()
652
for rev_id in revision_ids:
658
self.set_pending_merges(p)
661
def pending_merges(self):
662
"""Return a list of pending merges.
664
These are revisions that have been merged into the working
665
directory but not yet committed.
668
merges_file = self._control_files.get_utf8('pending-merges')
672
for l in merges_file.readlines():
673
p.append(l.rstrip('\n'))
677
def set_pending_merges(self, rev_list):
678
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
681
def set_merge_modified(self, modified_hashes):
683
for file_id, hash in modified_hashes.iteritems():
684
yield Stanza(file_id=file_id, hash=hash)
685
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
688
def _put_rio(self, filename, stanzas, header):
689
my_file = rio_file(stanzas, header)
690
self._control_files.put(filename, my_file)
693
def merge_modified(self):
695
hashfile = self._control_files.get('merge-hashes')
700
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
701
raise MergeModifiedFormatError()
702
except StopIteration:
703
raise MergeModifiedFormatError()
704
for s in RioReader(hashfile):
705
file_id = s.get("file_id")
706
if file_id not in self.inventory:
709
if hash == self.get_file_sha1(file_id):
710
merge_hashes[file_id] = hash
713
def get_symlink_target(self, file_id):
714
return os.readlink(self.id2abspath(file_id))
716
def file_class(self, filename):
717
if self.path2id(filename):
719
elif self.is_ignored(filename):
724
def list_files(self):
725
"""Recursively list all files as (path, class, kind, id, entry).
727
Lists, but does not descend into unversioned directories.
729
This does not include files that have been deleted in this
732
Skips the control directory.
734
inv = self._inventory
735
# Convert these into local objects to save lookup times
736
pathjoin = osutils.pathjoin
737
file_kind = osutils.file_kind
739
# transport.base ends in a slash, we want the piece
740
# between the last two slashes
741
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
743
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
745
# directory file_id, relative path, absolute path, reverse sorted children
746
children = os.listdir(self.basedir)
748
# jam 20060527 The kernel sized tree seems equivalent whether we
749
# use a deque and popleft to keep them sorted, or if we use a plain
750
# list and just reverse() them.
751
children = collections.deque(children)
752
stack = [(inv.root.file_id, u'', self.basedir, children)]
754
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
757
f = children.popleft()
758
## TODO: If we find a subdirectory with its own .bzr
759
## directory, then that is a separate tree and we
760
## should exclude it.
762
# the bzrdir for this tree
763
if transport_base_dir == f:
766
# we know that from_dir_relpath and from_dir_abspath never end in a slash
767
# and 'f' doesn't begin with one, we can do a string op, rather
768
# than the checks of pathjoin(), all relative paths will have an extra slash
770
fp = from_dir_relpath + '/' + f
773
fap = from_dir_abspath + '/' + f
775
f_ie = inv.get_child(from_dir_id, f)
778
elif self.is_ignored(fp[1:]):
781
# we may not have found this file, because of a unicode issue
782
f_norm, can_access = osutils.normalized_filename(f)
783
if f == f_norm or not can_access:
784
# No change, so treat this file normally
787
# this file can be accessed by a normalized path
788
# check again if it is versioned
789
# these lines are repeated here for performance
791
fp = from_dir_relpath + '/' + f
792
fap = from_dir_abspath + '/' + f
793
f_ie = inv.get_child(from_dir_id, f)
796
elif self.is_ignored(fp[1:]):
805
raise BzrCheckError("file %r entered as kind %r id %r, "
807
% (fap, f_ie.kind, f_ie.file_id, fk))
809
# make a last minute entry
811
yield fp[1:], c, fk, f_ie.file_id, f_ie
814
yield fp[1:], c, fk, None, fk_entries[fk]()
816
yield fp[1:], c, fk, None, TreeEntry()
819
if fk != 'directory':
822
# But do this child first
823
new_children = os.listdir(fap)
825
new_children = collections.deque(new_children)
826
stack.append((f_ie.file_id, fp, fap, new_children))
827
# Break out of inner loop, so that we start outer loop with child
830
# if we finished all children, pop it off the stack
835
def move(self, from_paths, to_name):
838
to_name must exist in the inventory.
840
If to_name exists and is a directory, the files are moved into
841
it, keeping their old names.
843
Note that to_name is only the last component of the new name;
844
this doesn't change the directory.
846
This returns a list of (from_path, to_path) pairs for each
850
## TODO: Option to move IDs only
851
assert not isinstance(from_paths, basestring)
853
to_abs = self.abspath(to_name)
854
if not isdir(to_abs):
855
raise BzrError("destination %r is not a directory" % to_abs)
856
if not self.has_filename(to_name):
857
raise BzrError("destination %r not in working directory" % to_abs)
858
to_dir_id = inv.path2id(to_name)
859
if to_dir_id == None and to_name != '':
860
raise BzrError("destination %r is not a versioned directory" % to_name)
861
to_dir_ie = inv[to_dir_id]
862
if to_dir_ie.kind != 'directory':
863
raise BzrError("destination %r is not a directory" % to_abs)
865
to_idpath = inv.get_idpath(to_dir_id)
868
if not self.has_filename(f):
869
raise BzrError("%r does not exist in working tree" % f)
870
f_id = inv.path2id(f)
872
raise BzrError("%r is not versioned" % f)
873
name_tail = splitpath(f)[-1]
874
dest_path = pathjoin(to_name, name_tail)
875
if self.has_filename(dest_path):
876
raise BzrError("destination %r already exists" % dest_path)
877
if f_id in to_idpath:
878
raise BzrError("can't move %r to a subdirectory of itself" % f)
880
# OK, so there's a race here, it's possible that someone will
881
# create a file in this interval and then the rename might be
882
# left half-done. But we should have caught most problems.
883
orig_inv = deepcopy(self.inventory)
886
name_tail = splitpath(f)[-1]
887
dest_path = pathjoin(to_name, name_tail)
888
result.append((f, dest_path))
889
inv.rename(inv.path2id(f), to_dir_id, name_tail)
891
rename(self.abspath(f), self.abspath(dest_path))
893
raise BzrError("failed to rename %r to %r: %s" %
894
(f, dest_path, e[1]),
895
["rename rolled back"])
897
# restore the inventory on error
898
self._set_inventory(orig_inv)
900
self._write_inventory(inv)
904
def rename_one(self, from_rel, to_rel):
907
This can change the directory or the filename or both.
910
if not self.has_filename(from_rel):
911
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
912
if self.has_filename(to_rel):
913
raise BzrError("can't rename: new working file %r already exists" % to_rel)
915
file_id = inv.path2id(from_rel)
917
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
920
from_parent = entry.parent_id
921
from_name = entry.name
923
if inv.path2id(to_rel):
924
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
926
to_dir, to_tail = os.path.split(to_rel)
927
to_dir_id = inv.path2id(to_dir)
928
if to_dir_id == None and to_dir != '':
929
raise BzrError("can't determine destination directory id for %r" % to_dir)
931
mutter("rename_one:")
932
mutter(" file_id {%s}" % file_id)
933
mutter(" from_rel %r" % from_rel)
934
mutter(" to_rel %r" % to_rel)
935
mutter(" to_dir %r" % to_dir)
936
mutter(" to_dir_id {%s}" % to_dir_id)
938
inv.rename(file_id, to_dir_id, to_tail)
940
from_abs = self.abspath(from_rel)
941
to_abs = self.abspath(to_rel)
943
rename(from_abs, to_abs)
945
inv.rename(file_id, from_parent, from_name)
946
raise BzrError("failed to rename %r to %r: %s"
947
% (from_abs, to_abs, e[1]),
948
["rename rolled back"])
949
self._write_inventory(inv)
953
"""Return all unknown files.
955
These are files in the working directory that are not versioned or
956
control files or ignored.
958
for subp in self.extras():
959
if not self.is_ignored(subp):
962
@deprecated_method(zero_eight)
963
def iter_conflicts(self):
964
"""List all files in the tree that have text or content conflicts.
965
DEPRECATED. Use conflicts instead."""
966
return self._iter_conflicts()
968
def _iter_conflicts(self):
970
for info in self.list_files():
972
stem = get_conflicted_stem(path)
975
if stem not in conflicted:
980
def pull(self, source, overwrite=False, stop_revision=None):
981
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
984
pp = ProgressPhase("Pull phase", 2, top_pb)
986
old_revision_history = self.branch.revision_history()
987
basis_tree = self.basis_tree()
988
count = self.branch.pull(source, overwrite, stop_revision)
989
new_revision_history = self.branch.revision_history()
990
if new_revision_history != old_revision_history:
992
if len(old_revision_history):
993
other_revision = old_revision_history[-1]
995
other_revision = None
996
repository = self.branch.repository
997
pb = bzrlib.ui.ui_factory.nested_progress_bar()
999
merge_inner(self.branch,
1000
self.branch.basis_tree(),
1006
self.set_last_revision(self.branch.last_revision())
1013
"""Yield all unknown files in this WorkingTree.
1015
If there are any unknown directories then only the directory is
1016
returned, not all its children. But if there are unknown files
1017
under a versioned subdirectory, they are returned.
1019
Currently returned depth-first, sorted by name within directories.
1021
## TODO: Work from given directory downwards
1022
for path, dir_entry in self.inventory.directories():
1023
# mutter("search for unknowns in %r", path)
1024
dirabs = self.abspath(path)
1025
if not isdir(dirabs):
1026
# e.g. directory deleted
1030
for subf in os.listdir(dirabs):
1033
if subf not in dir_entry.children:
1034
subf_norm, can_access = osutils.normalized_filename(subf)
1035
if subf_norm != subf and can_access:
1036
if subf_norm not in dir_entry.children:
1037
fl.append(subf_norm)
1043
subp = pathjoin(path, subf)
1046
def _translate_ignore_rule(self, rule):
1047
"""Translate a single ignore rule to a regex.
1049
There are two types of ignore rules. Those that do not contain a / are
1050
matched against the tail of the filename (that is, they do not care
1051
what directory the file is in.) Rules which do contain a slash must
1052
match the entire path. As a special case, './' at the start of the
1053
string counts as a slash in the string but is removed before matching
1054
(e.g. ./foo.c, ./src/foo.c)
1056
:return: The translated regex.
1058
if rule[:2] in ('./', '.\\'):
1060
result = fnmatch.translate(rule[2:])
1061
elif '/' in rule or '\\' in rule:
1063
result = fnmatch.translate(rule)
1065
# default rule style.
1066
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1067
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1068
return "(" + result + ")"
1070
def _combine_ignore_rules(self, rules):
1071
"""Combine a list of ignore rules into a single regex object.
1073
Each individual rule is combined with | to form a big regex, which then
1074
has $ added to it to form something like ()|()|()$. The group index for
1075
each subregex's outermost group is placed in a dictionary mapping back
1076
to the rule. This allows quick identification of the matching rule that
1078
:return: a list of the compiled regex and the matching-group index
1079
dictionaries. We return a list because python complains if you try to
1080
combine more than 100 regexes.
1085
translated_rules = []
1087
translated_rule = self._translate_ignore_rule(rule)
1088
compiled_rule = re.compile(translated_rule)
1089
groups[next_group] = rule
1090
next_group += compiled_rule.groups
1091
translated_rules.append(translated_rule)
1092
if next_group == 99:
1093
result.append((re.compile("|".join(translated_rules)), groups))
1096
translated_rules = []
1097
if len(translated_rules):
1098
result.append((re.compile("|".join(translated_rules)), groups))
1101
def ignored_files(self):
1102
"""Yield list of PATH, IGNORE_PATTERN"""
1103
for subp in self.extras():
1104
pat = self.is_ignored(subp)
1108
def get_ignore_list(self):
1109
"""Return list of ignore patterns.
1111
Cached in the Tree object after the first call.
1113
ignoreset = getattr(self, '_ignoreset', None)
1114
if ignoreset is not None:
1117
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1118
ignore_globs.update(ignores.get_runtime_ignores())
1120
ignore_globs.update(ignores.get_user_ignores())
1122
if self.has_filename(bzrlib.IGNORE_FILENAME):
1123
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1125
ignore_globs.update(ignores.parse_ignore_file(f))
1129
self._ignoreset = ignore_globs
1130
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1133
def _get_ignore_rules_as_regex(self):
1134
"""Return a regex of the ignore rules and a mapping dict.
1136
:return: (ignore rules compiled regex, dictionary mapping rule group
1137
indices to original rule.)
1139
if getattr(self, '_ignoreset', None) is None:
1140
self.get_ignore_list()
1141
return self._ignore_regex
1143
def is_ignored(self, filename):
1144
r"""Check whether the filename matches an ignore pattern.
1146
Patterns containing '/' or '\' need to match the whole path;
1147
others match against only the last component.
1149
If the file is ignored, returns the pattern which caused it to
1150
be ignored, otherwise None. So this can simply be used as a
1151
boolean if desired."""
1153
# TODO: Use '**' to match directories, and other extended
1154
# globbing stuff from cvs/rsync.
1156
# XXX: fnmatch is actually not quite what we want: it's only
1157
# approximately the same as real Unix fnmatch, and doesn't
1158
# treat dotfiles correctly and allows * to match /.
1159
# Eventually it should be replaced with something more
1162
rules = self._get_ignore_rules_as_regex()
1163
for regex, mapping in rules:
1164
match = regex.match(filename)
1165
if match is not None:
1166
# one or more of the groups in mapping will have a non-None group
1168
groups = match.groups()
1169
rules = [mapping[group] for group in
1170
mapping if groups[group] is not None]
1174
def kind(self, file_id):
1175
return file_kind(self.id2abspath(file_id))
1178
def last_revision(self):
1179
"""Return the last revision id of this working tree.
1181
In early branch formats this was == the branch last_revision,
1182
but that cannot be relied upon - for working tree operations,
1183
always use tree.last_revision().
1185
return self.branch.last_revision()
1187
def is_locked(self):
1188
return self._control_files.is_locked()
1190
def lock_read(self):
1191
"""See Branch.lock_read, and WorkingTree.unlock."""
1192
self.branch.lock_read()
1194
return self._control_files.lock_read()
1196
self.branch.unlock()
1199
def lock_write(self):
1200
"""See Branch.lock_write, and WorkingTree.unlock."""
1201
self.branch.lock_write()
1203
return self._control_files.lock_write()
1205
self.branch.unlock()
1208
def get_physical_lock_status(self):
1209
return self._control_files.get_physical_lock_status()
1211
def _basis_inventory_name(self):
1212
return 'basis-inventory'
1215
def set_last_revision(self, new_revision):
1216
"""Change the last revision in the working tree."""
1217
if self._change_last_revision(new_revision):
1218
self._cache_basis_inventory(new_revision)
1220
def _change_last_revision(self, new_revision):
1221
"""Template method part of set_last_revision to perform the change.
1223
This is used to allow WorkingTree3 instances to not affect branch
1224
when their last revision is set.
1226
if new_revision is None:
1227
self.branch.set_revision_history([])
1230
self.branch.generate_revision_history(new_revision)
1231
except errors.NoSuchRevision:
1232
# not present in the repo - dont try to set it deeper than the tip
1233
self.branch.set_revision_history([new_revision])
1236
def _cache_basis_inventory(self, new_revision):
1237
"""Cache new_revision as the basis inventory."""
1238
# TODO: this should allow the ready-to-use inventory to be passed in,
1239
# as commit already has that ready-to-use [while the format is the
1242
# this double handles the inventory - unpack and repack -
1243
# but is easier to understand. We can/should put a conditional
1244
# in here based on whether the inventory is in the latest format
1245
# - perhaps we should repack all inventories on a repository
1247
# the fast path is to copy the raw xml from the repository. If the
1248
# xml contains 'revision_id="', then we assume the right
1249
# revision_id is set. We must check for this full string, because a
1250
# root node id can legitimately look like 'revision_id' but cannot
1252
xml = self.branch.repository.get_inventory_xml(new_revision)
1253
if not 'revision_id="' in xml.split('\n', 1)[0]:
1254
inv = self.branch.repository.deserialise_inventory(
1256
inv.revision_id = new_revision
1257
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1258
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1259
path = self._basis_inventory_name()
1261
self._control_files.put(path, sio)
1262
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1265
def read_basis_inventory(self):
1266
"""Read the cached basis inventory."""
1267
path = self._basis_inventory_name()
1268
return self._control_files.get(path).read()
1271
def read_working_inventory(self):
1272
"""Read the working inventory."""
1273
# ElementTree does its own conversion from UTF-8, so open in
1275
result = bzrlib.xml5.serializer_v5.read_inventory(
1276
self._control_files.get('inventory'))
1277
self._set_inventory(result)
1281
def remove(self, files, verbose=False, to_file=None):
1282
"""Remove nominated files from the working inventory..
1284
This does not remove their text. This does not run on XXX on what? RBC
1286
TODO: Refuse to remove modified files unless --force is given?
1288
TODO: Do something useful with directories.
1290
TODO: Should this remove the text or not? Tough call; not
1291
removing may be useful and the user can just use use rm, and
1292
is the opposite of add. Removing it is consistent with most
1293
other tools. Maybe an option.
1295
## TODO: Normalize names
1296
## TODO: Remove nested loops; better scalability
1297
if isinstance(files, basestring):
1300
inv = self.inventory
1302
# do this before any modifications
1304
fid = inv.path2id(f)
1306
# TODO: Perhaps make this just a warning, and continue?
1307
# This tends to happen when
1308
raise NotVersionedError(path=f)
1310
# having remove it, it must be either ignored or unknown
1311
if self.is_ignored(f):
1315
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1318
self._write_inventory(inv)
1321
def revert(self, filenames, old_tree=None, backups=True,
1322
pb=DummyProgress()):
1323
from transform import revert
1324
from conflicts import resolve
1325
if old_tree is None:
1326
old_tree = self.basis_tree()
1327
conflicts = revert(self, old_tree, filenames, backups, pb)
1328
if not len(filenames):
1329
self.set_pending_merges([])
1332
resolve(self, filenames, ignore_misses=True)
1335
# XXX: This method should be deprecated in favour of taking in a proper
1336
# new Inventory object.
1338
def set_inventory(self, new_inventory_list):
1339
from bzrlib.inventory import (Inventory,
1344
inv = Inventory(self.get_root_id())
1345
for path, file_id, parent, kind in new_inventory_list:
1346
name = os.path.basename(path)
1349
# fixme, there should be a factory function inv,add_??
1350
if kind == 'directory':
1351
inv.add(InventoryDirectory(file_id, name, parent))
1352
elif kind == 'file':
1353
inv.add(InventoryFile(file_id, name, parent))
1354
elif kind == 'symlink':
1355
inv.add(InventoryLink(file_id, name, parent))
1357
raise BzrError("unknown kind %r" % kind)
1358
self._write_inventory(inv)
1361
def set_root_id(self, file_id):
1362
"""Set the root id for this tree."""
1363
inv = self.read_working_inventory()
1364
orig_root_id = inv.root.file_id
1365
del inv._byid[inv.root.file_id]
1366
inv.root.file_id = file_id
1367
inv._byid[inv.root.file_id] = inv.root
1370
if entry.parent_id == orig_root_id:
1371
entry.parent_id = inv.root.file_id
1372
self._write_inventory(inv)
1375
"""See Branch.unlock.
1377
WorkingTree locking just uses the Branch locking facilities.
1378
This is current because all working trees have an embedded branch
1379
within them. IF in the future, we were to make branch data shareable
1380
between multiple working trees, i.e. via shared storage, then we
1381
would probably want to lock both the local tree, and the branch.
1383
raise NotImplementedError(self.unlock)
1387
"""Update a working tree along its branch.
1389
This will update the branch if its bound too, which means we have multiple trees involved:
1390
The new basis tree of the master.
1391
The old basis tree of the branch.
1392
The old basis tree of the working tree.
1393
The current working tree state.
1394
pathologically all three may be different, and non ancestors of each other.
1395
Conceptually we want to:
1396
Preserve the wt.basis->wt.state changes
1397
Transform the wt.basis to the new master basis.
1398
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1399
Restore the wt.basis->wt.state changes.
1401
There isn't a single operation at the moment to do that, so we:
1402
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1403
Do a 'normal' merge of the old branch basis if it is relevant.
1405
old_tip = self.branch.update()
1406
if old_tip is not None:
1407
self.add_pending_merge(old_tip)
1408
self.branch.lock_read()
1411
if self.last_revision() != self.branch.last_revision():
1412
# merge tree state up to new branch tip.
1413
basis = self.basis_tree()
1414
to_tree = self.branch.basis_tree()
1415
result += merge_inner(self.branch,
1419
self.set_last_revision(self.branch.last_revision())
1420
if old_tip and old_tip != self.last_revision():
1421
# our last revision was not the prior branch last revision
1422
# and we have converted that last revision to a pending merge.
1423
# base is somewhere between the branch tip now
1424
# and the now pending merge
1425
from bzrlib.revision import common_ancestor
1427
base_rev_id = common_ancestor(self.branch.last_revision(),
1429
self.branch.repository)
1430
except errors.NoCommonAncestor:
1432
base_tree = self.branch.repository.revision_tree(base_rev_id)
1433
other_tree = self.branch.repository.revision_tree(old_tip)
1434
result += merge_inner(self.branch,
1440
self.branch.unlock()
1443
def _write_inventory(self, inv):
1444
"""Write inventory as the current inventory."""
1446
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1448
self._control_files.put('inventory', sio)
1449
self._set_inventory(inv)
1450
mutter('wrote working inventory')
1452
def set_conflicts(self, arg):
1453
raise UnsupportedOperation(self.set_conflicts, self)
1455
def add_conflicts(self, arg):
1456
raise UnsupportedOperation(self.add_conflicts, self)
1459
def conflicts(self):
1460
conflicts = ConflictList()
1461
for conflicted in self._iter_conflicts():
1464
if file_kind(self.abspath(conflicted)) != "file":
1466
except errors.NoSuchFile:
1469
for suffix in ('.THIS', '.OTHER'):
1471
kind = file_kind(self.abspath(conflicted+suffix))
1474
except errors.NoSuchFile:
1478
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1479
conflicts.append(Conflict.factory(ctype, path=conflicted,
1480
file_id=self.path2id(conflicted)))
1484
class WorkingTree2(WorkingTree):
1485
"""This is the Format 2 working tree.
1487
This was the first weave based working tree.
1488
- uses os locks for locking.
1489
- uses the branch last-revision.
1493
# we share control files:
1494
if self._hashcache.needs_write and self._control_files._lock_count==3:
1495
self._hashcache.write()
1496
# reverse order of locking.
1498
return self._control_files.unlock()
1500
self.branch.unlock()
1503
class WorkingTree3(WorkingTree):
1504
"""This is the Format 3 working tree.
1506
This differs from the base WorkingTree by:
1507
- having its own file lock
1508
- having its own last-revision property.
1510
This is new in bzr 0.8
1514
def last_revision(self):
1515
"""See WorkingTree.last_revision."""
1517
return self._control_files.get_utf8('last-revision').read()
1521
def _change_last_revision(self, revision_id):
1522
"""See WorkingTree._change_last_revision."""
1523
if revision_id is None or revision_id == NULL_REVISION:
1525
self._control_files._transport.delete('last-revision')
1526
except errors.NoSuchFile:
1530
self._control_files.put_utf8('last-revision', revision_id)
1534
def set_conflicts(self, conflicts):
1535
self._put_rio('conflicts', conflicts.to_stanzas(),
1539
def add_conflicts(self, new_conflicts):
1540
conflict_set = set(self.conflicts())
1541
conflict_set.update(set(list(new_conflicts)))
1542
self.set_conflicts(ConflictList(sorted(conflict_set,
1543
key=Conflict.sort_key)))
1546
def conflicts(self):
1548
confile = self._control_files.get('conflicts')
1550
return ConflictList()
1552
if confile.next() != CONFLICT_HEADER_1 + '\n':
1553
raise ConflictFormatError()
1554
except StopIteration:
1555
raise ConflictFormatError()
1556
return ConflictList.from_stanzas(RioReader(confile))
1559
if self._hashcache.needs_write and self._control_files._lock_count==1:
1560
self._hashcache.write()
1561
# reverse order of locking.
1563
return self._control_files.unlock()
1565
self.branch.unlock()
1568
def get_conflicted_stem(path):
1569
for suffix in CONFLICT_SUFFIXES:
1570
if path.endswith(suffix):
1571
return path[:-len(suffix)]
1573
@deprecated_function(zero_eight)
1574
def is_control_file(filename):
1575
"""See WorkingTree.is_control_filename(filename)."""
1576
## FIXME: better check
1577
filename = normpath(filename)
1578
while filename != '':
1579
head, tail = os.path.split(filename)
1580
## mutter('check %r for control file' % ((head, tail),))
1583
if filename == head:
1589
class WorkingTreeFormat(object):
1590
"""An encapsulation of the initialization and open routines for a format.
1592
Formats provide three things:
1593
* An initialization routine,
1597
Formats are placed in an dict by their format string for reference
1598
during workingtree opening. Its not required that these be instances, they
1599
can be classes themselves with class methods - it simply depends on
1600
whether state is needed for a given format or not.
1602
Once a format is deprecated, just deprecate the initialize and open
1603
methods on the format class. Do not deprecate the object, as the
1604
object will be created every time regardless.
1607
_default_format = None
1608
"""The default format used for new trees."""
1611
"""The known formats."""
1614
def find_format(klass, a_bzrdir):
1615
"""Return the format for the working tree object in a_bzrdir."""
1617
transport = a_bzrdir.get_workingtree_transport(None)
1618
format_string = transport.get("format").read()
1619
return klass._formats[format_string]
1621
raise errors.NoWorkingTree(base=transport.base)
1623
raise errors.UnknownFormatError(format=format_string)
1626
def get_default_format(klass):
1627
"""Return the current default format."""
1628
return klass._default_format
1630
def get_format_string(self):
1631
"""Return the ASCII format string that identifies this format."""
1632
raise NotImplementedError(self.get_format_string)
1634
def get_format_description(self):
1635
"""Return the short description for this format."""
1636
raise NotImplementedError(self.get_format_description)
1638
def is_supported(self):
1639
"""Is this format supported?
1641
Supported formats can be initialized and opened.
1642
Unsupported formats may not support initialization or committing or
1643
some other features depending on the reason for not being supported.
1648
def register_format(klass, format):
1649
klass._formats[format.get_format_string()] = format
1652
def set_default_format(klass, format):
1653
klass._default_format = format
1656
def unregister_format(klass, format):
1657
assert klass._formats[format.get_format_string()] is format
1658
del klass._formats[format.get_format_string()]
1662
class WorkingTreeFormat2(WorkingTreeFormat):
1663
"""The second working tree format.
1665
This format modified the hash cache from the format 1 hash cache.
1668
def get_format_description(self):
1669
"""See WorkingTreeFormat.get_format_description()."""
1670
return "Working tree format 2"
1672
def stub_initialize_remote(self, control_files):
1673
"""As a special workaround create critical control files for a remote working tree
1675
This ensures that it can later be updated and dealt with locally,
1676
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1677
no working tree. (See bug #43064).
1681
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1683
control_files.put('inventory', sio)
1685
control_files.put_utf8('pending-merges', '')
1688
def initialize(self, a_bzrdir, revision_id=None):
1689
"""See WorkingTreeFormat.initialize()."""
1690
if not isinstance(a_bzrdir.transport, LocalTransport):
1691
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1692
branch = a_bzrdir.open_branch()
1693
if revision_id is not None:
1696
revision_history = branch.revision_history()
1698
position = revision_history.index(revision_id)
1700
raise errors.NoSuchRevision(branch, revision_id)
1701
branch.set_revision_history(revision_history[:position + 1])
1704
revision = branch.last_revision()
1706
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1712
wt._write_inventory(inv)
1713
wt.set_root_id(inv.root.file_id)
1714
wt.set_last_revision(revision)
1715
wt.set_pending_merges([])
1716
build_tree(wt.basis_tree(), wt)
1720
super(WorkingTreeFormat2, self).__init__()
1721
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1723
def open(self, a_bzrdir, _found=False):
1724
"""Return the WorkingTree object for a_bzrdir
1726
_found is a private parameter, do not use it. It is used to indicate
1727
if format probing has already been done.
1730
# we are being called directly and must probe.
1731
raise NotImplementedError
1732
if not isinstance(a_bzrdir.transport, LocalTransport):
1733
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1734
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1740
class WorkingTreeFormat3(WorkingTreeFormat):
1741
"""The second working tree format updated to record a format marker.
1744
- exists within a metadir controlling .bzr
1745
- includes an explicit version marker for the workingtree control
1746
files, separate from the BzrDir format
1747
- modifies the hash cache format
1749
- uses a LockDir to guard access for writes.
1752
def get_format_string(self):
1753
"""See WorkingTreeFormat.get_format_string()."""
1754
return "Bazaar-NG Working Tree format 3"
1756
def get_format_description(self):
1757
"""See WorkingTreeFormat.get_format_description()."""
1758
return "Working tree format 3"
1760
_lock_file_name = 'lock'
1761
_lock_class = LockDir
1763
def _open_control_files(self, a_bzrdir):
1764
transport = a_bzrdir.get_workingtree_transport(None)
1765
return LockableFiles(transport, self._lock_file_name,
1768
def initialize(self, a_bzrdir, revision_id=None):
1769
"""See WorkingTreeFormat.initialize().
1771
revision_id allows creating a working tree at a different
1772
revision than the branch is at.
1774
if not isinstance(a_bzrdir.transport, LocalTransport):
1775
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1776
transport = a_bzrdir.get_workingtree_transport(self)
1777
control_files = self._open_control_files(a_bzrdir)
1778
control_files.create_lock()
1779
control_files.lock_write()
1780
control_files.put_utf8('format', self.get_format_string())
1781
branch = a_bzrdir.open_branch()
1782
if revision_id is None:
1783
revision_id = branch.last_revision()
1785
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1791
_control_files=control_files)
1794
wt._write_inventory(inv)
1795
wt.set_root_id(inv.root.file_id)
1796
wt.set_last_revision(revision_id)
1797
wt.set_pending_merges([])
1798
build_tree(wt.basis_tree(), wt)
1801
control_files.unlock()
1805
super(WorkingTreeFormat3, self).__init__()
1806
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1808
def open(self, a_bzrdir, _found=False):
1809
"""Return the WorkingTree object for a_bzrdir
1811
_found is a private parameter, do not use it. It is used to indicate
1812
if format probing has already been done.
1815
# we are being called directly and must probe.
1816
raise NotImplementedError
1817
if not isinstance(a_bzrdir.transport, LocalTransport):
1818
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1819
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1821
def _open(self, a_bzrdir, control_files):
1822
"""Open the tree itself.
1824
:param a_bzrdir: the dir for the tree.
1825
:param control_files: the control files for the tree.
1827
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1831
_control_files=control_files)
1834
return self.get_format_string()
1837
# formats which have no format string are not discoverable
1838
# and not independently creatable, so are not registered.
1839
__default_format = WorkingTreeFormat3()
1840
WorkingTreeFormat.register_format(__default_format)
1841
WorkingTreeFormat.set_default_format(__default_format)
1842
_legacy_formats = [WorkingTreeFormat2(),
1846
class WorkingTreeTestProviderAdapter(object):
1847
"""A tool to generate a suite testing multiple workingtree formats at once.
1849
This is done by copying the test once for each transport and injecting
1850
the transport_server, transport_readonly_server, and workingtree_format
1851
classes into each copy. Each copy is also given a new id() to make it
1855
def __init__(self, transport_server, transport_readonly_server, formats):
1856
self._transport_server = transport_server
1857
self._transport_readonly_server = transport_readonly_server
1858
self._formats = formats
1860
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1861
"""Clone test for adaption."""
1862
new_test = deepcopy(test)
1863
new_test.transport_server = self._transport_server
1864
new_test.transport_readonly_server = self._transport_readonly_server
1865
new_test.bzrdir_format = bzrdir_format
1866
new_test.workingtree_format = workingtree_format
1867
def make_new_test_id():
1868
new_id = "%s(%s)" % (test.id(), variation)
1869
return lambda: new_id
1870
new_test.id = make_new_test_id()
1873
def adapt(self, test):
1874
from bzrlib.tests import TestSuite
1875
result = TestSuite()
1876
for workingtree_format, bzrdir_format in self._formats:
1877
new_test = self._clone_test(
1880
workingtree_format, workingtree_format.__class__.__name__)
1881
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
