1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""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 cStringIO import StringIO
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
31
from bisect import bisect_left
33
from copy import deepcopy
45
conflicts as _mod_conflicts,
55
revision as _mod_revision,
65
from bzrlib.transport import get_transport
69
from bzrlib import symbol_versioning
70
from bzrlib.decorators import needs_read_lock, needs_write_lock
71
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
72
from bzrlib.lockable_files import LockableFiles, TransportLock
73
from bzrlib.lockdir import LockDir
74
import bzrlib.mutabletree
75
from bzrlib.mutabletree import needs_tree_write_lock
76
from bzrlib.osutils import (
86
from bzrlib.trace import mutter, note
87
from bzrlib.transport.local import LocalTransport
88
from bzrlib.tree import InterTree
89
from bzrlib.progress import DummyProgress, ProgressPhase
90
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
91
from bzrlib.rio import RioReader, rio_file, Stanza
92
from bzrlib.symbol_versioning import (deprecated_passed,
97
from bzrlib.tree import Tree
98
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
101
# This is the Windows equivalent of ENOTDIR
102
# It is defined in pywin32.winerror, but we don't want a strong dependency for
103
# just an error code.
104
ERROR_PATH_NOT_FOUND = 3
105
ERROR_DIRECTORY = 267
108
class WorkingTree4(WorkingTree3):
109
"""This is the Format 4 working tree.
111
This differs from WorkingTree3 by:
112
- Having a consolidated internal dirstate, stored in a
113
randomly-accessible sorted file on disk.
114
- Not having a regular inventory attribute. One can be synthesized
115
on demand but this is expensive and should be avoided.
117
This is new in bzr 0.15.
120
def __init__(self, basedir,
125
"""Construct a WorkingTree for basedir.
127
If the branch is not supplied, it is opened automatically.
128
If the branch is supplied, it must be the branch for this basedir.
129
(branch.base is not cross checked, because for remote branches that
130
would be meaningless).
132
self._format = _format
133
self.bzrdir = _bzrdir
134
basedir = safe_unicode(basedir)
135
mutter("opening working tree %r", basedir)
136
self._branch = branch
137
self.basedir = realpath(basedir)
138
# if branch is at our basedir and is a format 6 or less
139
# assume all other formats have their own control files.
140
self._control_files = _control_files
141
self._transport = self._control_files._transport
144
# during a read or write lock these objects are set, and are
145
# None the rest of the time.
146
self._dirstate = None
147
self._inventory = None
149
self._setup_directory_is_tree_reference()
150
self._detect_case_handling()
151
self._rules_searcher = None
153
@needs_tree_write_lock
154
def _add(self, files, ids, kinds):
155
"""See MutableTree._add."""
156
state = self.current_dirstate()
157
for f, file_id, kind in zip(files, ids, kinds):
160
# special case tree root handling.
161
if f == '' and self.path2id(f) == ROOT_ID:
162
state.set_path_id('', generate_ids.gen_file_id(f))
165
file_id = generate_ids.gen_file_id(f)
166
# deliberately add the file with no cached stat or sha1
167
# - on the first access it will be gathered, and we can
168
# always change this once tests are all passing.
169
state.add(f, file_id, kind, None, '')
170
self._make_dirty(reset_inventory=True)
172
def _make_dirty(self, reset_inventory):
173
"""Make the tree state dirty.
175
:param reset_inventory: True if the cached inventory should be removed
176
(presuming there is one).
179
if reset_inventory and self._inventory is not None:
180
self._inventory = None
182
@needs_tree_write_lock
183
def add_reference(self, sub_tree):
184
# use standard implementation, which calls back to self._add
186
# So we don't store the reference_revision in the working dirstate,
187
# it's just recorded at the moment of commit.
188
self._add_reference(sub_tree)
190
def break_lock(self):
191
"""Break a lock if one is present from another instance.
193
Uses the ui factory to ask for confirmation if the lock may be from
196
This will probe the repository for its lock as well.
198
# if the dirstate is locked by an active process, reject the break lock
201
if self._dirstate is None:
205
state = self._current_dirstate()
206
if state._lock_token is not None:
207
# we already have it locked. sheese, cant break our own lock.
208
raise errors.LockActive(self.basedir)
211
# try for a write lock - need permission to get one anyhow
214
except errors.LockContention:
215
# oslocks fail when a process is still live: fail.
216
# TODO: get the locked lockdir info and give to the user to
217
# assist in debugging.
218
raise errors.LockActive(self.basedir)
223
self._dirstate = None
224
self._control_files.break_lock()
225
self.branch.break_lock()
227
def _comparison_data(self, entry, path):
228
kind, executable, stat_value = \
229
WorkingTree3._comparison_data(self, entry, path)
230
# it looks like a plain directory, but it's really a reference -- see
232
if (self._repo_supports_tree_reference and
233
kind == 'directory' and
234
self._directory_is_tree_reference(path)):
235
kind = 'tree-reference'
236
return kind, executable, stat_value
239
def commit(self, message=None, revprops=None, *args, **kwargs):
240
# mark the tree as dirty post commit - commit
241
# can change the current versioned list by doing deletes.
242
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
243
self._make_dirty(reset_inventory=True)
246
def current_dirstate(self):
247
"""Return the current dirstate object.
249
This is not part of the tree interface and only exposed for ease of
252
:raises errors.NotWriteLocked: when not in a lock.
254
self._must_be_locked()
255
return self._current_dirstate()
257
def _current_dirstate(self):
258
"""Internal function that does not check lock status.
260
This is needed for break_lock which also needs the dirstate.
262
if self._dirstate is not None:
263
return self._dirstate
264
local_path = self.bzrdir.get_workingtree_transport(None
265
).local_abspath('dirstate')
266
self._dirstate = dirstate.DirState.on_file(local_path)
267
return self._dirstate
269
def filter_unversioned_files(self, paths):
270
"""Filter out paths that are versioned.
272
:return: set of paths.
274
# TODO: make a generic multi-bisect routine roughly that should list
275
# the paths, then process one half at a time recursively, and feed the
276
# results of each bisect in further still
277
paths = sorted(paths)
279
state = self.current_dirstate()
280
# TODO we want a paths_to_dirblocks helper I think
282
dirname, basename = os.path.split(path.encode('utf8'))
283
_, _, _, path_is_versioned = state._get_block_entry_index(
284
dirname, basename, 0)
285
if not path_is_versioned:
290
"""Write all cached data to disk."""
291
if self._control_files._lock_mode != 'w':
292
raise errors.NotWriteLocked(self)
293
self.current_dirstate().save()
294
self._inventory = None
297
@needs_tree_write_lock
298
def _gather_kinds(self, files, kinds):
299
"""See MutableTree._gather_kinds."""
300
for pos, f in enumerate(files):
301
if kinds[pos] is None:
302
kinds[pos] = self._kind(f)
304
def _generate_inventory(self):
305
"""Create and set self.inventory from the dirstate object.
307
This is relatively expensive: we have to walk the entire dirstate.
308
Ideally we would not, and can deprecate this function.
310
#: uncomment to trap on inventory requests.
311
# import pdb;pdb.set_trace()
312
state = self.current_dirstate()
313
state._read_dirblocks_if_needed()
314
root_key, current_entry = self._get_entry(path='')
315
current_id = root_key[2]
316
if not (current_entry[0][0] == 'd'): # directory
317
raise AssertionError(current_entry)
318
inv = Inventory(root_id=current_id)
319
# Turn some things into local variables
320
minikind_to_kind = dirstate.DirState._minikind_to_kind
321
factory = entry_factory
322
utf8_decode = cache_utf8._utf8_decode
324
# we could do this straight out of the dirstate; it might be fast
325
# and should be profiled - RBC 20070216
326
parent_ies = {'' : inv.root}
327
for block in state._dirblocks[1:]: # skip the root
330
parent_ie = parent_ies[dirname]
332
# all the paths in this block are not versioned in this tree
334
for key, entry in block[1]:
335
minikind, link_or_sha1, size, executable, stat = entry[0]
336
if minikind in ('a', 'r'): # absent, relocated
337
# a parent tree only entry
340
name_unicode = utf8_decode(name)[0]
342
kind = minikind_to_kind[minikind]
343
inv_entry = factory[kind](file_id, name_unicode,
346
# This is only needed on win32, where this is the only way
347
# we know the executable bit.
348
inv_entry.executable = executable
349
# not strictly needed: working tree
350
#inv_entry.text_size = size
351
#inv_entry.text_sha1 = sha1
352
elif kind == 'directory':
353
# add this entry to the parent map.
354
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
355
elif kind == 'tree-reference':
356
if not self._repo_supports_tree_reference:
357
raise AssertionError(
359
"doesn't support tree references "
360
"required by entry %r"
362
inv_entry.reference_revision = link_or_sha1 or None
363
elif kind != 'symlink':
364
raise AssertionError("unknown kind %r" % kind)
365
# These checks cost us around 40ms on a 55k entry tree
366
if file_id in inv_byid:
367
raise AssertionError('file_id %s already in'
368
' inventory as %s' % (file_id, inv_byid[file_id]))
369
if name_unicode in parent_ie.children:
370
raise AssertionError('name %r already in parent'
372
inv_byid[file_id] = inv_entry
373
parent_ie.children[name_unicode] = inv_entry
374
self._inventory = inv
376
def _get_entry(self, file_id=None, path=None):
377
"""Get the dirstate row for file_id or path.
379
If either file_id or path is supplied, it is used as the key to lookup.
380
If both are supplied, the fastest lookup is used, and an error is
381
raised if they do not both point at the same row.
383
:param file_id: An optional unicode file_id to be looked up.
384
:param path: An optional unicode path to be looked up.
385
:return: The dirstate row tuple for path/file_id, or (None, None)
387
if file_id is None and path is None:
388
raise errors.BzrError('must supply file_id or path')
389
state = self.current_dirstate()
391
path = path.encode('utf8')
392
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
394
def get_file_sha1(self, file_id, path=None, stat_value=None):
395
# check file id is valid unconditionally.
396
entry = self._get_entry(file_id=file_id, path=path)
398
raise errors.NoSuchId(self, file_id)
400
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
402
file_abspath = self.abspath(path)
403
state = self.current_dirstate()
404
if stat_value is None:
406
stat_value = os.lstat(file_abspath)
408
if e.errno == errno.ENOENT:
412
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
413
stat_value=stat_value)
414
if entry[1][0][0] == 'f':
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')))
464
def id2path(self, file_id):
465
"Convert a file-id to a path."
466
state = self.current_dirstate()
467
entry = self._get_entry(file_id=file_id)
468
if entry == (None, None):
469
raise errors.NoSuchId(tree=self, file_id=file_id)
470
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
471
return path_utf8.decode('utf8')
473
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
474
entry = self._get_entry(path=path)
475
if entry == (None, None):
476
return False # Missing entries are not executable
477
return entry[1][0][3] # Executable?
479
if not osutils.supports_executable():
480
def is_executable(self, file_id, path=None):
481
"""Test if a file is executable or not.
483
Note: The caller is expected to take a read-lock before calling this.
485
entry = self._get_entry(file_id=file_id, path=path)
486
if entry == (None, None):
488
return entry[1][0][3]
490
_is_executable_from_path_and_stat = \
491
_is_executable_from_path_and_stat_from_basis
493
def is_executable(self, file_id, path=None):
494
"""Test if a file is executable or not.
496
Note: The caller is expected to take a read-lock before calling this.
498
self._must_be_locked()
500
path = self.id2path(file_id)
501
mode = os.lstat(self.abspath(path)).st_mode
502
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
504
def all_file_ids(self):
505
"""See Tree.iter_all_file_ids"""
506
self._must_be_locked()
508
for key, tree_details in self.current_dirstate()._iter_entries():
509
if tree_details[0][0] in ('a', 'r'): # relocated
516
"""Iterate through file_ids for this tree.
518
file_ids are in a WorkingTree if they are in the working inventory
519
and the working file exists.
522
for key, tree_details in self.current_dirstate()._iter_entries():
523
if tree_details[0][0] in ('a', 'r'): # absent, relocated
524
# not relevant to the working tree
526
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
527
if osutils.lexists(path):
528
result.append(key[2])
531
def iter_references(self):
532
if not self._repo_supports_tree_reference:
533
# When the repo doesn't support references, we will have nothing to
536
for key, tree_details in self.current_dirstate()._iter_entries():
537
if tree_details[0][0] in ('a', 'r'): # absent, relocated
538
# not relevant to the working tree
541
# the root is not a reference.
543
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
545
if self._kind(relpath) == 'tree-reference':
546
yield relpath, key[2]
547
except errors.NoSuchFile:
548
# path is missing on disk.
551
def kind(self, file_id):
552
"""Return the kind of a file.
554
This is always the actual kind that's on disk, regardless of what it
557
Note: The caller is expected to take a read-lock before calling this.
559
relpath = self.id2path(file_id)
561
raise AssertionError(
562
"path for id {%s} is None!" % file_id)
563
return self._kind(relpath)
565
def _kind(self, relpath):
566
abspath = self.abspath(relpath)
567
kind = file_kind(abspath)
568
if (self._repo_supports_tree_reference and
569
kind == 'directory' and
570
self._directory_is_tree_reference(relpath)):
571
kind = 'tree-reference'
575
def _last_revision(self):
576
"""See Mutable.last_revision."""
577
parent_ids = self.current_dirstate().get_parent_ids()
581
return _mod_revision.NULL_REVISION
584
"""See Branch.lock_read, and WorkingTree.unlock."""
585
self.branch.lock_read()
587
self._control_files.lock_read()
589
state = self.current_dirstate()
590
if not state._lock_token:
592
# set our support for tree references from the repository in
594
self._repo_supports_tree_reference = getattr(
595
self.branch.repository._format, "supports_tree_reference",
598
self._control_files.unlock()
604
def _lock_self_write(self):
605
"""This should be called after the branch is locked."""
607
self._control_files.lock_write()
609
state = self.current_dirstate()
610
if not state._lock_token:
612
# set our support for tree references from the repository in
614
self._repo_supports_tree_reference = getattr(
615
self.branch.repository._format, "supports_tree_reference",
618
self._control_files.unlock()
624
def lock_tree_write(self):
625
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
626
self.branch.lock_read()
627
self._lock_self_write()
629
def lock_write(self):
630
"""See MutableTree.lock_write, and WorkingTree.unlock."""
631
self.branch.lock_write()
632
self._lock_self_write()
634
@needs_tree_write_lock
635
def move(self, from_paths, to_dir, after=False):
636
"""See WorkingTree.move()."""
640
state = self.current_dirstate()
641
if isinstance(from_paths, basestring):
643
to_dir_utf8 = to_dir.encode('utf8')
644
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
645
id_index = state._get_id_index()
646
# check destination directory
647
# get the details for it
648
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
649
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
650
if not entry_present:
651
raise errors.BzrMoveFailedError('', to_dir,
652
errors.NotVersionedError(to_dir))
653
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
654
# get a handle on the block itself.
655
to_block_index = state._ensure_block(
656
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
657
to_block = state._dirblocks[to_block_index]
658
to_abs = self.abspath(to_dir)
659
if not isdir(to_abs):
660
raise errors.BzrMoveFailedError('',to_dir,
661
errors.NotADirectory(to_abs))
663
if to_entry[1][0][0] != 'd':
664
raise errors.BzrMoveFailedError('',to_dir,
665
errors.NotADirectory(to_abs))
667
if self._inventory is not None:
668
update_inventory = True
670
to_dir_id = to_entry[0][2]
671
to_dir_ie = inv[to_dir_id]
673
update_inventory = False
676
def move_one(old_entry, from_path_utf8, minikind, executable,
677
fingerprint, packed_stat, size,
678
to_block, to_key, to_path_utf8):
679
state._make_absent(old_entry)
680
from_key = old_entry[0]
682
lambda:state.update_minimal(from_key,
684
executable=executable,
685
fingerprint=fingerprint,
686
packed_stat=packed_stat,
688
path_utf8=from_path_utf8))
689
state.update_minimal(to_key,
691
executable=executable,
692
fingerprint=fingerprint,
693
packed_stat=packed_stat,
695
path_utf8=to_path_utf8)
696
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
697
new_entry = to_block[1][added_entry_index]
698
rollbacks.append(lambda:state._make_absent(new_entry))
700
for from_rel in from_paths:
701
# from_rel is 'pathinroot/foo/bar'
702
from_rel_utf8 = from_rel.encode('utf8')
703
from_dirname, from_tail = osutils.split(from_rel)
704
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
705
from_entry = self._get_entry(path=from_rel)
706
if from_entry == (None, None):
707
raise errors.BzrMoveFailedError(from_rel,to_dir,
708
errors.NotVersionedError(path=str(from_rel)))
710
from_id = from_entry[0][2]
711
to_rel = pathjoin(to_dir, from_tail)
712
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
713
item_to_entry = self._get_entry(path=to_rel)
714
if item_to_entry != (None, None):
715
raise errors.BzrMoveFailedError(from_rel, to_rel,
716
"Target is already versioned.")
718
if from_rel == to_rel:
719
raise errors.BzrMoveFailedError(from_rel, to_rel,
720
"Source and target are identical.")
722
from_missing = not self.has_filename(from_rel)
723
to_missing = not self.has_filename(to_rel)
730
raise errors.BzrMoveFailedError(from_rel, to_rel,
731
errors.NoSuchFile(path=to_rel,
732
extra="New file has not been created yet"))
734
# neither path exists
735
raise errors.BzrRenameFailedError(from_rel, to_rel,
736
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
738
if from_missing: # implicitly just update our path mapping
741
raise errors.RenameFailedFilesExist(from_rel, to_rel)
744
def rollback_rename():
745
"""A single rename has failed, roll it back."""
746
# roll back everything, even if we encounter trouble doing one
749
# TODO: at least log the other exceptions rather than just
750
# losing them mbp 20070307
752
for rollback in reversed(rollbacks):
756
exc_info = sys.exc_info()
758
raise exc_info[0], exc_info[1], exc_info[2]
760
# perform the disk move first - its the most likely failure point.
762
from_rel_abs = self.abspath(from_rel)
763
to_rel_abs = self.abspath(to_rel)
765
osutils.rename(from_rel_abs, to_rel_abs)
767
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
768
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
770
# perform the rename in the inventory next if needed: its easy
774
from_entry = inv[from_id]
775
current_parent = from_entry.parent_id
776
inv.rename(from_id, to_dir_id, from_tail)
778
lambda: inv.rename(from_id, current_parent, from_tail))
779
# finally do the rename in the dirstate, which is a little
780
# tricky to rollback, but least likely to need it.
781
old_block_index, old_entry_index, dir_present, file_present = \
782
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
783
old_block = state._dirblocks[old_block_index][1]
784
old_entry = old_block[old_entry_index]
785
from_key, old_entry_details = old_entry
786
cur_details = old_entry_details[0]
788
to_key = ((to_block[0],) + from_key[1:3])
789
minikind = cur_details[0]
790
move_one(old_entry, from_path_utf8=from_rel_utf8,
792
executable=cur_details[3],
793
fingerprint=cur_details[1],
794
packed_stat=cur_details[4],
798
to_path_utf8=to_rel_utf8)
801
def update_dirblock(from_dir, to_key, to_dir_utf8):
802
"""Recursively update all entries in this dirblock."""
804
raise AssertionError("renaming root not supported")
805
from_key = (from_dir, '')
806
from_block_idx, present = \
807
state._find_block_index_from_key(from_key)
809
# This is the old record, if it isn't present, then
810
# there is theoretically nothing to update.
811
# (Unless it isn't present because of lazy loading,
812
# but we don't do that yet)
814
from_block = state._dirblocks[from_block_idx]
815
to_block_index, to_entry_index, _, _ = \
816
state._get_block_entry_index(to_key[0], to_key[1], 0)
817
to_block_index = state._ensure_block(
818
to_block_index, to_entry_index, to_dir_utf8)
819
to_block = state._dirblocks[to_block_index]
821
# Grab a copy since move_one may update the list.
822
for entry in from_block[1][:]:
823
if not (entry[0][0] == from_dir):
824
raise AssertionError()
825
cur_details = entry[1][0]
826
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
827
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
828
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
829
minikind = cur_details[0]
831
# Deleted children of a renamed directory
832
# Do not need to be updated.
833
# Children that have been renamed out of this
834
# directory should also not be updated
836
move_one(entry, from_path_utf8=from_path_utf8,
838
executable=cur_details[3],
839
fingerprint=cur_details[1],
840
packed_stat=cur_details[4],
844
to_path_utf8=to_path_utf8)
846
# We need to move all the children of this
848
update_dirblock(from_path_utf8, to_key,
850
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
854
result.append((from_rel, to_rel))
855
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
856
self._make_dirty(reset_inventory=False)
860
def _must_be_locked(self):
861
if not self._control_files._lock_count:
862
raise errors.ObjectNotLocked(self)
865
"""Initialize the state in this tree to be a new tree."""
869
def path2id(self, path):
870
"""Return the id for path in this tree."""
871
path = path.strip('/')
872
entry = self._get_entry(path=path)
873
if entry == (None, None):
877
def paths2ids(self, paths, trees=[], require_versioned=True):
878
"""See Tree.paths2ids().
880
This specialisation fast-paths the case where all the trees are in the
885
parents = self.get_parent_ids()
887
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
889
return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
890
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
891
# -- make all paths utf8 --
894
paths_utf8.add(path.encode('utf8'))
896
# -- paths is now a utf8 path set --
897
# -- get the state object and prepare it.
898
state = self.current_dirstate()
899
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
900
and '' not in paths):
901
paths2ids = self._paths2ids_using_bisect
903
paths2ids = self._paths2ids_in_memory
904
return paths2ids(paths, search_indexes,
905
require_versioned=require_versioned)
907
def _paths2ids_in_memory(self, paths, search_indexes,
908
require_versioned=True):
909
state = self.current_dirstate()
910
state._read_dirblocks_if_needed()
911
def _entries_for_path(path):
912
"""Return a list with all the entries that match path for all ids.
914
dirname, basename = os.path.split(path)
915
key = (dirname, basename, '')
916
block_index, present = state._find_block_index_from_key(key)
918
# the block which should contain path is absent.
921
block = state._dirblocks[block_index][1]
922
entry_index, _ = state._find_entry_index(key, block)
923
# we may need to look at multiple entries at this path: walk while the paths match.
924
while (entry_index < len(block) and
925
block[entry_index][0][0:2] == key[0:2]):
926
result.append(block[entry_index])
929
if require_versioned:
930
# -- check all supplied paths are versioned in a search tree. --
933
path_entries = _entries_for_path(path)
935
# this specified path is not present at all: error
936
all_versioned = False
938
found_versioned = False
939
# for each id at this path
940
for entry in path_entries:
942
for index in search_indexes:
943
if entry[1][index][0] != 'a': # absent
944
found_versioned = True
945
# all good: found a versioned cell
947
if not found_versioned:
948
# none of the indexes was not 'absent' at all ids for this
950
all_versioned = False
952
if not all_versioned:
953
raise errors.PathsNotVersionedError(paths)
954
# -- remove redundancy in supplied paths to prevent over-scanning --
955
search_paths = osutils.minimum_path_selection(paths)
957
# for all search_indexs in each path at or under each element of
958
# search_paths, if the detail is relocated: add the id, and add the
959
# relocated path as one to search if its not searched already. If the
960
# detail is not relocated, add the id.
961
searched_paths = set()
963
def _process_entry(entry):
964
"""Look at search_indexes within entry.
966
If a specific tree's details are relocated, add the relocation
967
target to search_paths if not searched already. If it is absent, do
968
nothing. Otherwise add the id to found_ids.
970
for index in search_indexes:
971
if entry[1][index][0] == 'r': # relocated
972
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
973
search_paths.add(entry[1][index][1])
974
elif entry[1][index][0] != 'a': # absent
975
found_ids.add(entry[0][2])
977
current_root = search_paths.pop()
978
searched_paths.add(current_root)
979
# process the entries for this containing directory: the rest will be
980
# found by their parents recursively.
981
root_entries = _entries_for_path(current_root)
983
# this specified path is not present at all, skip it.
985
for entry in root_entries:
986
_process_entry(entry)
987
initial_key = (current_root, '', '')
988
block_index, _ = state._find_block_index_from_key(initial_key)
989
while (block_index < len(state._dirblocks) and
990
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
991
for entry in state._dirblocks[block_index][1]:
992
_process_entry(entry)
996
def _paths2ids_using_bisect(self, paths, search_indexes,
997
require_versioned=True):
998
state = self.current_dirstate()
1001
split_paths = sorted(osutils.split(p) for p in paths)
1002
found = state._bisect_recursive(split_paths)
1004
if require_versioned:
1005
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1006
for dir_name in split_paths:
1007
if dir_name not in found_dir_names:
1008
raise errors.PathsNotVersionedError(paths)
1010
for dir_name_id, trees_info in found.iteritems():
1011
for index in search_indexes:
1012
if trees_info[index][0] not in ('r', 'a'):
1013
found_ids.add(dir_name_id[2])
1016
def read_working_inventory(self):
1017
"""Read the working inventory.
1019
This is a meaningless operation for dirstate, but we obey it anyhow.
1021
return self.inventory
1024
def revision_tree(self, revision_id):
1025
"""See Tree.revision_tree.
1027
WorkingTree4 supplies revision_trees for any basis tree.
1029
dirstate = self.current_dirstate()
1030
parent_ids = dirstate.get_parent_ids()
1031
if revision_id not in parent_ids:
1032
raise errors.NoSuchRevisionInTree(self, revision_id)
1033
if revision_id in dirstate.get_ghosts():
1034
raise errors.NoSuchRevisionInTree(self, revision_id)
1035
return DirStateRevisionTree(dirstate, revision_id,
1036
self.branch.repository)
1038
@needs_tree_write_lock
1039
def set_last_revision(self, new_revision):
1040
"""Change the last revision in the working tree."""
1041
parents = self.get_parent_ids()
1042
if new_revision in (NULL_REVISION, None):
1043
if len(parents) >= 2:
1044
raise AssertionError(
1045
"setting the last parent to none with a pending merge is "
1047
self.set_parent_ids([])
1049
self.set_parent_ids([new_revision] + parents[1:],
1050
allow_leftmost_as_ghost=True)
1052
@needs_tree_write_lock
1053
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1054
"""Set the parent ids to revision_ids.
1056
See also set_parent_trees. This api will try to retrieve the tree data
1057
for each element of revision_ids from the trees repository. If you have
1058
tree data already available, it is more efficient to use
1059
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1060
an easier API to use.
1062
:param revision_ids: The revision_ids to set as the parent ids of this
1063
working tree. Any of these may be ghosts.
1066
for revision_id in revision_ids:
1068
revtree = self.branch.repository.revision_tree(revision_id)
1069
# TODO: jam 20070213 KnitVersionedFile raises
1070
# RevisionNotPresent rather than NoSuchRevision if a
1071
# given revision_id is not present. Should Repository be
1072
# catching it and re-raising NoSuchRevision?
1073
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1075
trees.append((revision_id, revtree))
1076
self.set_parent_trees(trees,
1077
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1079
@needs_tree_write_lock
1080
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1081
"""Set the parents of the working tree.
1083
:param parents_list: A list of (revision_id, tree) tuples.
1084
If tree is None, then that element is treated as an unreachable
1085
parent tree - i.e. a ghost.
1087
dirstate = self.current_dirstate()
1088
if len(parents_list) > 0:
1089
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1090
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1094
parent_ids = [rev_id for rev_id, tree in parents_list]
1095
graph = self.branch.repository.get_graph()
1096
heads = graph.heads(parent_ids)
1097
accepted_revisions = set()
1099
# convert absent trees to the null tree, which we convert back to
1100
# missing on access.
1101
for rev_id, tree in parents_list:
1102
if len(accepted_revisions) > 0:
1103
# we always accept the first tree
1104
if rev_id in accepted_revisions or rev_id not in heads:
1105
# We have already included either this tree, or its
1106
# descendent, so we skip it.
1108
_mod_revision.check_not_reserved_id(rev_id)
1109
if tree is not None:
1110
real_trees.append((rev_id, tree))
1112
real_trees.append((rev_id,
1113
self.branch.repository.revision_tree(
1114
_mod_revision.NULL_REVISION)))
1115
ghosts.append(rev_id)
1116
accepted_revisions.add(rev_id)
1117
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1118
self._make_dirty(reset_inventory=False)
1120
def _set_root_id(self, file_id):
1121
"""See WorkingTree.set_root_id."""
1122
state = self.current_dirstate()
1123
state.set_path_id('', file_id)
1124
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1125
self._make_dirty(reset_inventory=True)
1127
def _sha_from_stat(self, path, stat_result):
1128
"""Get a sha digest from the tree's stat cache.
1130
The default implementation assumes no stat cache is present.
1132
:param path: The path.
1133
:param stat_result: The stat result being looked up.
1135
return self.current_dirstate().sha1_from_stat(path, stat_result)
1138
def supports_tree_reference(self):
1139
return self._repo_supports_tree_reference
1142
"""Unlock in format 4 trees needs to write the entire dirstate."""
1143
# do non-implementation specific cleanup
1146
if self._control_files._lock_count == 1:
1147
# eventually we should do signature checking during read locks for
1149
if self._control_files._lock_mode == 'w':
1152
if self._dirstate is not None:
1153
# This is a no-op if there are no modifications.
1154
self._dirstate.save()
1155
self._dirstate.unlock()
1156
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1157
# point. Instead, it could check if the header has been
1158
# modified when it is locked, and if not, it can hang on to
1159
# the data it has in memory.
1160
self._dirstate = None
1161
self._inventory = None
1162
# reverse order of locking.
1164
return self._control_files.unlock()
1166
self.branch.unlock()
1168
@needs_tree_write_lock
1169
def unversion(self, file_ids):
1170
"""Remove the file ids in file_ids from the current versioned set.
1172
When a file_id is unversioned, all of its children are automatically
1175
:param file_ids: The file ids to stop versioning.
1176
:raises: NoSuchId if any fileid is not currently versioned.
1180
state = self.current_dirstate()
1181
state._read_dirblocks_if_needed()
1182
ids_to_unversion = set(file_ids)
1183
paths_to_unversion = set()
1185
# check if the root is to be unversioned, if so, assert for now.
1186
# walk the state marking unversioned things as absent.
1187
# if there are any un-unversioned ids at the end, raise
1188
for key, details in state._dirblocks[0][1]:
1189
if (details[0][0] not in ('a', 'r') and # absent or relocated
1190
key[2] in ids_to_unversion):
1191
# I haven't written the code to unversion / yet - it should be
1193
raise errors.BzrError('Unversioning the / is not currently supported')
1195
while block_index < len(state._dirblocks):
1196
# process one directory at a time.
1197
block = state._dirblocks[block_index]
1198
# first check: is the path one to remove - it or its children
1199
delete_block = False
1200
for path in paths_to_unversion:
1201
if (block[0].startswith(path) and
1202
(len(block[0]) == len(path) or
1203
block[0][len(path)] == '/')):
1204
# this entire block should be deleted - its the block for a
1205
# path to unversion; or the child of one
1208
# TODO: trim paths_to_unversion as we pass by paths
1210
# this block is to be deleted: process it.
1211
# TODO: we can special case the no-parents case and
1212
# just forget the whole block.
1214
while entry_index < len(block[1]):
1215
# Mark this file id as having been removed
1216
entry = block[1][entry_index]
1217
ids_to_unversion.discard(entry[0][2])
1218
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1220
or not state._make_absent(entry)):
1222
# go to the next block. (At the moment we dont delete empty
1227
while entry_index < len(block[1]):
1228
entry = block[1][entry_index]
1229
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1230
# ^ some parent row.
1231
entry[0][2] not in ids_to_unversion):
1232
# ^ not an id to unversion
1235
if entry[1][0][0] == 'd':
1236
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1237
if not state._make_absent(entry):
1239
# we have unversioned this id
1240
ids_to_unversion.remove(entry[0][2])
1242
if ids_to_unversion:
1243
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1244
self._make_dirty(reset_inventory=False)
1245
# have to change the legacy inventory too.
1246
if self._inventory is not None:
1247
for file_id in file_ids:
1248
self._inventory.remove_recursive_id(file_id)
1250
@needs_tree_write_lock
1251
def rename_one(self, from_rel, to_rel, after=False):
1252
"""See WorkingTree.rename_one"""
1254
WorkingTree.rename_one(self, from_rel, to_rel, after)
1256
@needs_tree_write_lock
1257
def apply_inventory_delta(self, changes):
1258
"""See MutableTree.apply_inventory_delta"""
1259
state = self.current_dirstate()
1260
state.update_by_delta(changes)
1261
self._make_dirty(reset_inventory=True)
1263
def update_basis_by_delta(self, new_revid, delta):
1264
"""See MutableTree.update_basis_by_delta."""
1265
if self.last_revision() == new_revid:
1266
raise AssertionError()
1267
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1270
def _validate(self):
1271
self._dirstate._validate()
1273
@needs_tree_write_lock
1274
def _write_inventory(self, inv):
1275
"""Write inventory as the current inventory."""
1277
raise AssertionError("attempting to write an inventory when the "
1278
"dirstate is dirty will lose pending changes")
1279
self.current_dirstate().set_state_from_inventory(inv)
1280
self._make_dirty(reset_inventory=False)
1281
if self._inventory is not None:
1282
self._inventory = inv
1286
class WorkingTreeFormat4(WorkingTreeFormat3):
1287
"""The first consolidated dirstate working tree format.
1290
- exists within a metadir controlling .bzr
1291
- includes an explicit version marker for the workingtree control
1292
files, separate from the BzrDir format
1293
- modifies the hash cache format
1294
- is new in bzr 0.15
1295
- uses a LockDir to guard access to it.
1298
upgrade_recommended = False
1300
_tree_class = WorkingTree4
1302
def get_format_string(self):
1303
"""See WorkingTreeFormat.get_format_string()."""
1304
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1306
def get_format_description(self):
1307
"""See WorkingTreeFormat.get_format_description()."""
1308
return "Working tree format 4"
1310
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1311
accelerator_tree=None, hardlink=False):
1312
"""See WorkingTreeFormat.initialize().
1314
:param revision_id: allows creating a working tree at a different
1315
revision than the branch is at.
1316
:param accelerator_tree: A tree which can be used for retrieving file
1317
contents more quickly than the revision tree, i.e. a workingtree.
1318
The revision tree will be used for cases where accelerator_tree's
1319
content is different.
1320
:param hardlink: If true, hard-link files from accelerator_tree,
1323
These trees get an initial random root id, if their repository supports
1324
rich root data, TREE_ROOT otherwise.
1326
if not isinstance(a_bzrdir.transport, LocalTransport):
1327
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1328
transport = a_bzrdir.get_workingtree_transport(self)
1329
control_files = self._open_control_files(a_bzrdir)
1330
control_files.create_lock()
1331
control_files.lock_write()
1332
transport.put_bytes('format', self.get_format_string(),
1333
mode=a_bzrdir._get_file_mode())
1334
if from_branch is not None:
1335
branch = from_branch
1337
branch = a_bzrdir.open_branch()
1338
if revision_id is None:
1339
revision_id = branch.last_revision()
1340
local_path = transport.local_abspath('dirstate')
1341
# write out new dirstate (must exist when we create the tree)
1342
state = dirstate.DirState.initialize(local_path)
1345
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1349
_control_files=control_files)
1351
wt.lock_tree_write()
1353
self._init_custom_control_files(wt)
1354
if revision_id in (None, NULL_REVISION):
1355
if branch.repository.supports_rich_root():
1356
wt._set_root_id(generate_ids.gen_root_id())
1358
wt._set_root_id(ROOT_ID)
1361
# frequently, we will get here due to branching. The accelerator
1362
# tree will be the tree from the branch, so the desired basis
1363
# tree will often be a parent of the accelerator tree.
1364
if accelerator_tree is not None:
1366
basis = accelerator_tree.revision_tree(revision_id)
1367
except errors.NoSuchRevision:
1370
basis = branch.repository.revision_tree(revision_id)
1371
if revision_id == NULL_REVISION:
1374
parents_list = [(revision_id, basis)]
1377
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1379
# if the basis has a root id we have to use that; otherwise we
1380
# use a new random one
1381
basis_root_id = basis.get_root_id()
1382
if basis_root_id is not None:
1383
wt._set_root_id(basis_root_id)
1385
# delta_from_tree is safe even for DirStateRevisionTrees,
1386
# because wt4.apply_inventory_delta does not mutate the input
1387
# inventory entries.
1388
transform.build_tree(basis, wt, accelerator_tree,
1389
hardlink=hardlink, delta_from_tree=True)
1393
control_files.unlock()
1397
def _init_custom_control_files(self, wt):
1398
"""Subclasses with custom control files should override this method.
1400
The working tree and control files are locked for writing when this
1403
:param wt: the WorkingTree object
1406
def _open(self, a_bzrdir, control_files):
1407
"""Open the tree itself.
1409
:param a_bzrdir: the dir for the tree.
1410
:param control_files: the control files for the tree.
1412
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1413
branch=a_bzrdir.open_branch(),
1416
_control_files=control_files)
1418
def __get_matchingbzrdir(self):
1419
# please test against something that will let us do tree references
1420
return bzrdir.format_registry.make_bzrdir(
1421
'dirstate-with-subtree')
1423
_matchingbzrdir = property(__get_matchingbzrdir)
1426
class DirStateRevisionTree(Tree):
1427
"""A revision tree pulling the inventory from a dirstate."""
1429
def __init__(self, dirstate, revision_id, repository):
1430
self._dirstate = dirstate
1431
self._revision_id = revision_id
1432
self._repository = repository
1433
self._inventory = None
1435
self._dirstate_locked = False
1436
self._repo_supports_tree_reference = getattr(
1437
repository._format, "supports_tree_reference",
1441
return "<%s of %s in %s>" % \
1442
(self.__class__.__name__, self._revision_id, self._dirstate)
1444
def annotate_iter(self, file_id,
1445
default_revision=_mod_revision.CURRENT_REVISION):
1446
"""See Tree.annotate_iter"""
1447
text_key = (file_id, self.inventory[file_id].revision)
1448
annotations = self._repository.texts.annotate(text_key)
1449
return [(key[-1], line) for (key, line) in annotations]
1451
def _get_ancestors(self, default_revision):
1452
return set(self._repository.get_ancestry(self._revision_id,
1454
def _comparison_data(self, entry, path):
1455
"""See Tree._comparison_data."""
1457
return None, False, None
1458
# trust the entry as RevisionTree does, but this may not be
1459
# sensible: the entry might not have come from us?
1460
return entry.kind, entry.executable, None
1462
def _file_size(self, entry, stat_value):
1463
return entry.text_size
1465
def filter_unversioned_files(self, paths):
1466
"""Filter out paths that are not versioned.
1468
:return: set of paths.
1470
pred = self.has_filename
1471
return set((p for p in paths if not pred(p)))
1473
def get_root_id(self):
1474
return self.path2id('')
1476
def id2path(self, file_id):
1477
"Convert a file-id to a path."
1478
entry = self._get_entry(file_id=file_id)
1479
if entry == (None, None):
1480
raise errors.NoSuchId(tree=self, file_id=file_id)
1481
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1482
return path_utf8.decode('utf8')
1484
def iter_references(self):
1485
if not self._repo_supports_tree_reference:
1486
# When the repo doesn't support references, we will have nothing to
1489
# Otherwise, fall back to the default implementation
1490
return super(DirStateRevisionTree, self).iter_references()
1492
def _get_parent_index(self):
1493
"""Return the index in the dirstate referenced by this tree."""
1494
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1496
def _get_entry(self, file_id=None, path=None):
1497
"""Get the dirstate row for file_id or path.
1499
If either file_id or path is supplied, it is used as the key to lookup.
1500
If both are supplied, the fastest lookup is used, and an error is
1501
raised if they do not both point at the same row.
1503
:param file_id: An optional unicode file_id to be looked up.
1504
:param path: An optional unicode path to be looked up.
1505
:return: The dirstate row tuple for path/file_id, or (None, None)
1507
if file_id is None and path is None:
1508
raise errors.BzrError('must supply file_id or path')
1509
if path is not None:
1510
path = path.encode('utf8')
1511
parent_index = self._get_parent_index()
1512
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1514
def _generate_inventory(self):
1515
"""Create and set self.inventory from the dirstate object.
1517
(So this is only called the first time the inventory is requested for
1518
this tree; it then remains in memory until it's out of date.)
1520
This is relatively expensive: we have to walk the entire dirstate.
1522
if not self._locked:
1523
raise AssertionError(
1524
'cannot generate inventory of an unlocked '
1525
'dirstate revision tree')
1526
# separate call for profiling - makes it clear where the costs are.
1527
self._dirstate._read_dirblocks_if_needed()
1528
if self._revision_id not in self._dirstate.get_parent_ids():
1529
raise AssertionError(
1530
'parent %s has disappeared from %s' % (
1531
self._revision_id, self._dirstate.get_parent_ids()))
1532
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1533
# This is identical now to the WorkingTree _generate_inventory except
1534
# for the tree index use.
1535
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1536
current_id = root_key[2]
1537
if current_entry[parent_index][0] != 'd':
1538
raise AssertionError()
1539
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1540
inv.root.revision = current_entry[parent_index][4]
1541
# Turn some things into local variables
1542
minikind_to_kind = dirstate.DirState._minikind_to_kind
1543
factory = entry_factory
1544
utf8_decode = cache_utf8._utf8_decode
1545
inv_byid = inv._byid
1546
# we could do this straight out of the dirstate; it might be fast
1547
# and should be profiled - RBC 20070216
1548
parent_ies = {'' : inv.root}
1549
for block in self._dirstate._dirblocks[1:]: #skip root
1552
parent_ie = parent_ies[dirname]
1554
# all the paths in this block are not versioned in this tree
1556
for key, entry in block[1]:
1557
minikind, fingerprint, size, executable, revid = entry[parent_index]
1558
if minikind in ('a', 'r'): # absent, relocated
1562
name_unicode = utf8_decode(name)[0]
1564
kind = minikind_to_kind[minikind]
1565
inv_entry = factory[kind](file_id, name_unicode,
1567
inv_entry.revision = revid
1569
inv_entry.executable = executable
1570
inv_entry.text_size = size
1571
inv_entry.text_sha1 = fingerprint
1572
elif kind == 'directory':
1573
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1574
elif kind == 'symlink':
1575
inv_entry.executable = False
1576
inv_entry.text_size = None
1577
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1578
elif kind == 'tree-reference':
1579
inv_entry.reference_revision = fingerprint or None
1581
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1583
# These checks cost us around 40ms on a 55k entry tree
1584
if file_id in inv_byid:
1585
raise AssertionError('file_id %s already in'
1586
' inventory as %s' % (file_id, inv_byid[file_id]))
1587
if name_unicode in parent_ie.children:
1588
raise AssertionError('name %r already in parent'
1590
inv_byid[file_id] = inv_entry
1591
parent_ie.children[name_unicode] = inv_entry
1592
self._inventory = inv
1594
def get_file_mtime(self, file_id, path=None):
1595
"""Return the modification time for this record.
1597
We return the timestamp of the last-changed revision.
1599
# Make sure the file exists
1600
entry = self._get_entry(file_id, path=path)
1601
if entry == (None, None): # do we raise?
1603
parent_index = self._get_parent_index()
1604
last_changed_revision = entry[1][parent_index][4]
1605
return self._repository.get_revision(last_changed_revision).timestamp
1607
def get_file_sha1(self, file_id, path=None, stat_value=None):
1608
entry = self._get_entry(file_id=file_id, path=path)
1609
parent_index = self._get_parent_index()
1610
parent_details = entry[1][parent_index]
1611
if parent_details[0] == 'f':
1612
return parent_details[1]
1615
def get_file(self, file_id, path=None):
1616
return StringIO(self.get_file_text(file_id))
1618
def get_file_lines(self, file_id):
1619
return osutils.split_lines(self.get_file_text(file_id))
1621
def get_file_size(self, file_id):
1622
"""See Tree.get_file_size"""
1623
return self.inventory[file_id].text_size
1625
def get_file_text(self, file_id):
1626
return list(self.iter_files_bytes([(file_id, None)]))[0][1]
1628
def get_reference_revision(self, file_id, path=None):
1629
return self.inventory[file_id].reference_revision
1631
def iter_files_bytes(self, desired_files):
1632
"""See Tree.iter_files_bytes.
1634
This version is implemented on top of Repository.iter_files_bytes"""
1635
parent_index = self._get_parent_index()
1636
repo_desired_files = []
1637
for file_id, identifier in desired_files:
1638
entry = self._get_entry(file_id)
1639
if entry == (None, None):
1640
raise errors.NoSuchId(self, file_id)
1641
repo_desired_files.append((file_id, entry[1][parent_index][4],
1643
return self._repository.iter_files_bytes(repo_desired_files)
1645
def get_symlink_target(self, file_id):
1646
entry = self._get_entry(file_id=file_id)
1647
parent_index = self._get_parent_index()
1648
if entry[1][parent_index][0] != 'l':
1651
# At present, none of the tree implementations supports non-ascii
1652
# symlink targets. So we will just assume that the dirstate path is
1654
return entry[1][parent_index][1]
1656
def get_revision_id(self):
1657
"""Return the revision id for this tree."""
1658
return self._revision_id
1660
def _get_inventory(self):
1661
if self._inventory is not None:
1662
return self._inventory
1663
self._must_be_locked()
1664
self._generate_inventory()
1665
return self._inventory
1667
inventory = property(_get_inventory,
1668
doc="Inventory of this Tree")
1670
def get_parent_ids(self):
1671
"""The parents of a tree in the dirstate are not cached."""
1672
return self._repository.get_revision(self._revision_id).parent_ids
1674
def has_filename(self, filename):
1675
return bool(self.path2id(filename))
1677
def kind(self, file_id):
1678
entry = self._get_entry(file_id=file_id)[1]
1680
raise errors.NoSuchId(tree=self, file_id=file_id)
1681
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1683
def stored_kind(self, file_id):
1684
"""See Tree.stored_kind"""
1685
return self.kind(file_id)
1687
def path_content_summary(self, path):
1688
"""See Tree.path_content_summary."""
1689
id = self.inventory.path2id(path)
1691
return ('missing', None, None, None)
1692
entry = self._inventory[id]
1695
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1696
elif kind == 'symlink':
1697
return (kind, None, None, entry.symlink_target)
1699
return (kind, None, None, None)
1701
def is_executable(self, file_id, path=None):
1702
ie = self.inventory[file_id]
1703
if ie.kind != "file":
1705
return ie.executable
1707
def list_files(self, include_root=False):
1708
# We use a standard implementation, because DirStateRevisionTree is
1709
# dealing with one of the parents of the current state
1710
inv = self._get_inventory()
1711
entries = inv.iter_entries()
1712
if self.inventory.root is not None and not include_root:
1714
for path, entry in entries:
1715
yield path, 'V', entry.kind, entry.file_id, entry
1717
def lock_read(self):
1718
"""Lock the tree for a set of operations."""
1719
if not self._locked:
1720
self._repository.lock_read()
1721
if self._dirstate._lock_token is None:
1722
self._dirstate.lock_read()
1723
self._dirstate_locked = True
1726
def _must_be_locked(self):
1727
if not self._locked:
1728
raise errors.ObjectNotLocked(self)
1731
def path2id(self, path):
1732
"""Return the id for path in this tree."""
1733
# lookup by path: faster than splitting and walking the ivnentory.
1734
entry = self._get_entry(path=path)
1735
if entry == (None, None):
1740
"""Unlock, freeing any cache memory used during the lock."""
1741
# outside of a lock, the inventory is suspect: release it.
1743
if not self._locked:
1744
self._inventory = None
1746
if self._dirstate_locked:
1747
self._dirstate.unlock()
1748
self._dirstate_locked = False
1749
self._repository.unlock()
1752
def supports_tree_reference(self):
1753
return self._repo_supports_tree_reference
1755
def walkdirs(self, prefix=""):
1756
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1757
# implementation based on an inventory.
1758
# This should be cleaned up to use the much faster Dirstate code
1759
# So for now, we just build up the parent inventory, and extract
1760
# it the same way RevisionTree does.
1761
_directory = 'directory'
1762
inv = self._get_inventory()
1763
top_id = inv.path2id(prefix)
1767
pending = [(prefix, top_id)]
1770
relpath, file_id = pending.pop()
1771
# 0 - relpath, 1- file-id
1773
relroot = relpath + '/'
1776
# FIXME: stash the node in pending
1777
entry = inv[file_id]
1778
for name, child in entry.sorted_children():
1779
toppath = relroot + name
1780
dirblock.append((toppath, name, child.kind, None,
1781
child.file_id, child.kind
1783
yield (relpath, entry.file_id), dirblock
1784
# push the user specified dirs from dirblock
1785
for dir in reversed(dirblock):
1786
if dir[2] == _directory:
1787
pending.append((dir[0], dir[4]))
1790
class InterDirStateTree(InterTree):
1791
"""Fast path optimiser for changes_from with dirstate trees.
1793
This is used only when both trees are in the dirstate working file, and
1794
the source is any parent within the dirstate, and the destination is
1795
the current working tree of the same dirstate.
1797
# this could be generalized to allow comparisons between any trees in the
1798
# dirstate, and possibly between trees stored in different dirstates.
1800
def __init__(self, source, target):
1801
super(InterDirStateTree, self).__init__(source, target)
1802
if not InterDirStateTree.is_compatible(source, target):
1803
raise Exception, "invalid source %r and target %r" % (source, target)
1806
def make_source_parent_tree(source, target):
1807
"""Change the source tree into a parent of the target."""
1808
revid = source.commit('record tree')
1809
target.branch.repository.fetch(source.branch.repository, revid)
1810
target.set_parent_ids([revid])
1811
return target.basis_tree(), target
1813
_matching_from_tree_format = WorkingTreeFormat4()
1814
_matching_to_tree_format = WorkingTreeFormat4()
1815
_test_mutable_trees_to_test_trees = make_source_parent_tree
1817
def iter_changes(self, include_unchanged=False,
1818
specific_files=None, pb=None, extra_trees=[],
1819
require_versioned=True, want_unversioned=False):
1820
"""Return the changes from source to target.
1822
:return: An iterator that yields tuples. See InterTree.iter_changes
1824
:param specific_files: An optional list of file paths to restrict the
1825
comparison to. When mapping filenames to ids, all matches in all
1826
trees (including optional extra_trees) are used, and all children of
1827
matched directories are included.
1828
:param include_unchanged: An optional boolean requesting the inclusion of
1829
unchanged entries in the result.
1830
:param extra_trees: An optional list of additional trees to use when
1831
mapping the contents of specific_files (paths) to file_ids.
1832
:param require_versioned: If True, all files in specific_files must be
1833
versioned in one of source, target, extra_trees or
1834
PathsNotVersionedError is raised.
1835
:param want_unversioned: Should unversioned files be returned in the
1836
output. An unversioned file is defined as one with (False, False)
1837
for the versioned pair.
1839
utf8_decode = cache_utf8._utf8_decode
1840
_minikind_to_kind = dirstate.DirState._minikind_to_kind
1841
cmp_by_dirs = dirstate.cmp_by_dirs
1842
# NB: show_status depends on being able to pass in non-versioned files
1843
# and report them as unknown
1844
# TODO: handle extra trees in the dirstate.
1845
if (extra_trees or specific_files == []):
1846
# we can't fast-path these cases (yet)
1847
for f in super(InterDirStateTree, self).iter_changes(
1848
include_unchanged, specific_files, pb, extra_trees,
1849
require_versioned, want_unversioned=want_unversioned):
1852
parent_ids = self.target.get_parent_ids()
1853
if not (self.source._revision_id in parent_ids
1854
or self.source._revision_id == NULL_REVISION):
1855
raise AssertionError(
1856
"revision {%s} is not stored in {%s}, but %s "
1857
"can only be used for trees stored in the dirstate"
1858
% (self.source._revision_id, self.target, self.iter_changes))
1859
update_entry = dirstate.update_entry
1860
use_filesystem_for_exec = (sys.platform != 'win32')
1861
search_specific_files = set()
1862
process_entry = dirstate._process_entry(include_unchanged,
1863
use_filesystem_for_exec, search_specific_files)
1864
_process_entry = process_entry._process_entry
1865
uninteresting = process_entry.uninteresting
1866
searched_specific_files = process_entry.searched_specific_files
1868
if self.source._revision_id == NULL_REVISION:
1870
indices = (target_index,)
1872
if not (self.source._revision_id in parent_ids):
1873
raise AssertionError(
1874
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1875
self.source._revision_id, parent_ids))
1876
source_index = 1 + parent_ids.index(self.source._revision_id)
1877
indices = (source_index, target_index)
1878
# -- make all specific_files utf8 --
1880
specific_files_utf8 = set()
1881
for path in specific_files:
1882
specific_files_utf8.add(path.encode('utf8'))
1883
specific_files = specific_files_utf8
1885
specific_files = set([''])
1886
# -- specific_files is now a utf8 path set --
1887
# -- get the state object and prepare it.
1888
state = self.target.current_dirstate()
1889
state._read_dirblocks_if_needed()
1890
def _entries_for_path(path):
1891
"""Return a list with all the entries that match path for all ids.
1893
dirname, basename = os.path.split(path)
1894
key = (dirname, basename, '')
1895
block_index, present = state._find_block_index_from_key(key)
1897
# the block which should contain path is absent.
1900
block = state._dirblocks[block_index][1]
1901
entry_index, _ = state._find_entry_index(key, block)
1902
# we may need to look at multiple entries at this path: walk while the specific_files match.
1903
while (entry_index < len(block) and
1904
block[entry_index][0][0:2] == key[0:2]):
1905
result.append(block[entry_index])
1908
if require_versioned:
1909
# -- check all supplied paths are versioned in a search tree. --
1910
all_versioned = True
1911
for path in specific_files:
1912
path_entries = _entries_for_path(path)
1913
if not path_entries:
1914
# this specified path is not present at all: error
1915
all_versioned = False
1917
found_versioned = False
1918
# for each id at this path
1919
for entry in path_entries:
1921
for index in indices:
1922
if entry[1][index][0] != 'a': # absent
1923
found_versioned = True
1924
# all good: found a versioned cell
1926
if not found_versioned:
1927
# none of the indexes was not 'absent' at all ids for this
1929
all_versioned = False
1931
if not all_versioned:
1932
raise errors.PathsNotVersionedError(specific_files)
1933
# -- remove redundancy in supplied specific_files to prevent over-scanning --
1934
for path in specific_files:
1935
other_specific_files = specific_files.difference(set([path]))
1936
if not osutils.is_inside_any(other_specific_files, path):
1937
# this is a top level path, we must check it.
1938
search_specific_files.add(path)
1940
# compare source_index and target_index at or under each element of search_specific_files.
1941
# follow the following comparison table. Note that we only want to do diff operations when
1942
# the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
1946
# Source | Target | disk | action
1947
# r | fdlt | | add source to search, add id path move and perform
1948
# | | | diff check on source-target
1949
# r | fdlt | a | dangling file that was present in the basis.
1951
# r | a | | add source to search
1953
# r | r | | this path is present in a non-examined tree, skip.
1954
# r | r | a | this path is present in a non-examined tree, skip.
1955
# a | fdlt | | add new id
1956
# a | fdlt | a | dangling locally added file, skip
1957
# a | a | | not present in either tree, skip
1958
# a | a | a | not present in any tree, skip
1959
# a | r | | not present in either tree at this path, skip as it
1960
# | | | may not be selected by the users list of paths.
1961
# a | r | a | not present in either tree at this path, skip as it
1962
# | | | may not be selected by the users list of paths.
1963
# fdlt | fdlt | | content in both: diff them
1964
# fdlt | fdlt | a | deleted locally, but not unversioned - show as deleted ?
1965
# fdlt | a | | unversioned: output deleted id for now
1966
# fdlt | a | a | unversioned and deleted: output deleted id
1967
# fdlt | r | | relocated in this tree, so add target to search.
1968
# | | | Dont diff, we will see an r,fd; pair when we reach
1969
# | | | this id at the other path.
1970
# fdlt | r | a | relocated in this tree, so add target to search.
1971
# | | | Dont diff, we will see an r,fd; pair when we reach
1972
# | | | this id at the other path.
1974
# TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
1975
# keeping a cache of directories that we have seen.
1977
while search_specific_files:
1978
# TODO: the pending list should be lexically sorted? the
1979
# interface doesn't require it.
1980
current_root = search_specific_files.pop()
1981
current_root_unicode = current_root.decode('utf8')
1982
searched_specific_files.add(current_root)
1983
# process the entries for this containing directory: the rest will be
1984
# found by their parents recursively.
1985
root_entries = _entries_for_path(current_root)
1986
root_abspath = self.target.abspath(current_root_unicode)
1988
root_stat = os.lstat(root_abspath)
1990
if e.errno == errno.ENOENT:
1991
# the path does not exist: let _process_entry know that.
1992
root_dir_info = None
1994
# some other random error: hand it up.
1997
root_dir_info = ('', current_root,
1998
osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
2000
if root_dir_info[2] == 'directory':
2001
if self.target._directory_is_tree_reference(
2002
current_root.decode('utf8')):
2003
root_dir_info = root_dir_info[:2] + \
2004
('tree-reference',) + root_dir_info[3:]
2006
if not root_entries and not root_dir_info:
2007
# this specified path is not present at all, skip it.
2009
path_handled = False
2010
for entry in root_entries:
2011
result = _process_entry(entry, root_dir_info, source_index, target_index, state)
2012
if result is not None:
2014
if result is not uninteresting:
2016
if want_unversioned and not path_handled and root_dir_info:
2017
new_executable = bool(
2018
stat.S_ISREG(root_dir_info[3].st_mode)
2019
and stat.S_IEXEC & root_dir_info[3].st_mode)
2021
(None, current_root_unicode),
2025
(None, splitpath(current_root_unicode)[-1]),
2026
(None, root_dir_info[2]),
2027
(None, new_executable)
2029
initial_key = (current_root, '', '')
2030
block_index, _ = state._find_block_index_from_key(initial_key)
2031
if block_index == 0:
2032
# we have processed the total root already, but because the
2033
# initial key matched it we should skip it here.
2035
if root_dir_info and root_dir_info[2] == 'tree-reference':
2036
current_dir_info = None
2038
dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
2040
current_dir_info = dir_iterator.next()
2042
# on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
2043
# python 2.5 has e.errno == EINVAL,
2044
# and e.winerror == ERROR_DIRECTORY
2045
e_winerror = getattr(e, 'winerror', None)
2046
win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
2047
# there may be directories in the inventory even though
2048
# this path is not a file on disk: so mark it as end of
2050
if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
2051
current_dir_info = None
2052
elif (sys.platform == 'win32'
2053
and (e.errno in win_errors
2054
or e_winerror in win_errors)):
2055
current_dir_info = None
2059
if current_dir_info[0][0] == '':
2060
# remove .bzr from iteration
2061
bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
2062
if current_dir_info[1][bzr_index][0] != '.bzr':
2063
raise AssertionError()
2064
del current_dir_info[1][bzr_index]
2065
# walk until both the directory listing and the versioned metadata
2067
if (block_index < len(state._dirblocks) and
2068
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2069
current_block = state._dirblocks[block_index]
2071
current_block = None
2072
while (current_dir_info is not None or
2073
current_block is not None):
2074
if (current_dir_info and current_block
2075
and current_dir_info[0][0] != current_block[0]):
2076
if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
2077
# filesystem data refers to paths not covered by the dirblock.
2078
# this has two possibilities:
2079
# A) it is versioned but empty, so there is no block for it
2080
# B) it is not versioned.
2082
# if (A) then we need to recurse into it to check for
2083
# new unknown files or directories.
2084
# if (B) then we should ignore it, because we don't
2085
# recurse into unknown directories.
2087
while path_index < len(current_dir_info[1]):
2088
current_path_info = current_dir_info[1][path_index]
2089
if want_unversioned:
2090
if current_path_info[2] == 'directory':
2091
if self.target._directory_is_tree_reference(
2092
current_path_info[0].decode('utf8')):
2093
current_path_info = current_path_info[:2] + \
2094
('tree-reference',) + current_path_info[3:]
2095
new_executable = bool(
2096
stat.S_ISREG(current_path_info[3].st_mode)
2097
and stat.S_IEXEC & current_path_info[3].st_mode)
2099
(None, utf8_decode(current_path_info[0])[0]),
2103
(None, utf8_decode(current_path_info[1])[0]),
2104
(None, current_path_info[2]),
2105
(None, new_executable))
2106
# dont descend into this unversioned path if it is
2108
if current_path_info[2] in ('directory',
2110
del current_dir_info[1][path_index]
2114
# This dir info has been handled, go to the next
2116
current_dir_info = dir_iterator.next()
2117
except StopIteration:
2118
current_dir_info = None
2120
# We have a dirblock entry for this location, but there
2121
# is no filesystem path for this. This is most likely
2122
# because a directory was removed from the disk.
2123
# We don't have to report the missing directory,
2124
# because that should have already been handled, but we
2125
# need to handle all of the files that are contained
2127
for current_entry in current_block[1]:
2128
# entry referring to file not present on disk.
2129
# advance the entry only, after processing.
2130
result = _process_entry(current_entry, None, source_index, target_index, state)
2131
if result is not None:
2132
if result is not uninteresting:
2135
if (block_index < len(state._dirblocks) and
2136
osutils.is_inside(current_root,
2137
state._dirblocks[block_index][0])):
2138
current_block = state._dirblocks[block_index]
2140
current_block = None
2143
if current_block and entry_index < len(current_block[1]):
2144
current_entry = current_block[1][entry_index]
2146
current_entry = None
2147
advance_entry = True
2149
if current_dir_info and path_index < len(current_dir_info[1]):
2150
current_path_info = current_dir_info[1][path_index]
2151
if current_path_info[2] == 'directory':
2152
if self.target._directory_is_tree_reference(
2153
current_path_info[0].decode('utf8')):
2154
current_path_info = current_path_info[:2] + \
2155
('tree-reference',) + current_path_info[3:]
2157
current_path_info = None
2159
path_handled = False
2160
while (current_entry is not None or
2161
current_path_info is not None):
2162
if current_entry is None:
2163
# the check for path_handled when the path is adnvaced
2164
# will yield this path if needed.
2166
elif current_path_info is None:
2167
# no path is fine: the per entry code will handle it.
2168
result = _process_entry(current_entry, current_path_info, source_index, target_index, state)
2169
if result is not None:
2170
if result is not uninteresting:
2172
elif (current_entry[0][1] != current_path_info[1]
2173
or current_entry[1][target_index][0] in 'ar'):
2174
# The current path on disk doesn't match the dirblock
2175
# record. Either the dirblock is marked as absent, or
2176
# the file on disk is not present at all in the
2177
# dirblock. Either way, report about the dirblock
2178
# entry, and let other code handle the filesystem one.
2180
# Compare the basename for these files to determine
2182
if current_path_info[1] < current_entry[0][1]:
2183
# extra file on disk: pass for now, but only
2184
# increment the path, not the entry
2185
advance_entry = False
2187
# entry referring to file not present on disk.
2188
# advance the entry only, after processing.
2189
result = _process_entry(current_entry, None, source_index, target_index, state)
2190
if result is not None:
2191
if result is not uninteresting:
2193
advance_path = False
2195
result = _process_entry(current_entry, current_path_info, source_index, target_index, state)
2196
if result is not None:
2198
if result is not uninteresting:
2200
if advance_entry and current_entry is not None:
2202
if entry_index < len(current_block[1]):
2203
current_entry = current_block[1][entry_index]
2205
current_entry = None
2207
advance_entry = True # reset the advance flaga
2208
if advance_path and current_path_info is not None:
2209
if not path_handled:
2210
# unversioned in all regards
2211
if want_unversioned:
2212
new_executable = bool(
2213
stat.S_ISREG(current_path_info[3].st_mode)
2214
and stat.S_IEXEC & current_path_info[3].st_mode)
2216
relpath_unicode = utf8_decode(current_path_info[0])[0]
2217
except UnicodeDecodeError:
2218
raise errors.BadFilenameEncoding(
2219
current_path_info[0], osutils._fs_enc)
2221
(None, relpath_unicode),
2225
(None, utf8_decode(current_path_info[1])[0]),
2226
(None, current_path_info[2]),
2227
(None, new_executable))
2228
# dont descend into this unversioned path if it is
2230
if current_path_info[2] in ('directory'):
2231
del current_dir_info[1][path_index]
2233
# dont descend the disk iterator into any tree
2235
if current_path_info[2] == 'tree-reference':
2236
del current_dir_info[1][path_index]
2239
if path_index < len(current_dir_info[1]):
2240
current_path_info = current_dir_info[1][path_index]
2241
if current_path_info[2] == 'directory':
2242
if self.target._directory_is_tree_reference(
2243
current_path_info[0].decode('utf8')):
2244
current_path_info = current_path_info[:2] + \
2245
('tree-reference',) + current_path_info[3:]
2247
current_path_info = None
2248
path_handled = False
2250
advance_path = True # reset the advance flagg.
2251
if current_block is not None:
2253
if (block_index < len(state._dirblocks) and
2254
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2255
current_block = state._dirblocks[block_index]
2257
current_block = None
2258
if current_dir_info is not None:
2260
current_dir_info = dir_iterator.next()
2261
except StopIteration:
2262
current_dir_info = None
2265
def is_compatible(source, target):
2266
# the target must be a dirstate working tree
2267
if not isinstance(target, WorkingTree4):
2269
# the source must be a revtreee or dirstate rev tree.
2270
if not isinstance(source,
2271
(revisiontree.RevisionTree, DirStateRevisionTree)):
2273
# the source revid must be in the target dirstate
2274
if not (source._revision_id == NULL_REVISION or
2275
source._revision_id in target.get_parent_ids()):
2276
# TODO: what about ghosts? it may well need to
2277
# check for them explicitly.
2281
InterTree.register_optimiser(InterDirStateTree)
2284
class Converter3to4(object):
2285
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2288
self.target_format = WorkingTreeFormat4()
2290
def convert(self, tree):
2291
# lock the control files not the tree, so that we dont get tree
2292
# on-unlock behaviours, and so that noone else diddles with the
2293
# tree during upgrade.
2294
tree._control_files.lock_write()
2296
tree.read_working_inventory()
2297
self.create_dirstate_data(tree)
2298
self.update_format(tree)
2299
self.remove_xml_files(tree)
2301
tree._control_files.unlock()
2303
def create_dirstate_data(self, tree):
2304
"""Create the dirstate based data for tree."""
2305
local_path = tree.bzrdir.get_workingtree_transport(None
2306
).local_abspath('dirstate')
2307
state = dirstate.DirState.from_tree(tree, local_path)
2311
def remove_xml_files(self, tree):
2312
"""Remove the oldformat 3 data."""
2313
transport = tree.bzrdir.get_workingtree_transport(None)
2314
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2315
'pending-merges', 'stat-cache']:
2317
transport.delete(path)
2318
except errors.NoSuchFile:
2319
# some files are optional - just deal.
2322
def update_format(self, tree):
2323
"""Change the format marker."""
2324
tree._transport.put_bytes('format',
2325
self.target_format.get_format_string(),
2326
mode=tree.bzrdir._get_file_mode())