1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree4 format and implementation.
19
WorkingTree4 provides the dirstate based working tree logic.
21
To get a WorkingTree, call bzrdir.open_workingtree() or
22
WorkingTree.open(dir).
25
from cStringIO import StringIO
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
31
from bisect import bisect_left
33
from copy import deepcopy
45
conflicts as _mod_conflicts,
55
revision as _mod_revision,
65
from bzrlib.transport import get_transport
69
from bzrlib import symbol_versioning
70
from bzrlib.decorators import needs_read_lock, needs_write_lock
71
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
72
from bzrlib.lockable_files import LockableFiles, TransportLock
73
from bzrlib.lockdir import LockDir
74
import bzrlib.mutabletree
75
from bzrlib.mutabletree import needs_tree_write_lock
76
from bzrlib.osutils import (
86
from bzrlib.trace import mutter, note
87
from bzrlib.transport.local import LocalTransport
88
from bzrlib.tree import InterTree
89
from bzrlib.progress import DummyProgress, ProgressPhase
90
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
91
from bzrlib.rio import RioReader, rio_file, Stanza
92
from bzrlib.symbol_versioning import (deprecated_passed,
97
from bzrlib.tree import Tree
98
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
101
# This is the Windows equivalent of ENOTDIR
102
# It is defined in pywin32.winerror, but we don't want a strong dependency for
103
# just an error code.
104
ERROR_PATH_NOT_FOUND = 3
105
ERROR_DIRECTORY = 267
108
class WorkingTree4(WorkingTree3):
109
"""This is the Format 4 working tree.
111
This differs from WorkingTree3 by:
112
- Having a consolidated internal dirstate, stored in a
113
randomly-accessible sorted file on disk.
114
- Not having a regular inventory attribute. One can be synthesized
115
on demand but this is expensive and should be avoided.
117
This is new in bzr 0.15.
120
def __init__(self, basedir,
125
"""Construct a WorkingTree for basedir.
127
If the branch is not supplied, it is opened automatically.
128
If the branch is supplied, it must be the branch for this basedir.
129
(branch.base is not cross checked, because for remote branches that
130
would be meaningless).
132
self._format = _format
133
self.bzrdir = _bzrdir
134
basedir = safe_unicode(basedir)
135
mutter("opening working tree %r", basedir)
136
self._branch = branch
137
self.basedir = realpath(basedir)
138
# if branch is at our basedir and is a format 6 or less
139
# assume all other formats have their own control files.
140
self._control_files = _control_files
141
self._transport = self._control_files._transport
144
# during a read or write lock these objects are set, and are
145
# None the rest of the time.
146
self._dirstate = None
147
self._inventory = None
149
self._setup_directory_is_tree_reference()
150
self._detect_case_handling()
151
self._rules_searcher = None
153
@needs_tree_write_lock
154
def _add(self, files, ids, kinds):
155
"""See MutableTree._add."""
156
state = self.current_dirstate()
157
for f, file_id, kind in zip(files, ids, kinds):
160
# special case tree root handling.
161
if f == '' and self.path2id(f) == ROOT_ID:
162
state.set_path_id('', generate_ids.gen_file_id(f))
165
file_id = generate_ids.gen_file_id(f)
166
# deliberately add the file with no cached stat or sha1
167
# - on the first access it will be gathered, and we can
168
# always change this once tests are all passing.
169
state.add(f, file_id, kind, None, '')
170
self._make_dirty(reset_inventory=True)
172
def _make_dirty(self, reset_inventory):
173
"""Make the tree state dirty.
175
:param reset_inventory: True if the cached inventory should be removed
176
(presuming there is one).
179
if reset_inventory and self._inventory is not None:
180
self._inventory = None
182
@needs_tree_write_lock
183
def add_reference(self, sub_tree):
184
# use standard implementation, which calls back to self._add
186
# So we don't store the reference_revision in the working dirstate,
187
# it's just recorded at the moment of commit.
188
self._add_reference(sub_tree)
190
def break_lock(self):
191
"""Break a lock if one is present from another instance.
193
Uses the ui factory to ask for confirmation if the lock may be from
196
This will probe the repository for its lock as well.
198
# if the dirstate is locked by an active process, reject the break lock
201
if self._dirstate is None:
205
state = self._current_dirstate()
206
if state._lock_token is not None:
207
# we already have it locked. sheese, cant break our own lock.
208
raise errors.LockActive(self.basedir)
211
# try for a write lock - need permission to get one anyhow
214
except errors.LockContention:
215
# oslocks fail when a process is still live: fail.
216
# TODO: get the locked lockdir info and give to the user to
217
# assist in debugging.
218
raise errors.LockActive(self.basedir)
223
self._dirstate = None
224
self._control_files.break_lock()
225
self.branch.break_lock()
227
def _comparison_data(self, entry, path):
228
kind, executable, stat_value = \
229
WorkingTree3._comparison_data(self, entry, path)
230
# it looks like a plain directory, but it's really a reference -- see
232
if (self._repo_supports_tree_reference and
233
kind == 'directory' and
234
self._directory_is_tree_reference(path)):
235
kind = 'tree-reference'
236
return kind, executable, stat_value
239
def commit(self, message=None, revprops=None, *args, **kwargs):
240
# mark the tree as dirty post commit - commit
241
# can change the current versioned list by doing deletes.
242
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
243
self._make_dirty(reset_inventory=True)
246
def current_dirstate(self):
247
"""Return the current dirstate object.
249
This is not part of the tree interface and only exposed for ease of
252
:raises errors.NotWriteLocked: when not in a lock.
254
self._must_be_locked()
255
return self._current_dirstate()
257
def _current_dirstate(self):
258
"""Internal function that does not check lock status.
260
This is needed for break_lock which also needs the dirstate.
262
if self._dirstate is not None:
263
return self._dirstate
264
local_path = self.bzrdir.get_workingtree_transport(None
265
).local_abspath('dirstate')
266
self._dirstate = dirstate.DirState.on_file(local_path)
267
return self._dirstate
269
def filter_unversioned_files(self, paths):
270
"""Filter out paths that are versioned.
272
:return: set of paths.
274
# TODO: make a generic multi-bisect routine roughly that should list
275
# the paths, then process one half at a time recursively, and feed the
276
# results of each bisect in further still
277
paths = sorted(paths)
279
state = self.current_dirstate()
280
# TODO we want a paths_to_dirblocks helper I think
282
dirname, basename = os.path.split(path.encode('utf8'))
283
_, _, _, path_is_versioned = state._get_block_entry_index(
284
dirname, basename, 0)
285
if not path_is_versioned:
290
"""Write all cached data to disk."""
291
if self._control_files._lock_mode != 'w':
292
raise errors.NotWriteLocked(self)
293
self.current_dirstate().save()
294
self._inventory = None
297
@needs_tree_write_lock
298
def _gather_kinds(self, files, kinds):
299
"""See MutableTree._gather_kinds."""
300
for pos, f in enumerate(files):
301
if kinds[pos] is None:
302
kinds[pos] = self._kind(f)
304
def _generate_inventory(self):
305
"""Create and set self.inventory from the dirstate object.
307
This is relatively expensive: we have to walk the entire dirstate.
308
Ideally we would not, and can deprecate this function.
310
#: uncomment to trap on inventory requests.
311
# import pdb;pdb.set_trace()
312
state = self.current_dirstate()
313
state._read_dirblocks_if_needed()
314
root_key, current_entry = self._get_entry(path='')
315
current_id = root_key[2]
316
if not (current_entry[0][0] == 'd'): # directory
317
raise AssertionError(current_entry)
318
inv = Inventory(root_id=current_id)
319
# Turn some things into local variables
320
minikind_to_kind = dirstate.DirState._minikind_to_kind
321
factory = entry_factory
322
utf8_decode = cache_utf8._utf8_decode
324
# we could do this straight out of the dirstate; it might be fast
325
# and should be profiled - RBC 20070216
326
parent_ies = {'' : inv.root}
327
for block in state._dirblocks[1:]: # skip the root
330
parent_ie = parent_ies[dirname]
332
# all the paths in this block are not versioned in this tree
334
for key, entry in block[1]:
335
minikind, link_or_sha1, size, executable, stat = entry[0]
336
if minikind in ('a', 'r'): # absent, relocated
337
# a parent tree only entry
340
name_unicode = utf8_decode(name)[0]
342
kind = minikind_to_kind[minikind]
343
inv_entry = factory[kind](file_id, name_unicode,
346
# This is only needed on win32, where this is the only way
347
# we know the executable bit.
348
inv_entry.executable = executable
349
# not strictly needed: working tree
350
#inv_entry.text_size = size
351
#inv_entry.text_sha1 = sha1
352
elif kind == 'directory':
353
# add this entry to the parent map.
354
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
355
elif kind == 'tree-reference':
356
if not self._repo_supports_tree_reference:
357
raise AssertionError(
359
"doesn't support tree references "
360
"required by entry %r"
362
inv_entry.reference_revision = link_or_sha1 or None
363
elif kind != 'symlink':
364
raise AssertionError("unknown kind %r" % kind)
365
# These checks cost us around 40ms on a 55k entry tree
366
if file_id in inv_byid:
367
raise AssertionError('file_id %s already in'
368
' inventory as %s' % (file_id, inv_byid[file_id]))
369
if name_unicode in parent_ie.children:
370
raise AssertionError('name %r already in parent'
372
inv_byid[file_id] = inv_entry
373
parent_ie.children[name_unicode] = inv_entry
374
self._inventory = inv
376
def _get_entry(self, file_id=None, path=None):
377
"""Get the dirstate row for file_id or path.
379
If either file_id or path is supplied, it is used as the key to lookup.
380
If both are supplied, the fastest lookup is used, and an error is
381
raised if they do not both point at the same row.
383
:param file_id: An optional unicode file_id to be looked up.
384
:param path: An optional unicode path to be looked up.
385
:return: The dirstate row tuple for path/file_id, or (None, None)
387
if file_id is None and path is None:
388
raise errors.BzrError('must supply file_id or path')
389
state = self.current_dirstate()
391
path = path.encode('utf8')
392
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
394
def get_file_sha1(self, file_id, path=None, stat_value=None):
395
# check file id is valid unconditionally.
396
entry = self._get_entry(file_id=file_id, path=path)
398
raise errors.NoSuchId(self, file_id)
400
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
402
file_abspath = self.abspath(path)
403
state = self.current_dirstate()
404
if stat_value is None:
406
stat_value = os.lstat(file_abspath)
408
if e.errno == errno.ENOENT:
412
link_or_sha1 = state.update_entry(entry, file_abspath,
413
stat_value=stat_value)
414
if entry[1][0][0] == 'f':
418
def _get_inventory(self):
419
"""Get the inventory for the tree. This is only valid within a lock."""
420
if 'evil' in debug.debug_flags:
421
trace.mutter_callsite(2,
422
"accessing .inventory forces a size of tree translation.")
423
if self._inventory is not None:
424
return self._inventory
425
self._must_be_locked()
426
self._generate_inventory()
427
return self._inventory
429
inventory = property(_get_inventory,
430
doc="Inventory of this Tree")
433
def get_parent_ids(self):
434
"""See Tree.get_parent_ids.
436
This implementation requests the ids list from the dirstate file.
438
return self.current_dirstate().get_parent_ids()
440
def get_reference_revision(self, file_id, path=None):
441
# referenced tree's revision is whatever's currently there
442
return self.get_nested_tree(file_id, path).last_revision()
444
def get_nested_tree(self, file_id, path=None):
446
path = self.id2path(file_id)
447
# else: check file_id is at path?
448
return WorkingTree.open(self.abspath(path))
451
def get_root_id(self):
452
"""Return the id of this trees root"""
453
return self._get_entry(path='')[0][2]
455
def has_id(self, file_id):
456
state = self.current_dirstate()
457
row, parents = self._get_entry(file_id=file_id)
460
return osutils.lexists(pathjoin(
461
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
464
def id2path(self, file_id):
465
"Convert a file-id to a path."
466
state = self.current_dirstate()
467
entry = self._get_entry(file_id=file_id)
468
if entry == (None, None):
469
raise errors.NoSuchId(tree=self, file_id=file_id)
470
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
471
return path_utf8.decode('utf8')
473
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
474
entry = self._get_entry(path=path)
475
if entry == (None, None):
476
return False # Missing entries are not executable
477
return entry[1][0][3] # Executable?
479
if not osutils.supports_executable():
480
def is_executable(self, file_id, path=None):
481
"""Test if a file is executable or not.
483
Note: The caller is expected to take a read-lock before calling this.
485
entry = self._get_entry(file_id=file_id, path=path)
486
if entry == (None, None):
488
return entry[1][0][3]
490
_is_executable_from_path_and_stat = \
491
_is_executable_from_path_and_stat_from_basis
493
def is_executable(self, file_id, path=None):
494
"""Test if a file is executable or not.
496
Note: The caller is expected to take a read-lock before calling this.
498
self._must_be_locked()
500
path = self.id2path(file_id)
501
mode = os.lstat(self.abspath(path)).st_mode
502
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
504
def all_file_ids(self):
505
"""See Tree.iter_all_file_ids"""
506
self._must_be_locked()
508
for key, tree_details in self.current_dirstate()._iter_entries():
509
if tree_details[0][0] in ('a', 'r'): # relocated
516
"""Iterate through file_ids for this tree.
518
file_ids are in a WorkingTree if they are in the working inventory
519
and the working file exists.
522
for key, tree_details in self.current_dirstate()._iter_entries():
523
if tree_details[0][0] in ('a', 'r'): # absent, relocated
524
# not relevant to the working tree
526
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
527
if osutils.lexists(path):
528
result.append(key[2])
531
def iter_references(self):
532
if not self._repo_supports_tree_reference:
533
# When the repo doesn't support references, we will have nothing to
536
for key, tree_details in self.current_dirstate()._iter_entries():
537
if tree_details[0][0] in ('a', 'r'): # absent, relocated
538
# not relevant to the working tree
541
# the root is not a reference.
543
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
545
if self._kind(relpath) == 'tree-reference':
546
yield relpath, key[2]
547
except errors.NoSuchFile:
548
# path is missing on disk.
551
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
552
"""See MutableTree._observed_sha1."""
553
state = self.current_dirstate()
554
entry = self._get_entry(file_id=file_id, path=path)
555
state._observed_sha1(entry, sha1, statvalue)
557
def kind(self, file_id):
558
"""Return the kind of a file.
560
This is always the actual kind that's on disk, regardless of what it
563
Note: The caller is expected to take a read-lock before calling this.
565
relpath = self.id2path(file_id)
567
raise AssertionError(
568
"path for id {%s} is None!" % file_id)
569
return self._kind(relpath)
571
def _kind(self, relpath):
572
abspath = self.abspath(relpath)
573
kind = file_kind(abspath)
574
if (self._repo_supports_tree_reference and
575
kind == 'directory' and
576
self._directory_is_tree_reference(relpath)):
577
kind = 'tree-reference'
581
def _last_revision(self):
582
"""See Mutable.last_revision."""
583
parent_ids = self.current_dirstate().get_parent_ids()
587
return _mod_revision.NULL_REVISION
590
"""See Branch.lock_read, and WorkingTree.unlock."""
591
self.branch.lock_read()
593
self._control_files.lock_read()
595
state = self.current_dirstate()
596
if not state._lock_token:
598
# set our support for tree references from the repository in
600
self._repo_supports_tree_reference = getattr(
601
self.branch.repository._format, "supports_tree_reference",
604
self._control_files.unlock()
610
def _lock_self_write(self):
611
"""This should be called after the branch is locked."""
613
self._control_files.lock_write()
615
state = self.current_dirstate()
616
if not state._lock_token:
618
# set our support for tree references from the repository in
620
self._repo_supports_tree_reference = getattr(
621
self.branch.repository._format, "supports_tree_reference",
624
self._control_files.unlock()
630
def lock_tree_write(self):
631
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
632
self.branch.lock_read()
633
self._lock_self_write()
635
def lock_write(self):
636
"""See MutableTree.lock_write, and WorkingTree.unlock."""
637
self.branch.lock_write()
638
self._lock_self_write()
640
@needs_tree_write_lock
641
def move(self, from_paths, to_dir, after=False):
642
"""See WorkingTree.move()."""
646
state = self.current_dirstate()
647
if isinstance(from_paths, basestring):
649
to_dir_utf8 = to_dir.encode('utf8')
650
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
651
id_index = state._get_id_index()
652
# check destination directory
653
# get the details for it
654
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
655
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
656
if not entry_present:
657
raise errors.BzrMoveFailedError('', to_dir,
658
errors.NotVersionedError(to_dir))
659
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
660
# get a handle on the block itself.
661
to_block_index = state._ensure_block(
662
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
663
to_block = state._dirblocks[to_block_index]
664
to_abs = self.abspath(to_dir)
665
if not isdir(to_abs):
666
raise errors.BzrMoveFailedError('',to_dir,
667
errors.NotADirectory(to_abs))
669
if to_entry[1][0][0] != 'd':
670
raise errors.BzrMoveFailedError('',to_dir,
671
errors.NotADirectory(to_abs))
673
if self._inventory is not None:
674
update_inventory = True
676
to_dir_id = to_entry[0][2]
677
to_dir_ie = inv[to_dir_id]
679
update_inventory = False
682
def move_one(old_entry, from_path_utf8, minikind, executable,
683
fingerprint, packed_stat, size,
684
to_block, to_key, to_path_utf8):
685
state._make_absent(old_entry)
686
from_key = old_entry[0]
688
lambda:state.update_minimal(from_key,
690
executable=executable,
691
fingerprint=fingerprint,
692
packed_stat=packed_stat,
694
path_utf8=from_path_utf8))
695
state.update_minimal(to_key,
697
executable=executable,
698
fingerprint=fingerprint,
699
packed_stat=packed_stat,
701
path_utf8=to_path_utf8)
702
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
703
new_entry = to_block[1][added_entry_index]
704
rollbacks.append(lambda:state._make_absent(new_entry))
706
for from_rel in from_paths:
707
# from_rel is 'pathinroot/foo/bar'
708
from_rel_utf8 = from_rel.encode('utf8')
709
from_dirname, from_tail = osutils.split(from_rel)
710
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
711
from_entry = self._get_entry(path=from_rel)
712
if from_entry == (None, None):
713
raise errors.BzrMoveFailedError(from_rel,to_dir,
714
errors.NotVersionedError(path=str(from_rel)))
716
from_id = from_entry[0][2]
717
to_rel = pathjoin(to_dir, from_tail)
718
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
719
item_to_entry = self._get_entry(path=to_rel)
720
if item_to_entry != (None, None):
721
raise errors.BzrMoveFailedError(from_rel, to_rel,
722
"Target is already versioned.")
724
if from_rel == to_rel:
725
raise errors.BzrMoveFailedError(from_rel, to_rel,
726
"Source and target are identical.")
728
from_missing = not self.has_filename(from_rel)
729
to_missing = not self.has_filename(to_rel)
736
raise errors.BzrMoveFailedError(from_rel, to_rel,
737
errors.NoSuchFile(path=to_rel,
738
extra="New file has not been created yet"))
740
# neither path exists
741
raise errors.BzrRenameFailedError(from_rel, to_rel,
742
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
744
if from_missing: # implicitly just update our path mapping
747
raise errors.RenameFailedFilesExist(from_rel, to_rel)
750
def rollback_rename():
751
"""A single rename has failed, roll it back."""
752
# roll back everything, even if we encounter trouble doing one
755
# TODO: at least log the other exceptions rather than just
756
# losing them mbp 20070307
758
for rollback in reversed(rollbacks):
762
exc_info = sys.exc_info()
764
raise exc_info[0], exc_info[1], exc_info[2]
766
# perform the disk move first - its the most likely failure point.
768
from_rel_abs = self.abspath(from_rel)
769
to_rel_abs = self.abspath(to_rel)
771
osutils.rename(from_rel_abs, to_rel_abs)
773
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
774
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
776
# perform the rename in the inventory next if needed: its easy
780
from_entry = inv[from_id]
781
current_parent = from_entry.parent_id
782
inv.rename(from_id, to_dir_id, from_tail)
784
lambda: inv.rename(from_id, current_parent, from_tail))
785
# finally do the rename in the dirstate, which is a little
786
# tricky to rollback, but least likely to need it.
787
old_block_index, old_entry_index, dir_present, file_present = \
788
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
789
old_block = state._dirblocks[old_block_index][1]
790
old_entry = old_block[old_entry_index]
791
from_key, old_entry_details = old_entry
792
cur_details = old_entry_details[0]
794
to_key = ((to_block[0],) + from_key[1:3])
795
minikind = cur_details[0]
796
move_one(old_entry, from_path_utf8=from_rel_utf8,
798
executable=cur_details[3],
799
fingerprint=cur_details[1],
800
packed_stat=cur_details[4],
804
to_path_utf8=to_rel_utf8)
807
def update_dirblock(from_dir, to_key, to_dir_utf8):
808
"""Recursively update all entries in this dirblock."""
810
raise AssertionError("renaming root not supported")
811
from_key = (from_dir, '')
812
from_block_idx, present = \
813
state._find_block_index_from_key(from_key)
815
# This is the old record, if it isn't present, then
816
# there is theoretically nothing to update.
817
# (Unless it isn't present because of lazy loading,
818
# but we don't do that yet)
820
from_block = state._dirblocks[from_block_idx]
821
to_block_index, to_entry_index, _, _ = \
822
state._get_block_entry_index(to_key[0], to_key[1], 0)
823
to_block_index = state._ensure_block(
824
to_block_index, to_entry_index, to_dir_utf8)
825
to_block = state._dirblocks[to_block_index]
827
# Grab a copy since move_one may update the list.
828
for entry in from_block[1][:]:
829
if not (entry[0][0] == from_dir):
830
raise AssertionError()
831
cur_details = entry[1][0]
832
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
833
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
834
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
835
minikind = cur_details[0]
837
# Deleted children of a renamed directory
838
# Do not need to be updated.
839
# Children that have been renamed out of this
840
# directory should also not be updated
842
move_one(entry, from_path_utf8=from_path_utf8,
844
executable=cur_details[3],
845
fingerprint=cur_details[1],
846
packed_stat=cur_details[4],
850
to_path_utf8=to_path_utf8)
852
# We need to move all the children of this
854
update_dirblock(from_path_utf8, to_key,
856
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
860
result.append((from_rel, to_rel))
861
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
862
self._make_dirty(reset_inventory=False)
866
def _must_be_locked(self):
867
if not self._control_files._lock_count:
868
raise errors.ObjectNotLocked(self)
871
"""Initialize the state in this tree to be a new tree."""
875
def path2id(self, path):
876
"""Return the id for path in this tree."""
877
path = path.strip('/')
878
entry = self._get_entry(path=path)
879
if entry == (None, None):
883
def paths2ids(self, paths, trees=[], require_versioned=True):
884
"""See Tree.paths2ids().
886
This specialisation fast-paths the case where all the trees are in the
891
parents = self.get_parent_ids()
893
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
895
return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
896
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
897
# -- make all paths utf8 --
900
paths_utf8.add(path.encode('utf8'))
902
# -- paths is now a utf8 path set --
903
# -- get the state object and prepare it.
904
state = self.current_dirstate()
905
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
906
and '' not in paths):
907
paths2ids = self._paths2ids_using_bisect
909
paths2ids = self._paths2ids_in_memory
910
return paths2ids(paths, search_indexes,
911
require_versioned=require_versioned)
913
def _paths2ids_in_memory(self, paths, search_indexes,
914
require_versioned=True):
915
state = self.current_dirstate()
916
state._read_dirblocks_if_needed()
917
def _entries_for_path(path):
918
"""Return a list with all the entries that match path for all ids.
920
dirname, basename = os.path.split(path)
921
key = (dirname, basename, '')
922
block_index, present = state._find_block_index_from_key(key)
924
# the block which should contain path is absent.
927
block = state._dirblocks[block_index][1]
928
entry_index, _ = state._find_entry_index(key, block)
929
# we may need to look at multiple entries at this path: walk while the paths match.
930
while (entry_index < len(block) and
931
block[entry_index][0][0:2] == key[0:2]):
932
result.append(block[entry_index])
935
if require_versioned:
936
# -- check all supplied paths are versioned in a search tree. --
939
path_entries = _entries_for_path(path)
941
# this specified path is not present at all: error
942
all_versioned = False
944
found_versioned = False
945
# for each id at this path
946
for entry in path_entries:
948
for index in search_indexes:
949
if entry[1][index][0] != 'a': # absent
950
found_versioned = True
951
# all good: found a versioned cell
953
if not found_versioned:
954
# none of the indexes was not 'absent' at all ids for this
956
all_versioned = False
958
if not all_versioned:
959
raise errors.PathsNotVersionedError(paths)
960
# -- remove redundancy in supplied paths to prevent over-scanning --
961
search_paths = osutils.minimum_path_selection(paths)
963
# for all search_indexs in each path at or under each element of
964
# search_paths, if the detail is relocated: add the id, and add the
965
# relocated path as one to search if its not searched already. If the
966
# detail is not relocated, add the id.
967
searched_paths = set()
969
def _process_entry(entry):
970
"""Look at search_indexes within entry.
972
If a specific tree's details are relocated, add the relocation
973
target to search_paths if not searched already. If it is absent, do
974
nothing. Otherwise add the id to found_ids.
976
for index in search_indexes:
977
if entry[1][index][0] == 'r': # relocated
978
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
979
search_paths.add(entry[1][index][1])
980
elif entry[1][index][0] != 'a': # absent
981
found_ids.add(entry[0][2])
983
current_root = search_paths.pop()
984
searched_paths.add(current_root)
985
# process the entries for this containing directory: the rest will be
986
# found by their parents recursively.
987
root_entries = _entries_for_path(current_root)
989
# this specified path is not present at all, skip it.
991
for entry in root_entries:
992
_process_entry(entry)
993
initial_key = (current_root, '', '')
994
block_index, _ = state._find_block_index_from_key(initial_key)
995
while (block_index < len(state._dirblocks) and
996
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
997
for entry in state._dirblocks[block_index][1]:
998
_process_entry(entry)
1002
def _paths2ids_using_bisect(self, paths, search_indexes,
1003
require_versioned=True):
1004
state = self.current_dirstate()
1007
split_paths = sorted(osutils.split(p) for p in paths)
1008
found = state._bisect_recursive(split_paths)
1010
if require_versioned:
1011
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1012
for dir_name in split_paths:
1013
if dir_name not in found_dir_names:
1014
raise errors.PathsNotVersionedError(paths)
1016
for dir_name_id, trees_info in found.iteritems():
1017
for index in search_indexes:
1018
if trees_info[index][0] not in ('r', 'a'):
1019
found_ids.add(dir_name_id[2])
1022
def read_working_inventory(self):
1023
"""Read the working inventory.
1025
This is a meaningless operation for dirstate, but we obey it anyhow.
1027
return self.inventory
1030
def revision_tree(self, revision_id):
1031
"""See Tree.revision_tree.
1033
WorkingTree4 supplies revision_trees for any basis tree.
1035
dirstate = self.current_dirstate()
1036
parent_ids = dirstate.get_parent_ids()
1037
if revision_id not in parent_ids:
1038
raise errors.NoSuchRevisionInTree(self, revision_id)
1039
if revision_id in dirstate.get_ghosts():
1040
raise errors.NoSuchRevisionInTree(self, revision_id)
1041
return DirStateRevisionTree(dirstate, revision_id,
1042
self.branch.repository)
1044
@needs_tree_write_lock
1045
def set_last_revision(self, new_revision):
1046
"""Change the last revision in the working tree."""
1047
parents = self.get_parent_ids()
1048
if new_revision in (NULL_REVISION, None):
1049
if len(parents) >= 2:
1050
raise AssertionError(
1051
"setting the last parent to none with a pending merge is "
1053
self.set_parent_ids([])
1055
self.set_parent_ids([new_revision] + parents[1:],
1056
allow_leftmost_as_ghost=True)
1058
@needs_tree_write_lock
1059
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1060
"""Set the parent ids to revision_ids.
1062
See also set_parent_trees. This api will try to retrieve the tree data
1063
for each element of revision_ids from the trees repository. If you have
1064
tree data already available, it is more efficient to use
1065
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1066
an easier API to use.
1068
:param revision_ids: The revision_ids to set as the parent ids of this
1069
working tree. Any of these may be ghosts.
1072
for revision_id in revision_ids:
1074
revtree = self.branch.repository.revision_tree(revision_id)
1075
# TODO: jam 20070213 KnitVersionedFile raises
1076
# RevisionNotPresent rather than NoSuchRevision if a
1077
# given revision_id is not present. Should Repository be
1078
# catching it and re-raising NoSuchRevision?
1079
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1081
trees.append((revision_id, revtree))
1082
self.set_parent_trees(trees,
1083
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1085
@needs_tree_write_lock
1086
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1087
"""Set the parents of the working tree.
1089
:param parents_list: A list of (revision_id, tree) tuples.
1090
If tree is None, then that element is treated as an unreachable
1091
parent tree - i.e. a ghost.
1093
dirstate = self.current_dirstate()
1094
if len(parents_list) > 0:
1095
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1096
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1100
parent_ids = [rev_id for rev_id, tree in parents_list]
1101
graph = self.branch.repository.get_graph()
1102
heads = graph.heads(parent_ids)
1103
accepted_revisions = set()
1105
# convert absent trees to the null tree, which we convert back to
1106
# missing on access.
1107
for rev_id, tree in parents_list:
1108
if len(accepted_revisions) > 0:
1109
# we always accept the first tree
1110
if rev_id in accepted_revisions or rev_id not in heads:
1111
# We have already included either this tree, or its
1112
# descendent, so we skip it.
1114
_mod_revision.check_not_reserved_id(rev_id)
1115
if tree is not None:
1116
real_trees.append((rev_id, tree))
1118
real_trees.append((rev_id,
1119
self.branch.repository.revision_tree(
1120
_mod_revision.NULL_REVISION)))
1121
ghosts.append(rev_id)
1122
accepted_revisions.add(rev_id)
1123
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1124
self._make_dirty(reset_inventory=False)
1126
def _set_root_id(self, file_id):
1127
"""See WorkingTree.set_root_id."""
1128
state = self.current_dirstate()
1129
state.set_path_id('', file_id)
1130
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1131
self._make_dirty(reset_inventory=True)
1133
def _sha_from_stat(self, path, stat_result):
1134
"""Get a sha digest from the tree's stat cache.
1136
The default implementation assumes no stat cache is present.
1138
:param path: The path.
1139
:param stat_result: The stat result being looked up.
1141
return self.current_dirstate().sha1_from_stat(path, stat_result)
1144
def supports_tree_reference(self):
1145
return self._repo_supports_tree_reference
1148
"""Unlock in format 4 trees needs to write the entire dirstate."""
1149
# do non-implementation specific cleanup
1152
if self._control_files._lock_count == 1:
1153
# eventually we should do signature checking during read locks for
1155
if self._control_files._lock_mode == 'w':
1158
if self._dirstate is not None:
1159
# This is a no-op if there are no modifications.
1160
self._dirstate.save()
1161
self._dirstate.unlock()
1162
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1163
# point. Instead, it could check if the header has been
1164
# modified when it is locked, and if not, it can hang on to
1165
# the data it has in memory.
1166
self._dirstate = None
1167
self._inventory = None
1168
# reverse order of locking.
1170
return self._control_files.unlock()
1172
self.branch.unlock()
1174
@needs_tree_write_lock
1175
def unversion(self, file_ids):
1176
"""Remove the file ids in file_ids from the current versioned set.
1178
When a file_id is unversioned, all of its children are automatically
1181
:param file_ids: The file ids to stop versioning.
1182
:raises: NoSuchId if any fileid is not currently versioned.
1186
state = self.current_dirstate()
1187
state._read_dirblocks_if_needed()
1188
ids_to_unversion = set(file_ids)
1189
paths_to_unversion = set()
1191
# check if the root is to be unversioned, if so, assert for now.
1192
# walk the state marking unversioned things as absent.
1193
# if there are any un-unversioned ids at the end, raise
1194
for key, details in state._dirblocks[0][1]:
1195
if (details[0][0] not in ('a', 'r') and # absent or relocated
1196
key[2] in ids_to_unversion):
1197
# I haven't written the code to unversion / yet - it should be
1199
raise errors.BzrError('Unversioning the / is not currently supported')
1201
while block_index < len(state._dirblocks):
1202
# process one directory at a time.
1203
block = state._dirblocks[block_index]
1204
# first check: is the path one to remove - it or its children
1205
delete_block = False
1206
for path in paths_to_unversion:
1207
if (block[0].startswith(path) and
1208
(len(block[0]) == len(path) or
1209
block[0][len(path)] == '/')):
1210
# this entire block should be deleted - its the block for a
1211
# path to unversion; or the child of one
1214
# TODO: trim paths_to_unversion as we pass by paths
1216
# this block is to be deleted: process it.
1217
# TODO: we can special case the no-parents case and
1218
# just forget the whole block.
1220
while entry_index < len(block[1]):
1221
# Mark this file id as having been removed
1222
entry = block[1][entry_index]
1223
ids_to_unversion.discard(entry[0][2])
1224
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1226
or not state._make_absent(entry)):
1228
# go to the next block. (At the moment we dont delete empty
1233
while entry_index < len(block[1]):
1234
entry = block[1][entry_index]
1235
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1236
# ^ some parent row.
1237
entry[0][2] not in ids_to_unversion):
1238
# ^ not an id to unversion
1241
if entry[1][0][0] == 'd':
1242
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1243
if not state._make_absent(entry):
1245
# we have unversioned this id
1246
ids_to_unversion.remove(entry[0][2])
1248
if ids_to_unversion:
1249
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1250
self._make_dirty(reset_inventory=False)
1251
# have to change the legacy inventory too.
1252
if self._inventory is not None:
1253
for file_id in file_ids:
1254
self._inventory.remove_recursive_id(file_id)
1256
@needs_tree_write_lock
1257
def rename_one(self, from_rel, to_rel, after=False):
1258
"""See WorkingTree.rename_one"""
1260
WorkingTree.rename_one(self, from_rel, to_rel, after)
1262
@needs_tree_write_lock
1263
def apply_inventory_delta(self, changes):
1264
"""See MutableTree.apply_inventory_delta"""
1265
state = self.current_dirstate()
1266
state.update_by_delta(changes)
1267
self._make_dirty(reset_inventory=True)
1269
def update_basis_by_delta(self, new_revid, delta):
1270
"""See MutableTree.update_basis_by_delta."""
1271
if self.last_revision() == new_revid:
1272
raise AssertionError()
1273
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1276
def _validate(self):
1277
self._dirstate._validate()
1279
@needs_tree_write_lock
1280
def _write_inventory(self, inv):
1281
"""Write inventory as the current inventory."""
1283
raise AssertionError("attempting to write an inventory when the "
1284
"dirstate is dirty will lose pending changes")
1285
self.current_dirstate().set_state_from_inventory(inv)
1286
self._make_dirty(reset_inventory=False)
1287
if self._inventory is not None:
1288
self._inventory = inv
1292
class WorkingTreeFormat4(WorkingTreeFormat3):
1293
"""The first consolidated dirstate working tree format.
1296
- exists within a metadir controlling .bzr
1297
- includes an explicit version marker for the workingtree control
1298
files, separate from the BzrDir format
1299
- modifies the hash cache format
1300
- is new in bzr 0.15
1301
- uses a LockDir to guard access to it.
1304
upgrade_recommended = False
1306
_tree_class = WorkingTree4
1308
def get_format_string(self):
1309
"""See WorkingTreeFormat.get_format_string()."""
1310
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1312
def get_format_description(self):
1313
"""See WorkingTreeFormat.get_format_description()."""
1314
return "Working tree format 4"
1316
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1317
accelerator_tree=None, hardlink=False):
1318
"""See WorkingTreeFormat.initialize().
1320
:param revision_id: allows creating a working tree at a different
1321
revision than the branch is at.
1322
:param accelerator_tree: A tree which can be used for retrieving file
1323
contents more quickly than the revision tree, i.e. a workingtree.
1324
The revision tree will be used for cases where accelerator_tree's
1325
content is different.
1326
:param hardlink: If true, hard-link files from accelerator_tree,
1329
These trees get an initial random root id, if their repository supports
1330
rich root data, TREE_ROOT otherwise.
1332
if not isinstance(a_bzrdir.transport, LocalTransport):
1333
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1334
transport = a_bzrdir.get_workingtree_transport(self)
1335
control_files = self._open_control_files(a_bzrdir)
1336
control_files.create_lock()
1337
control_files.lock_write()
1338
transport.put_bytes('format', self.get_format_string(),
1339
mode=a_bzrdir._get_file_mode())
1340
if from_branch is not None:
1341
branch = from_branch
1343
branch = a_bzrdir.open_branch()
1344
if revision_id is None:
1345
revision_id = branch.last_revision()
1346
local_path = transport.local_abspath('dirstate')
1347
# write out new dirstate (must exist when we create the tree)
1348
state = dirstate.DirState.initialize(local_path)
1351
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1355
_control_files=control_files)
1357
wt.lock_tree_write()
1359
self._init_custom_control_files(wt)
1360
if revision_id in (None, NULL_REVISION):
1361
if branch.repository.supports_rich_root():
1362
wt._set_root_id(generate_ids.gen_root_id())
1364
wt._set_root_id(ROOT_ID)
1367
# frequently, we will get here due to branching. The accelerator
1368
# tree will be the tree from the branch, so the desired basis
1369
# tree will often be a parent of the accelerator tree.
1370
if accelerator_tree is not None:
1372
basis = accelerator_tree.revision_tree(revision_id)
1373
except errors.NoSuchRevision:
1376
basis = branch.repository.revision_tree(revision_id)
1377
if revision_id == NULL_REVISION:
1380
parents_list = [(revision_id, basis)]
1383
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1385
# if the basis has a root id we have to use that; otherwise we
1386
# use a new random one
1387
basis_root_id = basis.get_root_id()
1388
if basis_root_id is not None:
1389
wt._set_root_id(basis_root_id)
1391
# delta_from_tree is safe even for DirStateRevisionTrees,
1392
# because wt4.apply_inventory_delta does not mutate the input
1393
# inventory entries.
1394
transform.build_tree(basis, wt, accelerator_tree,
1395
hardlink=hardlink, delta_from_tree=True)
1399
control_files.unlock()
1403
def _init_custom_control_files(self, wt):
1404
"""Subclasses with custom control files should override this method.
1406
The working tree and control files are locked for writing when this
1409
:param wt: the WorkingTree object
1412
def _open(self, a_bzrdir, control_files):
1413
"""Open the tree itself.
1415
:param a_bzrdir: the dir for the tree.
1416
:param control_files: the control files for the tree.
1418
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1419
branch=a_bzrdir.open_branch(),
1422
_control_files=control_files)
1424
def __get_matchingbzrdir(self):
1425
# please test against something that will let us do tree references
1426
return bzrdir.format_registry.make_bzrdir(
1427
'dirstate-with-subtree')
1429
_matchingbzrdir = property(__get_matchingbzrdir)
1432
class DirStateRevisionTree(Tree):
1433
"""A revision tree pulling the inventory from a dirstate."""
1435
def __init__(self, dirstate, revision_id, repository):
1436
self._dirstate = dirstate
1437
self._revision_id = revision_id
1438
self._repository = repository
1439
self._inventory = None
1441
self._dirstate_locked = False
1442
self._repo_supports_tree_reference = getattr(
1443
repository._format, "supports_tree_reference",
1447
return "<%s of %s in %s>" % \
1448
(self.__class__.__name__, self._revision_id, self._dirstate)
1450
def annotate_iter(self, file_id,
1451
default_revision=_mod_revision.CURRENT_REVISION):
1452
"""See Tree.annotate_iter"""
1453
text_key = (file_id, self.inventory[file_id].revision)
1454
annotations = self._repository.texts.annotate(text_key)
1455
return [(key[-1], line) for (key, line) in annotations]
1457
def _get_ancestors(self, default_revision):
1458
return set(self._repository.get_ancestry(self._revision_id,
1460
def _comparison_data(self, entry, path):
1461
"""See Tree._comparison_data."""
1463
return None, False, None
1464
# trust the entry as RevisionTree does, but this may not be
1465
# sensible: the entry might not have come from us?
1466
return entry.kind, entry.executable, None
1468
def _file_size(self, entry, stat_value):
1469
return entry.text_size
1471
def filter_unversioned_files(self, paths):
1472
"""Filter out paths that are not versioned.
1474
:return: set of paths.
1476
pred = self.has_filename
1477
return set((p for p in paths if not pred(p)))
1479
def get_root_id(self):
1480
return self.path2id('')
1482
def id2path(self, file_id):
1483
"Convert a file-id to a path."
1484
entry = self._get_entry(file_id=file_id)
1485
if entry == (None, None):
1486
raise errors.NoSuchId(tree=self, file_id=file_id)
1487
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1488
return path_utf8.decode('utf8')
1490
def iter_references(self):
1491
if not self._repo_supports_tree_reference:
1492
# When the repo doesn't support references, we will have nothing to
1495
# Otherwise, fall back to the default implementation
1496
return super(DirStateRevisionTree, self).iter_references()
1498
def _get_parent_index(self):
1499
"""Return the index in the dirstate referenced by this tree."""
1500
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1502
def _get_entry(self, file_id=None, path=None):
1503
"""Get the dirstate row for file_id or path.
1505
If either file_id or path is supplied, it is used as the key to lookup.
1506
If both are supplied, the fastest lookup is used, and an error is
1507
raised if they do not both point at the same row.
1509
:param file_id: An optional unicode file_id to be looked up.
1510
:param path: An optional unicode path to be looked up.
1511
:return: The dirstate row tuple for path/file_id, or (None, None)
1513
if file_id is None and path is None:
1514
raise errors.BzrError('must supply file_id or path')
1515
if path is not None:
1516
path = path.encode('utf8')
1517
parent_index = self._get_parent_index()
1518
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1520
def _generate_inventory(self):
1521
"""Create and set self.inventory from the dirstate object.
1523
(So this is only called the first time the inventory is requested for
1524
this tree; it then remains in memory until it's out of date.)
1526
This is relatively expensive: we have to walk the entire dirstate.
1528
if not self._locked:
1529
raise AssertionError(
1530
'cannot generate inventory of an unlocked '
1531
'dirstate revision tree')
1532
# separate call for profiling - makes it clear where the costs are.
1533
self._dirstate._read_dirblocks_if_needed()
1534
if self._revision_id not in self._dirstate.get_parent_ids():
1535
raise AssertionError(
1536
'parent %s has disappeared from %s' % (
1537
self._revision_id, self._dirstate.get_parent_ids()))
1538
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1539
# This is identical now to the WorkingTree _generate_inventory except
1540
# for the tree index use.
1541
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1542
current_id = root_key[2]
1543
if current_entry[parent_index][0] != 'd':
1544
raise AssertionError()
1545
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1546
inv.root.revision = current_entry[parent_index][4]
1547
# Turn some things into local variables
1548
minikind_to_kind = dirstate.DirState._minikind_to_kind
1549
factory = entry_factory
1550
utf8_decode = cache_utf8._utf8_decode
1551
inv_byid = inv._byid
1552
# we could do this straight out of the dirstate; it might be fast
1553
# and should be profiled - RBC 20070216
1554
parent_ies = {'' : inv.root}
1555
for block in self._dirstate._dirblocks[1:]: #skip root
1558
parent_ie = parent_ies[dirname]
1560
# all the paths in this block are not versioned in this tree
1562
for key, entry in block[1]:
1563
minikind, fingerprint, size, executable, revid = entry[parent_index]
1564
if minikind in ('a', 'r'): # absent, relocated
1568
name_unicode = utf8_decode(name)[0]
1570
kind = minikind_to_kind[minikind]
1571
inv_entry = factory[kind](file_id, name_unicode,
1573
inv_entry.revision = revid
1575
inv_entry.executable = executable
1576
inv_entry.text_size = size
1577
inv_entry.text_sha1 = fingerprint
1578
elif kind == 'directory':
1579
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1580
elif kind == 'symlink':
1581
inv_entry.executable = False
1582
inv_entry.text_size = None
1583
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1584
elif kind == 'tree-reference':
1585
inv_entry.reference_revision = fingerprint or None
1587
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1589
# These checks cost us around 40ms on a 55k entry tree
1590
if file_id in inv_byid:
1591
raise AssertionError('file_id %s already in'
1592
' inventory as %s' % (file_id, inv_byid[file_id]))
1593
if name_unicode in parent_ie.children:
1594
raise AssertionError('name %r already in parent'
1596
inv_byid[file_id] = inv_entry
1597
parent_ie.children[name_unicode] = inv_entry
1598
self._inventory = inv
1600
def get_file_mtime(self, file_id, path=None):
1601
"""Return the modification time for this record.
1603
We return the timestamp of the last-changed revision.
1605
# Make sure the file exists
1606
entry = self._get_entry(file_id, path=path)
1607
if entry == (None, None): # do we raise?
1609
parent_index = self._get_parent_index()
1610
last_changed_revision = entry[1][parent_index][4]
1611
return self._repository.get_revision(last_changed_revision).timestamp
1613
def get_file_sha1(self, file_id, path=None, stat_value=None):
1614
entry = self._get_entry(file_id=file_id, path=path)
1615
parent_index = self._get_parent_index()
1616
parent_details = entry[1][parent_index]
1617
if parent_details[0] == 'f':
1618
return parent_details[1]
1621
def get_file(self, file_id, path=None):
1622
return StringIO(self.get_file_text(file_id))
1624
def get_file_lines(self, file_id):
1625
return osutils.split_lines(self.get_file_text(file_id))
1627
def get_file_size(self, file_id):
1628
"""See Tree.get_file_size"""
1629
return self.inventory[file_id].text_size
1631
def get_file_text(self, file_id):
1632
return list(self.iter_files_bytes([(file_id, None)]))[0][1]
1634
def get_reference_revision(self, file_id, path=None):
1635
return self.inventory[file_id].reference_revision
1637
def iter_files_bytes(self, desired_files):
1638
"""See Tree.iter_files_bytes.
1640
This version is implemented on top of Repository.iter_files_bytes"""
1641
parent_index = self._get_parent_index()
1642
repo_desired_files = []
1643
for file_id, identifier in desired_files:
1644
entry = self._get_entry(file_id)
1645
if entry == (None, None):
1646
raise errors.NoSuchId(self, file_id)
1647
repo_desired_files.append((file_id, entry[1][parent_index][4],
1649
return self._repository.iter_files_bytes(repo_desired_files)
1651
def get_symlink_target(self, file_id):
1652
entry = self._get_entry(file_id=file_id)
1653
parent_index = self._get_parent_index()
1654
if entry[1][parent_index][0] != 'l':
1657
# At present, none of the tree implementations supports non-ascii
1658
# symlink targets. So we will just assume that the dirstate path is
1660
return entry[1][parent_index][1]
1662
def get_revision_id(self):
1663
"""Return the revision id for this tree."""
1664
return self._revision_id
1666
def _get_inventory(self):
1667
if self._inventory is not None:
1668
return self._inventory
1669
self._must_be_locked()
1670
self._generate_inventory()
1671
return self._inventory
1673
inventory = property(_get_inventory,
1674
doc="Inventory of this Tree")
1676
def get_parent_ids(self):
1677
"""The parents of a tree in the dirstate are not cached."""
1678
return self._repository.get_revision(self._revision_id).parent_ids
1680
def has_filename(self, filename):
1681
return bool(self.path2id(filename))
1683
def kind(self, file_id):
1684
entry = self._get_entry(file_id=file_id)[1]
1686
raise errors.NoSuchId(tree=self, file_id=file_id)
1687
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1689
def stored_kind(self, file_id):
1690
"""See Tree.stored_kind"""
1691
return self.kind(file_id)
1693
def path_content_summary(self, path):
1694
"""See Tree.path_content_summary."""
1695
id = self.inventory.path2id(path)
1697
return ('missing', None, None, None)
1698
entry = self._inventory[id]
1701
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1702
elif kind == 'symlink':
1703
return (kind, None, None, entry.symlink_target)
1705
return (kind, None, None, None)
1707
def is_executable(self, file_id, path=None):
1708
ie = self.inventory[file_id]
1709
if ie.kind != "file":
1711
return ie.executable
1713
def list_files(self, include_root=False):
1714
# We use a standard implementation, because DirStateRevisionTree is
1715
# dealing with one of the parents of the current state
1716
inv = self._get_inventory()
1717
entries = inv.iter_entries()
1718
if self.inventory.root is not None and not include_root:
1720
for path, entry in entries:
1721
yield path, 'V', entry.kind, entry.file_id, entry
1723
def lock_read(self):
1724
"""Lock the tree for a set of operations."""
1725
if not self._locked:
1726
self._repository.lock_read()
1727
if self._dirstate._lock_token is None:
1728
self._dirstate.lock_read()
1729
self._dirstate_locked = True
1732
def _must_be_locked(self):
1733
if not self._locked:
1734
raise errors.ObjectNotLocked(self)
1737
def path2id(self, path):
1738
"""Return the id for path in this tree."""
1739
# lookup by path: faster than splitting and walking the ivnentory.
1740
entry = self._get_entry(path=path)
1741
if entry == (None, None):
1746
"""Unlock, freeing any cache memory used during the lock."""
1747
# outside of a lock, the inventory is suspect: release it.
1749
if not self._locked:
1750
self._inventory = None
1752
if self._dirstate_locked:
1753
self._dirstate.unlock()
1754
self._dirstate_locked = False
1755
self._repository.unlock()
1758
def supports_tree_reference(self):
1759
return self._repo_supports_tree_reference
1761
def walkdirs(self, prefix=""):
1762
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1763
# implementation based on an inventory.
1764
# This should be cleaned up to use the much faster Dirstate code
1765
# So for now, we just build up the parent inventory, and extract
1766
# it the same way RevisionTree does.
1767
_directory = 'directory'
1768
inv = self._get_inventory()
1769
top_id = inv.path2id(prefix)
1773
pending = [(prefix, top_id)]
1776
relpath, file_id = pending.pop()
1777
# 0 - relpath, 1- file-id
1779
relroot = relpath + '/'
1782
# FIXME: stash the node in pending
1783
entry = inv[file_id]
1784
for name, child in entry.sorted_children():
1785
toppath = relroot + name
1786
dirblock.append((toppath, name, child.kind, None,
1787
child.file_id, child.kind
1789
yield (relpath, entry.file_id), dirblock
1790
# push the user specified dirs from dirblock
1791
for dir in reversed(dirblock):
1792
if dir[2] == _directory:
1793
pending.append((dir[0], dir[4]))
1796
class InterDirStateTree(InterTree):
1797
"""Fast path optimiser for changes_from with dirstate trees.
1799
This is used only when both trees are in the dirstate working file, and
1800
the source is any parent within the dirstate, and the destination is
1801
the current working tree of the same dirstate.
1803
# this could be generalized to allow comparisons between any trees in the
1804
# dirstate, and possibly between trees stored in different dirstates.
1806
def __init__(self, source, target):
1807
super(InterDirStateTree, self).__init__(source, target)
1808
if not InterDirStateTree.is_compatible(source, target):
1809
raise Exception, "invalid source %r and target %r" % (source, target)
1812
def make_source_parent_tree(source, target):
1813
"""Change the source tree into a parent of the target."""
1814
revid = source.commit('record tree')
1815
target.branch.repository.fetch(source.branch.repository, revid)
1816
target.set_parent_ids([revid])
1817
return target.basis_tree(), target
1819
_matching_from_tree_format = WorkingTreeFormat4()
1820
_matching_to_tree_format = WorkingTreeFormat4()
1821
_test_mutable_trees_to_test_trees = make_source_parent_tree
1823
def iter_changes(self, include_unchanged=False,
1824
specific_files=None, pb=None, extra_trees=[],
1825
require_versioned=True, want_unversioned=False):
1826
"""Return the changes from source to target.
1828
:return: An iterator that yields tuples. See InterTree.iter_changes
1830
:param specific_files: An optional list of file paths to restrict the
1831
comparison to. When mapping filenames to ids, all matches in all
1832
trees (including optional extra_trees) are used, and all children of
1833
matched directories are included.
1834
:param include_unchanged: An optional boolean requesting the inclusion of
1835
unchanged entries in the result.
1836
:param extra_trees: An optional list of additional trees to use when
1837
mapping the contents of specific_files (paths) to file_ids.
1838
:param require_versioned: If True, all files in specific_files must be
1839
versioned in one of source, target, extra_trees or
1840
PathsNotVersionedError is raised.
1841
:param want_unversioned: Should unversioned files be returned in the
1842
output. An unversioned file is defined as one with (False, False)
1843
for the versioned pair.
1845
utf8_decode = cache_utf8._utf8_decode
1846
_minikind_to_kind = dirstate.DirState._minikind_to_kind
1847
cmp_by_dirs = dirstate.cmp_by_dirs
1848
# NB: show_status depends on being able to pass in non-versioned files
1849
# and report them as unknown
1850
# TODO: handle extra trees in the dirstate.
1851
if (extra_trees or specific_files == []):
1852
# we can't fast-path these cases (yet)
1853
for f in super(InterDirStateTree, self).iter_changes(
1854
include_unchanged, specific_files, pb, extra_trees,
1855
require_versioned, want_unversioned=want_unversioned):
1858
parent_ids = self.target.get_parent_ids()
1859
if not (self.source._revision_id in parent_ids
1860
or self.source._revision_id == NULL_REVISION):
1861
raise AssertionError(
1862
"revision {%s} is not stored in {%s}, but %s "
1863
"can only be used for trees stored in the dirstate"
1864
% (self.source._revision_id, self.target, self.iter_changes))
1866
if self.source._revision_id == NULL_REVISION:
1868
indices = (target_index,)
1870
if not (self.source._revision_id in parent_ids):
1871
raise AssertionError(
1872
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1873
self.source._revision_id, parent_ids))
1874
source_index = 1 + parent_ids.index(self.source._revision_id)
1875
indices = (source_index, target_index)
1876
# -- make all specific_files utf8 --
1878
specific_files_utf8 = set()
1879
for path in specific_files:
1880
specific_files_utf8.add(path.encode('utf8'))
1881
specific_files = specific_files_utf8
1883
specific_files = set([''])
1884
# -- specific_files is now a utf8 path set --
1885
# -- get the state object and prepare it.
1886
state = self.target.current_dirstate()
1887
state._read_dirblocks_if_needed()
1888
def _entries_for_path(path):
1889
"""Return a list with all the entries that match path for all ids.
1891
dirname, basename = os.path.split(path)
1892
key = (dirname, basename, '')
1893
block_index, present = state._find_block_index_from_key(key)
1895
# the block which should contain path is absent.
1898
block = state._dirblocks[block_index][1]
1899
entry_index, _ = state._find_entry_index(key, block)
1900
# we may need to look at multiple entries at this path: walk while the specific_files match.
1901
while (entry_index < len(block) and
1902
block[entry_index][0][0:2] == key[0:2]):
1903
result.append(block[entry_index])
1906
if require_versioned:
1907
# -- check all supplied paths are versioned in a search tree. --
1908
all_versioned = True
1909
for path in specific_files:
1910
path_entries = _entries_for_path(path)
1911
if not path_entries:
1912
# this specified path is not present at all: error
1913
all_versioned = False
1915
found_versioned = False
1916
# for each id at this path
1917
for entry in path_entries:
1919
for index in indices:
1920
if entry[1][index][0] != 'a': # absent
1921
found_versioned = True
1922
# all good: found a versioned cell
1924
if not found_versioned:
1925
# none of the indexes was not 'absent' at all ids for this
1927
all_versioned = False
1929
if not all_versioned:
1930
raise errors.PathsNotVersionedError(specific_files)
1931
# -- remove redundancy in supplied specific_files to prevent over-scanning --
1932
search_specific_files = set()
1933
for path in specific_files:
1934
other_specific_files = specific_files.difference(set([path]))
1935
if not osutils.is_inside_any(other_specific_files, path):
1936
# this is a top level path, we must check it.
1937
search_specific_files.add(path)
1939
# compare source_index and target_index at or under each element of search_specific_files.
1940
# follow the following comparison table. Note that we only want to do diff operations when
1941
# the target is fdl because thats when the walkdirs logic will have exposed the pathinfo
1945
# Source | Target | disk | action
1946
# r | fdlt | | add source to search, add id path move and perform
1947
# | | | diff check on source-target
1948
# r | fdlt | a | dangling file that was present in the basis.
1950
# r | a | | add source to search
1952
# r | r | | this path is present in a non-examined tree, skip.
1953
# r | r | a | this path is present in a non-examined tree, skip.
1954
# a | fdlt | | add new id
1955
# a | fdlt | a | dangling locally added file, skip
1956
# a | a | | not present in either tree, skip
1957
# a | a | a | not present in any tree, skip
1958
# a | r | | not present in either tree at this path, skip as it
1959
# | | | may not be selected by the users list of paths.
1960
# a | r | a | not present in either tree at this path, skip as it
1961
# | | | may not be selected by the users list of paths.
1962
# fdlt | fdlt | | content in both: diff them
1963
# fdlt | fdlt | a | deleted locally, but not unversioned - show as deleted ?
1964
# fdlt | a | | unversioned: output deleted id for now
1965
# fdlt | a | a | unversioned and deleted: output deleted id
1966
# fdlt | r | | relocated in this tree, so add target to search.
1967
# | | | Dont diff, we will see an r,fd; pair when we reach
1968
# | | | this id at the other path.
1969
# fdlt | r | a | relocated in this tree, so add target to search.
1970
# | | | Dont diff, we will see an r,fd; pair when we reach
1971
# | | | this id at the other path.
1973
# for all search_indexs in each path at or under each element of
1974
# search_specific_files, if the detail is relocated: add the id, and add the
1975
# relocated path as one to search if its not searched already. If the
1976
# detail is not relocated, add the id.
1977
searched_specific_files = set()
1978
NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
1979
# Using a list so that we can access the values and change them in
1980
# nested scope. Each one is [path, file_id, entry]
1981
last_source_parent = [None, None]
1982
last_target_parent = [None, None]
1984
use_filesystem_for_exec = (sys.platform != 'win32')
1986
# Just a sentry, so that _process_entry can say that this
1987
# record is handled, but isn't interesting to process (unchanged)
1988
uninteresting = object()
1990
old_dirname_to_file_id = {}
1991
new_dirname_to_file_id = {}
1992
# TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
1993
# keeping a cache of directories that we have seen.
1995
def _process_entry(entry, path_info):
1996
"""Compare an entry and real disk to generate delta information.
1998
:param path_info: top_relpath, basename, kind, lstat, abspath for
1999
the path of entry. If None, then the path is considered absent.
2000
(Perhaps we should pass in a concrete entry for this ?)
2001
Basename is returned as a utf8 string because we expect this
2002
tuple will be ignored, and don't want to take the time to
2004
:return: None if these don't match
2005
A tuple of information about the change, or
2006
the object 'uninteresting' if these match, but are
2007
basically identical.
2009
if source_index is None:
2010
source_details = NULL_PARENT_DETAILS
2012
source_details = entry[1][source_index]
2013
target_details = entry[1][target_index]
2014
target_minikind = target_details[0]
2015
if path_info is not None and target_minikind in 'fdlt':
2016
if not (target_index == 0):
2017
raise AssertionError()
2018
link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
2019
stat_value=path_info[3])
2020
# The entry may have been modified by update_entry
2021
target_details = entry[1][target_index]
2022
target_minikind = target_details[0]
2025
file_id = entry[0][2]
2026
source_minikind = source_details[0]
2027
if source_minikind in 'fdltr' and target_minikind in 'fdlt':
2028
# claimed content in both: diff
2029
# r | fdlt | | add source to search, add id path move and perform
2030
# | | | diff check on source-target
2031
# r | fdlt | a | dangling file that was present in the basis.
2033
if source_minikind in 'r':
2034
# add the source to the search path to find any children it
2035
# has. TODO ? : only add if it is a container ?
2036
if not osutils.is_inside_any(searched_specific_files,
2038
search_specific_files.add(source_details[1])
2039
# generate the old path; this is needed for stating later
2041
old_path = source_details[1]
2042
old_dirname, old_basename = os.path.split(old_path)
2043
path = pathjoin(entry[0][0], entry[0][1])
2044
old_entry = state._get_entry(source_index,
2046
# update the source details variable to be the real
2048
if old_entry == (None, None):
2049
raise errors.CorruptDirstate(state._filename,
2050
"entry '%s/%s' is considered renamed from %r"
2051
" but source does not exist\n"
2052
"entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
2053
source_details = old_entry[1][source_index]
2054
source_minikind = source_details[0]
2056
old_dirname = entry[0][0]
2057
old_basename = entry[0][1]
2058
old_path = path = None
2059
if path_info is None:
2060
# the file is missing on disk, show as removed.
2061
content_change = True
2065
# source and target are both versioned and disk file is present.
2066
target_kind = path_info[2]
2067
if target_kind == 'directory':
2069
old_path = path = pathjoin(old_dirname, old_basename)
2070
new_dirname_to_file_id[path] = file_id
2071
if source_minikind != 'd':
2072
content_change = True
2074
# directories have no fingerprint
2075
content_change = False
2077
elif target_kind == 'file':
2078
if source_minikind != 'f':
2079
content_change = True
2081
# We could check the size, but we already have the
2083
content_change = (link_or_sha1 != source_details[1])
2084
# Target details is updated at update_entry time
2085
if use_filesystem_for_exec:
2086
# We don't need S_ISREG here, because we are sure
2087
# we are dealing with a file.
2088
target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
2090
target_exec = target_details[3]
2091
elif target_kind == 'symlink':
2092
if source_minikind != 'l':
2093
content_change = True
2095
content_change = (link_or_sha1 != source_details[1])
2097
elif target_kind == 'tree-reference':
2098
if source_minikind != 't':
2099
content_change = True
2101
content_change = False
2104
raise Exception, "unknown kind %s" % path_info[2]
2105
if source_minikind == 'd':
2107
old_path = path = pathjoin(old_dirname, old_basename)
2108
old_dirname_to_file_id[old_path] = file_id
2109
# parent id is the entry for the path in the target tree
2110
if old_dirname == last_source_parent[0]:
2111
source_parent_id = last_source_parent[1]
2114
source_parent_id = old_dirname_to_file_id[old_dirname]
2116
source_parent_entry = state._get_entry(source_index,
2117
path_utf8=old_dirname)
2118
source_parent_id = source_parent_entry[0][2]
2119
if source_parent_id == entry[0][2]:
2120
# This is the root, so the parent is None
2121
source_parent_id = None
2123
last_source_parent[0] = old_dirname
2124
last_source_parent[1] = source_parent_id
2125
new_dirname = entry[0][0]
2126
if new_dirname == last_target_parent[0]:
2127
target_parent_id = last_target_parent[1]
2130
target_parent_id = new_dirname_to_file_id[new_dirname]
2132
# TODO: We don't always need to do the lookup, because the
2133
# parent entry will be the same as the source entry.
2134
target_parent_entry = state._get_entry(target_index,
2135
path_utf8=new_dirname)
2136
if target_parent_entry == (None, None):
2137
raise AssertionError(
2138
"Could not find target parent in wt: %s\nparent of: %s"
2139
% (new_dirname, entry))
2140
target_parent_id = target_parent_entry[0][2]
2141
if target_parent_id == entry[0][2]:
2142
# This is the root, so the parent is None
2143
target_parent_id = None
2145
last_target_parent[0] = new_dirname
2146
last_target_parent[1] = target_parent_id
2148
source_exec = source_details[3]
2149
if (include_unchanged
2151
or source_parent_id != target_parent_id
2152
or old_basename != entry[0][1]
2153
or source_exec != target_exec
2155
if old_path is None:
2156
old_path = path = pathjoin(old_dirname, old_basename)
2157
old_path_u = utf8_decode(old_path)[0]
2160
old_path_u = utf8_decode(old_path)[0]
2161
if old_path == path:
2164
path_u = utf8_decode(path)[0]
2165
source_kind = _minikind_to_kind[source_minikind]
2166
return (entry[0][2],
2167
(old_path_u, path_u),
2170
(source_parent_id, target_parent_id),
2171
(utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
2172
(source_kind, target_kind),
2173
(source_exec, target_exec))
2175
return uninteresting
2176
elif source_minikind in 'a' and target_minikind in 'fdlt':
2177
# looks like a new file
2178
path = pathjoin(entry[0][0], entry[0][1])
2179
# parent id is the entry for the path in the target tree
2180
# TODO: these are the same for an entire directory: cache em.
2181
parent_id = state._get_entry(target_index,
2182
path_utf8=entry[0][0])[0][2]
2183
if parent_id == entry[0][2]:
2185
if path_info is not None:
2187
if use_filesystem_for_exec:
2188
# We need S_ISREG here, because we aren't sure if this
2191
stat.S_ISREG(path_info[3].st_mode)
2192
and stat.S_IEXEC & path_info[3].st_mode)
2194
target_exec = target_details[3]
2195
return (entry[0][2],
2196
(None, utf8_decode(path)[0]),
2200
(None, utf8_decode(entry[0][1])[0]),
2201
(None, path_info[2]),
2202
(None, target_exec))
2204
# Its a missing file, report it as such.
2205
return (entry[0][2],
2206
(None, utf8_decode(path)[0]),
2210
(None, utf8_decode(entry[0][1])[0]),
2213
elif source_minikind in 'fdlt' and target_minikind in 'a':
2214
# unversioned, possibly, or possibly not deleted: we dont care.
2215
# if its still on disk, *and* theres no other entry at this
2216
# path [we dont know this in this routine at the moment -
2217
# perhaps we should change this - then it would be an unknown.
2218
old_path = pathjoin(entry[0][0], entry[0][1])
2219
# parent id is the entry for the path in the target tree
2220
parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
2221
if parent_id == entry[0][2]:
2223
return (entry[0][2],
2224
(utf8_decode(old_path)[0], None),
2228
(utf8_decode(entry[0][1])[0], None),
2229
(_minikind_to_kind[source_minikind], None),
2230
(source_details[3], None))
2231
elif source_minikind in 'fdlt' and target_minikind in 'r':
2232
# a rename; could be a true rename, or a rename inherited from
2233
# a renamed parent. TODO: handle this efficiently. Its not
2234
# common case to rename dirs though, so a correct but slow
2235
# implementation will do.
2236
if not osutils.is_inside_any(searched_specific_files, target_details[1]):
2237
search_specific_files.add(target_details[1])
2238
elif source_minikind in 'ra' and target_minikind in 'ra':
2239
# neither of the selected trees contain this file,
2240
# so skip over it. This is not currently directly tested, but
2241
# is indirectly via test_too_much.TestCommands.test_conflicts.
2244
raise AssertionError("don't know how to compare "
2245
"source_minikind=%r, target_minikind=%r"
2246
% (source_minikind, target_minikind))
2247
## import pdb;pdb.set_trace()
2250
while search_specific_files:
2251
# TODO: the pending list should be lexically sorted? the
2252
# interface doesn't require it.
2253
current_root = search_specific_files.pop()
2254
current_root_unicode = current_root.decode('utf8')
2255
searched_specific_files.add(current_root)
2256
# process the entries for this containing directory: the rest will be
2257
# found by their parents recursively.
2258
root_entries = _entries_for_path(current_root)
2259
root_abspath = self.target.abspath(current_root_unicode)
2261
root_stat = os.lstat(root_abspath)
2263
if e.errno == errno.ENOENT:
2264
# the path does not exist: let _process_entry know that.
2265
root_dir_info = None
2267
# some other random error: hand it up.
2270
root_dir_info = ('', current_root,
2271
osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
2273
if root_dir_info[2] == 'directory':
2274
if self.target._directory_is_tree_reference(
2275
current_root.decode('utf8')):
2276
root_dir_info = root_dir_info[:2] + \
2277
('tree-reference',) + root_dir_info[3:]
2279
if not root_entries and not root_dir_info:
2280
# this specified path is not present at all, skip it.
2282
path_handled = False
2283
for entry in root_entries:
2284
result = _process_entry(entry, root_dir_info)
2285
if result is not None:
2287
if result is not uninteresting:
2289
if want_unversioned and not path_handled and root_dir_info:
2290
new_executable = bool(
2291
stat.S_ISREG(root_dir_info[3].st_mode)
2292
and stat.S_IEXEC & root_dir_info[3].st_mode)
2294
(None, current_root_unicode),
2298
(None, splitpath(current_root_unicode)[-1]),
2299
(None, root_dir_info[2]),
2300
(None, new_executable)
2302
initial_key = (current_root, '', '')
2303
block_index, _ = state._find_block_index_from_key(initial_key)
2304
if block_index == 0:
2305
# we have processed the total root already, but because the
2306
# initial key matched it we should skip it here.
2308
if root_dir_info and root_dir_info[2] == 'tree-reference':
2309
current_dir_info = None
2311
dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
2313
current_dir_info = dir_iterator.next()
2315
# on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
2316
# python 2.5 has e.errno == EINVAL,
2317
# and e.winerror == ERROR_DIRECTORY
2318
e_winerror = getattr(e, 'winerror', None)
2319
win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
2320
# there may be directories in the inventory even though
2321
# this path is not a file on disk: so mark it as end of
2323
if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
2324
current_dir_info = None
2325
elif (sys.platform == 'win32'
2326
and (e.errno in win_errors
2327
or e_winerror in win_errors)):
2328
current_dir_info = None
2332
if current_dir_info[0][0] == '':
2333
# remove .bzr from iteration
2334
bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
2335
if current_dir_info[1][bzr_index][0] != '.bzr':
2336
raise AssertionError()
2337
del current_dir_info[1][bzr_index]
2338
# walk until both the directory listing and the versioned metadata
2340
if (block_index < len(state._dirblocks) and
2341
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2342
current_block = state._dirblocks[block_index]
2344
current_block = None
2345
while (current_dir_info is not None or
2346
current_block is not None):
2347
if (current_dir_info and current_block
2348
and current_dir_info[0][0] != current_block[0]):
2349
if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
2350
# filesystem data refers to paths not covered by the dirblock.
2351
# this has two possibilities:
2352
# A) it is versioned but empty, so there is no block for it
2353
# B) it is not versioned.
2355
# if (A) then we need to recurse into it to check for
2356
# new unknown files or directories.
2357
# if (B) then we should ignore it, because we don't
2358
# recurse into unknown directories.
2360
while path_index < len(current_dir_info[1]):
2361
current_path_info = current_dir_info[1][path_index]
2362
if want_unversioned:
2363
if current_path_info[2] == 'directory':
2364
if self.target._directory_is_tree_reference(
2365
current_path_info[0].decode('utf8')):
2366
current_path_info = current_path_info[:2] + \
2367
('tree-reference',) + current_path_info[3:]
2368
new_executable = bool(
2369
stat.S_ISREG(current_path_info[3].st_mode)
2370
and stat.S_IEXEC & current_path_info[3].st_mode)
2372
(None, utf8_decode(current_path_info[0])[0]),
2376
(None, utf8_decode(current_path_info[1])[0]),
2377
(None, current_path_info[2]),
2378
(None, new_executable))
2379
# dont descend into this unversioned path if it is
2381
if current_path_info[2] in ('directory',
2383
del current_dir_info[1][path_index]
2387
# This dir info has been handled, go to the next
2389
current_dir_info = dir_iterator.next()
2390
except StopIteration:
2391
current_dir_info = None
2393
# We have a dirblock entry for this location, but there
2394
# is no filesystem path for this. This is most likely
2395
# because a directory was removed from the disk.
2396
# We don't have to report the missing directory,
2397
# because that should have already been handled, but we
2398
# need to handle all of the files that are contained
2400
for current_entry in current_block[1]:
2401
# entry referring to file not present on disk.
2402
# advance the entry only, after processing.
2403
result = _process_entry(current_entry, None)
2404
if result is not None:
2405
if result is not uninteresting:
2408
if (block_index < len(state._dirblocks) and
2409
osutils.is_inside(current_root,
2410
state._dirblocks[block_index][0])):
2411
current_block = state._dirblocks[block_index]
2413
current_block = None
2416
if current_block and entry_index < len(current_block[1]):
2417
current_entry = current_block[1][entry_index]
2419
current_entry = None
2420
advance_entry = True
2422
if current_dir_info and path_index < len(current_dir_info[1]):
2423
current_path_info = current_dir_info[1][path_index]
2424
if current_path_info[2] == 'directory':
2425
if self.target._directory_is_tree_reference(
2426
current_path_info[0].decode('utf8')):
2427
current_path_info = current_path_info[:2] + \
2428
('tree-reference',) + current_path_info[3:]
2430
current_path_info = None
2432
path_handled = False
2433
while (current_entry is not None or
2434
current_path_info is not None):
2435
if current_entry is None:
2436
# the check for path_handled when the path is adnvaced
2437
# will yield this path if needed.
2439
elif current_path_info is None:
2440
# no path is fine: the per entry code will handle it.
2441
result = _process_entry(current_entry, current_path_info)
2442
if result is not None:
2443
if result is not uninteresting:
2445
elif (current_entry[0][1] != current_path_info[1]
2446
or current_entry[1][target_index][0] in 'ar'):
2447
# The current path on disk doesn't match the dirblock
2448
# record. Either the dirblock is marked as absent, or
2449
# the file on disk is not present at all in the
2450
# dirblock. Either way, report about the dirblock
2451
# entry, and let other code handle the filesystem one.
2453
# Compare the basename for these files to determine
2455
if current_path_info[1] < current_entry[0][1]:
2456
# extra file on disk: pass for now, but only
2457
# increment the path, not the entry
2458
advance_entry = False
2460
# entry referring to file not present on disk.
2461
# advance the entry only, after processing.
2462
result = _process_entry(current_entry, None)
2463
if result is not None:
2464
if result is not uninteresting:
2466
advance_path = False
2468
result = _process_entry(current_entry, current_path_info)
2469
if result is not None:
2471
if result is not uninteresting:
2473
if advance_entry and current_entry is not None:
2475
if entry_index < len(current_block[1]):
2476
current_entry = current_block[1][entry_index]
2478
current_entry = None
2480
advance_entry = True # reset the advance flaga
2481
if advance_path and current_path_info is not None:
2482
if not path_handled:
2483
# unversioned in all regards
2484
if want_unversioned:
2485
new_executable = bool(
2486
stat.S_ISREG(current_path_info[3].st_mode)
2487
and stat.S_IEXEC & current_path_info[3].st_mode)
2489
relpath_unicode = utf8_decode(current_path_info[0])[0]
2490
except UnicodeDecodeError:
2491
raise errors.BadFilenameEncoding(
2492
current_path_info[0], osutils._fs_enc)
2494
(None, relpath_unicode),
2498
(None, utf8_decode(current_path_info[1])[0]),
2499
(None, current_path_info[2]),
2500
(None, new_executable))
2501
# dont descend into this unversioned path if it is
2503
if current_path_info[2] in ('directory'):
2504
del current_dir_info[1][path_index]
2506
# dont descend the disk iterator into any tree
2508
if current_path_info[2] == 'tree-reference':
2509
del current_dir_info[1][path_index]
2512
if path_index < len(current_dir_info[1]):
2513
current_path_info = current_dir_info[1][path_index]
2514
if current_path_info[2] == 'directory':
2515
if self.target._directory_is_tree_reference(
2516
current_path_info[0].decode('utf8')):
2517
current_path_info = current_path_info[:2] + \
2518
('tree-reference',) + current_path_info[3:]
2520
current_path_info = None
2521
path_handled = False
2523
advance_path = True # reset the advance flagg.
2524
if current_block is not None:
2526
if (block_index < len(state._dirblocks) and
2527
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2528
current_block = state._dirblocks[block_index]
2530
current_block = None
2531
if current_dir_info is not None:
2533
current_dir_info = dir_iterator.next()
2534
except StopIteration:
2535
current_dir_info = None
2538
def is_compatible(source, target):
2539
# the target must be a dirstate working tree
2540
if not isinstance(target, WorkingTree4):
2542
# the source must be a revtreee or dirstate rev tree.
2543
if not isinstance(source,
2544
(revisiontree.RevisionTree, DirStateRevisionTree)):
2546
# the source revid must be in the target dirstate
2547
if not (source._revision_id == NULL_REVISION or
2548
source._revision_id in target.get_parent_ids()):
2549
# TODO: what about ghosts? it may well need to
2550
# check for them explicitly.
2554
InterTree.register_optimiser(InterDirStateTree)
2557
class Converter3to4(object):
2558
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2561
self.target_format = WorkingTreeFormat4()
2563
def convert(self, tree):
2564
# lock the control files not the tree, so that we dont get tree
2565
# on-unlock behaviours, and so that noone else diddles with the
2566
# tree during upgrade.
2567
tree._control_files.lock_write()
2569
tree.read_working_inventory()
2570
self.create_dirstate_data(tree)
2571
self.update_format(tree)
2572
self.remove_xml_files(tree)
2574
tree._control_files.unlock()
2576
def create_dirstate_data(self, tree):
2577
"""Create the dirstate based data for tree."""
2578
local_path = tree.bzrdir.get_workingtree_transport(None
2579
).local_abspath('dirstate')
2580
state = dirstate.DirState.from_tree(tree, local_path)
2584
def remove_xml_files(self, tree):
2585
"""Remove the oldformat 3 data."""
2586
transport = tree.bzrdir.get_workingtree_transport(None)
2587
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2588
'pending-merges', 'stat-cache']:
2590
transport.delete(path)
2591
except errors.NoSuchFile:
2592
# some files are optional - just deal.
2595
def update_format(self, tree):
2596
"""Change the format marker."""
2597
tree._transport.put_bytes('format',
2598
self.target_format.get_format_string(),
2599
mode=tree.bzrdir._get_file_mode())