1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.trace import mutter, note
101
from bzrlib.transform import build_tree
102
from bzrlib.transport import get_transport
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.textui import show_status
110
# the regex removes any weird characters; we don't escape them
111
# but rather just pull them out
112
_gen_file_id_re = re.compile(r'[^\w.]')
113
_gen_id_suffix = None
117
def _next_id_suffix():
118
"""Create a new file id suffix that is reasonably unique.
120
On the first call we combine the current time with 64 bits of randomness
121
to give a highly probably globally unique number. Then each call in the same
122
process adds 1 to a serial number we append to that unique value.
124
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
125
# than having to move the id randomness out of the inner loop like this.
126
# XXX TODO: for the global randomness this uses we should add the thread-id
127
# before the serial #.
128
global _gen_id_suffix, _gen_id_serial
129
if _gen_id_suffix is None:
130
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
132
return _gen_id_suffix + str(_gen_id_serial)
135
def gen_file_id(name):
136
"""Return new file id for the basename 'name'.
138
The uniqueness is supplied from _next_id_suffix.
140
# The real randomness is in the _next_id_suffix, the
141
# rest of the identifier is just to be nice.
143
# 1) Remove non-ascii word characters to keep the ids portable
144
# 2) squash to lowercase, so the file id doesn't have to
145
# be escaped (case insensitive filesystems would bork for ids
146
# that only differred in case without escaping).
147
# 3) truncate the filename to 20 chars. Long filenames also bork on some
149
# 4) Removing starting '.' characters to prevent the file ids from
150
# being considered hidden.
151
ascii_word_only = _gen_file_id_re.sub('', name.lower())
152
short_no_dots = ascii_word_only.lstrip('.')[:20]
153
return short_no_dots + _next_id_suffix()
157
"""Return a new tree-root file id."""
158
return gen_file_id('TREE_ROOT')
161
class TreeEntry(object):
162
"""An entry that implements the minimum interface used by commands.
164
This needs further inspection, it may be better to have
165
InventoryEntries without ids - though that seems wrong. For now,
166
this is a parallel hierarchy to InventoryEntry, and needs to become
167
one of several things: decorates to that hierarchy, children of, or
169
Another note is that these objects are currently only used when there is
170
no InventoryEntry available - i.e. for unversioned objects.
171
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
174
def __eq__(self, other):
175
# yes, this us ugly, TODO: best practice __eq__ style.
176
return (isinstance(other, TreeEntry)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeDirectory(TreeEntry):
184
"""See TreeEntry. This is a directory in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeDirectory)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeFile(TreeEntry):
195
"""See TreeEntry. This is a regular file in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeFile)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class TreeLink(TreeEntry):
206
"""See TreeEntry. This is a symlink in a working tree."""
208
def __eq__(self, other):
209
return (isinstance(other, TreeLink)
210
and other.__class__ == self.__class__)
212
def kind_character(self):
216
class WorkingTree(bzrlib.tree.Tree):
217
"""Working copy tree.
219
The inventory is held in the `Branch` working-inventory, and the
220
files are in a directory on disk.
222
It is possible for a `WorkingTree` to have a filename which is
223
not listed in the Inventory and vice versa.
226
def __init__(self, basedir='.',
227
branch=DEPRECATED_PARAMETER,
233
"""Construct a WorkingTree for basedir.
235
If the branch is not supplied, it is opened automatically.
236
If the branch is supplied, it must be the branch for this basedir.
237
(branch.base is not cross checked, because for remote branches that
238
would be meaningless).
240
self._format = _format
241
self.bzrdir = _bzrdir
243
# not created via open etc.
244
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
245
"Please use bzrdir.open_workingtree or WorkingTree.open().",
248
wt = WorkingTree.open(basedir)
249
self._branch = wt.branch
250
self.basedir = wt.basedir
251
self._control_files = wt._control_files
252
self._hashcache = wt._hashcache
253
self._set_inventory(wt._inventory)
254
self._format = wt._format
255
self.bzrdir = wt.bzrdir
256
from bzrlib.hashcache import HashCache
257
from bzrlib.trace import note, mutter
258
assert isinstance(basedir, basestring), \
259
"base directory %r is not a string" % basedir
260
basedir = safe_unicode(basedir)
261
mutter("opening working tree %r", basedir)
262
if deprecated_passed(branch):
264
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
265
" Please use bzrdir.open_workingtree() or"
266
" WorkingTree.open().",
270
self._branch = branch
272
self._branch = self.bzrdir.open_branch()
273
self.basedir = realpath(basedir)
274
# if branch is at our basedir and is a format 6 or less
275
if isinstance(self._format, WorkingTreeFormat2):
276
# share control object
277
self._control_files = self.branch.control_files
279
# assume all other formats have their own control files.
280
assert isinstance(_control_files, LockableFiles), \
281
"_control_files must be a LockableFiles, not %r" \
283
self._control_files = _control_files
284
# update the whole cache up front and write to disk if anything changed;
285
# in the future we might want to do this more selectively
286
# two possible ways offer themselves : in self._unlock, write the cache
287
# if needed, or, when the cache sees a change, append it to the hash
288
# cache file, and have the parser take the most recent entry for a
290
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
291
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
293
# is this scan needed ? it makes things kinda slow.
300
if _inventory is None:
301
self._set_inventory(self.read_working_inventory())
303
self._set_inventory(_inventory)
306
fget=lambda self: self._branch,
307
doc="""The branch this WorkingTree is connected to.
309
This cannot be set - it is reflective of the actual disk structure
310
the working tree has been constructed from.
313
def break_lock(self):
314
"""Break a lock if one is present from another instance.
316
Uses the ui factory to ask for confirmation if the lock may be from
319
This will probe the repository for its lock as well.
321
self._control_files.break_lock()
322
self.branch.break_lock()
324
def _set_inventory(self, inv):
325
self._inventory = inv
326
self.path2id = self._inventory.path2id
328
def is_control_filename(self, filename):
329
"""True if filename is the name of a control file in this tree.
331
:param filename: A filename within the tree. This is a relative path
332
from the root of this tree.
334
This is true IF and ONLY IF the filename is part of the meta data
335
that bzr controls in this tree. I.E. a random .bzr directory placed
336
on disk will not be a control file for this tree.
338
return self.bzrdir.is_control_filename(filename)
341
def open(path=None, _unsupported=False):
342
"""Open an existing working tree at path.
346
path = os.path.getcwdu()
347
control = bzrdir.BzrDir.open(path, _unsupported)
348
return control.open_workingtree(_unsupported)
351
def open_containing(path=None):
352
"""Open an existing working tree which has its root about path.
354
This probes for a working tree at path and searches upwards from there.
356
Basically we keep looking up until we find the control directory or
357
run into /. If there isn't one, raises NotBranchError.
358
TODO: give this a new exception.
359
If there is one, it is returned, along with the unused portion of path.
361
:return: The WorkingTree that contains 'path', and the rest of path
364
path = osutils.getcwd()
365
control, relpath = bzrdir.BzrDir.open_containing(path)
367
return control.open_workingtree(), relpath
370
def open_downlevel(path=None):
371
"""Open an unsupported working tree.
373
Only intended for advanced situations like upgrading part of a bzrdir.
375
return WorkingTree.open(path, _unsupported=True)
378
"""Iterate through file_ids for this tree.
380
file_ids are in a WorkingTree if they are in the working inventory
381
and the working file exists.
383
inv = self._inventory
384
for path, ie in inv.iter_entries():
385
if osutils.lexists(self.abspath(path)):
389
return "<%s of %s>" % (self.__class__.__name__,
390
getattr(self, 'basedir', None))
392
def abspath(self, filename):
393
return pathjoin(self.basedir, filename)
395
def basis_tree(self):
396
"""Return RevisionTree for the current last revision."""
397
revision_id = self.last_revision()
398
if revision_id is not None:
400
xml = self.read_basis_inventory()
401
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
404
if inv is not None and inv.revision_id == revision_id:
405
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
407
# FIXME? RBC 20060403 should we cache the inventory here ?
408
return self.branch.repository.revision_tree(revision_id)
411
@deprecated_method(zero_eight)
412
def create(branch, directory):
413
"""Create a workingtree for branch at directory.
415
If existing_directory already exists it must have a .bzr directory.
416
If it does not exist, it will be created.
418
This returns a new WorkingTree object for the new checkout.
420
TODO FIXME RBC 20060124 when we have checkout formats in place this
421
should accept an optional revisionid to checkout [and reject this if
422
checking out into the same dir as a pre-checkout-aware branch format.]
424
XXX: When BzrDir is present, these should be created through that
427
warnings.warn('delete WorkingTree.create', stacklevel=3)
428
transport = get_transport(directory)
429
if branch.bzrdir.root_transport.base == transport.base:
431
return branch.bzrdir.create_workingtree()
432
# different directory,
433
# create a branch reference
434
# and now a working tree.
435
raise NotImplementedError
438
@deprecated_method(zero_eight)
439
def create_standalone(directory):
440
"""Create a checkout and a branch and a repo at directory.
442
Directory must exist and be empty.
444
please use BzrDir.create_standalone_workingtree
446
return bzrdir.BzrDir.create_standalone_workingtree(directory)
448
def relpath(self, path):
449
"""Return the local path portion from a given path.
451
The path may be absolute or relative. If its a relative path it is
452
interpreted relative to the python current working directory.
454
return relpath(self.basedir, path)
456
def has_filename(self, filename):
457
return osutils.lexists(self.abspath(filename))
459
def get_file(self, file_id):
460
return self.get_file_byname(self.id2path(file_id))
462
def get_file_text(self, file_id):
463
return self.get_file(file_id).read()
465
def get_file_byname(self, filename):
466
return file(self.abspath(filename), 'rb')
468
def get_parent_ids(self):
469
"""See Tree.get_parent_ids.
471
This implementation reads the pending merges list and last_revision
472
value and uses that to decide what the parents list should be.
474
last_rev = self.last_revision()
479
other_parents = self.pending_merges()
480
return parents + other_parents
482
def get_root_id(self):
483
"""Return the id of this trees root"""
484
inv = self.read_working_inventory()
485
return inv.root.file_id
487
def _get_store_filename(self, file_id):
488
## XXX: badly named; this is not in the store at all
489
return self.abspath(self.id2path(file_id))
492
def clone(self, to_bzrdir, revision_id=None, basis=None):
493
"""Duplicate this working tree into to_bzr, including all state.
495
Specifically modified files are kept as modified, but
496
ignored and unknown files are discarded.
498
If you want to make a new line of development, see bzrdir.sprout()
501
If not None, the cloned tree will have its last revision set to
502
revision, and and difference between the source trees last revision
503
and this one merged in.
506
If not None, a closer copy of a tree which may have some files in
507
common, and which file content should be preferentially copied from.
509
# assumes the target bzr dir format is compatible.
510
result = self._format.initialize(to_bzrdir)
511
self.copy_content_into(result, revision_id)
515
def copy_content_into(self, tree, revision_id=None):
516
"""Copy the current content and user files of this tree into tree."""
517
tree.set_root_id(self.get_root_id())
518
if revision_id is None:
519
transform_tree(tree, self)
521
# TODO now merge from tree.last_revision to revision
522
transform_tree(tree, self)
523
tree.set_last_revision(revision_id)
526
def commit(self, message=None, revprops=None, *args, **kwargs):
527
# avoid circular imports
528
from bzrlib.commit import Commit
531
if not 'branch-nick' in revprops:
532
revprops['branch-nick'] = self.branch.nick
533
# args for wt.commit start at message from the Commit.commit method,
534
# but with branch a kwarg now, passing in args as is results in the
535
#message being used for the branch
536
args = (DEPRECATED_PARAMETER, message, ) + args
537
committed_id = Commit().commit( working_tree=self, revprops=revprops,
539
self._set_inventory(self.read_working_inventory())
542
def id2abspath(self, file_id):
543
return self.abspath(self.id2path(file_id))
545
def has_id(self, file_id):
546
# files that have been deleted are excluded
547
inv = self._inventory
548
if not inv.has_id(file_id):
550
path = inv.id2path(file_id)
551
return osutils.lexists(self.abspath(path))
553
def has_or_had_id(self, file_id):
554
if file_id == self.inventory.root.file_id:
556
return self.inventory.has_id(file_id)
558
__contains__ = has_id
560
def get_file_size(self, file_id):
561
return os.path.getsize(self.id2abspath(file_id))
564
def get_file_sha1(self, file_id, path=None):
566
path = self._inventory.id2path(file_id)
567
return self._hashcache.get_sha1(path)
569
def get_file_mtime(self, file_id, path=None):
571
path = self._inventory.id2path(file_id)
572
return os.lstat(self.abspath(path)).st_mtime
574
if not supports_executable():
575
def is_executable(self, file_id, path=None):
576
return self._inventory[file_id].executable
578
def is_executable(self, file_id, path=None):
580
path = self._inventory.id2path(file_id)
581
mode = os.lstat(self.abspath(path)).st_mode
582
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
585
def add(self, files, ids=None):
586
"""Make files versioned.
588
Note that the command line normally calls smart_add instead,
589
which can automatically recurse.
591
This adds the files to the inventory, so that they will be
592
recorded by the next commit.
595
List of paths to add, relative to the base of the tree.
598
If set, use these instead of automatically generated ids.
599
Must be the same length as the list of files, but may
600
contain None for ids that are to be autogenerated.
602
TODO: Perhaps have an option to add the ids even if the files do
605
TODO: Perhaps callback with the ids and paths as they're added.
607
# TODO: Re-adding a file that is removed in the working copy
608
# should probably put it back with the previous ID.
609
if isinstance(files, basestring):
610
assert(ids is None or isinstance(ids, basestring))
616
ids = [None] * len(files)
618
assert(len(ids) == len(files))
620
inv = self.read_working_inventory()
621
for f,file_id in zip(files, ids):
622
if self.is_control_filename(f):
623
raise errors.ForbiddenControlFileError(filename=f)
628
raise BzrError("cannot add top-level %r" % f)
630
fullpath = normpath(self.abspath(f))
632
kind = file_kind(fullpath)
634
if e.errno == errno.ENOENT:
635
raise NoSuchFile(fullpath)
636
if not InventoryEntry.versionable_kind(kind):
637
raise errors.BadFileKindError(filename=f, kind=kind)
639
inv.add_path(f, kind=kind)
641
inv.add_path(f, kind=kind, file_id=file_id)
643
self._write_inventory(inv)
646
def add_pending_merge(self, *revision_ids):
647
# TODO: Perhaps should check at this point that the
648
# history of the revision is actually present?
649
p = self.pending_merges()
651
for rev_id in revision_ids:
657
self.set_pending_merges(p)
660
def pending_merges(self):
661
"""Return a list of pending merges.
663
These are revisions that have been merged into the working
664
directory but not yet committed.
667
merges_file = self._control_files.get_utf8('pending-merges')
671
for l in merges_file.readlines():
672
p.append(l.rstrip('\n'))
676
def set_pending_merges(self, rev_list):
677
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
680
def set_merge_modified(self, modified_hashes):
682
for file_id, hash in modified_hashes.iteritems():
683
yield Stanza(file_id=file_id, hash=hash)
684
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
687
def _put_rio(self, filename, stanzas, header):
688
my_file = rio_file(stanzas, header)
689
self._control_files.put(filename, my_file)
692
def merge_modified(self):
694
hashfile = self._control_files.get('merge-hashes')
699
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
700
raise MergeModifiedFormatError()
701
except StopIteration:
702
raise MergeModifiedFormatError()
703
for s in RioReader(hashfile):
704
file_id = s.get("file_id")
705
if file_id not in self.inventory:
708
if hash == self.get_file_sha1(file_id):
709
merge_hashes[file_id] = hash
712
def get_symlink_target(self, file_id):
713
return os.readlink(self.id2abspath(file_id))
715
def file_class(self, filename):
716
if self.path2id(filename):
718
elif self.is_ignored(filename):
723
def list_files(self, include_root=False):
724
"""Recursively list all files as (path, class, kind, id, entry).
726
Lists, but does not descend into unversioned directories.
728
This does not include files that have been deleted in this
731
Skips the control directory.
733
inv = self._inventory
734
# Convert these into local objects to save lookup times
735
pathjoin = osutils.pathjoin
736
file_kind = osutils.file_kind
738
# transport.base ends in a slash, we want the piece
739
# between the last two slashes
740
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
742
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
744
# directory file_id, relative path, absolute path, reverse sorted children
745
children = os.listdir(self.basedir)
747
# jam 20060527 The kernel sized tree seems equivalent whether we
748
# use a deque and popleft to keep them sorted, or if we use a plain
749
# list and just reverse() them.
750
children = collections.deque(children)
751
stack = [(inv.root.file_id, u'', self.basedir, children)]
753
yield u'', 'V', 'directory', inv.root.file_id, inv.root
755
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
758
f = children.popleft()
759
## TODO: If we find a subdirectory with its own .bzr
760
## directory, then that is a separate tree and we
761
## should exclude it.
763
# the bzrdir for this tree
764
if transport_base_dir == f:
767
# we know that from_dir_relpath and from_dir_abspath never end in a slash
768
# and 'f' doesn't begin with one, we can do a string op, rather
769
# than the checks of pathjoin(), all relative paths will have an extra slash
771
fp = from_dir_relpath + '/' + f
774
fap = from_dir_abspath + '/' + f
776
f_ie = inv.get_child(from_dir_id, f)
779
elif self.is_ignored(fp[1:]):
782
# we may not have found this file, because of a unicode issue
783
f_norm, can_access = osutils.normalized_filename(f)
784
if f == f_norm or not can_access:
785
# No change, so treat this file normally
788
# this file can be accessed by a normalized path
789
# check again if it is versioned
790
# these lines are repeated here for performance
792
fp = from_dir_relpath + '/' + f
793
fap = from_dir_abspath + '/' + f
794
f_ie = inv.get_child(from_dir_id, f)
797
elif self.is_ignored(fp[1:]):
806
raise BzrCheckError("file %r entered as kind %r id %r, "
808
% (fap, f_ie.kind, f_ie.file_id, fk))
810
# make a last minute entry
812
yield fp[1:], c, fk, f_ie.file_id, f_ie
815
yield fp[1:], c, fk, None, fk_entries[fk]()
817
yield fp[1:], c, fk, None, TreeEntry()
820
if fk != 'directory':
823
# But do this child first
824
new_children = os.listdir(fap)
826
new_children = collections.deque(new_children)
827
stack.append((f_ie.file_id, fp, fap, new_children))
828
# Break out of inner loop, so that we start outer loop with child
831
# if we finished all children, pop it off the stack
836
def move(self, from_paths, to_name):
839
to_name must exist in the inventory.
841
If to_name exists and is a directory, the files are moved into
842
it, keeping their old names.
844
Note that to_name is only the last component of the new name;
845
this doesn't change the directory.
847
This returns a list of (from_path, to_path) pairs for each
851
## TODO: Option to move IDs only
852
assert not isinstance(from_paths, basestring)
854
to_abs = self.abspath(to_name)
855
if not isdir(to_abs):
856
raise BzrError("destination %r is not a directory" % to_abs)
857
if not self.has_filename(to_name):
858
raise BzrError("destination %r not in working directory" % to_abs)
859
to_dir_id = inv.path2id(to_name)
860
if to_dir_id == None and to_name != '':
861
raise BzrError("destination %r is not a versioned directory" % to_name)
862
to_dir_ie = inv[to_dir_id]
863
if to_dir_ie.kind != 'directory':
864
raise BzrError("destination %r is not a directory" % to_abs)
866
to_idpath = inv.get_idpath(to_dir_id)
869
if not self.has_filename(f):
870
raise BzrError("%r does not exist in working tree" % f)
871
f_id = inv.path2id(f)
873
raise BzrError("%r is not versioned" % f)
874
name_tail = splitpath(f)[-1]
875
dest_path = pathjoin(to_name, name_tail)
876
if self.has_filename(dest_path):
877
raise BzrError("destination %r already exists" % dest_path)
878
if f_id in to_idpath:
879
raise BzrError("can't move %r to a subdirectory of itself" % f)
881
# OK, so there's a race here, it's possible that someone will
882
# create a file in this interval and then the rename might be
883
# left half-done. But we should have caught most problems.
884
orig_inv = deepcopy(self.inventory)
887
name_tail = splitpath(f)[-1]
888
dest_path = pathjoin(to_name, name_tail)
889
result.append((f, dest_path))
890
inv.rename(inv.path2id(f), to_dir_id, name_tail)
892
rename(self.abspath(f), self.abspath(dest_path))
894
raise BzrError("failed to rename %r to %r: %s" %
895
(f, dest_path, e[1]),
896
["rename rolled back"])
898
# restore the inventory on error
899
self._set_inventory(orig_inv)
901
self._write_inventory(inv)
905
def rename_one(self, from_rel, to_rel):
908
This can change the directory or the filename or both.
911
if not self.has_filename(from_rel):
912
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
913
if self.has_filename(to_rel):
914
raise BzrError("can't rename: new working file %r already exists" % to_rel)
916
file_id = inv.path2id(from_rel)
918
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
921
from_parent = entry.parent_id
922
from_name = entry.name
924
if inv.path2id(to_rel):
925
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
927
to_dir, to_tail = os.path.split(to_rel)
928
to_dir_id = inv.path2id(to_dir)
929
if to_dir_id == None and to_dir != '':
930
raise BzrError("can't determine destination directory id for %r" % to_dir)
932
mutter("rename_one:")
933
mutter(" file_id {%s}" % file_id)
934
mutter(" from_rel %r" % from_rel)
935
mutter(" to_rel %r" % to_rel)
936
mutter(" to_dir %r" % to_dir)
937
mutter(" to_dir_id {%s}" % to_dir_id)
939
inv.rename(file_id, to_dir_id, to_tail)
941
from_abs = self.abspath(from_rel)
942
to_abs = self.abspath(to_rel)
944
rename(from_abs, to_abs)
946
inv.rename(file_id, from_parent, from_name)
947
raise BzrError("failed to rename %r to %r: %s"
948
% (from_abs, to_abs, e[1]),
949
["rename rolled back"])
950
self._write_inventory(inv)
954
"""Return all unknown files.
956
These are files in the working directory that are not versioned or
957
control files or ignored.
959
for subp in self.extras():
960
if not self.is_ignored(subp):
963
@deprecated_method(zero_eight)
964
def iter_conflicts(self):
965
"""List all files in the tree that have text or content conflicts.
966
DEPRECATED. Use conflicts instead."""
967
return self._iter_conflicts()
969
def _iter_conflicts(self):
971
for info in self.list_files():
973
stem = get_conflicted_stem(path)
976
if stem not in conflicted:
981
def pull(self, source, overwrite=False, stop_revision=None):
982
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
985
pp = ProgressPhase("Pull phase", 2, top_pb)
987
old_revision_history = self.branch.revision_history()
988
basis_tree = self.basis_tree()
989
count = self.branch.pull(source, overwrite, stop_revision)
990
new_revision_history = self.branch.revision_history()
991
if new_revision_history != old_revision_history:
993
if len(old_revision_history):
994
other_revision = old_revision_history[-1]
996
other_revision = None
997
repository = self.branch.repository
998
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1000
branch_basis = self.branch.basis_tree()
1001
merge_inner(self.branch, branch_basis, basis_tree,
1002
this_tree=self, pb=pb)
1003
if (basis_tree.inventory.root is None and
1004
branch_basis.inventory.root is not None):
1005
self.set_root_id(branch_basis.inventory.root.file_id)
1008
self.set_last_revision(self.branch.last_revision())
1015
"""Yield all unknown files in this WorkingTree.
1017
If there are any unknown directories then only the directory is
1018
returned, not all its children. But if there are unknown files
1019
under a versioned subdirectory, they are returned.
1021
Currently returned depth-first, sorted by name within directories.
1023
## TODO: Work from given directory downwards
1024
for path, dir_entry in self.inventory.directories():
1025
# mutter("search for unknowns in %r", path)
1026
dirabs = self.abspath(path)
1027
if not isdir(dirabs):
1028
# e.g. directory deleted
1032
for subf in os.listdir(dirabs):
1035
if subf not in dir_entry.children:
1036
subf_norm, can_access = osutils.normalized_filename(subf)
1037
if subf_norm != subf and can_access:
1038
if subf_norm not in dir_entry.children:
1039
fl.append(subf_norm)
1045
subp = pathjoin(path, subf)
1048
def _translate_ignore_rule(self, rule):
1049
"""Translate a single ignore rule to a regex.
1051
There are two types of ignore rules. Those that do not contain a / are
1052
matched against the tail of the filename (that is, they do not care
1053
what directory the file is in.) Rules which do contain a slash must
1054
match the entire path. As a special case, './' at the start of the
1055
string counts as a slash in the string but is removed before matching
1056
(e.g. ./foo.c, ./src/foo.c)
1058
:return: The translated regex.
1060
if rule[:2] in ('./', '.\\'):
1062
result = fnmatch.translate(rule[2:])
1063
elif '/' in rule or '\\' in rule:
1065
result = fnmatch.translate(rule)
1067
# default rule style.
1068
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1069
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1070
return "(" + result + ")"
1072
def _combine_ignore_rules(self, rules):
1073
"""Combine a list of ignore rules into a single regex object.
1075
Each individual rule is combined with | to form a big regex, which then
1076
has $ added to it to form something like ()|()|()$. The group index for
1077
each subregex's outermost group is placed in a dictionary mapping back
1078
to the rule. This allows quick identification of the matching rule that
1080
:return: a list of the compiled regex and the matching-group index
1081
dictionaries. We return a list because python complains if you try to
1082
combine more than 100 regexes.
1087
translated_rules = []
1089
translated_rule = self._translate_ignore_rule(rule)
1090
compiled_rule = re.compile(translated_rule)
1091
groups[next_group] = rule
1092
next_group += compiled_rule.groups
1093
translated_rules.append(translated_rule)
1094
if next_group == 99:
1095
result.append((re.compile("|".join(translated_rules)), groups))
1098
translated_rules = []
1099
if len(translated_rules):
1100
result.append((re.compile("|".join(translated_rules)), groups))
1103
def ignored_files(self):
1104
"""Yield list of PATH, IGNORE_PATTERN"""
1105
for subp in self.extras():
1106
pat = self.is_ignored(subp)
1110
def get_ignore_list(self):
1111
"""Return list of ignore patterns.
1113
Cached in the Tree object after the first call.
1115
ignoreset = getattr(self, '_ignoreset', None)
1116
if ignoreset is not None:
1119
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1120
ignore_globs.update(ignores.get_runtime_ignores())
1122
ignore_globs.update(ignores.get_user_ignores())
1124
if self.has_filename(bzrlib.IGNORE_FILENAME):
1125
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1127
ignore_globs.update(ignores.parse_ignore_file(f))
1131
self._ignoreset = ignore_globs
1132
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1135
def _get_ignore_rules_as_regex(self):
1136
"""Return a regex of the ignore rules and a mapping dict.
1138
:return: (ignore rules compiled regex, dictionary mapping rule group
1139
indices to original rule.)
1141
if getattr(self, '_ignoreset', None) is None:
1142
self.get_ignore_list()
1143
return self._ignore_regex
1145
def is_ignored(self, filename):
1146
r"""Check whether the filename matches an ignore pattern.
1148
Patterns containing '/' or '\' need to match the whole path;
1149
others match against only the last component.
1151
If the file is ignored, returns the pattern which caused it to
1152
be ignored, otherwise None. So this can simply be used as a
1153
boolean if desired."""
1155
# TODO: Use '**' to match directories, and other extended
1156
# globbing stuff from cvs/rsync.
1158
# XXX: fnmatch is actually not quite what we want: it's only
1159
# approximately the same as real Unix fnmatch, and doesn't
1160
# treat dotfiles correctly and allows * to match /.
1161
# Eventually it should be replaced with something more
1164
rules = self._get_ignore_rules_as_regex()
1165
for regex, mapping in rules:
1166
match = regex.match(filename)
1167
if match is not None:
1168
# one or more of the groups in mapping will have a non-None group
1170
groups = match.groups()
1171
rules = [mapping[group] for group in
1172
mapping if groups[group] is not None]
1176
def kind(self, file_id):
1177
return file_kind(self.id2abspath(file_id))
1180
def last_revision(self):
1181
"""Return the last revision id of this working tree.
1183
In early branch formats this was == the branch last_revision,
1184
but that cannot be relied upon - for working tree operations,
1185
always use tree.last_revision().
1187
return self.branch.last_revision()
1189
def is_locked(self):
1190
return self._control_files.is_locked()
1192
def lock_read(self):
1193
"""See Branch.lock_read, and WorkingTree.unlock."""
1194
self.branch.lock_read()
1196
return self._control_files.lock_read()
1198
self.branch.unlock()
1201
def lock_write(self):
1202
"""See Branch.lock_write, and WorkingTree.unlock."""
1203
self.branch.lock_write()
1205
return self._control_files.lock_write()
1207
self.branch.unlock()
1210
def get_physical_lock_status(self):
1211
return self._control_files.get_physical_lock_status()
1213
def _basis_inventory_name(self):
1214
return 'basis-inventory'
1217
def set_last_revision(self, new_revision):
1218
"""Change the last revision in the working tree."""
1219
if self._change_last_revision(new_revision):
1220
self._cache_basis_inventory(new_revision)
1222
def _change_last_revision(self, new_revision):
1223
"""Template method part of set_last_revision to perform the change.
1225
This is used to allow WorkingTree3 instances to not affect branch
1226
when their last revision is set.
1228
if new_revision is None:
1229
self.branch.set_revision_history([])
1231
# current format is locked in with the branch
1232
revision_history = self.branch.revision_history()
1234
position = revision_history.index(new_revision)
1236
raise errors.NoSuchRevision(self.branch, new_revision)
1237
self.branch.set_revision_history(revision_history[:position + 1])
1240
def _cache_basis_inventory(self, new_revision):
1241
"""Cache new_revision as the basis inventory."""
1242
# TODO: this should allow the ready-to-use inventory to be passed in,
1243
# as commit already has that ready-to-use [while the format is the
1246
# this double handles the inventory - unpack and repack -
1247
# but is easier to understand. We can/should put a conditional
1248
# in here based on whether the inventory is in the latest format
1249
# - perhaps we should repack all inventories on a repository
1251
# the fast path is to copy the raw xml from the repository. If the
1252
# xml contains 'revision_id="', then we assume the right
1253
# revision_id is set. We must check for this full string, because a
1254
# root node id can legitimately look like 'revision_id' but cannot
1256
xml = self.branch.repository.get_inventory_xml(new_revision)
1257
if not 'revision_id="' in xml.split('\n', 1)[0]:
1258
inv = self.branch.repository.deserialise_inventory(
1260
inv.revision_id = new_revision
1261
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1262
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1263
path = self._basis_inventory_name()
1265
self._control_files.put(path, sio)
1266
except WeaveRevisionNotPresent:
1269
def read_basis_inventory(self):
1270
"""Read the cached basis inventory."""
1271
path = self._basis_inventory_name()
1272
return self._control_files.get(path).read()
1275
def read_working_inventory(self):
1276
"""Read the working inventory."""
1277
# ElementTree does its own conversion from UTF-8, so open in
1279
result = bzrlib.xml5.serializer_v5.read_inventory(
1280
self._control_files.get('inventory'))
1281
self._set_inventory(result)
1285
def remove(self, files, verbose=False, to_file=None):
1286
"""Remove nominated files from the working inventory..
1288
This does not remove their text. This does not run on XXX on what? RBC
1290
TODO: Refuse to remove modified files unless --force is given?
1292
TODO: Do something useful with directories.
1294
TODO: Should this remove the text or not? Tough call; not
1295
removing may be useful and the user can just use use rm, and
1296
is the opposite of add. Removing it is consistent with most
1297
other tools. Maybe an option.
1299
## TODO: Normalize names
1300
## TODO: Remove nested loops; better scalability
1301
if isinstance(files, basestring):
1304
inv = self.inventory
1306
# do this before any modifications
1308
fid = inv.path2id(f)
1310
# TODO: Perhaps make this just a warning, and continue?
1311
# This tends to happen when
1312
raise NotVersionedError(path=f)
1314
# having remove it, it must be either ignored or unknown
1315
if self.is_ignored(f):
1319
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1322
self._write_inventory(inv)
1325
def revert(self, filenames, old_tree=None, backups=True,
1326
pb=DummyProgress()):
1327
from transform import revert
1328
from conflicts import resolve
1329
if old_tree is None:
1330
old_tree = self.basis_tree()
1331
conflicts = revert(self, old_tree, filenames, backups, pb)
1332
if not len(filenames):
1333
self.set_pending_merges([])
1336
resolve(self, filenames, ignore_misses=True)
1339
# XXX: This method should be deprecated in favour of taking in a proper
1340
# new Inventory object.
1342
def set_inventory(self, new_inventory_list):
1343
from bzrlib.inventory import (Inventory,
1348
inv = Inventory(self.get_root_id())
1349
for path, file_id, parent, kind in new_inventory_list:
1350
name = os.path.basename(path)
1353
# fixme, there should be a factory function inv,add_??
1354
if kind == 'directory':
1355
inv.add(InventoryDirectory(file_id, name, parent))
1356
elif kind == 'file':
1357
inv.add(InventoryFile(file_id, name, parent))
1358
elif kind == 'symlink':
1359
inv.add(InventoryLink(file_id, name, parent))
1361
raise BzrError("unknown kind %r" % kind)
1362
self._write_inventory(inv)
1365
def set_root_id(self, file_id):
1366
"""Set the root id for this tree."""
1367
inv = self.read_working_inventory()
1368
orig_root_id = inv.root.file_id
1369
del inv._byid[inv.root.file_id]
1370
inv.root.file_id = file_id
1371
inv._byid[inv.root.file_id] = inv.root
1374
if entry.parent_id == orig_root_id:
1375
entry.parent_id = inv.root.file_id
1376
self._write_inventory(inv)
1379
"""See Branch.unlock.
1381
WorkingTree locking just uses the Branch locking facilities.
1382
This is current because all working trees have an embedded branch
1383
within them. IF in the future, we were to make branch data shareable
1384
between multiple working trees, i.e. via shared storage, then we
1385
would probably want to lock both the local tree, and the branch.
1387
raise NotImplementedError(self.unlock)
1391
"""Update a working tree along its branch.
1393
This will update the branch if its bound too, which means we have
1394
multiple trees involved:
1396
- The new basis tree of the master.
1397
- The old basis tree of the branch.
1398
- The old basis tree of the working tree.
1399
- The current working tree state.
1401
Pathologically, all three may be different, and non-ancestors of each
1402
other. Conceptually we want to:
1404
- Preserve the wt.basis->wt.state changes
1405
- Transform the wt.basis to the new master basis.
1406
- Apply a merge of the old branch basis to get any 'local' changes from
1408
- Restore the wt.basis->wt.state changes.
1410
There isn't a single operation at the moment to do that, so we:
1411
- Merge current state -> basis tree of the master w.r.t. the old tree
1413
- Do a 'normal' merge of the old branch basis if it is relevant.
1415
old_tip = self.branch.update()
1416
if old_tip is not None:
1417
self.add_pending_merge(old_tip)
1418
self.branch.lock_read()
1421
if self.last_revision() != self.branch.last_revision():
1422
# merge tree state up to new branch tip.
1423
basis = self.basis_tree()
1424
to_tree = self.branch.basis_tree()
1425
if basis.inventory.root is None:
1426
self.set_root_id(to_tree.inventory.root.file_id)
1427
result += merge_inner(self.branch,
1431
self.set_last_revision(self.branch.last_revision())
1432
if old_tip and old_tip != self.last_revision():
1433
# our last revision was not the prior branch last revision
1434
# and we have converted that last revision to a pending merge.
1435
# base is somewhere between the branch tip now
1436
# and the now pending merge
1437
from bzrlib.revision import common_ancestor
1439
base_rev_id = common_ancestor(self.branch.last_revision(),
1441
self.branch.repository)
1442
except errors.NoCommonAncestor:
1444
base_tree = self.branch.repository.revision_tree(base_rev_id)
1445
other_tree = self.branch.repository.revision_tree(old_tip)
1446
result += merge_inner(self.branch,
1452
self.branch.unlock()
1455
def _write_inventory(self, inv):
1456
"""Write inventory as the current inventory."""
1458
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1460
self._control_files.put('inventory', sio)
1461
self._set_inventory(inv)
1462
mutter('wrote working inventory')
1464
def set_conflicts(self, arg):
1465
raise UnsupportedOperation(self.set_conflicts, self)
1467
def add_conflicts(self, arg):
1468
raise UnsupportedOperation(self.add_conflicts, self)
1471
def conflicts(self):
1472
conflicts = ConflictList()
1473
for conflicted in self._iter_conflicts():
1476
if file_kind(self.abspath(conflicted)) != "file":
1478
except errors.NoSuchFile:
1481
for suffix in ('.THIS', '.OTHER'):
1483
kind = file_kind(self.abspath(conflicted+suffix))
1486
except errors.NoSuchFile:
1490
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1491
conflicts.append(Conflict.factory(ctype, path=conflicted,
1492
file_id=self.path2id(conflicted)))
1496
class WorkingTree2(WorkingTree):
1497
"""This is the Format 2 working tree.
1499
This was the first weave based working tree.
1500
- uses os locks for locking.
1501
- uses the branch last-revision.
1505
# we share control files:
1506
if self._hashcache.needs_write and self._control_files._lock_count==3:
1507
self._hashcache.write()
1508
# reverse order of locking.
1510
return self._control_files.unlock()
1512
self.branch.unlock()
1515
class WorkingTree3(WorkingTree):
1516
"""This is the Format 3 working tree.
1518
This differs from the base WorkingTree by:
1519
- having its own file lock
1520
- having its own last-revision property.
1522
This is new in bzr 0.8
1526
def last_revision(self):
1527
"""See WorkingTree.last_revision."""
1529
return self._control_files.get_utf8('last-revision').read()
1533
def _change_last_revision(self, revision_id):
1534
"""See WorkingTree._change_last_revision."""
1535
if revision_id is None or revision_id == NULL_REVISION:
1537
self._control_files._transport.delete('last-revision')
1538
except errors.NoSuchFile:
1543
self.branch.revision_history().index(revision_id)
1545
raise errors.NoSuchRevision(self.branch, revision_id)
1546
self._control_files.put_utf8('last-revision', revision_id)
1550
def set_conflicts(self, conflicts):
1551
self._put_rio('conflicts', conflicts.to_stanzas(),
1555
def add_conflicts(self, new_conflicts):
1556
conflict_set = set(self.conflicts())
1557
conflict_set.update(set(list(new_conflicts)))
1558
self.set_conflicts(ConflictList(sorted(conflict_set,
1559
key=Conflict.sort_key)))
1562
def conflicts(self):
1564
confile = self._control_files.get('conflicts')
1566
return ConflictList()
1568
if confile.next() != CONFLICT_HEADER_1 + '\n':
1569
raise ConflictFormatError()
1570
except StopIteration:
1571
raise ConflictFormatError()
1572
return ConflictList.from_stanzas(RioReader(confile))
1575
if self._hashcache.needs_write and self._control_files._lock_count==1:
1576
self._hashcache.write()
1577
# reverse order of locking.
1579
return self._control_files.unlock()
1581
self.branch.unlock()
1584
def get_conflicted_stem(path):
1585
for suffix in CONFLICT_SUFFIXES:
1586
if path.endswith(suffix):
1587
return path[:-len(suffix)]
1589
@deprecated_function(zero_eight)
1590
def is_control_file(filename):
1591
"""See WorkingTree.is_control_filename(filename)."""
1592
## FIXME: better check
1593
filename = normpath(filename)
1594
while filename != '':
1595
head, tail = os.path.split(filename)
1596
## mutter('check %r for control file' % ((head, tail),))
1599
if filename == head:
1605
class WorkingTreeFormat(object):
1606
"""An encapsulation of the initialization and open routines for a format.
1608
Formats provide three things:
1609
* An initialization routine,
1613
Formats are placed in an dict by their format string for reference
1614
during workingtree opening. Its not required that these be instances, they
1615
can be classes themselves with class methods - it simply depends on
1616
whether state is needed for a given format or not.
1618
Once a format is deprecated, just deprecate the initialize and open
1619
methods on the format class. Do not deprecate the object, as the
1620
object will be created every time regardless.
1623
_default_format = None
1624
"""The default format used for new trees."""
1627
"""The known formats."""
1630
def find_format(klass, a_bzrdir):
1631
"""Return the format for the working tree object in a_bzrdir."""
1633
transport = a_bzrdir.get_workingtree_transport(None)
1634
format_string = transport.get("format").read()
1635
return klass._formats[format_string]
1637
raise errors.NoWorkingTree(base=transport.base)
1639
raise errors.UnknownFormatError(format=format_string)
1642
def get_default_format(klass):
1643
"""Return the current default format."""
1644
return klass._default_format
1646
def get_format_string(self):
1647
"""Return the ASCII format string that identifies this format."""
1648
raise NotImplementedError(self.get_format_string)
1650
def get_format_description(self):
1651
"""Return the short description for this format."""
1652
raise NotImplementedError(self.get_format_description)
1654
def is_supported(self):
1655
"""Is this format supported?
1657
Supported formats can be initialized and opened.
1658
Unsupported formats may not support initialization or committing or
1659
some other features depending on the reason for not being supported.
1664
def register_format(klass, format):
1665
klass._formats[format.get_format_string()] = format
1668
def set_default_format(klass, format):
1669
klass._default_format = format
1672
def unregister_format(klass, format):
1673
assert klass._formats[format.get_format_string()] is format
1674
del klass._formats[format.get_format_string()]
1678
class WorkingTreeFormat2(WorkingTreeFormat):
1679
"""The second working tree format.
1681
This format modified the hash cache from the format 1 hash cache.
1684
def get_format_description(self):
1685
"""See WorkingTreeFormat.get_format_description()."""
1686
return "Working tree format 2"
1688
def stub_initialize_remote(self, control_files):
1689
"""As a special workaround create critical control files for a remote working tree
1691
This ensures that it can later be updated and dealt with locally,
1692
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1693
no working tree. (See bug #43064).
1697
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1699
control_files.put('inventory', sio)
1701
control_files.put_utf8('pending-merges', '')
1704
def initialize(self, a_bzrdir, revision_id=None):
1705
"""See WorkingTreeFormat.initialize()."""
1706
if not isinstance(a_bzrdir.transport, LocalTransport):
1707
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1708
branch = a_bzrdir.open_branch()
1709
if revision_id is not None:
1712
revision_history = branch.revision_history()
1714
position = revision_history.index(revision_id)
1716
raise errors.NoSuchRevision(branch, revision_id)
1717
branch.set_revision_history(revision_history[:position + 1])
1720
revision = branch.last_revision()
1721
inv = Inventory(root_id=gen_root_id())
1722
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1728
wt.set_last_revision(revision)
1729
basis_tree = wt.basis_tree()
1730
if basis_tree.inventory.root is not None:
1731
inv.root.file_id = basis_tree.inventory.root.file_id
1732
wt._write_inventory(inv)
1733
wt.set_pending_merges([])
1734
build_tree(basis_tree, wt)
1738
super(WorkingTreeFormat2, self).__init__()
1739
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1741
def open(self, a_bzrdir, _found=False):
1742
"""Return the WorkingTree object for a_bzrdir
1744
_found is a private parameter, do not use it. It is used to indicate
1745
if format probing has already been done.
1748
# we are being called directly and must probe.
1749
raise NotImplementedError
1750
if not isinstance(a_bzrdir.transport, LocalTransport):
1751
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1752
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1758
class WorkingTreeFormat3(WorkingTreeFormat):
1759
"""The second working tree format updated to record a format marker.
1762
- exists within a metadir controlling .bzr
1763
- includes an explicit version marker for the workingtree control
1764
files, separate from the BzrDir format
1765
- modifies the hash cache format
1767
- uses a LockDir to guard access for writes.
1770
def get_format_string(self):
1771
"""See WorkingTreeFormat.get_format_string()."""
1772
return "Bazaar-NG Working Tree format 3"
1774
def get_format_description(self):
1775
"""See WorkingTreeFormat.get_format_description()."""
1776
return "Working tree format 3"
1778
_lock_file_name = 'lock'
1779
_lock_class = LockDir
1781
def _open_control_files(self, a_bzrdir):
1782
transport = a_bzrdir.get_workingtree_transport(None)
1783
return LockableFiles(transport, self._lock_file_name,
1786
def initialize(self, a_bzrdir, revision_id=None):
1787
"""See WorkingTreeFormat.initialize().
1789
revision_id allows creating a working tree at a different
1790
revision than the branch is at.
1792
if not isinstance(a_bzrdir.transport, LocalTransport):
1793
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1794
transport = a_bzrdir.get_workingtree_transport(self)
1795
control_files = self._open_control_files(a_bzrdir)
1796
control_files.create_lock()
1797
control_files.lock_write()
1798
control_files.put_utf8('format', self.get_format_string())
1799
branch = a_bzrdir.open_branch()
1800
if revision_id is None:
1801
revision_id = branch.last_revision()
1802
inv = Inventory(root_id=gen_root_id())
1803
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1809
_control_files=control_files)
1812
wt.set_last_revision(revision_id)
1813
basis_tree = wt.basis_tree()
1814
wt._write_inventory(inv)
1815
if basis_tree.inventory.root is not None:
1816
inv.root.file_id = basis_tree.inventory.root.file_id
1817
wt.set_pending_merges([])
1818
build_tree(basis_tree, wt)
1821
control_files.unlock()
1825
super(WorkingTreeFormat3, self).__init__()
1826
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1828
def open(self, a_bzrdir, _found=False):
1829
"""Return the WorkingTree object for a_bzrdir
1831
_found is a private parameter, do not use it. It is used to indicate
1832
if format probing has already been done.
1835
# we are being called directly and must probe.
1836
raise NotImplementedError
1837
if not isinstance(a_bzrdir.transport, LocalTransport):
1838
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1839
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1841
def _open(self, a_bzrdir, control_files):
1842
"""Open the tree itself.
1844
:param a_bzrdir: the dir for the tree.
1845
:param control_files: the control files for the tree.
1847
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1851
_control_files=control_files)
1854
return self.get_format_string()
1857
# formats which have no format string are not discoverable
1858
# and not independently creatable, so are not registered.
1859
__default_format = WorkingTreeFormat3()
1860
WorkingTreeFormat.register_format(__default_format)
1861
WorkingTreeFormat.set_default_format(__default_format)
1862
_legacy_formats = [WorkingTreeFormat2(),
1866
class WorkingTreeTestProviderAdapter(object):
1867
"""A tool to generate a suite testing multiple workingtree formats at once.
1869
This is done by copying the test once for each transport and injecting
1870
the transport_server, transport_readonly_server, and workingtree_format
1871
classes into each copy. Each copy is also given a new id() to make it
1875
def __init__(self, transport_server, transport_readonly_server, formats):
1876
self._transport_server = transport_server
1877
self._transport_readonly_server = transport_readonly_server
1878
self._formats = formats
1880
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1881
"""Clone test for adaption."""
1882
new_test = deepcopy(test)
1883
new_test.transport_server = self._transport_server
1884
new_test.transport_readonly_server = self._transport_readonly_server
1885
new_test.bzrdir_format = bzrdir_format
1886
new_test.workingtree_format = workingtree_format
1887
def make_new_test_id():
1888
new_id = "%s(%s)" % (test.id(), variation)
1889
return lambda: new_id
1890
new_test.id = make_new_test_id()
1893
def adapt(self, test):
1894
from bzrlib.tests import TestSuite
1895
result = TestSuite()
1896
for workingtree_format, bzrdir_format in self._formats:
1897
new_test = self._clone_test(
1900
workingtree_format, workingtree_format.__class__.__name__)
1901
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
