1
# Copyright (C) 2007-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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(), """
43
revision as _mod_revision,
53
from bzrlib.decorators import needs_read_lock, needs_write_lock
54
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
55
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
56
from bzrlib.lock import LogicalLockResult
57
from bzrlib.mutabletree import needs_tree_write_lock
58
from bzrlib.osutils import (
65
from bzrlib.trace import mutter
66
from bzrlib.transport.local import LocalTransport
67
from bzrlib.tree import InterTree
68
from bzrlib.tree import Tree
69
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
72
class DirStateWorkingTree(WorkingTree3):
73
def __init__(self, basedir,
78
"""Construct a WorkingTree for basedir.
80
If the branch is not supplied, it is opened automatically.
81
If the branch is supplied, it must be the branch for this basedir.
82
(branch.base is not cross checked, because for remote branches that
83
would be meaningless).
85
self._format = _format
87
basedir = safe_unicode(basedir)
88
mutter("opening working tree %r", basedir)
90
self.basedir = realpath(basedir)
91
# if branch is at our basedir and is a format 6 or less
92
# assume all other formats have their own control files.
93
self._control_files = _control_files
94
self._transport = self._control_files._transport
97
# during a read or write lock these objects are set, and are
98
# None the rest of the time.
100
self._inventory = None
102
self._setup_directory_is_tree_reference()
103
self._detect_case_handling()
104
self._rules_searcher = None
105
self.views = self._make_views()
106
#--- allow tests to select the dirstate iter_changes implementation
107
self._iter_changes = dirstate._process_entry
109
@needs_tree_write_lock
110
def _add(self, files, ids, kinds):
111
"""See MutableTree._add."""
112
state = self.current_dirstate()
113
for f, file_id, kind in zip(files, ids, kinds):
116
# special case tree root handling.
117
if f == '' and self.path2id(f) == ROOT_ID:
118
state.set_path_id('', generate_ids.gen_file_id(f))
121
file_id = generate_ids.gen_file_id(f)
122
# deliberately add the file with no cached stat or sha1
123
# - on the first access it will be gathered, and we can
124
# always change this once tests are all passing.
125
state.add(f, file_id, kind, None, '')
126
self._make_dirty(reset_inventory=True)
128
def _make_dirty(self, reset_inventory):
129
"""Make the tree state dirty.
131
:param reset_inventory: True if the cached inventory should be removed
132
(presuming there is one).
135
if reset_inventory and self._inventory is not None:
136
self._inventory = None
138
@needs_tree_write_lock
139
def add_reference(self, sub_tree):
140
# use standard implementation, which calls back to self._add
142
# So we don't store the reference_revision in the working dirstate,
143
# it's just recorded at the moment of commit.
144
self._add_reference(sub_tree)
146
def break_lock(self):
147
"""Break a lock if one is present from another instance.
149
Uses the ui factory to ask for confirmation if the lock may be from
152
This will probe the repository for its lock as well.
154
# if the dirstate is locked by an active process, reject the break lock
157
if self._dirstate is None:
161
state = self._current_dirstate()
162
if state._lock_token is not None:
163
# we already have it locked. sheese, cant break our own lock.
164
raise errors.LockActive(self.basedir)
167
# try for a write lock - need permission to get one anyhow
170
except errors.LockContention:
171
# oslocks fail when a process is still live: fail.
172
# TODO: get the locked lockdir info and give to the user to
173
# assist in debugging.
174
raise errors.LockActive(self.basedir)
179
self._dirstate = None
180
self._control_files.break_lock()
181
self.branch.break_lock()
183
def _comparison_data(self, entry, path):
184
kind, executable, stat_value = \
185
WorkingTree3._comparison_data(self, entry, path)
186
# it looks like a plain directory, but it's really a reference -- see
188
if (self._repo_supports_tree_reference and kind == 'directory'
189
and entry is not None and entry.kind == 'tree-reference'):
190
kind = 'tree-reference'
191
return kind, executable, stat_value
194
def commit(self, message=None, revprops=None, *args, **kwargs):
195
# mark the tree as dirty post commit - commit
196
# can change the current versioned list by doing deletes.
197
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
198
self._make_dirty(reset_inventory=True)
201
def current_dirstate(self):
202
"""Return the current dirstate object.
204
This is not part of the tree interface and only exposed for ease of
207
:raises errors.NotWriteLocked: when not in a lock.
209
self._must_be_locked()
210
return self._current_dirstate()
212
def _current_dirstate(self):
213
"""Internal function that does not check lock status.
215
This is needed for break_lock which also needs the dirstate.
217
if self._dirstate is not None:
218
return self._dirstate
219
local_path = self.bzrdir.get_workingtree_transport(None
220
).local_abspath('dirstate')
221
self._dirstate = dirstate.DirState.on_file(local_path,
222
self._sha1_provider())
223
return self._dirstate
225
def _sha1_provider(self):
226
"""A function that returns a SHA1Provider suitable for this tree.
228
:return: None if content filtering is not supported by this tree.
229
Otherwise, a SHA1Provider is returned that sha's the canonical
230
form of files, i.e. after read filters are applied.
232
if self.supports_content_filtering():
233
return ContentFilterAwareSHA1Provider(self)
237
def filter_unversioned_files(self, paths):
238
"""Filter out paths that are versioned.
240
:return: set of paths.
242
# TODO: make a generic multi-bisect routine roughly that should list
243
# the paths, then process one half at a time recursively, and feed the
244
# results of each bisect in further still
245
paths = sorted(paths)
247
state = self.current_dirstate()
248
# TODO we want a paths_to_dirblocks helper I think
250
dirname, basename = os.path.split(path.encode('utf8'))
251
_, _, _, path_is_versioned = state._get_block_entry_index(
252
dirname, basename, 0)
253
if not path_is_versioned:
258
"""Write all cached data to disk."""
259
if self._control_files._lock_mode != 'w':
260
raise errors.NotWriteLocked(self)
261
self.current_dirstate().save()
262
self._inventory = None
265
@needs_tree_write_lock
266
def _gather_kinds(self, files, kinds):
267
"""See MutableTree._gather_kinds."""
268
for pos, f in enumerate(files):
269
if kinds[pos] is None:
270
kinds[pos] = self._kind(f)
272
def _generate_inventory(self):
273
"""Create and set self.inventory from the dirstate object.
275
This is relatively expensive: we have to walk the entire dirstate.
276
Ideally we would not, and can deprecate this function.
278
#: uncomment to trap on inventory requests.
279
# import pdb;pdb.set_trace()
280
state = self.current_dirstate()
281
state._read_dirblocks_if_needed()
282
root_key, current_entry = self._get_entry(path='')
283
current_id = root_key[2]
284
if not (current_entry[0][0] == 'd'): # directory
285
raise AssertionError(current_entry)
286
inv = Inventory(root_id=current_id)
287
# Turn some things into local variables
288
minikind_to_kind = dirstate.DirState._minikind_to_kind
289
factory = entry_factory
290
utf8_decode = cache_utf8._utf8_decode
292
# we could do this straight out of the dirstate; it might be fast
293
# and should be profiled - RBC 20070216
294
parent_ies = {'' : inv.root}
295
for block in state._dirblocks[1:]: # skip the root
298
parent_ie = parent_ies[dirname]
300
# all the paths in this block are not versioned in this tree
302
for key, entry in block[1]:
303
minikind, link_or_sha1, size, executable, stat = entry[0]
304
if minikind in ('a', 'r'): # absent, relocated
305
# a parent tree only entry
308
name_unicode = utf8_decode(name)[0]
310
kind = minikind_to_kind[minikind]
311
inv_entry = factory[kind](file_id, name_unicode,
314
# This is only needed on win32, where this is the only way
315
# we know the executable bit.
316
inv_entry.executable = executable
317
# not strictly needed: working tree
318
#inv_entry.text_size = size
319
#inv_entry.text_sha1 = sha1
320
elif kind == 'directory':
321
# add this entry to the parent map.
322
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
323
elif kind == 'tree-reference':
324
if not self._repo_supports_tree_reference:
325
raise errors.UnsupportedOperation(
326
self._generate_inventory,
327
self.branch.repository)
328
inv_entry.reference_revision = link_or_sha1 or None
329
elif kind != 'symlink':
330
raise AssertionError("unknown kind %r" % kind)
331
# These checks cost us around 40ms on a 55k entry tree
332
if file_id in inv_byid:
333
raise AssertionError('file_id %s already in'
334
' inventory as %s' % (file_id, inv_byid[file_id]))
335
if name_unicode in parent_ie.children:
336
raise AssertionError('name %r already in parent'
338
inv_byid[file_id] = inv_entry
339
parent_ie.children[name_unicode] = inv_entry
340
self._inventory = inv
342
def _get_entry(self, file_id=None, path=None):
343
"""Get the dirstate row for file_id or path.
345
If either file_id or path is supplied, it is used as the key to lookup.
346
If both are supplied, the fastest lookup is used, and an error is
347
raised if they do not both point at the same row.
349
:param file_id: An optional unicode file_id to be looked up.
350
:param path: An optional unicode path to be looked up.
351
:return: The dirstate row tuple for path/file_id, or (None, None)
353
if file_id is None and path is None:
354
raise errors.BzrError('must supply file_id or path')
355
state = self.current_dirstate()
357
path = path.encode('utf8')
358
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
360
def get_file_sha1(self, file_id, path=None, stat_value=None):
361
# check file id is valid unconditionally.
362
entry = self._get_entry(file_id=file_id, path=path)
364
raise errors.NoSuchId(self, file_id)
366
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
368
file_abspath = self.abspath(path)
369
state = self.current_dirstate()
370
if stat_value is None:
372
stat_value = os.lstat(file_abspath)
374
if e.errno == errno.ENOENT:
378
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
379
stat_value=stat_value)
380
if entry[1][0][0] == 'f':
381
if link_or_sha1 is None:
382
file_obj, statvalue = self.get_file_with_stat(file_id, path)
384
sha1 = osutils.sha_file(file_obj)
387
self._observed_sha1(file_id, path, (sha1, statvalue))
393
def _get_inventory(self):
394
"""Get the inventory for the tree. This is only valid within a lock."""
395
if 'evil' in debug.debug_flags:
396
trace.mutter_callsite(2,
397
"accessing .inventory forces a size of tree translation.")
398
if self._inventory is not None:
399
return self._inventory
400
self._must_be_locked()
401
self._generate_inventory()
402
return self._inventory
404
inventory = property(_get_inventory,
405
doc="Inventory of this Tree")
408
def get_parent_ids(self):
409
"""See Tree.get_parent_ids.
411
This implementation requests the ids list from the dirstate file.
413
return self.current_dirstate().get_parent_ids()
415
def get_reference_revision(self, file_id, path=None):
416
# referenced tree's revision is whatever's currently there
417
return self.get_nested_tree(file_id, path).last_revision()
419
def get_nested_tree(self, file_id, path=None):
421
path = self.id2path(file_id)
422
# else: check file_id is at path?
423
return WorkingTree.open(self.abspath(path))
426
def get_root_id(self):
427
"""Return the id of this trees root"""
428
return self._get_entry(path='')[0][2]
430
def has_id(self, file_id):
431
state = self.current_dirstate()
432
row, parents = self._get_entry(file_id=file_id)
435
return osutils.lexists(pathjoin(
436
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
438
def has_or_had_id(self, file_id):
439
state = self.current_dirstate()
440
row, parents = self._get_entry(file_id=file_id)
441
return row is not None
444
def id2path(self, file_id):
445
"Convert a file-id to a path."
446
state = self.current_dirstate()
447
entry = self._get_entry(file_id=file_id)
448
if entry == (None, None):
449
raise errors.NoSuchId(tree=self, file_id=file_id)
450
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
451
return path_utf8.decode('utf8')
453
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
454
entry = self._get_entry(path=path)
455
if entry == (None, None):
456
return False # Missing entries are not executable
457
return entry[1][0][3] # Executable?
459
if not osutils.supports_executable():
460
def is_executable(self, file_id, path=None):
461
"""Test if a file is executable or not.
463
Note: The caller is expected to take a read-lock before calling this.
465
entry = self._get_entry(file_id=file_id, path=path)
466
if entry == (None, None):
468
return entry[1][0][3]
470
_is_executable_from_path_and_stat = \
471
_is_executable_from_path_and_stat_from_basis
473
def is_executable(self, file_id, path=None):
474
"""Test if a file is executable or not.
476
Note: The caller is expected to take a read-lock before calling this.
478
self._must_be_locked()
480
path = self.id2path(file_id)
481
mode = os.lstat(self.abspath(path)).st_mode
482
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
484
def all_file_ids(self):
485
"""See Tree.iter_all_file_ids"""
486
self._must_be_locked()
488
for key, tree_details in self.current_dirstate()._iter_entries():
489
if tree_details[0][0] in ('a', 'r'): # relocated
496
"""Iterate through file_ids for this tree.
498
file_ids are in a WorkingTree if they are in the working inventory
499
and the working file exists.
502
for key, tree_details in self.current_dirstate()._iter_entries():
503
if tree_details[0][0] in ('a', 'r'): # absent, relocated
504
# not relevant to the working tree
506
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
507
if osutils.lexists(path):
508
result.append(key[2])
511
def iter_references(self):
512
if not self._repo_supports_tree_reference:
513
# When the repo doesn't support references, we will have nothing to
516
for key, tree_details in self.current_dirstate()._iter_entries():
517
if tree_details[0][0] in ('a', 'r'): # absent, relocated
518
# not relevant to the working tree
521
# the root is not a reference.
523
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
525
if self._kind(relpath) == 'tree-reference':
526
yield relpath, key[2]
527
except errors.NoSuchFile:
528
# path is missing on disk.
531
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
532
"""See MutableTree._observed_sha1."""
533
state = self.current_dirstate()
534
entry = self._get_entry(file_id=file_id, path=path)
535
state._observed_sha1(entry, sha1, statvalue)
537
def kind(self, file_id):
538
"""Return the kind of a file.
540
This is always the actual kind that's on disk, regardless of what it
543
Note: The caller is expected to take a read-lock before calling this.
545
relpath = self.id2path(file_id)
547
raise AssertionError(
548
"path for id {%s} is None!" % file_id)
549
return self._kind(relpath)
551
def _kind(self, relpath):
552
abspath = self.abspath(relpath)
553
kind = file_kind(abspath)
554
if (self._repo_supports_tree_reference and kind == 'directory'):
555
entry = self._get_entry(path=relpath)
556
if entry[1] is not None:
557
if entry[1][0][0] == 't':
558
kind = 'tree-reference'
562
def _last_revision(self):
563
"""See Mutable.last_revision."""
564
parent_ids = self.current_dirstate().get_parent_ids()
568
return _mod_revision.NULL_REVISION
571
"""See Branch.lock_read, and WorkingTree.unlock.
573
:return: A bzrlib.lock.LogicalLockResult.
575
self.branch.lock_read()
577
self._control_files.lock_read()
579
state = self.current_dirstate()
580
if not state._lock_token:
582
# set our support for tree references from the repository in
584
self._repo_supports_tree_reference = getattr(
585
self.branch.repository._format, "supports_tree_reference",
588
self._control_files.unlock()
593
return LogicalLockResult(self.unlock)
595
def _lock_self_write(self):
596
"""This should be called after the branch is locked."""
598
self._control_files.lock_write()
600
state = self.current_dirstate()
601
if not state._lock_token:
603
# set our support for tree references from the repository in
605
self._repo_supports_tree_reference = getattr(
606
self.branch.repository._format, "supports_tree_reference",
609
self._control_files.unlock()
614
return LogicalLockResult(self.unlock)
616
def lock_tree_write(self):
617
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
619
:return: A bzrlib.lock.LogicalLockResult.
621
self.branch.lock_read()
622
return self._lock_self_write()
624
def lock_write(self):
625
"""See MutableTree.lock_write, and WorkingTree.unlock.
627
:return: A bzrlib.lock.LogicalLockResult.
629
self.branch.lock_write()
630
return self._lock_self_write()
632
@needs_tree_write_lock
633
def move(self, from_paths, to_dir, after=False):
634
"""See WorkingTree.move()."""
638
state = self.current_dirstate()
639
if isinstance(from_paths, basestring):
641
to_dir_utf8 = to_dir.encode('utf8')
642
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
643
id_index = state._get_id_index()
644
# check destination directory
645
# get the details for it
646
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
647
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
648
if not entry_present:
649
raise errors.BzrMoveFailedError('', to_dir,
650
errors.NotVersionedError(to_dir))
651
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
652
# get a handle on the block itself.
653
to_block_index = state._ensure_block(
654
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
655
to_block = state._dirblocks[to_block_index]
656
to_abs = self.abspath(to_dir)
657
if not isdir(to_abs):
658
raise errors.BzrMoveFailedError('',to_dir,
659
errors.NotADirectory(to_abs))
661
if to_entry[1][0][0] != 'd':
662
raise errors.BzrMoveFailedError('',to_dir,
663
errors.NotADirectory(to_abs))
665
if self._inventory is not None:
666
update_inventory = True
668
to_dir_id = to_entry[0][2]
669
to_dir_ie = inv[to_dir_id]
671
update_inventory = False
674
def move_one(old_entry, from_path_utf8, minikind, executable,
675
fingerprint, packed_stat, size,
676
to_block, to_key, to_path_utf8):
677
state._make_absent(old_entry)
678
from_key = old_entry[0]
680
lambda:state.update_minimal(from_key,
682
executable=executable,
683
fingerprint=fingerprint,
684
packed_stat=packed_stat,
686
path_utf8=from_path_utf8))
687
state.update_minimal(to_key,
689
executable=executable,
690
fingerprint=fingerprint,
691
packed_stat=packed_stat,
693
path_utf8=to_path_utf8)
694
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
695
new_entry = to_block[1][added_entry_index]
696
rollbacks.append(lambda:state._make_absent(new_entry))
698
for from_rel in from_paths:
699
# from_rel is 'pathinroot/foo/bar'
700
from_rel_utf8 = from_rel.encode('utf8')
701
from_dirname, from_tail = osutils.split(from_rel)
702
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
703
from_entry = self._get_entry(path=from_rel)
704
if from_entry == (None, None):
705
raise errors.BzrMoveFailedError(from_rel,to_dir,
706
errors.NotVersionedError(path=from_rel))
708
from_id = from_entry[0][2]
709
to_rel = pathjoin(to_dir, from_tail)
710
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
711
item_to_entry = self._get_entry(path=to_rel)
712
if item_to_entry != (None, None):
713
raise errors.BzrMoveFailedError(from_rel, to_rel,
714
"Target is already versioned.")
716
if from_rel == to_rel:
717
raise errors.BzrMoveFailedError(from_rel, to_rel,
718
"Source and target are identical.")
720
from_missing = not self.has_filename(from_rel)
721
to_missing = not self.has_filename(to_rel)
728
raise errors.BzrMoveFailedError(from_rel, to_rel,
729
errors.NoSuchFile(path=to_rel,
730
extra="New file has not been created yet"))
732
# neither path exists
733
raise errors.BzrRenameFailedError(from_rel, to_rel,
734
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
736
if from_missing: # implicitly just update our path mapping
739
raise errors.RenameFailedFilesExist(from_rel, to_rel)
742
def rollback_rename():
743
"""A single rename has failed, roll it back."""
744
# roll back everything, even if we encounter trouble doing one
747
# TODO: at least log the other exceptions rather than just
748
# losing them mbp 20070307
750
for rollback in reversed(rollbacks):
754
exc_info = sys.exc_info()
756
raise exc_info[0], exc_info[1], exc_info[2]
758
# perform the disk move first - its the most likely failure point.
760
from_rel_abs = self.abspath(from_rel)
761
to_rel_abs = self.abspath(to_rel)
763
osutils.rename(from_rel_abs, to_rel_abs)
765
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
766
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
768
# perform the rename in the inventory next if needed: its easy
772
from_entry = inv[from_id]
773
current_parent = from_entry.parent_id
774
inv.rename(from_id, to_dir_id, from_tail)
776
lambda: inv.rename(from_id, current_parent, from_tail))
777
# finally do the rename in the dirstate, which is a little
778
# tricky to rollback, but least likely to need it.
779
old_block_index, old_entry_index, dir_present, file_present = \
780
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
781
old_block = state._dirblocks[old_block_index][1]
782
old_entry = old_block[old_entry_index]
783
from_key, old_entry_details = old_entry
784
cur_details = old_entry_details[0]
786
to_key = ((to_block[0],) + from_key[1:3])
787
minikind = cur_details[0]
788
move_one(old_entry, from_path_utf8=from_rel_utf8,
790
executable=cur_details[3],
791
fingerprint=cur_details[1],
792
packed_stat=cur_details[4],
796
to_path_utf8=to_rel_utf8)
799
def update_dirblock(from_dir, to_key, to_dir_utf8):
800
"""Recursively update all entries in this dirblock."""
802
raise AssertionError("renaming root not supported")
803
from_key = (from_dir, '')
804
from_block_idx, present = \
805
state._find_block_index_from_key(from_key)
807
# This is the old record, if it isn't present, then
808
# there is theoretically nothing to update.
809
# (Unless it isn't present because of lazy loading,
810
# but we don't do that yet)
812
from_block = state._dirblocks[from_block_idx]
813
to_block_index, to_entry_index, _, _ = \
814
state._get_block_entry_index(to_key[0], to_key[1], 0)
815
to_block_index = state._ensure_block(
816
to_block_index, to_entry_index, to_dir_utf8)
817
to_block = state._dirblocks[to_block_index]
819
# Grab a copy since move_one may update the list.
820
for entry in from_block[1][:]:
821
if not (entry[0][0] == from_dir):
822
raise AssertionError()
823
cur_details = entry[1][0]
824
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
825
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
826
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
827
minikind = cur_details[0]
829
# Deleted children of a renamed directory
830
# Do not need to be updated.
831
# Children that have been renamed out of this
832
# directory should also not be updated
834
move_one(entry, from_path_utf8=from_path_utf8,
836
executable=cur_details[3],
837
fingerprint=cur_details[1],
838
packed_stat=cur_details[4],
842
to_path_utf8=to_path_utf8)
844
# We need to move all the children of this
846
update_dirblock(from_path_utf8, to_key,
848
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
852
result.append((from_rel, to_rel))
853
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
854
self._make_dirty(reset_inventory=False)
858
def _must_be_locked(self):
859
if not self._control_files._lock_count:
860
raise errors.ObjectNotLocked(self)
863
"""Initialize the state in this tree to be a new tree."""
867
def path2id(self, path):
868
"""Return the id for path in this tree."""
869
path = path.strip('/')
870
entry = self._get_entry(path=path)
871
if entry == (None, None):
875
def paths2ids(self, paths, trees=[], require_versioned=True):
876
"""See Tree.paths2ids().
878
This specialisation fast-paths the case where all the trees are in the
883
parents = self.get_parent_ids()
885
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
887
return super(DirStateWorkingTree, self).paths2ids(paths,
888
trees, require_versioned)
889
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
890
# -- make all paths utf8 --
893
paths_utf8.add(path.encode('utf8'))
895
# -- paths is now a utf8 path set --
896
# -- get the state object and prepare it.
897
state = self.current_dirstate()
898
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
899
and '' not in paths):
900
paths2ids = self._paths2ids_using_bisect
902
paths2ids = self._paths2ids_in_memory
903
return paths2ids(paths, search_indexes,
904
require_versioned=require_versioned)
906
def _paths2ids_in_memory(self, paths, search_indexes,
907
require_versioned=True):
908
state = self.current_dirstate()
909
state._read_dirblocks_if_needed()
910
def _entries_for_path(path):
911
"""Return a list with all the entries that match path for all ids.
913
dirname, basename = os.path.split(path)
914
key = (dirname, basename, '')
915
block_index, present = state._find_block_index_from_key(key)
917
# the block which should contain path is absent.
920
block = state._dirblocks[block_index][1]
921
entry_index, _ = state._find_entry_index(key, block)
922
# we may need to look at multiple entries at this path: walk while the paths match.
923
while (entry_index < len(block) and
924
block[entry_index][0][0:2] == key[0:2]):
925
result.append(block[entry_index])
928
if require_versioned:
929
# -- check all supplied paths are versioned in a search tree. --
932
path_entries = _entries_for_path(path)
934
# this specified path is not present at all: error
935
all_versioned = False
937
found_versioned = False
938
# for each id at this path
939
for entry in path_entries:
941
for index in search_indexes:
942
if entry[1][index][0] != 'a': # absent
943
found_versioned = True
944
# all good: found a versioned cell
946
if not found_versioned:
947
# none of the indexes was not 'absent' at all ids for this
949
all_versioned = False
951
if not all_versioned:
952
raise errors.PathsNotVersionedError(paths)
953
# -- remove redundancy in supplied paths to prevent over-scanning --
954
search_paths = osutils.minimum_path_selection(paths)
956
# for all search_indexs in each path at or under each element of
957
# search_paths, if the detail is relocated: add the id, and add the
958
# relocated path as one to search if its not searched already. If the
959
# detail is not relocated, add the id.
960
searched_paths = set()
962
def _process_entry(entry):
963
"""Look at search_indexes within entry.
965
If a specific tree's details are relocated, add the relocation
966
target to search_paths if not searched already. If it is absent, do
967
nothing. Otherwise add the id to found_ids.
969
for index in search_indexes:
970
if entry[1][index][0] == 'r': # relocated
971
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
972
search_paths.add(entry[1][index][1])
973
elif entry[1][index][0] != 'a': # absent
974
found_ids.add(entry[0][2])
976
current_root = search_paths.pop()
977
searched_paths.add(current_root)
978
# process the entries for this containing directory: the rest will be
979
# found by their parents recursively.
980
root_entries = _entries_for_path(current_root)
982
# this specified path is not present at all, skip it.
984
for entry in root_entries:
985
_process_entry(entry)
986
initial_key = (current_root, '', '')
987
block_index, _ = state._find_block_index_from_key(initial_key)
988
while (block_index < len(state._dirblocks) and
989
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
990
for entry in state._dirblocks[block_index][1]:
991
_process_entry(entry)
995
def _paths2ids_using_bisect(self, paths, search_indexes,
996
require_versioned=True):
997
state = self.current_dirstate()
1000
split_paths = sorted(osutils.split(p) for p in paths)
1001
found = state._bisect_recursive(split_paths)
1003
if require_versioned:
1004
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1005
for dir_name in split_paths:
1006
if dir_name not in found_dir_names:
1007
raise errors.PathsNotVersionedError(paths)
1009
for dir_name_id, trees_info in found.iteritems():
1010
for index in search_indexes:
1011
if trees_info[index][0] not in ('r', 'a'):
1012
found_ids.add(dir_name_id[2])
1015
def read_working_inventory(self):
1016
"""Read the working inventory.
1018
This is a meaningless operation for dirstate, but we obey it anyhow.
1020
return self.inventory
1023
def revision_tree(self, revision_id):
1024
"""See Tree.revision_tree.
1026
WorkingTree4 supplies revision_trees for any basis tree.
1028
dirstate = self.current_dirstate()
1029
parent_ids = dirstate.get_parent_ids()
1030
if revision_id not in parent_ids:
1031
raise errors.NoSuchRevisionInTree(self, revision_id)
1032
if revision_id in dirstate.get_ghosts():
1033
raise errors.NoSuchRevisionInTree(self, revision_id)
1034
return DirStateRevisionTree(dirstate, revision_id,
1035
self.branch.repository)
1037
@needs_tree_write_lock
1038
def set_last_revision(self, new_revision):
1039
"""Change the last revision in the working tree."""
1040
parents = self.get_parent_ids()
1041
if new_revision in (_mod_revision.NULL_REVISION, None):
1042
if len(parents) >= 2:
1043
raise AssertionError(
1044
"setting the last parent to none with a pending merge is "
1046
self.set_parent_ids([])
1048
self.set_parent_ids([new_revision] + parents[1:],
1049
allow_leftmost_as_ghost=True)
1051
@needs_tree_write_lock
1052
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1053
"""Set the parent ids to revision_ids.
1055
See also set_parent_trees. This api will try to retrieve the tree data
1056
for each element of revision_ids from the trees repository. If you have
1057
tree data already available, it is more efficient to use
1058
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1059
an easier API to use.
1061
:param revision_ids: The revision_ids to set as the parent ids of this
1062
working tree. Any of these may be ghosts.
1065
for revision_id in revision_ids:
1067
revtree = self.branch.repository.revision_tree(revision_id)
1068
# TODO: jam 20070213 KnitVersionedFile raises
1069
# RevisionNotPresent rather than NoSuchRevision if a
1070
# given revision_id is not present. Should Repository be
1071
# catching it and re-raising NoSuchRevision?
1072
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1074
trees.append((revision_id, revtree))
1075
self.set_parent_trees(trees,
1076
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1078
@needs_tree_write_lock
1079
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1080
"""Set the parents of the working tree.
1082
:param parents_list: A list of (revision_id, tree) tuples.
1083
If tree is None, then that element is treated as an unreachable
1084
parent tree - i.e. a ghost.
1086
dirstate = self.current_dirstate()
1087
if len(parents_list) > 0:
1088
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1089
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1093
parent_ids = [rev_id for rev_id, tree in parents_list]
1094
graph = self.branch.repository.get_graph()
1095
heads = graph.heads(parent_ids)
1096
accepted_revisions = set()
1098
# convert absent trees to the null tree, which we convert back to
1099
# missing on access.
1100
for rev_id, tree in parents_list:
1101
if len(accepted_revisions) > 0:
1102
# we always accept the first tree
1103
if rev_id in accepted_revisions or rev_id not in heads:
1104
# We have already included either this tree, or its
1105
# descendent, so we skip it.
1107
_mod_revision.check_not_reserved_id(rev_id)
1108
if tree is not None:
1109
real_trees.append((rev_id, tree))
1111
real_trees.append((rev_id,
1112
self.branch.repository.revision_tree(
1113
_mod_revision.NULL_REVISION)))
1114
ghosts.append(rev_id)
1115
accepted_revisions.add(rev_id)
1116
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1117
self._make_dirty(reset_inventory=False)
1119
def _set_root_id(self, file_id):
1120
"""See WorkingTree.set_root_id."""
1121
state = self.current_dirstate()
1122
state.set_path_id('', file_id)
1123
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1124
self._make_dirty(reset_inventory=True)
1126
def _sha_from_stat(self, path, stat_result):
1127
"""Get a sha digest from the tree's stat cache.
1129
The default implementation assumes no stat cache is present.
1131
:param path: The path.
1132
:param stat_result: The stat result being looked up.
1134
return self.current_dirstate().sha1_from_stat(path, stat_result)
1137
def supports_tree_reference(self):
1138
return self._repo_supports_tree_reference
1141
"""Unlock in format 4 trees needs to write the entire dirstate."""
1142
# do non-implementation specific cleanup
1145
if self._control_files._lock_count == 1:
1146
# eventually we should do signature checking during read locks for
1148
if self._control_files._lock_mode == 'w':
1151
if self._dirstate is not None:
1152
# This is a no-op if there are no modifications.
1153
self._dirstate.save()
1154
self._dirstate.unlock()
1155
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1156
# point. Instead, it could check if the header has been
1157
# modified when it is locked, and if not, it can hang on to
1158
# the data it has in memory.
1159
self._dirstate = None
1160
self._inventory = None
1161
# reverse order of locking.
1163
return self._control_files.unlock()
1165
self.branch.unlock()
1167
@needs_tree_write_lock
1168
def unversion(self, file_ids):
1169
"""Remove the file ids in file_ids from the current versioned set.
1171
When a file_id is unversioned, all of its children are automatically
1174
:param file_ids: The file ids to stop versioning.
1175
:raises: NoSuchId if any fileid is not currently versioned.
1179
state = self.current_dirstate()
1180
state._read_dirblocks_if_needed()
1181
ids_to_unversion = set(file_ids)
1182
paths_to_unversion = set()
1184
# check if the root is to be unversioned, if so, assert for now.
1185
# walk the state marking unversioned things as absent.
1186
# if there are any un-unversioned ids at the end, raise
1187
for key, details in state._dirblocks[0][1]:
1188
if (details[0][0] not in ('a', 'r') and # absent or relocated
1189
key[2] in ids_to_unversion):
1190
# I haven't written the code to unversion / yet - it should be
1192
raise errors.BzrError('Unversioning the / is not currently supported')
1194
while block_index < len(state._dirblocks):
1195
# process one directory at a time.
1196
block = state._dirblocks[block_index]
1197
# first check: is the path one to remove - it or its children
1198
delete_block = False
1199
for path in paths_to_unversion:
1200
if (block[0].startswith(path) and
1201
(len(block[0]) == len(path) or
1202
block[0][len(path)] == '/')):
1203
# this entire block should be deleted - its the block for a
1204
# path to unversion; or the child of one
1207
# TODO: trim paths_to_unversion as we pass by paths
1209
# this block is to be deleted: process it.
1210
# TODO: we can special case the no-parents case and
1211
# just forget the whole block.
1213
while entry_index < len(block[1]):
1214
entry = block[1][entry_index]
1215
if entry[1][0][0] in 'ar':
1216
# don't remove absent or renamed entries
1219
# Mark this file id as having been removed
1220
ids_to_unversion.discard(entry[0][2])
1221
if not state._make_absent(entry):
1222
# The block has not shrunk.
1224
# go to the next block. (At the moment we dont delete empty
1229
while entry_index < len(block[1]):
1230
entry = block[1][entry_index]
1231
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1232
# ^ some parent row.
1233
entry[0][2] not in ids_to_unversion):
1234
# ^ not an id to unversion
1237
if entry[1][0][0] == 'd':
1238
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1239
if not state._make_absent(entry):
1241
# we have unversioned this id
1242
ids_to_unversion.remove(entry[0][2])
1244
if ids_to_unversion:
1245
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1246
self._make_dirty(reset_inventory=False)
1247
# have to change the legacy inventory too.
1248
if self._inventory is not None:
1249
for file_id in file_ids:
1250
if self._inventory.has_id(file_id):
1251
self._inventory.remove_recursive_id(file_id)
1253
@needs_tree_write_lock
1254
def rename_one(self, from_rel, to_rel, after=False):
1255
"""See WorkingTree.rename_one"""
1257
WorkingTree.rename_one(self, from_rel, to_rel, after)
1259
@needs_tree_write_lock
1260
def apply_inventory_delta(self, changes):
1261
"""See MutableTree.apply_inventory_delta"""
1262
state = self.current_dirstate()
1263
state.update_by_delta(changes)
1264
self._make_dirty(reset_inventory=True)
1266
def update_basis_by_delta(self, new_revid, delta):
1267
"""See MutableTree.update_basis_by_delta."""
1268
if self.last_revision() == new_revid:
1269
raise AssertionError()
1270
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1273
def _validate(self):
1274
self._dirstate._validate()
1276
@needs_tree_write_lock
1277
def _write_inventory(self, inv):
1278
"""Write inventory as the current inventory."""
1280
raise AssertionError("attempting to write an inventory when the "
1281
"dirstate is dirty will lose pending changes")
1282
had_inventory = self._inventory is not None
1283
# Setting self._inventory = None forces the dirstate to regenerate the
1284
# working inventory. We do this because self.inventory may be inv, or
1285
# may have been modified, and either case would prevent a clean delta
1287
self._inventory = None
1289
delta = inv._make_delta(self.inventory)
1291
self.apply_inventory_delta(delta)
1293
self._inventory = inv
1297
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1299
def __init__(self, tree):
1302
def sha1(self, abspath):
1303
"""See dirstate.SHA1Provider.sha1()."""
1304
filters = self.tree._content_filter_stack(
1305
self.tree.relpath(osutils.safe_unicode(abspath)))
1306
return internal_size_sha_file_byname(abspath, filters)[1]
1308
def stat_and_sha1(self, abspath):
1309
"""See dirstate.SHA1Provider.stat_and_sha1()."""
1310
filters = self.tree._content_filter_stack(
1311
self.tree.relpath(osutils.safe_unicode(abspath)))
1312
file_obj = file(abspath, 'rb', 65000)
1314
statvalue = os.fstat(file_obj.fileno())
1316
file_obj = filtered_input_file(file_obj, filters)
1317
sha1 = osutils.size_sha_file(file_obj)[1]
1320
return statvalue, sha1
1323
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1324
"""Dirstate working tree that supports content filtering.
1326
The dirstate holds the hash and size of the canonical form of the file,
1327
and most methods must return that.
1330
def _file_content_summary(self, path, stat_result):
1331
# This is to support the somewhat obsolete path_content_summary method
1332
# with content filtering: see
1333
# <https://bugs.launchpad.net/bzr/+bug/415508>.
1335
# If the dirstate cache is up to date and knows the hash and size,
1337
# Otherwise if there are no content filters, return the on-disk size
1338
# and leave the hash blank.
1339
# Otherwise, read and filter the on-disk file and use its size and
1342
# The dirstate doesn't store the size of the canonical form so we
1343
# can't trust it for content-filtered trees. We just return None.
1344
dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1345
executable = self._is_executable_from_path_and_stat(path, stat_result)
1346
return ('file', None, executable, dirstate_sha1)
1349
class WorkingTree4(DirStateWorkingTree):
1350
"""This is the Format 4 working tree.
1352
This differs from WorkingTree3 by:
1353
- Having a consolidated internal dirstate, stored in a
1354
randomly-accessible sorted file on disk.
1355
- Not having a regular inventory attribute. One can be synthesized
1356
on demand but this is expensive and should be avoided.
1358
This is new in bzr 0.15.
1362
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1363
"""This is the Format 5 working tree.
1365
This differs from WorkingTree4 by:
1366
- Supporting content filtering.
1368
This is new in bzr 1.11.
1372
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1373
"""This is the Format 6 working tree.
1375
This differs from WorkingTree5 by:
1376
- Supporting a current view that may mask the set of files in a tree
1377
impacted by most user operations.
1379
This is new in bzr 1.14.
1382
def _make_views(self):
1383
return views.PathBasedViews(self)
1386
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1388
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1389
accelerator_tree=None, hardlink=False):
1390
"""See WorkingTreeFormat.initialize().
1392
:param revision_id: allows creating a working tree at a different
1393
revision than the branch is at.
1394
:param accelerator_tree: A tree which can be used for retrieving file
1395
contents more quickly than the revision tree, i.e. a workingtree.
1396
The revision tree will be used for cases where accelerator_tree's
1397
content is different.
1398
:param hardlink: If true, hard-link files from accelerator_tree,
1401
These trees get an initial random root id, if their repository supports
1402
rich root data, TREE_ROOT otherwise.
1404
if not isinstance(a_bzrdir.transport, LocalTransport):
1405
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1406
transport = a_bzrdir.get_workingtree_transport(self)
1407
control_files = self._open_control_files(a_bzrdir)
1408
control_files.create_lock()
1409
control_files.lock_write()
1410
transport.put_bytes('format', self.get_format_string(),
1411
mode=a_bzrdir._get_file_mode())
1412
if from_branch is not None:
1413
branch = from_branch
1415
branch = a_bzrdir.open_branch()
1416
if revision_id is None:
1417
revision_id = branch.last_revision()
1418
local_path = transport.local_abspath('dirstate')
1419
# write out new dirstate (must exist when we create the tree)
1420
state = dirstate.DirState.initialize(local_path)
1423
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1427
_control_files=control_files)
1429
wt.lock_tree_write()
1431
self._init_custom_control_files(wt)
1432
if revision_id in (None, _mod_revision.NULL_REVISION):
1433
if branch.repository.supports_rich_root():
1434
wt._set_root_id(generate_ids.gen_root_id())
1436
wt._set_root_id(ROOT_ID)
1439
# frequently, we will get here due to branching. The accelerator
1440
# tree will be the tree from the branch, so the desired basis
1441
# tree will often be a parent of the accelerator tree.
1442
if accelerator_tree is not None:
1444
basis = accelerator_tree.revision_tree(revision_id)
1445
except errors.NoSuchRevision:
1448
basis = branch.repository.revision_tree(revision_id)
1449
if revision_id == _mod_revision.NULL_REVISION:
1452
parents_list = [(revision_id, basis)]
1455
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1457
# if the basis has a root id we have to use that; otherwise we
1458
# use a new random one
1459
basis_root_id = basis.get_root_id()
1460
if basis_root_id is not None:
1461
wt._set_root_id(basis_root_id)
1463
if wt.supports_content_filtering():
1464
# The original tree may not have the same content filters
1465
# applied so we can't safely build the inventory delta from
1467
delta_from_tree = False
1469
delta_from_tree = True
1470
# delta_from_tree is safe even for DirStateRevisionTrees,
1471
# because wt4.apply_inventory_delta does not mutate the input
1472
# inventory entries.
1473
transform.build_tree(basis, wt, accelerator_tree,
1475
delta_from_tree=delta_from_tree)
1479
control_files.unlock()
1483
def _init_custom_control_files(self, wt):
1484
"""Subclasses with custom control files should override this method.
1486
The working tree and control files are locked for writing when this
1489
:param wt: the WorkingTree object
1492
def _open(self, a_bzrdir, control_files):
1493
"""Open the tree itself.
1495
:param a_bzrdir: the dir for the tree.
1496
:param control_files: the control files for the tree.
1498
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1499
branch=a_bzrdir.open_branch(),
1502
_control_files=control_files)
1504
def __get_matchingbzrdir(self):
1505
return self._get_matchingbzrdir()
1507
def _get_matchingbzrdir(self):
1508
"""Overrideable method to get a bzrdir for testing."""
1509
# please test against something that will let us do tree references
1510
return bzrdir.format_registry.make_bzrdir(
1511
'dirstate-with-subtree')
1513
_matchingbzrdir = property(__get_matchingbzrdir)
1516
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1517
"""The first consolidated dirstate working tree format.
1520
- exists within a metadir controlling .bzr
1521
- includes an explicit version marker for the workingtree control
1522
files, separate from the BzrDir format
1523
- modifies the hash cache format
1524
- is new in bzr 0.15
1525
- uses a LockDir to guard access to it.
1528
upgrade_recommended = False
1530
_tree_class = WorkingTree4
1532
def get_format_string(self):
1533
"""See WorkingTreeFormat.get_format_string()."""
1534
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1536
def get_format_description(self):
1537
"""See WorkingTreeFormat.get_format_description()."""
1538
return "Working tree format 4"
1541
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1542
"""WorkingTree format supporting content filtering.
1545
upgrade_recommended = False
1547
_tree_class = WorkingTree5
1549
def get_format_string(self):
1550
"""See WorkingTreeFormat.get_format_string()."""
1551
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1553
def get_format_description(self):
1554
"""See WorkingTreeFormat.get_format_description()."""
1555
return "Working tree format 5"
1557
def supports_content_filtering(self):
1561
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1562
"""WorkingTree format supporting views.
1565
upgrade_recommended = False
1567
_tree_class = WorkingTree6
1569
def get_format_string(self):
1570
"""See WorkingTreeFormat.get_format_string()."""
1571
return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1573
def get_format_description(self):
1574
"""See WorkingTreeFormat.get_format_description()."""
1575
return "Working tree format 6"
1577
def _init_custom_control_files(self, wt):
1578
"""Subclasses with custom control files should override this method."""
1579
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1581
def supports_content_filtering(self):
1584
def supports_views(self):
1588
class DirStateRevisionTree(Tree):
1589
"""A revision tree pulling the inventory from a dirstate.
1591
Note that this is one of the historical (ie revision) trees cached in the
1592
dirstate for easy access, not the workingtree.
1595
def __init__(self, dirstate, revision_id, repository):
1596
self._dirstate = dirstate
1597
self._revision_id = revision_id
1598
self._repository = repository
1599
self._inventory = None
1601
self._dirstate_locked = False
1602
self._repo_supports_tree_reference = getattr(
1603
repository._format, "supports_tree_reference",
1607
return "<%s of %s in %s>" % \
1608
(self.__class__.__name__, self._revision_id, self._dirstate)
1610
def annotate_iter(self, file_id,
1611
default_revision=_mod_revision.CURRENT_REVISION):
1612
"""See Tree.annotate_iter"""
1613
text_key = (file_id, self.inventory[file_id].revision)
1614
annotations = self._repository.texts.annotate(text_key)
1615
return [(key[-1], line) for (key, line) in annotations]
1617
def _get_ancestors(self, default_revision):
1618
return set(self._repository.get_ancestry(self._revision_id,
1620
def _comparison_data(self, entry, path):
1621
"""See Tree._comparison_data."""
1623
return None, False, None
1624
# trust the entry as RevisionTree does, but this may not be
1625
# sensible: the entry might not have come from us?
1626
return entry.kind, entry.executable, None
1628
def _file_size(self, entry, stat_value):
1629
return entry.text_size
1631
def filter_unversioned_files(self, paths):
1632
"""Filter out paths that are not versioned.
1634
:return: set of paths.
1636
pred = self.has_filename
1637
return set((p for p in paths if not pred(p)))
1639
def get_root_id(self):
1640
return self.path2id('')
1642
def id2path(self, file_id):
1643
"Convert a file-id to a path."
1644
entry = self._get_entry(file_id=file_id)
1645
if entry == (None, None):
1646
raise errors.NoSuchId(tree=self, file_id=file_id)
1647
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1648
return path_utf8.decode('utf8')
1650
def iter_references(self):
1651
if not self._repo_supports_tree_reference:
1652
# When the repo doesn't support references, we will have nothing to
1655
# Otherwise, fall back to the default implementation
1656
return super(DirStateRevisionTree, self).iter_references()
1658
def _get_parent_index(self):
1659
"""Return the index in the dirstate referenced by this tree."""
1660
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1662
def _get_entry(self, file_id=None, path=None):
1663
"""Get the dirstate row for file_id or path.
1665
If either file_id or path is supplied, it is used as the key to lookup.
1666
If both are supplied, the fastest lookup is used, and an error is
1667
raised if they do not both point at the same row.
1669
:param file_id: An optional unicode file_id to be looked up.
1670
:param path: An optional unicode path to be looked up.
1671
:return: The dirstate row tuple for path/file_id, or (None, None)
1673
if file_id is None and path is None:
1674
raise errors.BzrError('must supply file_id or path')
1675
if path is not None:
1676
path = path.encode('utf8')
1677
parent_index = self._get_parent_index()
1678
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1680
def _generate_inventory(self):
1681
"""Create and set self.inventory from the dirstate object.
1683
(So this is only called the first time the inventory is requested for
1684
this tree; it then remains in memory until it's out of date.)
1686
This is relatively expensive: we have to walk the entire dirstate.
1688
if not self._locked:
1689
raise AssertionError(
1690
'cannot generate inventory of an unlocked '
1691
'dirstate revision tree')
1692
# separate call for profiling - makes it clear where the costs are.
1693
self._dirstate._read_dirblocks_if_needed()
1694
if self._revision_id not in self._dirstate.get_parent_ids():
1695
raise AssertionError(
1696
'parent %s has disappeared from %s' % (
1697
self._revision_id, self._dirstate.get_parent_ids()))
1698
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1699
# This is identical now to the WorkingTree _generate_inventory except
1700
# for the tree index use.
1701
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1702
current_id = root_key[2]
1703
if current_entry[parent_index][0] != 'd':
1704
raise AssertionError()
1705
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1706
inv.root.revision = current_entry[parent_index][4]
1707
# Turn some things into local variables
1708
minikind_to_kind = dirstate.DirState._minikind_to_kind
1709
factory = entry_factory
1710
utf8_decode = cache_utf8._utf8_decode
1711
inv_byid = inv._byid
1712
# we could do this straight out of the dirstate; it might be fast
1713
# and should be profiled - RBC 20070216
1714
parent_ies = {'' : inv.root}
1715
for block in self._dirstate._dirblocks[1:]: #skip root
1718
parent_ie = parent_ies[dirname]
1720
# all the paths in this block are not versioned in this tree
1722
for key, entry in block[1]:
1723
minikind, fingerprint, size, executable, revid = entry[parent_index]
1724
if minikind in ('a', 'r'): # absent, relocated
1728
name_unicode = utf8_decode(name)[0]
1730
kind = minikind_to_kind[minikind]
1731
inv_entry = factory[kind](file_id, name_unicode,
1733
inv_entry.revision = revid
1735
inv_entry.executable = executable
1736
inv_entry.text_size = size
1737
inv_entry.text_sha1 = fingerprint
1738
elif kind == 'directory':
1739
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1740
elif kind == 'symlink':
1741
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1742
elif kind == 'tree-reference':
1743
inv_entry.reference_revision = fingerprint or None
1745
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1747
# These checks cost us around 40ms on a 55k entry tree
1748
if file_id in inv_byid:
1749
raise AssertionError('file_id %s already in'
1750
' inventory as %s' % (file_id, inv_byid[file_id]))
1751
if name_unicode in parent_ie.children:
1752
raise AssertionError('name %r already in parent'
1754
inv_byid[file_id] = inv_entry
1755
parent_ie.children[name_unicode] = inv_entry
1756
self._inventory = inv
1758
def get_file_mtime(self, file_id, path=None):
1759
"""Return the modification time for this record.
1761
We return the timestamp of the last-changed revision.
1763
# Make sure the file exists
1764
entry = self._get_entry(file_id, path=path)
1765
if entry == (None, None): # do we raise?
1767
parent_index = self._get_parent_index()
1768
last_changed_revision = entry[1][parent_index][4]
1770
rev = self._repository.get_revision(last_changed_revision)
1771
except errors.NoSuchRevision:
1772
raise errors.FileTimestampUnavailable(self.id2path(file_id))
1773
return rev.timestamp
1775
def get_file_sha1(self, file_id, path=None, stat_value=None):
1776
entry = self._get_entry(file_id=file_id, path=path)
1777
parent_index = self._get_parent_index()
1778
parent_details = entry[1][parent_index]
1779
if parent_details[0] == 'f':
1780
return parent_details[1]
1783
def get_file(self, file_id, path=None):
1784
return StringIO(self.get_file_text(file_id))
1786
def get_file_size(self, file_id):
1787
"""See Tree.get_file_size"""
1788
return self.inventory[file_id].text_size
1790
def get_file_text(self, file_id, path=None):
1791
_, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1792
return ''.join(content)
1794
def get_reference_revision(self, file_id, path=None):
1795
return self.inventory[file_id].reference_revision
1797
def iter_files_bytes(self, desired_files):
1798
"""See Tree.iter_files_bytes.
1800
This version is implemented on top of Repository.iter_files_bytes"""
1801
parent_index = self._get_parent_index()
1802
repo_desired_files = []
1803
for file_id, identifier in desired_files:
1804
entry = self._get_entry(file_id)
1805
if entry == (None, None):
1806
raise errors.NoSuchId(self, file_id)
1807
repo_desired_files.append((file_id, entry[1][parent_index][4],
1809
return self._repository.iter_files_bytes(repo_desired_files)
1811
def get_symlink_target(self, file_id):
1812
entry = self._get_entry(file_id=file_id)
1813
parent_index = self._get_parent_index()
1814
if entry[1][parent_index][0] != 'l':
1817
target = entry[1][parent_index][1]
1818
target = target.decode('utf8')
1821
def get_revision_id(self):
1822
"""Return the revision id for this tree."""
1823
return self._revision_id
1825
def _get_inventory(self):
1826
if self._inventory is not None:
1827
return self._inventory
1828
self._must_be_locked()
1829
self._generate_inventory()
1830
return self._inventory
1832
inventory = property(_get_inventory,
1833
doc="Inventory of this Tree")
1835
def get_parent_ids(self):
1836
"""The parents of a tree in the dirstate are not cached."""
1837
return self._repository.get_revision(self._revision_id).parent_ids
1839
def has_filename(self, filename):
1840
return bool(self.path2id(filename))
1842
def kind(self, file_id):
1843
entry = self._get_entry(file_id=file_id)[1]
1845
raise errors.NoSuchId(tree=self, file_id=file_id)
1846
parent_index = self._get_parent_index()
1847
return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1849
def stored_kind(self, file_id):
1850
"""See Tree.stored_kind"""
1851
return self.kind(file_id)
1853
def path_content_summary(self, path):
1854
"""See Tree.path_content_summary."""
1855
id = self.inventory.path2id(path)
1857
return ('missing', None, None, None)
1858
entry = self._inventory[id]
1861
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1862
elif kind == 'symlink':
1863
return (kind, None, None, entry.symlink_target)
1865
return (kind, None, None, None)
1867
def is_executable(self, file_id, path=None):
1868
ie = self.inventory[file_id]
1869
if ie.kind != "file":
1871
return ie.executable
1873
def is_locked(self):
1876
def list_files(self, include_root=False, from_dir=None, recursive=True):
1877
# We use a standard implementation, because DirStateRevisionTree is
1878
# dealing with one of the parents of the current state
1879
inv = self._get_inventory()
1880
if from_dir is None:
1883
from_dir_id = inv.path2id(from_dir)
1884
if from_dir_id is None:
1885
# Directory not versioned
1887
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1888
if inv.root is not None and not include_root and from_dir is None:
1890
for path, entry in entries:
1891
yield path, 'V', entry.kind, entry.file_id, entry
1893
def lock_read(self):
1894
"""Lock the tree for a set of operations.
1896
:return: A bzrlib.lock.LogicalLockResult.
1898
if not self._locked:
1899
self._repository.lock_read()
1900
if self._dirstate._lock_token is None:
1901
self._dirstate.lock_read()
1902
self._dirstate_locked = True
1904
return LogicalLockResult(self.unlock)
1906
def _must_be_locked(self):
1907
if not self._locked:
1908
raise errors.ObjectNotLocked(self)
1911
def path2id(self, path):
1912
"""Return the id for path in this tree."""
1913
# lookup by path: faster than splitting and walking the ivnentory.
1914
entry = self._get_entry(path=path)
1915
if entry == (None, None):
1920
"""Unlock, freeing any cache memory used during the lock."""
1921
# outside of a lock, the inventory is suspect: release it.
1923
if not self._locked:
1924
self._inventory = None
1926
if self._dirstate_locked:
1927
self._dirstate.unlock()
1928
self._dirstate_locked = False
1929
self._repository.unlock()
1932
def supports_tree_reference(self):
1933
return self._repo_supports_tree_reference
1935
def walkdirs(self, prefix=""):
1936
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1937
# implementation based on an inventory.
1938
# This should be cleaned up to use the much faster Dirstate code
1939
# So for now, we just build up the parent inventory, and extract
1940
# it the same way RevisionTree does.
1941
_directory = 'directory'
1942
inv = self._get_inventory()
1943
top_id = inv.path2id(prefix)
1947
pending = [(prefix, top_id)]
1950
relpath, file_id = pending.pop()
1951
# 0 - relpath, 1- file-id
1953
relroot = relpath + '/'
1956
# FIXME: stash the node in pending
1957
entry = inv[file_id]
1958
for name, child in entry.sorted_children():
1959
toppath = relroot + name
1960
dirblock.append((toppath, name, child.kind, None,
1961
child.file_id, child.kind
1963
yield (relpath, entry.file_id), dirblock
1964
# push the user specified dirs from dirblock
1965
for dir in reversed(dirblock):
1966
if dir[2] == _directory:
1967
pending.append((dir[0], dir[4]))
1970
class InterDirStateTree(InterTree):
1971
"""Fast path optimiser for changes_from with dirstate trees.
1973
This is used only when both trees are in the dirstate working file, and
1974
the source is any parent within the dirstate, and the destination is
1975
the current working tree of the same dirstate.
1977
# this could be generalized to allow comparisons between any trees in the
1978
# dirstate, and possibly between trees stored in different dirstates.
1980
def __init__(self, source, target):
1981
super(InterDirStateTree, self).__init__(source, target)
1982
if not InterDirStateTree.is_compatible(source, target):
1983
raise Exception, "invalid source %r and target %r" % (source, target)
1986
def make_source_parent_tree(source, target):
1987
"""Change the source tree into a parent of the target."""
1988
revid = source.commit('record tree')
1989
target.branch.repository.fetch(source.branch.repository, revid)
1990
target.set_parent_ids([revid])
1991
return target.basis_tree(), target
1994
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1995
result = klass.make_source_parent_tree(source, target)
1996
result[1]._iter_changes = dirstate.ProcessEntryPython
2000
def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
2002
from bzrlib.tests.test__dirstate_helpers import \
2003
compiled_dirstate_helpers_feature
2004
test_case.requireFeature(compiled_dirstate_helpers_feature)
2005
from bzrlib._dirstate_helpers_pyx import ProcessEntryC
2006
result = klass.make_source_parent_tree(source, target)
2007
result[1]._iter_changes = ProcessEntryC
2010
_matching_from_tree_format = WorkingTreeFormat4()
2011
_matching_to_tree_format = WorkingTreeFormat4()
2014
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
2015
# This method shouldn't be called, because we have python and C
2016
# specific flavours.
2017
raise NotImplementedError
2019
def iter_changes(self, include_unchanged=False,
2020
specific_files=None, pb=None, extra_trees=[],
2021
require_versioned=True, want_unversioned=False):
2022
"""Return the changes from source to target.
2024
:return: An iterator that yields tuples. See InterTree.iter_changes
2026
:param specific_files: An optional list of file paths to restrict the
2027
comparison to. When mapping filenames to ids, all matches in all
2028
trees (including optional extra_trees) are used, and all children of
2029
matched directories are included.
2030
:param include_unchanged: An optional boolean requesting the inclusion of
2031
unchanged entries in the result.
2032
:param extra_trees: An optional list of additional trees to use when
2033
mapping the contents of specific_files (paths) to file_ids.
2034
:param require_versioned: If True, all files in specific_files must be
2035
versioned in one of source, target, extra_trees or
2036
PathsNotVersionedError is raised.
2037
:param want_unversioned: Should unversioned files be returned in the
2038
output. An unversioned file is defined as one with (False, False)
2039
for the versioned pair.
2041
# TODO: handle extra trees in the dirstate.
2042
if (extra_trees or specific_files == []):
2043
# we can't fast-path these cases (yet)
2044
return super(InterDirStateTree, self).iter_changes(
2045
include_unchanged, specific_files, pb, extra_trees,
2046
require_versioned, want_unversioned=want_unversioned)
2047
parent_ids = self.target.get_parent_ids()
2048
if not (self.source._revision_id in parent_ids
2049
or self.source._revision_id == _mod_revision.NULL_REVISION):
2050
raise AssertionError(
2051
"revision {%s} is not stored in {%s}, but %s "
2052
"can only be used for trees stored in the dirstate"
2053
% (self.source._revision_id, self.target, self.iter_changes))
2055
if self.source._revision_id == _mod_revision.NULL_REVISION:
2057
indices = (target_index,)
2059
if not (self.source._revision_id in parent_ids):
2060
raise AssertionError(
2061
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2062
self.source._revision_id, parent_ids))
2063
source_index = 1 + parent_ids.index(self.source._revision_id)
2064
indices = (source_index, target_index)
2065
# -- make all specific_files utf8 --
2067
specific_files_utf8 = set()
2068
for path in specific_files:
2069
# Note, if there are many specific files, using cache_utf8
2070
# would be good here.
2071
specific_files_utf8.add(path.encode('utf8'))
2072
specific_files = specific_files_utf8
2074
specific_files = set([''])
2075
# -- specific_files is now a utf8 path set --
2077
# -- get the state object and prepare it.
2078
state = self.target.current_dirstate()
2079
state._read_dirblocks_if_needed()
2080
if require_versioned:
2081
# -- check all supplied paths are versioned in a search tree. --
2083
for path in specific_files:
2084
path_entries = state._entries_for_path(path)
2085
if not path_entries:
2086
# this specified path is not present at all: error
2087
not_versioned.append(path)
2089
found_versioned = False
2090
# for each id at this path
2091
for entry in path_entries:
2093
for index in indices:
2094
if entry[1][index][0] != 'a': # absent
2095
found_versioned = True
2096
# all good: found a versioned cell
2098
if not found_versioned:
2099
# none of the indexes was not 'absent' at all ids for this
2101
not_versioned.append(path)
2102
if len(not_versioned) > 0:
2103
raise errors.PathsNotVersionedError(not_versioned)
2104
# -- remove redundancy in supplied specific_files to prevent over-scanning --
2105
search_specific_files = osutils.minimum_path_selection(specific_files)
2107
use_filesystem_for_exec = (sys.platform != 'win32')
2108
iter_changes = self.target._iter_changes(include_unchanged,
2109
use_filesystem_for_exec, search_specific_files, state,
2110
source_index, target_index, want_unversioned, self.target)
2111
return iter_changes.iter_changes()
2114
def is_compatible(source, target):
2115
# the target must be a dirstate working tree
2116
if not isinstance(target, DirStateWorkingTree):
2118
# the source must be a revtree or dirstate rev tree.
2119
if not isinstance(source,
2120
(revisiontree.RevisionTree, DirStateRevisionTree)):
2122
# the source revid must be in the target dirstate
2123
if not (source._revision_id == _mod_revision.NULL_REVISION or
2124
source._revision_id in target.get_parent_ids()):
2125
# TODO: what about ghosts? it may well need to
2126
# check for them explicitly.
2130
InterTree.register_optimiser(InterDirStateTree)
2133
class Converter3to4(object):
2134
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2137
self.target_format = WorkingTreeFormat4()
2139
def convert(self, tree):
2140
# lock the control files not the tree, so that we dont get tree
2141
# on-unlock behaviours, and so that noone else diddles with the
2142
# tree during upgrade.
2143
tree._control_files.lock_write()
2145
tree.read_working_inventory()
2146
self.create_dirstate_data(tree)
2147
self.update_format(tree)
2148
self.remove_xml_files(tree)
2150
tree._control_files.unlock()
2152
def create_dirstate_data(self, tree):
2153
"""Create the dirstate based data for tree."""
2154
local_path = tree.bzrdir.get_workingtree_transport(None
2155
).local_abspath('dirstate')
2156
state = dirstate.DirState.from_tree(tree, local_path)
2160
def remove_xml_files(self, tree):
2161
"""Remove the oldformat 3 data."""
2162
transport = tree.bzrdir.get_workingtree_transport(None)
2163
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2164
'pending-merges', 'stat-cache']:
2166
transport.delete(path)
2167
except errors.NoSuchFile:
2168
# some files are optional - just deal.
2171
def update_format(self, tree):
2172
"""Change the format marker."""
2173
tree._transport.put_bytes('format',
2174
self.target_format.get_format_string(),
2175
mode=tree.bzrdir._get_file_mode())
2178
class Converter4to5(object):
2179
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2182
self.target_format = WorkingTreeFormat5()
2184
def convert(self, tree):
2185
# lock the control files not the tree, so that we don't get tree
2186
# on-unlock behaviours, and so that no-one else diddles with the
2187
# tree during upgrade.
2188
tree._control_files.lock_write()
2190
self.update_format(tree)
2192
tree._control_files.unlock()
2194
def update_format(self, tree):
2195
"""Change the format marker."""
2196
tree._transport.put_bytes('format',
2197
self.target_format.get_format_string(),
2198
mode=tree.bzrdir._get_file_mode())
2201
class Converter4or5to6(object):
2202
"""Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2205
self.target_format = WorkingTreeFormat6()
2207
def convert(self, tree):
2208
# lock the control files not the tree, so that we don't get tree
2209
# on-unlock behaviours, and so that no-one else diddles with the
2210
# tree during upgrade.
2211
tree._control_files.lock_write()
2213
self.init_custom_control_files(tree)
2214
self.update_format(tree)
2216
tree._control_files.unlock()
2218
def init_custom_control_files(self, tree):
2219
"""Initialize custom control files."""
2220
tree._transport.put_bytes('views', '',
2221
mode=tree.bzrdir._get_file_mode())
2223
def update_format(self, tree):
2224
"""Change the format marker."""
2225
tree._transport.put_bytes('format',
2226
self.target_format.get_format_string(),
2227
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
