25
25
At the moment every WorkingTree has its own branch. Remote
26
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
28
To get a WorkingTree, call Branch.working_tree():
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
32
# TODO: Don't allow WorkingTrees to be constructed for remote branches if
35
# FIXME: I don't know if writing out the cache from the destructor is really a
36
# good idea, because destructors are considered poor taste in Python, and it's
37
# not predictable when it will be written out.
35
39
# TODO: Give the workingtree sole responsibility for the working inventory;
36
40
# remove the variable and references to it from the branch. This may require
37
41
# updating the commit code so as to update the inventory within the working
38
42
# 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)
43
# At the momenthey may alias the inventory and have old copies of it in memory.
42
from binascii import hexlify
44
45
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
50
from bzrlib.branch import (Branch,
60
55
from bzrlib.errors import (BzrCheckError,
63
58
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 (
61
from bzrlib.inventory import InventoryEntry
62
from bzrlib.osutils import (appendpath,
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
76
from bzrlib.textui import show_status
105
77
import bzrlib.tree
78
from bzrlib.trace import mutter
107
79
import bzrlib.xml5
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
82
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()
83
"""Return new file id.
85
This should probably generate proper UUIDs, but for the moment we
86
cope with just randomness because running uuidgen every time is
89
from binascii import hexlify
96
idx = name.rfind('\\')
100
# make it not a hidden file
101
name = name.lstrip('.')
103
# remove any wierd characters; we don't escape them but rather
105
name = re.sub(r'[^\w.]', '', name)
107
s = hexlify(rand_bytes(8))
108
return '-'.join((name, compact_date(time()), s))
156
111
def gen_root_id():
237
186
(branch.base is not cross checked, because for remote branches that
238
187
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
189
from bzrlib.hashcache import HashCache
257
190
from bzrlib.trace import note, mutter
258
191
assert isinstance(basedir, basestring), \
259
192
"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()
194
branch = Branch.open(basedir)
195
assert isinstance(branch, Branch), \
196
"branch %r is not a Branch" % branch
273
198
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
200
# update the whole cache up front and write to disk if anything changed;
285
201
# in the future we might want to do this more selectively
286
202
# two possible ways offer themselves : in self._unlock, write the cache
287
203
# if needed, or, when the cache sees a change, append it to the hash
288
204
# cache file, and have the parser take the most recent entry for a
289
205
# given path only.
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)
206
hc = self._hashcache = HashCache(basedir)
293
# is this scan needed ? it makes things kinda slow.
296
210
if hc.needs_write:
297
211
mutter("write hc")
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()
214
self._set_inventory(self.read_working_inventory())
324
216
def _set_inventory(self, inv):
325
assert inv.root is not None
326
217
self._inventory = inv
327
218
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
221
def open_containing(path=None):
353
222
"""Open an existing working tree which has its root about path.
393
270
def abspath(self, filename):
394
271
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision."""
398
revision_id = self.last_revision()
399
if revision_id is not None:
401
xml = self.read_basis_inventory()
402
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
403
inv.root.revision = revision_id
406
if inv is not None and inv.revision_id == revision_id:
407
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
409
# FIXME? RBC 20060403 should we cache the inventory here ?
410
return self.branch.repository.revision_tree(revision_id)
413
@deprecated_method(zero_eight)
414
def create(branch, directory):
415
"""Create a workingtree for branch at directory.
417
If existing_directory already exists it must have a .bzr directory.
418
If it does not exist, it will be created.
420
This returns a new WorkingTree object for the new checkout.
422
TODO FIXME RBC 20060124 when we have checkout formats in place this
423
should accept an optional revisionid to checkout [and reject this if
424
checking out into the same dir as a pre-checkout-aware branch format.]
426
XXX: When BzrDir is present, these should be created through that
429
warnings.warn('delete WorkingTree.create', stacklevel=3)
430
transport = get_transport(directory)
431
if branch.bzrdir.root_transport.base == transport.base:
433
return branch.bzrdir.create_workingtree()
434
# different directory,
435
# create a branch reference
436
# and now a working tree.
437
raise NotImplementedError
440
@deprecated_method(zero_eight)
441
def create_standalone(directory):
442
"""Create a checkout and a branch and a repo at directory.
444
Directory must exist and be empty.
446
please use BzrDir.create_standalone_workingtree
448
return bzrdir.BzrDir.create_standalone_workingtree(directory)
450
def relpath(self, path):
451
"""Return the local path portion from a given path.
453
The path may be absolute or relative. If its a relative path it is
454
interpreted relative to the python current working directory.
456
return relpath(self.basedir, path)
273
def relpath(self, abs):
274
"""Return the local path portion from a given absolute path."""
275
return relpath(self.basedir, abs)
458
277
def has_filename(self, filename):
459
return osutils.lexists(self.abspath(filename))
278
return bzrlib.osutils.lexists(self.abspath(filename))
461
280
def get_file(self, file_id):
462
281
return self.get_file_byname(self.id2path(file_id))
464
def get_file_text(self, file_id):
465
return self.get_file(file_id).read()
467
283
def get_file_byname(self, filename):
468
284
return file(self.abspath(filename), 'rb')
470
def get_parent_ids(self):
471
"""See Tree.get_parent_ids.
473
This implementation reads the pending merges list and last_revision
474
value and uses that to decide what the parents list should be.
476
last_rev = self.last_revision()
481
other_parents = self.pending_merges()
482
return parents + other_parents
484
286
def get_root_id(self):
485
287
"""Return the id of this trees root"""
486
288
inv = self.read_working_inventory()
1158
754
# treat dotfiles correctly and allows * to match /.
1159
755
# Eventually it should be replaced with something more
1162
rules = self._get_ignore_rules_as_regex()
1163
for regex, mapping in rules:
1164
match = regex.match(filename)
1165
if match is not None:
1166
# one or more of the groups in mapping will have a non-None group
1168
groups = match.groups()
1169
rules = [mapping[group] for group in
1170
mapping if groups[group] is not None]
758
for pat in self.get_ignore_list():
759
if '/' in pat or '\\' in pat:
761
# as a special case, you can put ./ at the start of a
762
# pattern; this is good to match in the top-level
765
if (pat[:2] == './') or (pat[:2] == '.\\'):
769
if fnmatch.fnmatchcase(filename, newpat):
772
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1174
777
def kind(self, file_id):
1175
778
return file_kind(self.id2abspath(file_id))
1178
def last_revision(self):
1179
"""Return the last revision id of this working tree.
1181
In early branch formats this was == the branch last_revision,
1182
but that cannot be relied upon - for working tree operations,
1183
always use tree.last_revision().
1185
return self.branch.last_revision()
1187
def is_locked(self):
1188
return self._control_files.is_locked()
1190
780
def lock_read(self):
1191
781
"""See Branch.lock_read, and WorkingTree.unlock."""
1192
self.branch.lock_read()
1194
return self._control_files.lock_read()
1196
self.branch.unlock()
782
return self.branch.lock_read()
1199
784
def lock_write(self):
1200
785
"""See Branch.lock_write, and WorkingTree.unlock."""
1201
self.branch.lock_write()
1203
return self._control_files.lock_write()
1205
self.branch.unlock()
1208
def get_physical_lock_status(self):
1209
return self._control_files.get_physical_lock_status()
1211
def _basis_inventory_name(self):
1212
return 'basis-inventory'
1215
def set_last_revision(self, new_revision):
1216
"""Change the last revision in the working tree."""
1217
if self._change_last_revision(new_revision):
1218
self._cache_basis_inventory(new_revision)
1220
def _change_last_revision(self, new_revision):
1221
"""Template method part of set_last_revision to perform the change.
1223
This is used to allow WorkingTree3 instances to not affect branch
1224
when their last revision is set.
1226
if new_revision is None:
1227
self.branch.set_revision_history([])
1230
self.branch.generate_revision_history(new_revision)
1231
except errors.NoSuchRevision:
1232
# not present in the repo - dont try to set it deeper than the tip
1233
self.branch.set_revision_history([new_revision])
1236
def _cache_basis_inventory(self, new_revision):
1237
"""Cache new_revision as the basis inventory."""
1238
# TODO: this should allow the ready-to-use inventory to be passed in,
1239
# as commit already has that ready-to-use [while the format is the
1242
# this double handles the inventory - unpack and repack -
1243
# but is easier to understand. We can/should put a conditional
1244
# in here based on whether the inventory is in the latest format
1245
# - perhaps we should repack all inventories on a repository
1247
# the fast path is to copy the raw xml from the repository. If the
1248
# xml contains 'revision_id="', then we assume the right
1249
# revision_id is set. We must check for this full string, because a
1250
# root node id can legitimately look like 'revision_id' but cannot
1252
xml = self.branch.repository.get_inventory_xml(new_revision)
1253
if not 'revision_id="' in xml.split('\n', 1)[0]:
1254
inv = self.branch.repository.deserialise_inventory(
1256
inv.revision_id = new_revision
1257
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1258
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1259
path = self._basis_inventory_name()
1261
self._control_files.put(path, sio)
1262
except (errors.NoSuchRevision, errors.RevisionNotPresent):
786
return self.branch.lock_write()
788
def _basis_inventory_name(self, revision_id):
789
return 'basis-inventory.%s' % revision_id
791
def set_last_revision(self, new_revision, old_revision=None):
794
path = self._basis_inventory_name(old_revision)
795
path = self.branch._rel_controlfilename(path)
796
self.branch._transport.delete(path)
800
xml = self.branch.get_inventory_xml(new_revision)
801
path = self._basis_inventory_name(new_revision)
802
self.branch.put_controlfile(path, xml)
803
except WeaveRevisionNotPresent:
1265
def read_basis_inventory(self):
806
def read_basis_inventory(self, revision_id):
1266
807
"""Read the cached basis inventory."""
1267
path = self._basis_inventory_name()
1268
return self._control_files.get(path).read()
808
path = self._basis_inventory_name(revision_id)
809
return self.branch.controlfile(path, 'r').read()
1270
811
@needs_read_lock
1271
812
def read_working_inventory(self):
1272
813
"""Read the working inventory."""
1273
814
# ElementTree does its own conversion from UTF-8, so open in
1275
result = bzrlib.xml5.serializer_v5.read_inventory(
1276
self._control_files.get('inventory'))
1277
self._set_inventory(result)
816
f = self.branch.controlfile('inventory', 'rb')
817
return bzrlib.xml5.serializer_v5.read_inventory(f)
1280
819
@needs_write_lock
1281
def remove(self, files, verbose=False, to_file=None):
820
def remove(self, files, verbose=False):
1282
821
"""Remove nominated files from the working inventory..
1284
823
This does not remove their text. This does not run on XXX on what? RBC
1380
915
between multiple working trees, i.e. via shared storage, then we
1381
916
would probably want to lock both the local tree, and the branch.
1383
raise NotImplementedError(self.unlock)
1387
"""Update a working tree along its branch.
1389
This will update the branch if its bound too, which means we have multiple trees involved:
1390
The new basis tree of the master.
1391
The old basis tree of the branch.
1392
The old basis tree of the working tree.
1393
The current working tree state.
1394
pathologically all three may be different, and non ancestors of each other.
1395
Conceptually we want to:
1396
Preserve the wt.basis->wt.state changes
1397
Transform the wt.basis to the new master basis.
1398
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1399
Restore the wt.basis->wt.state changes.
1401
There isn't a single operation at the moment to do that, so we:
1402
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1403
Do a 'normal' merge of the old branch basis if it is relevant.
1405
old_tip = self.branch.update()
1406
if old_tip is not None:
1407
self.add_pending_merge(old_tip)
1408
self.branch.lock_read()
1411
if self.last_revision() != self.branch.last_revision():
1412
# merge tree state up to new branch tip.
1413
basis = self.basis_tree()
1414
to_tree = self.branch.basis_tree()
1415
result += merge_inner(self.branch,
1419
self.set_last_revision(self.branch.last_revision())
1420
if old_tip and old_tip != self.last_revision():
1421
# our last revision was not the prior branch last revision
1422
# and we have converted that last revision to a pending merge.
1423
# base is somewhere between the branch tip now
1424
# and the now pending merge
1425
from bzrlib.revision import common_ancestor
1427
base_rev_id = common_ancestor(self.branch.last_revision(),
1429
self.branch.repository)
1430
except errors.NoCommonAncestor:
1432
base_tree = self.branch.repository.revision_tree(base_rev_id)
1433
other_tree = self.branch.repository.revision_tree(old_tip)
1434
result += merge_inner(self.branch,
1440
self.branch.unlock()
918
if self._hashcache.needs_write and self.branch._lock_count==1:
919
self._hashcache.write()
920
return self.branch.unlock()
1442
922
@needs_write_lock
1443
923
def _write_inventory(self, inv):
1444
924
"""Write inventory as the current inventory."""
925
from cStringIO import StringIO
926
from bzrlib.atomicfile import AtomicFile
1445
927
sio = StringIO()
1446
928
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1448
self._control_files.put('inventory', sio)
930
f = AtomicFile(self.branch.controlfilename('inventory'))
1449
936
self._set_inventory(inv)
1450
937
mutter('wrote working inventory')
1452
def set_conflicts(self, arg):
1453
raise UnsupportedOperation(self.set_conflicts, self)
1455
def add_conflicts(self, arg):
1456
raise UnsupportedOperation(self.add_conflicts, self)
1459
def conflicts(self):
1460
conflicts = ConflictList()
1461
for conflicted in self._iter_conflicts():
1464
if file_kind(self.abspath(conflicted)) != "file":
1466
except errors.NoSuchFile:
1469
for suffix in ('.THIS', '.OTHER'):
1471
kind = file_kind(self.abspath(conflicted+suffix))
1474
except errors.NoSuchFile:
1478
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1479
conflicts.append(Conflict.factory(ctype, path=conflicted,
1480
file_id=self.path2id(conflicted)))
1484
class WorkingTree2(WorkingTree):
1485
"""This is the Format 2 working tree.
1487
This was the first weave based working tree.
1488
- uses os locks for locking.
1489
- uses the branch last-revision.
1493
# we share control files:
1494
if self._hashcache.needs_write and self._control_files._lock_count==3:
1495
self._hashcache.write()
1496
# reverse order of locking.
1498
return self._control_files.unlock()
1500
self.branch.unlock()
1503
class WorkingTree3(WorkingTree):
1504
"""This is the Format 3 working tree.
1506
This differs from the base WorkingTree by:
1507
- having its own file lock
1508
- having its own last-revision property.
1510
This is new in bzr 0.8
1514
def last_revision(self):
1515
"""See WorkingTree.last_revision."""
1517
return self._control_files.get_utf8('last-revision').read()
1521
def _change_last_revision(self, revision_id):
1522
"""See WorkingTree._change_last_revision."""
1523
if revision_id is None or revision_id == NULL_REVISION:
1525
self._control_files._transport.delete('last-revision')
1526
except errors.NoSuchFile:
1530
self._control_files.put_utf8('last-revision', revision_id)
1534
def set_conflicts(self, conflicts):
1535
self._put_rio('conflicts', conflicts.to_stanzas(),
1539
def add_conflicts(self, new_conflicts):
1540
conflict_set = set(self.conflicts())
1541
conflict_set.update(set(list(new_conflicts)))
1542
self.set_conflicts(ConflictList(sorted(conflict_set,
1543
key=Conflict.sort_key)))
1546
def conflicts(self):
1548
confile = self._control_files.get('conflicts')
1550
return ConflictList()
1552
if confile.next() != CONFLICT_HEADER_1 + '\n':
1553
raise ConflictFormatError()
1554
except StopIteration:
1555
raise ConflictFormatError()
1556
return ConflictList.from_stanzas(RioReader(confile))
1559
if self._hashcache.needs_write and self._control_files._lock_count==1:
1560
self._hashcache.write()
1561
# reverse order of locking.
1563
return self._control_files.unlock()
1565
self.branch.unlock()
940
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1568
941
def get_conflicted_stem(path):
1569
942
for suffix in CONFLICT_SUFFIXES:
1570
943
if path.endswith(suffix):
1571
944
return path[:-len(suffix)]
1573
@deprecated_function(zero_eight)
1574
def is_control_file(filename):
1575
"""See WorkingTree.is_control_filename(filename)."""
1576
## FIXME: better check
1577
filename = normpath(filename)
1578
while filename != '':
1579
head, tail = os.path.split(filename)
1580
## mutter('check %r for control file' % ((head, tail),))
1583
if filename == head:
1589
class WorkingTreeFormat(object):
1590
"""An encapsulation of the initialization and open routines for a format.
1592
Formats provide three things:
1593
* An initialization routine,
1597
Formats are placed in an dict by their format string for reference
1598
during workingtree opening. Its not required that these be instances, they
1599
can be classes themselves with class methods - it simply depends on
1600
whether state is needed for a given format or not.
1602
Once a format is deprecated, just deprecate the initialize and open
1603
methods on the format class. Do not deprecate the object, as the
1604
object will be created every time regardless.
1607
_default_format = None
1608
"""The default format used for new trees."""
1611
"""The known formats."""
1614
def find_format(klass, a_bzrdir):
1615
"""Return the format for the working tree object in a_bzrdir."""
1617
transport = a_bzrdir.get_workingtree_transport(None)
1618
format_string = transport.get("format").read()
1619
return klass._formats[format_string]
1621
raise errors.NoWorkingTree(base=transport.base)
1623
raise errors.UnknownFormatError(format=format_string)
1626
def get_default_format(klass):
1627
"""Return the current default format."""
1628
return klass._default_format
1630
def get_format_string(self):
1631
"""Return the ASCII format string that identifies this format."""
1632
raise NotImplementedError(self.get_format_string)
1634
def get_format_description(self):
1635
"""Return the short description for this format."""
1636
raise NotImplementedError(self.get_format_description)
1638
def is_supported(self):
1639
"""Is this format supported?
1641
Supported formats can be initialized and opened.
1642
Unsupported formats may not support initialization or committing or
1643
some other features depending on the reason for not being supported.
1648
def register_format(klass, format):
1649
klass._formats[format.get_format_string()] = format
1652
def set_default_format(klass, format):
1653
klass._default_format = format
1656
def unregister_format(klass, format):
1657
assert klass._formats[format.get_format_string()] is format
1658
del klass._formats[format.get_format_string()]
1662
class WorkingTreeFormat2(WorkingTreeFormat):
1663
"""The second working tree format.
1665
This format modified the hash cache from the format 1 hash cache.
1668
def get_format_description(self):
1669
"""See WorkingTreeFormat.get_format_description()."""
1670
return "Working tree format 2"
1672
def stub_initialize_remote(self, control_files):
1673
"""As a special workaround create critical control files for a remote working tree
1675
This ensures that it can later be updated and dealt with locally,
1676
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1677
no working tree. (See bug #43064).
1681
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1683
control_files.put('inventory', sio)
1685
control_files.put_utf8('pending-merges', '')
1688
def initialize(self, a_bzrdir, revision_id=None):
1689
"""See WorkingTreeFormat.initialize()."""
1690
if not isinstance(a_bzrdir.transport, LocalTransport):
1691
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1692
branch = a_bzrdir.open_branch()
1693
if revision_id is not None:
1696
revision_history = branch.revision_history()
1698
position = revision_history.index(revision_id)
1700
raise errors.NoSuchRevision(branch, revision_id)
1701
branch.set_revision_history(revision_history[:position + 1])
1704
revision = branch.last_revision()
1706
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1712
wt._write_inventory(inv)
1713
wt.set_root_id(inv.root.file_id)
1714
wt.set_last_revision(revision)
1715
wt.set_pending_merges([])
1716
build_tree(wt.basis_tree(), wt)
1720
super(WorkingTreeFormat2, self).__init__()
1721
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1723
def open(self, a_bzrdir, _found=False):
1724
"""Return the WorkingTree object for a_bzrdir
1726
_found is a private parameter, do not use it. It is used to indicate
1727
if format probing has already been done.
1730
# we are being called directly and must probe.
1731
raise NotImplementedError
1732
if not isinstance(a_bzrdir.transport, LocalTransport):
1733
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1734
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1740
class WorkingTreeFormat3(WorkingTreeFormat):
1741
"""The second working tree format updated to record a format marker.
1744
- exists within a metadir controlling .bzr
1745
- includes an explicit version marker for the workingtree control
1746
files, separate from the BzrDir format
1747
- modifies the hash cache format
1749
- uses a LockDir to guard access for writes.
1752
def get_format_string(self):
1753
"""See WorkingTreeFormat.get_format_string()."""
1754
return "Bazaar-NG Working Tree format 3"
1756
def get_format_description(self):
1757
"""See WorkingTreeFormat.get_format_description()."""
1758
return "Working tree format 3"
1760
_lock_file_name = 'lock'
1761
_lock_class = LockDir
1763
def _open_control_files(self, a_bzrdir):
1764
transport = a_bzrdir.get_workingtree_transport(None)
1765
return LockableFiles(transport, self._lock_file_name,
1768
def initialize(self, a_bzrdir, revision_id=None):
1769
"""See WorkingTreeFormat.initialize().
1771
revision_id allows creating a working tree at a different
1772
revision than the branch is at.
1774
if not isinstance(a_bzrdir.transport, LocalTransport):
1775
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1776
transport = a_bzrdir.get_workingtree_transport(self)
1777
control_files = self._open_control_files(a_bzrdir)
1778
control_files.create_lock()
1779
control_files.lock_write()
1780
control_files.put_utf8('format', self.get_format_string())
1781
branch = a_bzrdir.open_branch()
1782
if revision_id is None:
1783
revision_id = branch.last_revision()
1785
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1791
_control_files=control_files)
1794
wt._write_inventory(inv)
1795
wt.set_root_id(inv.root.file_id)
1796
wt.set_last_revision(revision_id)
1797
wt.set_pending_merges([])
1798
build_tree(wt.basis_tree(), wt)
1801
control_files.unlock()
1805
super(WorkingTreeFormat3, self).__init__()
1806
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1808
def open(self, a_bzrdir, _found=False):
1809
"""Return the WorkingTree object for a_bzrdir
1811
_found is a private parameter, do not use it. It is used to indicate
1812
if format probing has already been done.
1815
# we are being called directly and must probe.
1816
raise NotImplementedError
1817
if not isinstance(a_bzrdir.transport, LocalTransport):
1818
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1819
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1821
def _open(self, a_bzrdir, control_files):
1822
"""Open the tree itself.
1824
:param a_bzrdir: the dir for the tree.
1825
:param control_files: the control files for the tree.
1827
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1831
_control_files=control_files)
1834
return self.get_format_string()
1837
# formats which have no format string are not discoverable
1838
# and not independently creatable, so are not registered.
1839
__default_format = WorkingTreeFormat3()
1840
WorkingTreeFormat.register_format(__default_format)
1841
WorkingTreeFormat.set_default_format(__default_format)
1842
_legacy_formats = [WorkingTreeFormat2(),
1846
class WorkingTreeTestProviderAdapter(object):
1847
"""A tool to generate a suite testing multiple workingtree formats at once.
1849
This is done by copying the test once for each transport and injecting
1850
the transport_server, transport_readonly_server, and workingtree_format
1851
classes into each copy. Each copy is also given a new id() to make it
1855
def __init__(self, transport_server, transport_readonly_server, formats):
1856
self._transport_server = transport_server
1857
self._transport_readonly_server = transport_readonly_server
1858
self._formats = formats
1860
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1861
"""Clone test for adaption."""
1862
new_test = deepcopy(test)
1863
new_test.transport_server = self._transport_server
1864
new_test.transport_readonly_server = self._transport_readonly_server
1865
new_test.bzrdir_format = bzrdir_format
1866
new_test.workingtree_format = workingtree_format
1867
def make_new_test_id():
1868
new_id = "%s(%s)" % (test.id(), variation)
1869
return lambda: new_id
1870
new_test.id = make_new_test_id()
1873
def adapt(self, test):
1874
from bzrlib.tests import TestSuite
1875
result = TestSuite()
1876
for workingtree_format, bzrdir_format in self._formats:
1877
new_test = self._clone_test(
1880
workingtree_format, workingtree_format.__class__.__name__)
1881
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
