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
import bzrlib.mutabletree
73
from bzrlib.mutabletree import needs_tree_write_lock
74
from bzrlib.osutils import (
84
from bzrlib.trace import mutter, note
85
from bzrlib.transport.local import LocalTransport
86
from bzrlib.tree import InterTree
87
from bzrlib.progress import DummyProgress, ProgressPhase
88
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
89
from bzrlib.rio import RioReader, rio_file, Stanza
90
from bzrlib.symbol_versioning import (deprecated_passed,
95
from bzrlib.tree import Tree
96
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
99
class WorkingTree4(WorkingTree3):
100
"""This is the Format 4 working tree.
102
This differs from WorkingTree3 by:
103
- Having a consolidated internal dirstate, stored in a
104
randomly-accessible sorted file on disk.
105
- Not having a regular inventory attribute. One can be synthesized
106
on demand but this is expensive and should be avoided.
108
This is new in bzr 0.15.
111
def __init__(self, basedir,
116
"""Construct a WorkingTree for basedir.
118
If the branch is not supplied, it is opened automatically.
119
If the branch is supplied, it must be the branch for this basedir.
120
(branch.base is not cross checked, because for remote branches that
121
would be meaningless).
123
self._format = _format
124
self.bzrdir = _bzrdir
125
basedir = safe_unicode(basedir)
126
mutter("opening working tree %r", basedir)
127
self._branch = branch
128
self.basedir = realpath(basedir)
129
# if branch is at our basedir and is a format 6 or less
130
# assume all other formats have their own control files.
131
self._control_files = _control_files
132
self._transport = self._control_files._transport
135
# during a read or write lock these objects are set, and are
136
# None the rest of the time.
137
self._dirstate = None
138
self._inventory = None
140
self._setup_directory_is_tree_reference()
141
self._detect_case_handling()
142
self._rules_searcher = None
143
#--- allow tests to select the dirstate iter_changes implementation
144
self._iter_changes = dirstate._process_entry
146
@needs_tree_write_lock
147
def _add(self, files, ids, kinds):
148
"""See MutableTree._add."""
149
state = self.current_dirstate()
150
for f, file_id, kind in zip(files, ids, kinds):
153
# special case tree root handling.
154
if f == '' and self.path2id(f) == ROOT_ID:
155
state.set_path_id('', generate_ids.gen_file_id(f))
158
file_id = generate_ids.gen_file_id(f)
159
# deliberately add the file with no cached stat or sha1
160
# - on the first access it will be gathered, and we can
161
# always change this once tests are all passing.
162
state.add(f, file_id, kind, None, '')
163
self._make_dirty(reset_inventory=True)
165
def _make_dirty(self, reset_inventory):
166
"""Make the tree state dirty.
168
:param reset_inventory: True if the cached inventory should be removed
169
(presuming there is one).
172
if reset_inventory and self._inventory is not None:
173
self._inventory = None
175
@needs_tree_write_lock
176
def add_reference(self, sub_tree):
177
# use standard implementation, which calls back to self._add
179
# So we don't store the reference_revision in the working dirstate,
180
# it's just recorded at the moment of commit.
181
self._add_reference(sub_tree)
183
def break_lock(self):
184
"""Break a lock if one is present from another instance.
186
Uses the ui factory to ask for confirmation if the lock may be from
189
This will probe the repository for its lock as well.
191
# if the dirstate is locked by an active process, reject the break lock
194
if self._dirstate is None:
198
state = self._current_dirstate()
199
if state._lock_token is not None:
200
# we already have it locked. sheese, cant break our own lock.
201
raise errors.LockActive(self.basedir)
204
# try for a write lock - need permission to get one anyhow
207
except errors.LockContention:
208
# oslocks fail when a process is still live: fail.
209
# TODO: get the locked lockdir info and give to the user to
210
# assist in debugging.
211
raise errors.LockActive(self.basedir)
216
self._dirstate = None
217
self._control_files.break_lock()
218
self.branch.break_lock()
220
def _comparison_data(self, entry, path):
221
kind, executable, stat_value = \
222
WorkingTree3._comparison_data(self, entry, path)
223
# it looks like a plain directory, but it's really a reference -- see
225
if (self._repo_supports_tree_reference and
226
kind == 'directory' and
227
self._directory_is_tree_reference(path)):
228
kind = 'tree-reference'
229
return kind, executable, stat_value
232
def commit(self, message=None, revprops=None, *args, **kwargs):
233
# mark the tree as dirty post commit - commit
234
# can change the current versioned list by doing deletes.
235
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
236
self._make_dirty(reset_inventory=True)
239
def current_dirstate(self):
240
"""Return the current dirstate object.
242
This is not part of the tree interface and only exposed for ease of
245
:raises errors.NotWriteLocked: when not in a lock.
247
self._must_be_locked()
248
return self._current_dirstate()
250
def _current_dirstate(self):
251
"""Internal function that does not check lock status.
253
This is needed for break_lock which also needs the dirstate.
255
if self._dirstate is not None:
256
return self._dirstate
257
local_path = self.bzrdir.get_workingtree_transport(None
258
).local_abspath('dirstate')
259
self._dirstate = dirstate.DirState.on_file(local_path,
260
self._content_filter_stack_provider())
261
return self._dirstate
263
def filter_unversioned_files(self, paths):
264
"""Filter out paths that are versioned.
266
:return: set of paths.
268
# TODO: make a generic multi-bisect routine roughly that should list
269
# the paths, then process one half at a time recursively, and feed the
270
# results of each bisect in further still
271
paths = sorted(paths)
273
state = self.current_dirstate()
274
# TODO we want a paths_to_dirblocks helper I think
276
dirname, basename = os.path.split(path.encode('utf8'))
277
_, _, _, path_is_versioned = state._get_block_entry_index(
278
dirname, basename, 0)
279
if not path_is_versioned:
284
"""Write all cached data to disk."""
285
if self._control_files._lock_mode != 'w':
286
raise errors.NotWriteLocked(self)
287
self.current_dirstate().save()
288
self._inventory = None
291
@needs_tree_write_lock
292
def _gather_kinds(self, files, kinds):
293
"""See MutableTree._gather_kinds."""
294
for pos, f in enumerate(files):
295
if kinds[pos] is None:
296
kinds[pos] = self._kind(f)
298
def _generate_inventory(self):
299
"""Create and set self.inventory from the dirstate object.
301
This is relatively expensive: we have to walk the entire dirstate.
302
Ideally we would not, and can deprecate this function.
304
#: uncomment to trap on inventory requests.
305
# import pdb;pdb.set_trace()
306
state = self.current_dirstate()
307
state._read_dirblocks_if_needed()
308
root_key, current_entry = self._get_entry(path='')
309
current_id = root_key[2]
310
if not (current_entry[0][0] == 'd'): # directory
311
raise AssertionError(current_entry)
312
inv = Inventory(root_id=current_id)
313
# Turn some things into local variables
314
minikind_to_kind = dirstate.DirState._minikind_to_kind
315
factory = entry_factory
316
utf8_decode = cache_utf8._utf8_decode
318
# we could do this straight out of the dirstate; it might be fast
319
# and should be profiled - RBC 20070216
320
parent_ies = {'' : inv.root}
321
for block in state._dirblocks[1:]: # skip the root
324
parent_ie = parent_ies[dirname]
326
# all the paths in this block are not versioned in this tree
328
for key, entry in block[1]:
329
minikind, link_or_sha1, size, executable, stat = entry[0]
330
if minikind in ('a', 'r'): # absent, relocated
331
# a parent tree only entry
334
name_unicode = utf8_decode(name)[0]
336
kind = minikind_to_kind[minikind]
337
inv_entry = factory[kind](file_id, name_unicode,
340
# This is only needed on win32, where this is the only way
341
# we know the executable bit.
342
inv_entry.executable = executable
343
# not strictly needed: working tree
344
#inv_entry.text_size = size
345
#inv_entry.text_sha1 = sha1
346
elif kind == 'directory':
347
# add this entry to the parent map.
348
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
349
elif kind == 'tree-reference':
350
if not self._repo_supports_tree_reference:
351
raise AssertionError(
353
"doesn't support tree references "
354
"required by entry %r"
356
inv_entry.reference_revision = link_or_sha1 or None
357
elif kind != 'symlink':
358
raise AssertionError("unknown kind %r" % kind)
359
# These checks cost us around 40ms on a 55k entry tree
360
if file_id in inv_byid:
361
raise AssertionError('file_id %s already in'
362
' inventory as %s' % (file_id, inv_byid[file_id]))
363
if name_unicode in parent_ie.children:
364
raise AssertionError('name %r already in parent'
366
inv_byid[file_id] = inv_entry
367
parent_ie.children[name_unicode] = inv_entry
368
self._inventory = inv
370
def _get_entry(self, file_id=None, path=None):
371
"""Get the dirstate row for file_id or path.
373
If either file_id or path is supplied, it is used as the key to lookup.
374
If both are supplied, the fastest lookup is used, and an error is
375
raised if they do not both point at the same row.
377
:param file_id: An optional unicode file_id to be looked up.
378
:param path: An optional unicode path to be looked up.
379
:return: The dirstate row tuple for path/file_id, or (None, None)
381
if file_id is None and path is None:
382
raise errors.BzrError('must supply file_id or path')
383
state = self.current_dirstate()
385
path = path.encode('utf8')
386
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
388
def get_file_sha1(self, file_id, path=None, stat_value=None):
389
# check file id is valid unconditionally.
390
entry = self._get_entry(file_id=file_id, path=path)
392
raise errors.NoSuchId(self, file_id)
394
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
396
file_abspath = self.abspath(path)
397
state = self.current_dirstate()
398
if stat_value is None:
400
stat_value = os.lstat(file_abspath)
402
if e.errno == errno.ENOENT:
406
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
407
stat_value=stat_value)
408
if entry[1][0][0] == 'f':
409
if link_or_sha1 is None:
410
file_obj, statvalue = self.get_file_with_stat(file_id, path)
412
sha1 = osutils.sha_file(file_obj)
415
self._observed_sha1(file_id, path, (sha1, statvalue))
421
def _get_inventory(self):
422
"""Get the inventory for the tree. This is only valid within a lock."""
423
if 'evil' in debug.debug_flags:
424
trace.mutter_callsite(2,
425
"accessing .inventory forces a size of tree translation.")
426
if self._inventory is not None:
427
return self._inventory
428
self._must_be_locked()
429
self._generate_inventory()
430
return self._inventory
432
inventory = property(_get_inventory,
433
doc="Inventory of this Tree")
436
def get_parent_ids(self):
437
"""See Tree.get_parent_ids.
439
This implementation requests the ids list from the dirstate file.
441
return self.current_dirstate().get_parent_ids()
443
def get_reference_revision(self, file_id, path=None):
444
# referenced tree's revision is whatever's currently there
445
return self.get_nested_tree(file_id, path).last_revision()
447
def get_nested_tree(self, file_id, path=None):
449
path = self.id2path(file_id)
450
# else: check file_id is at path?
451
return WorkingTree.open(self.abspath(path))
454
def get_root_id(self):
455
"""Return the id of this trees root"""
456
return self._get_entry(path='')[0][2]
458
def has_id(self, file_id):
459
state = self.current_dirstate()
460
row, parents = self._get_entry(file_id=file_id)
463
return osutils.lexists(pathjoin(
464
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
467
def id2path(self, file_id):
468
"Convert a file-id to a path."
469
state = self.current_dirstate()
470
entry = self._get_entry(file_id=file_id)
471
if entry == (None, None):
472
raise errors.NoSuchId(tree=self, file_id=file_id)
473
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
474
return path_utf8.decode('utf8')
476
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
477
entry = self._get_entry(path=path)
478
if entry == (None, None):
479
return False # Missing entries are not executable
480
return entry[1][0][3] # Executable?
482
if not osutils.supports_executable():
483
def is_executable(self, file_id, path=None):
484
"""Test if a file is executable or not.
486
Note: The caller is expected to take a read-lock before calling this.
488
entry = self._get_entry(file_id=file_id, path=path)
489
if entry == (None, None):
491
return entry[1][0][3]
493
_is_executable_from_path_and_stat = \
494
_is_executable_from_path_and_stat_from_basis
496
def is_executable(self, file_id, path=None):
497
"""Test if a file is executable or not.
499
Note: The caller is expected to take a read-lock before calling this.
501
self._must_be_locked()
503
path = self.id2path(file_id)
504
mode = os.lstat(self.abspath(path)).st_mode
505
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
507
def all_file_ids(self):
508
"""See Tree.iter_all_file_ids"""
509
self._must_be_locked()
511
for key, tree_details in self.current_dirstate()._iter_entries():
512
if tree_details[0][0] in ('a', 'r'): # relocated
519
"""Iterate through file_ids for this tree.
521
file_ids are in a WorkingTree if they are in the working inventory
522
and the working file exists.
525
for key, tree_details in self.current_dirstate()._iter_entries():
526
if tree_details[0][0] in ('a', 'r'): # absent, relocated
527
# not relevant to the working tree
529
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
530
if osutils.lexists(path):
531
result.append(key[2])
534
def iter_references(self):
535
if not self._repo_supports_tree_reference:
536
# When the repo doesn't support references, we will have nothing to
539
for key, tree_details in self.current_dirstate()._iter_entries():
540
if tree_details[0][0] in ('a', 'r'): # absent, relocated
541
# not relevant to the working tree
544
# the root is not a reference.
546
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
548
if self._kind(relpath) == 'tree-reference':
549
yield relpath, key[2]
550
except errors.NoSuchFile:
551
# path is missing on disk.
554
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
555
"""See MutableTree._observed_sha1."""
556
state = self.current_dirstate()
557
entry = self._get_entry(file_id=file_id, path=path)
558
state._observed_sha1(entry, sha1, statvalue)
560
def kind(self, file_id):
561
"""Return the kind of a file.
563
This is always the actual kind that's on disk, regardless of what it
566
Note: The caller is expected to take a read-lock before calling this.
568
relpath = self.id2path(file_id)
570
raise AssertionError(
571
"path for id {%s} is None!" % file_id)
572
return self._kind(relpath)
574
def _kind(self, relpath):
575
abspath = self.abspath(relpath)
576
kind = file_kind(abspath)
577
if (self._repo_supports_tree_reference and
578
kind == 'directory' and
579
self._directory_is_tree_reference(relpath)):
580
kind = 'tree-reference'
584
def _last_revision(self):
585
"""See Mutable.last_revision."""
586
parent_ids = self.current_dirstate().get_parent_ids()
590
return _mod_revision.NULL_REVISION
593
"""See Branch.lock_read, and WorkingTree.unlock."""
594
self.branch.lock_read()
596
self._control_files.lock_read()
598
state = self.current_dirstate()
599
if not state._lock_token:
601
# set our support for tree references from the repository in
603
self._repo_supports_tree_reference = getattr(
604
self.branch.repository._format, "supports_tree_reference",
607
self._control_files.unlock()
613
def _lock_self_write(self):
614
"""This should be called after the branch is locked."""
616
self._control_files.lock_write()
618
state = self.current_dirstate()
619
if not state._lock_token:
621
# set our support for tree references from the repository in
623
self._repo_supports_tree_reference = getattr(
624
self.branch.repository._format, "supports_tree_reference",
627
self._control_files.unlock()
633
def lock_tree_write(self):
634
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
635
self.branch.lock_read()
636
self._lock_self_write()
638
def lock_write(self):
639
"""See MutableTree.lock_write, and WorkingTree.unlock."""
640
self.branch.lock_write()
641
self._lock_self_write()
643
@needs_tree_write_lock
644
def move(self, from_paths, to_dir, after=False):
645
"""See WorkingTree.move()."""
649
state = self.current_dirstate()
650
if isinstance(from_paths, basestring):
652
to_dir_utf8 = to_dir.encode('utf8')
653
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
654
id_index = state._get_id_index()
655
# check destination directory
656
# get the details for it
657
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
658
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
659
if not entry_present:
660
raise errors.BzrMoveFailedError('', to_dir,
661
errors.NotVersionedError(to_dir))
662
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
663
# get a handle on the block itself.
664
to_block_index = state._ensure_block(
665
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
666
to_block = state._dirblocks[to_block_index]
667
to_abs = self.abspath(to_dir)
668
if not isdir(to_abs):
669
raise errors.BzrMoveFailedError('',to_dir,
670
errors.NotADirectory(to_abs))
672
if to_entry[1][0][0] != 'd':
673
raise errors.BzrMoveFailedError('',to_dir,
674
errors.NotADirectory(to_abs))
676
if self._inventory is not None:
677
update_inventory = True
679
to_dir_id = to_entry[0][2]
680
to_dir_ie = inv[to_dir_id]
682
update_inventory = False
685
def move_one(old_entry, from_path_utf8, minikind, executable,
686
fingerprint, packed_stat, size,
687
to_block, to_key, to_path_utf8):
688
state._make_absent(old_entry)
689
from_key = old_entry[0]
691
lambda:state.update_minimal(from_key,
693
executable=executable,
694
fingerprint=fingerprint,
695
packed_stat=packed_stat,
697
path_utf8=from_path_utf8))
698
state.update_minimal(to_key,
700
executable=executable,
701
fingerprint=fingerprint,
702
packed_stat=packed_stat,
704
path_utf8=to_path_utf8)
705
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
706
new_entry = to_block[1][added_entry_index]
707
rollbacks.append(lambda:state._make_absent(new_entry))
709
for from_rel in from_paths:
710
# from_rel is 'pathinroot/foo/bar'
711
from_rel_utf8 = from_rel.encode('utf8')
712
from_dirname, from_tail = osutils.split(from_rel)
713
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
714
from_entry = self._get_entry(path=from_rel)
715
if from_entry == (None, None):
716
raise errors.BzrMoveFailedError(from_rel,to_dir,
717
errors.NotVersionedError(path=str(from_rel)))
719
from_id = from_entry[0][2]
720
to_rel = pathjoin(to_dir, from_tail)
721
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
722
item_to_entry = self._get_entry(path=to_rel)
723
if item_to_entry != (None, None):
724
raise errors.BzrMoveFailedError(from_rel, to_rel,
725
"Target is already versioned.")
727
if from_rel == to_rel:
728
raise errors.BzrMoveFailedError(from_rel, to_rel,
729
"Source and target are identical.")
731
from_missing = not self.has_filename(from_rel)
732
to_missing = not self.has_filename(to_rel)
739
raise errors.BzrMoveFailedError(from_rel, to_rel,
740
errors.NoSuchFile(path=to_rel,
741
extra="New file has not been created yet"))
743
# neither path exists
744
raise errors.BzrRenameFailedError(from_rel, to_rel,
745
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
747
if from_missing: # implicitly just update our path mapping
750
raise errors.RenameFailedFilesExist(from_rel, to_rel)
753
def rollback_rename():
754
"""A single rename has failed, roll it back."""
755
# roll back everything, even if we encounter trouble doing one
758
# TODO: at least log the other exceptions rather than just
759
# losing them mbp 20070307
761
for rollback in reversed(rollbacks):
765
exc_info = sys.exc_info()
767
raise exc_info[0], exc_info[1], exc_info[2]
769
# perform the disk move first - its the most likely failure point.
771
from_rel_abs = self.abspath(from_rel)
772
to_rel_abs = self.abspath(to_rel)
774
osutils.rename(from_rel_abs, to_rel_abs)
776
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
777
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
779
# perform the rename in the inventory next if needed: its easy
783
from_entry = inv[from_id]
784
current_parent = from_entry.parent_id
785
inv.rename(from_id, to_dir_id, from_tail)
787
lambda: inv.rename(from_id, current_parent, from_tail))
788
# finally do the rename in the dirstate, which is a little
789
# tricky to rollback, but least likely to need it.
790
old_block_index, old_entry_index, dir_present, file_present = \
791
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
792
old_block = state._dirblocks[old_block_index][1]
793
old_entry = old_block[old_entry_index]
794
from_key, old_entry_details = old_entry
795
cur_details = old_entry_details[0]
797
to_key = ((to_block[0],) + from_key[1:3])
798
minikind = cur_details[0]
799
move_one(old_entry, from_path_utf8=from_rel_utf8,
801
executable=cur_details[3],
802
fingerprint=cur_details[1],
803
packed_stat=cur_details[4],
807
to_path_utf8=to_rel_utf8)
810
def update_dirblock(from_dir, to_key, to_dir_utf8):
811
"""Recursively update all entries in this dirblock."""
813
raise AssertionError("renaming root not supported")
814
from_key = (from_dir, '')
815
from_block_idx, present = \
816
state._find_block_index_from_key(from_key)
818
# This is the old record, if it isn't present, then
819
# there is theoretically nothing to update.
820
# (Unless it isn't present because of lazy loading,
821
# but we don't do that yet)
823
from_block = state._dirblocks[from_block_idx]
824
to_block_index, to_entry_index, _, _ = \
825
state._get_block_entry_index(to_key[0], to_key[1], 0)
826
to_block_index = state._ensure_block(
827
to_block_index, to_entry_index, to_dir_utf8)
828
to_block = state._dirblocks[to_block_index]
830
# Grab a copy since move_one may update the list.
831
for entry in from_block[1][:]:
832
if not (entry[0][0] == from_dir):
833
raise AssertionError()
834
cur_details = entry[1][0]
835
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
836
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
837
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
838
minikind = cur_details[0]
840
# Deleted children of a renamed directory
841
# Do not need to be updated.
842
# Children that have been renamed out of this
843
# directory should also not be updated
845
move_one(entry, from_path_utf8=from_path_utf8,
847
executable=cur_details[3],
848
fingerprint=cur_details[1],
849
packed_stat=cur_details[4],
853
to_path_utf8=to_path_utf8)
855
# We need to move all the children of this
857
update_dirblock(from_path_utf8, to_key,
859
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
863
result.append((from_rel, to_rel))
864
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
865
self._make_dirty(reset_inventory=False)
869
def _must_be_locked(self):
870
if not self._control_files._lock_count:
871
raise errors.ObjectNotLocked(self)
874
"""Initialize the state in this tree to be a new tree."""
878
def path2id(self, path):
879
"""Return the id for path in this tree."""
880
path = path.strip('/')
881
entry = self._get_entry(path=path)
882
if entry == (None, None):
886
def paths2ids(self, paths, trees=[], require_versioned=True):
887
"""See Tree.paths2ids().
889
This specialisation fast-paths the case where all the trees are in the
894
parents = self.get_parent_ids()
896
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
898
return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
899
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
900
# -- make all paths utf8 --
903
paths_utf8.add(path.encode('utf8'))
905
# -- paths is now a utf8 path set --
906
# -- get the state object and prepare it.
907
state = self.current_dirstate()
908
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
909
and '' not in paths):
910
paths2ids = self._paths2ids_using_bisect
912
paths2ids = self._paths2ids_in_memory
913
return paths2ids(paths, search_indexes,
914
require_versioned=require_versioned)
916
def _paths2ids_in_memory(self, paths, search_indexes,
917
require_versioned=True):
918
state = self.current_dirstate()
919
state._read_dirblocks_if_needed()
920
def _entries_for_path(path):
921
"""Return a list with all the entries that match path for all ids.
923
dirname, basename = os.path.split(path)
924
key = (dirname, basename, '')
925
block_index, present = state._find_block_index_from_key(key)
927
# the block which should contain path is absent.
930
block = state._dirblocks[block_index][1]
931
entry_index, _ = state._find_entry_index(key, block)
932
# we may need to look at multiple entries at this path: walk while the paths match.
933
while (entry_index < len(block) and
934
block[entry_index][0][0:2] == key[0:2]):
935
result.append(block[entry_index])
938
if require_versioned:
939
# -- check all supplied paths are versioned in a search tree. --
942
path_entries = _entries_for_path(path)
944
# this specified path is not present at all: error
945
all_versioned = False
947
found_versioned = False
948
# for each id at this path
949
for entry in path_entries:
951
for index in search_indexes:
952
if entry[1][index][0] != 'a': # absent
953
found_versioned = True
954
# all good: found a versioned cell
956
if not found_versioned:
957
# none of the indexes was not 'absent' at all ids for this
959
all_versioned = False
961
if not all_versioned:
962
raise errors.PathsNotVersionedError(paths)
963
# -- remove redundancy in supplied paths to prevent over-scanning --
964
search_paths = osutils.minimum_path_selection(paths)
966
# for all search_indexs in each path at or under each element of
967
# search_paths, if the detail is relocated: add the id, and add the
968
# relocated path as one to search if its not searched already. If the
969
# detail is not relocated, add the id.
970
searched_paths = set()
972
def _process_entry(entry):
973
"""Look at search_indexes within entry.
975
If a specific tree's details are relocated, add the relocation
976
target to search_paths if not searched already. If it is absent, do
977
nothing. Otherwise add the id to found_ids.
979
for index in search_indexes:
980
if entry[1][index][0] == 'r': # relocated
981
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
982
search_paths.add(entry[1][index][1])
983
elif entry[1][index][0] != 'a': # absent
984
found_ids.add(entry[0][2])
986
current_root = search_paths.pop()
987
searched_paths.add(current_root)
988
# process the entries for this containing directory: the rest will be
989
# found by their parents recursively.
990
root_entries = _entries_for_path(current_root)
992
# this specified path is not present at all, skip it.
994
for entry in root_entries:
995
_process_entry(entry)
996
initial_key = (current_root, '', '')
997
block_index, _ = state._find_block_index_from_key(initial_key)
998
while (block_index < len(state._dirblocks) and
999
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
1000
for entry in state._dirblocks[block_index][1]:
1001
_process_entry(entry)
1005
def _paths2ids_using_bisect(self, paths, search_indexes,
1006
require_versioned=True):
1007
state = self.current_dirstate()
1010
split_paths = sorted(osutils.split(p) for p in paths)
1011
found = state._bisect_recursive(split_paths)
1013
if require_versioned:
1014
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1015
for dir_name in split_paths:
1016
if dir_name not in found_dir_names:
1017
raise errors.PathsNotVersionedError(paths)
1019
for dir_name_id, trees_info in found.iteritems():
1020
for index in search_indexes:
1021
if trees_info[index][0] not in ('r', 'a'):
1022
found_ids.add(dir_name_id[2])
1025
def read_working_inventory(self):
1026
"""Read the working inventory.
1028
This is a meaningless operation for dirstate, but we obey it anyhow.
1030
return self.inventory
1033
def revision_tree(self, revision_id):
1034
"""See Tree.revision_tree.
1036
WorkingTree4 supplies revision_trees for any basis tree.
1038
dirstate = self.current_dirstate()
1039
parent_ids = dirstate.get_parent_ids()
1040
if revision_id not in parent_ids:
1041
raise errors.NoSuchRevisionInTree(self, revision_id)
1042
if revision_id in dirstate.get_ghosts():
1043
raise errors.NoSuchRevisionInTree(self, revision_id)
1044
return DirStateRevisionTree(dirstate, revision_id,
1045
self.branch.repository)
1047
@needs_tree_write_lock
1048
def set_last_revision(self, new_revision):
1049
"""Change the last revision in the working tree."""
1050
parents = self.get_parent_ids()
1051
if new_revision in (NULL_REVISION, None):
1052
if len(parents) >= 2:
1053
raise AssertionError(
1054
"setting the last parent to none with a pending merge is "
1056
self.set_parent_ids([])
1058
self.set_parent_ids([new_revision] + parents[1:],
1059
allow_leftmost_as_ghost=True)
1061
@needs_tree_write_lock
1062
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1063
"""Set the parent ids to revision_ids.
1065
See also set_parent_trees. This api will try to retrieve the tree data
1066
for each element of revision_ids from the trees repository. If you have
1067
tree data already available, it is more efficient to use
1068
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1069
an easier API to use.
1071
:param revision_ids: The revision_ids to set as the parent ids of this
1072
working tree. Any of these may be ghosts.
1075
for revision_id in revision_ids:
1077
revtree = self.branch.repository.revision_tree(revision_id)
1078
# TODO: jam 20070213 KnitVersionedFile raises
1079
# RevisionNotPresent rather than NoSuchRevision if a
1080
# given revision_id is not present. Should Repository be
1081
# catching it and re-raising NoSuchRevision?
1082
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1084
trees.append((revision_id, revtree))
1085
self.set_parent_trees(trees,
1086
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1088
@needs_tree_write_lock
1089
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1090
"""Set the parents of the working tree.
1092
:param parents_list: A list of (revision_id, tree) tuples.
1093
If tree is None, then that element is treated as an unreachable
1094
parent tree - i.e. a ghost.
1096
dirstate = self.current_dirstate()
1097
if len(parents_list) > 0:
1098
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1099
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1103
parent_ids = [rev_id for rev_id, tree in parents_list]
1104
graph = self.branch.repository.get_graph()
1105
heads = graph.heads(parent_ids)
1106
accepted_revisions = set()
1108
# convert absent trees to the null tree, which we convert back to
1109
# missing on access.
1110
for rev_id, tree in parents_list:
1111
if len(accepted_revisions) > 0:
1112
# we always accept the first tree
1113
if rev_id in accepted_revisions or rev_id not in heads:
1114
# We have already included either this tree, or its
1115
# descendent, so we skip it.
1117
_mod_revision.check_not_reserved_id(rev_id)
1118
if tree is not None:
1119
real_trees.append((rev_id, tree))
1121
real_trees.append((rev_id,
1122
self.branch.repository.revision_tree(
1123
_mod_revision.NULL_REVISION)))
1124
ghosts.append(rev_id)
1125
accepted_revisions.add(rev_id)
1126
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1127
self._make_dirty(reset_inventory=False)
1129
def _set_root_id(self, file_id):
1130
"""See WorkingTree.set_root_id."""
1131
state = self.current_dirstate()
1132
state.set_path_id('', file_id)
1133
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1134
self._make_dirty(reset_inventory=True)
1136
def _sha_from_stat(self, path, stat_result):
1137
"""Get a sha digest from the tree's stat cache.
1139
The default implementation assumes no stat cache is present.
1141
:param path: The path.
1142
:param stat_result: The stat result being looked up.
1144
return self.current_dirstate().sha1_from_stat(path, stat_result)
1147
def supports_tree_reference(self):
1148
return self._repo_supports_tree_reference
1151
"""Unlock in format 4 trees needs to write the entire dirstate."""
1152
# do non-implementation specific cleanup
1155
if self._control_files._lock_count == 1:
1156
# eventually we should do signature checking during read locks for
1158
if self._control_files._lock_mode == 'w':
1161
if self._dirstate is not None:
1162
# This is a no-op if there are no modifications.
1163
self._dirstate.save()
1164
self._dirstate.unlock()
1165
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1166
# point. Instead, it could check if the header has been
1167
# modified when it is locked, and if not, it can hang on to
1168
# the data it has in memory.
1169
self._dirstate = None
1170
self._inventory = None
1171
# reverse order of locking.
1173
return self._control_files.unlock()
1175
self.branch.unlock()
1177
@needs_tree_write_lock
1178
def unversion(self, file_ids):
1179
"""Remove the file ids in file_ids from the current versioned set.
1181
When a file_id is unversioned, all of its children are automatically
1184
:param file_ids: The file ids to stop versioning.
1185
:raises: NoSuchId if any fileid is not currently versioned.
1189
state = self.current_dirstate()
1190
state._read_dirblocks_if_needed()
1191
ids_to_unversion = set(file_ids)
1192
paths_to_unversion = set()
1194
# check if the root is to be unversioned, if so, assert for now.
1195
# walk the state marking unversioned things as absent.
1196
# if there are any un-unversioned ids at the end, raise
1197
for key, details in state._dirblocks[0][1]:
1198
if (details[0][0] not in ('a', 'r') and # absent or relocated
1199
key[2] in ids_to_unversion):
1200
# I haven't written the code to unversion / yet - it should be
1202
raise errors.BzrError('Unversioning the / is not currently supported')
1204
while block_index < len(state._dirblocks):
1205
# process one directory at a time.
1206
block = state._dirblocks[block_index]
1207
# first check: is the path one to remove - it or its children
1208
delete_block = False
1209
for path in paths_to_unversion:
1210
if (block[0].startswith(path) and
1211
(len(block[0]) == len(path) or
1212
block[0][len(path)] == '/')):
1213
# this entire block should be deleted - its the block for a
1214
# path to unversion; or the child of one
1217
# TODO: trim paths_to_unversion as we pass by paths
1219
# this block is to be deleted: process it.
1220
# TODO: we can special case the no-parents case and
1221
# just forget the whole block.
1223
while entry_index < len(block[1]):
1224
# Mark this file id as having been removed
1225
entry = block[1][entry_index]
1226
ids_to_unversion.discard(entry[0][2])
1227
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1229
or not state._make_absent(entry)):
1231
# go to the next block. (At the moment we dont delete empty
1236
while entry_index < len(block[1]):
1237
entry = block[1][entry_index]
1238
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1239
# ^ some parent row.
1240
entry[0][2] not in ids_to_unversion):
1241
# ^ not an id to unversion
1244
if entry[1][0][0] == 'd':
1245
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1246
if not state._make_absent(entry):
1248
# we have unversioned this id
1249
ids_to_unversion.remove(entry[0][2])
1251
if ids_to_unversion:
1252
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1253
self._make_dirty(reset_inventory=False)
1254
# have to change the legacy inventory too.
1255
if self._inventory is not None:
1256
for file_id in file_ids:
1257
self._inventory.remove_recursive_id(file_id)
1259
@needs_tree_write_lock
1260
def rename_one(self, from_rel, to_rel, after=False):
1261
"""See WorkingTree.rename_one"""
1263
WorkingTree.rename_one(self, from_rel, to_rel, after)
1265
@needs_tree_write_lock
1266
def apply_inventory_delta(self, changes):
1267
"""See MutableTree.apply_inventory_delta"""
1268
state = self.current_dirstate()
1269
state.update_by_delta(changes)
1270
self._make_dirty(reset_inventory=True)
1272
def update_basis_by_delta(self, new_revid, delta):
1273
"""See MutableTree.update_basis_by_delta."""
1274
if self.last_revision() == new_revid:
1275
raise AssertionError()
1276
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1279
def _validate(self):
1280
self._dirstate._validate()
1282
@needs_tree_write_lock
1283
def _write_inventory(self, inv):
1284
"""Write inventory as the current inventory."""
1286
raise AssertionError("attempting to write an inventory when the "
1287
"dirstate is dirty will lose pending changes")
1288
self.current_dirstate().set_state_from_inventory(inv)
1289
self._make_dirty(reset_inventory=False)
1290
if self._inventory is not None:
1291
self._inventory = inv
1295
class WorkingTreeFormat4(WorkingTreeFormat3):
1296
"""The first consolidated dirstate working tree format.
1299
- exists within a metadir controlling .bzr
1300
- includes an explicit version marker for the workingtree control
1301
files, separate from the BzrDir format
1302
- modifies the hash cache format
1303
- is new in bzr 0.15
1304
- uses a LockDir to guard access to it.
1307
upgrade_recommended = False
1309
_tree_class = WorkingTree4
1311
def get_format_string(self):
1312
"""See WorkingTreeFormat.get_format_string()."""
1313
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1315
def get_format_description(self):
1316
"""See WorkingTreeFormat.get_format_description()."""
1317
return "Working tree format 4"
1319
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1320
accelerator_tree=None, hardlink=False):
1321
"""See WorkingTreeFormat.initialize().
1323
:param revision_id: allows creating a working tree at a different
1324
revision than the branch is at.
1325
:param accelerator_tree: A tree which can be used for retrieving file
1326
contents more quickly than the revision tree, i.e. a workingtree.
1327
The revision tree will be used for cases where accelerator_tree's
1328
content is different.
1329
:param hardlink: If true, hard-link files from accelerator_tree,
1332
These trees get an initial random root id, if their repository supports
1333
rich root data, TREE_ROOT otherwise.
1335
if not isinstance(a_bzrdir.transport, LocalTransport):
1336
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1337
transport = a_bzrdir.get_workingtree_transport(self)
1338
control_files = self._open_control_files(a_bzrdir)
1339
control_files.create_lock()
1340
control_files.lock_write()
1341
transport.put_bytes('format', self.get_format_string(),
1342
mode=a_bzrdir._get_file_mode())
1343
if from_branch is not None:
1344
branch = from_branch
1346
branch = a_bzrdir.open_branch()
1347
if revision_id is None:
1348
revision_id = branch.last_revision()
1349
local_path = transport.local_abspath('dirstate')
1350
# write out new dirstate (must exist when we create the tree)
1351
state = dirstate.DirState.initialize(local_path)
1354
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1358
_control_files=control_files)
1360
wt.lock_tree_write()
1362
self._init_custom_control_files(wt)
1363
if revision_id in (None, NULL_REVISION):
1364
if branch.repository.supports_rich_root():
1365
wt._set_root_id(generate_ids.gen_root_id())
1367
wt._set_root_id(ROOT_ID)
1370
# frequently, we will get here due to branching. The accelerator
1371
# tree will be the tree from the branch, so the desired basis
1372
# tree will often be a parent of the accelerator tree.
1373
if accelerator_tree is not None:
1375
basis = accelerator_tree.revision_tree(revision_id)
1376
except errors.NoSuchRevision:
1379
basis = branch.repository.revision_tree(revision_id)
1380
if revision_id == NULL_REVISION:
1383
parents_list = [(revision_id, basis)]
1386
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1388
# if the basis has a root id we have to use that; otherwise we
1389
# use a new random one
1390
basis_root_id = basis.get_root_id()
1391
if basis_root_id is not None:
1392
wt._set_root_id(basis_root_id)
1394
# delta_from_tree is safe even for DirStateRevisionTrees,
1395
# because wt4.apply_inventory_delta does not mutate the input
1396
# inventory entries.
1397
transform.build_tree(basis, wt, accelerator_tree,
1398
hardlink=hardlink, delta_from_tree=True)
1402
control_files.unlock()
1406
def _init_custom_control_files(self, wt):
1407
"""Subclasses with custom control files should override this method.
1409
The working tree and control files are locked for writing when this
1412
:param wt: the WorkingTree object
1415
def _open(self, a_bzrdir, control_files):
1416
"""Open the tree itself.
1418
:param a_bzrdir: the dir for the tree.
1419
:param control_files: the control files for the tree.
1421
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1422
branch=a_bzrdir.open_branch(),
1425
_control_files=control_files)
1427
def __get_matchingbzrdir(self):
1428
# please test against something that will let us do tree references
1429
return bzrdir.format_registry.make_bzrdir(
1430
'dirstate-with-subtree')
1432
_matchingbzrdir = property(__get_matchingbzrdir)
1435
class DirStateRevisionTree(Tree):
1436
"""A revision tree pulling the inventory from a dirstate."""
1438
def __init__(self, dirstate, revision_id, repository):
1439
self._dirstate = dirstate
1440
self._revision_id = revision_id
1441
self._repository = repository
1442
self._inventory = None
1444
self._dirstate_locked = False
1445
self._repo_supports_tree_reference = getattr(
1446
repository._format, "supports_tree_reference",
1450
return "<%s of %s in %s>" % \
1451
(self.__class__.__name__, self._revision_id, self._dirstate)
1453
def annotate_iter(self, file_id,
1454
default_revision=_mod_revision.CURRENT_REVISION):
1455
"""See Tree.annotate_iter"""
1456
text_key = (file_id, self.inventory[file_id].revision)
1457
annotations = self._repository.texts.annotate(text_key)
1458
return [(key[-1], line) for (key, line) in annotations]
1460
def _get_ancestors(self, default_revision):
1461
return set(self._repository.get_ancestry(self._revision_id,
1463
def _comparison_data(self, entry, path):
1464
"""See Tree._comparison_data."""
1466
return None, False, None
1467
# trust the entry as RevisionTree does, but this may not be
1468
# sensible: the entry might not have come from us?
1469
return entry.kind, entry.executable, None
1471
def _file_size(self, entry, stat_value):
1472
return entry.text_size
1474
def filter_unversioned_files(self, paths):
1475
"""Filter out paths that are not versioned.
1477
:return: set of paths.
1479
pred = self.has_filename
1480
return set((p for p in paths if not pred(p)))
1482
def get_root_id(self):
1483
return self.path2id('')
1485
def id2path(self, file_id):
1486
"Convert a file-id to a path."
1487
entry = self._get_entry(file_id=file_id)
1488
if entry == (None, None):
1489
raise errors.NoSuchId(tree=self, file_id=file_id)
1490
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1491
return path_utf8.decode('utf8')
1493
def iter_references(self):
1494
if not self._repo_supports_tree_reference:
1495
# When the repo doesn't support references, we will have nothing to
1498
# Otherwise, fall back to the default implementation
1499
return super(DirStateRevisionTree, self).iter_references()
1501
def _get_parent_index(self):
1502
"""Return the index in the dirstate referenced by this tree."""
1503
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1505
def _get_entry(self, file_id=None, path=None):
1506
"""Get the dirstate row for file_id or path.
1508
If either file_id or path is supplied, it is used as the key to lookup.
1509
If both are supplied, the fastest lookup is used, and an error is
1510
raised if they do not both point at the same row.
1512
:param file_id: An optional unicode file_id to be looked up.
1513
:param path: An optional unicode path to be looked up.
1514
:return: The dirstate row tuple for path/file_id, or (None, None)
1516
if file_id is None and path is None:
1517
raise errors.BzrError('must supply file_id or path')
1518
if path is not None:
1519
path = path.encode('utf8')
1520
parent_index = self._get_parent_index()
1521
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1523
def _generate_inventory(self):
1524
"""Create and set self.inventory from the dirstate object.
1526
(So this is only called the first time the inventory is requested for
1527
this tree; it then remains in memory until it's out of date.)
1529
This is relatively expensive: we have to walk the entire dirstate.
1531
if not self._locked:
1532
raise AssertionError(
1533
'cannot generate inventory of an unlocked '
1534
'dirstate revision tree')
1535
# separate call for profiling - makes it clear where the costs are.
1536
self._dirstate._read_dirblocks_if_needed()
1537
if self._revision_id not in self._dirstate.get_parent_ids():
1538
raise AssertionError(
1539
'parent %s has disappeared from %s' % (
1540
self._revision_id, self._dirstate.get_parent_ids()))
1541
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1542
# This is identical now to the WorkingTree _generate_inventory except
1543
# for the tree index use.
1544
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1545
current_id = root_key[2]
1546
if current_entry[parent_index][0] != 'd':
1547
raise AssertionError()
1548
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1549
inv.root.revision = current_entry[parent_index][4]
1550
# Turn some things into local variables
1551
minikind_to_kind = dirstate.DirState._minikind_to_kind
1552
factory = entry_factory
1553
utf8_decode = cache_utf8._utf8_decode
1554
inv_byid = inv._byid
1555
# we could do this straight out of the dirstate; it might be fast
1556
# and should be profiled - RBC 20070216
1557
parent_ies = {'' : inv.root}
1558
for block in self._dirstate._dirblocks[1:]: #skip root
1561
parent_ie = parent_ies[dirname]
1563
# all the paths in this block are not versioned in this tree
1565
for key, entry in block[1]:
1566
minikind, fingerprint, size, executable, revid = entry[parent_index]
1567
if minikind in ('a', 'r'): # absent, relocated
1571
name_unicode = utf8_decode(name)[0]
1573
kind = minikind_to_kind[minikind]
1574
inv_entry = factory[kind](file_id, name_unicode,
1576
inv_entry.revision = revid
1578
inv_entry.executable = executable
1579
inv_entry.text_size = size
1580
inv_entry.text_sha1 = fingerprint
1581
elif kind == 'directory':
1582
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1583
elif kind == 'symlink':
1584
inv_entry.executable = False
1585
inv_entry.text_size = None
1586
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1587
elif kind == 'tree-reference':
1588
inv_entry.reference_revision = fingerprint or None
1590
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1592
# These checks cost us around 40ms on a 55k entry tree
1593
if file_id in inv_byid:
1594
raise AssertionError('file_id %s already in'
1595
' inventory as %s' % (file_id, inv_byid[file_id]))
1596
if name_unicode in parent_ie.children:
1597
raise AssertionError('name %r already in parent'
1599
inv_byid[file_id] = inv_entry
1600
parent_ie.children[name_unicode] = inv_entry
1601
self._inventory = inv
1603
def get_file_mtime(self, file_id, path=None):
1604
"""Return the modification time for this record.
1606
We return the timestamp of the last-changed revision.
1608
# Make sure the file exists
1609
entry = self._get_entry(file_id, path=path)
1610
if entry == (None, None): # do we raise?
1612
parent_index = self._get_parent_index()
1613
last_changed_revision = entry[1][parent_index][4]
1614
return self._repository.get_revision(last_changed_revision).timestamp
1616
def get_file_sha1(self, file_id, path=None, stat_value=None):
1617
entry = self._get_entry(file_id=file_id, path=path)
1618
parent_index = self._get_parent_index()
1619
parent_details = entry[1][parent_index]
1620
if parent_details[0] == 'f':
1621
return parent_details[1]
1624
def get_file(self, file_id, path=None):
1625
return StringIO(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, path=None):
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
1820
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1821
result = klass.make_source_parent_tree(source, target)
1822
result[1]._iter_changes = dirstate.ProcessEntryPython
1826
def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
1827
from bzrlib.tests.test__dirstate_helpers import \
1828
CompiledDirstateHelpersFeature
1829
if not CompiledDirstateHelpersFeature.available():
1830
from bzrlib.tests import UnavailableFeature
1831
raise UnavailableFeature(CompiledDirstateHelpersFeature)
1832
from bzrlib._dirstate_helpers_c import ProcessEntryC
1833
result = klass.make_source_parent_tree(source, target)
1834
result[1]._iter_changes = ProcessEntryC
1837
_matching_from_tree_format = WorkingTreeFormat4()
1838
_matching_to_tree_format = WorkingTreeFormat4()
1841
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1842
# This method shouldn't be called, because we have python and C
1843
# specific flavours.
1844
raise NotImplementedError
1846
def iter_changes(self, include_unchanged=False,
1847
specific_files=None, pb=None, extra_trees=[],
1848
require_versioned=True, want_unversioned=False):
1849
"""Return the changes from source to target.
1851
:return: An iterator that yields tuples. See InterTree.iter_changes
1853
:param specific_files: An optional list of file paths to restrict the
1854
comparison to. When mapping filenames to ids, all matches in all
1855
trees (including optional extra_trees) are used, and all children of
1856
matched directories are included.
1857
:param include_unchanged: An optional boolean requesting the inclusion of
1858
unchanged entries in the result.
1859
:param extra_trees: An optional list of additional trees to use when
1860
mapping the contents of specific_files (paths) to file_ids.
1861
:param require_versioned: If True, all files in specific_files must be
1862
versioned in one of source, target, extra_trees or
1863
PathsNotVersionedError is raised.
1864
:param want_unversioned: Should unversioned files be returned in the
1865
output. An unversioned file is defined as one with (False, False)
1866
for the versioned pair.
1868
# NB: show_status depends on being able to pass in non-versioned files
1869
# and report them as unknown
1870
# TODO: handle extra trees in the dirstate.
1871
if (extra_trees or specific_files == []):
1872
# we can't fast-path these cases (yet)
1873
return super(InterDirStateTree, self).iter_changes(
1874
include_unchanged, specific_files, pb, extra_trees,
1875
require_versioned, want_unversioned=want_unversioned)
1876
parent_ids = self.target.get_parent_ids()
1877
if not (self.source._revision_id in parent_ids
1878
or self.source._revision_id == NULL_REVISION):
1879
raise AssertionError(
1880
"revision {%s} is not stored in {%s}, but %s "
1881
"can only be used for trees stored in the dirstate"
1882
% (self.source._revision_id, self.target, self.iter_changes))
1884
if self.source._revision_id == NULL_REVISION:
1886
indices = (target_index,)
1888
if not (self.source._revision_id in parent_ids):
1889
raise AssertionError(
1890
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1891
self.source._revision_id, parent_ids))
1892
source_index = 1 + parent_ids.index(self.source._revision_id)
1893
indices = (source_index, target_index)
1894
# -- make all specific_files utf8 --
1896
specific_files_utf8 = set()
1897
for path in specific_files:
1898
# Note, if there are many specific files, using cache_utf8
1899
# would be good here.
1900
specific_files_utf8.add(path.encode('utf8'))
1901
specific_files = specific_files_utf8
1903
specific_files = set([''])
1904
# -- specific_files is now a utf8 path set --
1905
search_specific_files = set()
1906
# -- get the state object and prepare it.
1907
state = self.target.current_dirstate()
1908
state._read_dirblocks_if_needed()
1909
if require_versioned:
1910
# -- check all supplied paths are versioned in a search tree. --
1911
all_versioned = True
1912
for path in specific_files:
1913
path_entries = state._entries_for_path(path)
1914
if not path_entries:
1915
# this specified path is not present at all: error
1916
all_versioned = False
1918
found_versioned = False
1919
# for each id at this path
1920
for entry in path_entries:
1922
for index in indices:
1923
if entry[1][index][0] != 'a': # absent
1924
found_versioned = True
1925
# all good: found a versioned cell
1927
if not found_versioned:
1928
# none of the indexes was not 'absent' at all ids for this
1930
all_versioned = False
1932
if not all_versioned:
1933
raise errors.PathsNotVersionedError(specific_files)
1934
# -- remove redundancy in supplied specific_files to prevent over-scanning --
1935
for path in specific_files:
1936
other_specific_files = specific_files.difference(set([path]))
1937
if not osutils.is_inside_any(other_specific_files, path):
1938
# this is a top level path, we must check it.
1939
search_specific_files.add(path)
1941
use_filesystem_for_exec = (sys.platform != 'win32')
1942
iter_changes = self.target._iter_changes(include_unchanged,
1943
use_filesystem_for_exec, search_specific_files, state,
1944
source_index, target_index, want_unversioned, self.target)
1945
return iter_changes.iter_changes()
1948
def is_compatible(source, target):
1949
# the target must be a dirstate working tree
1950
if not isinstance(target, WorkingTree4):
1952
# the source must be a revtreee or dirstate rev tree.
1953
if not isinstance(source,
1954
(revisiontree.RevisionTree, DirStateRevisionTree)):
1956
# the source revid must be in the target dirstate
1957
if not (source._revision_id == NULL_REVISION or
1958
source._revision_id in target.get_parent_ids()):
1959
# TODO: what about ghosts? it may well need to
1960
# check for them explicitly.
1964
InterTree.register_optimiser(InterDirStateTree)
1967
class Converter3to4(object):
1968
"""Perform an in-place upgrade of format 3 to format 4 trees."""
1971
self.target_format = WorkingTreeFormat4()
1973
def convert(self, tree):
1974
# lock the control files not the tree, so that we dont get tree
1975
# on-unlock behaviours, and so that noone else diddles with the
1976
# tree during upgrade.
1977
tree._control_files.lock_write()
1979
tree.read_working_inventory()
1980
self.create_dirstate_data(tree)
1981
self.update_format(tree)
1982
self.remove_xml_files(tree)
1984
tree._control_files.unlock()
1986
def create_dirstate_data(self, tree):
1987
"""Create the dirstate based data for tree."""
1988
local_path = tree.bzrdir.get_workingtree_transport(None
1989
).local_abspath('dirstate')
1990
state = dirstate.DirState.from_tree(tree, local_path)
1994
def remove_xml_files(self, tree):
1995
"""Remove the oldformat 3 data."""
1996
transport = tree.bzrdir.get_workingtree_transport(None)
1997
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
1998
'pending-merges', 'stat-cache']:
2000
transport.delete(path)
2001
except errors.NoSuchFile:
2002
# some files are optional - just deal.
2005
def update_format(self, tree):
2006
"""Change the format marker."""
2007
tree._transport.put_bytes('format',
2008
self.target_format.get_format_string(),
2009
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
