1
# Copyright (C) 2007-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""WorkingTree4 format and implementation.
19
WorkingTree4 provides the dirstate based working tree logic.
21
To get a WorkingTree, call bzrdir.open_workingtree() or
22
WorkingTree.open(dir).
25
from __future__ import absolute_import
27
from cStringIO import StringIO
31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
40
conflicts as _mod_conflicts,
44
filters as _mod_filters,
47
revision as _mod_revision,
55
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
57
from bzrlib.lock import LogicalLockResult
58
from bzrlib.lockable_files import LockableFiles
59
from bzrlib.lockdir import LockDir
60
from bzrlib.mutabletree import (
62
needs_tree_write_lock,
64
from bzrlib.osutils import (
71
from bzrlib.transport.local import LocalTransport
72
from bzrlib.tree import (
76
from bzrlib.workingtree import (
79
WorkingTreeFormatMetaDir,
83
class DirStateWorkingTree(InventoryWorkingTree):
85
def __init__(self, basedir,
90
"""Construct a WorkingTree for basedir.
92
If the branch is not supplied, it is opened automatically.
93
If the branch is supplied, it must be the branch for this basedir.
94
(branch.base is not cross checked, because for remote branches that
95
would be meaningless).
97
self._format = _format
99
basedir = safe_unicode(basedir)
100
trace.mutter("opening working tree %r", basedir)
101
self._branch = branch
102
self.basedir = realpath(basedir)
103
# if branch is at our basedir and is a format 6 or less
104
# assume all other formats have their own control files.
105
self._control_files = _control_files
106
self._transport = self._control_files._transport
109
# during a read or write lock these objects are set, and are
110
# None the rest of the time.
111
self._dirstate = None
112
self._inventory = None
114
self._setup_directory_is_tree_reference()
115
self._detect_case_handling()
116
self._rules_searcher = None
117
self.views = self._make_views()
118
#--- allow tests to select the dirstate iter_changes implementation
119
self._iter_changes = dirstate._process_entry
121
@needs_tree_write_lock
122
def _add(self, files, ids, kinds):
123
"""See MutableTree._add."""
124
state = self.current_dirstate()
125
for f, file_id, kind in zip(files, ids, kinds):
128
# special case tree root handling.
129
if f == '' and self.path2id(f) == ROOT_ID:
130
state.set_path_id('', generate_ids.gen_file_id(f))
133
file_id = generate_ids.gen_file_id(f)
134
# deliberately add the file with no cached stat or sha1
135
# - on the first access it will be gathered, and we can
136
# always change this once tests are all passing.
137
state.add(f, file_id, kind, None, '')
138
self._make_dirty(reset_inventory=True)
140
def _get_check_refs(self):
141
"""Return the references needed to perform a check of this tree."""
142
return [('trees', self.last_revision())]
144
def _make_dirty(self, reset_inventory):
145
"""Make the tree state dirty.
147
:param reset_inventory: True if the cached inventory should be removed
148
(presuming there is one).
151
if reset_inventory and self._inventory is not None:
152
self._inventory = None
154
@needs_tree_write_lock
155
def add_reference(self, sub_tree):
156
# use standard implementation, which calls back to self._add
158
# So we don't store the reference_revision in the working dirstate,
159
# it's just recorded at the moment of commit.
160
self._add_reference(sub_tree)
162
def break_lock(self):
163
"""Break a lock if one is present from another instance.
165
Uses the ui factory to ask for confirmation if the lock may be from
168
This will probe the repository for its lock as well.
170
# if the dirstate is locked by an active process, reject the break lock
173
if self._dirstate is None:
177
state = self._current_dirstate()
178
if state._lock_token is not None:
179
# we already have it locked. sheese, cant break our own lock.
180
raise errors.LockActive(self.basedir)
183
# try for a write lock - need permission to get one anyhow
186
except errors.LockContention:
187
# oslocks fail when a process is still live: fail.
188
# TODO: get the locked lockdir info and give to the user to
189
# assist in debugging.
190
raise errors.LockActive(self.basedir)
195
self._dirstate = None
196
self._control_files.break_lock()
197
self.branch.break_lock()
199
def _comparison_data(self, entry, path):
200
kind, executable, stat_value = \
201
WorkingTree._comparison_data(self, entry, path)
202
# it looks like a plain directory, but it's really a reference -- see
204
if (self._repo_supports_tree_reference and kind == 'directory'
205
and entry is not None and entry.kind == 'tree-reference'):
206
kind = 'tree-reference'
207
return kind, executable, stat_value
210
def commit(self, message=None, revprops=None, *args, **kwargs):
211
# mark the tree as dirty post commit - commit
212
# can change the current versioned list by doing deletes.
213
result = WorkingTree.commit(self, message, revprops, *args, **kwargs)
214
self._make_dirty(reset_inventory=True)
217
def current_dirstate(self):
218
"""Return the current dirstate object.
220
This is not part of the tree interface and only exposed for ease of
223
:raises errors.NotWriteLocked: when not in a lock.
225
self._must_be_locked()
226
return self._current_dirstate()
228
def _current_dirstate(self):
229
"""Internal function that does not check lock status.
231
This is needed for break_lock which also needs the dirstate.
233
if self._dirstate is not None:
234
return self._dirstate
235
local_path = self.bzrdir.get_workingtree_transport(None
236
).local_abspath('dirstate')
237
self._dirstate = dirstate.DirState.on_file(local_path,
238
self._sha1_provider(), self._worth_saving_limit())
239
return self._dirstate
241
def _sha1_provider(self):
242
"""A function that returns a SHA1Provider suitable for this tree.
244
:return: None if content filtering is not supported by this tree.
245
Otherwise, a SHA1Provider is returned that sha's the canonical
246
form of files, i.e. after read filters are applied.
248
if self.supports_content_filtering():
249
return ContentFilterAwareSHA1Provider(self)
253
def _worth_saving_limit(self):
254
"""How many hash changes are ok before we must save the dirstate.
256
:return: an integer. -1 means never save.
258
# FIXME: We want a WorkingTreeStack here -- vila 20110812
259
conf = config.BranchStack(self.branch)
260
return conf.get('bzr.workingtree.worth_saving_limit')
262
def filter_unversioned_files(self, paths):
263
"""Filter out paths that are versioned.
265
:return: set of paths.
267
# TODO: make a generic multi-bisect routine roughly that should list
268
# the paths, then process one half at a time recursively, and feed the
269
# results of each bisect in further still
270
paths = sorted(paths)
272
state = self.current_dirstate()
273
# TODO we want a paths_to_dirblocks helper I think
275
dirname, basename = os.path.split(path.encode('utf8'))
276
_, _, _, path_is_versioned = state._get_block_entry_index(
277
dirname, basename, 0)
278
if not path_is_versioned:
283
"""Write all cached data to disk."""
284
if self._control_files._lock_mode != 'w':
285
raise errors.NotWriteLocked(self)
286
self.current_dirstate().save()
287
self._inventory = None
290
@needs_tree_write_lock
291
def _gather_kinds(self, files, kinds):
292
"""See MutableTree._gather_kinds."""
293
for pos, f in enumerate(files):
294
if kinds[pos] is None:
295
kinds[pos] = self._kind(f)
297
def _generate_inventory(self):
298
"""Create and set self.inventory from the dirstate object.
300
This is relatively expensive: we have to walk the entire dirstate.
301
Ideally we would not, and can deprecate this function.
303
#: uncomment to trap on inventory requests.
304
# import pdb;pdb.set_trace()
305
state = self.current_dirstate()
306
state._read_dirblocks_if_needed()
307
root_key, current_entry = self._get_entry(path='')
308
current_id = root_key[2]
309
if not (current_entry[0][0] == 'd'): # directory
310
raise AssertionError(current_entry)
311
inv = Inventory(root_id=current_id)
312
# Turn some things into local variables
313
minikind_to_kind = dirstate.DirState._minikind_to_kind
314
factory = entry_factory
315
utf8_decode = cache_utf8._utf8_decode
317
# we could do this straight out of the dirstate; it might be fast
318
# and should be profiled - RBC 20070216
319
parent_ies = {'' : inv.root}
320
for block in state._dirblocks[1:]: # skip the root
323
parent_ie = parent_ies[dirname]
325
# all the paths in this block are not versioned in this tree
327
for key, entry in block[1]:
328
minikind, link_or_sha1, size, executable, stat = entry[0]
329
if minikind in ('a', 'r'): # absent, relocated
330
# a parent tree only entry
333
name_unicode = utf8_decode(name)[0]
335
kind = minikind_to_kind[minikind]
336
inv_entry = factory[kind](file_id, name_unicode,
339
# This is only needed on win32, where this is the only way
340
# we know the executable bit.
341
inv_entry.executable = executable
342
# not strictly needed: working tree
343
#inv_entry.text_size = size
344
#inv_entry.text_sha1 = sha1
345
elif kind == 'directory':
346
# add this entry to the parent map.
347
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
348
elif kind == 'tree-reference':
349
if not self._repo_supports_tree_reference:
350
raise errors.UnsupportedOperation(
351
self._generate_inventory,
352
self.branch.repository)
353
inv_entry.reference_revision = link_or_sha1 or None
354
elif kind != 'symlink':
355
raise AssertionError("unknown kind %r" % kind)
356
# These checks cost us around 40ms on a 55k entry tree
357
if file_id in inv_byid:
358
raise AssertionError('file_id %s already in'
359
' inventory as %s' % (file_id, inv_byid[file_id]))
360
if name_unicode in parent_ie.children:
361
raise AssertionError('name %r already in parent'
363
inv_byid[file_id] = inv_entry
364
parent_ie.children[name_unicode] = inv_entry
365
self._inventory = inv
367
def _get_entry(self, file_id=None, path=None):
368
"""Get the dirstate row for file_id or path.
370
If either file_id or path is supplied, it is used as the key to lookup.
371
If both are supplied, the fastest lookup is used, and an error is
372
raised if they do not both point at the same row.
374
:param file_id: An optional unicode file_id to be looked up.
375
:param path: An optional unicode path to be looked up.
376
:return: The dirstate row tuple for path/file_id, or (None, None)
378
if file_id is None and path is None:
379
raise errors.BzrError('must supply file_id or path')
380
state = self.current_dirstate()
382
path = path.encode('utf8')
383
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
385
def get_file_sha1(self, file_id, path=None, stat_value=None):
386
# check file id is valid unconditionally.
387
entry = self._get_entry(file_id=file_id, path=path)
389
raise errors.NoSuchId(self, file_id)
391
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
393
file_abspath = self.abspath(path)
394
state = self.current_dirstate()
395
if stat_value is None:
397
stat_value = osutils.lstat(file_abspath)
399
if e.errno == errno.ENOENT:
403
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
404
stat_value=stat_value)
405
if entry[1][0][0] == 'f':
406
if link_or_sha1 is None:
407
file_obj, statvalue = self.get_file_with_stat(file_id, path)
409
sha1 = osutils.sha_file(file_obj)
412
self._observed_sha1(file_id, path, (sha1, statvalue))
418
def _get_inventory(self):
419
"""Get the inventory for the tree. This is only valid within a lock."""
420
if 'evil' in debug.debug_flags:
421
trace.mutter_callsite(2,
422
"accessing .inventory forces a size of tree translation.")
423
if self._inventory is not None:
424
return self._inventory
425
self._must_be_locked()
426
self._generate_inventory()
427
return self._inventory
429
inventory = property(_get_inventory,
430
doc="Inventory of this Tree")
433
def get_parent_ids(self):
434
"""See Tree.get_parent_ids.
436
This implementation requests the ids list from the dirstate file.
438
return self.current_dirstate().get_parent_ids()
440
def get_reference_revision(self, file_id, path=None):
441
# referenced tree's revision is whatever's currently there
442
return self.get_nested_tree(file_id, path).last_revision()
444
def get_nested_tree(self, file_id, path=None):
446
path = self.id2path(file_id)
447
# else: check file_id is at path?
448
return WorkingTree.open(self.abspath(path))
451
def get_root_id(self):
452
"""Return the id of this trees root"""
453
return self._get_entry(path='')[0][2]
455
def has_id(self, file_id):
456
state = self.current_dirstate()
457
row, parents = self._get_entry(file_id=file_id)
460
return osutils.lexists(pathjoin(
461
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
463
def has_or_had_id(self, file_id):
464
state = self.current_dirstate()
465
row, parents = self._get_entry(file_id=file_id)
466
return row is not None
469
def id2path(self, file_id):
470
"Convert a file-id to a path."
471
state = self.current_dirstate()
472
entry = self._get_entry(file_id=file_id)
473
if entry == (None, None):
474
raise errors.NoSuchId(tree=self, file_id=file_id)
475
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
476
return path_utf8.decode('utf8')
478
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
479
entry = self._get_entry(path=path)
480
if entry == (None, None):
481
return False # Missing entries are not executable
482
return entry[1][0][3] # Executable?
484
def is_executable(self, file_id, path=None):
485
"""Test if a file is executable or not.
487
Note: The caller is expected to take a read-lock before calling this.
489
if not self._supports_executable():
490
entry = self._get_entry(file_id=file_id, path=path)
491
if entry == (None, None):
493
return entry[1][0][3]
495
self._must_be_locked()
497
path = self.id2path(file_id)
498
mode = osutils.lstat(self.abspath(path)).st_mode
499
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
501
def all_file_ids(self):
502
"""See Tree.iter_all_file_ids"""
503
self._must_be_locked()
505
for key, tree_details in self.current_dirstate()._iter_entries():
506
if tree_details[0][0] in ('a', 'r'): # relocated
513
"""Iterate through file_ids for this tree.
515
file_ids are in a WorkingTree if they are in the working inventory
516
and the working file exists.
519
for key, tree_details in self.current_dirstate()._iter_entries():
520
if tree_details[0][0] in ('a', 'r'): # absent, relocated
521
# not relevant to the working tree
523
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
524
if osutils.lexists(path):
525
result.append(key[2])
528
def iter_references(self):
529
if not self._repo_supports_tree_reference:
530
# When the repo doesn't support references, we will have nothing to
533
for key, tree_details in self.current_dirstate()._iter_entries():
534
if tree_details[0][0] in ('a', 'r'): # absent, relocated
535
# not relevant to the working tree
538
# the root is not a reference.
540
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
542
if self._kind(relpath) == 'tree-reference':
543
yield relpath, key[2]
544
except errors.NoSuchFile:
545
# path is missing on disk.
548
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
549
"""See MutableTree._observed_sha1."""
550
state = self.current_dirstate()
551
entry = self._get_entry(file_id=file_id, path=path)
552
state._observed_sha1(entry, sha1, statvalue)
554
def kind(self, file_id):
555
"""Return the kind of a file.
557
This is always the actual kind that's on disk, regardless of what it
560
Note: The caller is expected to take a read-lock before calling this.
562
relpath = self.id2path(file_id)
564
raise AssertionError(
565
"path for id {%s} is None!" % file_id)
566
return self._kind(relpath)
568
def _kind(self, relpath):
569
abspath = self.abspath(relpath)
570
kind = file_kind(abspath)
571
if (self._repo_supports_tree_reference and kind == 'directory'):
572
entry = self._get_entry(path=relpath)
573
if entry[1] is not None:
574
if entry[1][0][0] == 't':
575
kind = 'tree-reference'
579
def _last_revision(self):
580
"""See Mutable.last_revision."""
581
parent_ids = self.current_dirstate().get_parent_ids()
585
return _mod_revision.NULL_REVISION
588
"""See Branch.lock_read, and WorkingTree.unlock.
590
:return: A bzrlib.lock.LogicalLockResult.
592
self.branch.lock_read()
594
self._control_files.lock_read()
596
state = self.current_dirstate()
597
if not state._lock_token:
599
# set our support for tree references from the repository in
601
self._repo_supports_tree_reference = getattr(
602
self.branch.repository._format, "supports_tree_reference",
605
self._control_files.unlock()
610
return LogicalLockResult(self.unlock)
612
def _lock_self_write(self):
613
"""This should be called after the branch is locked."""
615
self._control_files.lock_write()
617
state = self.current_dirstate()
618
if not state._lock_token:
620
# set our support for tree references from the repository in
622
self._repo_supports_tree_reference = getattr(
623
self.branch.repository._format, "supports_tree_reference",
626
self._control_files.unlock()
631
return LogicalLockResult(self.unlock)
633
def lock_tree_write(self):
634
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
636
:return: A bzrlib.lock.LogicalLockResult.
638
self.branch.lock_read()
639
return self._lock_self_write()
641
def lock_write(self):
642
"""See MutableTree.lock_write, and WorkingTree.unlock.
644
:return: A bzrlib.lock.LogicalLockResult.
646
self.branch.lock_write()
647
return self._lock_self_write()
649
@needs_tree_write_lock
650
def move(self, from_paths, to_dir, after=False):
651
"""See WorkingTree.move()."""
655
state = self.current_dirstate()
656
if isinstance(from_paths, basestring):
658
to_dir_utf8 = to_dir.encode('utf8')
659
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
660
id_index = state._get_id_index()
661
# check destination directory
662
# get the details for it
663
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
664
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
665
if not entry_present:
666
raise errors.BzrMoveFailedError('', to_dir,
667
errors.NotVersionedError(to_dir))
668
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
669
# get a handle on the block itself.
670
to_block_index = state._ensure_block(
671
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
672
to_block = state._dirblocks[to_block_index]
673
to_abs = self.abspath(to_dir)
674
if not isdir(to_abs):
675
raise errors.BzrMoveFailedError('',to_dir,
676
errors.NotADirectory(to_abs))
678
if to_entry[1][0][0] != 'd':
679
raise errors.BzrMoveFailedError('',to_dir,
680
errors.NotADirectory(to_abs))
682
if self._inventory is not None:
683
update_inventory = True
685
to_dir_id = to_entry[0][2]
686
to_dir_ie = inv[to_dir_id]
688
update_inventory = False
691
def move_one(old_entry, from_path_utf8, minikind, executable,
692
fingerprint, packed_stat, size,
693
to_block, to_key, to_path_utf8):
694
state._make_absent(old_entry)
695
from_key = old_entry[0]
697
lambda:state.update_minimal(from_key,
699
executable=executable,
700
fingerprint=fingerprint,
701
packed_stat=packed_stat,
703
path_utf8=from_path_utf8))
704
state.update_minimal(to_key,
706
executable=executable,
707
fingerprint=fingerprint,
708
packed_stat=packed_stat,
710
path_utf8=to_path_utf8)
711
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
712
new_entry = to_block[1][added_entry_index]
713
rollbacks.append(lambda:state._make_absent(new_entry))
715
for from_rel in from_paths:
716
# from_rel is 'pathinroot/foo/bar'
717
from_rel_utf8 = from_rel.encode('utf8')
718
from_dirname, from_tail = osutils.split(from_rel)
719
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
720
from_entry = self._get_entry(path=from_rel)
721
if from_entry == (None, None):
722
raise errors.BzrMoveFailedError(from_rel,to_dir,
723
errors.NotVersionedError(path=from_rel))
725
from_id = from_entry[0][2]
726
to_rel = pathjoin(to_dir, from_tail)
727
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
728
item_to_entry = self._get_entry(path=to_rel)
729
if item_to_entry != (None, None):
730
raise errors.BzrMoveFailedError(from_rel, to_rel,
731
"Target is already versioned.")
733
if from_rel == to_rel:
734
raise errors.BzrMoveFailedError(from_rel, to_rel,
735
"Source and target are identical.")
737
from_missing = not self.has_filename(from_rel)
738
to_missing = not self.has_filename(to_rel)
745
raise errors.BzrMoveFailedError(from_rel, to_rel,
746
errors.NoSuchFile(path=to_rel,
747
extra="New file has not been created yet"))
749
# neither path exists
750
raise errors.BzrRenameFailedError(from_rel, to_rel,
751
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
753
if from_missing: # implicitly just update our path mapping
756
raise errors.RenameFailedFilesExist(from_rel, to_rel)
759
def rollback_rename():
760
"""A single rename has failed, roll it back."""
761
# roll back everything, even if we encounter trouble doing one
764
# TODO: at least log the other exceptions rather than just
765
# losing them mbp 20070307
767
for rollback in reversed(rollbacks):
771
exc_info = sys.exc_info()
773
raise exc_info[0], exc_info[1], exc_info[2]
775
# perform the disk move first - its the most likely failure point.
777
from_rel_abs = self.abspath(from_rel)
778
to_rel_abs = self.abspath(to_rel)
780
osutils.rename(from_rel_abs, to_rel_abs)
782
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
783
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
785
# perform the rename in the inventory next if needed: its easy
789
from_entry = inv[from_id]
790
current_parent = from_entry.parent_id
791
inv.rename(from_id, to_dir_id, from_tail)
793
lambda: inv.rename(from_id, current_parent, from_tail))
794
# finally do the rename in the dirstate, which is a little
795
# tricky to rollback, but least likely to need it.
796
old_block_index, old_entry_index, dir_present, file_present = \
797
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
798
old_block = state._dirblocks[old_block_index][1]
799
old_entry = old_block[old_entry_index]
800
from_key, old_entry_details = old_entry
801
cur_details = old_entry_details[0]
803
to_key = ((to_block[0],) + from_key[1:3])
804
minikind = cur_details[0]
805
move_one(old_entry, from_path_utf8=from_rel_utf8,
807
executable=cur_details[3],
808
fingerprint=cur_details[1],
809
packed_stat=cur_details[4],
813
to_path_utf8=to_rel_utf8)
816
def update_dirblock(from_dir, to_key, to_dir_utf8):
817
"""Recursively update all entries in this dirblock."""
819
raise AssertionError("renaming root not supported")
820
from_key = (from_dir, '')
821
from_block_idx, present = \
822
state._find_block_index_from_key(from_key)
824
# This is the old record, if it isn't present, then
825
# there is theoretically nothing to update.
826
# (Unless it isn't present because of lazy loading,
827
# but we don't do that yet)
829
from_block = state._dirblocks[from_block_idx]
830
to_block_index, to_entry_index, _, _ = \
831
state._get_block_entry_index(to_key[0], to_key[1], 0)
832
to_block_index = state._ensure_block(
833
to_block_index, to_entry_index, to_dir_utf8)
834
to_block = state._dirblocks[to_block_index]
836
# Grab a copy since move_one may update the list.
837
for entry in from_block[1][:]:
838
if not (entry[0][0] == from_dir):
839
raise AssertionError()
840
cur_details = entry[1][0]
841
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
842
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
843
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
844
minikind = cur_details[0]
846
# Deleted children of a renamed directory
847
# Do not need to be updated.
848
# Children that have been renamed out of this
849
# directory should also not be updated
851
move_one(entry, from_path_utf8=from_path_utf8,
853
executable=cur_details[3],
854
fingerprint=cur_details[1],
855
packed_stat=cur_details[4],
859
to_path_utf8=to_path_utf8)
861
# We need to move all the children of this
863
update_dirblock(from_path_utf8, to_key,
865
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
869
result.append((from_rel, to_rel))
870
state._mark_modified()
871
self._make_dirty(reset_inventory=False)
875
def _must_be_locked(self):
876
if not self._control_files._lock_count:
877
raise errors.ObjectNotLocked(self)
880
"""Initialize the state in this tree to be a new tree."""
884
def path2id(self, path):
885
"""Return the id for path in this tree."""
886
path = path.strip('/')
887
entry = self._get_entry(path=path)
888
if entry == (None, None):
892
def paths2ids(self, paths, trees=[], require_versioned=True):
893
"""See Tree.paths2ids().
895
This specialisation fast-paths the case where all the trees are in the
900
parents = self.get_parent_ids()
902
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
904
return super(DirStateWorkingTree, self).paths2ids(paths,
905
trees, require_versioned)
906
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
907
# -- make all paths utf8 --
910
paths_utf8.add(path.encode('utf8'))
912
# -- paths is now a utf8 path set --
913
# -- get the state object and prepare it.
914
state = self.current_dirstate()
915
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
916
and '' not in paths):
917
paths2ids = self._paths2ids_using_bisect
919
paths2ids = self._paths2ids_in_memory
920
return paths2ids(paths, search_indexes,
921
require_versioned=require_versioned)
923
def _paths2ids_in_memory(self, paths, search_indexes,
924
require_versioned=True):
925
state = self.current_dirstate()
926
state._read_dirblocks_if_needed()
927
def _entries_for_path(path):
928
"""Return a list with all the entries that match path for all ids.
930
dirname, basename = os.path.split(path)
931
key = (dirname, basename, '')
932
block_index, present = state._find_block_index_from_key(key)
934
# the block which should contain path is absent.
937
block = state._dirblocks[block_index][1]
938
entry_index, _ = state._find_entry_index(key, block)
939
# we may need to look at multiple entries at this path: walk while the paths match.
940
while (entry_index < len(block) and
941
block[entry_index][0][0:2] == key[0:2]):
942
result.append(block[entry_index])
945
if require_versioned:
946
# -- check all supplied paths are versioned in a search tree. --
949
path_entries = _entries_for_path(path)
951
# this specified path is not present at all: error
952
all_versioned = False
954
found_versioned = False
955
# for each id at this path
956
for entry in path_entries:
958
for index in search_indexes:
959
if entry[1][index][0] != 'a': # absent
960
found_versioned = True
961
# all good: found a versioned cell
963
if not found_versioned:
964
# none of the indexes was not 'absent' at all ids for this
966
all_versioned = False
968
if not all_versioned:
969
raise errors.PathsNotVersionedError(
970
[p.decode('utf-8') for p in paths])
971
# -- remove redundancy in supplied paths to prevent over-scanning --
972
search_paths = osutils.minimum_path_selection(paths)
974
# for all search_indexs in each path at or under each element of
975
# search_paths, if the detail is relocated: add the id, and add the
976
# relocated path as one to search if its not searched already. If the
977
# detail is not relocated, add the id.
978
searched_paths = set()
980
def _process_entry(entry):
981
"""Look at search_indexes within entry.
983
If a specific tree's details are relocated, add the relocation
984
target to search_paths if not searched already. If it is absent, do
985
nothing. Otherwise add the id to found_ids.
987
for index in search_indexes:
988
if entry[1][index][0] == 'r': # relocated
989
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
990
search_paths.add(entry[1][index][1])
991
elif entry[1][index][0] != 'a': # absent
992
found_ids.add(entry[0][2])
994
current_root = search_paths.pop()
995
searched_paths.add(current_root)
996
# process the entries for this containing directory: the rest will be
997
# found by their parents recursively.
998
root_entries = _entries_for_path(current_root)
1000
# this specified path is not present at all, skip it.
1002
for entry in root_entries:
1003
_process_entry(entry)
1004
initial_key = (current_root, '', '')
1005
block_index, _ = state._find_block_index_from_key(initial_key)
1006
while (block_index < len(state._dirblocks) and
1007
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
1008
for entry in state._dirblocks[block_index][1]:
1009
_process_entry(entry)
1013
def _paths2ids_using_bisect(self, paths, search_indexes,
1014
require_versioned=True):
1015
state = self.current_dirstate()
1018
split_paths = sorted(osutils.split(p) for p in paths)
1019
found = state._bisect_recursive(split_paths)
1021
if require_versioned:
1022
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1023
for dir_name in split_paths:
1024
if dir_name not in found_dir_names:
1025
raise errors.PathsNotVersionedError(
1026
[p.decode('utf-8') for p in paths])
1028
for dir_name_id, trees_info in found.iteritems():
1029
for index in search_indexes:
1030
if trees_info[index][0] not in ('r', 'a'):
1031
found_ids.add(dir_name_id[2])
1034
def read_working_inventory(self):
1035
"""Read the working inventory.
1037
This is a meaningless operation for dirstate, but we obey it anyhow.
1039
return self.inventory
1042
def revision_tree(self, revision_id):
1043
"""See Tree.revision_tree.
1045
WorkingTree4 supplies revision_trees for any basis tree.
1047
dirstate = self.current_dirstate()
1048
parent_ids = dirstate.get_parent_ids()
1049
if revision_id not in parent_ids:
1050
raise errors.NoSuchRevisionInTree(self, revision_id)
1051
if revision_id in dirstate.get_ghosts():
1052
raise errors.NoSuchRevisionInTree(self, revision_id)
1053
return DirStateRevisionTree(dirstate, revision_id,
1054
self.branch.repository)
1056
@needs_tree_write_lock
1057
def set_last_revision(self, new_revision):
1058
"""Change the last revision in the working tree."""
1059
parents = self.get_parent_ids()
1060
if new_revision in (_mod_revision.NULL_REVISION, None):
1061
if len(parents) >= 2:
1062
raise AssertionError(
1063
"setting the last parent to none with a pending merge is "
1065
self.set_parent_ids([])
1067
self.set_parent_ids([new_revision] + parents[1:],
1068
allow_leftmost_as_ghost=True)
1070
@needs_tree_write_lock
1071
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1072
"""Set the parent ids to revision_ids.
1074
See also set_parent_trees. This api will try to retrieve the tree data
1075
for each element of revision_ids from the trees repository. If you have
1076
tree data already available, it is more efficient to use
1077
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1078
an easier API to use.
1080
:param revision_ids: The revision_ids to set as the parent ids of this
1081
working tree. Any of these may be ghosts.
1084
for revision_id in revision_ids:
1086
revtree = self.branch.repository.revision_tree(revision_id)
1087
# TODO: jam 20070213 KnitVersionedFile raises
1088
# RevisionNotPresent rather than NoSuchRevision if a
1089
# given revision_id is not present. Should Repository be
1090
# catching it and re-raising NoSuchRevision?
1091
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1093
trees.append((revision_id, revtree))
1094
self.set_parent_trees(trees,
1095
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1097
@needs_tree_write_lock
1098
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1099
"""Set the parents of the working tree.
1101
:param parents_list: A list of (revision_id, tree) tuples.
1102
If tree is None, then that element is treated as an unreachable
1103
parent tree - i.e. a ghost.
1105
dirstate = self.current_dirstate()
1106
if len(parents_list) > 0:
1107
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1108
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1112
parent_ids = [rev_id for rev_id, tree in parents_list]
1113
graph = self.branch.repository.get_graph()
1114
heads = graph.heads(parent_ids)
1115
accepted_revisions = set()
1117
# convert absent trees to the null tree, which we convert back to
1118
# missing on access.
1119
for rev_id, tree in parents_list:
1120
if len(accepted_revisions) > 0:
1121
# we always accept the first tree
1122
if rev_id in accepted_revisions or rev_id not in heads:
1123
# We have already included either this tree, or its
1124
# descendent, so we skip it.
1126
_mod_revision.check_not_reserved_id(rev_id)
1127
if tree is not None:
1128
real_trees.append((rev_id, tree))
1130
real_trees.append((rev_id,
1131
self.branch.repository.revision_tree(
1132
_mod_revision.NULL_REVISION)))
1133
ghosts.append(rev_id)
1134
accepted_revisions.add(rev_id)
1136
if (len(real_trees) == 1
1138
and self.branch.repository._format.fast_deltas
1139
and isinstance(real_trees[0][1],
1140
revisiontree.InventoryRevisionTree)
1141
and self.get_parent_ids()):
1142
rev_id, rev_tree = real_trees[0]
1143
basis_id = self.get_parent_ids()[0]
1144
# There are times when basis_tree won't be in
1145
# self.branch.repository, (switch, for example)
1147
basis_tree = self.branch.repository.revision_tree(basis_id)
1148
except errors.NoSuchRevision:
1149
# Fall back to the set_parent_trees(), since we can't use
1150
# _make_delta if we can't get the RevisionTree
1153
delta = rev_tree.inventory._make_delta(basis_tree.inventory)
1154
dirstate.update_basis_by_delta(delta, rev_id)
1157
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1158
self._make_dirty(reset_inventory=False)
1160
def _set_root_id(self, file_id):
1161
"""See WorkingTree.set_root_id."""
1162
state = self.current_dirstate()
1163
state.set_path_id('', file_id)
1164
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1165
self._make_dirty(reset_inventory=True)
1167
def _sha_from_stat(self, path, stat_result):
1168
"""Get a sha digest from the tree's stat cache.
1170
The default implementation assumes no stat cache is present.
1172
:param path: The path.
1173
:param stat_result: The stat result being looked up.
1175
return self.current_dirstate().sha1_from_stat(path, stat_result)
1178
def supports_tree_reference(self):
1179
return self._repo_supports_tree_reference
1182
"""Unlock in format 4 trees needs to write the entire dirstate."""
1183
if self._control_files._lock_count == 1:
1184
# do non-implementation specific cleanup
1187
# eventually we should do signature checking during read locks for
1189
if self._control_files._lock_mode == 'w':
1192
if self._dirstate is not None:
1193
# This is a no-op if there are no modifications.
1194
self._dirstate.save()
1195
self._dirstate.unlock()
1196
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1197
# point. Instead, it could check if the header has been
1198
# modified when it is locked, and if not, it can hang on to
1199
# the data it has in memory.
1200
self._dirstate = None
1201
self._inventory = None
1202
# reverse order of locking.
1204
return self._control_files.unlock()
1206
self.branch.unlock()
1208
@needs_tree_write_lock
1209
def unversion(self, file_ids):
1210
"""Remove the file ids in file_ids from the current versioned set.
1212
When a file_id is unversioned, all of its children are automatically
1215
:param file_ids: The file ids to stop versioning.
1216
:raises: NoSuchId if any fileid is not currently versioned.
1220
state = self.current_dirstate()
1221
state._read_dirblocks_if_needed()
1222
ids_to_unversion = set(file_ids)
1223
paths_to_unversion = set()
1225
# check if the root is to be unversioned, if so, assert for now.
1226
# walk the state marking unversioned things as absent.
1227
# if there are any un-unversioned ids at the end, raise
1228
for key, details in state._dirblocks[0][1]:
1229
if (details[0][0] not in ('a', 'r') and # absent or relocated
1230
key[2] in ids_to_unversion):
1231
# I haven't written the code to unversion / yet - it should be
1233
raise errors.BzrError('Unversioning the / is not currently supported')
1235
while block_index < len(state._dirblocks):
1236
# process one directory at a time.
1237
block = state._dirblocks[block_index]
1238
# first check: is the path one to remove - it or its children
1239
delete_block = False
1240
for path in paths_to_unversion:
1241
if (block[0].startswith(path) and
1242
(len(block[0]) == len(path) or
1243
block[0][len(path)] == '/')):
1244
# this entire block should be deleted - its the block for a
1245
# path to unversion; or the child of one
1248
# TODO: trim paths_to_unversion as we pass by paths
1250
# this block is to be deleted: process it.
1251
# TODO: we can special case the no-parents case and
1252
# just forget the whole block.
1254
while entry_index < len(block[1]):
1255
entry = block[1][entry_index]
1256
if entry[1][0][0] in 'ar':
1257
# don't remove absent or renamed entries
1260
# Mark this file id as having been removed
1261
ids_to_unversion.discard(entry[0][2])
1262
if not state._make_absent(entry):
1263
# The block has not shrunk.
1265
# go to the next block. (At the moment we dont delete empty
1270
while entry_index < len(block[1]):
1271
entry = block[1][entry_index]
1272
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1273
# ^ some parent row.
1274
entry[0][2] not in ids_to_unversion):
1275
# ^ not an id to unversion
1278
if entry[1][0][0] == 'd':
1279
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1280
if not state._make_absent(entry):
1282
# we have unversioned this id
1283
ids_to_unversion.remove(entry[0][2])
1285
if ids_to_unversion:
1286
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1287
self._make_dirty(reset_inventory=False)
1288
# have to change the legacy inventory too.
1289
if self._inventory is not None:
1290
for file_id in file_ids:
1291
if self._inventory.has_id(file_id):
1292
self._inventory.remove_recursive_id(file_id)
1294
@needs_tree_write_lock
1295
def rename_one(self, from_rel, to_rel, after=False):
1296
"""See WorkingTree.rename_one"""
1298
super(DirStateWorkingTree, self).rename_one(from_rel, to_rel, after)
1300
@needs_tree_write_lock
1301
def apply_inventory_delta(self, changes):
1302
"""See MutableTree.apply_inventory_delta"""
1303
state = self.current_dirstate()
1304
state.update_by_delta(changes)
1305
self._make_dirty(reset_inventory=True)
1307
def update_basis_by_delta(self, new_revid, delta):
1308
"""See MutableTree.update_basis_by_delta."""
1309
if self.last_revision() == new_revid:
1310
raise AssertionError()
1311
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1314
def _validate(self):
1315
self._dirstate._validate()
1317
@needs_tree_write_lock
1318
def _write_inventory(self, inv):
1319
"""Write inventory as the current inventory."""
1321
raise AssertionError("attempting to write an inventory when the "
1322
"dirstate is dirty will lose pending changes")
1323
had_inventory = self._inventory is not None
1324
# Setting self._inventory = None forces the dirstate to regenerate the
1325
# working inventory. We do this because self.inventory may be inv, or
1326
# may have been modified, and either case would prevent a clean delta
1328
self._inventory = None
1330
delta = inv._make_delta(self.inventory)
1332
self.apply_inventory_delta(delta)
1334
self._inventory = inv
1337
@needs_tree_write_lock
1338
def reset_state(self, revision_ids=None):
1339
"""Reset the state of the working tree.
1341
This does a hard-reset to a last-known-good state. This is a way to
1342
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1344
if revision_ids is None:
1345
revision_ids = self.get_parent_ids()
1346
if not revision_ids:
1347
base_tree = self.branch.repository.revision_tree(
1348
_mod_revision.NULL_REVISION)
1351
trees = zip(revision_ids,
1352
self.branch.repository.revision_trees(revision_ids))
1353
base_tree = trees[0][1]
1354
state = self.current_dirstate()
1355
# We don't support ghosts yet
1356
state.set_state_from_scratch(base_tree.inventory, trees, [])
1359
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1361
def __init__(self, tree):
1364
def sha1(self, abspath):
1365
"""See dirstate.SHA1Provider.sha1()."""
1366
filters = self.tree._content_filter_stack(
1367
self.tree.relpath(osutils.safe_unicode(abspath)))
1368
return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
1370
def stat_and_sha1(self, abspath):
1371
"""See dirstate.SHA1Provider.stat_and_sha1()."""
1372
filters = self.tree._content_filter_stack(
1373
self.tree.relpath(osutils.safe_unicode(abspath)))
1374
file_obj = file(abspath, 'rb', 65000)
1376
statvalue = os.fstat(file_obj.fileno())
1378
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
1379
sha1 = osutils.size_sha_file(file_obj)[1]
1382
return statvalue, sha1
1385
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1386
"""Dirstate working tree that supports content filtering.
1388
The dirstate holds the hash and size of the canonical form of the file,
1389
and most methods must return that.
1392
def _file_content_summary(self, path, stat_result):
1393
# This is to support the somewhat obsolete path_content_summary method
1394
# with content filtering: see
1395
# <https://bugs.launchpad.net/bzr/+bug/415508>.
1397
# If the dirstate cache is up to date and knows the hash and size,
1399
# Otherwise if there are no content filters, return the on-disk size
1400
# and leave the hash blank.
1401
# Otherwise, read and filter the on-disk file and use its size and
1404
# The dirstate doesn't store the size of the canonical form so we
1405
# can't trust it for content-filtered trees. We just return None.
1406
dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1407
executable = self._is_executable_from_path_and_stat(path, stat_result)
1408
return ('file', None, executable, dirstate_sha1)
1411
class WorkingTree4(DirStateWorkingTree):
1412
"""This is the Format 4 working tree.
1414
This differs from WorkingTree by:
1415
- Having a consolidated internal dirstate, stored in a
1416
randomly-accessible sorted file on disk.
1417
- Not having a regular inventory attribute. One can be synthesized
1418
on demand but this is expensive and should be avoided.
1420
This is new in bzr 0.15.
1424
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1425
"""This is the Format 5 working tree.
1427
This differs from WorkingTree4 by:
1428
- Supporting content filtering.
1430
This is new in bzr 1.11.
1434
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1435
"""This is the Format 6 working tree.
1437
This differs from WorkingTree5 by:
1438
- Supporting a current view that may mask the set of files in a tree
1439
impacted by most user operations.
1441
This is new in bzr 1.14.
1444
def _make_views(self):
1445
return views.PathBasedViews(self)
1448
class DirStateWorkingTreeFormat(WorkingTreeFormatMetaDir):
1450
missing_parent_conflicts = True
1452
supports_versioned_directories = True
1454
_lock_class = LockDir
1455
_lock_file_name = 'lock'
1457
def _open_control_files(self, a_bzrdir):
1458
transport = a_bzrdir.get_workingtree_transport(None)
1459
return LockableFiles(transport, self._lock_file_name,
1462
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1463
accelerator_tree=None, hardlink=False):
1464
"""See WorkingTreeFormat.initialize().
1466
:param revision_id: allows creating a working tree at a different
1467
revision than the branch is at.
1468
:param accelerator_tree: A tree which can be used for retrieving file
1469
contents more quickly than the revision tree, i.e. a workingtree.
1470
The revision tree will be used for cases where accelerator_tree's
1471
content is different.
1472
:param hardlink: If true, hard-link files from accelerator_tree,
1475
These trees get an initial random root id, if their repository supports
1476
rich root data, TREE_ROOT otherwise.
1478
if not isinstance(a_bzrdir.transport, LocalTransport):
1479
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1480
transport = a_bzrdir.get_workingtree_transport(self)
1481
control_files = self._open_control_files(a_bzrdir)
1482
control_files.create_lock()
1483
control_files.lock_write()
1484
transport.put_bytes('format', self.as_string(),
1485
mode=a_bzrdir._get_file_mode())
1486
if from_branch is not None:
1487
branch = from_branch
1489
branch = a_bzrdir.open_branch()
1490
if revision_id is None:
1491
revision_id = branch.last_revision()
1492
local_path = transport.local_abspath('dirstate')
1493
# write out new dirstate (must exist when we create the tree)
1494
state = dirstate.DirState.initialize(local_path)
1497
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1501
_control_files=control_files)
1503
wt.lock_tree_write()
1505
self._init_custom_control_files(wt)
1506
if revision_id in (None, _mod_revision.NULL_REVISION):
1507
if branch.repository.supports_rich_root():
1508
wt._set_root_id(generate_ids.gen_root_id())
1510
wt._set_root_id(ROOT_ID)
1513
# frequently, we will get here due to branching. The accelerator
1514
# tree will be the tree from the branch, so the desired basis
1515
# tree will often be a parent of the accelerator tree.
1516
if accelerator_tree is not None:
1518
basis = accelerator_tree.revision_tree(revision_id)
1519
except errors.NoSuchRevision:
1522
basis = branch.repository.revision_tree(revision_id)
1523
if revision_id == _mod_revision.NULL_REVISION:
1526
parents_list = [(revision_id, basis)]
1529
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1531
# if the basis has a root id we have to use that; otherwise we
1532
# use a new random one
1533
basis_root_id = basis.get_root_id()
1534
if basis_root_id is not None:
1535
wt._set_root_id(basis_root_id)
1537
if wt.supports_content_filtering():
1538
# The original tree may not have the same content filters
1539
# applied so we can't safely build the inventory delta from
1541
delta_from_tree = False
1543
delta_from_tree = True
1544
# delta_from_tree is safe even for DirStateRevisionTrees,
1545
# because wt4.apply_inventory_delta does not mutate the input
1546
# inventory entries.
1547
transform.build_tree(basis, wt, accelerator_tree,
1549
delta_from_tree=delta_from_tree)
1550
for hook in MutableTree.hooks['post_build_tree']:
1555
control_files.unlock()
1559
def _init_custom_control_files(self, wt):
1560
"""Subclasses with custom control files should override this method.
1562
The working tree and control files are locked for writing when this
1565
:param wt: the WorkingTree object
1568
def open(self, a_bzrdir, _found=False):
1569
"""Return the WorkingTree object for a_bzrdir
1571
_found is a private parameter, do not use it. It is used to indicate
1572
if format probing has already been done.
1575
# we are being called directly and must probe.
1576
raise NotImplementedError
1577
if not isinstance(a_bzrdir.transport, LocalTransport):
1578
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1579
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1582
def _open(self, a_bzrdir, control_files):
1583
"""Open the tree itself.
1585
:param a_bzrdir: the dir for the tree.
1586
:param control_files: the control files for the tree.
1588
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1589
branch=a_bzrdir.open_branch(),
1592
_control_files=control_files)
1594
def __get_matchingbzrdir(self):
1595
return self._get_matchingbzrdir()
1597
def _get_matchingbzrdir(self):
1598
"""Overrideable method to get a bzrdir for testing."""
1599
# please test against something that will let us do tree references
1600
return bzrdir.format_registry.make_bzrdir(
1601
'dirstate-with-subtree')
1603
_matchingbzrdir = property(__get_matchingbzrdir)
1606
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1607
"""The first consolidated dirstate working tree format.
1610
- exists within a metadir controlling .bzr
1611
- includes an explicit version marker for the workingtree control
1612
files, separate from the ControlDir format
1613
- modifies the hash cache format
1614
- is new in bzr 0.15
1615
- uses a LockDir to guard access to it.
1618
upgrade_recommended = False
1620
_tree_class = WorkingTree4
1623
def get_format_string(cls):
1624
"""See WorkingTreeFormat.get_format_string()."""
1625
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1627
def get_format_description(self):
1628
"""See WorkingTreeFormat.get_format_description()."""
1629
return "Working tree format 4"
1632
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1633
"""WorkingTree format supporting content filtering.
1636
upgrade_recommended = False
1638
_tree_class = WorkingTree5
1641
def get_format_string(cls):
1642
"""See WorkingTreeFormat.get_format_string()."""
1643
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1645
def get_format_description(self):
1646
"""See WorkingTreeFormat.get_format_description()."""
1647
return "Working tree format 5"
1649
def supports_content_filtering(self):
1653
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1654
"""WorkingTree format supporting views.
1657
upgrade_recommended = False
1659
_tree_class = WorkingTree6
1662
def get_format_string(cls):
1663
"""See WorkingTreeFormat.get_format_string()."""
1664
return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1666
def get_format_description(self):
1667
"""See WorkingTreeFormat.get_format_description()."""
1668
return "Working tree format 6"
1670
def _init_custom_control_files(self, wt):
1671
"""Subclasses with custom control files should override this method."""
1672
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1674
def supports_content_filtering(self):
1677
def supports_views(self):
1681
class DirStateRevisionTree(InventoryTree):
1682
"""A revision tree pulling the inventory from a dirstate.
1684
Note that this is one of the historical (ie revision) trees cached in the
1685
dirstate for easy access, not the workingtree.
1688
def __init__(self, dirstate, revision_id, repository):
1689
self._dirstate = dirstate
1690
self._revision_id = revision_id
1691
self._repository = repository
1692
self._inventory = None
1694
self._dirstate_locked = False
1695
self._repo_supports_tree_reference = getattr(
1696
repository._format, "supports_tree_reference",
1700
return "<%s of %s in %s>" % \
1701
(self.__class__.__name__, self._revision_id, self._dirstate)
1703
def annotate_iter(self, file_id,
1704
default_revision=_mod_revision.CURRENT_REVISION):
1705
"""See Tree.annotate_iter"""
1706
text_key = (file_id, self.get_file_revision(file_id))
1707
annotations = self._repository.texts.annotate(text_key)
1708
return [(key[-1], line) for (key, line) in annotations]
1710
def _comparison_data(self, entry, path):
1711
"""See Tree._comparison_data."""
1713
return None, False, None
1714
# trust the entry as RevisionTree does, but this may not be
1715
# sensible: the entry might not have come from us?
1716
return entry.kind, entry.executable, None
1718
def _file_size(self, entry, stat_value):
1719
return entry.text_size
1721
def filter_unversioned_files(self, paths):
1722
"""Filter out paths that are not versioned.
1724
:return: set of paths.
1726
pred = self.has_filename
1727
return set((p for p in paths if not pred(p)))
1729
def get_root_id(self):
1730
return self.path2id('')
1732
def id2path(self, file_id):
1733
"Convert a file-id to a path."
1734
entry = self._get_entry(file_id=file_id)
1735
if entry == (None, None):
1736
raise errors.NoSuchId(tree=self, file_id=file_id)
1737
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1738
return path_utf8.decode('utf8')
1740
def iter_references(self):
1741
if not self._repo_supports_tree_reference:
1742
# When the repo doesn't support references, we will have nothing to
1745
# Otherwise, fall back to the default implementation
1746
return super(DirStateRevisionTree, self).iter_references()
1748
def _get_parent_index(self):
1749
"""Return the index in the dirstate referenced by this tree."""
1750
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1752
def _get_entry(self, file_id=None, path=None):
1753
"""Get the dirstate row for file_id or path.
1755
If either file_id or path is supplied, it is used as the key to lookup.
1756
If both are supplied, the fastest lookup is used, and an error is
1757
raised if they do not both point at the same row.
1759
:param file_id: An optional unicode file_id to be looked up.
1760
:param path: An optional unicode path to be looked up.
1761
:return: The dirstate row tuple for path/file_id, or (None, None)
1763
if file_id is None and path is None:
1764
raise errors.BzrError('must supply file_id or path')
1765
if path is not None:
1766
path = path.encode('utf8')
1767
parent_index = self._get_parent_index()
1768
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1770
def _generate_inventory(self):
1771
"""Create and set self.inventory from the dirstate object.
1773
(So this is only called the first time the inventory is requested for
1774
this tree; it then remains in memory until it's out of date.)
1776
This is relatively expensive: we have to walk the entire dirstate.
1778
if not self._locked:
1779
raise AssertionError(
1780
'cannot generate inventory of an unlocked '
1781
'dirstate revision tree')
1782
# separate call for profiling - makes it clear where the costs are.
1783
self._dirstate._read_dirblocks_if_needed()
1784
if self._revision_id not in self._dirstate.get_parent_ids():
1785
raise AssertionError(
1786
'parent %s has disappeared from %s' % (
1787
self._revision_id, self._dirstate.get_parent_ids()))
1788
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1789
# This is identical now to the WorkingTree _generate_inventory except
1790
# for the tree index use.
1791
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1792
current_id = root_key[2]
1793
if current_entry[parent_index][0] != 'd':
1794
raise AssertionError()
1795
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1796
inv.root.revision = current_entry[parent_index][4]
1797
# Turn some things into local variables
1798
minikind_to_kind = dirstate.DirState._minikind_to_kind
1799
factory = entry_factory
1800
utf8_decode = cache_utf8._utf8_decode
1801
inv_byid = inv._byid
1802
# we could do this straight out of the dirstate; it might be fast
1803
# and should be profiled - RBC 20070216
1804
parent_ies = {'' : inv.root}
1805
for block in self._dirstate._dirblocks[1:]: #skip root
1808
parent_ie = parent_ies[dirname]
1810
# all the paths in this block are not versioned in this tree
1812
for key, entry in block[1]:
1813
minikind, fingerprint, size, executable, revid = entry[parent_index]
1814
if minikind in ('a', 'r'): # absent, relocated
1818
name_unicode = utf8_decode(name)[0]
1820
kind = minikind_to_kind[minikind]
1821
inv_entry = factory[kind](file_id, name_unicode,
1823
inv_entry.revision = revid
1825
inv_entry.executable = executable
1826
inv_entry.text_size = size
1827
inv_entry.text_sha1 = fingerprint
1828
elif kind == 'directory':
1829
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1830
elif kind == 'symlink':
1831
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1832
elif kind == 'tree-reference':
1833
inv_entry.reference_revision = fingerprint or None
1835
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1837
# These checks cost us around 40ms on a 55k entry tree
1838
if file_id in inv_byid:
1839
raise AssertionError('file_id %s already in'
1840
' inventory as %s' % (file_id, inv_byid[file_id]))
1841
if name_unicode in parent_ie.children:
1842
raise AssertionError('name %r already in parent'
1844
inv_byid[file_id] = inv_entry
1845
parent_ie.children[name_unicode] = inv_entry
1846
self._inventory = inv
1848
def get_file_mtime(self, file_id, path=None):
1849
"""Return the modification time for this record.
1851
We return the timestamp of the last-changed revision.
1853
# Make sure the file exists
1854
entry = self._get_entry(file_id, path=path)
1855
if entry == (None, None): # do we raise?
1856
raise errors.NoSuchId(self, file_id)
1857
parent_index = self._get_parent_index()
1858
last_changed_revision = entry[1][parent_index][4]
1860
rev = self._repository.get_revision(last_changed_revision)
1861
except errors.NoSuchRevision:
1862
raise errors.FileTimestampUnavailable(self.id2path(file_id))
1863
return rev.timestamp
1865
def get_file_sha1(self, file_id, path=None, stat_value=None):
1866
entry = self._get_entry(file_id=file_id, path=path)
1867
parent_index = self._get_parent_index()
1868
parent_details = entry[1][parent_index]
1869
if parent_details[0] == 'f':
1870
return parent_details[1]
1874
def get_file_revision(self, file_id):
1875
return self.inventory[file_id].revision
1877
def get_file(self, file_id, path=None):
1878
return StringIO(self.get_file_text(file_id))
1880
def get_file_size(self, file_id):
1881
"""See Tree.get_file_size"""
1882
return self.inventory[file_id].text_size
1884
def get_file_text(self, file_id, path=None):
1885
_, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1886
return ''.join(content)
1888
def get_reference_revision(self, file_id, path=None):
1889
return self.inventory[file_id].reference_revision
1891
def iter_files_bytes(self, desired_files):
1892
"""See Tree.iter_files_bytes.
1894
This version is implemented on top of Repository.iter_files_bytes"""
1895
parent_index = self._get_parent_index()
1896
repo_desired_files = []
1897
for file_id, identifier in desired_files:
1898
entry = self._get_entry(file_id)
1899
if entry == (None, None):
1900
raise errors.NoSuchId(self, file_id)
1901
repo_desired_files.append((file_id, entry[1][parent_index][4],
1903
return self._repository.iter_files_bytes(repo_desired_files)
1905
def get_symlink_target(self, file_id, path=None):
1906
entry = self._get_entry(file_id=file_id)
1907
parent_index = self._get_parent_index()
1908
if entry[1][parent_index][0] != 'l':
1911
target = entry[1][parent_index][1]
1912
target = target.decode('utf8')
1915
def get_revision_id(self):
1916
"""Return the revision id for this tree."""
1917
return self._revision_id
1919
def _get_inventory(self):
1920
if self._inventory is not None:
1921
return self._inventory
1922
self._must_be_locked()
1923
self._generate_inventory()
1924
return self._inventory
1926
inventory = property(_get_inventory,
1927
doc="Inventory of this Tree")
1929
def get_parent_ids(self):
1930
"""The parents of a tree in the dirstate are not cached."""
1931
return self._repository.get_revision(self._revision_id).parent_ids
1933
def has_filename(self, filename):
1934
return bool(self.path2id(filename))
1936
def kind(self, file_id):
1937
entry = self._get_entry(file_id=file_id)[1]
1939
raise errors.NoSuchId(tree=self, file_id=file_id)
1940
parent_index = self._get_parent_index()
1941
return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1943
def stored_kind(self, file_id):
1944
"""See Tree.stored_kind"""
1945
return self.kind(file_id)
1947
def path_content_summary(self, path):
1948
"""See Tree.path_content_summary."""
1949
id = self.inventory.path2id(path)
1951
return ('missing', None, None, None)
1952
entry = self._inventory[id]
1955
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1956
elif kind == 'symlink':
1957
return (kind, None, None, entry.symlink_target)
1959
return (kind, None, None, None)
1961
def is_executable(self, file_id, path=None):
1962
ie = self.inventory[file_id]
1963
if ie.kind != "file":
1965
return ie.executable
1967
def is_locked(self):
1970
def list_files(self, include_root=False, from_dir=None, recursive=True):
1971
# We use a standard implementation, because DirStateRevisionTree is
1972
# dealing with one of the parents of the current state
1973
inv = self._get_inventory()
1974
if from_dir is None:
1977
from_dir_id = inv.path2id(from_dir)
1978
if from_dir_id is None:
1979
# Directory not versioned
1981
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1982
if inv.root is not None and not include_root and from_dir is None:
1984
for path, entry in entries:
1985
yield path, 'V', entry.kind, entry.file_id, entry
1987
def lock_read(self):
1988
"""Lock the tree for a set of operations.
1990
:return: A bzrlib.lock.LogicalLockResult.
1992
if not self._locked:
1993
self._repository.lock_read()
1994
if self._dirstate._lock_token is None:
1995
self._dirstate.lock_read()
1996
self._dirstate_locked = True
1998
return LogicalLockResult(self.unlock)
2000
def _must_be_locked(self):
2001
if not self._locked:
2002
raise errors.ObjectNotLocked(self)
2005
def path2id(self, path):
2006
"""Return the id for path in this tree."""
2007
# lookup by path: faster than splitting and walking the ivnentory.
2008
entry = self._get_entry(path=path)
2009
if entry == (None, None):
2014
"""Unlock, freeing any cache memory used during the lock."""
2015
# outside of a lock, the inventory is suspect: release it.
2017
if not self._locked:
2018
self._inventory = None
2020
if self._dirstate_locked:
2021
self._dirstate.unlock()
2022
self._dirstate_locked = False
2023
self._repository.unlock()
2026
def supports_tree_reference(self):
2027
return self._repo_supports_tree_reference
2029
def walkdirs(self, prefix=""):
2030
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
2031
# implementation based on an inventory.
2032
# This should be cleaned up to use the much faster Dirstate code
2033
# So for now, we just build up the parent inventory, and extract
2034
# it the same way RevisionTree does.
2035
_directory = 'directory'
2036
inv = self._get_inventory()
2037
top_id = inv.path2id(prefix)
2041
pending = [(prefix, top_id)]
2044
relpath, file_id = pending.pop()
2045
# 0 - relpath, 1- file-id
2047
relroot = relpath + '/'
2050
# FIXME: stash the node in pending
2051
entry = inv[file_id]
2052
for name, child in entry.sorted_children():
2053
toppath = relroot + name
2054
dirblock.append((toppath, name, child.kind, None,
2055
child.file_id, child.kind
2057
yield (relpath, entry.file_id), dirblock
2058
# push the user specified dirs from dirblock
2059
for dir in reversed(dirblock):
2060
if dir[2] == _directory:
2061
pending.append((dir[0], dir[4]))
2064
class InterDirStateTree(InterTree):
2065
"""Fast path optimiser for changes_from with dirstate trees.
2067
This is used only when both trees are in the dirstate working file, and
2068
the source is any parent within the dirstate, and the destination is
2069
the current working tree of the same dirstate.
2071
# this could be generalized to allow comparisons between any trees in the
2072
# dirstate, and possibly between trees stored in different dirstates.
2074
def __init__(self, source, target):
2075
super(InterDirStateTree, self).__init__(source, target)
2076
if not InterDirStateTree.is_compatible(source, target):
2077
raise Exception, "invalid source %r and target %r" % (source, target)
2080
def make_source_parent_tree(source, target):
2081
"""Change the source tree into a parent of the target."""
2082
revid = source.commit('record tree')
2083
target.branch.fetch(source.branch, revid)
2084
target.set_parent_ids([revid])
2085
return target.basis_tree(), target
2088
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
2089
result = klass.make_source_parent_tree(source, target)
2090
result[1]._iter_changes = dirstate.ProcessEntryPython
2094
def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
2096
from bzrlib.tests.test__dirstate_helpers import \
2097
compiled_dirstate_helpers_feature
2098
test_case.requireFeature(compiled_dirstate_helpers_feature)
2099
from bzrlib._dirstate_helpers_pyx import ProcessEntryC
2100
result = klass.make_source_parent_tree(source, target)
2101
result[1]._iter_changes = ProcessEntryC
2104
_matching_from_tree_format = WorkingTreeFormat4()
2105
_matching_to_tree_format = WorkingTreeFormat4()
2108
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
2109
# This method shouldn't be called, because we have python and C
2110
# specific flavours.
2111
raise NotImplementedError
2113
def iter_changes(self, include_unchanged=False,
2114
specific_files=None, pb=None, extra_trees=[],
2115
require_versioned=True, want_unversioned=False):
2116
"""Return the changes from source to target.
2118
:return: An iterator that yields tuples. See InterTree.iter_changes
2120
:param specific_files: An optional list of file paths to restrict the
2121
comparison to. When mapping filenames to ids, all matches in all
2122
trees (including optional extra_trees) are used, and all children of
2123
matched directories are included.
2124
:param include_unchanged: An optional boolean requesting the inclusion of
2125
unchanged entries in the result.
2126
:param extra_trees: An optional list of additional trees to use when
2127
mapping the contents of specific_files (paths) to file_ids.
2128
:param require_versioned: If True, all files in specific_files must be
2129
versioned in one of source, target, extra_trees or
2130
PathsNotVersionedError is raised.
2131
:param want_unversioned: Should unversioned files be returned in the
2132
output. An unversioned file is defined as one with (False, False)
2133
for the versioned pair.
2135
# TODO: handle extra trees in the dirstate.
2136
if (extra_trees or specific_files == []):
2137
# we can't fast-path these cases (yet)
2138
return super(InterDirStateTree, self).iter_changes(
2139
include_unchanged, specific_files, pb, extra_trees,
2140
require_versioned, want_unversioned=want_unversioned)
2141
parent_ids = self.target.get_parent_ids()
2142
if not (self.source._revision_id in parent_ids
2143
or self.source._revision_id == _mod_revision.NULL_REVISION):
2144
raise AssertionError(
2145
"revision {%s} is not stored in {%s}, but %s "
2146
"can only be used for trees stored in the dirstate"
2147
% (self.source._revision_id, self.target, self.iter_changes))
2149
if self.source._revision_id == _mod_revision.NULL_REVISION:
2151
indices = (target_index,)
2153
if not (self.source._revision_id in parent_ids):
2154
raise AssertionError(
2155
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2156
self.source._revision_id, parent_ids))
2157
source_index = 1 + parent_ids.index(self.source._revision_id)
2158
indices = (source_index, target_index)
2159
# -- make all specific_files utf8 --
2161
specific_files_utf8 = set()
2162
for path in specific_files:
2163
# Note, if there are many specific files, using cache_utf8
2164
# would be good here.
2165
specific_files_utf8.add(path.encode('utf8'))
2166
specific_files = specific_files_utf8
2168
specific_files = set([''])
2169
# -- specific_files is now a utf8 path set --
2171
# -- get the state object and prepare it.
2172
state = self.target.current_dirstate()
2173
state._read_dirblocks_if_needed()
2174
if require_versioned:
2175
# -- check all supplied paths are versioned in a search tree. --
2177
for path in specific_files:
2178
path_entries = state._entries_for_path(path)
2179
if not path_entries:
2180
# this specified path is not present at all: error
2181
not_versioned.append(path.decode('utf-8'))
2183
found_versioned = False
2184
# for each id at this path
2185
for entry in path_entries:
2187
for index in indices:
2188
if entry[1][index][0] != 'a': # absent
2189
found_versioned = True
2190
# all good: found a versioned cell
2192
if not found_versioned:
2193
# none of the indexes was not 'absent' at all ids for this
2195
not_versioned.append(path.decode('utf-8'))
2196
if len(not_versioned) > 0:
2197
raise errors.PathsNotVersionedError(not_versioned)
2198
# -- remove redundancy in supplied specific_files to prevent over-scanning --
2199
search_specific_files = osutils.minimum_path_selection(specific_files)
2201
use_filesystem_for_exec = (sys.platform != 'win32')
2202
iter_changes = self.target._iter_changes(include_unchanged,
2203
use_filesystem_for_exec, search_specific_files, state,
2204
source_index, target_index, want_unversioned, self.target)
2205
return iter_changes.iter_changes()
2208
def is_compatible(source, target):
2209
# the target must be a dirstate working tree
2210
if not isinstance(target, DirStateWorkingTree):
2212
# the source must be a revtree or dirstate rev tree.
2213
if not isinstance(source,
2214
(revisiontree.RevisionTree, DirStateRevisionTree)):
2216
# the source revid must be in the target dirstate
2217
if not (source._revision_id == _mod_revision.NULL_REVISION or
2218
source._revision_id in target.get_parent_ids()):
2219
# TODO: what about ghosts? it may well need to
2220
# check for them explicitly.
2224
InterTree.register_optimiser(InterDirStateTree)
2227
class Converter3to4(object):
2228
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2231
self.target_format = WorkingTreeFormat4()
2233
def convert(self, tree):
2234
# lock the control files not the tree, so that we dont get tree
2235
# on-unlock behaviours, and so that noone else diddles with the
2236
# tree during upgrade.
2237
tree._control_files.lock_write()
2239
tree.read_working_inventory()
2240
self.create_dirstate_data(tree)
2241
self.update_format(tree)
2242
self.remove_xml_files(tree)
2244
tree._control_files.unlock()
2246
def create_dirstate_data(self, tree):
2247
"""Create the dirstate based data for tree."""
2248
local_path = tree.bzrdir.get_workingtree_transport(None
2249
).local_abspath('dirstate')
2250
state = dirstate.DirState.from_tree(tree, local_path)
2254
def remove_xml_files(self, tree):
2255
"""Remove the oldformat 3 data."""
2256
transport = tree.bzrdir.get_workingtree_transport(None)
2257
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2258
'pending-merges', 'stat-cache']:
2260
transport.delete(path)
2261
except errors.NoSuchFile:
2262
# some files are optional - just deal.
2265
def update_format(self, tree):
2266
"""Change the format marker."""
2267
tree._transport.put_bytes('format',
2268
self.target_format.as_string(),
2269
mode=tree.bzrdir._get_file_mode())
2272
class Converter4to5(object):
2273
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2276
self.target_format = WorkingTreeFormat5()
2278
def convert(self, tree):
2279
# lock the control files not the tree, so that we don't get tree
2280
# on-unlock behaviours, and so that no-one else diddles with the
2281
# tree during upgrade.
2282
tree._control_files.lock_write()
2284
self.update_format(tree)
2286
tree._control_files.unlock()
2288
def update_format(self, tree):
2289
"""Change the format marker."""
2290
tree._transport.put_bytes('format',
2291
self.target_format.as_string(),
2292
mode=tree.bzrdir._get_file_mode())
2295
class Converter4or5to6(object):
2296
"""Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2299
self.target_format = WorkingTreeFormat6()
2301
def convert(self, tree):
2302
# lock the control files not the tree, so that we don't get tree
2303
# on-unlock behaviours, and so that no-one else diddles with the
2304
# tree during upgrade.
2305
tree._control_files.lock_write()
2307
self.init_custom_control_files(tree)
2308
self.update_format(tree)
2310
tree._control_files.unlock()
2312
def init_custom_control_files(self, tree):
2313
"""Initialize custom control files."""
2314
tree._transport.put_bytes('views', '',
2315
mode=tree.bzrdir._get_file_mode())
2317
def update_format(self, tree):
2318
"""Change the format marker."""
2319
tree._transport.put_bytes('format',
2320
self.target_format.as_string(),
2321
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
