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 ?
411
return self.branch.repository.revision_tree(revision_id)
412
except errors.RevisionNotPresent:
413
# the basis tree *may* be a ghost or a low level error may have
414
# occured. If the revision is present, its a problem, if its not
416
if self.branch.repository.has_revision(revision_id):
418
# the basis tree is a ghost
419
return self.branch.repository.revision_tree(None)
422
@deprecated_method(zero_eight)
423
def create(branch, directory):
424
"""Create a workingtree for branch at directory.
426
If existing_directory already exists it must have a .bzr directory.
427
If it does not exist, it will be created.
429
This returns a new WorkingTree object for the new checkout.
431
TODO FIXME RBC 20060124 when we have checkout formats in place this
432
should accept an optional revisionid to checkout [and reject this if
433
checking out into the same dir as a pre-checkout-aware branch format.]
435
XXX: When BzrDir is present, these should be created through that
438
warnings.warn('delete WorkingTree.create', stacklevel=3)
439
transport = get_transport(directory)
440
if branch.bzrdir.root_transport.base == transport.base:
442
return branch.bzrdir.create_workingtree()
443
# different directory,
444
# create a branch reference
445
# and now a working tree.
446
raise NotImplementedError
449
@deprecated_method(zero_eight)
450
def create_standalone(directory):
451
"""Create a checkout and a branch and a repo at directory.
453
Directory must exist and be empty.
455
please use BzrDir.create_standalone_workingtree
457
return bzrdir.BzrDir.create_standalone_workingtree(directory)
459
def relpath(self, path):
460
"""Return the local path portion from a given path.
462
The path may be absolute or relative. If its a relative path it is
463
interpreted relative to the python current working directory.
465
return relpath(self.basedir, path)
467
def has_filename(self, filename):
468
return osutils.lexists(self.abspath(filename))
470
def get_file(self, file_id):
471
return self.get_file_byname(self.id2path(file_id))
473
def get_file_text(self, file_id):
474
return self.get_file(file_id).read()
476
def get_file_byname(self, filename):
477
return file(self.abspath(filename), 'rb')
479
def get_parent_ids(self):
480
"""See Tree.get_parent_ids.
482
This implementation reads the pending merges list and last_revision
483
value and uses that to decide what the parents list should be.
485
last_rev = self.last_revision()
490
other_parents = self.pending_merges()
491
return parents + other_parents
493
def get_root_id(self):
494
"""Return the id of this trees root"""
495
inv = self.read_working_inventory()
496
return inv.root.file_id
498
def _get_store_filename(self, file_id):
499
## XXX: badly named; this is not in the store at all
500
return self.abspath(self.id2path(file_id))
503
def clone(self, to_bzrdir, revision_id=None, basis=None):
504
"""Duplicate this working tree into to_bzr, including all state.
506
Specifically modified files are kept as modified, but
507
ignored and unknown files are discarded.
509
If you want to make a new line of development, see bzrdir.sprout()
512
If not None, the cloned tree will have its last revision set to
513
revision, and and difference between the source trees last revision
514
and this one merged in.
517
If not None, a closer copy of a tree which may have some files in
518
common, and which file content should be preferentially copied from.
520
# assumes the target bzr dir format is compatible.
521
result = self._format.initialize(to_bzrdir)
522
self.copy_content_into(result, revision_id)
526
def copy_content_into(self, tree, revision_id=None):
527
"""Copy the current content and user files of this tree into tree."""
528
if revision_id is None:
529
transform_tree(tree, self)
531
# TODO now merge from tree.last_revision to revision
532
transform_tree(tree, self)
533
tree.set_last_revision(revision_id)
536
def commit(self, message=None, revprops=None, *args, **kwargs):
537
# avoid circular imports
538
from bzrlib.commit import Commit
541
if not 'branch-nick' in revprops:
542
revprops['branch-nick'] = self.branch.nick
543
# args for wt.commit start at message from the Commit.commit method,
544
# but with branch a kwarg now, passing in args as is results in the
545
#message being used for the branch
546
args = (DEPRECATED_PARAMETER, message, ) + args
547
committed_id = Commit().commit( working_tree=self, revprops=revprops,
549
self._set_inventory(self.read_working_inventory())
552
def id2abspath(self, file_id):
553
return self.abspath(self.id2path(file_id))
555
def has_id(self, file_id):
556
# files that have been deleted are excluded
557
inv = self._inventory
558
if not inv.has_id(file_id):
560
path = inv.id2path(file_id)
561
return osutils.lexists(self.abspath(path))
563
def has_or_had_id(self, file_id):
564
if file_id == self.inventory.root.file_id:
566
return self.inventory.has_id(file_id)
568
__contains__ = has_id
570
def get_file_size(self, file_id):
571
return os.path.getsize(self.id2abspath(file_id))
574
def get_file_sha1(self, file_id, path=None):
576
path = self._inventory.id2path(file_id)
577
return self._hashcache.get_sha1(path)
579
def get_file_mtime(self, file_id, path=None):
581
path = self._inventory.id2path(file_id)
582
return os.lstat(self.abspath(path)).st_mtime
584
if not supports_executable():
585
def is_executable(self, file_id, path=None):
586
return self._inventory[file_id].executable
588
def is_executable(self, file_id, path=None):
590
path = self._inventory.id2path(file_id)
591
mode = os.lstat(self.abspath(path)).st_mode
592
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
595
def add(self, files, ids=None):
596
"""Make files versioned.
598
Note that the command line normally calls smart_add instead,
599
which can automatically recurse.
601
This adds the files to the inventory, so that they will be
602
recorded by the next commit.
605
List of paths to add, relative to the base of the tree.
608
If set, use these instead of automatically generated ids.
609
Must be the same length as the list of files, but may
610
contain None for ids that are to be autogenerated.
612
TODO: Perhaps have an option to add the ids even if the files do
615
TODO: Perhaps callback with the ids and paths as they're added.
617
# TODO: Re-adding a file that is removed in the working copy
618
# should probably put it back with the previous ID.
619
if isinstance(files, basestring):
620
assert(ids is None or isinstance(ids, basestring))
626
ids = [None] * len(files)
628
assert(len(ids) == len(files))
630
inv = self.read_working_inventory()
631
for f,file_id in zip(files, ids):
632
if self.is_control_filename(f):
633
raise errors.ForbiddenControlFileError(filename=f)
638
raise BzrError("cannot add top-level %r" % f)
640
fullpath = normpath(self.abspath(f))
642
kind = file_kind(fullpath)
644
if e.errno == errno.ENOENT:
645
raise NoSuchFile(fullpath)
646
if not InventoryEntry.versionable_kind(kind):
647
raise errors.BadFileKindError(filename=f, kind=kind)
649
inv.add_path(f, kind=kind)
651
inv.add_path(f, kind=kind, file_id=file_id)
653
self._write_inventory(inv)
656
def add_pending_merge(self, *revision_ids):
657
# TODO: Perhaps should check at this point that the
658
# history of the revision is actually present?
659
p = self.pending_merges()
660
existing_parents = self.get_parent_ids()
662
for rev_id in revision_ids:
665
if rev_id in existing_parents:
670
self.set_pending_merges(p)
673
def pending_merges(self):
674
"""Return a list of pending merges.
676
These are revisions that have been merged into the working
677
directory but not yet committed.
680
merges_file = self._control_files.get_utf8('pending-merges')
684
for l in merges_file.readlines():
685
p.append(l.rstrip('\n'))
689
def set_pending_merges(self, rev_list):
690
if self.last_revision() is None:
691
new_last_list = rev_list[:1]
692
rev_list = rev_list[1:]
694
self.set_last_revision(new_last_list[0])
695
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
698
def set_merge_modified(self, modified_hashes):
700
for file_id, hash in modified_hashes.iteritems():
701
yield Stanza(file_id=file_id, hash=hash)
702
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
705
def _put_rio(self, filename, stanzas, header):
706
my_file = rio_file(stanzas, header)
707
self._control_files.put(filename, my_file)
710
def merge_modified(self):
712
hashfile = self._control_files.get('merge-hashes')
717
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
718
raise MergeModifiedFormatError()
719
except StopIteration:
720
raise MergeModifiedFormatError()
721
for s in RioReader(hashfile):
722
file_id = s.get("file_id")
723
if file_id not in self.inventory:
726
if hash == self.get_file_sha1(file_id):
727
merge_hashes[file_id] = hash
730
def get_symlink_target(self, file_id):
731
return os.readlink(self.id2abspath(file_id))
733
def file_class(self, filename):
734
if self.path2id(filename):
736
elif self.is_ignored(filename):
741
def list_files(self):
742
"""Recursively list all files as (path, class, kind, id, entry).
744
Lists, but does not descend into unversioned directories.
746
This does not include files that have been deleted in this
749
Skips the control directory.
751
inv = self._inventory
752
# Convert these into local objects to save lookup times
753
pathjoin = osutils.pathjoin
754
file_kind = osutils.file_kind
756
# transport.base ends in a slash, we want the piece
757
# between the last two slashes
758
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
760
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
762
# directory file_id, relative path, absolute path, reverse sorted children
763
children = os.listdir(self.basedir)
765
# jam 20060527 The kernel sized tree seems equivalent whether we
766
# use a deque and popleft to keep them sorted, or if we use a plain
767
# list and just reverse() them.
768
children = collections.deque(children)
769
stack = [(inv.root.file_id, u'', self.basedir, children)]
771
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
774
f = children.popleft()
775
## TODO: If we find a subdirectory with its own .bzr
776
## directory, then that is a separate tree and we
777
## should exclude it.
779
# the bzrdir for this tree
780
if transport_base_dir == f:
783
# we know that from_dir_relpath and from_dir_abspath never end in a slash
784
# and 'f' doesn't begin with one, we can do a string op, rather
785
# than the checks of pathjoin(), all relative paths will have an extra slash
787
fp = from_dir_relpath + '/' + f
790
fap = from_dir_abspath + '/' + f
792
f_ie = inv.get_child(from_dir_id, f)
795
elif self.is_ignored(fp[1:]):
798
# we may not have found this file, because of a unicode issue
799
f_norm, can_access = osutils.normalized_filename(f)
800
if f == f_norm or not can_access:
801
# No change, so treat this file normally
804
# this file can be accessed by a normalized path
805
# check again if it is versioned
806
# these lines are repeated here for performance
808
fp = from_dir_relpath + '/' + f
809
fap = from_dir_abspath + '/' + f
810
f_ie = inv.get_child(from_dir_id, f)
813
elif self.is_ignored(fp[1:]):
822
raise BzrCheckError("file %r entered as kind %r id %r, "
824
% (fap, f_ie.kind, f_ie.file_id, fk))
826
# make a last minute entry
828
yield fp[1:], c, fk, f_ie.file_id, f_ie
831
yield fp[1:], c, fk, None, fk_entries[fk]()
833
yield fp[1:], c, fk, None, TreeEntry()
836
if fk != 'directory':
839
# But do this child first
840
new_children = os.listdir(fap)
842
new_children = collections.deque(new_children)
843
stack.append((f_ie.file_id, fp, fap, new_children))
844
# Break out of inner loop, so that we start outer loop with child
847
# if we finished all children, pop it off the stack
852
def move(self, from_paths, to_name):
855
to_name must exist in the inventory.
857
If to_name exists and is a directory, the files are moved into
858
it, keeping their old names.
860
Note that to_name is only the last component of the new name;
861
this doesn't change the directory.
863
This returns a list of (from_path, to_path) pairs for each
867
## TODO: Option to move IDs only
868
assert not isinstance(from_paths, basestring)
870
to_abs = self.abspath(to_name)
871
if not isdir(to_abs):
872
raise BzrError("destination %r is not a directory" % to_abs)
873
if not self.has_filename(to_name):
874
raise BzrError("destination %r not in working directory" % to_abs)
875
to_dir_id = inv.path2id(to_name)
876
if to_dir_id == None and to_name != '':
877
raise BzrError("destination %r is not a versioned directory" % to_name)
878
to_dir_ie = inv[to_dir_id]
879
if to_dir_ie.kind != 'directory':
880
raise BzrError("destination %r is not a directory" % to_abs)
882
to_idpath = inv.get_idpath(to_dir_id)
885
if not self.has_filename(f):
886
raise BzrError("%r does not exist in working tree" % f)
887
f_id = inv.path2id(f)
889
raise BzrError("%r is not versioned" % f)
890
name_tail = splitpath(f)[-1]
891
dest_path = pathjoin(to_name, name_tail)
892
if self.has_filename(dest_path):
893
raise BzrError("destination %r already exists" % dest_path)
894
if f_id in to_idpath:
895
raise BzrError("can't move %r to a subdirectory of itself" % f)
897
# OK, so there's a race here, it's possible that someone will
898
# create a file in this interval and then the rename might be
899
# left half-done. But we should have caught most problems.
900
orig_inv = deepcopy(self.inventory)
903
name_tail = splitpath(f)[-1]
904
dest_path = pathjoin(to_name, name_tail)
905
result.append((f, dest_path))
906
inv.rename(inv.path2id(f), to_dir_id, name_tail)
908
rename(self.abspath(f), self.abspath(dest_path))
910
raise BzrError("failed to rename %r to %r: %s" %
911
(f, dest_path, e[1]),
912
["rename rolled back"])
914
# restore the inventory on error
915
self._set_inventory(orig_inv)
917
self._write_inventory(inv)
921
def rename_one(self, from_rel, to_rel):
924
This can change the directory or the filename or both.
927
if not self.has_filename(from_rel):
928
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
929
if self.has_filename(to_rel):
930
raise BzrError("can't rename: new working file %r already exists" % to_rel)
932
file_id = inv.path2id(from_rel)
934
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
937
from_parent = entry.parent_id
938
from_name = entry.name
940
if inv.path2id(to_rel):
941
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
943
to_dir, to_tail = os.path.split(to_rel)
944
to_dir_id = inv.path2id(to_dir)
945
if to_dir_id == None and to_dir != '':
946
raise BzrError("can't determine destination directory id for %r" % to_dir)
948
mutter("rename_one:")
949
mutter(" file_id {%s}" % file_id)
950
mutter(" from_rel %r" % from_rel)
951
mutter(" to_rel %r" % to_rel)
952
mutter(" to_dir %r" % to_dir)
953
mutter(" to_dir_id {%s}" % to_dir_id)
955
inv.rename(file_id, to_dir_id, to_tail)
957
from_abs = self.abspath(from_rel)
958
to_abs = self.abspath(to_rel)
960
rename(from_abs, to_abs)
962
inv.rename(file_id, from_parent, from_name)
963
raise BzrError("failed to rename %r to %r: %s"
964
% (from_abs, to_abs, e[1]),
965
["rename rolled back"])
966
self._write_inventory(inv)
970
"""Return all unknown files.
972
These are files in the working directory that are not versioned or
973
control files or ignored.
975
for subp in self.extras():
976
if not self.is_ignored(subp):
979
@deprecated_method(zero_eight)
980
def iter_conflicts(self):
981
"""List all files in the tree that have text or content conflicts.
982
DEPRECATED. Use conflicts instead."""
983
return self._iter_conflicts()
985
def _iter_conflicts(self):
987
for info in self.list_files():
989
stem = get_conflicted_stem(path)
992
if stem not in conflicted:
997
def pull(self, source, overwrite=False, stop_revision=None):
998
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1001
pp = ProgressPhase("Pull phase", 2, top_pb)
1003
old_revision_history = self.branch.revision_history()
1004
basis_tree = self.basis_tree()
1005
count = self.branch.pull(source, overwrite, stop_revision)
1006
new_revision_history = self.branch.revision_history()
1007
if new_revision_history != old_revision_history:
1009
if len(old_revision_history):
1010
other_revision = old_revision_history[-1]
1012
other_revision = None
1013
repository = self.branch.repository
1014
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1016
merge_inner(self.branch,
1017
self.branch.basis_tree(),
1023
self.set_last_revision(self.branch.last_revision())
1030
"""Yield all unknown files in this WorkingTree.
1032
If there are any unknown directories then only the directory is
1033
returned, not all its children. But if there are unknown files
1034
under a versioned subdirectory, they are returned.
1036
Currently returned depth-first, sorted by name within directories.
1038
## TODO: Work from given directory downwards
1039
for path, dir_entry in self.inventory.directories():
1040
# mutter("search for unknowns in %r", path)
1041
dirabs = self.abspath(path)
1042
if not isdir(dirabs):
1043
# e.g. directory deleted
1047
for subf in os.listdir(dirabs):
1050
if subf not in dir_entry.children:
1051
subf_norm, can_access = osutils.normalized_filename(subf)
1052
if subf_norm != subf and can_access:
1053
if subf_norm not in dir_entry.children:
1054
fl.append(subf_norm)
1060
subp = pathjoin(path, subf)
1063
def _translate_ignore_rule(self, rule):
1064
"""Translate a single ignore rule to a regex.
1066
There are two types of ignore rules. Those that do not contain a / are
1067
matched against the tail of the filename (that is, they do not care
1068
what directory the file is in.) Rules which do contain a slash must
1069
match the entire path. As a special case, './' at the start of the
1070
string counts as a slash in the string but is removed before matching
1071
(e.g. ./foo.c, ./src/foo.c)
1073
:return: The translated regex.
1075
if rule[:2] in ('./', '.\\'):
1077
result = fnmatch.translate(rule[2:])
1078
elif '/' in rule or '\\' in rule:
1080
result = fnmatch.translate(rule)
1082
# default rule style.
1083
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1084
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1085
return "(" + result + ")"
1087
def _combine_ignore_rules(self, rules):
1088
"""Combine a list of ignore rules into a single regex object.
1090
Each individual rule is combined with | to form a big regex, which then
1091
has $ added to it to form something like ()|()|()$. The group index for
1092
each subregex's outermost group is placed in a dictionary mapping back
1093
to the rule. This allows quick identification of the matching rule that
1095
:return: a list of the compiled regex and the matching-group index
1096
dictionaries. We return a list because python complains if you try to
1097
combine more than 100 regexes.
1102
translated_rules = []
1104
translated_rule = self._translate_ignore_rule(rule)
1105
compiled_rule = re.compile(translated_rule)
1106
groups[next_group] = rule
1107
next_group += compiled_rule.groups
1108
translated_rules.append(translated_rule)
1109
if next_group == 99:
1110
result.append((re.compile("|".join(translated_rules)), groups))
1113
translated_rules = []
1114
if len(translated_rules):
1115
result.append((re.compile("|".join(translated_rules)), groups))
1118
def ignored_files(self):
1119
"""Yield list of PATH, IGNORE_PATTERN"""
1120
for subp in self.extras():
1121
pat = self.is_ignored(subp)
1125
def get_ignore_list(self):
1126
"""Return list of ignore patterns.
1128
Cached in the Tree object after the first call.
1130
ignoreset = getattr(self, '_ignoreset', None)
1131
if ignoreset is not None:
1134
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1135
ignore_globs.update(ignores.get_runtime_ignores())
1137
ignore_globs.update(ignores.get_user_ignores())
1139
if self.has_filename(bzrlib.IGNORE_FILENAME):
1140
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1142
ignore_globs.update(ignores.parse_ignore_file(f))
1146
self._ignoreset = ignore_globs
1147
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1150
def _get_ignore_rules_as_regex(self):
1151
"""Return a regex of the ignore rules and a mapping dict.
1153
:return: (ignore rules compiled regex, dictionary mapping rule group
1154
indices to original rule.)
1156
if getattr(self, '_ignoreset', None) is None:
1157
self.get_ignore_list()
1158
return self._ignore_regex
1160
def is_ignored(self, filename):
1161
r"""Check whether the filename matches an ignore pattern.
1163
Patterns containing '/' or '\' need to match the whole path;
1164
others match against only the last component.
1166
If the file is ignored, returns the pattern which caused it to
1167
be ignored, otherwise None. So this can simply be used as a
1168
boolean if desired."""
1170
# TODO: Use '**' to match directories, and other extended
1171
# globbing stuff from cvs/rsync.
1173
# XXX: fnmatch is actually not quite what we want: it's only
1174
# approximately the same as real Unix fnmatch, and doesn't
1175
# treat dotfiles correctly and allows * to match /.
1176
# Eventually it should be replaced with something more
1179
rules = self._get_ignore_rules_as_regex()
1180
for regex, mapping in rules:
1181
match = regex.match(filename)
1182
if match is not None:
1183
# one or more of the groups in mapping will have a non-None group
1185
groups = match.groups()
1186
rules = [mapping[group] for group in
1187
mapping if groups[group] is not None]
1191
def kind(self, file_id):
1192
return file_kind(self.id2abspath(file_id))
1195
def last_revision(self):
1196
"""Return the last revision id of this working tree.
1198
In early branch formats this was == the branch last_revision,
1199
but that cannot be relied upon - for working tree operations,
1200
always use tree.last_revision().
1202
return self.branch.last_revision()
1204
def is_locked(self):
1205
return self._control_files.is_locked()
1207
def lock_read(self):
1208
"""See Branch.lock_read, and WorkingTree.unlock."""
1209
self.branch.lock_read()
1211
return self._control_files.lock_read()
1213
self.branch.unlock()
1216
def lock_write(self):
1217
"""See Branch.lock_write, and WorkingTree.unlock."""
1218
self.branch.lock_write()
1220
return self._control_files.lock_write()
1222
self.branch.unlock()
1225
def get_physical_lock_status(self):
1226
return self._control_files.get_physical_lock_status()
1228
def _basis_inventory_name(self):
1229
return 'basis-inventory'
1232
def set_last_revision(self, new_revision):
1233
"""Change the last revision in the working tree."""
1234
if self._change_last_revision(new_revision):
1235
self._cache_basis_inventory(new_revision)
1237
def _change_last_revision(self, new_revision):
1238
"""Template method part of set_last_revision to perform the change.
1240
This is used to allow WorkingTree3 instances to not affect branch
1241
when their last revision is set.
1243
if new_revision is None:
1244
self.branch.set_revision_history([])
1247
self.branch.generate_revision_history(new_revision)
1248
except errors.NoSuchRevision:
1249
# not present in the repo - dont try to set it deeper than the tip
1250
self.branch.set_revision_history([new_revision])
1253
def _cache_basis_inventory(self, new_revision):
1254
"""Cache new_revision as the basis inventory."""
1255
# TODO: this should allow the ready-to-use inventory to be passed in,
1256
# as commit already has that ready-to-use [while the format is the
1259
# this double handles the inventory - unpack and repack -
1260
# but is easier to understand. We can/should put a conditional
1261
# in here based on whether the inventory is in the latest format
1262
# - perhaps we should repack all inventories on a repository
1264
# the fast path is to copy the raw xml from the repository. If the
1265
# xml contains 'revision_id="', then we assume the right
1266
# revision_id is set. We must check for this full string, because a
1267
# root node id can legitimately look like 'revision_id' but cannot
1269
xml = self.branch.repository.get_inventory_xml(new_revision)
1270
if not 'revision_id="' in xml.split('\n', 1)[0]:
1271
inv = self.branch.repository.deserialise_inventory(
1273
inv.revision_id = new_revision
1274
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1275
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1276
path = self._basis_inventory_name()
1278
self._control_files.put(path, sio)
1279
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1282
def read_basis_inventory(self):
1283
"""Read the cached basis inventory."""
1284
path = self._basis_inventory_name()
1285
return self._control_files.get(path).read()
1288
def read_working_inventory(self):
1289
"""Read the working inventory."""
1290
# ElementTree does its own conversion from UTF-8, so open in
1292
result = bzrlib.xml5.serializer_v5.read_inventory(
1293
self._control_files.get('inventory'))
1294
self._set_inventory(result)
1298
def remove(self, files, verbose=False, to_file=None):
1299
"""Remove nominated files from the working inventory..
1301
This does not remove their text. This does not run on XXX on what? RBC
1303
TODO: Refuse to remove modified files unless --force is given?
1305
TODO: Do something useful with directories.
1307
TODO: Should this remove the text or not? Tough call; not
1308
removing may be useful and the user can just use use rm, and
1309
is the opposite of add. Removing it is consistent with most
1310
other tools. Maybe an option.
1312
## TODO: Normalize names
1313
## TODO: Remove nested loops; better scalability
1314
if isinstance(files, basestring):
1317
inv = self.inventory
1319
# do this before any modifications
1321
fid = inv.path2id(f)
1323
# TODO: Perhaps make this just a warning, and continue?
1324
# This tends to happen when
1325
raise NotVersionedError(path=f)
1327
# having remove it, it must be either ignored or unknown
1328
if self.is_ignored(f):
1332
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1335
self._write_inventory(inv)
1338
def revert(self, filenames, old_tree=None, backups=True,
1339
pb=DummyProgress()):
1340
from transform import revert
1341
from conflicts import resolve
1342
if old_tree is None:
1343
old_tree = self.basis_tree()
1344
conflicts = revert(self, old_tree, filenames, backups, pb)
1345
if not len(filenames):
1346
self.set_pending_merges([])
1349
resolve(self, filenames, ignore_misses=True)
1352
# XXX: This method should be deprecated in favour of taking in a proper
1353
# new Inventory object.
1355
def set_inventory(self, new_inventory_list):
1356
from bzrlib.inventory import (Inventory,
1361
inv = Inventory(self.get_root_id())
1362
for path, file_id, parent, kind in new_inventory_list:
1363
name = os.path.basename(path)
1366
# fixme, there should be a factory function inv,add_??
1367
if kind == 'directory':
1368
inv.add(InventoryDirectory(file_id, name, parent))
1369
elif kind == 'file':
1370
inv.add(InventoryFile(file_id, name, parent))
1371
elif kind == 'symlink':
1372
inv.add(InventoryLink(file_id, name, parent))
1374
raise BzrError("unknown kind %r" % kind)
1375
self._write_inventory(inv)
1378
def set_root_id(self, file_id):
1379
"""Set the root id for this tree."""
1380
inv = self.read_working_inventory()
1381
orig_root_id = inv.root.file_id
1382
del inv._byid[inv.root.file_id]
1383
inv.root.file_id = file_id
1384
inv._byid[inv.root.file_id] = inv.root
1387
if entry.parent_id == orig_root_id:
1388
entry.parent_id = inv.root.file_id
1389
self._write_inventory(inv)
1392
"""See Branch.unlock.
1394
WorkingTree locking just uses the Branch locking facilities.
1395
This is current because all working trees have an embedded branch
1396
within them. IF in the future, we were to make branch data shareable
1397
between multiple working trees, i.e. via shared storage, then we
1398
would probably want to lock both the local tree, and the branch.
1400
raise NotImplementedError(self.unlock)
1404
"""Update a working tree along its branch.
1406
This will update the branch if its bound too, which means we have multiple trees involved:
1407
The new basis tree of the master.
1408
The old basis tree of the branch.
1409
The old basis tree of the working tree.
1410
The current working tree state.
1411
pathologically all three may be different, and non ancestors of each other.
1412
Conceptually we want to:
1413
Preserve the wt.basis->wt.state changes
1414
Transform the wt.basis to the new master basis.
1415
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1416
Restore the wt.basis->wt.state changes.
1418
There isn't a single operation at the moment to do that, so we:
1419
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1420
Do a 'normal' merge of the old branch basis if it is relevant.
1422
old_tip = self.branch.update()
1425
if self.last_revision() != self.branch.last_revision():
1426
# merge tree state up to new branch tip.
1427
basis = self.basis_tree()
1428
to_tree = self.branch.basis_tree()
1429
result += merge_inner(self.branch,
1433
self.set_last_revision(self.branch.last_revision())
1434
if old_tip and old_tip != self.last_revision():
1435
# our last revision was not the prior branch last revision
1436
# and we have converted that last revision to a pending merge.
1437
# base is somewhere between the branch tip now
1438
# and the now pending merge
1439
from bzrlib.revision import common_ancestor
1441
base_rev_id = common_ancestor(self.branch.last_revision(),
1443
self.branch.repository)
1444
except errors.NoCommonAncestor:
1446
base_tree = self.branch.repository.revision_tree(base_rev_id)
1447
other_tree = self.branch.repository.revision_tree(old_tip)
1448
result += merge_inner(self.branch,
1454
if old_tip is not None:
1455
self.add_pending_merge(old_tip)
1458
def _write_inventory(self, inv):
1459
"""Write inventory as the current inventory."""
1461
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1463
self._control_files.put('inventory', sio)
1464
self._set_inventory(inv)
1465
mutter('wrote working inventory')
1467
def set_conflicts(self, arg):
1468
raise UnsupportedOperation(self.set_conflicts, self)
1470
def add_conflicts(self, arg):
1471
raise UnsupportedOperation(self.add_conflicts, self)
1474
def conflicts(self):
1475
conflicts = ConflictList()
1476
for conflicted in self._iter_conflicts():
1479
if file_kind(self.abspath(conflicted)) != "file":
1481
except errors.NoSuchFile:
1484
for suffix in ('.THIS', '.OTHER'):
1486
kind = file_kind(self.abspath(conflicted+suffix))
1489
except errors.NoSuchFile:
1493
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1494
conflicts.append(Conflict.factory(ctype, path=conflicted,
1495
file_id=self.path2id(conflicted)))
1499
class WorkingTree2(WorkingTree):
1500
"""This is the Format 2 working tree.
1502
This was the first weave based working tree.
1503
- uses os locks for locking.
1504
- uses the branch last-revision.
1508
# we share control files:
1509
if self._hashcache.needs_write and self._control_files._lock_count==3:
1510
self._hashcache.write()
1511
# reverse order of locking.
1513
return self._control_files.unlock()
1515
self.branch.unlock()
1518
class WorkingTree3(WorkingTree):
1519
"""This is the Format 3 working tree.
1521
This differs from the base WorkingTree by:
1522
- having its own file lock
1523
- having its own last-revision property.
1525
This is new in bzr 0.8
1529
def last_revision(self):
1530
"""See WorkingTree.last_revision."""
1532
return self._control_files.get_utf8('last-revision').read()
1536
def _change_last_revision(self, revision_id):
1537
"""See WorkingTree._change_last_revision."""
1538
if revision_id is None or revision_id == NULL_REVISION:
1540
self._control_files._transport.delete('last-revision')
1541
except errors.NoSuchFile:
1545
self._control_files.put_utf8('last-revision', revision_id)
1549
def set_conflicts(self, conflicts):
1550
self._put_rio('conflicts', conflicts.to_stanzas(),
1554
def add_conflicts(self, new_conflicts):
1555
conflict_set = set(self.conflicts())
1556
conflict_set.update(set(list(new_conflicts)))
1557
self.set_conflicts(ConflictList(sorted(conflict_set,
1558
key=Conflict.sort_key)))
1561
def conflicts(self):
1563
confile = self._control_files.get('conflicts')
1565
return ConflictList()
1567
if confile.next() != CONFLICT_HEADER_1 + '\n':
1568
raise ConflictFormatError()
1569
except StopIteration:
1570
raise ConflictFormatError()
1571
return ConflictList.from_stanzas(RioReader(confile))
1574
if self._hashcache.needs_write and self._control_files._lock_count==1:
1575
self._hashcache.write()
1576
# reverse order of locking.
1578
return self._control_files.unlock()
1580
self.branch.unlock()
1583
def get_conflicted_stem(path):
1584
for suffix in CONFLICT_SUFFIXES:
1585
if path.endswith(suffix):
1586
return path[:-len(suffix)]
1588
@deprecated_function(zero_eight)
1589
def is_control_file(filename):
1590
"""See WorkingTree.is_control_filename(filename)."""
1591
## FIXME: better check
1592
filename = normpath(filename)
1593
while filename != '':
1594
head, tail = os.path.split(filename)
1595
## mutter('check %r for control file' % ((head, tail),))
1598
if filename == head:
1604
class WorkingTreeFormat(object):
1605
"""An encapsulation of the initialization and open routines for a format.
1607
Formats provide three things:
1608
* An initialization routine,
1612
Formats are placed in an dict by their format string for reference
1613
during workingtree opening. Its not required that these be instances, they
1614
can be classes themselves with class methods - it simply depends on
1615
whether state is needed for a given format or not.
1617
Once a format is deprecated, just deprecate the initialize and open
1618
methods on the format class. Do not deprecate the object, as the
1619
object will be created every time regardless.
1622
_default_format = None
1623
"""The default format used for new trees."""
1626
"""The known formats."""
1629
def find_format(klass, a_bzrdir):
1630
"""Return the format for the working tree object in a_bzrdir."""
1632
transport = a_bzrdir.get_workingtree_transport(None)
1633
format_string = transport.get("format").read()
1634
return klass._formats[format_string]
1636
raise errors.NoWorkingTree(base=transport.base)
1638
raise errors.UnknownFormatError(format=format_string)
1641
def get_default_format(klass):
1642
"""Return the current default format."""
1643
return klass._default_format
1645
def get_format_string(self):
1646
"""Return the ASCII format string that identifies this format."""
1647
raise NotImplementedError(self.get_format_string)
1649
def get_format_description(self):
1650
"""Return the short description for this format."""
1651
raise NotImplementedError(self.get_format_description)
1653
def is_supported(self):
1654
"""Is this format supported?
1656
Supported formats can be initialized and opened.
1657
Unsupported formats may not support initialization or committing or
1658
some other features depending on the reason for not being supported.
1663
def register_format(klass, format):
1664
klass._formats[format.get_format_string()] = format
1667
def set_default_format(klass, format):
1668
klass._default_format = format
1671
def unregister_format(klass, format):
1672
assert klass._formats[format.get_format_string()] is format
1673
del klass._formats[format.get_format_string()]
1677
class WorkingTreeFormat2(WorkingTreeFormat):
1678
"""The second working tree format.
1680
This format modified the hash cache from the format 1 hash cache.
1683
def get_format_description(self):
1684
"""See WorkingTreeFormat.get_format_description()."""
1685
return "Working tree format 2"
1687
def stub_initialize_remote(self, control_files):
1688
"""As a special workaround create critical control files for a remote working tree
1690
This ensures that it can later be updated and dealt with locally,
1691
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1692
no working tree. (See bug #43064).
1696
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1698
control_files.put('inventory', sio)
1700
control_files.put_utf8('pending-merges', '')
1703
def initialize(self, a_bzrdir, revision_id=None):
1704
"""See WorkingTreeFormat.initialize()."""
1705
if not isinstance(a_bzrdir.transport, LocalTransport):
1706
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1707
branch = a_bzrdir.open_branch()
1708
if revision_id is not None:
1711
revision_history = branch.revision_history()
1713
position = revision_history.index(revision_id)
1715
raise errors.NoSuchRevision(branch, revision_id)
1716
branch.set_revision_history(revision_history[:position + 1])
1719
revision = branch.last_revision()
1721
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1727
wt._write_inventory(inv)
1728
wt.set_root_id(inv.root.file_id)
1729
wt.set_last_revision(revision)
1730
wt.set_pending_merges([])
1731
build_tree(wt.basis_tree(), wt)
1735
super(WorkingTreeFormat2, self).__init__()
1736
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1738
def open(self, a_bzrdir, _found=False):
1739
"""Return the WorkingTree object for a_bzrdir
1741
_found is a private parameter, do not use it. It is used to indicate
1742
if format probing has already been done.
1745
# we are being called directly and must probe.
1746
raise NotImplementedError
1747
if not isinstance(a_bzrdir.transport, LocalTransport):
1748
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1749
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1755
class WorkingTreeFormat3(WorkingTreeFormat):
1756
"""The second working tree format updated to record a format marker.
1759
- exists within a metadir controlling .bzr
1760
- includes an explicit version marker for the workingtree control
1761
files, separate from the BzrDir format
1762
- modifies the hash cache format
1764
- uses a LockDir to guard access for writes.
1767
def get_format_string(self):
1768
"""See WorkingTreeFormat.get_format_string()."""
1769
return "Bazaar-NG Working Tree format 3"
1771
def get_format_description(self):
1772
"""See WorkingTreeFormat.get_format_description()."""
1773
return "Working tree format 3"
1775
_lock_file_name = 'lock'
1776
_lock_class = LockDir
1778
def _open_control_files(self, a_bzrdir):
1779
transport = a_bzrdir.get_workingtree_transport(None)
1780
return LockableFiles(transport, self._lock_file_name,
1783
def initialize(self, a_bzrdir, revision_id=None):
1784
"""See WorkingTreeFormat.initialize().
1786
revision_id allows creating a working tree at a different
1787
revision than the branch is at.
1789
if not isinstance(a_bzrdir.transport, LocalTransport):
1790
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1791
transport = a_bzrdir.get_workingtree_transport(self)
1792
control_files = self._open_control_files(a_bzrdir)
1793
control_files.create_lock()
1794
control_files.lock_write()
1795
control_files.put_utf8('format', self.get_format_string())
1796
branch = a_bzrdir.open_branch()
1797
if revision_id is None:
1798
revision_id = branch.last_revision()
1800
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1806
_control_files=control_files)
1809
wt._write_inventory(inv)
1810
wt.set_root_id(inv.root.file_id)
1811
wt.set_last_revision(revision_id)
1812
wt.set_pending_merges([])
1813
build_tree(wt.basis_tree(), wt)
1816
control_files.unlock()
1820
super(WorkingTreeFormat3, self).__init__()
1821
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1823
def open(self, a_bzrdir, _found=False):
1824
"""Return the WorkingTree object for a_bzrdir
1826
_found is a private parameter, do not use it. It is used to indicate
1827
if format probing has already been done.
1830
# we are being called directly and must probe.
1831
raise NotImplementedError
1832
if not isinstance(a_bzrdir.transport, LocalTransport):
1833
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1834
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1836
def _open(self, a_bzrdir, control_files):
1837
"""Open the tree itself.
1839
:param a_bzrdir: the dir for the tree.
1840
:param control_files: the control files for the tree.
1842
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1846
_control_files=control_files)
1849
return self.get_format_string()
1852
# formats which have no format string are not discoverable
1853
# and not independently creatable, so are not registered.
1854
__default_format = WorkingTreeFormat3()
1855
WorkingTreeFormat.register_format(__default_format)
1856
WorkingTreeFormat.set_default_format(__default_format)
1857
_legacy_formats = [WorkingTreeFormat2(),
1861
class WorkingTreeTestProviderAdapter(object):
1862
"""A tool to generate a suite testing multiple workingtree formats at once.
1864
This is done by copying the test once for each transport and injecting
1865
the transport_server, transport_readonly_server, and workingtree_format
1866
classes into each copy. Each copy is also given a new id() to make it
1870
def __init__(self, transport_server, transport_readonly_server, formats):
1871
self._transport_server = transport_server
1872
self._transport_readonly_server = transport_readonly_server
1873
self._formats = formats
1875
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1876
"""Clone test for adaption."""
1877
new_test = deepcopy(test)
1878
new_test.transport_server = self._transport_server
1879
new_test.transport_readonly_server = self._transport_readonly_server
1880
new_test.bzrdir_format = bzrdir_format
1881
new_test.workingtree_format = workingtree_format
1882
def make_new_test_id():
1883
new_id = "%s(%s)" % (test.id(), variation)
1884
return lambda: new_id
1885
new_test.id = make_new_test_id()
1888
def adapt(self, test):
1889
from bzrlib.tests import TestSuite
1890
result = TestSuite()
1891
for workingtree_format, bzrdir_format in self._formats:
1892
new_test = self._clone_test(
1895
workingtree_format, workingtree_format.__class__.__name__)
1896
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
