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
154
self._setup_directory_is_tree_reference()
155
self._detect_case_handling()
157
@needs_tree_write_lock
158
def _add(self, files, ids, kinds):
159
"""See MutableTree._add."""
160
state = self.current_dirstate()
161
for f, file_id, kind in zip(files, ids, kinds):
164
# special case tree root handling.
165
if f == '' and self.path2id(f) == ROOT_ID:
166
state.set_path_id('', generate_ids.gen_file_id(f))
169
file_id = generate_ids.gen_file_id(f)
170
# deliberately add the file with no cached stat or sha1
171
# - on the first access it will be gathered, and we can
172
# always change this once tests are all passing.
173
state.add(f, file_id, kind, None, '')
174
self._make_dirty(reset_inventory=True)
176
def _make_dirty(self, reset_inventory):
177
"""Make the tree state dirty.
179
:param reset_inventory: True if the cached inventory should be removed
180
(presuming there is one).
183
if reset_inventory and self._inventory is not None:
184
self._inventory = None
186
@needs_tree_write_lock
187
def add_reference(self, sub_tree):
188
# use standard implementation, which calls back to self._add
190
# So we don't store the reference_revision in the working dirstate,
191
# it's just recorded at the moment of commit.
192
self._add_reference(sub_tree)
194
def break_lock(self):
195
"""Break a lock if one is present from another instance.
197
Uses the ui factory to ask for confirmation if the lock may be from
200
This will probe the repository for its lock as well.
202
# if the dirstate is locked by an active process, reject the break lock
205
if self._dirstate is None:
209
state = self._current_dirstate()
210
if state._lock_token is not None:
211
# we already have it locked. sheese, cant break our own lock.
212
raise errors.LockActive(self.basedir)
215
# try for a write lock - need permission to get one anyhow
218
except errors.LockContention:
219
# oslocks fail when a process is still live: fail.
220
# TODO: get the locked lockdir info and give to the user to
221
# assist in debugging.
222
raise errors.LockActive(self.basedir)
227
self._dirstate = None
228
self._control_files.break_lock()
229
self.branch.break_lock()
231
def _comparison_data(self, entry, path):
232
kind, executable, stat_value = \
233
WorkingTree3._comparison_data(self, entry, path)
234
# it looks like a plain directory, but it's really a reference -- see
236
if (self._repo_supports_tree_reference and
237
kind == 'directory' and
238
self._directory_is_tree_reference(path)):
239
kind = 'tree-reference'
240
return kind, executable, stat_value
243
def commit(self, message=None, revprops=None, *args, **kwargs):
244
# mark the tree as dirty post commit - commit
245
# can change the current versioned list by doing deletes.
246
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
247
self._make_dirty(reset_inventory=True)
250
def current_dirstate(self):
251
"""Return the current dirstate object.
253
This is not part of the tree interface and only exposed for ease of
256
:raises errors.NotWriteLocked: when not in a lock.
258
self._must_be_locked()
259
return self._current_dirstate()
261
def _current_dirstate(self):
262
"""Internal function that does not check lock status.
264
This is needed for break_lock which also needs the dirstate.
266
if self._dirstate is not None:
267
return self._dirstate
268
local_path = self.bzrdir.get_workingtree_transport(None
269
).local_abspath('dirstate')
270
self._dirstate = dirstate.DirState.on_file(local_path)
271
return self._dirstate
273
def filter_unversioned_files(self, paths):
274
"""Filter out paths that are versioned.
276
:return: set of paths.
278
# TODO: make a generic multi-bisect routine roughly that should list
279
# the paths, then process one half at a time recursively, and feed the
280
# results of each bisect in further still
281
paths = sorted(paths)
283
state = self.current_dirstate()
284
# TODO we want a paths_to_dirblocks helper I think
286
dirname, basename = os.path.split(path.encode('utf8'))
287
_, _, _, path_is_versioned = state._get_block_entry_index(
288
dirname, basename, 0)
289
if not path_is_versioned:
294
"""Write all cached data to disk."""
295
if self._control_files._lock_mode != 'w':
296
raise errors.NotWriteLocked(self)
297
self.current_dirstate().save()
298
self._inventory = None
301
@needs_tree_write_lock
302
def _gather_kinds(self, files, kinds):
303
"""See MutableTree._gather_kinds."""
304
for pos, f in enumerate(files):
305
if kinds[pos] is None:
306
kinds[pos] = self._kind(f)
308
def _generate_inventory(self):
309
"""Create and set self.inventory from the dirstate object.
311
This is relatively expensive: we have to walk the entire dirstate.
312
Ideally we would not, and can deprecate this function.
314
#: uncomment to trap on inventory requests.
315
# import pdb;pdb.set_trace()
316
state = self.current_dirstate()
317
state._read_dirblocks_if_needed()
318
root_key, current_entry = self._get_entry(path='')
319
current_id = root_key[2]
320
assert current_entry[0][0] == 'd' # directory
321
inv = Inventory(root_id=current_id)
322
# Turn some things into local variables
323
minikind_to_kind = dirstate.DirState._minikind_to_kind
324
factory = entry_factory
325
utf8_decode = cache_utf8._utf8_decode
327
# we could do this straight out of the dirstate; it might be fast
328
# and should be profiled - RBC 20070216
329
parent_ies = {'' : inv.root}
330
for block in state._dirblocks[1:]: # skip the root
333
parent_ie = parent_ies[dirname]
335
# all the paths in this block are not versioned in this tree
337
for key, entry in block[1]:
338
minikind, link_or_sha1, size, executable, stat = entry[0]
339
if minikind in ('a', 'r'): # absent, relocated
340
# a parent tree only entry
343
name_unicode = utf8_decode(name)[0]
345
kind = minikind_to_kind[minikind]
346
inv_entry = factory[kind](file_id, name_unicode,
349
# This is only needed on win32, where this is the only way
350
# we know the executable bit.
351
inv_entry.executable = executable
352
# not strictly needed: working tree
353
#inv_entry.text_size = size
354
#inv_entry.text_sha1 = sha1
355
elif kind == 'directory':
356
# add this entry to the parent map.
357
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
358
elif kind == 'tree-reference':
359
assert self._repo_supports_tree_reference, \
360
"repository of %r " \
361
"doesn't support tree references " \
362
"required by entry %r" \
364
inv_entry.reference_revision = link_or_sha1 or None
365
elif kind != 'symlink':
366
raise AssertionError("unknown kind %r" % kind)
367
# These checks cost us around 40ms on a 55k entry tree
368
assert file_id not in inv_byid, ('file_id %s already in'
369
' inventory as %s' % (file_id, inv_byid[file_id]))
370
assert name_unicode not in parent_ie.children
371
inv_byid[file_id] = inv_entry
372
parent_ie.children[name_unicode] = inv_entry
373
self._inventory = inv
375
def _get_entry(self, file_id=None, path=None):
376
"""Get the dirstate row for file_id or path.
378
If either file_id or path is supplied, it is used as the key to lookup.
379
If both are supplied, the fastest lookup is used, and an error is
380
raised if they do not both point at the same row.
382
:param file_id: An optional unicode file_id to be looked up.
383
:param path: An optional unicode path to be looked up.
384
:return: The dirstate row tuple for path/file_id, or (None, None)
386
if file_id is None and path is None:
387
raise errors.BzrError('must supply file_id or path')
388
state = self.current_dirstate()
390
path = path.encode('utf8')
391
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
393
def get_file_sha1(self, file_id, path=None, stat_value=None):
394
# check file id is valid unconditionally.
395
entry = self._get_entry(file_id=file_id, path=path)
397
raise errors.NoSuchId(self, file_id)
399
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
401
file_abspath = self.abspath(path)
402
state = self.current_dirstate()
403
if stat_value is None:
405
stat_value = os.lstat(file_abspath)
407
if e.errno == errno.ENOENT:
411
link_or_sha1 = state.update_entry(entry, file_abspath,
412
stat_value=stat_value)
413
if entry[1][0][0] == 'f':
417
def _get_inventory(self):
418
"""Get the inventory for the tree. This is only valid within a lock."""
419
if 'evil' in debug.debug_flags:
420
trace.mutter_callsite(2,
421
"accessing .inventory forces a size of tree translation.")
422
if self._inventory is not None:
423
return self._inventory
424
self._must_be_locked()
425
self._generate_inventory()
426
return self._inventory
428
inventory = property(_get_inventory,
429
doc="Inventory of this Tree")
432
def get_parent_ids(self):
433
"""See Tree.get_parent_ids.
435
This implementation requests the ids list from the dirstate file.
437
return self.current_dirstate().get_parent_ids()
439
def get_reference_revision(self, file_id, path=None):
440
# referenced tree's revision is whatever's currently there
441
return self.get_nested_tree(file_id, path).last_revision()
443
def get_nested_tree(self, file_id, path=None):
445
path = self.id2path(file_id)
446
# else: check file_id is at path?
447
return WorkingTree.open(self.abspath(path))
450
def get_root_id(self):
451
"""Return the id of this trees root"""
452
return self._get_entry(path='')[0][2]
454
def has_id(self, file_id):
455
state = self.current_dirstate()
456
row, parents = self._get_entry(file_id=file_id)
459
return osutils.lexists(pathjoin(
460
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
463
def id2path(self, file_id):
464
"Convert a file-id to a path."
465
state = self.current_dirstate()
466
entry = self._get_entry(file_id=file_id)
467
if entry == (None, None):
468
raise errors.NoSuchId(tree=self, file_id=file_id)
469
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
470
return path_utf8.decode('utf8')
472
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
473
entry = self._get_entry(path=path)
474
if entry == (None, None):
475
return False # Missing entries are not executable
476
return entry[1][0][3] # Executable?
478
if not osutils.supports_executable():
479
def is_executable(self, file_id, path=None):
480
"""Test if a file is executable or not.
482
Note: The caller is expected to take a read-lock before calling this.
484
entry = self._get_entry(file_id=file_id, path=path)
485
if entry == (None, None):
487
return entry[1][0][3]
489
_is_executable_from_path_and_stat = \
490
_is_executable_from_path_and_stat_from_basis
492
def is_executable(self, file_id, path=None):
493
"""Test if a file is executable or not.
495
Note: The caller is expected to take a read-lock before calling this.
498
path = self.id2path(file_id)
499
mode = os.lstat(self.abspath(path)).st_mode
500
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
504
"""Iterate through file_ids for this tree.
506
file_ids are in a WorkingTree if they are in the working inventory
507
and the working file exists.
510
for key, tree_details in self.current_dirstate()._iter_entries():
511
if tree_details[0][0] in ('a', 'r'): # absent, relocated
512
# not relevant to the working tree
514
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
515
if osutils.lexists(path):
516
result.append(key[2])
519
def iter_references(self):
520
for key, tree_details in self.current_dirstate()._iter_entries():
521
if tree_details[0][0] in ('a', 'r'): # absent, relocated
522
# not relevant to the working tree
525
# the root is not a reference.
527
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
529
if self._kind(path) == 'tree-reference':
531
except errors.NoSuchFile:
532
# path is missing on disk.
535
def kind(self, file_id):
536
"""Return the kind of a file.
538
This is always the actual kind that's on disk, regardless of what it
541
Note: The caller is expected to take a read-lock before calling this.
543
relpath = self.id2path(file_id)
544
assert relpath != None, \
545
"path for id {%s} is None!" % file_id
546
return self._kind(relpath)
548
def _kind(self, relpath):
549
abspath = self.abspath(relpath)
550
kind = file_kind(abspath)
551
if (self._repo_supports_tree_reference and
552
kind == 'directory' and
553
self._directory_is_tree_reference(relpath)):
554
kind = 'tree-reference'
558
def _last_revision(self):
559
"""See Mutable.last_revision."""
560
parent_ids = self.current_dirstate().get_parent_ids()
564
return _mod_revision.NULL_REVISION
567
"""See Branch.lock_read, and WorkingTree.unlock."""
568
self.branch.lock_read()
570
self._control_files.lock_read()
572
state = self.current_dirstate()
573
if not state._lock_token:
575
# set our support for tree references from the repository in
577
self._repo_supports_tree_reference = getattr(
578
self.branch.repository._format, "supports_tree_reference",
581
self._control_files.unlock()
587
def _lock_self_write(self):
588
"""This should be called after the branch is locked."""
590
self._control_files.lock_write()
592
state = self.current_dirstate()
593
if not state._lock_token:
595
# set our support for tree references from the repository in
597
self._repo_supports_tree_reference = getattr(
598
self.branch.repository._format, "supports_tree_reference",
601
self._control_files.unlock()
607
def lock_tree_write(self):
608
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
609
self.branch.lock_read()
610
self._lock_self_write()
612
def lock_write(self):
613
"""See MutableTree.lock_write, and WorkingTree.unlock."""
614
self.branch.lock_write()
615
self._lock_self_write()
617
@needs_tree_write_lock
618
def move(self, from_paths, to_dir, after=False):
619
"""See WorkingTree.move()."""
624
state = self.current_dirstate()
626
assert not isinstance(from_paths, basestring)
627
to_dir_utf8 = to_dir.encode('utf8')
628
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
629
id_index = state._get_id_index()
630
# check destination directory
631
# get the details for it
632
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
633
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
634
if not entry_present:
635
raise errors.BzrMoveFailedError('', to_dir,
636
errors.NotVersionedError(to_dir))
637
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
638
# get a handle on the block itself.
639
to_block_index = state._ensure_block(
640
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
641
to_block = state._dirblocks[to_block_index]
642
to_abs = self.abspath(to_dir)
643
if not isdir(to_abs):
644
raise errors.BzrMoveFailedError('',to_dir,
645
errors.NotADirectory(to_abs))
647
if to_entry[1][0][0] != 'd':
648
raise errors.BzrMoveFailedError('',to_dir,
649
errors.NotADirectory(to_abs))
651
if self._inventory is not None:
652
update_inventory = True
654
to_dir_ie = inv[to_dir_id]
655
to_dir_id = to_entry[0][2]
657
update_inventory = False
660
def move_one(old_entry, from_path_utf8, minikind, executable,
661
fingerprint, packed_stat, size,
662
to_block, to_key, to_path_utf8):
663
state._make_absent(old_entry)
664
from_key = old_entry[0]
666
lambda:state.update_minimal(from_key,
668
executable=executable,
669
fingerprint=fingerprint,
670
packed_stat=packed_stat,
672
path_utf8=from_path_utf8))
673
state.update_minimal(to_key,
675
executable=executable,
676
fingerprint=fingerprint,
677
packed_stat=packed_stat,
679
path_utf8=to_path_utf8)
680
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
681
new_entry = to_block[1][added_entry_index]
682
rollbacks.append(lambda:state._make_absent(new_entry))
684
for from_rel in from_paths:
685
# from_rel is 'pathinroot/foo/bar'
686
from_rel_utf8 = from_rel.encode('utf8')
687
from_dirname, from_tail = osutils.split(from_rel)
688
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
689
from_entry = self._get_entry(path=from_rel)
690
if from_entry == (None, None):
691
raise errors.BzrMoveFailedError(from_rel,to_dir,
692
errors.NotVersionedError(path=str(from_rel)))
694
from_id = from_entry[0][2]
695
to_rel = pathjoin(to_dir, from_tail)
696
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
697
item_to_entry = self._get_entry(path=to_rel)
698
if item_to_entry != (None, None):
699
raise errors.BzrMoveFailedError(from_rel, to_rel,
700
"Target is already versioned.")
702
if from_rel == to_rel:
703
raise errors.BzrMoveFailedError(from_rel, to_rel,
704
"Source and target are identical.")
706
from_missing = not self.has_filename(from_rel)
707
to_missing = not self.has_filename(to_rel)
714
raise errors.BzrMoveFailedError(from_rel, to_rel,
715
errors.NoSuchFile(path=to_rel,
716
extra="New file has not been created yet"))
718
# neither path exists
719
raise errors.BzrRenameFailedError(from_rel, to_rel,
720
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
722
if from_missing: # implicitly just update our path mapping
725
raise errors.RenameFailedFilesExist(from_rel, to_rel)
728
def rollback_rename():
729
"""A single rename has failed, roll it back."""
730
# roll back everything, even if we encounter trouble doing one
733
# TODO: at least log the other exceptions rather than just
734
# losing them mbp 20070307
736
for rollback in reversed(rollbacks):
740
exc_info = sys.exc_info()
742
raise exc_info[0], exc_info[1], exc_info[2]
744
# perform the disk move first - its the most likely failure point.
746
from_rel_abs = self.abspath(from_rel)
747
to_rel_abs = self.abspath(to_rel)
749
osutils.rename(from_rel_abs, to_rel_abs)
751
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
752
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
754
# perform the rename in the inventory next if needed: its easy
758
from_entry = inv[from_id]
759
current_parent = from_entry.parent_id
760
inv.rename(from_id, to_dir_id, from_tail)
762
lambda: inv.rename(from_id, current_parent, from_tail))
763
# finally do the rename in the dirstate, which is a little
764
# tricky to rollback, but least likely to need it.
765
old_block_index, old_entry_index, dir_present, file_present = \
766
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
767
old_block = state._dirblocks[old_block_index][1]
768
old_entry = old_block[old_entry_index]
769
from_key, old_entry_details = old_entry
770
cur_details = old_entry_details[0]
772
to_key = ((to_block[0],) + from_key[1:3])
773
minikind = cur_details[0]
774
move_one(old_entry, from_path_utf8=from_rel_utf8,
776
executable=cur_details[3],
777
fingerprint=cur_details[1],
778
packed_stat=cur_details[4],
782
to_path_utf8=to_rel_utf8)
785
def update_dirblock(from_dir, to_key, to_dir_utf8):
786
"""Recursively update all entries in this dirblock."""
787
assert from_dir != '', "renaming root not supported"
788
from_key = (from_dir, '')
789
from_block_idx, present = \
790
state._find_block_index_from_key(from_key)
792
# This is the old record, if it isn't present, then
793
# there is theoretically nothing to update.
794
# (Unless it isn't present because of lazy loading,
795
# but we don't do that yet)
797
from_block = state._dirblocks[from_block_idx]
798
to_block_index, to_entry_index, _, _ = \
799
state._get_block_entry_index(to_key[0], to_key[1], 0)
800
to_block_index = state._ensure_block(
801
to_block_index, to_entry_index, to_dir_utf8)
802
to_block = state._dirblocks[to_block_index]
804
# Grab a copy since move_one may update the list.
805
for entry in from_block[1][:]:
806
assert entry[0][0] == from_dir
807
cur_details = entry[1][0]
808
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
809
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
810
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
811
minikind = cur_details[0]
813
# Deleted children of a renamed directory
814
# Do not need to be updated.
815
# Children that have been renamed out of this
816
# directory should also not be updated
818
move_one(entry, from_path_utf8=from_path_utf8,
820
executable=cur_details[3],
821
fingerprint=cur_details[1],
822
packed_stat=cur_details[4],
826
to_path_utf8=to_path_utf8)
828
# We need to move all the children of this
830
update_dirblock(from_path_utf8, to_key,
832
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
836
result.append((from_rel, to_rel))
837
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
838
self._make_dirty(reset_inventory=False)
842
def _must_be_locked(self):
843
if not self._control_files._lock_count:
844
raise errors.ObjectNotLocked(self)
847
"""Initialize the state in this tree to be a new tree."""
851
def path2id(self, path):
852
"""Return the id for path in this tree."""
853
path = path.strip('/')
854
entry = self._get_entry(path=path)
855
if entry == (None, None):
859
def paths2ids(self, paths, trees=[], require_versioned=True):
860
"""See Tree.paths2ids().
862
This specialisation fast-paths the case where all the trees are in the
867
parents = self.get_parent_ids()
869
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
871
return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
872
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
873
# -- make all paths utf8 --
876
paths_utf8.add(path.encode('utf8'))
878
# -- paths is now a utf8 path set --
879
# -- get the state object and prepare it.
880
state = self.current_dirstate()
881
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
882
and '' not in paths):
883
paths2ids = self._paths2ids_using_bisect
885
paths2ids = self._paths2ids_in_memory
886
return paths2ids(paths, search_indexes,
887
require_versioned=require_versioned)
889
def _paths2ids_in_memory(self, paths, search_indexes,
890
require_versioned=True):
891
state = self.current_dirstate()
892
state._read_dirblocks_if_needed()
893
def _entries_for_path(path):
894
"""Return a list with all the entries that match path for all ids.
896
dirname, basename = os.path.split(path)
897
key = (dirname, basename, '')
898
block_index, present = state._find_block_index_from_key(key)
900
# the block which should contain path is absent.
903
block = state._dirblocks[block_index][1]
904
entry_index, _ = state._find_entry_index(key, block)
905
# we may need to look at multiple entries at this path: walk while the paths match.
906
while (entry_index < len(block) and
907
block[entry_index][0][0:2] == key[0:2]):
908
result.append(block[entry_index])
911
if require_versioned:
912
# -- check all supplied paths are versioned in a search tree. --
915
path_entries = _entries_for_path(path)
917
# this specified path is not present at all: error
918
all_versioned = False
920
found_versioned = False
921
# for each id at this path
922
for entry in path_entries:
924
for index in search_indexes:
925
if entry[1][index][0] != 'a': # absent
926
found_versioned = True
927
# all good: found a versioned cell
929
if not found_versioned:
930
# none of the indexes was not 'absent' at all ids for this
932
all_versioned = False
934
if not all_versioned:
935
raise errors.PathsNotVersionedError(paths)
936
# -- remove redundancy in supplied paths to prevent over-scanning --
937
search_paths = osutils.minimum_path_selection(paths)
939
# for all search_indexs in each path at or under each element of
940
# search_paths, if the detail is relocated: add the id, and add the
941
# relocated path as one to search if its not searched already. If the
942
# detail is not relocated, add the id.
943
searched_paths = set()
945
def _process_entry(entry):
946
"""Look at search_indexes within entry.
948
If a specific tree's details are relocated, add the relocation
949
target to search_paths if not searched already. If it is absent, do
950
nothing. Otherwise add the id to found_ids.
952
for index in search_indexes:
953
if entry[1][index][0] == 'r': # relocated
954
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
955
search_paths.add(entry[1][index][1])
956
elif entry[1][index][0] != 'a': # absent
957
found_ids.add(entry[0][2])
959
current_root = search_paths.pop()
960
searched_paths.add(current_root)
961
# process the entries for this containing directory: the rest will be
962
# found by their parents recursively.
963
root_entries = _entries_for_path(current_root)
965
# this specified path is not present at all, skip it.
967
for entry in root_entries:
968
_process_entry(entry)
969
initial_key = (current_root, '', '')
970
block_index, _ = state._find_block_index_from_key(initial_key)
971
while (block_index < len(state._dirblocks) and
972
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
973
for entry in state._dirblocks[block_index][1]:
974
_process_entry(entry)
978
def _paths2ids_using_bisect(self, paths, search_indexes,
979
require_versioned=True):
980
state = self.current_dirstate()
983
split_paths = sorted(osutils.split(p) for p in paths)
984
found = state._bisect_recursive(split_paths)
986
if require_versioned:
987
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
988
for dir_name in split_paths:
989
if dir_name not in found_dir_names:
990
raise errors.PathsNotVersionedError(paths)
992
for dir_name_id, trees_info in found.iteritems():
993
for index in search_indexes:
994
if trees_info[index][0] not in ('r', 'a'):
995
found_ids.add(dir_name_id[2])
998
def read_working_inventory(self):
999
"""Read the working inventory.
1001
This is a meaningless operation for dirstate, but we obey it anyhow.
1003
return self.inventory
1006
def revision_tree(self, revision_id):
1007
"""See Tree.revision_tree.
1009
WorkingTree4 supplies revision_trees for any basis tree.
1011
dirstate = self.current_dirstate()
1012
parent_ids = dirstate.get_parent_ids()
1013
if revision_id not in parent_ids:
1014
raise errors.NoSuchRevisionInTree(self, revision_id)
1015
if revision_id in dirstate.get_ghosts():
1016
raise errors.NoSuchRevisionInTree(self, revision_id)
1017
return DirStateRevisionTree(dirstate, revision_id,
1018
self.branch.repository)
1020
@needs_tree_write_lock
1021
def set_last_revision(self, new_revision):
1022
"""Change the last revision in the working tree."""
1023
parents = self.get_parent_ids()
1024
if new_revision in (NULL_REVISION, None):
1025
assert len(parents) < 2, (
1026
"setting the last parent to none with a pending merge is "
1028
self.set_parent_ids([])
1030
self.set_parent_ids([new_revision] + parents[1:],
1031
allow_leftmost_as_ghost=True)
1033
@needs_tree_write_lock
1034
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1035
"""Set the parent ids to revision_ids.
1037
See also set_parent_trees. This api will try to retrieve the tree data
1038
for each element of revision_ids from the trees repository. If you have
1039
tree data already available, it is more efficient to use
1040
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1041
an easier API to use.
1043
:param revision_ids: The revision_ids to set as the parent ids of this
1044
working tree. Any of these may be ghosts.
1047
for revision_id in revision_ids:
1049
revtree = self.branch.repository.revision_tree(revision_id)
1050
# TODO: jam 20070213 KnitVersionedFile raises
1051
# RevisionNotPresent rather than NoSuchRevision if a
1052
# given revision_id is not present. Should Repository be
1053
# catching it and re-raising NoSuchRevision?
1054
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1056
trees.append((revision_id, revtree))
1057
self.set_parent_trees(trees,
1058
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1060
@needs_tree_write_lock
1061
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1062
"""Set the parents of the working tree.
1064
:param parents_list: A list of (revision_id, tree) tuples.
1065
If tree is None, then that element is treated as an unreachable
1066
parent tree - i.e. a ghost.
1068
dirstate = self.current_dirstate()
1069
if len(parents_list) > 0:
1070
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1071
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1074
# convert absent trees to the null tree, which we convert back to
1075
# missing on access.
1076
for rev_id, tree in parents_list:
1077
_mod_revision.check_not_reserved_id(rev_id)
1078
if tree is not None:
1079
real_trees.append((rev_id, tree))
1081
real_trees.append((rev_id,
1082
self.branch.repository.revision_tree(None)))
1083
ghosts.append(rev_id)
1084
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1085
self._make_dirty(reset_inventory=False)
1087
def _set_root_id(self, file_id):
1088
"""See WorkingTree.set_root_id."""
1089
state = self.current_dirstate()
1090
state.set_path_id('', file_id)
1091
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1092
self._make_dirty(reset_inventory=True)
1094
def _sha_from_stat(self, path, stat_result):
1095
"""Get a sha digest from the tree's stat cache.
1097
The default implementation assumes no stat cache is present.
1099
:param path: The path.
1100
:param stat_result: The stat result being looked up.
1102
return self.current_dirstate().sha1_from_stat(path, stat_result)
1105
def supports_tree_reference(self):
1106
return self._repo_supports_tree_reference
1109
"""Unlock in format 4 trees needs to write the entire dirstate."""
1110
# do non-implementation specific cleanup
1113
if self._control_files._lock_count == 1:
1114
# eventually we should do signature checking during read locks for
1116
if self._control_files._lock_mode == 'w':
1119
if self._dirstate is not None:
1120
# This is a no-op if there are no modifications.
1121
self._dirstate.save()
1122
self._dirstate.unlock()
1123
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1124
# point. Instead, it could check if the header has been
1125
# modified when it is locked, and if not, it can hang on to
1126
# the data it has in memory.
1127
self._dirstate = None
1128
self._inventory = None
1129
# reverse order of locking.
1131
return self._control_files.unlock()
1133
self.branch.unlock()
1135
@needs_tree_write_lock
1136
def unversion(self, file_ids):
1137
"""Remove the file ids in file_ids from the current versioned set.
1139
When a file_id is unversioned, all of its children are automatically
1142
:param file_ids: The file ids to stop versioning.
1143
:raises: NoSuchId if any fileid is not currently versioned.
1147
state = self.current_dirstate()
1148
state._read_dirblocks_if_needed()
1149
ids_to_unversion = set(file_ids)
1150
paths_to_unversion = set()
1152
# check if the root is to be unversioned, if so, assert for now.
1153
# walk the state marking unversioned things as absent.
1154
# if there are any un-unversioned ids at the end, raise
1155
for key, details in state._dirblocks[0][1]:
1156
if (details[0][0] not in ('a', 'r') and # absent or relocated
1157
key[2] in ids_to_unversion):
1158
# I haven't written the code to unversion / yet - it should be
1160
raise errors.BzrError('Unversioning the / is not currently supported')
1162
while block_index < len(state._dirblocks):
1163
# process one directory at a time.
1164
block = state._dirblocks[block_index]
1165
# first check: is the path one to remove - it or its children
1166
delete_block = False
1167
for path in paths_to_unversion:
1168
if (block[0].startswith(path) and
1169
(len(block[0]) == len(path) or
1170
block[0][len(path)] == '/')):
1171
# this entire block should be deleted - its the block for a
1172
# path to unversion; or the child of one
1175
# TODO: trim paths_to_unversion as we pass by paths
1177
# this block is to be deleted: process it.
1178
# TODO: we can special case the no-parents case and
1179
# just forget the whole block.
1181
while entry_index < len(block[1]):
1182
# Mark this file id as having been removed
1183
entry = block[1][entry_index]
1184
ids_to_unversion.discard(entry[0][2])
1185
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1187
or not state._make_absent(entry)):
1189
# go to the next block. (At the moment we dont delete empty
1194
while entry_index < len(block[1]):
1195
entry = block[1][entry_index]
1196
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1197
# ^ some parent row.
1198
entry[0][2] not in ids_to_unversion):
1199
# ^ not an id to unversion
1202
if entry[1][0][0] == 'd':
1203
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1204
if not state._make_absent(entry):
1206
# we have unversioned this id
1207
ids_to_unversion.remove(entry[0][2])
1209
if ids_to_unversion:
1210
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1211
self._make_dirty(reset_inventory=False)
1212
# have to change the legacy inventory too.
1213
if self._inventory is not None:
1214
for file_id in file_ids:
1215
self._inventory.remove_recursive_id(file_id)
1217
def update_basis_by_delta(self, new_revid, delta):
1218
"""See MutableTree.update_basis_by_delta."""
1219
assert self.last_revision() != new_revid
1220
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1223
def _validate(self):
1224
self._dirstate._validate()
1226
@needs_tree_write_lock
1227
def _write_inventory(self, inv):
1228
"""Write inventory as the current inventory."""
1229
assert not self._dirty, ("attempting to write an inventory when the "
1230
"dirstate is dirty will cause data loss")
1231
self.current_dirstate().set_state_from_inventory(inv)
1232
self._make_dirty(reset_inventory=False)
1233
if self._inventory is not None:
1234
self._inventory = inv
1238
class WorkingTreeFormat4(WorkingTreeFormat3):
1239
"""The first consolidated dirstate working tree format.
1242
- exists within a metadir controlling .bzr
1243
- includes an explicit version marker for the workingtree control
1244
files, separate from the BzrDir format
1245
- modifies the hash cache format
1246
- is new in bzr 0.15
1247
- uses a LockDir to guard access to it.
1250
upgrade_recommended = False
1252
def get_format_string(self):
1253
"""See WorkingTreeFormat.get_format_string()."""
1254
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1256
def get_format_description(self):
1257
"""See WorkingTreeFormat.get_format_description()."""
1258
return "Working tree format 4"
1260
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
1261
"""See WorkingTreeFormat.initialize().
1263
:param revision_id: allows creating a working tree at a different
1264
revision than the branch is at.
1266
These trees get an initial random root id, if their repository supports
1267
rich root data, TREE_ROOT otherwise.
1269
if not isinstance(a_bzrdir.transport, LocalTransport):
1270
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1271
transport = a_bzrdir.get_workingtree_transport(self)
1272
control_files = self._open_control_files(a_bzrdir)
1273
control_files.create_lock()
1274
control_files.lock_write()
1275
control_files.put_utf8('format', self.get_format_string())
1276
if from_branch is not None:
1277
branch = from_branch
1279
branch = a_bzrdir.open_branch()
1280
if revision_id is None:
1281
revision_id = branch.last_revision()
1282
local_path = transport.local_abspath('dirstate')
1283
# write out new dirstate (must exist when we create the tree)
1284
state = dirstate.DirState.initialize(local_path)
1287
wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1291
_control_files=control_files)
1293
wt.lock_tree_write()
1295
if revision_id in (None, NULL_REVISION):
1296
if branch.repository.supports_rich_root():
1297
wt._set_root_id(generate_ids.gen_root_id())
1299
wt._set_root_id(ROOT_ID)
1301
wt.set_last_revision(revision_id)
1303
basis = wt.basis_tree()
1305
# if the basis has a root id we have to use that; otherwise we use
1307
basis_root_id = basis.get_root_id()
1308
if basis_root_id is not None:
1309
wt._set_root_id(basis_root_id)
1311
transform.build_tree(basis, wt)
1314
control_files.unlock()
1318
def _open(self, a_bzrdir, control_files):
1319
"""Open the tree itself.
1321
:param a_bzrdir: the dir for the tree.
1322
:param control_files: the control files for the tree.
1324
return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1325
branch=a_bzrdir.open_branch(),
1328
_control_files=control_files)
1330
def __get_matchingbzrdir(self):
1331
# please test against something that will let us do tree references
1332
return bzrdir.format_registry.make_bzrdir(
1333
'dirstate-with-subtree')
1335
_matchingbzrdir = property(__get_matchingbzrdir)
1338
class DirStateRevisionTree(Tree):
1339
"""A revision tree pulling the inventory from a dirstate."""
1341
def __init__(self, dirstate, revision_id, repository):
1342
self._dirstate = dirstate
1343
self._revision_id = revision_id
1344
self._repository = repository
1345
self._inventory = None
1347
self._dirstate_locked = False
1350
return "<%s of %s in %s>" % \
1351
(self.__class__.__name__, self._revision_id, self._dirstate)
1353
def annotate_iter(self, file_id,
1354
default_revision=_mod_revision.CURRENT_REVISION):
1355
"""See Tree.annotate_iter"""
1356
w = self._get_weave(file_id)
1357
return w.annotate_iter(self.inventory[file_id].revision)
1359
def _get_ancestors(self, default_revision):
1360
return set(self._repository.get_ancestry(self._revision_id,
1362
def _comparison_data(self, entry, path):
1363
"""See Tree._comparison_data."""
1365
return None, False, None
1366
# trust the entry as RevisionTree does, but this may not be
1367
# sensible: the entry might not have come from us?
1368
return entry.kind, entry.executable, None
1370
def _file_size(self, entry, stat_value):
1371
return entry.text_size
1373
def filter_unversioned_files(self, paths):
1374
"""Filter out paths that are not versioned.
1376
:return: set of paths.
1378
pred = self.has_filename
1379
return set((p for p in paths if not pred(p)))
1381
def get_root_id(self):
1382
return self.path2id('')
1384
def id2path(self, file_id):
1385
"Convert a file-id to a path."
1386
entry = self._get_entry(file_id=file_id)
1387
if entry == (None, None):
1388
raise errors.NoSuchId(tree=self, file_id=file_id)
1389
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1390
return path_utf8.decode('utf8')
1392
def _get_parent_index(self):
1393
"""Return the index in the dirstate referenced by this tree."""
1394
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1396
def _get_entry(self, file_id=None, path=None):
1397
"""Get the dirstate row for file_id or path.
1399
If either file_id or path is supplied, it is used as the key to lookup.
1400
If both are supplied, the fastest lookup is used, and an error is
1401
raised if they do not both point at the same row.
1403
:param file_id: An optional unicode file_id to be looked up.
1404
:param path: An optional unicode path to be looked up.
1405
:return: The dirstate row tuple for path/file_id, or (None, None)
1407
if file_id is None and path is None:
1408
raise errors.BzrError('must supply file_id or path')
1409
if path is not None:
1410
path = path.encode('utf8')
1411
parent_index = self._get_parent_index()
1412
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1414
def _generate_inventory(self):
1415
"""Create and set self.inventory from the dirstate object.
1417
(So this is only called the first time the inventory is requested for
1418
this tree; it then remains in memory until it's out of date.)
1420
This is relatively expensive: we have to walk the entire dirstate.
1422
assert self._locked, 'cannot generate inventory of an unlocked '\
1423
'dirstate revision tree'
1424
# separate call for profiling - makes it clear where the costs are.
1425
self._dirstate._read_dirblocks_if_needed()
1426
assert self._revision_id in self._dirstate.get_parent_ids(), \
1427
'parent %s has disappeared from %s' % (
1428
self._revision_id, self._dirstate.get_parent_ids())
1429
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1430
# This is identical now to the WorkingTree _generate_inventory except
1431
# for the tree index use.
1432
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1433
current_id = root_key[2]
1434
assert current_entry[parent_index][0] == 'd'
1435
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1436
inv.root.revision = current_entry[parent_index][4]
1437
# Turn some things into local variables
1438
minikind_to_kind = dirstate.DirState._minikind_to_kind
1439
factory = entry_factory
1440
utf8_decode = cache_utf8._utf8_decode
1441
inv_byid = inv._byid
1442
# we could do this straight out of the dirstate; it might be fast
1443
# and should be profiled - RBC 20070216
1444
parent_ies = {'' : inv.root}
1445
for block in self._dirstate._dirblocks[1:]: #skip root
1448
parent_ie = parent_ies[dirname]
1450
# all the paths in this block are not versioned in this tree
1452
for key, entry in block[1]:
1453
minikind, fingerprint, size, executable, revid = entry[parent_index]
1454
if minikind in ('a', 'r'): # absent, relocated
1458
name_unicode = utf8_decode(name)[0]
1460
kind = minikind_to_kind[minikind]
1461
inv_entry = factory[kind](file_id, name_unicode,
1463
inv_entry.revision = revid
1465
inv_entry.executable = executable
1466
inv_entry.text_size = size
1467
inv_entry.text_sha1 = fingerprint
1468
elif kind == 'directory':
1469
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1470
elif kind == 'symlink':
1471
inv_entry.executable = False
1472
inv_entry.text_size = None
1473
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1474
elif kind == 'tree-reference':
1475
inv_entry.reference_revision = fingerprint or None
1477
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1479
# These checks cost us around 40ms on a 55k entry tree
1480
assert file_id not in inv_byid
1481
assert name_unicode not in parent_ie.children
1482
inv_byid[file_id] = inv_entry
1483
parent_ie.children[name_unicode] = inv_entry
1484
self._inventory = inv
1486
def get_file_mtime(self, file_id, path=None):
1487
"""Return the modification time for this record.
1489
We return the timestamp of the last-changed revision.
1491
# Make sure the file exists
1492
entry = self._get_entry(file_id, path=path)
1493
if entry == (None, None): # do we raise?
1495
parent_index = self._get_parent_index()
1496
last_changed_revision = entry[1][parent_index][4]
1497
return self._repository.get_revision(last_changed_revision).timestamp
1499
def get_file_sha1(self, file_id, path=None, stat_value=None):
1500
entry = self._get_entry(file_id=file_id, path=path)
1501
parent_index = self._get_parent_index()
1502
parent_details = entry[1][parent_index]
1503
if parent_details[0] == 'f':
1504
return parent_details[1]
1507
@symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
1508
def get_weave(self, file_id):
1509
return self._get_weave(file_id)
1511
def _get_weave(self, file_id):
1512
return self._repository.weave_store.get_weave(file_id,
1513
self._repository.get_transaction())
1515
def get_file(self, file_id, path=None):
1516
return StringIO(self.get_file_text(file_id))
1518
def get_file_lines(self, file_id):
1519
entry = self._get_entry(file_id=file_id)[1]
1521
raise errors.NoSuchId(tree=self, file_id=file_id)
1522
return self._get_weave(file_id).get_lines(entry[1][4])
1524
def get_file_size(self, file_id):
1525
return self.inventory[file_id].text_size
1527
def get_file_text(self, file_id):
1528
return ''.join(self.get_file_lines(file_id))
1530
def get_reference_revision(self, file_id, path=None):
1531
return self.inventory[file_id].reference_revision
1533
def iter_files_bytes(self, desired_files):
1534
"""See Tree.iter_files_bytes.
1536
This version is implemented on top of Repository.iter_files_bytes"""
1537
parent_index = self._get_parent_index()
1538
repo_desired_files = []
1539
for file_id, identifier in desired_files:
1540
entry = self._get_entry(file_id)
1541
if entry == (None, None):
1542
raise errors.NoSuchId(self, file_id)
1543
repo_desired_files.append((file_id, entry[1][parent_index][4],
1545
return self._repository.iter_files_bytes(repo_desired_files)
1547
def get_symlink_target(self, file_id):
1548
entry = self._get_entry(file_id=file_id)
1549
parent_index = self._get_parent_index()
1550
if entry[1][parent_index][0] != 'l':
1553
# At present, none of the tree implementations supports non-ascii
1554
# symlink targets. So we will just assume that the dirstate path is
1556
return entry[1][parent_index][1]
1558
def get_revision_id(self):
1559
"""Return the revision id for this tree."""
1560
return self._revision_id
1562
def _get_inventory(self):
1563
if self._inventory is not None:
1564
return self._inventory
1565
self._must_be_locked()
1566
self._generate_inventory()
1567
return self._inventory
1569
inventory = property(_get_inventory,
1570
doc="Inventory of this Tree")
1572
def get_parent_ids(self):
1573
"""The parents of a tree in the dirstate are not cached."""
1574
return self._repository.get_revision(self._revision_id).parent_ids
1576
def has_filename(self, filename):
1577
return bool(self.path2id(filename))
1579
def kind(self, file_id):
1580
entry = self._get_entry(file_id=file_id)[1]
1582
raise errors.NoSuchId(tree=self, file_id=file_id)
1583
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1585
def path_content_summary(self, path):
1586
"""See Tree.path_content_summary."""
1587
id = self.inventory.path2id(path)
1589
return ('missing', None, None, None)
1590
entry = self._inventory[id]
1593
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1594
elif kind == 'symlink':
1595
return (kind, None, None, entry.symlink_target)
1597
return (kind, None, None, None)
1599
def is_executable(self, file_id, path=None):
1600
ie = self.inventory[file_id]
1601
if ie.kind != "file":
1603
return ie.executable
1605
def list_files(self, include_root=False):
1606
# We use a standard implementation, because DirStateRevisionTree is
1607
# dealing with one of the parents of the current state
1608
inv = self._get_inventory()
1609
entries = inv.iter_entries()
1610
if self.inventory.root is not None and not include_root:
1612
for path, entry in entries:
1613
yield path, 'V', entry.kind, entry.file_id, entry
1615
def lock_read(self):
1616
"""Lock the tree for a set of operations."""
1617
if not self._locked:
1618
self._repository.lock_read()
1619
if self._dirstate._lock_token is None:
1620
self._dirstate.lock_read()
1621
self._dirstate_locked = True
1624
def _must_be_locked(self):
1625
if not self._locked:
1626
raise errors.ObjectNotLocked(self)
1629
def path2id(self, path):
1630
"""Return the id for path in this tree."""
1631
# lookup by path: faster than splitting and walking the ivnentory.
1632
entry = self._get_entry(path=path)
1633
if entry == (None, None):
1638
"""Unlock, freeing any cache memory used during the lock."""
1639
# outside of a lock, the inventory is suspect: release it.
1641
if not self._locked:
1642
self._inventory = None
1644
if self._dirstate_locked:
1645
self._dirstate.unlock()
1646
self._dirstate_locked = False
1647
self._repository.unlock()
1649
def walkdirs(self, prefix=""):
1650
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1651
# implementation based on an inventory.
1652
# This should be cleaned up to use the much faster Dirstate code
1653
# So for now, we just build up the parent inventory, and extract
1654
# it the same way RevisionTree does.
1655
_directory = 'directory'
1656
inv = self._get_inventory()
1657
top_id = inv.path2id(prefix)
1661
pending = [(prefix, top_id)]
1664
relpath, file_id = pending.pop()
1665
# 0 - relpath, 1- file-id
1667
relroot = relpath + '/'
1670
# FIXME: stash the node in pending
1671
entry = inv[file_id]
1672
for name, child in entry.sorted_children():
1673
toppath = relroot + name
1674
dirblock.append((toppath, name, child.kind, None,
1675
child.file_id, child.kind
1677
yield (relpath, entry.file_id), dirblock
1678
# push the user specified dirs from dirblock
1679
for dir in reversed(dirblock):
1680
if dir[2] == _directory:
1681
pending.append((dir[0], dir[4]))
1684
class InterDirStateTree(InterTree):
1685
"""Fast path optimiser for changes_from with dirstate trees.
1687
This is used only when both trees are in the dirstate working file, and
1688
the source is any parent within the dirstate, and the destination is
1689
the current working tree of the same dirstate.
1691
# this could be generalized to allow comparisons between any trees in the
1692
# dirstate, and possibly between trees stored in different dirstates.
1694
def __init__(self, source, target):
1695
super(InterDirStateTree, self).__init__(source, target)
1696
if not InterDirStateTree.is_compatible(source, target):
1697
raise Exception, "invalid source %r and target %r" % (source, target)
1700
def make_source_parent_tree(source, target):
1701
"""Change the source tree into a parent of the target."""
1702
revid = source.commit('record tree')
1703
target.branch.repository.fetch(source.branch.repository, revid)
1704
target.set_parent_ids([revid])
1705
return target.basis_tree(), target
1707
_matching_from_tree_format = WorkingTreeFormat4()
1708
_matching_to_tree_format = WorkingTreeFormat4()
1709
_test_mutable_trees_to_test_trees = make_source_parent_tree
1711
def _iter_changes(self, include_unchanged=False,
1712
specific_files=None, pb=None, extra_trees=[],
1713
require_versioned=True, want_unversioned=False):
1714
"""Return the changes from source to target.
1716
:return: An iterator that yields tuples. See InterTree._iter_changes
1718
:param specific_files: An optional list of file paths to restrict the
1719
comparison to. When mapping filenames to ids, all matches in all
1720
trees (including optional extra_trees) are used, and all children of
1721
matched directories are included.
1722
:param include_unchanged: An optional boolean requesting the inclusion of
1723
unchanged entries in the result.
1724
:param extra_trees: An optional list of additional trees to use when
1725
mapping the contents of specific_files (paths) to file_ids.
1726
:param require_versioned: If True, all files in specific_files must be
1727
versioned in one of source, target, extra_trees or
1728
PathsNotVersionedError is raised.
1729
:param want_unversioned: Should unversioned files be returned in the
1730
output. An unversioned file is defined as one with (False, False)
1731
for the versioned pair.
1733
utf8_decode = cache_utf8._utf8_decode
1734
_minikind_to_kind = dirstate.DirState._minikind_to_kind
1735
cmp_by_dirs = dirstate.cmp_by_dirs
1736
# NB: show_status depends on being able to pass in non-versioned files
1737
# and report them as unknown
1738
# TODO: handle extra trees in the dirstate.
1739
if (extra_trees or specific_files == []):
1740
# we can't fast-path these cases (yet)
1741
for f in super(InterDirStateTree, self)._iter_changes(
1742
include_unchanged, specific_files, pb, extra_trees,
1743
require_versioned, want_unversioned=want_unversioned):
1746
parent_ids = self.target.get_parent_ids()
1747
assert (self.source._revision_id in parent_ids
1748
or self.source._revision_id == NULL_REVISION), \
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())