1
# Copyright (C) 2005, 2006, 2007 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
assert isinstance(basedir, basestring), \
135
"base directory %r is not a string" % basedir
136
basedir = safe_unicode(basedir)
137
mutter("opening working tree %r", basedir)
138
self._branch = branch
139
assert isinstance(self.branch, bzrlib.branch.Branch), \
140
"branch %r is not a Branch" % self.branch
141
self.basedir = realpath(basedir)
142
# if branch is at our basedir and is a format 6 or less
143
# assume all other formats have their own control files.
144
assert isinstance(_control_files, LockableFiles), \
145
"_control_files must be a LockableFiles, not %r" % _control_files
146
self._control_files = _control_files
149
# during a read or write lock these objects are set, and are
150
# None the rest of the time.
151
self._dirstate = None
152
self._inventory = None
155
@needs_tree_write_lock
156
def _add(self, files, ids, kinds):
157
"""See MutableTree._add."""
158
state = self.current_dirstate()
159
for f, file_id, kind in zip(files, ids, kinds):
162
# special case tree root handling.
163
if f == '' and self.path2id(f) == ROOT_ID:
164
state.set_path_id('', generate_ids.gen_file_id(f))
167
file_id = generate_ids.gen_file_id(f)
168
# deliberately add the file with no cached stat or sha1
169
# - on the first access it will be gathered, and we can
170
# always change this once tests are all passing.
171
state.add(f, file_id, kind, None, '')
172
self._make_dirty(reset_inventory=True)
174
def _make_dirty(self, reset_inventory):
175
"""Make the tree state dirty.
177
:param reset_inventory: True if the cached inventory should be removed
178
(presuming there is one).
181
if reset_inventory and self._inventory is not None:
182
self._inventory = None
184
@needs_tree_write_lock
185
def add_reference(self, sub_tree):
186
# use standard implementation, which calls back to self._add
188
# So we don't store the reference_revision in the working dirstate,
189
# it's just recorded at the moment of commit.
190
self._add_reference(sub_tree)
192
def break_lock(self):
193
"""Break a lock if one is present from another instance.
195
Uses the ui factory to ask for confirmation if the lock may be from
198
This will probe the repository for its lock as well.
200
# if the dirstate is locked by an active process, reject the break lock
203
if self._dirstate is None:
207
state = self._current_dirstate()
208
if state._lock_token is not None:
209
# we already have it locked. sheese, cant break our own lock.
210
raise errors.LockActive(self.basedir)
213
# try for a write lock - need permission to get one anyhow
216
except errors.LockContention:
217
# oslocks fail when a process is still live: fail.
218
# TODO: get the locked lockdir info and give to the user to
219
# assist in debugging.
220
raise errors.LockActive(self.basedir)
225
self._dirstate = None
226
self._control_files.break_lock()
227
self.branch.break_lock()
229
def _comparison_data(self, entry, path):
230
kind, executable, stat_value = \
231
WorkingTree3._comparison_data(self, entry, path)
232
# it looks like a plain directory, but it's really a reference -- see
234
if (self._repo_supports_tree_reference and
235
kind == 'directory' and
236
self._directory_is_tree_reference(path)):
237
kind = 'tree-reference'
238
return kind, executable, stat_value
241
def commit(self, message=None, revprops=None, *args, **kwargs):
242
# mark the tree as dirty post commit - commit
243
# can change the current versioned list by doing deletes.
244
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
245
self._make_dirty(reset_inventory=True)
248
def current_dirstate(self):
249
"""Return the current dirstate object.
251
This is not part of the tree interface and only exposed for ease of
254
:raises errors.NotWriteLocked: when not in a lock.
256
self._must_be_locked()
257
return self._current_dirstate()
259
def _current_dirstate(self):
260
"""Internal function that does not check lock status.
262
This is needed for break_lock which also needs the dirstate.
264
if self._dirstate is not None:
265
return self._dirstate
266
local_path = self.bzrdir.get_workingtree_transport(None
267
).local_abspath('dirstate')
268
self._dirstate = dirstate.DirState.on_file(local_path)
269
return self._dirstate
271
def filter_unversioned_files(self, paths):
272
"""Filter out paths that are versioned.
274
:return: set of paths.
276
# TODO: make a generic multi-bisect routine roughly that should list
277
# the paths, then process one half at a time recursively, and feed the
278
# results of each bisect in further still
279
paths = sorted(paths)
281
state = self.current_dirstate()
282
# TODO we want a paths_to_dirblocks helper I think
284
dirname, basename = os.path.split(path.encode('utf8'))
285
_, _, _, path_is_versioned = state._get_block_entry_index(
286
dirname, basename, 0)
287
if not path_is_versioned:
292
"""Write all cached data to disk."""
293
if self._control_files._lock_mode != 'w':
294
raise errors.NotWriteLocked(self)
295
self.current_dirstate().save()
296
self._inventory = None
299
@needs_tree_write_lock
300
def _gather_kinds(self, files, kinds):
301
"""See MutableTree._gather_kinds."""
302
for pos, f in enumerate(files):
303
if kinds[pos] is None:
304
kinds[pos] = self._kind(f)
306
def _generate_inventory(self):
307
"""Create and set self.inventory from the dirstate object.
309
This is relatively expensive: we have to walk the entire dirstate.
310
Ideally we would not, and can deprecate this function.
312
#: uncomment to trap on inventory requests.
313
# import pdb;pdb.set_trace()
314
state = self.current_dirstate()
315
state._read_dirblocks_if_needed()
316
root_key, current_entry = self._get_entry(path='')
317
current_id = root_key[2]
318
assert current_entry[0][0] == 'd' # directory
319
inv = Inventory(root_id=current_id)
320
# Turn some things into local variables
321
minikind_to_kind = dirstate.DirState._minikind_to_kind
322
factory = entry_factory
323
utf8_decode = cache_utf8._utf8_decode
325
# we could do this straight out of the dirstate; it might be fast
326
# and should be profiled - RBC 20070216
327
parent_ies = {'' : inv.root}
328
for block in state._dirblocks[1:]: # skip the root
331
parent_ie = parent_ies[dirname]
333
# all the paths in this block are not versioned in this tree
335
for key, entry in block[1]:
336
minikind, link_or_sha1, size, executable, stat = entry[0]
337
if minikind in ('a', 'r'): # absent, relocated
338
# a parent tree only entry
341
name_unicode = utf8_decode(name)[0]
343
kind = minikind_to_kind[minikind]
344
inv_entry = factory[kind](file_id, name_unicode,
347
# This is only needed on win32, where this is the only way
348
# we know the executable bit.
349
inv_entry.executable = executable
350
# not strictly needed: working tree
351
#inv_entry.text_size = size
352
#inv_entry.text_sha1 = sha1
353
elif kind == 'directory':
354
# add this entry to the parent map.
355
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
356
elif kind == 'tree-reference':
357
assert self._repo_supports_tree_reference, \
358
"repository of %r " \
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
assert file_id not in inv_byid, ('file_id %s already in'
367
' inventory as %s' % (file_id, inv_byid[file_id]))
368
assert name_unicode not in parent_ie.children
369
inv_byid[file_id] = inv_entry
370
parent_ie.children[name_unicode] = inv_entry
371
self._inventory = inv
373
def _get_entry(self, file_id=None, path=None):
374
"""Get the dirstate row for file_id or path.
376
If either file_id or path is supplied, it is used as the key to lookup.
377
If both are supplied, the fastest lookup is used, and an error is
378
raised if they do not both point at the same row.
380
:param file_id: An optional unicode file_id to be looked up.
381
:param path: An optional unicode path to be looked up.
382
:return: The dirstate row tuple for path/file_id, or (None, None)
384
if file_id is None and path is None:
385
raise errors.BzrError('must supply file_id or path')
386
state = self.current_dirstate()
388
path = path.encode('utf8')
389
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
391
def get_file_sha1(self, file_id, path=None, stat_value=None):
392
# check file id is valid unconditionally.
393
entry = self._get_entry(file_id=file_id, path=path)
395
raise errors.NoSuchId(self, file_id)
397
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
399
file_abspath = self.abspath(path)
400
state = self.current_dirstate()
401
if stat_value is None:
403
stat_value = os.lstat(file_abspath)
405
if e.errno == errno.ENOENT:
409
link_or_sha1 = state.update_entry(entry, file_abspath,
410
stat_value=stat_value)
411
if entry[1][0][0] == 'f':
415
def _get_inventory(self):
416
"""Get the inventory for the tree. This is only valid within a lock."""
417
if 'evil' in debug.debug_flags:
418
trace.mutter_callsite(2,
419
"accessing .inventory forces a size of tree translation.")
420
if self._inventory is not None:
421
return self._inventory
422
self._must_be_locked()
423
self._generate_inventory()
424
return self._inventory
426
inventory = property(_get_inventory,
427
doc="Inventory of this Tree")
430
def get_parent_ids(self):
431
"""See Tree.get_parent_ids.
433
This implementation requests the ids list from the dirstate file.
435
return self.current_dirstate().get_parent_ids()
437
def get_reference_revision(self, file_id, path=None):
438
# referenced tree's revision is whatever's currently there
439
return self.get_nested_tree(file_id, path).last_revision()
441
def get_nested_tree(self, file_id, path=None):
443
path = self.id2path(file_id)
444
# else: check file_id is at path?
445
return WorkingTree.open(self.abspath(path))
448
def get_root_id(self):
449
"""Return the id of this trees root"""
450
return self._get_entry(path='')[0][2]
452
def has_id(self, file_id):
453
state = self.current_dirstate()
454
row, parents = self._get_entry(file_id=file_id)
457
return osutils.lexists(pathjoin(
458
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
461
def id2path(self, file_id):
462
"Convert a file-id to a path."
463
state = self.current_dirstate()
464
entry = self._get_entry(file_id=file_id)
465
if entry == (None, None):
466
raise errors.NoSuchId(tree=self, file_id=file_id)
467
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
468
return path_utf8.decode('utf8')
470
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
471
entry = self._get_entry(path=path)
472
if entry == (None, None):
473
return False # Missing entries are not executable
474
return entry[1][0][3] # Executable?
476
if not osutils.supports_executable():
477
def is_executable(self, file_id, path=None):
478
"""Test if a file is executable or not.
480
Note: The caller is expected to take a read-lock before calling this.
482
entry = self._get_entry(file_id=file_id, path=path)
483
if entry == (None, None):
485
return entry[1][0][3]
487
_is_executable_from_path_and_stat = \
488
_is_executable_from_path_and_stat_from_basis
490
def is_executable(self, file_id, path=None):
491
"""Test if a file is executable or not.
493
Note: The caller is expected to take a read-lock before calling this.
496
path = self.id2path(file_id)
497
mode = os.lstat(self.abspath(path)).st_mode
498
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
502
"""Iterate through file_ids for this tree.
504
file_ids are in a WorkingTree if they are in the working inventory
505
and the working file exists.
508
for key, tree_details in self.current_dirstate()._iter_entries():
509
if tree_details[0][0] in ('a', 'r'): # absent, relocated
510
# not relevant to the working tree
512
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
513
if osutils.lexists(path):
514
result.append(key[2])
517
def iter_references(self):
518
for key, tree_details in self.current_dirstate()._iter_entries():
519
if tree_details[0][0] in ('a', 'r'): # absent, relocated
520
# not relevant to the working tree
523
# the root is not a reference.
525
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
527
if self._kind(path) == 'tree-reference':
529
except errors.NoSuchFile:
530
# path is missing on disk.
533
def kind(self, file_id):
534
"""Return the kind of a file.
536
This is always the actual kind that's on disk, regardless of what it
539
Note: The caller is expected to take a read-lock before calling this.
541
relpath = self.id2path(file_id)
542
assert relpath != None, \
543
"path for id {%s} is None!" % file_id
544
return self._kind(relpath)
546
def _kind(self, relpath):
547
abspath = self.abspath(relpath)
548
kind = file_kind(abspath)
549
if (self._repo_supports_tree_reference and
550
kind == 'directory' and
551
self._directory_is_tree_reference(relpath)):
552
kind = 'tree-reference'
556
def _last_revision(self):
557
"""See Mutable.last_revision."""
558
parent_ids = self.current_dirstate().get_parent_ids()
562
return _mod_revision.NULL_REVISION
565
"""See Branch.lock_read, and WorkingTree.unlock."""
566
self.branch.lock_read()
568
self._control_files.lock_read()
570
state = self.current_dirstate()
571
if not state._lock_token:
573
# set our support for tree references from the repository in
575
self._repo_supports_tree_reference = getattr(
576
self.branch.repository._format, "supports_tree_reference",
579
self._control_files.unlock()
585
def _lock_self_write(self):
586
"""This should be called after the branch is locked."""
588
self._control_files.lock_write()
590
state = self.current_dirstate()
591
if not state._lock_token:
593
# set our support for tree references from the repository in
595
self._repo_supports_tree_reference = getattr(
596
self.branch.repository._format, "supports_tree_reference",
599
self._control_files.unlock()
605
def lock_tree_write(self):
606
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
607
self.branch.lock_read()
608
self._lock_self_write()
610
def lock_write(self):
611
"""See MutableTree.lock_write, and WorkingTree.unlock."""
612
self.branch.lock_write()
613
self._lock_self_write()
615
@needs_tree_write_lock
616
def move(self, from_paths, to_dir, after=False):
617
"""See WorkingTree.move()."""
622
state = self.current_dirstate()
624
assert not isinstance(from_paths, basestring)
625
to_dir_utf8 = to_dir.encode('utf8')
626
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
627
id_index = state._get_id_index()
628
# check destination directory
629
# get the details for it
630
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
631
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
632
if not entry_present:
633
raise errors.BzrMoveFailedError('', to_dir,
634
errors.NotVersionedError(to_dir))
635
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
636
# get a handle on the block itself.
637
to_block_index = state._ensure_block(
638
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
639
to_block = state._dirblocks[to_block_index]
640
to_abs = self.abspath(to_dir)
641
if not isdir(to_abs):
642
raise errors.BzrMoveFailedError('',to_dir,
643
errors.NotADirectory(to_abs))
645
if to_entry[1][0][0] != 'd':
646
raise errors.BzrMoveFailedError('',to_dir,
647
errors.NotADirectory(to_abs))
649
if self._inventory is not None:
650
update_inventory = True
652
to_dir_ie = inv[to_dir_id]
653
to_dir_id = to_entry[0][2]
655
update_inventory = False
658
def move_one(old_entry, from_path_utf8, minikind, executable,
659
fingerprint, packed_stat, size,
660
to_block, to_key, to_path_utf8):
661
state._make_absent(old_entry)
662
from_key = old_entry[0]
664
lambda:state.update_minimal(from_key,
666
executable=executable,
667
fingerprint=fingerprint,
668
packed_stat=packed_stat,
670
path_utf8=from_path_utf8))
671
state.update_minimal(to_key,
673
executable=executable,
674
fingerprint=fingerprint,
675
packed_stat=packed_stat,
677
path_utf8=to_path_utf8)
678
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
679
new_entry = to_block[1][added_entry_index]
680
rollbacks.append(lambda:state._make_absent(new_entry))
682
for from_rel in from_paths:
683
# from_rel is 'pathinroot/foo/bar'
684
from_rel_utf8 = from_rel.encode('utf8')
685
from_dirname, from_tail = osutils.split(from_rel)
686
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
687
from_entry = self._get_entry(path=from_rel)
688
if from_entry == (None, None):
689
raise errors.BzrMoveFailedError(from_rel,to_dir,
690
errors.NotVersionedError(path=str(from_rel)))
692
from_id = from_entry[0][2]
693
to_rel = pathjoin(to_dir, from_tail)
694
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
695
item_to_entry = self._get_entry(path=to_rel)
696
if item_to_entry != (None, None):
697
raise errors.BzrMoveFailedError(from_rel, to_rel,
698
"Target is already versioned.")
700
if from_rel == to_rel:
701
raise errors.BzrMoveFailedError(from_rel, to_rel,
702
"Source and target are identical.")
704
from_missing = not self.has_filename(from_rel)
705
to_missing = not self.has_filename(to_rel)
712
raise errors.BzrMoveFailedError(from_rel, to_rel,
713
errors.NoSuchFile(path=to_rel,
714
extra="New file has not been created yet"))
716
# neither path exists
717
raise errors.BzrRenameFailedError(from_rel, to_rel,
718
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
720
if from_missing: # implicitly just update our path mapping
723
raise errors.RenameFailedFilesExist(from_rel, to_rel,
724
extra="(Use --after to update the Bazaar id)")
727
def rollback_rename():
728
"""A single rename has failed, roll it back."""
729
# roll back everything, even if we encounter trouble doing one
732
# TODO: at least log the other exceptions rather than just
733
# losing them mbp 20070307
735
for rollback in reversed(rollbacks):
739
exc_info = sys.exc_info()
741
raise exc_info[0], exc_info[1], exc_info[2]
743
# perform the disk move first - its the most likely failure point.
745
from_rel_abs = self.abspath(from_rel)
746
to_rel_abs = self.abspath(to_rel)
748
osutils.rename(from_rel_abs, to_rel_abs)
750
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
751
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
753
# perform the rename in the inventory next if needed: its easy
757
from_entry = inv[from_id]
758
current_parent = from_entry.parent_id
759
inv.rename(from_id, to_dir_id, from_tail)
761
lambda: inv.rename(from_id, current_parent, from_tail))
762
# finally do the rename in the dirstate, which is a little
763
# tricky to rollback, but least likely to need it.
764
old_block_index, old_entry_index, dir_present, file_present = \
765
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
766
old_block = state._dirblocks[old_block_index][1]
767
old_entry = old_block[old_entry_index]
768
from_key, old_entry_details = old_entry
769
cur_details = old_entry_details[0]
771
to_key = ((to_block[0],) + from_key[1:3])
772
minikind = cur_details[0]
773
move_one(old_entry, from_path_utf8=from_rel_utf8,
775
executable=cur_details[3],
776
fingerprint=cur_details[1],
777
packed_stat=cur_details[4],
781
to_path_utf8=to_rel_utf8)
784
def update_dirblock(from_dir, to_key, to_dir_utf8):
785
"""Recursively update all entries in this dirblock."""
786
assert from_dir != '', "renaming root not supported"
787
from_key = (from_dir, '')
788
from_block_idx, present = \
789
state._find_block_index_from_key(from_key)
791
# This is the old record, if it isn't present, then
792
# there is theoretically nothing to update.
793
# (Unless it isn't present because of lazy loading,
794
# but we don't do that yet)
796
from_block = state._dirblocks[from_block_idx]
797
to_block_index, to_entry_index, _, _ = \
798
state._get_block_entry_index(to_key[0], to_key[1], 0)
799
to_block_index = state._ensure_block(
800
to_block_index, to_entry_index, to_dir_utf8)
801
to_block = state._dirblocks[to_block_index]
803
# Grab a copy since move_one may update the list.
804
for entry in from_block[1][:]:
805
assert entry[0][0] == from_dir
806
cur_details = entry[1][0]
807
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
808
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
809
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
810
minikind = cur_details[0]
812
# Deleted children of a renamed directory
813
# Do not need to be updated.
814
# Children that have been renamed out of this
815
# directory should also not be updated
817
move_one(entry, from_path_utf8=from_path_utf8,
819
executable=cur_details[3],
820
fingerprint=cur_details[1],
821
packed_stat=cur_details[4],
825
to_path_utf8=to_path_utf8)
827
# We need to move all the children of this
829
update_dirblock(from_path_utf8, to_key,
831
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
835
result.append((from_rel, to_rel))
836
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
837
self._make_dirty(reset_inventory=False)
841
def _must_be_locked(self):
842
if not self._control_files._lock_count:
843
raise errors.ObjectNotLocked(self)
846
"""Initialize the state in this tree to be a new tree."""
850
def path2id(self, path):
851
"""Return the id for path in this tree."""
852
path = path.strip('/')
853
entry = self._get_entry(path=path)
854
if entry == (None, None):
858
def paths2ids(self, paths, trees=[], require_versioned=True):
859
"""See Tree.paths2ids().
861
This specialisation fast-paths the case where all the trees are in the
866
parents = self.get_parent_ids()
868
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
870
return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
871
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
872
# -- make all paths utf8 --
875
paths_utf8.add(path.encode('utf8'))
877
# -- paths is now a utf8 path set --
878
# -- get the state object and prepare it.
879
state = self.current_dirstate()
880
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
881
and '' not in paths):
882
paths2ids = self._paths2ids_using_bisect
884
paths2ids = self._paths2ids_in_memory
885
return paths2ids(paths, search_indexes,
886
require_versioned=require_versioned)
888
def _paths2ids_in_memory(self, paths, search_indexes,
889
require_versioned=True):
890
state = self.current_dirstate()
891
state._read_dirblocks_if_needed()
892
def _entries_for_path(path):
893
"""Return a list with all the entries that match path for all ids.
895
dirname, basename = os.path.split(path)
896
key = (dirname, basename, '')
897
block_index, present = state._find_block_index_from_key(key)
899
# the block which should contain path is absent.
902
block = state._dirblocks[block_index][1]
903
entry_index, _ = state._find_entry_index(key, block)
904
# we may need to look at multiple entries at this path: walk while the paths match.
905
while (entry_index < len(block) and
906
block[entry_index][0][0:2] == key[0:2]):
907
result.append(block[entry_index])
910
if require_versioned:
911
# -- check all supplied paths are versioned in a search tree. --
914
path_entries = _entries_for_path(path)
916
# this specified path is not present at all: error
917
all_versioned = False
919
found_versioned = False
920
# for each id at this path
921
for entry in path_entries:
923
for index in search_indexes:
924
if entry[1][index][0] != 'a': # absent
925
found_versioned = True
926
# all good: found a versioned cell
928
if not found_versioned:
929
# none of the indexes was not 'absent' at all ids for this
931
all_versioned = False
933
if not all_versioned:
934
raise errors.PathsNotVersionedError(paths)
935
# -- remove redundancy in supplied paths to prevent over-scanning --
936
search_paths = osutils.minimum_path_selection(paths)
938
# for all search_indexs in each path at or under each element of
939
# search_paths, if the detail is relocated: add the id, and add the
940
# relocated path as one to search if its not searched already. If the
941
# detail is not relocated, add the id.
942
searched_paths = set()
944
def _process_entry(entry):
945
"""Look at search_indexes within entry.
947
If a specific tree's details are relocated, add the relocation
948
target to search_paths if not searched already. If it is absent, do
949
nothing. Otherwise add the id to found_ids.
951
for index in search_indexes:
952
if entry[1][index][0] == 'r': # relocated
953
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
954
search_paths.add(entry[1][index][1])
955
elif entry[1][index][0] != 'a': # absent
956
found_ids.add(entry[0][2])
958
current_root = search_paths.pop()
959
searched_paths.add(current_root)
960
# process the entries for this containing directory: the rest will be
961
# found by their parents recursively.
962
root_entries = _entries_for_path(current_root)
964
# this specified path is not present at all, skip it.
966
for entry in root_entries:
967
_process_entry(entry)
968
initial_key = (current_root, '', '')
969
block_index, _ = state._find_block_index_from_key(initial_key)
970
while (block_index < len(state._dirblocks) and
971
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
972
for entry in state._dirblocks[block_index][1]:
973
_process_entry(entry)
977
def _paths2ids_using_bisect(self, paths, search_indexes,
978
require_versioned=True):
979
state = self.current_dirstate()
982
split_paths = sorted(osutils.split(p) for p in paths)
983
found = state._bisect_recursive(split_paths)
985
if require_versioned:
986
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
987
for dir_name in split_paths:
988
if dir_name not in found_dir_names:
989
raise errors.PathsNotVersionedError(paths)
991
for dir_name_id, trees_info in found.iteritems():
992
for index in search_indexes:
993
if trees_info[index][0] not in ('r', 'a'):
994
found_ids.add(dir_name_id[2])
997
def read_working_inventory(self):
998
"""Read the working inventory.
1000
This is a meaningless operation for dirstate, but we obey it anyhow.
1002
return self.inventory
1005
def revision_tree(self, revision_id):
1006
"""See Tree.revision_tree.
1008
WorkingTree4 supplies revision_trees for any basis tree.
1010
dirstate = self.current_dirstate()
1011
parent_ids = dirstate.get_parent_ids()
1012
if revision_id not in parent_ids:
1013
raise errors.NoSuchRevisionInTree(self, revision_id)
1014
if revision_id in dirstate.get_ghosts():
1015
raise errors.NoSuchRevisionInTree(self, revision_id)
1016
return DirStateRevisionTree(dirstate, revision_id,
1017
self.branch.repository)
1019
@needs_tree_write_lock
1020
def set_last_revision(self, new_revision):
1021
"""Change the last revision in the working tree."""
1022
parents = self.get_parent_ids()
1023
if new_revision in (NULL_REVISION, None):
1024
assert len(parents) < 2, (
1025
"setting the last parent to none with a pending merge is "
1027
self.set_parent_ids([])
1029
self.set_parent_ids([new_revision] + parents[1:],
1030
allow_leftmost_as_ghost=True)
1032
@needs_tree_write_lock
1033
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1034
"""Set the parent ids to revision_ids.
1036
See also set_parent_trees. This api will try to retrieve the tree data
1037
for each element of revision_ids from the trees repository. If you have
1038
tree data already available, it is more efficient to use
1039
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1040
an easier API to use.
1042
:param revision_ids: The revision_ids to set as the parent ids of this
1043
working tree. Any of these may be ghosts.
1046
for revision_id in revision_ids:
1048
revtree = self.branch.repository.revision_tree(revision_id)
1049
# TODO: jam 20070213 KnitVersionedFile raises
1050
# RevisionNotPresent rather than NoSuchRevision if a
1051
# given revision_id is not present. Should Repository be
1052
# catching it and re-raising NoSuchRevision?
1053
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1055
trees.append((revision_id, revtree))
1056
self.set_parent_trees(trees,
1057
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1059
@needs_tree_write_lock
1060
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1061
"""Set the parents of the working tree.
1063
:param parents_list: A list of (revision_id, tree) tuples.
1064
If tree is None, then that element is treated as an unreachable
1065
parent tree - i.e. a ghost.
1067
dirstate = self.current_dirstate()
1068
if len(parents_list) > 0:
1069
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1070
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1073
# convert absent trees to the null tree, which we convert back to
1074
# missing on access.
1075
for rev_id, tree in parents_list:
1076
_mod_revision.check_not_reserved_id(rev_id)
1077
if tree is not None:
1078
real_trees.append((rev_id, tree))
1080
real_trees.append((rev_id,
1081
self.branch.repository.revision_tree(None)))
1082
ghosts.append(rev_id)
1083
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1084
self._make_dirty(reset_inventory=False)
1086
def _set_root_id(self, file_id):
1087
"""See WorkingTree.set_root_id."""
1088
state = self.current_dirstate()
1089
state.set_path_id('', file_id)
1090
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1091
self._make_dirty(reset_inventory=True)
1093
def _sha_from_stat(self, path, stat_result):
1094
"""Get a sha digest from the tree's stat cache.
1096
The default implementation assumes no stat cache is present.
1098
:param path: The path.
1099
:param stat_result: The stat result being looked up.
1101
state = self.current_dirstate()
1102
# XXX: should we make the path be passed in as utf8 ?
1103
entry = state._get_entry(0, path_utf8=cache_utf8.encode(path))
1104
tree_details = entry[1][0]
1105
packed_stat = dirstate.pack_stat(stat_result)
1106
if tree_details[4] == packed_stat:
1107
return tree_details[1]
1112
def supports_tree_reference(self):
1113
return self._repo_supports_tree_reference
1116
"""Unlock in format 4 trees needs to write the entire dirstate."""
1117
# do non-implementation specific cleanup
1120
if self._control_files._lock_count == 1:
1121
# eventually we should do signature checking during read locks for
1123
if self._control_files._lock_mode == 'w':
1126
if self._dirstate is not None:
1127
# This is a no-op if there are no modifications.
1128
self._dirstate.save()
1129
self._dirstate.unlock()
1130
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1131
# point. Instead, it could check if the header has been
1132
# modified when it is locked, and if not, it can hang on to
1133
# the data it has in memory.
1134
self._dirstate = None
1135
self._inventory = None
1136
# reverse order of locking.
1138
return self._control_files.unlock()
1140
self.branch.unlock()
1142
@needs_tree_write_lock
1143
def unversion(self, file_ids):
1144
"""Remove the file ids in file_ids from the current versioned set.
1146
When a file_id is unversioned, all of its children are automatically
1149
:param file_ids: The file ids to stop versioning.
1150
:raises: NoSuchId if any fileid is not currently versioned.
1154
state = self.current_dirstate()
1155
state._read_dirblocks_if_needed()
1156
ids_to_unversion = set(file_ids)
1157
paths_to_unversion = set()
1159
# check if the root is to be unversioned, if so, assert for now.
1160
# walk the state marking unversioned things as absent.
1161
# if there are any un-unversioned ids at the end, raise
1162
for key, details in state._dirblocks[0][1]:
1163
if (details[0][0] not in ('a', 'r') and # absent or relocated
1164
key[2] in ids_to_unversion):
1165
# I haven't written the code to unversion / yet - it should be
1167
raise errors.BzrError('Unversioning the / is not currently supported')
1169
while block_index < len(state._dirblocks):
1170
# process one directory at a time.
1171
block = state._dirblocks[block_index]
1172
# first check: is the path one to remove - it or its children
1173
delete_block = False
1174
for path in paths_to_unversion:
1175
if (block[0].startswith(path) and
1176
(len(block[0]) == len(path) or
1177
block[0][len(path)] == '/')):
1178
# this entire block should be deleted - its the block for a
1179
# path to unversion; or the child of one
1182
# TODO: trim paths_to_unversion as we pass by paths
1184
# this block is to be deleted: process it.
1185
# TODO: we can special case the no-parents case and
1186
# just forget the whole block.
1188
while entry_index < len(block[1]):
1189
# Mark this file id as having been removed
1190
entry = block[1][entry_index]
1191
ids_to_unversion.discard(entry[0][2])
1192
if (entry[1][0][0] == 'a'
1193
or not state._make_absent(entry)):
1195
# go to the next block. (At the moment we dont delete empty
1200
while entry_index < len(block[1]):
1201
entry = block[1][entry_index]
1202
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1203
# ^ some parent row.
1204
entry[0][2] not in ids_to_unversion):
1205
# ^ not an id to unversion
1208
if entry[1][0][0] == 'd':
1209
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1210
if not state._make_absent(entry):
1212
# we have unversioned this id
1213
ids_to_unversion.remove(entry[0][2])
1215
if ids_to_unversion:
1216
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1217
self._make_dirty(reset_inventory=False)
1218
# have to change the legacy inventory too.
1219
if self._inventory is not None:
1220
for file_id in file_ids:
1221
self._inventory.remove_recursive_id(file_id)
1223
def update_basis_by_delta(self, new_revid, delta):
1224
"""See MutableTree.update_basis_by_delta."""
1225
assert self.last_revision() != new_revid
1226
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1229
def _validate(self):
1230
self._dirstate._validate()
1232
@needs_tree_write_lock
1233
def _write_inventory(self, inv):
1234
"""Write inventory as the current inventory."""
1235
assert not self._dirty, ("attempting to write an inventory when the "
1236
"dirstate is dirty will cause data loss")
1237
self.current_dirstate().set_state_from_inventory(inv)
1238
self._make_dirty(reset_inventory=False)
1239
if self._inventory is not None:
1240
self._inventory = inv
1244
class WorkingTreeFormat4(WorkingTreeFormat3):
1245
"""The first consolidated dirstate working tree format.
1248
- exists within a metadir controlling .bzr
1249
- includes an explicit version marker for the workingtree control
1250
files, separate from the BzrDir format
1251
- modifies the hash cache format
1252
- is new in bzr 0.15
1253
- uses a LockDir to guard access to it.
1256
upgrade_recommended = False
1258
def get_format_string(self):
1259
"""See WorkingTreeFormat.get_format_string()."""
1260
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1262
def get_format_description(self):
1263
"""See WorkingTreeFormat.get_format_description()."""
1264
return "Working tree format 4"
1266
def initialize(self, a_bzrdir, revision_id=None):
1267
"""See WorkingTreeFormat.initialize().
1269
:param revision_id: allows creating a working tree at a different
1270
revision than the branch is at.
1272
These trees get an initial random root id, if their repository supports
1273
rich root data, TREE_ROOT otherwise.
1275
if not isinstance(a_bzrdir.transport, LocalTransport):
1276
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1277
transport = a_bzrdir.get_workingtree_transport(self)
1278
control_files = self._open_control_files(a_bzrdir)
1279
control_files.create_lock()
1280
control_files.lock_write()
1281
control_files.put_utf8('format', self.get_format_string())
1282
branch = a_bzrdir.open_branch()
1283
if revision_id is None:
1284
revision_id = branch.last_revision()
1285
local_path = transport.local_abspath('dirstate')
1286
# write out new dirstate (must exist when we create the tree)
1287
state = dirstate.DirState.initialize(local_path)
1290
wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1294
_control_files=control_files)
1296
wt.lock_tree_write()
1298
if revision_id in (None, NULL_REVISION):
1299
if branch.repository.supports_rich_root():
1300
wt._set_root_id(generate_ids.gen_root_id())
1302
wt._set_root_id(ROOT_ID)
1304
wt.set_last_revision(revision_id)
1306
basis = wt.basis_tree()
1308
# if the basis has a root id we have to use that; otherwise we use
1310
basis_root_id = basis.get_root_id()
1311
if basis_root_id is not None:
1312
wt._set_root_id(basis_root_id)
1314
transform.build_tree(basis, wt)
1317
control_files.unlock()
1321
def _open(self, a_bzrdir, control_files):
1322
"""Open the tree itself.
1324
:param a_bzrdir: the dir for the tree.
1325
:param control_files: the control files for the tree.
1327
return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1328
branch=a_bzrdir.open_branch(),
1331
_control_files=control_files)
1333
def __get_matchingbzrdir(self):
1334
# please test against something that will let us do tree references
1335
return bzrdir.format_registry.make_bzrdir(
1336
'dirstate-with-subtree')
1338
_matchingbzrdir = property(__get_matchingbzrdir)
1341
class DirStateRevisionTree(Tree):
1342
"""A revision tree pulling the inventory from a dirstate."""
1344
def __init__(self, dirstate, revision_id, repository):
1345
self._dirstate = dirstate
1346
self._revision_id = revision_id
1347
self._repository = repository
1348
self._inventory = None
1350
self._dirstate_locked = False
1353
return "<%s of %s in %s>" % \
1354
(self.__class__.__name__, self._revision_id, self._dirstate)
1356
def annotate_iter(self, file_id,
1357
default_revision=_mod_revision.CURRENT_REVISION):
1358
"""See Tree.annotate_iter"""
1359
w = self._get_weave(file_id)
1360
return w.annotate_iter(self.inventory[file_id].revision)
1362
def _get_ancestors(self, default_revision):
1363
return set(self._repository.get_ancestry(self._revision_id,
1365
def _comparison_data(self, entry, path):
1366
"""See Tree._comparison_data."""
1368
return None, False, None
1369
# trust the entry as RevisionTree does, but this may not be
1370
# sensible: the entry might not have come from us?
1371
return entry.kind, entry.executable, None
1373
def _file_size(self, entry, stat_value):
1374
return entry.text_size
1376
def filter_unversioned_files(self, paths):
1377
"""Filter out paths that are not versioned.
1379
:return: set of paths.
1381
pred = self.has_filename
1382
return set((p for p in paths if not pred(p)))
1384
def get_root_id(self):
1385
return self.path2id('')
1387
def _get_parent_index(self):
1388
"""Return the index in the dirstate referenced by this tree."""
1389
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1391
def _get_entry(self, file_id=None, path=None):
1392
"""Get the dirstate row for file_id or path.
1394
If either file_id or path is supplied, it is used as the key to lookup.
1395
If both are supplied, the fastest lookup is used, and an error is
1396
raised if they do not both point at the same row.
1398
:param file_id: An optional unicode file_id to be looked up.
1399
:param path: An optional unicode path to be looked up.
1400
:return: The dirstate row tuple for path/file_id, or (None, None)
1402
if file_id is None and path is None:
1403
raise errors.BzrError('must supply file_id or path')
1404
if path is not None:
1405
path = path.encode('utf8')
1406
parent_index = self._get_parent_index()
1407
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1409
def _generate_inventory(self):
1410
"""Create and set self.inventory from the dirstate object.
1412
(So this is only called the first time the inventory is requested for
1413
this tree; it then remains in memory until it's out of date.)
1415
This is relatively expensive: we have to walk the entire dirstate.
1417
assert self._locked, 'cannot generate inventory of an unlocked '\
1418
'dirstate revision tree'
1419
# separate call for profiling - makes it clear where the costs are.
1420
self._dirstate._read_dirblocks_if_needed()
1421
assert self._revision_id in self._dirstate.get_parent_ids(), \
1422
'parent %s has disappeared from %s' % (
1423
self._revision_id, self._dirstate.get_parent_ids())
1424
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1425
# This is identical now to the WorkingTree _generate_inventory except
1426
# for the tree index use.
1427
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1428
current_id = root_key[2]
1429
assert current_entry[parent_index][0] == 'd'
1430
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1431
inv.root.revision = current_entry[parent_index][4]
1432
# Turn some things into local variables
1433
minikind_to_kind = dirstate.DirState._minikind_to_kind
1434
factory = entry_factory
1435
utf8_decode = cache_utf8._utf8_decode
1436
inv_byid = inv._byid
1437
# we could do this straight out of the dirstate; it might be fast
1438
# and should be profiled - RBC 20070216
1439
parent_ies = {'' : inv.root}
1440
for block in self._dirstate._dirblocks[1:]: #skip root
1443
parent_ie = parent_ies[dirname]
1445
# all the paths in this block are not versioned in this tree
1447
for key, entry in block[1]:
1448
minikind, fingerprint, size, executable, revid = entry[parent_index]
1449
if minikind in ('a', 'r'): # absent, relocated
1453
name_unicode = utf8_decode(name)[0]
1455
kind = minikind_to_kind[minikind]
1456
inv_entry = factory[kind](file_id, name_unicode,
1458
inv_entry.revision = revid
1460
inv_entry.executable = executable
1461
inv_entry.text_size = size
1462
inv_entry.text_sha1 = fingerprint
1463
elif kind == 'directory':
1464
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1465
elif kind == 'symlink':
1466
inv_entry.executable = False
1467
inv_entry.text_size = None
1468
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1469
elif kind == 'tree-reference':
1470
inv_entry.reference_revision = fingerprint or None
1472
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1474
# These checks cost us around 40ms on a 55k entry tree
1475
assert file_id not in inv_byid
1476
assert name_unicode not in parent_ie.children
1477
inv_byid[file_id] = inv_entry
1478
parent_ie.children[name_unicode] = inv_entry
1479
self._inventory = inv
1481
def get_file_mtime(self, file_id, path=None):
1482
"""Return the modification time for this record.
1484
We return the timestamp of the last-changed revision.
1486
# Make sure the file exists
1487
entry = self._get_entry(file_id, path=path)
1488
if entry == (None, None): # do we raise?
1490
parent_index = self._get_parent_index()
1491
last_changed_revision = entry[1][parent_index][4]
1492
return self._repository.get_revision(last_changed_revision).timestamp
1494
def get_file_sha1(self, file_id, path=None, stat_value=None):
1495
entry = self._get_entry(file_id=file_id, path=path)
1496
parent_index = self._get_parent_index()
1497
parent_details = entry[1][parent_index]
1498
if parent_details[0] == 'f':
1499
return parent_details[1]
1502
@symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
1503
def get_weave(self, file_id):
1504
return self._get_weave(file_id)
1506
def _get_weave(self, file_id):
1507
return self._repository.weave_store.get_weave(file_id,
1508
self._repository.get_transaction())
1510
def get_file(self, file_id, path=None):
1511
return StringIO(self.get_file_text(file_id))
1513
def get_file_lines(self, file_id):
1514
ie = self.inventory[file_id]
1515
return self._get_weave(file_id).get_lines(ie.revision)
1517
def get_file_size(self, file_id):
1518
return self.inventory[file_id].text_size
1520
def get_file_text(self, file_id):
1521
return ''.join(self.get_file_lines(file_id))
1523
def get_reference_revision(self, file_id, path=None):
1524
return self.inventory[file_id].reference_revision
1526
def iter_files_bytes(self, desired_files):
1527
"""See Tree.iter_files_bytes.
1529
This version is implemented on top of Repository.iter_files_bytes"""
1530
parent_index = self._get_parent_index()
1531
repo_desired_files = []
1532
for file_id, identifier in desired_files:
1533
entry = self._get_entry(file_id)
1534
if entry == (None, None):
1535
raise errors.NoSuchId(self, file_id)
1536
repo_desired_files.append((file_id, entry[1][parent_index][4],
1538
return self._repository.iter_files_bytes(repo_desired_files)
1540
def get_symlink_target(self, file_id):
1541
entry = self._get_entry(file_id=file_id)
1542
parent_index = self._get_parent_index()
1543
if entry[1][parent_index][0] != 'l':
1546
# At present, none of the tree implementations supports non-ascii
1547
# symlink targets. So we will just assume that the dirstate path is
1549
return entry[1][parent_index][1]
1551
def get_revision_id(self):
1552
"""Return the revision id for this tree."""
1553
return self._revision_id
1555
def _get_inventory(self):
1556
if self._inventory is not None:
1557
return self._inventory
1558
self._must_be_locked()
1559
self._generate_inventory()
1560
return self._inventory
1562
inventory = property(_get_inventory,
1563
doc="Inventory of this Tree")
1565
def get_parent_ids(self):
1566
"""The parents of a tree in the dirstate are not cached."""
1567
return self._repository.get_revision(self._revision_id).parent_ids
1569
def has_filename(self, filename):
1570
return bool(self.path2id(filename))
1572
def kind(self, file_id):
1573
return self.inventory[file_id].kind
1575
def path_content_summary(self, path):
1576
"""See Tree.path_content_summary."""
1577
id = self.inventory.path2id(path)
1579
return ('missing', None, None, None)
1580
entry = self._inventory[id]
1583
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1584
elif kind == 'symlink':
1585
return (kind, None, None, entry.symlink_target)
1587
return (kind, None, None, None)
1589
def is_executable(self, file_id, path=None):
1590
ie = self.inventory[file_id]
1591
if ie.kind != "file":
1593
return ie.executable
1595
def list_files(self, include_root=False):
1596
# We use a standard implementation, because DirStateRevisionTree is
1597
# dealing with one of the parents of the current state
1598
inv = self._get_inventory()
1599
entries = inv.iter_entries()
1600
if self.inventory.root is not None and not include_root:
1602
for path, entry in entries:
1603
yield path, 'V', entry.kind, entry.file_id, entry
1605
def lock_read(self):
1606
"""Lock the tree for a set of operations."""
1607
if not self._locked:
1608
self._repository.lock_read()
1609
if self._dirstate._lock_token is None:
1610
self._dirstate.lock_read()
1611
self._dirstate_locked = True
1614
def _must_be_locked(self):
1615
if not self._locked:
1616
raise errors.ObjectNotLocked(self)
1619
def path2id(self, path):
1620
"""Return the id for path in this tree."""
1621
# lookup by path: faster than splitting and walking the ivnentory.
1622
entry = self._get_entry(path=path)
1623
if entry == (None, None):
1628
"""Unlock, freeing any cache memory used during the lock."""
1629
# outside of a lock, the inventory is suspect: release it.
1631
if not self._locked:
1632
self._inventory = None
1634
if self._dirstate_locked:
1635
self._dirstate.unlock()
1636
self._dirstate_locked = False
1637
self._repository.unlock()
1639
def walkdirs(self, prefix=""):
1640
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1641
# implementation based on an inventory.
1642
# This should be cleaned up to use the much faster Dirstate code
1643
# So for now, we just build up the parent inventory, and extract
1644
# it the same way RevisionTree does.
1645
_directory = 'directory'
1646
inv = self._get_inventory()
1647
top_id = inv.path2id(prefix)
1651
pending = [(prefix, top_id)]
1654
relpath, file_id = pending.pop()
1655
# 0 - relpath, 1- file-id
1657
relroot = relpath + '/'
1660
# FIXME: stash the node in pending
1661
entry = inv[file_id]
1662
for name, child in entry.sorted_children():
1663
toppath = relroot + name
1664
dirblock.append((toppath, name, child.kind, None,
1665
child.file_id, child.kind
1667
yield (relpath, entry.file_id), dirblock
1668
# push the user specified dirs from dirblock
1669
for dir in reversed(dirblock):
1670
if dir[2] == _directory:
1671
pending.append((dir[0], dir[4]))
1674
class InterDirStateTree(InterTree):
1675
"""Fast path optimiser for changes_from with dirstate trees.
1677
This is used only when both trees are in the dirstate working file, and
1678
the source is any parent within the dirstate, and the destination is
1679
the current working tree of the same dirstate.
1681
# this could be generalized to allow comparisons between any trees in the
1682
# dirstate, and possibly between trees stored in different dirstates.
1684
def __init__(self, source, target):
1685
super(InterDirStateTree, self).__init__(source, target)
1686
if not InterDirStateTree.is_compatible(source, target):
1687
raise Exception, "invalid source %r and target %r" % (source, target)
1690
def make_source_parent_tree(source, target):
1691
"""Change the source tree into a parent of the target."""
1692
revid = source.commit('record tree')
1693
target.branch.repository.fetch(source.branch.repository, revid)
1694
target.set_parent_ids([revid])
1695
return target.basis_tree(), target
1697
_matching_from_tree_format = WorkingTreeFormat4()
1698
_matching_to_tree_format = WorkingTreeFormat4()
1699
_test_mutable_trees_to_test_trees = make_source_parent_tree
1701
def _iter_changes(self, include_unchanged=False,
1702
specific_files=None, pb=None, extra_trees=[],
1703
require_versioned=True, want_unversioned=False):
1704
"""Return the changes from source to target.
1706
:return: An iterator that yields tuples. See InterTree._iter_changes
1708
:param specific_files: An optional list of file paths to restrict the
1709
comparison to. When mapping filenames to ids, all matches in all
1710
trees (including optional extra_trees) are used, and all children of
1711
matched directories are included.
1712
:param include_unchanged: An optional boolean requesting the inclusion of
1713
unchanged entries in the result.
1714
:param extra_trees: An optional list of additional trees to use when
1715
mapping the contents of specific_files (paths) to file_ids.
1716
:param require_versioned: If True, all files in specific_files must be
1717
versioned in one of source, target, extra_trees or
1718
PathsNotVersionedError is raised.
1719
:param want_unversioned: Should unversioned files be returned in the
1720
output. An unversioned file is defined as one with (False, False)
1721
for the versioned pair.
1723
utf8_decode = cache_utf8._utf8_decode
1724
_minikind_to_kind = dirstate.DirState._minikind_to_kind
1725
cmp_by_dirs = dirstate.cmp_by_dirs
1726
# NB: show_status depends on being able to pass in non-versioned files
1727
# and report them as unknown
1728
# TODO: handle extra trees in the dirstate.
1729
# TODO: handle comparisons as an empty tree as a different special
1730
# case? mbp 20070226
1731
if (extra_trees or (self.source._revision_id == NULL_REVISION)
1732
or specific_files == []):
1733
# we can't fast-path these cases (yet)
1734
for f in super(InterDirStateTree, self)._iter_changes(
1735
include_unchanged, specific_files, pb, extra_trees,
1736
require_versioned, want_unversioned=want_unversioned):
1739
parent_ids = self.target.get_parent_ids()
1740
assert (self.source._revision_id in parent_ids), \
1741
"revision {%s} is not stored in {%s}, but %s " \
1742
"can only be used for trees stored in the dirstate" \
1743
% (self.source._revision_id, self.target, self._iter_changes)
1745
if self.source._revision_id == NULL_REVISION:
1747
indices = (target_index,)
1749
assert (self.source._revision_id in parent_ids), \
1750
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1751
self.source._revision_id, parent_ids)
1752
source_index = 1 + parent_ids.index(self.source._revision_id)
1753
indices = (source_index,target_index)
1754
# -- make all specific_files utf8 --
1756
specific_files_utf8 = set()
1757
for path in specific_files:
1758
specific_files_utf8.add(path.encode('utf8'))
1759
specific_files = specific_files_utf8
1761
specific_files = set([''])
1762
# -- specific_files is now a utf8 path set --
1763
# -- get the state object and prepare it.
1764
state = self.target.current_dirstate()
1765
state._read_dirblocks_if_needed()
1766
def _entries_for_path(path):
1767
"""Return a list with all the entries that match path for all ids.
1769
dirname, basename = os.path.split(path)
1770
key = (dirname, basename, '')
1771
block_index, present = state._find_block_index_from_key(key)
1773
# the block which should contain path is absent.
1776
block = state._dirblocks[block_index][1]
1777
entry_index, _ = state._find_entry_index(key, block)
1778
# we may need to look at multiple entries at this path: walk while the specific_files match.
1779
while (entry_index < len(block) and
1780
block[entry_index][0][0:2] == key[0:2]):
1781
result.append(block[entry_index])
1784
if require_versioned:
1785
# -- check all supplied paths are versioned in a search tree. --
1786
all_versioned = True
1787
for path in specific_files:
1788
path_entries = _entries_for_path(path)
1789
if not path_entries:
1790
# this specified path is not present at all: error
1791
all_versioned = False
1793
found_versioned = False
1794
# for each id at this path
1795
for entry in path_entries:
1797
for index in indices:
1798
if entry[1][index][0] != 'a': # absent
1799
found_versioned = True
1800
# all good: found a versioned cell
1802
if not found_versioned:
1803
# none of the indexes was not 'absent' at all ids for this
1805
all_versioned = False
1807
if not all_versioned:
1808
raise errors.PathsNotVersionedError(specific_files)
1809
# -- remove redundancy in supplied specific_files to prevent over-scanning --
1810
search_specific_files = set()
1811
for path in specific_files:
1812
other_specific_files = specific_files.difference(set([path]))
1813
if not osutils.is_inside_any(other_specific_files, path):
1814
# this is a top level path, we must check it.
1815
search_specific_files.add(path)
1817
# compare source_index and target_index at or under each element of search_specific_files.
1818
# follow the following comparison table. Note that we only want to do diff operations when
1819
# the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
1823
# Source | Target | disk | action
1824
# r | fdlt | | add source to search, add id path move and perform
1825
# | | | diff check on source-target
1826
# r | fdlt | a | dangling file that was present in the basis.
1828
# r | a | | add source to search
1830
# r | r | | this path is present in a non-examined tree, skip.
1831
# r | r | a | this path is present in a non-examined tree, skip.
1832
# a | fdlt | | add new id
1833
# a | fdlt | a | dangling locally added file, skip
1834
# a | a | | not present in either tree, skip
1835
# a | a | a | not present in any tree, skip
1836
# a | r | | not present in either tree at this path, skip as it
1837
# | | | may not be selected by the users list of paths.
1838
# a | r | a | not present in either tree at this path, skip as it
1839
# | | | may not be selected by the users list of paths.
1840
# fdlt | fdlt | | content in both: diff them
1841
# fdlt | fdlt | a | deleted locally, but not unversioned - show as deleted ?
1842
# fdlt | a | | unversioned: output deleted id for now
1843
# fdlt | a | a | unversioned and deleted: output deleted id
1844
# fdlt | r | | relocated in this tree, so add target to search.
1845
# | | | Dont diff, we will see an r,fd; pair when we reach
1846
# | | | this id at the other path.
1847
# fdlt | r | a | relocated in this tree, so add target to search.
1848
# | | | Dont diff, we will see an r,fd; pair when we reach
1849
# | | | this id at the other path.
1851
# for all search_indexs in each path at or under each element of
1852
# search_specific_files, if the detail is relocated: add the id, and add the
1853
# relocated path as one to search if its not searched already. If the
1854
# detail is not relocated, add the id.
1855
searched_specific_files = set()
1856
NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
1857
# Using a list so that we can access the values and change them in
1858
# nested scope. Each one is [path, file_id, entry]
1859
last_source_parent = [None, None]
1860
last_target_parent = [None, None]
1862
use_filesystem_for_exec = (sys.platform != 'win32')
1864
# Just a sentry, so that _process_entry can say that this
1865
# record is handled, but isn't interesting to process (unchanged)
1866
uninteresting = object()
1869
old_dirname_to_file_id = {}
1870
new_dirname_to_file_id = {}
1871
# TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
1872
# keeping a cache of directories that we have seen.
1874
def _process_entry(entry, path_info):
1875
"""Compare an entry and real disk to generate delta information.
1877
:param path_info: top_relpath, basename, kind, lstat, abspath for
1878
the path of entry. If None, then the path is considered absent.
1879
(Perhaps we should pass in a concrete entry for this ?)
1880
Basename is returned as a utf8 string because we expect this
1881
tuple will be ignored, and don't want to take the time to
1883
:return: None if these don't match
1884
A tuple of information about the change, or
1885
the object 'uninteresting' if these match, but are
1886
basically identical.
1888
if source_index is None:
1889
source_details = NULL_PARENT_DETAILS
1891
source_details = entry[1][source_index]
1892
target_details = entry[1][target_index]
1893
target_minikind = target_details[0]
1894
if path_info is not None and target_minikind in 'fdlt':
1895
assert target_index == 0
1896
link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
1897
stat_value=path_info[3])
1898
# The entry may have been modified by update_entry
1899
target_details = entry[1][target_index]
1900
target_minikind = target_details[0]
1903
file_id = entry[0][2]
1904
source_minikind = source_details[0]
1905
if source_minikind in 'fdltr' and target_minikind in 'fdlt':
1906
# claimed content in both: diff
1907
# r | fdlt | | add source to search, add id path move and perform
1908
# | | | diff check on source-target
1909
# r | fdlt | a | dangling file that was present in the basis.
1911
if source_minikind in 'r':
1912
# add the source to the search path to find any children it
1913
# has. TODO ? : only add if it is a container ?
1914
if not osutils.is_inside_any(searched_specific_files,
1916
search_specific_files.add(source_details[1])
1917
# generate the old path; this is needed for stating later
1919
old_path = source_details[1]
1920
old_dirname, old_basename = os.path.split(old_path)
1921
path = pathjoin(entry[0][0], entry[0][1])
1922
old_entry = state._get_entry(source_index,
1924
# update the source details variable to be the real
1926
source_details = old_entry[1][source_index]
1927
source_minikind = source_details[0]
1929
old_dirname = entry[0][0]
1930
old_basename = entry[0][1]
1931
old_path = path = None
1932
if path_info is None:
1933
# the file is missing on disk, show as removed.
1934
content_change = True
1938
# source and target are both versioned and disk file is present.
1939
target_kind = path_info[2]
1940
if target_kind == 'directory':
1942
old_path = path = pathjoin(old_dirname, old_basename)
1943
new_dirname_to_file_id[path] = file_id
1944
if source_minikind != 'd':
1945
content_change = True
1947
# directories have no fingerprint
1948
content_change = False
1950
elif target_kind == 'file':
1951
if source_minikind != 'f':
1952
content_change = True
1954
# We could check the size, but we already have the
1956
content_change = (link_or_sha1 != source_details[1])
1957
# Target details is updated at update_entry time
1958
if use_filesystem_for_exec:
1959
# We don't need S_ISREG here, because we are sure
1960
# we are dealing with a file.
1961
target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
1963
target_exec = target_details[3]
1964
elif target_kind == 'symlink':
1965
if source_minikind != 'l':
1966
content_change = True
1968
content_change = (link_or_sha1 != source_details[1])
1970
elif target_kind == 'tree-reference':
1971
if source_minikind != 't':
1972
content_change = True
1974
content_change = False
1977
raise Exception, "unknown kind %s" % path_info[2]
1978
if source_minikind == 'd':
1980
old_path = path = pathjoin(old_dirname, old_basename)
1981
old_dirname_to_file_id[old_path] = file_id
1982
# parent id is the entry for the path in the target tree
1983
if old_dirname == last_source_parent[0]:
1984
source_parent_id = last_source_parent[1]
1987
source_parent_id = old_dirname_to_file_id[old_dirname]
1989
source_parent_entry = state._get_entry(source_index,
1990
path_utf8=old_dirname)
1991
source_parent_id = source_parent_entry[0][2]
1992
if source_parent_id == entry[0][2]:
1993
# This is the root, so the parent is None
1994
source_parent_id = None
1996
last_source_parent[0] = old_dirname
1997
last_source_parent[1] = source_parent_id
1998
new_dirname = entry[0][0]
1999
if new_dirname == last_target_parent[0]:
2000
target_parent_id = last_target_parent[1]
2003
target_parent_id = new_dirname_to_file_id[new_dirname]
2005
# TODO: We don't always need to do the lookup, because the
2006
# parent entry will be the same as the source entry.
2007
target_parent_entry = state._get_entry(target_index,
2008
path_utf8=new_dirname)
2009
assert target_parent_entry != (None, None), (
2010
"Could not find target parent in wt: %s\nparent of: %s"
2011
% (new_dirname, entry))
2012
target_parent_id = target_parent_entry[0][2]
2013
if target_parent_id == entry[0][2]:
2014
# This is the root, so the parent is None
2015
target_parent_id = None
2017
last_target_parent[0] = new_dirname
2018
last_target_parent[1] = target_parent_id
2020
source_exec = source_details[3]
2021
if (include_unchanged
2023
or source_parent_id != target_parent_id
2024
or old_basename != entry[0][1]
2025
or source_exec != target_exec
2027
if old_path is None:
2028
old_path = path = pathjoin(old_dirname, old_basename)
2029
old_path_u = utf8_decode(old_path)[0]
2032
old_path_u = utf8_decode(old_path)[0]
2033
if old_path == path:
2036
path_u = utf8_decode(path)[0]
2037
source_kind = _minikind_to_kind[source_minikind]
2038
return (entry[0][2],
2039
(old_path_u, path_u),
2042
(source_parent_id, target_parent_id),
2043
(utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
2044
(source_kind, target_kind),
2045
(source_exec, target_exec))
2047
return uninteresting
2048
elif source_minikind in 'a' and target_minikind in 'fdlt':
2049
# looks like a new file
2050
if path_info is not None:
2051
path = pathjoin(entry[0][0], entry[0][1])
2052
# parent id is the entry for the path in the target tree
2053
# TODO: these are the same for an entire directory: cache em.
2054
parent_id = state._get_entry(target_index,
2055
path_utf8=entry[0][0])[0][2]
2056
if parent_id == entry[0][2]:
2058
if use_filesystem_for_exec:
2059
# We need S_ISREG here, because we aren't sure if this
2062
stat.S_ISREG(path_info[3].st_mode)
2063
and stat.S_IEXEC & path_info[3].st_mode)
2065
target_exec = target_details[3]
2066
return (entry[0][2],
2067
(None, utf8_decode(path)[0]),
2071
(None, utf8_decode(entry[0][1])[0]),
2072
(None, path_info[2]),
2073
(None, target_exec))
2075
# but its not on disk: we deliberately treat this as just
2076
# never-present. (Why ?! - RBC 20070224)
2078
elif source_minikind in 'fdlt' and target_minikind in 'a':
2079
# unversioned, possibly, or possibly not deleted: we dont care.
2080
# if its still on disk, *and* theres no other entry at this
2081
# path [we dont know this in this routine at the moment -
2082
# perhaps we should change this - then it would be an unknown.
2083
old_path = pathjoin(entry[0][0], entry[0][1])
2084
# parent id is the entry for the path in the target tree
2085
parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
2086
if parent_id == entry[0][2]:
2088
return (entry[0][2],
2089
(utf8_decode(old_path)[0], None),
2093
(utf8_decode(entry[0][1])[0], None),
2094
(_minikind_to_kind[source_minikind], None),
2095
(source_details[3], None))
2096
elif source_minikind in 'fdlt' and target_minikind in 'r':
2097
# a rename; could be a true rename, or a rename inherited from
2098
# a renamed parent. TODO: handle this efficiently. Its not
2099
# common case to rename dirs though, so a correct but slow
2100
# implementation will do.
2101
if not osutils.is_inside_any(searched_specific_files, target_details[1]):
2102
search_specific_files.add(target_details[1])
2103
elif source_minikind in 'ra' and target_minikind in 'ra':
2104
# neither of the selected trees contain this file,
2105
# so skip over it. This is not currently directly tested, but
2106
# is indirectly via test_too_much.TestCommands.test_conflicts.
2109
raise AssertionError("don't know how to compare "
2110
"source_minikind=%r, target_minikind=%r"
2111
% (source_minikind, target_minikind))
2112
## import pdb;pdb.set_trace()
2115
while search_specific_files:
2116
# TODO: the pending list should be lexically sorted? the
2117
# interface doesn't require it.
2118
current_root = search_specific_files.pop()
2119
current_root_unicode = current_root.decode('utf8')
2120
searched_specific_files.add(current_root)
2121
# process the entries for this containing directory: the rest will be
2122
# found by their parents recursively.
2123
root_entries = _entries_for_path(current_root)
2124
root_abspath = self.target.abspath(current_root_unicode)
2126
root_stat = os.lstat(root_abspath)
2128
if e.errno == errno.ENOENT:
2129
# the path does not exist: let _process_entry know that.
2130
root_dir_info = None
2132
# some other random error: hand it up.
2135
root_dir_info = ('', current_root,
2136
osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
2138
if root_dir_info[2] == 'directory':
2139
if self.target._directory_is_tree_reference(
2140
current_root.decode('utf8')):
2141
root_dir_info = root_dir_info[:2] + \
2142
('tree-reference',) + root_dir_info[3:]
2144
if not root_entries and not root_dir_info:
2145
# this specified path is not present at all, skip it.
2147
path_handled = False
2148
for entry in root_entries:
2149
result = _process_entry(entry, root_dir_info)
2150
if result is not None:
2152
if result is not uninteresting:
2154
if want_unversioned and not path_handled and root_dir_info:
2155
new_executable = bool(
2156
stat.S_ISREG(root_dir_info[3].st_mode)
2157
and stat.S_IEXEC & root_dir_info[3].st_mode)
2159
(None, current_root_unicode),
2163
(None, splitpath(current_root_unicode)[-1]),
2164
(None, root_dir_info[2]),
2165
(None, new_executable)
2167
initial_key = (current_root, '', '')
2168
block_index, _ = state._find_block_index_from_key(initial_key)
2169
if block_index == 0:
2170
# we have processed the total root already, but because the
2171
# initial key matched it we should skip it here.
2173
if root_dir_info and root_dir_info[2] == 'tree-reference':
2174
current_dir_info = None
2176
dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
2178
current_dir_info = dir_iterator.next()
2180
# on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
2181
# python 2.5 has e.errno == EINVAL,
2182
# and e.winerror == ERROR_DIRECTORY
2183
e_winerror = getattr(e, 'winerror', None)
2184
win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
2185
# there may be directories in the inventory even though
2186
# this path is not a file on disk: so mark it as end of
2188
if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
2189
current_dir_info = None
2190
elif (sys.platform == 'win32'
2191
and (e.errno in win_errors
2192
or e_winerror in win_errors)):
2193
current_dir_info = None
2197
if current_dir_info[0][0] == '':
2198
# remove .bzr from iteration
2199
bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
2200
assert current_dir_info[1][bzr_index][0] == '.bzr'
2201
del current_dir_info[1][bzr_index]
2202
# walk until both the directory listing and the versioned metadata
2204
if (block_index < len(state._dirblocks) and
2205
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2206
current_block = state._dirblocks[block_index]
2208
current_block = None
2209
while (current_dir_info is not None or
2210
current_block is not None):
2211
if (current_dir_info and current_block
2212
and current_dir_info[0][0] != current_block[0]):
2213
if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
2214
# filesystem data refers to paths not covered by the dirblock.
2215
# this has two possibilities:
2216
# A) it is versioned but empty, so there is no block for it
2217
# B) it is not versioned.
2219
# if (A) then we need to recurse into it to check for
2220
# new unknown files or directories.
2221
# if (B) then we should ignore it, because we don't
2222
# recurse into unknown directories.
2224
while path_index < len(current_dir_info[1]):
2225
current_path_info = current_dir_info[1][path_index]
2226
if want_unversioned:
2227
if current_path_info[2] == 'directory':
2228
if self.target._directory_is_tree_reference(
2229
current_path_info[0].decode('utf8')):
2230
current_path_info = current_path_info[:2] + \
2231
('tree-reference',) + current_path_info[3:]
2232
new_executable = bool(
2233
stat.S_ISREG(current_path_info[3].st_mode)
2234
and stat.S_IEXEC & current_path_info[3].st_mode)
2236
(None, utf8_decode(current_path_info[0])[0]),
2240
(None, utf8_decode(current_path_info[1])[0]),
2241
(None, current_path_info[2]),
2242
(None, new_executable))
2243
# dont descend into this unversioned path if it is
2245
if current_path_info[2] in ('directory',
2247
del current_dir_info[1][path_index]
2251
# This dir info has been handled, go to the next
2253
current_dir_info = dir_iterator.next()
2254
except StopIteration:
2255
current_dir_info = None
2257
# We have a dirblock entry for this location, but there
2258
# is no filesystem path for this. This is most likely
2259
# because a directory was removed from the disk.
2260
# We don't have to report the missing directory,
2261
# because that should have already been handled, but we
2262
# need to handle all of the files that are contained
2264
for current_entry in current_block[1]:
2265
# entry referring to file not present on disk.
2266
# advance the entry only, after processing.
2267
result = _process_entry(current_entry, None)
2268
if result is not None:
2269
if result is not uninteresting:
2272
if (block_index < len(state._dirblocks) and
2273
osutils.is_inside(current_root,
2274
state._dirblocks[block_index][0])):
2275
current_block = state._dirblocks[block_index]
2277
current_block = None
2280
if current_block and entry_index < len(current_block[1]):
2281
current_entry = current_block[1][entry_index]
2283
current_entry = None
2284
advance_entry = True
2286
if current_dir_info and path_index < len(current_dir_info[1]):
2287
current_path_info = current_dir_info[1][path_index]
2288
if current_path_info[2] == 'directory':
2289
if self.target._directory_is_tree_reference(
2290
current_path_info[0].decode('utf8')):
2291
current_path_info = current_path_info[:2] + \
2292
('tree-reference',) + current_path_info[3:]
2294
current_path_info = None
2296
path_handled = False
2297
while (current_entry is not None or
2298
current_path_info is not None):
2299
if current_entry is None:
2300
# the check for path_handled when the path is adnvaced
2301
# will yield this path if needed.
2303
elif current_path_info is None:
2304
# no path is fine: the per entry code will handle it.
2305
result = _process_entry(current_entry, current_path_info)
2306
if result is not None:
2307
if result is not uninteresting:
2309
elif (current_entry[0][1] != current_path_info[1]
2310
or current_entry[1][target_index][0] in 'ar'):
2311
# The current path on disk doesn't match the dirblock
2312
# record. Either the dirblock is marked as absent, or
2313
# the file on disk is not present at all in the
2314
# dirblock. Either way, report about the dirblock
2315
# entry, and let other code handle the filesystem one.
2317
# Compare the basename for these files to determine
2319
if current_path_info[1] < current_entry[0][1]:
2320
# extra file on disk: pass for now, but only
2321
# increment the path, not the entry
2322
advance_entry = False
2324
# entry referring to file not present on disk.
2325
# advance the entry only, after processing.
2326
result = _process_entry(current_entry, None)
2327
if result is not None:
2328
if result is not uninteresting:
2330
advance_path = False
2332
result = _process_entry(current_entry, current_path_info)
2333
if result is not None:
2335
if result is not uninteresting:
2337
if advance_entry and current_entry is not None:
2339
if entry_index < len(current_block[1]):
2340
current_entry = current_block[1][entry_index]
2342
current_entry = None
2344
advance_entry = True # reset the advance flaga
2345
if advance_path and current_path_info is not None:
2346
if not path_handled:
2347
# unversioned in all regards
2348
if want_unversioned:
2349
new_executable = bool(
2350
stat.S_ISREG(current_path_info[3].st_mode)
2351
and stat.S_IEXEC & current_path_info[3].st_mode)
2353
(None, utf8_decode(current_path_info[0])[0]),
2357
(None, utf8_decode(current_path_info[1])[0]),
2358
(None, current_path_info[2]),
2359
(None, new_executable))
2360
# dont descend into this unversioned path if it is
2362
if current_path_info[2] in ('directory'):
2363
del current_dir_info[1][path_index]
2365
# dont descend the disk iterator into any tree
2367
if current_path_info[2] == 'tree-reference':
2368
del current_dir_info[1][path_index]
2371
if path_index < len(current_dir_info[1]):
2372
current_path_info = current_dir_info[1][path_index]
2373
if current_path_info[2] == 'directory':
2374
if self.target._directory_is_tree_reference(
2375
current_path_info[0].decode('utf8')):
2376
current_path_info = current_path_info[:2] + \
2377
('tree-reference',) + current_path_info[3:]
2379
current_path_info = None
2380
path_handled = False
2382
advance_path = True # reset the advance flagg.
2383
if current_block is not None:
2385
if (block_index < len(state._dirblocks) and
2386
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2387
current_block = state._dirblocks[block_index]
2389
current_block = None
2390
if current_dir_info is not None:
2392
current_dir_info = dir_iterator.next()
2393
except StopIteration:
2394
current_dir_info = None
2398
def is_compatible(source, target):
2399
# the target must be a dirstate working tree
2400
if not isinstance(target, WorkingTree4):
2402
# the source must be a revtreee or dirstate rev tree.
2403
if not isinstance(source,
2404
(revisiontree.RevisionTree, DirStateRevisionTree)):
2406
# the source revid must be in the target dirstate
2407
if not (source._revision_id == NULL_REVISION or
2408
source._revision_id in target.get_parent_ids()):
2409
# TODO: what about ghosts? it may well need to
2410
# check for them explicitly.
2414
InterTree.register_optimiser(InterDirStateTree)
2417
class Converter3to4(object):
2418
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2421
self.target_format = WorkingTreeFormat4()
2423
def convert(self, tree):
2424
# lock the control files not the tree, so that we dont get tree
2425
# on-unlock behaviours, and so that noone else diddles with the
2426
# tree during upgrade.
2427
tree._control_files.lock_write()
2429
tree.read_working_inventory()
2430
self.create_dirstate_data(tree)
2431
self.update_format(tree)
2432
self.remove_xml_files(tree)
2434
tree._control_files.unlock()
2436
def create_dirstate_data(self, tree):
2437
"""Create the dirstate based data for tree."""
2438
local_path = tree.bzrdir.get_workingtree_transport(None
2439
).local_abspath('dirstate')
2440
state = dirstate.DirState.from_tree(tree, local_path)
2444
def remove_xml_files(self, tree):
2445
"""Remove the oldformat 3 data."""
2446
transport = tree.bzrdir.get_workingtree_transport(None)
2447
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2448
'pending-merges', 'stat-cache']:
2450
transport.delete(path)
2451
except errors.NoSuchFile:
2452
# some files are optional - just deal.
2455
def update_format(self, tree):
2456
"""Change the format marker."""
2457
tree._control_files.put_utf8('format',
2458
self.target_format.get_format_string())