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
class WorkingTree4(WorkingTree3):
102
"""This is the Format 4 working tree.
104
This differs from WorkingTree3 by:
105
- Having a consolidated internal dirstate, stored in a
106
randomly-accessible sorted file on disk.
107
- Not having a regular inventory attribute. One can be synthesized
108
on demand but this is expensive and should be avoided.
110
This is new in bzr 0.15.
113
def __init__(self, basedir,
118
"""Construct a WorkingTree for basedir.
120
If the branch is not supplied, it is opened automatically.
121
If the branch is supplied, it must be the branch for this basedir.
122
(branch.base is not cross checked, because for remote branches that
123
would be meaningless).
125
self._format = _format
126
self.bzrdir = _bzrdir
127
basedir = safe_unicode(basedir)
128
mutter("opening working tree %r", basedir)
129
self._branch = branch
130
self.basedir = realpath(basedir)
131
# if branch is at our basedir and is a format 6 or less
132
# assume all other formats have their own control files.
133
self._control_files = _control_files
134
self._transport = self._control_files._transport
137
# during a read or write lock these objects are set, and are
138
# None the rest of the time.
139
self._dirstate = None
140
self._inventory = None
142
self._setup_directory_is_tree_reference()
143
self._detect_case_handling()
144
self._rules_searcher = None
145
#--- allow tests to select the dirstate iter_changes implementation
146
self._iter_changes = dirstate._process_entry
148
@needs_tree_write_lock
149
def _add(self, files, ids, kinds):
150
"""See MutableTree._add."""
151
state = self.current_dirstate()
152
for f, file_id, kind in zip(files, ids, kinds):
155
# special case tree root handling.
156
if f == '' and self.path2id(f) == ROOT_ID:
157
state.set_path_id('', generate_ids.gen_file_id(f))
160
file_id = generate_ids.gen_file_id(f)
161
# deliberately add the file with no cached stat or sha1
162
# - on the first access it will be gathered, and we can
163
# always change this once tests are all passing.
164
state.add(f, file_id, kind, None, '')
165
self._make_dirty(reset_inventory=True)
167
def _make_dirty(self, reset_inventory):
168
"""Make the tree state dirty.
170
:param reset_inventory: True if the cached inventory should be removed
171
(presuming there is one).
174
if reset_inventory and self._inventory is not None:
175
self._inventory = None
177
@needs_tree_write_lock
178
def add_reference(self, sub_tree):
179
# use standard implementation, which calls back to self._add
181
# So we don't store the reference_revision in the working dirstate,
182
# it's just recorded at the moment of commit.
183
self._add_reference(sub_tree)
185
def break_lock(self):
186
"""Break a lock if one is present from another instance.
188
Uses the ui factory to ask for confirmation if the lock may be from
191
This will probe the repository for its lock as well.
193
# if the dirstate is locked by an active process, reject the break lock
196
if self._dirstate is None:
200
state = self._current_dirstate()
201
if state._lock_token is not None:
202
# we already have it locked. sheese, cant break our own lock.
203
raise errors.LockActive(self.basedir)
206
# try for a write lock - need permission to get one anyhow
209
except errors.LockContention:
210
# oslocks fail when a process is still live: fail.
211
# TODO: get the locked lockdir info and give to the user to
212
# assist in debugging.
213
raise errors.LockActive(self.basedir)
218
self._dirstate = None
219
self._control_files.break_lock()
220
self.branch.break_lock()
222
def _comparison_data(self, entry, path):
223
kind, executable, stat_value = \
224
WorkingTree3._comparison_data(self, entry, path)
225
# it looks like a plain directory, but it's really a reference -- see
227
if (self._repo_supports_tree_reference and
228
kind == 'directory' and
229
self._directory_is_tree_reference(path)):
230
kind = 'tree-reference'
231
return kind, executable, stat_value
234
def commit(self, message=None, revprops=None, *args, **kwargs):
235
# mark the tree as dirty post commit - commit
236
# can change the current versioned list by doing deletes.
237
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
238
self._make_dirty(reset_inventory=True)
241
def current_dirstate(self):
242
"""Return the current dirstate object.
244
This is not part of the tree interface and only exposed for ease of
247
:raises errors.NotWriteLocked: when not in a lock.
249
self._must_be_locked()
250
return self._current_dirstate()
252
def _current_dirstate(self):
253
"""Internal function that does not check lock status.
255
This is needed for break_lock which also needs the dirstate.
257
if self._dirstate is not None:
258
return self._dirstate
259
local_path = self.bzrdir.get_workingtree_transport(None
260
).local_abspath('dirstate')
261
self._dirstate = dirstate.DirState.on_file(local_path)
262
return self._dirstate
264
def filter_unversioned_files(self, paths):
265
"""Filter out paths that are versioned.
267
:return: set of paths.
269
# TODO: make a generic multi-bisect routine roughly that should list
270
# the paths, then process one half at a time recursively, and feed the
271
# results of each bisect in further still
272
paths = sorted(paths)
274
state = self.current_dirstate()
275
# TODO we want a paths_to_dirblocks helper I think
277
dirname, basename = os.path.split(path.encode('utf8'))
278
_, _, _, path_is_versioned = state._get_block_entry_index(
279
dirname, basename, 0)
280
if not path_is_versioned:
285
"""Write all cached data to disk."""
286
if self._control_files._lock_mode != 'w':
287
raise errors.NotWriteLocked(self)
288
self.current_dirstate().save()
289
self._inventory = None
292
@needs_tree_write_lock
293
def _gather_kinds(self, files, kinds):
294
"""See MutableTree._gather_kinds."""
295
for pos, f in enumerate(files):
296
if kinds[pos] is None:
297
kinds[pos] = self._kind(f)
299
def _generate_inventory(self):
300
"""Create and set self.inventory from the dirstate object.
302
This is relatively expensive: we have to walk the entire dirstate.
303
Ideally we would not, and can deprecate this function.
305
#: uncomment to trap on inventory requests.
306
# import pdb;pdb.set_trace()
307
state = self.current_dirstate()
308
state._read_dirblocks_if_needed()
309
root_key, current_entry = self._get_entry(path='')
310
current_id = root_key[2]
311
if not (current_entry[0][0] == 'd'): # directory
312
raise AssertionError(current_entry)
313
inv = Inventory(root_id=current_id)
314
# Turn some things into local variables
315
minikind_to_kind = dirstate.DirState._minikind_to_kind
316
factory = entry_factory
317
utf8_decode = cache_utf8._utf8_decode
319
# we could do this straight out of the dirstate; it might be fast
320
# and should be profiled - RBC 20070216
321
parent_ies = {'' : inv.root}
322
for block in state._dirblocks[1:]: # skip the root
325
parent_ie = parent_ies[dirname]
327
# all the paths in this block are not versioned in this tree
329
for key, entry in block[1]:
330
minikind, link_or_sha1, size, executable, stat = entry[0]
331
if minikind in ('a', 'r'): # absent, relocated
332
# a parent tree only entry
335
name_unicode = utf8_decode(name)[0]
337
kind = minikind_to_kind[minikind]
338
inv_entry = factory[kind](file_id, name_unicode,
341
# This is only needed on win32, where this is the only way
342
# we know the executable bit.
343
inv_entry.executable = executable
344
# not strictly needed: working tree
345
#inv_entry.text_size = size
346
#inv_entry.text_sha1 = sha1
347
elif kind == 'directory':
348
# add this entry to the parent map.
349
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
350
elif kind == 'tree-reference':
351
if not self._repo_supports_tree_reference:
352
raise AssertionError(
354
"doesn't support tree references "
355
"required by entry %r"
357
inv_entry.reference_revision = link_or_sha1 or None
358
elif kind != 'symlink':
359
raise AssertionError("unknown kind %r" % kind)
360
# These checks cost us around 40ms on a 55k entry tree
361
if file_id in inv_byid:
362
raise AssertionError('file_id %s already in'
363
' inventory as %s' % (file_id, inv_byid[file_id]))
364
if name_unicode in parent_ie.children:
365
raise AssertionError('name %r already in parent'
367
inv_byid[file_id] = inv_entry
368
parent_ie.children[name_unicode] = inv_entry
369
self._inventory = inv
371
def _get_entry(self, file_id=None, path=None):
372
"""Get the dirstate row for file_id or path.
374
If either file_id or path is supplied, it is used as the key to lookup.
375
If both are supplied, the fastest lookup is used, and an error is
376
raised if they do not both point at the same row.
378
:param file_id: An optional unicode file_id to be looked up.
379
:param path: An optional unicode path to be looked up.
380
:return: The dirstate row tuple for path/file_id, or (None, None)
382
if file_id is None and path is None:
383
raise errors.BzrError('must supply file_id or path')
384
state = self.current_dirstate()
386
path = path.encode('utf8')
387
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
389
def get_file_sha1(self, file_id, path=None, stat_value=None):
390
# check file id is valid unconditionally.
391
entry = self._get_entry(file_id=file_id, path=path)
393
raise errors.NoSuchId(self, file_id)
395
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
397
file_abspath = self.abspath(path)
398
state = self.current_dirstate()
399
if stat_value is None:
401
stat_value = os.lstat(file_abspath)
403
if e.errno == errno.ENOENT:
407
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
408
stat_value=stat_value)
409
if entry[1][0][0] == 'f':
413
def _get_inventory(self):
414
"""Get the inventory for the tree. This is only valid within a lock."""
415
if 'evil' in debug.debug_flags:
416
trace.mutter_callsite(2,
417
"accessing .inventory forces a size of tree translation.")
418
if self._inventory is not None:
419
return self._inventory
420
self._must_be_locked()
421
self._generate_inventory()
422
return self._inventory
424
inventory = property(_get_inventory,
425
doc="Inventory of this Tree")
428
def get_parent_ids(self):
429
"""See Tree.get_parent_ids.
431
This implementation requests the ids list from the dirstate file.
433
return self.current_dirstate().get_parent_ids()
435
def get_reference_revision(self, file_id, path=None):
436
# referenced tree's revision is whatever's currently there
437
return self.get_nested_tree(file_id, path).last_revision()
439
def get_nested_tree(self, file_id, path=None):
441
path = self.id2path(file_id)
442
# else: check file_id is at path?
443
return WorkingTree.open(self.abspath(path))
446
def get_root_id(self):
447
"""Return the id of this trees root"""
448
return self._get_entry(path='')[0][2]
450
def has_id(self, file_id):
451
state = self.current_dirstate()
452
row, parents = self._get_entry(file_id=file_id)
455
return osutils.lexists(pathjoin(
456
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
459
def id2path(self, file_id):
460
"Convert a file-id to a path."
461
state = self.current_dirstate()
462
entry = self._get_entry(file_id=file_id)
463
if entry == (None, None):
464
raise errors.NoSuchId(tree=self, file_id=file_id)
465
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
466
return path_utf8.decode('utf8')
468
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
469
entry = self._get_entry(path=path)
470
if entry == (None, None):
471
return False # Missing entries are not executable
472
return entry[1][0][3] # Executable?
474
if not osutils.supports_executable():
475
def is_executable(self, file_id, path=None):
476
"""Test if a file is executable or not.
478
Note: The caller is expected to take a read-lock before calling this.
480
entry = self._get_entry(file_id=file_id, path=path)
481
if entry == (None, None):
483
return entry[1][0][3]
485
_is_executable_from_path_and_stat = \
486
_is_executable_from_path_and_stat_from_basis
488
def is_executable(self, file_id, path=None):
489
"""Test if a file is executable or not.
491
Note: The caller is expected to take a read-lock before calling this.
493
self._must_be_locked()
495
path = self.id2path(file_id)
496
mode = os.lstat(self.abspath(path)).st_mode
497
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
499
def all_file_ids(self):
500
"""See Tree.iter_all_file_ids"""
501
self._must_be_locked()
503
for key, tree_details in self.current_dirstate()._iter_entries():
504
if tree_details[0][0] in ('a', 'r'): # relocated
511
"""Iterate through file_ids for this tree.
513
file_ids are in a WorkingTree if they are in the working inventory
514
and the working file exists.
517
for key, tree_details in self.current_dirstate()._iter_entries():
518
if tree_details[0][0] in ('a', 'r'): # absent, relocated
519
# not relevant to the working tree
521
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
522
if osutils.lexists(path):
523
result.append(key[2])
526
def iter_references(self):
527
if not self._repo_supports_tree_reference:
528
# When the repo doesn't support references, we will have nothing to
531
for key, tree_details in self.current_dirstate()._iter_entries():
532
if tree_details[0][0] in ('a', 'r'): # absent, relocated
533
# not relevant to the working tree
536
# the root is not a reference.
538
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
540
if self._kind(relpath) == 'tree-reference':
541
yield relpath, key[2]
542
except errors.NoSuchFile:
543
# path is missing on disk.
546
def kind(self, file_id):
547
"""Return the kind of a file.
549
This is always the actual kind that's on disk, regardless of what it
552
Note: The caller is expected to take a read-lock before calling this.
554
relpath = self.id2path(file_id)
556
raise AssertionError(
557
"path for id {%s} is None!" % file_id)
558
return self._kind(relpath)
560
def _kind(self, relpath):
561
abspath = self.abspath(relpath)
562
kind = file_kind(abspath)
563
if (self._repo_supports_tree_reference and
564
kind == 'directory' and
565
self._directory_is_tree_reference(relpath)):
566
kind = 'tree-reference'
570
def _last_revision(self):
571
"""See Mutable.last_revision."""
572
parent_ids = self.current_dirstate().get_parent_ids()
576
return _mod_revision.NULL_REVISION
579
"""See Branch.lock_read, and WorkingTree.unlock."""
580
self.branch.lock_read()
582
self._control_files.lock_read()
584
state = self.current_dirstate()
585
if not state._lock_token:
587
# set our support for tree references from the repository in
589
self._repo_supports_tree_reference = getattr(
590
self.branch.repository._format, "supports_tree_reference",
593
self._control_files.unlock()
599
def _lock_self_write(self):
600
"""This should be called after the branch is locked."""
602
self._control_files.lock_write()
604
state = self.current_dirstate()
605
if not state._lock_token:
607
# set our support for tree references from the repository in
609
self._repo_supports_tree_reference = getattr(
610
self.branch.repository._format, "supports_tree_reference",
613
self._control_files.unlock()
619
def lock_tree_write(self):
620
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
621
self.branch.lock_read()
622
self._lock_self_write()
624
def lock_write(self):
625
"""See MutableTree.lock_write, and WorkingTree.unlock."""
626
self.branch.lock_write()
627
self._lock_self_write()
629
@needs_tree_write_lock
630
def move(self, from_paths, to_dir, after=False):
631
"""See WorkingTree.move()."""
635
state = self.current_dirstate()
636
if isinstance(from_paths, basestring):
638
to_dir_utf8 = to_dir.encode('utf8')
639
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
640
id_index = state._get_id_index()
641
# check destination directory
642
# get the details for it
643
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
644
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
645
if not entry_present:
646
raise errors.BzrMoveFailedError('', to_dir,
647
errors.NotVersionedError(to_dir))
648
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
649
# get a handle on the block itself.
650
to_block_index = state._ensure_block(
651
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
652
to_block = state._dirblocks[to_block_index]
653
to_abs = self.abspath(to_dir)
654
if not isdir(to_abs):
655
raise errors.BzrMoveFailedError('',to_dir,
656
errors.NotADirectory(to_abs))
658
if to_entry[1][0][0] != 'd':
659
raise errors.BzrMoveFailedError('',to_dir,
660
errors.NotADirectory(to_abs))
662
if self._inventory is not None:
663
update_inventory = True
665
to_dir_id = to_entry[0][2]
666
to_dir_ie = inv[to_dir_id]
668
update_inventory = False
671
def move_one(old_entry, from_path_utf8, minikind, executable,
672
fingerprint, packed_stat, size,
673
to_block, to_key, to_path_utf8):
674
state._make_absent(old_entry)
675
from_key = old_entry[0]
677
lambda:state.update_minimal(from_key,
679
executable=executable,
680
fingerprint=fingerprint,
681
packed_stat=packed_stat,
683
path_utf8=from_path_utf8))
684
state.update_minimal(to_key,
686
executable=executable,
687
fingerprint=fingerprint,
688
packed_stat=packed_stat,
690
path_utf8=to_path_utf8)
691
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
692
new_entry = to_block[1][added_entry_index]
693
rollbacks.append(lambda:state._make_absent(new_entry))
695
for from_rel in from_paths:
696
# from_rel is 'pathinroot/foo/bar'
697
from_rel_utf8 = from_rel.encode('utf8')
698
from_dirname, from_tail = osutils.split(from_rel)
699
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
700
from_entry = self._get_entry(path=from_rel)
701
if from_entry == (None, None):
702
raise errors.BzrMoveFailedError(from_rel,to_dir,
703
errors.NotVersionedError(path=str(from_rel)))
705
from_id = from_entry[0][2]
706
to_rel = pathjoin(to_dir, from_tail)
707
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
708
item_to_entry = self._get_entry(path=to_rel)
709
if item_to_entry != (None, None):
710
raise errors.BzrMoveFailedError(from_rel, to_rel,
711
"Target is already versioned.")
713
if from_rel == to_rel:
714
raise errors.BzrMoveFailedError(from_rel, to_rel,
715
"Source and target are identical.")
717
from_missing = not self.has_filename(from_rel)
718
to_missing = not self.has_filename(to_rel)
725
raise errors.BzrMoveFailedError(from_rel, to_rel,
726
errors.NoSuchFile(path=to_rel,
727
extra="New file has not been created yet"))
729
# neither path exists
730
raise errors.BzrRenameFailedError(from_rel, to_rel,
731
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
733
if from_missing: # implicitly just update our path mapping
736
raise errors.RenameFailedFilesExist(from_rel, to_rel)
739
def rollback_rename():
740
"""A single rename has failed, roll it back."""
741
# roll back everything, even if we encounter trouble doing one
744
# TODO: at least log the other exceptions rather than just
745
# losing them mbp 20070307
747
for rollback in reversed(rollbacks):
751
exc_info = sys.exc_info()
753
raise exc_info[0], exc_info[1], exc_info[2]
755
# perform the disk move first - its the most likely failure point.
757
from_rel_abs = self.abspath(from_rel)
758
to_rel_abs = self.abspath(to_rel)
760
osutils.rename(from_rel_abs, to_rel_abs)
762
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
763
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
765
# perform the rename in the inventory next if needed: its easy
769
from_entry = inv[from_id]
770
current_parent = from_entry.parent_id
771
inv.rename(from_id, to_dir_id, from_tail)
773
lambda: inv.rename(from_id, current_parent, from_tail))
774
# finally do the rename in the dirstate, which is a little
775
# tricky to rollback, but least likely to need it.
776
old_block_index, old_entry_index, dir_present, file_present = \
777
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
778
old_block = state._dirblocks[old_block_index][1]
779
old_entry = old_block[old_entry_index]
780
from_key, old_entry_details = old_entry
781
cur_details = old_entry_details[0]
783
to_key = ((to_block[0],) + from_key[1:3])
784
minikind = cur_details[0]
785
move_one(old_entry, from_path_utf8=from_rel_utf8,
787
executable=cur_details[3],
788
fingerprint=cur_details[1],
789
packed_stat=cur_details[4],
793
to_path_utf8=to_rel_utf8)
796
def update_dirblock(from_dir, to_key, to_dir_utf8):
797
"""Recursively update all entries in this dirblock."""
799
raise AssertionError("renaming root not supported")
800
from_key = (from_dir, '')
801
from_block_idx, present = \
802
state._find_block_index_from_key(from_key)
804
# This is the old record, if it isn't present, then
805
# there is theoretically nothing to update.
806
# (Unless it isn't present because of lazy loading,
807
# but we don't do that yet)
809
from_block = state._dirblocks[from_block_idx]
810
to_block_index, to_entry_index, _, _ = \
811
state._get_block_entry_index(to_key[0], to_key[1], 0)
812
to_block_index = state._ensure_block(
813
to_block_index, to_entry_index, to_dir_utf8)
814
to_block = state._dirblocks[to_block_index]
816
# Grab a copy since move_one may update the list.
817
for entry in from_block[1][:]:
818
if not (entry[0][0] == from_dir):
819
raise AssertionError()
820
cur_details = entry[1][0]
821
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
822
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
823
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
824
minikind = cur_details[0]
826
# Deleted children of a renamed directory
827
# Do not need to be updated.
828
# Children that have been renamed out of this
829
# directory should also not be updated
831
move_one(entry, from_path_utf8=from_path_utf8,
833
executable=cur_details[3],
834
fingerprint=cur_details[1],
835
packed_stat=cur_details[4],
839
to_path_utf8=to_path_utf8)
841
# We need to move all the children of this
843
update_dirblock(from_path_utf8, to_key,
845
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
849
result.append((from_rel, to_rel))
850
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
851
self._make_dirty(reset_inventory=False)
855
def _must_be_locked(self):
856
if not self._control_files._lock_count:
857
raise errors.ObjectNotLocked(self)
860
"""Initialize the state in this tree to be a new tree."""
864
def path2id(self, path):
865
"""Return the id for path in this tree."""
866
path = path.strip('/')
867
entry = self._get_entry(path=path)
868
if entry == (None, None):
872
def paths2ids(self, paths, trees=[], require_versioned=True):
873
"""See Tree.paths2ids().
875
This specialisation fast-paths the case where all the trees are in the
880
parents = self.get_parent_ids()
882
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
884
return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
885
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
886
# -- make all paths utf8 --
889
paths_utf8.add(path.encode('utf8'))
891
# -- paths is now a utf8 path set --
892
# -- get the state object and prepare it.
893
state = self.current_dirstate()
894
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
895
and '' not in paths):
896
paths2ids = self._paths2ids_using_bisect
898
paths2ids = self._paths2ids_in_memory
899
return paths2ids(paths, search_indexes,
900
require_versioned=require_versioned)
902
def _paths2ids_in_memory(self, paths, search_indexes,
903
require_versioned=True):
904
state = self.current_dirstate()
905
state._read_dirblocks_if_needed()
906
def _entries_for_path(path):
907
"""Return a list with all the entries that match path for all ids.
909
dirname, basename = os.path.split(path)
910
key = (dirname, basename, '')
911
block_index, present = state._find_block_index_from_key(key)
913
# the block which should contain path is absent.
916
block = state._dirblocks[block_index][1]
917
entry_index, _ = state._find_entry_index(key, block)
918
# we may need to look at multiple entries at this path: walk while the paths match.
919
while (entry_index < len(block) and
920
block[entry_index][0][0:2] == key[0:2]):
921
result.append(block[entry_index])
924
if require_versioned:
925
# -- check all supplied paths are versioned in a search tree. --
928
path_entries = _entries_for_path(path)
930
# this specified path is not present at all: error
931
all_versioned = False
933
found_versioned = False
934
# for each id at this path
935
for entry in path_entries:
937
for index in search_indexes:
938
if entry[1][index][0] != 'a': # absent
939
found_versioned = True
940
# all good: found a versioned cell
942
if not found_versioned:
943
# none of the indexes was not 'absent' at all ids for this
945
all_versioned = False
947
if not all_versioned:
948
raise errors.PathsNotVersionedError(paths)
949
# -- remove redundancy in supplied paths to prevent over-scanning --
950
search_paths = osutils.minimum_path_selection(paths)
952
# for all search_indexs in each path at or under each element of
953
# search_paths, if the detail is relocated: add the id, and add the
954
# relocated path as one to search if its not searched already. If the
955
# detail is not relocated, add the id.
956
searched_paths = set()
958
def _process_entry(entry):
959
"""Look at search_indexes within entry.
961
If a specific tree's details are relocated, add the relocation
962
target to search_paths if not searched already. If it is absent, do
963
nothing. Otherwise add the id to found_ids.
965
for index in search_indexes:
966
if entry[1][index][0] == 'r': # relocated
967
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
968
search_paths.add(entry[1][index][1])
969
elif entry[1][index][0] != 'a': # absent
970
found_ids.add(entry[0][2])
972
current_root = search_paths.pop()
973
searched_paths.add(current_root)
974
# process the entries for this containing directory: the rest will be
975
# found by their parents recursively.
976
root_entries = _entries_for_path(current_root)
978
# this specified path is not present at all, skip it.
980
for entry in root_entries:
981
_process_entry(entry)
982
initial_key = (current_root, '', '')
983
block_index, _ = state._find_block_index_from_key(initial_key)
984
while (block_index < len(state._dirblocks) and
985
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
986
for entry in state._dirblocks[block_index][1]:
987
_process_entry(entry)
991
def _paths2ids_using_bisect(self, paths, search_indexes,
992
require_versioned=True):
993
state = self.current_dirstate()
996
split_paths = sorted(osutils.split(p) for p in paths)
997
found = state._bisect_recursive(split_paths)
999
if require_versioned:
1000
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1001
for dir_name in split_paths:
1002
if dir_name not in found_dir_names:
1003
raise errors.PathsNotVersionedError(paths)
1005
for dir_name_id, trees_info in found.iteritems():
1006
for index in search_indexes:
1007
if trees_info[index][0] not in ('r', 'a'):
1008
found_ids.add(dir_name_id[2])
1011
def read_working_inventory(self):
1012
"""Read the working inventory.
1014
This is a meaningless operation for dirstate, but we obey it anyhow.
1016
return self.inventory
1019
def revision_tree(self, revision_id):
1020
"""See Tree.revision_tree.
1022
WorkingTree4 supplies revision_trees for any basis tree.
1024
dirstate = self.current_dirstate()
1025
parent_ids = dirstate.get_parent_ids()
1026
if revision_id not in parent_ids:
1027
raise errors.NoSuchRevisionInTree(self, revision_id)
1028
if revision_id in dirstate.get_ghosts():
1029
raise errors.NoSuchRevisionInTree(self, revision_id)
1030
return DirStateRevisionTree(dirstate, revision_id,
1031
self.branch.repository)
1033
@needs_tree_write_lock
1034
def set_last_revision(self, new_revision):
1035
"""Change the last revision in the working tree."""
1036
parents = self.get_parent_ids()
1037
if new_revision in (NULL_REVISION, None):
1038
if len(parents) >= 2:
1039
raise AssertionError(
1040
"setting the last parent to none with a pending merge is "
1042
self.set_parent_ids([])
1044
self.set_parent_ids([new_revision] + parents[1:],
1045
allow_leftmost_as_ghost=True)
1047
@needs_tree_write_lock
1048
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1049
"""Set the parent ids to revision_ids.
1051
See also set_parent_trees. This api will try to retrieve the tree data
1052
for each element of revision_ids from the trees repository. If you have
1053
tree data already available, it is more efficient to use
1054
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1055
an easier API to use.
1057
:param revision_ids: The revision_ids to set as the parent ids of this
1058
working tree. Any of these may be ghosts.
1061
for revision_id in revision_ids:
1063
revtree = self.branch.repository.revision_tree(revision_id)
1064
# TODO: jam 20070213 KnitVersionedFile raises
1065
# RevisionNotPresent rather than NoSuchRevision if a
1066
# given revision_id is not present. Should Repository be
1067
# catching it and re-raising NoSuchRevision?
1068
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1070
trees.append((revision_id, revtree))
1071
self.set_parent_trees(trees,
1072
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1074
@needs_tree_write_lock
1075
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1076
"""Set the parents of the working tree.
1078
:param parents_list: A list of (revision_id, tree) tuples.
1079
If tree is None, then that element is treated as an unreachable
1080
parent tree - i.e. a ghost.
1082
dirstate = self.current_dirstate()
1083
if len(parents_list) > 0:
1084
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1085
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1089
parent_ids = [rev_id for rev_id, tree in parents_list]
1090
graph = self.branch.repository.get_graph()
1091
heads = graph.heads(parent_ids)
1092
accepted_revisions = set()
1094
# convert absent trees to the null tree, which we convert back to
1095
# missing on access.
1096
for rev_id, tree in parents_list:
1097
if len(accepted_revisions) > 0:
1098
# we always accept the first tree
1099
if rev_id in accepted_revisions or rev_id not in heads:
1100
# We have already included either this tree, or its
1101
# descendent, so we skip it.
1103
_mod_revision.check_not_reserved_id(rev_id)
1104
if tree is not None:
1105
real_trees.append((rev_id, tree))
1107
real_trees.append((rev_id,
1108
self.branch.repository.revision_tree(
1109
_mod_revision.NULL_REVISION)))
1110
ghosts.append(rev_id)
1111
accepted_revisions.add(rev_id)
1112
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1113
self._make_dirty(reset_inventory=False)
1115
def _set_root_id(self, file_id):
1116
"""See WorkingTree.set_root_id."""
1117
state = self.current_dirstate()
1118
state.set_path_id('', file_id)
1119
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1120
self._make_dirty(reset_inventory=True)
1122
def _sha_from_stat(self, path, stat_result):
1123
"""Get a sha digest from the tree's stat cache.
1125
The default implementation assumes no stat cache is present.
1127
:param path: The path.
1128
:param stat_result: The stat result being looked up.
1130
return self.current_dirstate().sha1_from_stat(path, stat_result)
1133
def supports_tree_reference(self):
1134
return self._repo_supports_tree_reference
1137
"""Unlock in format 4 trees needs to write the entire dirstate."""
1138
# do non-implementation specific cleanup
1141
if self._control_files._lock_count == 1:
1142
# eventually we should do signature checking during read locks for
1144
if self._control_files._lock_mode == 'w':
1147
if self._dirstate is not None:
1148
# This is a no-op if there are no modifications.
1149
self._dirstate.save()
1150
self._dirstate.unlock()
1151
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1152
# point. Instead, it could check if the header has been
1153
# modified when it is locked, and if not, it can hang on to
1154
# the data it has in memory.
1155
self._dirstate = None
1156
self._inventory = None
1157
# reverse order of locking.
1159
return self._control_files.unlock()
1161
self.branch.unlock()
1163
@needs_tree_write_lock
1164
def unversion(self, file_ids):
1165
"""Remove the file ids in file_ids from the current versioned set.
1167
When a file_id is unversioned, all of its children are automatically
1170
:param file_ids: The file ids to stop versioning.
1171
:raises: NoSuchId if any fileid is not currently versioned.
1175
state = self.current_dirstate()
1176
state._read_dirblocks_if_needed()
1177
ids_to_unversion = set(file_ids)
1178
paths_to_unversion = set()
1180
# check if the root is to be unversioned, if so, assert for now.
1181
# walk the state marking unversioned things as absent.
1182
# if there are any un-unversioned ids at the end, raise
1183
for key, details in state._dirblocks[0][1]:
1184
if (details[0][0] not in ('a', 'r') and # absent or relocated
1185
key[2] in ids_to_unversion):
1186
# I haven't written the code to unversion / yet - it should be
1188
raise errors.BzrError('Unversioning the / is not currently supported')
1190
while block_index < len(state._dirblocks):
1191
# process one directory at a time.
1192
block = state._dirblocks[block_index]
1193
# first check: is the path one to remove - it or its children
1194
delete_block = False
1195
for path in paths_to_unversion:
1196
if (block[0].startswith(path) and
1197
(len(block[0]) == len(path) or
1198
block[0][len(path)] == '/')):
1199
# this entire block should be deleted - its the block for a
1200
# path to unversion; or the child of one
1203
# TODO: trim paths_to_unversion as we pass by paths
1205
# this block is to be deleted: process it.
1206
# TODO: we can special case the no-parents case and
1207
# just forget the whole block.
1209
while entry_index < len(block[1]):
1210
# Mark this file id as having been removed
1211
entry = block[1][entry_index]
1212
ids_to_unversion.discard(entry[0][2])
1213
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1215
or not state._make_absent(entry)):
1217
# go to the next block. (At the moment we dont delete empty
1222
while entry_index < len(block[1]):
1223
entry = block[1][entry_index]
1224
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1225
# ^ some parent row.
1226
entry[0][2] not in ids_to_unversion):
1227
# ^ not an id to unversion
1230
if entry[1][0][0] == 'd':
1231
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1232
if not state._make_absent(entry):
1234
# we have unversioned this id
1235
ids_to_unversion.remove(entry[0][2])
1237
if ids_to_unversion:
1238
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1239
self._make_dirty(reset_inventory=False)
1240
# have to change the legacy inventory too.
1241
if self._inventory is not None:
1242
for file_id in file_ids:
1243
self._inventory.remove_recursive_id(file_id)
1245
@needs_tree_write_lock
1246
def rename_one(self, from_rel, to_rel, after=False):
1247
"""See WorkingTree.rename_one"""
1249
WorkingTree.rename_one(self, from_rel, to_rel, after)
1251
@needs_tree_write_lock
1252
def apply_inventory_delta(self, changes):
1253
"""See MutableTree.apply_inventory_delta"""
1254
state = self.current_dirstate()
1255
state.update_by_delta(changes)
1256
self._make_dirty(reset_inventory=True)
1258
def update_basis_by_delta(self, new_revid, delta):
1259
"""See MutableTree.update_basis_by_delta."""
1260
if self.last_revision() == new_revid:
1261
raise AssertionError()
1262
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1265
def _validate(self):
1266
self._dirstate._validate()
1268
@needs_tree_write_lock
1269
def _write_inventory(self, inv):
1270
"""Write inventory as the current inventory."""
1272
raise AssertionError("attempting to write an inventory when the "
1273
"dirstate is dirty will lose pending changes")
1274
self.current_dirstate().set_state_from_inventory(inv)
1275
self._make_dirty(reset_inventory=False)
1276
if self._inventory is not None:
1277
self._inventory = inv
1281
class WorkingTreeFormat4(WorkingTreeFormat3):
1282
"""The first consolidated dirstate working tree format.
1285
- exists within a metadir controlling .bzr
1286
- includes an explicit version marker for the workingtree control
1287
files, separate from the BzrDir format
1288
- modifies the hash cache format
1289
- is new in bzr 0.15
1290
- uses a LockDir to guard access to it.
1293
upgrade_recommended = False
1295
_tree_class = WorkingTree4
1297
def get_format_string(self):
1298
"""See WorkingTreeFormat.get_format_string()."""
1299
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1301
def get_format_description(self):
1302
"""See WorkingTreeFormat.get_format_description()."""
1303
return "Working tree format 4"
1305
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1306
accelerator_tree=None, hardlink=False):
1307
"""See WorkingTreeFormat.initialize().
1309
:param revision_id: allows creating a working tree at a different
1310
revision than the branch is at.
1311
:param accelerator_tree: A tree which can be used for retrieving file
1312
contents more quickly than the revision tree, i.e. a workingtree.
1313
The revision tree will be used for cases where accelerator_tree's
1314
content is different.
1315
:param hardlink: If true, hard-link files from accelerator_tree,
1318
These trees get an initial random root id, if their repository supports
1319
rich root data, TREE_ROOT otherwise.
1321
if not isinstance(a_bzrdir.transport, LocalTransport):
1322
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1323
transport = a_bzrdir.get_workingtree_transport(self)
1324
control_files = self._open_control_files(a_bzrdir)
1325
control_files.create_lock()
1326
control_files.lock_write()
1327
transport.put_bytes('format', self.get_format_string(),
1328
mode=a_bzrdir._get_file_mode())
1329
if from_branch is not None:
1330
branch = from_branch
1332
branch = a_bzrdir.open_branch()
1333
if revision_id is None:
1334
revision_id = branch.last_revision()
1335
local_path = transport.local_abspath('dirstate')
1336
# write out new dirstate (must exist when we create the tree)
1337
state = dirstate.DirState.initialize(local_path)
1340
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1344
_control_files=control_files)
1346
wt.lock_tree_write()
1348
self._init_custom_control_files(wt)
1349
if revision_id in (None, NULL_REVISION):
1350
if branch.repository.supports_rich_root():
1351
wt._set_root_id(generate_ids.gen_root_id())
1353
wt._set_root_id(ROOT_ID)
1356
# frequently, we will get here due to branching. The accelerator
1357
# tree will be the tree from the branch, so the desired basis
1358
# tree will often be a parent of the accelerator tree.
1359
if accelerator_tree is not None:
1361
basis = accelerator_tree.revision_tree(revision_id)
1362
except errors.NoSuchRevision:
1365
basis = branch.repository.revision_tree(revision_id)
1366
if revision_id == NULL_REVISION:
1369
parents_list = [(revision_id, basis)]
1372
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1374
# if the basis has a root id we have to use that; otherwise we
1375
# use a new random one
1376
basis_root_id = basis.get_root_id()
1377
if basis_root_id is not None:
1378
wt._set_root_id(basis_root_id)
1380
# delta_from_tree is safe even for DirStateRevisionTrees,
1381
# because wt4.apply_inventory_delta does not mutate the input
1382
# inventory entries.
1383
transform.build_tree(basis, wt, accelerator_tree,
1384
hardlink=hardlink, delta_from_tree=True)
1388
control_files.unlock()
1392
def _init_custom_control_files(self, wt):
1393
"""Subclasses with custom control files should override this method.
1395
The working tree and control files are locked for writing when this
1398
:param wt: the WorkingTree object
1401
def _open(self, a_bzrdir, control_files):
1402
"""Open the tree itself.
1404
:param a_bzrdir: the dir for the tree.
1405
:param control_files: the control files for the tree.
1407
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1408
branch=a_bzrdir.open_branch(),
1411
_control_files=control_files)
1413
def __get_matchingbzrdir(self):
1414
# please test against something that will let us do tree references
1415
return bzrdir.format_registry.make_bzrdir(
1416
'dirstate-with-subtree')
1418
_matchingbzrdir = property(__get_matchingbzrdir)
1421
class DirStateRevisionTree(Tree):
1422
"""A revision tree pulling the inventory from a dirstate."""
1424
def __init__(self, dirstate, revision_id, repository):
1425
self._dirstate = dirstate
1426
self._revision_id = revision_id
1427
self._repository = repository
1428
self._inventory = None
1430
self._dirstate_locked = False
1431
self._repo_supports_tree_reference = getattr(
1432
repository._format, "supports_tree_reference",
1436
return "<%s of %s in %s>" % \
1437
(self.__class__.__name__, self._revision_id, self._dirstate)
1439
def annotate_iter(self, file_id,
1440
default_revision=_mod_revision.CURRENT_REVISION):
1441
"""See Tree.annotate_iter"""
1442
text_key = (file_id, self.inventory[file_id].revision)
1443
annotations = self._repository.texts.annotate(text_key)
1444
return [(key[-1], line) for (key, line) in annotations]
1446
def _get_ancestors(self, default_revision):
1447
return set(self._repository.get_ancestry(self._revision_id,
1449
def _comparison_data(self, entry, path):
1450
"""See Tree._comparison_data."""
1452
return None, False, None
1453
# trust the entry as RevisionTree does, but this may not be
1454
# sensible: the entry might not have come from us?
1455
return entry.kind, entry.executable, None
1457
def _file_size(self, entry, stat_value):
1458
return entry.text_size
1460
def filter_unversioned_files(self, paths):
1461
"""Filter out paths that are not versioned.
1463
:return: set of paths.
1465
pred = self.has_filename
1466
return set((p for p in paths if not pred(p)))
1468
def get_root_id(self):
1469
return self.path2id('')
1471
def id2path(self, file_id):
1472
"Convert a file-id to a path."
1473
entry = self._get_entry(file_id=file_id)
1474
if entry == (None, None):
1475
raise errors.NoSuchId(tree=self, file_id=file_id)
1476
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1477
return path_utf8.decode('utf8')
1479
def iter_references(self):
1480
if not self._repo_supports_tree_reference:
1481
# When the repo doesn't support references, we will have nothing to
1484
# Otherwise, fall back to the default implementation
1485
return super(DirStateRevisionTree, self).iter_references()
1487
def _get_parent_index(self):
1488
"""Return the index in the dirstate referenced by this tree."""
1489
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1491
def _get_entry(self, file_id=None, path=None):
1492
"""Get the dirstate row for file_id or path.
1494
If either file_id or path is supplied, it is used as the key to lookup.
1495
If both are supplied, the fastest lookup is used, and an error is
1496
raised if they do not both point at the same row.
1498
:param file_id: An optional unicode file_id to be looked up.
1499
:param path: An optional unicode path to be looked up.
1500
:return: The dirstate row tuple for path/file_id, or (None, None)
1502
if file_id is None and path is None:
1503
raise errors.BzrError('must supply file_id or path')
1504
if path is not None:
1505
path = path.encode('utf8')
1506
parent_index = self._get_parent_index()
1507
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1509
def _generate_inventory(self):
1510
"""Create and set self.inventory from the dirstate object.
1512
(So this is only called the first time the inventory is requested for
1513
this tree; it then remains in memory until it's out of date.)
1515
This is relatively expensive: we have to walk the entire dirstate.
1517
if not self._locked:
1518
raise AssertionError(
1519
'cannot generate inventory of an unlocked '
1520
'dirstate revision tree')
1521
# separate call for profiling - makes it clear where the costs are.
1522
self._dirstate._read_dirblocks_if_needed()
1523
if self._revision_id not in self._dirstate.get_parent_ids():
1524
raise AssertionError(
1525
'parent %s has disappeared from %s' % (
1526
self._revision_id, self._dirstate.get_parent_ids()))
1527
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1528
# This is identical now to the WorkingTree _generate_inventory except
1529
# for the tree index use.
1530
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1531
current_id = root_key[2]
1532
if current_entry[parent_index][0] != 'd':
1533
raise AssertionError()
1534
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1535
inv.root.revision = current_entry[parent_index][4]
1536
# Turn some things into local variables
1537
minikind_to_kind = dirstate.DirState._minikind_to_kind
1538
factory = entry_factory
1539
utf8_decode = cache_utf8._utf8_decode
1540
inv_byid = inv._byid
1541
# we could do this straight out of the dirstate; it might be fast
1542
# and should be profiled - RBC 20070216
1543
parent_ies = {'' : inv.root}
1544
for block in self._dirstate._dirblocks[1:]: #skip root
1547
parent_ie = parent_ies[dirname]
1549
# all the paths in this block are not versioned in this tree
1551
for key, entry in block[1]:
1552
minikind, fingerprint, size, executable, revid = entry[parent_index]
1553
if minikind in ('a', 'r'): # absent, relocated
1557
name_unicode = utf8_decode(name)[0]
1559
kind = minikind_to_kind[minikind]
1560
inv_entry = factory[kind](file_id, name_unicode,
1562
inv_entry.revision = revid
1564
inv_entry.executable = executable
1565
inv_entry.text_size = size
1566
inv_entry.text_sha1 = fingerprint
1567
elif kind == 'directory':
1568
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1569
elif kind == 'symlink':
1570
inv_entry.executable = False
1571
inv_entry.text_size = None
1572
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1573
elif kind == 'tree-reference':
1574
inv_entry.reference_revision = fingerprint or None
1576
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1578
# These checks cost us around 40ms on a 55k entry tree
1579
if file_id in inv_byid:
1580
raise AssertionError('file_id %s already in'
1581
' inventory as %s' % (file_id, inv_byid[file_id]))
1582
if name_unicode in parent_ie.children:
1583
raise AssertionError('name %r already in parent'
1585
inv_byid[file_id] = inv_entry
1586
parent_ie.children[name_unicode] = inv_entry
1587
self._inventory = inv
1589
def get_file_mtime(self, file_id, path=None):
1590
"""Return the modification time for this record.
1592
We return the timestamp of the last-changed revision.
1594
# Make sure the file exists
1595
entry = self._get_entry(file_id, path=path)
1596
if entry == (None, None): # do we raise?
1598
parent_index = self._get_parent_index()
1599
last_changed_revision = entry[1][parent_index][4]
1600
return self._repository.get_revision(last_changed_revision).timestamp
1602
def get_file_sha1(self, file_id, path=None, stat_value=None):
1603
entry = self._get_entry(file_id=file_id, path=path)
1604
parent_index = self._get_parent_index()
1605
parent_details = entry[1][parent_index]
1606
if parent_details[0] == 'f':
1607
return parent_details[1]
1610
def get_file(self, file_id, path=None):
1611
return StringIO(self.get_file_text(file_id))
1613
def get_file_lines(self, file_id):
1614
return osutils.split_lines(self.get_file_text(file_id))
1616
def get_file_size(self, file_id):
1617
"""See Tree.get_file_size"""
1618
return self.inventory[file_id].text_size
1620
def get_file_text(self, file_id):
1621
return list(self.iter_files_bytes([(file_id, None)]))[0][1]
1623
def get_reference_revision(self, file_id, path=None):
1624
return self.inventory[file_id].reference_revision
1626
def iter_files_bytes(self, desired_files):
1627
"""See Tree.iter_files_bytes.
1629
This version is implemented on top of Repository.iter_files_bytes"""
1630
parent_index = self._get_parent_index()
1631
repo_desired_files = []
1632
for file_id, identifier in desired_files:
1633
entry = self._get_entry(file_id)
1634
if entry == (None, None):
1635
raise errors.NoSuchId(self, file_id)
1636
repo_desired_files.append((file_id, entry[1][parent_index][4],
1638
return self._repository.iter_files_bytes(repo_desired_files)
1640
def get_symlink_target(self, file_id):
1641
entry = self._get_entry(file_id=file_id)
1642
parent_index = self._get_parent_index()
1643
if entry[1][parent_index][0] != 'l':
1646
# At present, none of the tree implementations supports non-ascii
1647
# symlink targets. So we will just assume that the dirstate path is
1649
return entry[1][parent_index][1]
1651
def get_revision_id(self):
1652
"""Return the revision id for this tree."""
1653
return self._revision_id
1655
def _get_inventory(self):
1656
if self._inventory is not None:
1657
return self._inventory
1658
self._must_be_locked()
1659
self._generate_inventory()
1660
return self._inventory
1662
inventory = property(_get_inventory,
1663
doc="Inventory of this Tree")
1665
def get_parent_ids(self):
1666
"""The parents of a tree in the dirstate are not cached."""
1667
return self._repository.get_revision(self._revision_id).parent_ids
1669
def has_filename(self, filename):
1670
return bool(self.path2id(filename))
1672
def kind(self, file_id):
1673
entry = self._get_entry(file_id=file_id)[1]
1675
raise errors.NoSuchId(tree=self, file_id=file_id)
1676
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1678
def stored_kind(self, file_id):
1679
"""See Tree.stored_kind"""
1680
return self.kind(file_id)
1682
def path_content_summary(self, path):
1683
"""See Tree.path_content_summary."""
1684
id = self.inventory.path2id(path)
1686
return ('missing', None, None, None)
1687
entry = self._inventory[id]
1690
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1691
elif kind == 'symlink':
1692
return (kind, None, None, entry.symlink_target)
1694
return (kind, None, None, None)
1696
def is_executable(self, file_id, path=None):
1697
ie = self.inventory[file_id]
1698
if ie.kind != "file":
1700
return ie.executable
1702
def list_files(self, include_root=False):
1703
# We use a standard implementation, because DirStateRevisionTree is
1704
# dealing with one of the parents of the current state
1705
inv = self._get_inventory()
1706
entries = inv.iter_entries()
1707
if self.inventory.root is not None and not include_root:
1709
for path, entry in entries:
1710
yield path, 'V', entry.kind, entry.file_id, entry
1712
def lock_read(self):
1713
"""Lock the tree for a set of operations."""
1714
if not self._locked:
1715
self._repository.lock_read()
1716
if self._dirstate._lock_token is None:
1717
self._dirstate.lock_read()
1718
self._dirstate_locked = True
1721
def _must_be_locked(self):
1722
if not self._locked:
1723
raise errors.ObjectNotLocked(self)
1726
def path2id(self, path):
1727
"""Return the id for path in this tree."""
1728
# lookup by path: faster than splitting and walking the ivnentory.
1729
entry = self._get_entry(path=path)
1730
if entry == (None, None):
1735
"""Unlock, freeing any cache memory used during the lock."""
1736
# outside of a lock, the inventory is suspect: release it.
1738
if not self._locked:
1739
self._inventory = None
1741
if self._dirstate_locked:
1742
self._dirstate.unlock()
1743
self._dirstate_locked = False
1744
self._repository.unlock()
1747
def supports_tree_reference(self):
1748
return self._repo_supports_tree_reference
1750
def walkdirs(self, prefix=""):
1751
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1752
# implementation based on an inventory.
1753
# This should be cleaned up to use the much faster Dirstate code
1754
# So for now, we just build up the parent inventory, and extract
1755
# it the same way RevisionTree does.
1756
_directory = 'directory'
1757
inv = self._get_inventory()
1758
top_id = inv.path2id(prefix)
1762
pending = [(prefix, top_id)]
1765
relpath, file_id = pending.pop()
1766
# 0 - relpath, 1- file-id
1768
relroot = relpath + '/'
1771
# FIXME: stash the node in pending
1772
entry = inv[file_id]
1773
for name, child in entry.sorted_children():
1774
toppath = relroot + name
1775
dirblock.append((toppath, name, child.kind, None,
1776
child.file_id, child.kind
1778
yield (relpath, entry.file_id), dirblock
1779
# push the user specified dirs from dirblock
1780
for dir in reversed(dirblock):
1781
if dir[2] == _directory:
1782
pending.append((dir[0], dir[4]))
1785
class InterDirStateTree(InterTree):
1786
"""Fast path optimiser for changes_from with dirstate trees.
1788
This is used only when both trees are in the dirstate working file, and
1789
the source is any parent within the dirstate, and the destination is
1790
the current working tree of the same dirstate.
1792
# this could be generalized to allow comparisons between any trees in the
1793
# dirstate, and possibly between trees stored in different dirstates.
1795
def __init__(self, source, target):
1796
super(InterDirStateTree, self).__init__(source, target)
1797
if not InterDirStateTree.is_compatible(source, target):
1798
raise Exception, "invalid source %r and target %r" % (source, target)
1801
def make_source_parent_tree(source, target):
1802
"""Change the source tree into a parent of the target."""
1803
revid = source.commit('record tree')
1804
target.branch.repository.fetch(source.branch.repository, revid)
1805
target.set_parent_ids([revid])
1806
return target.basis_tree(), target
1809
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1810
result = klass.make_source_parent_tree(source, target)
1811
result[1]._iter_changes = dirstate.ProcessEntryPython
1815
def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
1816
from bzrlib.tests.test__dirstate_helpers import \
1817
CompiledDirstateHelpersFeature
1818
if not CompiledDirstateHelpersFeature.available():
1819
from bzrlib.tests import UnavailableFeature
1820
raise UnavailableFeature(CompiledDirstateHelpersFeature)
1821
from bzrlib._dirstate_helpers_c import ProcessEntryC
1822
result = klass.make_source_parent_tree(source, target)
1823
result[1]._iter_changes = ProcessEntryC
1826
_matching_from_tree_format = WorkingTreeFormat4()
1827
_matching_to_tree_format = WorkingTreeFormat4()
1830
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1831
# This method shouldn't be called, because we have python and C
1832
# specific flavours.
1833
raise NotImplementedError
1835
def iter_changes(self, include_unchanged=False,
1836
specific_files=None, pb=None, extra_trees=[],
1837
require_versioned=True, want_unversioned=False):
1838
"""Return the changes from source to target.
1840
:return: An iterator that yields tuples. See InterTree.iter_changes
1842
:param specific_files: An optional list of file paths to restrict the
1843
comparison to. When mapping filenames to ids, all matches in all
1844
trees (including optional extra_trees) are used, and all children of
1845
matched directories are included.
1846
:param include_unchanged: An optional boolean requesting the inclusion of
1847
unchanged entries in the result.
1848
:param extra_trees: An optional list of additional trees to use when
1849
mapping the contents of specific_files (paths) to file_ids.
1850
:param require_versioned: If True, all files in specific_files must be
1851
versioned in one of source, target, extra_trees or
1852
PathsNotVersionedError is raised.
1853
:param want_unversioned: Should unversioned files be returned in the
1854
output. An unversioned file is defined as one with (False, False)
1855
for the versioned pair.
1857
# NB: show_status depends on being able to pass in non-versioned files
1858
# and report them as unknown
1859
# TODO: handle extra trees in the dirstate.
1860
if (extra_trees or specific_files == []):
1861
# we can't fast-path these cases (yet)
1862
return super(InterDirStateTree, self).iter_changes(
1863
include_unchanged, specific_files, pb, extra_trees,
1864
require_versioned, want_unversioned=want_unversioned)
1865
parent_ids = self.target.get_parent_ids()
1866
if not (self.source._revision_id in parent_ids
1867
or self.source._revision_id == NULL_REVISION):
1868
raise AssertionError(
1869
"revision {%s} is not stored in {%s}, but %s "
1870
"can only be used for trees stored in the dirstate"
1871
% (self.source._revision_id, self.target, self.iter_changes))
1873
if self.source._revision_id == NULL_REVISION:
1875
indices = (target_index,)
1877
if not (self.source._revision_id in parent_ids):
1878
raise AssertionError(
1879
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1880
self.source._revision_id, parent_ids))
1881
source_index = 1 + parent_ids.index(self.source._revision_id)
1882
indices = (source_index, target_index)
1883
# -- make all specific_files utf8 --
1885
specific_files_utf8 = set()
1886
for path in specific_files:
1887
# Note, if there are many specific files, using cache_utf8
1888
# would be good here.
1889
specific_files_utf8.add(path.encode('utf8'))
1890
specific_files = specific_files_utf8
1892
specific_files = set([''])
1893
# -- specific_files is now a utf8 path set --
1894
search_specific_files = set()
1895
# -- get the state object and prepare it.
1896
state = self.target.current_dirstate()
1897
state._read_dirblocks_if_needed()
1898
if require_versioned:
1899
# -- check all supplied paths are versioned in a search tree. --
1900
all_versioned = True
1901
for path in specific_files:
1902
path_entries = state._entries_for_path(path)
1903
if not path_entries:
1904
# this specified path is not present at all: error
1905
all_versioned = False
1907
found_versioned = False
1908
# for each id at this path
1909
for entry in path_entries:
1911
for index in indices:
1912
if entry[1][index][0] != 'a': # absent
1913
found_versioned = True
1914
# all good: found a versioned cell
1916
if not found_versioned:
1917
# none of the indexes was not 'absent' at all ids for this
1919
all_versioned = False
1921
if not all_versioned:
1922
raise errors.PathsNotVersionedError(specific_files)
1923
# -- remove redundancy in supplied specific_files to prevent over-scanning --
1924
for path in specific_files:
1925
other_specific_files = specific_files.difference(set([path]))
1926
if not osutils.is_inside_any(other_specific_files, path):
1927
# this is a top level path, we must check it.
1928
search_specific_files.add(path)
1930
use_filesystem_for_exec = (sys.platform != 'win32')
1931
iter_changes = self.target._iter_changes(include_unchanged,
1932
use_filesystem_for_exec, search_specific_files, state,
1933
source_index, target_index, want_unversioned, self.target)
1934
return iter_changes.iter_changes()
1937
def is_compatible(source, target):
1938
# the target must be a dirstate working tree
1939
if not isinstance(target, WorkingTree4):
1941
# the source must be a revtreee or dirstate rev tree.
1942
if not isinstance(source,
1943
(revisiontree.RevisionTree, DirStateRevisionTree)):
1945
# the source revid must be in the target dirstate
1946
if not (source._revision_id == NULL_REVISION or
1947
source._revision_id in target.get_parent_ids()):
1948
# TODO: what about ghosts? it may well need to
1949
# check for them explicitly.
1953
InterTree.register_optimiser(InterDirStateTree)
1956
class Converter3to4(object):
1957
"""Perform an in-place upgrade of format 3 to format 4 trees."""
1960
self.target_format = WorkingTreeFormat4()
1962
def convert(self, tree):
1963
# lock the control files not the tree, so that we dont get tree
1964
# on-unlock behaviours, and so that noone else diddles with the
1965
# tree during upgrade.
1966
tree._control_files.lock_write()
1968
tree.read_working_inventory()
1969
self.create_dirstate_data(tree)
1970
self.update_format(tree)
1971
self.remove_xml_files(tree)
1973
tree._control_files.unlock()
1975
def create_dirstate_data(self, tree):
1976
"""Create the dirstate based data for tree."""
1977
local_path = tree.bzrdir.get_workingtree_transport(None
1978
).local_abspath('dirstate')
1979
state = dirstate.DirState.from_tree(tree, local_path)
1983
def remove_xml_files(self, tree):
1984
"""Remove the oldformat 3 data."""
1985
transport = tree.bzrdir.get_workingtree_transport(None)
1986
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
1987
'pending-merges', 'stat-cache']:
1989
transport.delete(path)
1990
except errors.NoSuchFile:
1991
# some files are optional - just deal.
1994
def update_format(self, tree):
1995
"""Change the format marker."""
1996
tree._transport.put_bytes('format',
1997
self.target_format.get_format_string(),
1998
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
