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)
726
def rollback_rename():
727
"""A single rename has failed, roll it back."""
728
# roll back everything, even if we encounter trouble doing one
731
# TODO: at least log the other exceptions rather than just
732
# losing them mbp 20070307
734
for rollback in reversed(rollbacks):
738
exc_info = sys.exc_info()
740
raise exc_info[0], exc_info[1], exc_info[2]
742
# perform the disk move first - its the most likely failure point.
744
from_rel_abs = self.abspath(from_rel)
745
to_rel_abs = self.abspath(to_rel)
747
osutils.rename(from_rel_abs, to_rel_abs)
749
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
750
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
752
# perform the rename in the inventory next if needed: its easy
756
from_entry = inv[from_id]
757
current_parent = from_entry.parent_id
758
inv.rename(from_id, to_dir_id, from_tail)
760
lambda: inv.rename(from_id, current_parent, from_tail))
761
# finally do the rename in the dirstate, which is a little
762
# tricky to rollback, but least likely to need it.
763
old_block_index, old_entry_index, dir_present, file_present = \
764
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
765
old_block = state._dirblocks[old_block_index][1]
766
old_entry = old_block[old_entry_index]
767
from_key, old_entry_details = old_entry
768
cur_details = old_entry_details[0]
770
to_key = ((to_block[0],) + from_key[1:3])
771
minikind = cur_details[0]
772
move_one(old_entry, from_path_utf8=from_rel_utf8,
774
executable=cur_details[3],
775
fingerprint=cur_details[1],
776
packed_stat=cur_details[4],
780
to_path_utf8=to_rel_utf8)
783
def update_dirblock(from_dir, to_key, to_dir_utf8):
784
"""Recursively update all entries in this dirblock."""
785
assert from_dir != '', "renaming root not supported"
786
from_key = (from_dir, '')
787
from_block_idx, present = \
788
state._find_block_index_from_key(from_key)
790
# This is the old record, if it isn't present, then
791
# there is theoretically nothing to update.
792
# (Unless it isn't present because of lazy loading,
793
# but we don't do that yet)
795
from_block = state._dirblocks[from_block_idx]
796
to_block_index, to_entry_index, _, _ = \
797
state._get_block_entry_index(to_key[0], to_key[1], 0)
798
to_block_index = state._ensure_block(
799
to_block_index, to_entry_index, to_dir_utf8)
800
to_block = state._dirblocks[to_block_index]
802
# Grab a copy since move_one may update the list.
803
for entry in from_block[1][:]:
804
assert entry[0][0] == from_dir
805
cur_details = entry[1][0]
806
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
807
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
808
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
809
minikind = cur_details[0]
811
# Deleted children of a renamed directory
812
# Do not need to be updated.
813
# Children that have been renamed out of this
814
# directory should also not be updated
816
move_one(entry, from_path_utf8=from_path_utf8,
818
executable=cur_details[3],
819
fingerprint=cur_details[1],
820
packed_stat=cur_details[4],
824
to_path_utf8=to_path_utf8)
826
# We need to move all the children of this
828
update_dirblock(from_path_utf8, to_key,
830
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
834
result.append((from_rel, to_rel))
835
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
836
self._make_dirty(reset_inventory=False)
840
def _must_be_locked(self):
841
if not self._control_files._lock_count:
842
raise errors.ObjectNotLocked(self)
845
"""Initialize the state in this tree to be a new tree."""
849
def path2id(self, path):
850
"""Return the id for path in this tree."""
851
path = path.strip('/')
852
entry = self._get_entry(path=path)
853
if entry == (None, None):
857
def paths2ids(self, paths, trees=[], require_versioned=True):
858
"""See Tree.paths2ids().
860
This specialisation fast-paths the case where all the trees are in the
865
parents = self.get_parent_ids()
867
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
869
return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
870
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
871
# -- make all paths utf8 --
874
paths_utf8.add(path.encode('utf8'))
876
# -- paths is now a utf8 path set --
877
# -- get the state object and prepare it.
878
state = self.current_dirstate()
879
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
880
and '' not in paths):
881
paths2ids = self._paths2ids_using_bisect
883
paths2ids = self._paths2ids_in_memory
884
return paths2ids(paths, search_indexes,
885
require_versioned=require_versioned)
887
def _paths2ids_in_memory(self, paths, search_indexes,
888
require_versioned=True):
889
state = self.current_dirstate()
890
state._read_dirblocks_if_needed()
891
def _entries_for_path(path):
892
"""Return a list with all the entries that match path for all ids.
894
dirname, basename = os.path.split(path)
895
key = (dirname, basename, '')
896
block_index, present = state._find_block_index_from_key(key)
898
# the block which should contain path is absent.
901
block = state._dirblocks[block_index][1]
902
entry_index, _ = state._find_entry_index(key, block)
903
# we may need to look at multiple entries at this path: walk while the paths match.
904
while (entry_index < len(block) and
905
block[entry_index][0][0:2] == key[0:2]):
906
result.append(block[entry_index])
909
if require_versioned:
910
# -- check all supplied paths are versioned in a search tree. --
913
path_entries = _entries_for_path(path)
915
# this specified path is not present at all: error
916
all_versioned = False
918
found_versioned = False
919
# for each id at this path
920
for entry in path_entries:
922
for index in search_indexes:
923
if entry[1][index][0] != 'a': # absent
924
found_versioned = True
925
# all good: found a versioned cell
927
if not found_versioned:
928
# none of the indexes was not 'absent' at all ids for this
930
all_versioned = False
932
if not all_versioned:
933
raise errors.PathsNotVersionedError(paths)
934
# -- remove redundancy in supplied paths to prevent over-scanning --
935
search_paths = osutils.minimum_path_selection(paths)
937
# for all search_indexs in each path at or under each element of
938
# search_paths, if the detail is relocated: add the id, and add the
939
# relocated path as one to search if its not searched already. If the
940
# detail is not relocated, add the id.
941
searched_paths = set()
943
def _process_entry(entry):
944
"""Look at search_indexes within entry.
946
If a specific tree's details are relocated, add the relocation
947
target to search_paths if not searched already. If it is absent, do
948
nothing. Otherwise add the id to found_ids.
950
for index in search_indexes:
951
if entry[1][index][0] == 'r': # relocated
952
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
953
search_paths.add(entry[1][index][1])
954
elif entry[1][index][0] != 'a': # absent
955
found_ids.add(entry[0][2])
957
current_root = search_paths.pop()
958
searched_paths.add(current_root)
959
# process the entries for this containing directory: the rest will be
960
# found by their parents recursively.
961
root_entries = _entries_for_path(current_root)
963
# this specified path is not present at all, skip it.
965
for entry in root_entries:
966
_process_entry(entry)
967
initial_key = (current_root, '', '')
968
block_index, _ = state._find_block_index_from_key(initial_key)
969
while (block_index < len(state._dirblocks) and
970
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
971
for entry in state._dirblocks[block_index][1]:
972
_process_entry(entry)
976
def _paths2ids_using_bisect(self, paths, search_indexes,
977
require_versioned=True):
978
state = self.current_dirstate()
981
split_paths = sorted(osutils.split(p) for p in paths)
982
found = state._bisect_recursive(split_paths)
984
if require_versioned:
985
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
986
for dir_name in split_paths:
987
if dir_name not in found_dir_names:
988
raise errors.PathsNotVersionedError(paths)
990
for dir_name_id, trees_info in found.iteritems():
991
for index in search_indexes:
992
if trees_info[index][0] not in ('r', 'a'):
993
found_ids.add(dir_name_id[2])
996
def read_working_inventory(self):
997
"""Read the working inventory.
999
This is a meaningless operation for dirstate, but we obey it anyhow.
1001
return self.inventory
1004
def revision_tree(self, revision_id):
1005
"""See Tree.revision_tree.
1007
WorkingTree4 supplies revision_trees for any basis tree.
1009
dirstate = self.current_dirstate()
1010
parent_ids = dirstate.get_parent_ids()
1011
if revision_id not in parent_ids:
1012
raise errors.NoSuchRevisionInTree(self, revision_id)
1013
if revision_id in dirstate.get_ghosts():
1014
raise errors.NoSuchRevisionInTree(self, revision_id)
1015
return DirStateRevisionTree(dirstate, revision_id,
1016
self.branch.repository)
1018
@needs_tree_write_lock
1019
def set_last_revision(self, new_revision):
1020
"""Change the last revision in the working tree."""
1021
parents = self.get_parent_ids()
1022
if new_revision in (NULL_REVISION, None):
1023
assert len(parents) < 2, (
1024
"setting the last parent to none with a pending merge is "
1026
self.set_parent_ids([])
1028
self.set_parent_ids([new_revision] + parents[1:],
1029
allow_leftmost_as_ghost=True)
1031
@needs_tree_write_lock
1032
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1033
"""Set the parent ids to revision_ids.
1035
See also set_parent_trees. This api will try to retrieve the tree data
1036
for each element of revision_ids from the trees repository. If you have
1037
tree data already available, it is more efficient to use
1038
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1039
an easier API to use.
1041
:param revision_ids: The revision_ids to set as the parent ids of this
1042
working tree. Any of these may be ghosts.
1045
for revision_id in revision_ids:
1047
revtree = self.branch.repository.revision_tree(revision_id)
1048
# TODO: jam 20070213 KnitVersionedFile raises
1049
# RevisionNotPresent rather than NoSuchRevision if a
1050
# given revision_id is not present. Should Repository be
1051
# catching it and re-raising NoSuchRevision?
1052
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1054
trees.append((revision_id, revtree))
1055
self.set_parent_trees(trees,
1056
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1058
@needs_tree_write_lock
1059
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1060
"""Set the parents of the working tree.
1062
:param parents_list: A list of (revision_id, tree) tuples.
1063
If tree is None, then that element is treated as an unreachable
1064
parent tree - i.e. a ghost.
1066
dirstate = self.current_dirstate()
1067
if len(parents_list) > 0:
1068
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1069
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1072
# convert absent trees to the null tree, which we convert back to
1073
# missing on access.
1074
for rev_id, tree in parents_list:
1075
_mod_revision.check_not_reserved_id(rev_id)
1076
if tree is not None:
1077
real_trees.append((rev_id, tree))
1079
real_trees.append((rev_id,
1080
self.branch.repository.revision_tree(None)))
1081
ghosts.append(rev_id)
1082
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1083
self._make_dirty(reset_inventory=False)
1085
def _set_root_id(self, file_id):
1086
"""See WorkingTree.set_root_id."""
1087
state = self.current_dirstate()
1088
state.set_path_id('', file_id)
1089
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1090
self._make_dirty(reset_inventory=True)
1092
def _sha_from_stat(self, path, stat_result):
1093
"""Get a sha digest from the tree's stat cache.
1095
The default implementation assumes no stat cache is present.
1097
:param path: The path.
1098
:param stat_result: The stat result being looked up.
1100
return self.current_dirstate().sha1_from_stat(path, stat_result)
1103
def supports_tree_reference(self):
1104
return self._repo_supports_tree_reference
1107
"""Unlock in format 4 trees needs to write the entire dirstate."""
1108
# do non-implementation specific cleanup
1111
if self._control_files._lock_count == 1:
1112
# eventually we should do signature checking during read locks for
1114
if self._control_files._lock_mode == 'w':
1117
if self._dirstate is not None:
1118
# This is a no-op if there are no modifications.
1119
self._dirstate.save()
1120
self._dirstate.unlock()
1121
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1122
# point. Instead, it could check if the header has been
1123
# modified when it is locked, and if not, it can hang on to
1124
# the data it has in memory.
1125
self._dirstate = None
1126
self._inventory = None
1127
# reverse order of locking.
1129
return self._control_files.unlock()
1131
self.branch.unlock()
1133
@needs_tree_write_lock
1134
def unversion(self, file_ids):
1135
"""Remove the file ids in file_ids from the current versioned set.
1137
When a file_id is unversioned, all of its children are automatically
1140
:param file_ids: The file ids to stop versioning.
1141
:raises: NoSuchId if any fileid is not currently versioned.
1145
state = self.current_dirstate()
1146
state._read_dirblocks_if_needed()
1147
ids_to_unversion = set(file_ids)
1148
paths_to_unversion = set()
1150
# check if the root is to be unversioned, if so, assert for now.
1151
# walk the state marking unversioned things as absent.
1152
# if there are any un-unversioned ids at the end, raise
1153
for key, details in state._dirblocks[0][1]:
1154
if (details[0][0] not in ('a', 'r') and # absent or relocated
1155
key[2] in ids_to_unversion):
1156
# I haven't written the code to unversion / yet - it should be
1158
raise errors.BzrError('Unversioning the / is not currently supported')
1160
while block_index < len(state._dirblocks):
1161
# process one directory at a time.
1162
block = state._dirblocks[block_index]
1163
# first check: is the path one to remove - it or its children
1164
delete_block = False
1165
for path in paths_to_unversion:
1166
if (block[0].startswith(path) and
1167
(len(block[0]) == len(path) or
1168
block[0][len(path)] == '/')):
1169
# this entire block should be deleted - its the block for a
1170
# path to unversion; or the child of one
1173
# TODO: trim paths_to_unversion as we pass by paths
1175
# this block is to be deleted: process it.
1176
# TODO: we can special case the no-parents case and
1177
# just forget the whole block.
1179
while entry_index < len(block[1]):
1180
# Mark this file id as having been removed
1181
entry = block[1][entry_index]
1182
ids_to_unversion.discard(entry[0][2])
1183
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1185
or not state._make_absent(entry)):
1187
# go to the next block. (At the moment we dont delete empty
1192
while entry_index < len(block[1]):
1193
entry = block[1][entry_index]
1194
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1195
# ^ some parent row.
1196
entry[0][2] not in ids_to_unversion):
1197
# ^ not an id to unversion
1200
if entry[1][0][0] == 'd':
1201
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1202
if not state._make_absent(entry):
1204
# we have unversioned this id
1205
ids_to_unversion.remove(entry[0][2])
1207
if ids_to_unversion:
1208
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1209
self._make_dirty(reset_inventory=False)
1210
# have to change the legacy inventory too.
1211
if self._inventory is not None:
1212
for file_id in file_ids:
1213
self._inventory.remove_recursive_id(file_id)
1215
def update_basis_by_delta(self, new_revid, delta):
1216
"""See MutableTree.update_basis_by_delta."""
1217
assert self.last_revision() != new_revid
1218
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1221
def _validate(self):
1222
self._dirstate._validate()
1224
@needs_tree_write_lock
1225
def _write_inventory(self, inv):
1226
"""Write inventory as the current inventory."""
1227
assert not self._dirty, ("attempting to write an inventory when the "
1228
"dirstate is dirty will cause data loss")
1229
self.current_dirstate().set_state_from_inventory(inv)
1230
self._make_dirty(reset_inventory=False)
1231
if self._inventory is not None:
1232
self._inventory = inv
1236
class WorkingTreeFormat4(WorkingTreeFormat3):
1237
"""The first consolidated dirstate working tree format.
1240
- exists within a metadir controlling .bzr
1241
- includes an explicit version marker for the workingtree control
1242
files, separate from the BzrDir format
1243
- modifies the hash cache format
1244
- is new in bzr 0.15
1245
- uses a LockDir to guard access to it.
1248
upgrade_recommended = False
1250
def get_format_string(self):
1251
"""See WorkingTreeFormat.get_format_string()."""
1252
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1254
def get_format_description(self):
1255
"""See WorkingTreeFormat.get_format_description()."""
1256
return "Working tree format 4"
1258
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
1259
"""See WorkingTreeFormat.initialize().
1261
:param revision_id: allows creating a working tree at a different
1262
revision than the branch is at.
1264
These trees get an initial random root id, if their repository supports
1265
rich root data, TREE_ROOT otherwise.
1267
if not isinstance(a_bzrdir.transport, LocalTransport):
1268
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1269
transport = a_bzrdir.get_workingtree_transport(self)
1270
control_files = self._open_control_files(a_bzrdir)
1271
control_files.create_lock()
1272
control_files.lock_write()
1273
control_files.put_utf8('format', self.get_format_string())
1274
if from_branch is not None:
1275
branch = from_branch
1277
branch = a_bzrdir.open_branch()
1278
if revision_id is None:
1279
revision_id = branch.last_revision()
1280
local_path = transport.local_abspath('dirstate')
1281
# write out new dirstate (must exist when we create the tree)
1282
state = dirstate.DirState.initialize(local_path)
1285
wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1289
_control_files=control_files)
1291
wt.lock_tree_write()
1293
if revision_id in (None, NULL_REVISION):
1294
if branch.repository.supports_rich_root():
1295
wt._set_root_id(generate_ids.gen_root_id())
1297
wt._set_root_id(ROOT_ID)
1299
wt.set_last_revision(revision_id)
1301
basis = wt.basis_tree()
1303
# if the basis has a root id we have to use that; otherwise we use
1305
basis_root_id = basis.get_root_id()
1306
if basis_root_id is not None:
1307
wt._set_root_id(basis_root_id)
1309
transform.build_tree(basis, wt)
1312
control_files.unlock()
1316
def _open(self, a_bzrdir, control_files):
1317
"""Open the tree itself.
1319
:param a_bzrdir: the dir for the tree.
1320
:param control_files: the control files for the tree.
1322
return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1323
branch=a_bzrdir.open_branch(),
1326
_control_files=control_files)
1328
def __get_matchingbzrdir(self):
1329
# please test against something that will let us do tree references
1330
return bzrdir.format_registry.make_bzrdir(
1331
'dirstate-with-subtree')
1333
_matchingbzrdir = property(__get_matchingbzrdir)
1336
class DirStateRevisionTree(Tree):
1337
"""A revision tree pulling the inventory from a dirstate."""
1339
def __init__(self, dirstate, revision_id, repository):
1340
self._dirstate = dirstate
1341
self._revision_id = revision_id
1342
self._repository = repository
1343
self._inventory = None
1345
self._dirstate_locked = False
1348
return "<%s of %s in %s>" % \
1349
(self.__class__.__name__, self._revision_id, self._dirstate)
1351
def annotate_iter(self, file_id,
1352
default_revision=_mod_revision.CURRENT_REVISION):
1353
"""See Tree.annotate_iter"""
1354
w = self._get_weave(file_id)
1355
return w.annotate_iter(self.inventory[file_id].revision)
1357
def _get_ancestors(self, default_revision):
1358
return set(self._repository.get_ancestry(self._revision_id,
1360
def _comparison_data(self, entry, path):
1361
"""See Tree._comparison_data."""
1363
return None, False, None
1364
# trust the entry as RevisionTree does, but this may not be
1365
# sensible: the entry might not have come from us?
1366
return entry.kind, entry.executable, None
1368
def _file_size(self, entry, stat_value):
1369
return entry.text_size
1371
def filter_unversioned_files(self, paths):
1372
"""Filter out paths that are not versioned.
1374
:return: set of paths.
1376
pred = self.has_filename
1377
return set((p for p in paths if not pred(p)))
1379
def get_root_id(self):
1380
return self.path2id('')
1382
def id2path(self, file_id):
1383
"Convert a file-id to a path."
1384
entry = self._get_entry(file_id=file_id)
1385
if entry == (None, None):
1386
raise errors.NoSuchId(tree=self, file_id=file_id)
1387
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1388
return path_utf8.decode('utf8')
1390
def _get_parent_index(self):
1391
"""Return the index in the dirstate referenced by this tree."""
1392
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1394
def _get_entry(self, file_id=None, path=None):
1395
"""Get the dirstate row for file_id or path.
1397
If either file_id or path is supplied, it is used as the key to lookup.
1398
If both are supplied, the fastest lookup is used, and an error is
1399
raised if they do not both point at the same row.
1401
:param file_id: An optional unicode file_id to be looked up.
1402
:param path: An optional unicode path to be looked up.
1403
:return: The dirstate row tuple for path/file_id, or (None, None)
1405
if file_id is None and path is None:
1406
raise errors.BzrError('must supply file_id or path')
1407
if path is not None:
1408
path = path.encode('utf8')
1409
parent_index = self._get_parent_index()
1410
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1412
def _generate_inventory(self):
1413
"""Create and set self.inventory from the dirstate object.
1415
(So this is only called the first time the inventory is requested for
1416
this tree; it then remains in memory until it's out of date.)
1418
This is relatively expensive: we have to walk the entire dirstate.
1420
assert self._locked, 'cannot generate inventory of an unlocked '\
1421
'dirstate revision tree'
1422
# separate call for profiling - makes it clear where the costs are.
1423
self._dirstate._read_dirblocks_if_needed()
1424
assert self._revision_id in self._dirstate.get_parent_ids(), \
1425
'parent %s has disappeared from %s' % (
1426
self._revision_id, self._dirstate.get_parent_ids())
1427
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1428
# This is identical now to the WorkingTree _generate_inventory except
1429
# for the tree index use.
1430
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1431
current_id = root_key[2]
1432
assert current_entry[parent_index][0] == 'd'
1433
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1434
inv.root.revision = current_entry[parent_index][4]
1435
# Turn some things into local variables
1436
minikind_to_kind = dirstate.DirState._minikind_to_kind
1437
factory = entry_factory
1438
utf8_decode = cache_utf8._utf8_decode
1439
inv_byid = inv._byid
1440
# we could do this straight out of the dirstate; it might be fast
1441
# and should be profiled - RBC 20070216
1442
parent_ies = {'' : inv.root}
1443
for block in self._dirstate._dirblocks[1:]: #skip root
1446
parent_ie = parent_ies[dirname]
1448
# all the paths in this block are not versioned in this tree
1450
for key, entry in block[1]:
1451
minikind, fingerprint, size, executable, revid = entry[parent_index]
1452
if minikind in ('a', 'r'): # absent, relocated
1456
name_unicode = utf8_decode(name)[0]
1458
kind = minikind_to_kind[minikind]
1459
inv_entry = factory[kind](file_id, name_unicode,
1461
inv_entry.revision = revid
1463
inv_entry.executable = executable
1464
inv_entry.text_size = size
1465
inv_entry.text_sha1 = fingerprint
1466
elif kind == 'directory':
1467
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1468
elif kind == 'symlink':
1469
inv_entry.executable = False
1470
inv_entry.text_size = None
1471
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1472
elif kind == 'tree-reference':
1473
inv_entry.reference_revision = fingerprint or None
1475
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1477
# These checks cost us around 40ms on a 55k entry tree
1478
assert file_id not in inv_byid
1479
assert name_unicode not in parent_ie.children
1480
inv_byid[file_id] = inv_entry
1481
parent_ie.children[name_unicode] = inv_entry
1482
self._inventory = inv
1484
def get_file_mtime(self, file_id, path=None):
1485
"""Return the modification time for this record.
1487
We return the timestamp of the last-changed revision.
1489
# Make sure the file exists
1490
entry = self._get_entry(file_id, path=path)
1491
if entry == (None, None): # do we raise?
1493
parent_index = self._get_parent_index()
1494
last_changed_revision = entry[1][parent_index][4]
1495
return self._repository.get_revision(last_changed_revision).timestamp
1497
def get_file_sha1(self, file_id, path=None, stat_value=None):
1498
entry = self._get_entry(file_id=file_id, path=path)
1499
parent_index = self._get_parent_index()
1500
parent_details = entry[1][parent_index]
1501
if parent_details[0] == 'f':
1502
return parent_details[1]
1505
@symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
1506
def get_weave(self, file_id):
1507
return self._get_weave(file_id)
1509
def _get_weave(self, file_id):
1510
return self._repository.weave_store.get_weave(file_id,
1511
self._repository.get_transaction())
1513
def get_file(self, file_id, path=None):
1514
return StringIO(self.get_file_text(file_id))
1516
def get_file_lines(self, file_id):
1517
entry = self._get_entry(file_id=file_id)[1]
1519
raise errors.NoSuchId(tree=self, file_id=file_id)
1520
return self._get_weave(file_id).get_lines(entry[1][4])
1522
def get_file_size(self, file_id):
1523
return self.inventory[file_id].text_size
1525
def get_file_text(self, file_id):
1526
return ''.join(self.get_file_lines(file_id))
1528
def get_reference_revision(self, file_id, path=None):
1529
return self.inventory[file_id].reference_revision
1531
def iter_files_bytes(self, desired_files):
1532
"""See Tree.iter_files_bytes.
1534
This version is implemented on top of Repository.iter_files_bytes"""
1535
parent_index = self._get_parent_index()
1536
repo_desired_files = []
1537
for file_id, identifier in desired_files:
1538
entry = self._get_entry(file_id)
1539
if entry == (None, None):
1540
raise errors.NoSuchId(self, file_id)
1541
repo_desired_files.append((file_id, entry[1][parent_index][4],
1543
return self._repository.iter_files_bytes(repo_desired_files)
1545
def get_symlink_target(self, file_id):
1546
entry = self._get_entry(file_id=file_id)
1547
parent_index = self._get_parent_index()
1548
if entry[1][parent_index][0] != 'l':
1551
# At present, none of the tree implementations supports non-ascii
1552
# symlink targets. So we will just assume that the dirstate path is
1554
return entry[1][parent_index][1]
1556
def get_revision_id(self):
1557
"""Return the revision id for this tree."""
1558
return self._revision_id
1560
def _get_inventory(self):
1561
if self._inventory is not None:
1562
return self._inventory
1563
self._must_be_locked()
1564
self._generate_inventory()
1565
return self._inventory
1567
inventory = property(_get_inventory,
1568
doc="Inventory of this Tree")
1570
def get_parent_ids(self):
1571
"""The parents of a tree in the dirstate are not cached."""
1572
return self._repository.get_revision(self._revision_id).parent_ids
1574
def has_filename(self, filename):
1575
return bool(self.path2id(filename))
1577
def kind(self, file_id):
1578
entry = self._get_entry(file_id=file_id)[1]
1580
raise errors.NoSuchId(tree=self, file_id=file_id)
1581
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1583
def path_content_summary(self, path):
1584
"""See Tree.path_content_summary."""
1585
id = self.inventory.path2id(path)
1587
return ('missing', None, None, None)
1588
entry = self._inventory[id]
1591
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1592
elif kind == 'symlink':
1593
return (kind, None, None, entry.symlink_target)
1595
return (kind, None, None, None)
1597
def is_executable(self, file_id, path=None):
1598
ie = self.inventory[file_id]
1599
if ie.kind != "file":
1601
return ie.executable
1603
def list_files(self, include_root=False):
1604
# We use a standard implementation, because DirStateRevisionTree is
1605
# dealing with one of the parents of the current state
1606
inv = self._get_inventory()
1607
entries = inv.iter_entries()
1608
if self.inventory.root is not None and not include_root:
1610
for path, entry in entries:
1611
yield path, 'V', entry.kind, entry.file_id, entry
1613
def lock_read(self):
1614
"""Lock the tree for a set of operations."""
1615
if not self._locked:
1616
self._repository.lock_read()
1617
if self._dirstate._lock_token is None:
1618
self._dirstate.lock_read()
1619
self._dirstate_locked = True
1622
def _must_be_locked(self):
1623
if not self._locked:
1624
raise errors.ObjectNotLocked(self)
1627
def path2id(self, path):
1628
"""Return the id for path in this tree."""
1629
# lookup by path: faster than splitting and walking the ivnentory.
1630
entry = self._get_entry(path=path)
1631
if entry == (None, None):
1636
"""Unlock, freeing any cache memory used during the lock."""
1637
# outside of a lock, the inventory is suspect: release it.
1639
if not self._locked:
1640
self._inventory = None
1642
if self._dirstate_locked:
1643
self._dirstate.unlock()
1644
self._dirstate_locked = False
1645
self._repository.unlock()
1647
def walkdirs(self, prefix=""):
1648
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1649
# implementation based on an inventory.
1650
# This should be cleaned up to use the much faster Dirstate code
1651
# So for now, we just build up the parent inventory, and extract
1652
# it the same way RevisionTree does.
1653
_directory = 'directory'
1654
inv = self._get_inventory()
1655
top_id = inv.path2id(prefix)
1659
pending = [(prefix, top_id)]
1662
relpath, file_id = pending.pop()
1663
# 0 - relpath, 1- file-id
1665
relroot = relpath + '/'
1668
# FIXME: stash the node in pending
1669
entry = inv[file_id]
1670
for name, child in entry.sorted_children():
1671
toppath = relroot + name
1672
dirblock.append((toppath, name, child.kind, None,
1673
child.file_id, child.kind
1675
yield (relpath, entry.file_id), dirblock
1676
# push the user specified dirs from dirblock
1677
for dir in reversed(dirblock):
1678
if dir[2] == _directory:
1679
pending.append((dir[0], dir[4]))
1682
class InterDirStateTree(InterTree):
1683
"""Fast path optimiser for changes_from with dirstate trees.
1685
This is used only when both trees are in the dirstate working file, and
1686
the source is any parent within the dirstate, and the destination is
1687
the current working tree of the same dirstate.
1689
# this could be generalized to allow comparisons between any trees in the
1690
# dirstate, and possibly between trees stored in different dirstates.
1692
def __init__(self, source, target):
1693
super(InterDirStateTree, self).__init__(source, target)
1694
if not InterDirStateTree.is_compatible(source, target):
1695
raise Exception, "invalid source %r and target %r" % (source, target)
1698
def make_source_parent_tree(source, target):
1699
"""Change the source tree into a parent of the target."""
1700
revid = source.commit('record tree')
1701
target.branch.repository.fetch(source.branch.repository, revid)
1702
target.set_parent_ids([revid])
1703
return target.basis_tree(), target
1705
_matching_from_tree_format = WorkingTreeFormat4()
1706
_matching_to_tree_format = WorkingTreeFormat4()
1707
_test_mutable_trees_to_test_trees = make_source_parent_tree
1709
def _iter_changes(self, include_unchanged=False,
1710
specific_files=None, pb=None, extra_trees=[],
1711
require_versioned=True, want_unversioned=False):
1712
"""Return the changes from source to target.
1714
:return: An iterator that yields tuples. See InterTree._iter_changes
1716
:param specific_files: An optional list of file paths to restrict the
1717
comparison to. When mapping filenames to ids, all matches in all
1718
trees (including optional extra_trees) are used, and all children of
1719
matched directories are included.
1720
:param include_unchanged: An optional boolean requesting the inclusion of
1721
unchanged entries in the result.
1722
:param extra_trees: An optional list of additional trees to use when
1723
mapping the contents of specific_files (paths) to file_ids.
1724
:param require_versioned: If True, all files in specific_files must be
1725
versioned in one of source, target, extra_trees or
1726
PathsNotVersionedError is raised.
1727
:param want_unversioned: Should unversioned files be returned in the
1728
output. An unversioned file is defined as one with (False, False)
1729
for the versioned pair.
1731
utf8_decode = cache_utf8._utf8_decode
1732
_minikind_to_kind = dirstate.DirState._minikind_to_kind
1733
cmp_by_dirs = dirstate.cmp_by_dirs
1734
# NB: show_status depends on being able to pass in non-versioned files
1735
# and report them as unknown
1736
# TODO: handle extra trees in the dirstate.
1737
# TODO: handle comparisons as an empty tree as a different special
1738
# case? mbp 20070226
1739
if (extra_trees or (self.source._revision_id == NULL_REVISION)
1740
or specific_files == []):
1741
# we can't fast-path these cases (yet)
1742
for f in super(InterDirStateTree, self)._iter_changes(
1743
include_unchanged, specific_files, pb, extra_trees,
1744
require_versioned, want_unversioned=want_unversioned):
1747
parent_ids = self.target.get_parent_ids()
1748
assert (self.source._revision_id in parent_ids), \
1749
"revision {%s} is not stored in {%s}, but %s " \
1750
"can only be used for trees stored in the dirstate" \
1751
% (self.source._revision_id, self.target, self._iter_changes)
1753
if self.source._revision_id == NULL_REVISION:
1755
indices = (target_index,)
1757
assert (self.source._revision_id in parent_ids), \
1758
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1759
self.source._revision_id, parent_ids)
1760
source_index = 1 + parent_ids.index(self.source._revision_id)
1761
indices = (source_index,target_index)
1762
# -- make all specific_files utf8 --
1764
specific_files_utf8 = set()
1765
for path in specific_files:
1766
specific_files_utf8.add(path.encode('utf8'))
1767
specific_files = specific_files_utf8
1769
specific_files = set([''])
1770
# -- specific_files is now a utf8 path set --
1771
# -- get the state object and prepare it.
1772
state = self.target.current_dirstate()
1773
state._read_dirblocks_if_needed()
1774
def _entries_for_path(path):
1775
"""Return a list with all the entries that match path for all ids.
1777
dirname, basename = os.path.split(path)
1778
key = (dirname, basename, '')
1779
block_index, present = state._find_block_index_from_key(key)
1781
# the block which should contain path is absent.
1784
block = state._dirblocks[block_index][1]
1785
entry_index, _ = state._find_entry_index(key, block)
1786
# we may need to look at multiple entries at this path: walk while the specific_files match.
1787
while (entry_index < len(block) and
1788
block[entry_index][0][0:2] == key[0:2]):
1789
result.append(block[entry_index])
1792
if require_versioned:
1793
# -- check all supplied paths are versioned in a search tree. --
1794
all_versioned = True
1795
for path in specific_files:
1796
path_entries = _entries_for_path(path)
1797
if not path_entries:
1798
# this specified path is not present at all: error
1799
all_versioned = False
1801
found_versioned = False
1802
# for each id at this path
1803
for entry in path_entries:
1805
for index in indices:
1806
if entry[1][index][0] != 'a': # absent
1807
found_versioned = True
1808
# all good: found a versioned cell
1810
if not found_versioned:
1811
# none of the indexes was not 'absent' at all ids for this
1813
all_versioned = False
1815
if not all_versioned:
1816
raise errors.PathsNotVersionedError(specific_files)
1817
# -- remove redundancy in supplied specific_files to prevent over-scanning --
1818
search_specific_files = set()
1819
for path in specific_files:
1820
other_specific_files = specific_files.difference(set([path]))
1821
if not osutils.is_inside_any(other_specific_files, path):
1822
# this is a top level path, we must check it.
1823
search_specific_files.add(path)
1825
# compare source_index and target_index at or under each element of search_specific_files.
1826
# follow the following comparison table. Note that we only want to do diff operations when
1827
# the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
1831
# Source | Target | disk | action
1832
# r | fdlt | | add source to search, add id path move and perform
1833
# | | | diff check on source-target
1834
# r | fdlt | a | dangling file that was present in the basis.
1836
# r | a | | add source to search
1838
# r | r | | this path is present in a non-examined tree, skip.
1839
# r | r | a | this path is present in a non-examined tree, skip.
1840
# a | fdlt | | add new id
1841
# a | fdlt | a | dangling locally added file, skip
1842
# a | a | | not present in either tree, skip
1843
# a | a | a | not present in any tree, skip
1844
# a | r | | not present in either tree at this path, skip as it
1845
# | | | may not be selected by the users list of paths.
1846
# a | r | a | not present in either tree at this path, skip as it
1847
# | | | may not be selected by the users list of paths.
1848
# fdlt | fdlt | | content in both: diff them
1849
# fdlt | fdlt | a | deleted locally, but not unversioned - show as deleted ?
1850
# fdlt | a | | unversioned: output deleted id for now
1851
# fdlt | a | a | unversioned and deleted: output deleted id
1852
# fdlt | r | | relocated in this tree, so add target to search.
1853
# | | | Dont diff, we will see an r,fd; pair when we reach
1854
# | | | this id at the other path.
1855
# fdlt | r | a | relocated in this tree, so add target to search.
1856
# | | | Dont diff, we will see an r,fd; pair when we reach
1857
# | | | this id at the other path.
1859
# for all search_indexs in each path at or under each element of
1860
# search_specific_files, if the detail is relocated: add the id, and add the
1861
# relocated path as one to search if its not searched already. If the
1862
# detail is not relocated, add the id.
1863
searched_specific_files = set()
1864
NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
1865
# Using a list so that we can access the values and change them in
1866
# nested scope. Each one is [path, file_id, entry]
1867
last_source_parent = [None, None]
1868
last_target_parent = [None, None]
1870
use_filesystem_for_exec = (sys.platform != 'win32')
1872
# Just a sentry, so that _process_entry can say that this
1873
# record is handled, but isn't interesting to process (unchanged)
1874
uninteresting = object()
1877
old_dirname_to_file_id = {}
1878
new_dirname_to_file_id = {}
1879
# TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
1880
# keeping a cache of directories that we have seen.
1882
def _process_entry(entry, path_info):
1883
"""Compare an entry and real disk to generate delta information.
1885
:param path_info: top_relpath, basename, kind, lstat, abspath for
1886
the path of entry. If None, then the path is considered absent.
1887
(Perhaps we should pass in a concrete entry for this ?)
1888
Basename is returned as a utf8 string because we expect this
1889
tuple will be ignored, and don't want to take the time to
1891
:return: None if these don't match
1892
A tuple of information about the change, or
1893
the object 'uninteresting' if these match, but are
1894
basically identical.
1896
if source_index is None:
1897
source_details = NULL_PARENT_DETAILS
1899
source_details = entry[1][source_index]
1900
target_details = entry[1][target_index]
1901
target_minikind = target_details[0]
1902
if path_info is not None and target_minikind in 'fdlt':
1903
assert target_index == 0
1904
link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
1905
stat_value=path_info[3])
1906
# The entry may have been modified by update_entry
1907
target_details = entry[1][target_index]
1908
target_minikind = target_details[0]
1911
file_id = entry[0][2]
1912
source_minikind = source_details[0]
1913
if source_minikind in 'fdltr' and target_minikind in 'fdlt':
1914
# claimed content in both: diff
1915
# r | fdlt | | add source to search, add id path move and perform
1916
# | | | diff check on source-target
1917
# r | fdlt | a | dangling file that was present in the basis.
1919
if source_minikind in 'r':
1920
# add the source to the search path to find any children it
1921
# has. TODO ? : only add if it is a container ?
1922
if not osutils.is_inside_any(searched_specific_files,
1924
search_specific_files.add(source_details[1])
1925
# generate the old path; this is needed for stating later
1927
old_path = source_details[1]
1928
old_dirname, old_basename = os.path.split(old_path)
1929
path = pathjoin(entry[0][0], entry[0][1])
1930
old_entry = state._get_entry(source_index,
1932
# update the source details variable to be the real
1934
source_details = old_entry[1][source_index]
1935
source_minikind = source_details[0]
1937
old_dirname = entry[0][0]
1938
old_basename = entry[0][1]
1939
old_path = path = None
1940
if path_info is None:
1941
# the file is missing on disk, show as removed.
1942
content_change = True
1946
# source and target are both versioned and disk file is present.
1947
target_kind = path_info[2]
1948
if target_kind == 'directory':
1950
old_path = path = pathjoin(old_dirname, old_basename)
1951
new_dirname_to_file_id[path] = file_id
1952
if source_minikind != 'd':
1953
content_change = True
1955
# directories have no fingerprint
1956
content_change = False
1958
elif target_kind == 'file':
1959
if source_minikind != 'f':
1960
content_change = True
1962
# We could check the size, but we already have the
1964
content_change = (link_or_sha1 != source_details[1])
1965
# Target details is updated at update_entry time
1966
if use_filesystem_for_exec:
1967
# We don't need S_ISREG here, because we are sure
1968
# we are dealing with a file.
1969
target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
1971
target_exec = target_details[3]
1972
elif target_kind == 'symlink':
1973
if source_minikind != 'l':
1974
content_change = True
1976
content_change = (link_or_sha1 != source_details[1])
1978
elif target_kind == 'tree-reference':
1979
if source_minikind != 't':
1980
content_change = True
1982
content_change = False
1985
raise Exception, "unknown kind %s" % path_info[2]
1986
if source_minikind == 'd':
1988
old_path = path = pathjoin(old_dirname, old_basename)
1989
old_dirname_to_file_id[old_path] = file_id
1990
# parent id is the entry for the path in the target tree
1991
if old_dirname == last_source_parent[0]:
1992
source_parent_id = last_source_parent[1]
1995
source_parent_id = old_dirname_to_file_id[old_dirname]
1997
source_parent_entry = state._get_entry(source_index,
1998
path_utf8=old_dirname)
1999
source_parent_id = source_parent_entry[0][2]
2000
if source_parent_id == entry[0][2]:
2001
# This is the root, so the parent is None
2002
source_parent_id = None
2004
last_source_parent[0] = old_dirname
2005
last_source_parent[1] = source_parent_id
2006
new_dirname = entry[0][0]
2007
if new_dirname == last_target_parent[0]:
2008
target_parent_id = last_target_parent[1]
2011
target_parent_id = new_dirname_to_file_id[new_dirname]
2013
# TODO: We don't always need to do the lookup, because the
2014
# parent entry will be the same as the source entry.
2015
target_parent_entry = state._get_entry(target_index,
2016
path_utf8=new_dirname)
2017
assert target_parent_entry != (None, None), (
2018
"Could not find target parent in wt: %s\nparent of: %s"
2019
% (new_dirname, entry))
2020
target_parent_id = target_parent_entry[0][2]
2021
if target_parent_id == entry[0][2]:
2022
# This is the root, so the parent is None
2023
target_parent_id = None
2025
last_target_parent[0] = new_dirname
2026
last_target_parent[1] = target_parent_id
2028
source_exec = source_details[3]
2029
if (include_unchanged
2031
or source_parent_id != target_parent_id
2032
or old_basename != entry[0][1]
2033
or source_exec != target_exec
2035
if old_path is None:
2036
old_path = path = pathjoin(old_dirname, old_basename)
2037
old_path_u = utf8_decode(old_path)[0]
2040
old_path_u = utf8_decode(old_path)[0]
2041
if old_path == path:
2044
path_u = utf8_decode(path)[0]
2045
source_kind = _minikind_to_kind[source_minikind]
2046
return (entry[0][2],
2047
(old_path_u, path_u),
2050
(source_parent_id, target_parent_id),
2051
(utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
2052
(source_kind, target_kind),
2053
(source_exec, target_exec))
2055
return uninteresting
2056
elif source_minikind in 'a' and target_minikind in 'fdlt':
2057
# looks like a new file
2058
if path_info is not None:
2059
path = pathjoin(entry[0][0], entry[0][1])
2060
# parent id is the entry for the path in the target tree
2061
# TODO: these are the same for an entire directory: cache em.
2062
parent_id = state._get_entry(target_index,
2063
path_utf8=entry[0][0])[0][2]
2064
if parent_id == entry[0][2]:
2066
if use_filesystem_for_exec:
2067
# We need S_ISREG here, because we aren't sure if this
2070
stat.S_ISREG(path_info[3].st_mode)
2071
and stat.S_IEXEC & path_info[3].st_mode)
2073
target_exec = target_details[3]
2074
return (entry[0][2],
2075
(None, utf8_decode(path)[0]),
2079
(None, utf8_decode(entry[0][1])[0]),
2080
(None, path_info[2]),
2081
(None, target_exec))
2083
# but its not on disk: we deliberately treat this as just
2084
# never-present. (Why ?! - RBC 20070224)
2086
elif source_minikind in 'fdlt' and target_minikind in 'a':
2087
# unversioned, possibly, or possibly not deleted: we dont care.
2088
# if its still on disk, *and* theres no other entry at this
2089
# path [we dont know this in this routine at the moment -
2090
# perhaps we should change this - then it would be an unknown.
2091
old_path = pathjoin(entry[0][0], entry[0][1])
2092
# parent id is the entry for the path in the target tree
2093
parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
2094
if parent_id == entry[0][2]:
2096
return (entry[0][2],
2097
(utf8_decode(old_path)[0], None),
2101
(utf8_decode(entry[0][1])[0], None),
2102
(_minikind_to_kind[source_minikind], None),
2103
(source_details[3], None))
2104
elif source_minikind in 'fdlt' and target_minikind in 'r':
2105
# a rename; could be a true rename, or a rename inherited from
2106
# a renamed parent. TODO: handle this efficiently. Its not
2107
# common case to rename dirs though, so a correct but slow
2108
# implementation will do.
2109
if not osutils.is_inside_any(searched_specific_files, target_details[1]):
2110
search_specific_files.add(target_details[1])
2111
elif source_minikind in 'ra' and target_minikind in 'ra':
2112
# neither of the selected trees contain this file,
2113
# so skip over it. This is not currently directly tested, but
2114
# is indirectly via test_too_much.TestCommands.test_conflicts.
2117
raise AssertionError("don't know how to compare "
2118
"source_minikind=%r, target_minikind=%r"
2119
% (source_minikind, target_minikind))
2120
## import pdb;pdb.set_trace()
2123
while search_specific_files:
2124
# TODO: the pending list should be lexically sorted? the
2125
# interface doesn't require it.
2126
current_root = search_specific_files.pop()
2127
current_root_unicode = current_root.decode('utf8')
2128
searched_specific_files.add(current_root)
2129
# process the entries for this containing directory: the rest will be
2130
# found by their parents recursively.
2131
root_entries = _entries_for_path(current_root)
2132
root_abspath = self.target.abspath(current_root_unicode)
2134
root_stat = os.lstat(root_abspath)
2136
if e.errno == errno.ENOENT:
2137
# the path does not exist: let _process_entry know that.
2138
root_dir_info = None
2140
# some other random error: hand it up.
2143
root_dir_info = ('', current_root,
2144
osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
2146
if root_dir_info[2] == 'directory':
2147
if self.target._directory_is_tree_reference(
2148
current_root.decode('utf8')):
2149
root_dir_info = root_dir_info[:2] + \
2150
('tree-reference',) + root_dir_info[3:]
2152
if not root_entries and not root_dir_info:
2153
# this specified path is not present at all, skip it.
2155
path_handled = False
2156
for entry in root_entries:
2157
result = _process_entry(entry, root_dir_info)
2158
if result is not None:
2160
if result is not uninteresting:
2162
if want_unversioned and not path_handled and root_dir_info:
2163
new_executable = bool(
2164
stat.S_ISREG(root_dir_info[3].st_mode)
2165
and stat.S_IEXEC & root_dir_info[3].st_mode)
2167
(None, current_root_unicode),
2171
(None, splitpath(current_root_unicode)[-1]),
2172
(None, root_dir_info[2]),
2173
(None, new_executable)
2175
initial_key = (current_root, '', '')
2176
block_index, _ = state._find_block_index_from_key(initial_key)
2177
if block_index == 0:
2178
# we have processed the total root already, but because the
2179
# initial key matched it we should skip it here.
2181
if root_dir_info and root_dir_info[2] == 'tree-reference':
2182
current_dir_info = None
2184
dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
2186
current_dir_info = dir_iterator.next()
2188
# on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
2189
# python 2.5 has e.errno == EINVAL,
2190
# and e.winerror == ERROR_DIRECTORY
2191
e_winerror = getattr(e, 'winerror', None)
2192
win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
2193
# there may be directories in the inventory even though
2194
# this path is not a file on disk: so mark it as end of
2196
if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
2197
current_dir_info = None
2198
elif (sys.platform == 'win32'
2199
and (e.errno in win_errors
2200
or e_winerror in win_errors)):
2201
current_dir_info = None
2205
if current_dir_info[0][0] == '':
2206
# remove .bzr from iteration
2207
bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
2208
assert current_dir_info[1][bzr_index][0] == '.bzr'
2209
del current_dir_info[1][bzr_index]
2210
# walk until both the directory listing and the versioned metadata
2212
if (block_index < len(state._dirblocks) and
2213
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2214
current_block = state._dirblocks[block_index]
2216
current_block = None
2217
while (current_dir_info is not None or
2218
current_block is not None):
2219
if (current_dir_info and current_block
2220
and current_dir_info[0][0] != current_block[0]):
2221
if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
2222
# filesystem data refers to paths not covered by the dirblock.
2223
# this has two possibilities:
2224
# A) it is versioned but empty, so there is no block for it
2225
# B) it is not versioned.
2227
# if (A) then we need to recurse into it to check for
2228
# new unknown files or directories.
2229
# if (B) then we should ignore it, because we don't
2230
# recurse into unknown directories.
2232
while path_index < len(current_dir_info[1]):
2233
current_path_info = current_dir_info[1][path_index]
2234
if want_unversioned:
2235
if current_path_info[2] == 'directory':
2236
if self.target._directory_is_tree_reference(
2237
current_path_info[0].decode('utf8')):
2238
current_path_info = current_path_info[:2] + \
2239
('tree-reference',) + current_path_info[3:]
2240
new_executable = bool(
2241
stat.S_ISREG(current_path_info[3].st_mode)
2242
and stat.S_IEXEC & current_path_info[3].st_mode)
2244
(None, utf8_decode(current_path_info[0])[0]),
2248
(None, utf8_decode(current_path_info[1])[0]),
2249
(None, current_path_info[2]),
2250
(None, new_executable))
2251
# dont descend into this unversioned path if it is
2253
if current_path_info[2] in ('directory',
2255
del current_dir_info[1][path_index]
2259
# This dir info has been handled, go to the next
2261
current_dir_info = dir_iterator.next()
2262
except StopIteration:
2263
current_dir_info = None
2265
# We have a dirblock entry for this location, but there
2266
# is no filesystem path for this. This is most likely
2267
# because a directory was removed from the disk.
2268
# We don't have to report the missing directory,
2269
# because that should have already been handled, but we
2270
# need to handle all of the files that are contained
2272
for current_entry in current_block[1]:
2273
# entry referring to file not present on disk.
2274
# advance the entry only, after processing.
2275
result = _process_entry(current_entry, None)
2276
if result is not None:
2277
if result is not uninteresting:
2280
if (block_index < len(state._dirblocks) and
2281
osutils.is_inside(current_root,
2282
state._dirblocks[block_index][0])):
2283
current_block = state._dirblocks[block_index]
2285
current_block = None
2288
if current_block and entry_index < len(current_block[1]):
2289
current_entry = current_block[1][entry_index]
2291
current_entry = None
2292
advance_entry = True
2294
if current_dir_info and path_index < len(current_dir_info[1]):
2295
current_path_info = current_dir_info[1][path_index]
2296
if current_path_info[2] == 'directory':
2297
if self.target._directory_is_tree_reference(
2298
current_path_info[0].decode('utf8')):
2299
current_path_info = current_path_info[:2] + \
2300
('tree-reference',) + current_path_info[3:]
2302
current_path_info = None
2304
path_handled = False
2305
while (current_entry is not None or
2306
current_path_info is not None):
2307
if current_entry is None:
2308
# the check for path_handled when the path is adnvaced
2309
# will yield this path if needed.
2311
elif current_path_info is None:
2312
# no path is fine: the per entry code will handle it.
2313
result = _process_entry(current_entry, current_path_info)
2314
if result is not None:
2315
if result is not uninteresting:
2317
elif (current_entry[0][1] != current_path_info[1]
2318
or current_entry[1][target_index][0] in 'ar'):
2319
# The current path on disk doesn't match the dirblock
2320
# record. Either the dirblock is marked as absent, or
2321
# the file on disk is not present at all in the
2322
# dirblock. Either way, report about the dirblock
2323
# entry, and let other code handle the filesystem one.
2325
# Compare the basename for these files to determine
2327
if current_path_info[1] < current_entry[0][1]:
2328
# extra file on disk: pass for now, but only
2329
# increment the path, not the entry
2330
advance_entry = False
2332
# entry referring to file not present on disk.
2333
# advance the entry only, after processing.
2334
result = _process_entry(current_entry, None)
2335
if result is not None:
2336
if result is not uninteresting:
2338
advance_path = False
2340
result = _process_entry(current_entry, current_path_info)
2341
if result is not None:
2343
if result is not uninteresting:
2345
if advance_entry and current_entry is not None:
2347
if entry_index < len(current_block[1]):
2348
current_entry = current_block[1][entry_index]
2350
current_entry = None
2352
advance_entry = True # reset the advance flaga
2353
if advance_path and current_path_info is not None:
2354
if not path_handled:
2355
# unversioned in all regards
2356
if want_unversioned:
2357
new_executable = bool(
2358
stat.S_ISREG(current_path_info[3].st_mode)
2359
and stat.S_IEXEC & current_path_info[3].st_mode)
2361
(None, utf8_decode(current_path_info[0])[0]),
2365
(None, utf8_decode(current_path_info[1])[0]),
2366
(None, current_path_info[2]),
2367
(None, new_executable))
2368
# dont descend into this unversioned path if it is
2370
if current_path_info[2] in ('directory'):
2371
del current_dir_info[1][path_index]
2373
# dont descend the disk iterator into any tree
2375
if current_path_info[2] == 'tree-reference':
2376
del current_dir_info[1][path_index]
2379
if path_index < len(current_dir_info[1]):
2380
current_path_info = current_dir_info[1][path_index]
2381
if current_path_info[2] == 'directory':
2382
if self.target._directory_is_tree_reference(
2383
current_path_info[0].decode('utf8')):
2384
current_path_info = current_path_info[:2] + \
2385
('tree-reference',) + current_path_info[3:]
2387
current_path_info = None
2388
path_handled = False
2390
advance_path = True # reset the advance flagg.
2391
if current_block is not None:
2393
if (block_index < len(state._dirblocks) and
2394
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2395
current_block = state._dirblocks[block_index]
2397
current_block = None
2398
if current_dir_info is not None:
2400
current_dir_info = dir_iterator.next()
2401
except StopIteration:
2402
current_dir_info = None
2406
def is_compatible(source, target):
2407
# the target must be a dirstate working tree
2408
if not isinstance(target, WorkingTree4):
2410
# the source must be a revtreee or dirstate rev tree.
2411
if not isinstance(source,
2412
(revisiontree.RevisionTree, DirStateRevisionTree)):
2414
# the source revid must be in the target dirstate
2415
if not (source._revision_id == NULL_REVISION or
2416
source._revision_id in target.get_parent_ids()):
2417
# TODO: what about ghosts? it may well need to
2418
# check for them explicitly.
2422
InterTree.register_optimiser(InterDirStateTree)
2425
class Converter3to4(object):
2426
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2429
self.target_format = WorkingTreeFormat4()
2431
def convert(self, tree):
2432
# lock the control files not the tree, so that we dont get tree
2433
# on-unlock behaviours, and so that noone else diddles with the
2434
# tree during upgrade.
2435
tree._control_files.lock_write()
2437
tree.read_working_inventory()
2438
self.create_dirstate_data(tree)
2439
self.update_format(tree)
2440
self.remove_xml_files(tree)
2442
tree._control_files.unlock()
2444
def create_dirstate_data(self, tree):
2445
"""Create the dirstate based data for tree."""
2446
local_path = tree.bzrdir.get_workingtree_transport(None
2447
).local_abspath('dirstate')
2448
state = dirstate.DirState.from_tree(tree, local_path)
2452
def remove_xml_files(self, tree):
2453
"""Remove the oldformat 3 data."""
2454
transport = tree.bzrdir.get_workingtree_transport(None)
2455
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2456
'pending-merges', 'stat-cache']:
2458
transport.delete(path)
2459
except errors.NoSuchFile:
2460
# some files are optional - just deal.
2463
def update_format(self, tree):
2464
"""Change the format marker."""
2465
tree._control_files.put_utf8('format',
2466
self.target_format.get_format_string())