1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
import bzrlib.mutabletree
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')))
439
def id2path(self, file_id):
440
"Convert a file-id to a path."
441
state = self.current_dirstate()
442
entry = self._get_entry(file_id=file_id)
443
if entry == (None, None):
444
raise errors.NoSuchId(tree=self, file_id=file_id)
445
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
446
return path_utf8.decode('utf8')
448
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
449
entry = self._get_entry(path=path)
450
if entry == (None, None):
451
return False # Missing entries are not executable
452
return entry[1][0][3] # Executable?
454
if not osutils.supports_executable():
455
def is_executable(self, file_id, path=None):
456
"""Test if a file is executable or not.
458
Note: The caller is expected to take a read-lock before calling this.
460
entry = self._get_entry(file_id=file_id, path=path)
461
if entry == (None, None):
463
return entry[1][0][3]
465
_is_executable_from_path_and_stat = \
466
_is_executable_from_path_and_stat_from_basis
468
def is_executable(self, file_id, path=None):
469
"""Test if a file is executable or not.
471
Note: The caller is expected to take a read-lock before calling this.
473
self._must_be_locked()
475
path = self.id2path(file_id)
476
mode = os.lstat(self.abspath(path)).st_mode
477
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
479
def all_file_ids(self):
480
"""See Tree.iter_all_file_ids"""
481
self._must_be_locked()
483
for key, tree_details in self.current_dirstate()._iter_entries():
484
if tree_details[0][0] in ('a', 'r'): # relocated
491
"""Iterate through file_ids for this tree.
493
file_ids are in a WorkingTree if they are in the working inventory
494
and the working file exists.
497
for key, tree_details in self.current_dirstate()._iter_entries():
498
if tree_details[0][0] in ('a', 'r'): # absent, relocated
499
# not relevant to the working tree
501
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
502
if osutils.lexists(path):
503
result.append(key[2])
506
def iter_references(self):
507
if not self._repo_supports_tree_reference:
508
# When the repo doesn't support references, we will have nothing to
511
for key, tree_details in self.current_dirstate()._iter_entries():
512
if tree_details[0][0] in ('a', 'r'): # absent, relocated
513
# not relevant to the working tree
516
# the root is not a reference.
518
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
520
if self._kind(relpath) == 'tree-reference':
521
yield relpath, key[2]
522
except errors.NoSuchFile:
523
# path is missing on disk.
526
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
527
"""See MutableTree._observed_sha1."""
528
state = self.current_dirstate()
529
entry = self._get_entry(file_id=file_id, path=path)
530
state._observed_sha1(entry, sha1, statvalue)
532
def kind(self, file_id):
533
"""Return the kind of a file.
535
This is always the actual kind that's on disk, regardless of what it
538
Note: The caller is expected to take a read-lock before calling this.
540
relpath = self.id2path(file_id)
542
raise AssertionError(
543
"path for id {%s} is None!" % file_id)
544
return self._kind(relpath)
546
def _kind(self, relpath):
547
abspath = self.abspath(relpath)
548
kind = file_kind(abspath)
549
if (self._repo_supports_tree_reference and kind == 'directory'):
550
entry = self._get_entry(path=relpath)
551
if entry[1] is not None:
552
if entry[1][0][0] == 't':
553
kind = 'tree-reference'
557
def _last_revision(self):
558
"""See Mutable.last_revision."""
559
parent_ids = self.current_dirstate().get_parent_ids()
563
return _mod_revision.NULL_REVISION
566
"""See Branch.lock_read, and WorkingTree.unlock."""
567
self.branch.lock_read()
569
self._control_files.lock_read()
571
state = self.current_dirstate()
572
if not state._lock_token:
574
# set our support for tree references from the repository in
576
self._repo_supports_tree_reference = getattr(
577
self.branch.repository._format, "supports_tree_reference",
580
self._control_files.unlock()
586
def _lock_self_write(self):
587
"""This should be called after the branch is locked."""
589
self._control_files.lock_write()
591
state = self.current_dirstate()
592
if not state._lock_token:
594
# set our support for tree references from the repository in
596
self._repo_supports_tree_reference = getattr(
597
self.branch.repository._format, "supports_tree_reference",
600
self._control_files.unlock()
606
def lock_tree_write(self):
607
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
608
self.branch.lock_read()
609
self._lock_self_write()
611
def lock_write(self):
612
"""See MutableTree.lock_write, and WorkingTree.unlock."""
613
self.branch.lock_write()
614
self._lock_self_write()
616
@needs_tree_write_lock
617
def move(self, from_paths, to_dir, after=False):
618
"""See WorkingTree.move()."""
622
state = self.current_dirstate()
623
if isinstance(from_paths, basestring):
625
to_dir_utf8 = to_dir.encode('utf8')
626
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
627
id_index = state._get_id_index()
628
# check destination directory
629
# get the details for it
630
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
631
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
632
if not entry_present:
633
raise errors.BzrMoveFailedError('', to_dir,
634
errors.NotVersionedError(to_dir))
635
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
636
# get a handle on the block itself.
637
to_block_index = state._ensure_block(
638
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
639
to_block = state._dirblocks[to_block_index]
640
to_abs = self.abspath(to_dir)
641
if not isdir(to_abs):
642
raise errors.BzrMoveFailedError('',to_dir,
643
errors.NotADirectory(to_abs))
645
if to_entry[1][0][0] != 'd':
646
raise errors.BzrMoveFailedError('',to_dir,
647
errors.NotADirectory(to_abs))
649
if self._inventory is not None:
650
update_inventory = True
652
to_dir_id = to_entry[0][2]
653
to_dir_ie = inv[to_dir_id]
655
update_inventory = False
658
def move_one(old_entry, from_path_utf8, minikind, executable,
659
fingerprint, packed_stat, size,
660
to_block, to_key, to_path_utf8):
661
state._make_absent(old_entry)
662
from_key = old_entry[0]
664
lambda:state.update_minimal(from_key,
666
executable=executable,
667
fingerprint=fingerprint,
668
packed_stat=packed_stat,
670
path_utf8=from_path_utf8))
671
state.update_minimal(to_key,
673
executable=executable,
674
fingerprint=fingerprint,
675
packed_stat=packed_stat,
677
path_utf8=to_path_utf8)
678
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
679
new_entry = to_block[1][added_entry_index]
680
rollbacks.append(lambda:state._make_absent(new_entry))
682
for from_rel in from_paths:
683
# from_rel is 'pathinroot/foo/bar'
684
from_rel_utf8 = from_rel.encode('utf8')
685
from_dirname, from_tail = osutils.split(from_rel)
686
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
687
from_entry = self._get_entry(path=from_rel)
688
if from_entry == (None, None):
689
raise errors.BzrMoveFailedError(from_rel,to_dir,
690
errors.NotVersionedError(path=from_rel))
692
from_id = from_entry[0][2]
693
to_rel = pathjoin(to_dir, from_tail)
694
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
695
item_to_entry = self._get_entry(path=to_rel)
696
if item_to_entry != (None, None):
697
raise errors.BzrMoveFailedError(from_rel, to_rel,
698
"Target is already versioned.")
700
if from_rel == to_rel:
701
raise errors.BzrMoveFailedError(from_rel, to_rel,
702
"Source and target are identical.")
704
from_missing = not self.has_filename(from_rel)
705
to_missing = not self.has_filename(to_rel)
712
raise errors.BzrMoveFailedError(from_rel, to_rel,
713
errors.NoSuchFile(path=to_rel,
714
extra="New file has not been created yet"))
716
# neither path exists
717
raise errors.BzrRenameFailedError(from_rel, to_rel,
718
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
720
if from_missing: # implicitly just update our path mapping
723
raise errors.RenameFailedFilesExist(from_rel, to_rel)
726
def rollback_rename():
727
"""A single rename has failed, roll it back."""
728
# roll back everything, even if we encounter trouble doing one
731
# TODO: at least log the other exceptions rather than just
732
# losing them mbp 20070307
734
for rollback in reversed(rollbacks):
738
exc_info = sys.exc_info()
740
raise exc_info[0], exc_info[1], exc_info[2]
742
# perform the disk move first - its the most likely failure point.
744
from_rel_abs = self.abspath(from_rel)
745
to_rel_abs = self.abspath(to_rel)
747
osutils.rename(from_rel_abs, to_rel_abs)
749
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
750
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
752
# perform the rename in the inventory next if needed: its easy
756
from_entry = inv[from_id]
757
current_parent = from_entry.parent_id
758
inv.rename(from_id, to_dir_id, from_tail)
760
lambda: inv.rename(from_id, current_parent, from_tail))
761
# finally do the rename in the dirstate, which is a little
762
# tricky to rollback, but least likely to need it.
763
old_block_index, old_entry_index, dir_present, file_present = \
764
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
765
old_block = state._dirblocks[old_block_index][1]
766
old_entry = old_block[old_entry_index]
767
from_key, old_entry_details = old_entry
768
cur_details = old_entry_details[0]
770
to_key = ((to_block[0],) + from_key[1:3])
771
minikind = cur_details[0]
772
move_one(old_entry, from_path_utf8=from_rel_utf8,
774
executable=cur_details[3],
775
fingerprint=cur_details[1],
776
packed_stat=cur_details[4],
780
to_path_utf8=to_rel_utf8)
783
def update_dirblock(from_dir, to_key, to_dir_utf8):
784
"""Recursively update all entries in this dirblock."""
786
raise AssertionError("renaming root not supported")
787
from_key = (from_dir, '')
788
from_block_idx, present = \
789
state._find_block_index_from_key(from_key)
791
# This is the old record, if it isn't present, then
792
# there is theoretically nothing to update.
793
# (Unless it isn't present because of lazy loading,
794
# but we don't do that yet)
796
from_block = state._dirblocks[from_block_idx]
797
to_block_index, to_entry_index, _, _ = \
798
state._get_block_entry_index(to_key[0], to_key[1], 0)
799
to_block_index = state._ensure_block(
800
to_block_index, to_entry_index, to_dir_utf8)
801
to_block = state._dirblocks[to_block_index]
803
# Grab a copy since move_one may update the list.
804
for entry in from_block[1][:]:
805
if not (entry[0][0] == from_dir):
806
raise AssertionError()
807
cur_details = entry[1][0]
808
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
809
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
810
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
811
minikind = cur_details[0]
813
# Deleted children of a renamed directory
814
# Do not need to be updated.
815
# Children that have been renamed out of this
816
# directory should also not be updated
818
move_one(entry, from_path_utf8=from_path_utf8,
820
executable=cur_details[3],
821
fingerprint=cur_details[1],
822
packed_stat=cur_details[4],
826
to_path_utf8=to_path_utf8)
828
# We need to move all the children of this
830
update_dirblock(from_path_utf8, to_key,
832
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
836
result.append((from_rel, to_rel))
837
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
838
self._make_dirty(reset_inventory=False)
842
def _must_be_locked(self):
843
if not self._control_files._lock_count:
844
raise errors.ObjectNotLocked(self)
847
"""Initialize the state in this tree to be a new tree."""
851
def path2id(self, path):
852
"""Return the id for path in this tree."""
853
path = path.strip('/')
854
entry = self._get_entry(path=path)
855
if entry == (None, None):
859
def paths2ids(self, paths, trees=[], require_versioned=True):
860
"""See Tree.paths2ids().
862
This specialisation fast-paths the case where all the trees are in the
867
parents = self.get_parent_ids()
869
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
871
return super(DirStateWorkingTree, self).paths2ids(paths,
872
trees, require_versioned)
873
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
874
# -- make all paths utf8 --
877
paths_utf8.add(path.encode('utf8'))
879
# -- paths is now a utf8 path set --
880
# -- get the state object and prepare it.
881
state = self.current_dirstate()
882
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
883
and '' not in paths):
884
paths2ids = self._paths2ids_using_bisect
886
paths2ids = self._paths2ids_in_memory
887
return paths2ids(paths, search_indexes,
888
require_versioned=require_versioned)
890
def _paths2ids_in_memory(self, paths, search_indexes,
891
require_versioned=True):
892
state = self.current_dirstate()
893
state._read_dirblocks_if_needed()
894
def _entries_for_path(path):
895
"""Return a list with all the entries that match path for all ids.
897
dirname, basename = os.path.split(path)
898
key = (dirname, basename, '')
899
block_index, present = state._find_block_index_from_key(key)
901
# the block which should contain path is absent.
904
block = state._dirblocks[block_index][1]
905
entry_index, _ = state._find_entry_index(key, block)
906
# we may need to look at multiple entries at this path: walk while the paths match.
907
while (entry_index < len(block) and
908
block[entry_index][0][0:2] == key[0:2]):
909
result.append(block[entry_index])
912
if require_versioned:
913
# -- check all supplied paths are versioned in a search tree. --
916
path_entries = _entries_for_path(path)
918
# this specified path is not present at all: error
919
all_versioned = False
921
found_versioned = False
922
# for each id at this path
923
for entry in path_entries:
925
for index in search_indexes:
926
if entry[1][index][0] != 'a': # absent
927
found_versioned = True
928
# all good: found a versioned cell
930
if not found_versioned:
931
# none of the indexes was not 'absent' at all ids for this
933
all_versioned = False
935
if not all_versioned:
936
raise errors.PathsNotVersionedError(paths)
937
# -- remove redundancy in supplied paths to prevent over-scanning --
938
search_paths = osutils.minimum_path_selection(paths)
940
# for all search_indexs in each path at or under each element of
941
# search_paths, if the detail is relocated: add the id, and add the
942
# relocated path as one to search if its not searched already. If the
943
# detail is not relocated, add the id.
944
searched_paths = set()
946
def _process_entry(entry):
947
"""Look at search_indexes within entry.
949
If a specific tree's details are relocated, add the relocation
950
target to search_paths if not searched already. If it is absent, do
951
nothing. Otherwise add the id to found_ids.
953
for index in search_indexes:
954
if entry[1][index][0] == 'r': # relocated
955
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
956
search_paths.add(entry[1][index][1])
957
elif entry[1][index][0] != 'a': # absent
958
found_ids.add(entry[0][2])
960
current_root = search_paths.pop()
961
searched_paths.add(current_root)
962
# process the entries for this containing directory: the rest will be
963
# found by their parents recursively.
964
root_entries = _entries_for_path(current_root)
966
# this specified path is not present at all, skip it.
968
for entry in root_entries:
969
_process_entry(entry)
970
initial_key = (current_root, '', '')
971
block_index, _ = state._find_block_index_from_key(initial_key)
972
while (block_index < len(state._dirblocks) and
973
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
974
for entry in state._dirblocks[block_index][1]:
975
_process_entry(entry)
979
def _paths2ids_using_bisect(self, paths, search_indexes,
980
require_versioned=True):
981
state = self.current_dirstate()
984
split_paths = sorted(osutils.split(p) for p in paths)
985
found = state._bisect_recursive(split_paths)
987
if require_versioned:
988
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
989
for dir_name in split_paths:
990
if dir_name not in found_dir_names:
991
raise errors.PathsNotVersionedError(paths)
993
for dir_name_id, trees_info in found.iteritems():
994
for index in search_indexes:
995
if trees_info[index][0] not in ('r', 'a'):
996
found_ids.add(dir_name_id[2])
999
def read_working_inventory(self):
1000
"""Read the working inventory.
1002
This is a meaningless operation for dirstate, but we obey it anyhow.
1004
return self.inventory
1007
def revision_tree(self, revision_id):
1008
"""See Tree.revision_tree.
1010
WorkingTree4 supplies revision_trees for any basis tree.
1012
dirstate = self.current_dirstate()
1013
parent_ids = dirstate.get_parent_ids()
1014
if revision_id not in parent_ids:
1015
raise errors.NoSuchRevisionInTree(self, revision_id)
1016
if revision_id in dirstate.get_ghosts():
1017
raise errors.NoSuchRevisionInTree(self, revision_id)
1018
return DirStateRevisionTree(dirstate, revision_id,
1019
self.branch.repository)
1021
@needs_tree_write_lock
1022
def set_last_revision(self, new_revision):
1023
"""Change the last revision in the working tree."""
1024
parents = self.get_parent_ids()
1025
if new_revision in (_mod_revision.NULL_REVISION, None):
1026
if len(parents) >= 2:
1027
raise AssertionError(
1028
"setting the last parent to none with a pending merge is "
1030
self.set_parent_ids([])
1032
self.set_parent_ids([new_revision] + parents[1:],
1033
allow_leftmost_as_ghost=True)
1035
@needs_tree_write_lock
1036
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1037
"""Set the parent ids to revision_ids.
1039
See also set_parent_trees. This api will try to retrieve the tree data
1040
for each element of revision_ids from the trees repository. If you have
1041
tree data already available, it is more efficient to use
1042
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1043
an easier API to use.
1045
:param revision_ids: The revision_ids to set as the parent ids of this
1046
working tree. Any of these may be ghosts.
1049
for revision_id in revision_ids:
1051
revtree = self.branch.repository.revision_tree(revision_id)
1052
# TODO: jam 20070213 KnitVersionedFile raises
1053
# RevisionNotPresent rather than NoSuchRevision if a
1054
# given revision_id is not present. Should Repository be
1055
# catching it and re-raising NoSuchRevision?
1056
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1058
trees.append((revision_id, revtree))
1059
self.set_parent_trees(trees,
1060
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1062
@needs_tree_write_lock
1063
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1064
"""Set the parents of the working tree.
1066
:param parents_list: A list of (revision_id, tree) tuples.
1067
If tree is None, then that element is treated as an unreachable
1068
parent tree - i.e. a ghost.
1070
dirstate = self.current_dirstate()
1071
if len(parents_list) > 0:
1072
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1073
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1077
parent_ids = [rev_id for rev_id, tree in parents_list]
1078
graph = self.branch.repository.get_graph()
1079
heads = graph.heads(parent_ids)
1080
accepted_revisions = set()
1082
# convert absent trees to the null tree, which we convert back to
1083
# missing on access.
1084
for rev_id, tree in parents_list:
1085
if len(accepted_revisions) > 0:
1086
# we always accept the first tree
1087
if rev_id in accepted_revisions or rev_id not in heads:
1088
# We have already included either this tree, or its
1089
# descendent, so we skip it.
1091
_mod_revision.check_not_reserved_id(rev_id)
1092
if tree is not None:
1093
real_trees.append((rev_id, tree))
1095
real_trees.append((rev_id,
1096
self.branch.repository.revision_tree(
1097
_mod_revision.NULL_REVISION)))
1098
ghosts.append(rev_id)
1099
accepted_revisions.add(rev_id)
1100
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1101
self._make_dirty(reset_inventory=False)
1103
def _set_root_id(self, file_id):
1104
"""See WorkingTree.set_root_id."""
1105
state = self.current_dirstate()
1106
state.set_path_id('', file_id)
1107
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1108
self._make_dirty(reset_inventory=True)
1110
def _sha_from_stat(self, path, stat_result):
1111
"""Get a sha digest from the tree's stat cache.
1113
The default implementation assumes no stat cache is present.
1115
:param path: The path.
1116
:param stat_result: The stat result being looked up.
1118
return self.current_dirstate().sha1_from_stat(path, stat_result)
1121
def supports_tree_reference(self):
1122
return self._repo_supports_tree_reference
1125
"""Unlock in format 4 trees needs to write the entire dirstate."""
1126
# do non-implementation specific cleanup
1129
if self._control_files._lock_count == 1:
1130
# eventually we should do signature checking during read locks for
1132
if self._control_files._lock_mode == 'w':
1135
if self._dirstate is not None:
1136
# This is a no-op if there are no modifications.
1137
self._dirstate.save()
1138
self._dirstate.unlock()
1139
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1140
# point. Instead, it could check if the header has been
1141
# modified when it is locked, and if not, it can hang on to
1142
# the data it has in memory.
1143
self._dirstate = None
1144
self._inventory = None
1145
# reverse order of locking.
1147
return self._control_files.unlock()
1149
self.branch.unlock()
1151
@needs_tree_write_lock
1152
def unversion(self, file_ids):
1153
"""Remove the file ids in file_ids from the current versioned set.
1155
When a file_id is unversioned, all of its children are automatically
1158
:param file_ids: The file ids to stop versioning.
1159
:raises: NoSuchId if any fileid is not currently versioned.
1163
state = self.current_dirstate()
1164
state._read_dirblocks_if_needed()
1165
ids_to_unversion = set(file_ids)
1166
paths_to_unversion = set()
1168
# check if the root is to be unversioned, if so, assert for now.
1169
# walk the state marking unversioned things as absent.
1170
# if there are any un-unversioned ids at the end, raise
1171
for key, details in state._dirblocks[0][1]:
1172
if (details[0][0] not in ('a', 'r') and # absent or relocated
1173
key[2] in ids_to_unversion):
1174
# I haven't written the code to unversion / yet - it should be
1176
raise errors.BzrError('Unversioning the / is not currently supported')
1178
while block_index < len(state._dirblocks):
1179
# process one directory at a time.
1180
block = state._dirblocks[block_index]
1181
# first check: is the path one to remove - it or its children
1182
delete_block = False
1183
for path in paths_to_unversion:
1184
if (block[0].startswith(path) and
1185
(len(block[0]) == len(path) or
1186
block[0][len(path)] == '/')):
1187
# this entire block should be deleted - its the block for a
1188
# path to unversion; or the child of one
1191
# TODO: trim paths_to_unversion as we pass by paths
1193
# this block is to be deleted: process it.
1194
# TODO: we can special case the no-parents case and
1195
# just forget the whole block.
1197
while entry_index < len(block[1]):
1198
# Mark this file id as having been removed
1199
entry = block[1][entry_index]
1200
ids_to_unversion.discard(entry[0][2])
1201
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1203
or not state._make_absent(entry)):
1205
# go to the next block. (At the moment we dont delete empty
1210
while entry_index < len(block[1]):
1211
entry = block[1][entry_index]
1212
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1213
# ^ some parent row.
1214
entry[0][2] not in ids_to_unversion):
1215
# ^ not an id to unversion
1218
if entry[1][0][0] == 'd':
1219
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1220
if not state._make_absent(entry):
1222
# we have unversioned this id
1223
ids_to_unversion.remove(entry[0][2])
1225
if ids_to_unversion:
1226
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1227
self._make_dirty(reset_inventory=False)
1228
# have to change the legacy inventory too.
1229
if self._inventory is not None:
1230
for file_id in file_ids:
1231
self._inventory.remove_recursive_id(file_id)
1233
@needs_tree_write_lock
1234
def rename_one(self, from_rel, to_rel, after=False):
1235
"""See WorkingTree.rename_one"""
1237
WorkingTree.rename_one(self, from_rel, to_rel, after)
1239
@needs_tree_write_lock
1240
def apply_inventory_delta(self, changes):
1241
"""See MutableTree.apply_inventory_delta"""
1242
state = self.current_dirstate()
1243
state.update_by_delta(changes)
1244
self._make_dirty(reset_inventory=True)
1246
def update_basis_by_delta(self, new_revid, delta):
1247
"""See MutableTree.update_basis_by_delta."""
1248
if self.last_revision() == new_revid:
1249
raise AssertionError()
1250
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1253
def _validate(self):
1254
self._dirstate._validate()
1256
@needs_tree_write_lock
1257
def _write_inventory(self, inv):
1258
"""Write inventory as the current inventory."""
1260
raise AssertionError("attempting to write an inventory when the "
1261
"dirstate is dirty will lose pending changes")
1262
self.current_dirstate().set_state_from_inventory(inv)
1263
self._make_dirty(reset_inventory=False)
1264
if self._inventory is not None:
1265
self._inventory = inv
1269
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1271
def __init__(self, tree):
1274
def sha1(self, abspath):
1275
"""See dirstate.SHA1Provider.sha1()."""
1276
filters = self.tree._content_filter_stack(
1277
self.tree.relpath(osutils.safe_unicode(abspath)))
1278
return internal_size_sha_file_byname(abspath, filters)[1]
1280
def stat_and_sha1(self, abspath):
1281
"""See dirstate.SHA1Provider.stat_and_sha1()."""
1282
filters = self.tree._content_filter_stack(
1283
self.tree.relpath(osutils.safe_unicode(abspath)))
1284
file_obj = file(abspath, 'rb', 65000)
1286
statvalue = os.fstat(file_obj.fileno())
1288
file_obj = filtered_input_file(file_obj, filters)
1289
sha1 = osutils.size_sha_file(file_obj)[1]
1292
return statvalue, sha1
1295
class WorkingTree4(DirStateWorkingTree):
1296
"""This is the Format 4 working tree.
1298
This differs from WorkingTree3 by:
1299
- Having a consolidated internal dirstate, stored in a
1300
randomly-accessible sorted file on disk.
1301
- Not having a regular inventory attribute. One can be synthesized
1302
on demand but this is expensive and should be avoided.
1304
This is new in bzr 0.15.
1308
class WorkingTree5(DirStateWorkingTree):
1309
"""This is the Format 5 working tree.
1311
This differs from WorkingTree4 by:
1312
- Supporting content filtering.
1314
This is new in bzr 1.11.
1318
class WorkingTree6(DirStateWorkingTree):
1319
"""This is the Format 6 working tree.
1321
This differs from WorkingTree5 by:
1322
- Supporting a current view that may mask the set of files in a tree
1323
impacted by most user operations.
1325
This is new in bzr 1.14.
1328
def _make_views(self):
1329
return views.PathBasedViews(self)
1332
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1333
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1334
accelerator_tree=None, hardlink=False):
1335
"""See WorkingTreeFormat.initialize().
1337
:param revision_id: allows creating a working tree at a different
1338
revision than the branch is at.
1339
:param accelerator_tree: A tree which can be used for retrieving file
1340
contents more quickly than the revision tree, i.e. a workingtree.
1341
The revision tree will be used for cases where accelerator_tree's
1342
content is different.
1343
:param hardlink: If true, hard-link files from accelerator_tree,
1346
These trees get an initial random root id, if their repository supports
1347
rich root data, TREE_ROOT otherwise.
1349
if not isinstance(a_bzrdir.transport, LocalTransport):
1350
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1351
transport = a_bzrdir.get_workingtree_transport(self)
1352
control_files = self._open_control_files(a_bzrdir)
1353
control_files.create_lock()
1354
control_files.lock_write()
1355
transport.put_bytes('format', self.get_format_string(),
1356
mode=a_bzrdir._get_file_mode())
1357
if from_branch is not None:
1358
branch = from_branch
1360
branch = a_bzrdir.open_branch()
1361
if revision_id is None:
1362
revision_id = branch.last_revision()
1363
local_path = transport.local_abspath('dirstate')
1364
# write out new dirstate (must exist when we create the tree)
1365
state = dirstate.DirState.initialize(local_path)
1368
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1372
_control_files=control_files)
1374
wt.lock_tree_write()
1376
self._init_custom_control_files(wt)
1377
if revision_id in (None, _mod_revision.NULL_REVISION):
1378
if branch.repository.supports_rich_root():
1379
wt._set_root_id(generate_ids.gen_root_id())
1381
wt._set_root_id(ROOT_ID)
1384
# frequently, we will get here due to branching. The accelerator
1385
# tree will be the tree from the branch, so the desired basis
1386
# tree will often be a parent of the accelerator tree.
1387
if accelerator_tree is not None:
1389
basis = accelerator_tree.revision_tree(revision_id)
1390
except errors.NoSuchRevision:
1393
basis = branch.repository.revision_tree(revision_id)
1394
if revision_id == _mod_revision.NULL_REVISION:
1397
parents_list = [(revision_id, basis)]
1400
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1402
# if the basis has a root id we have to use that; otherwise we
1403
# use a new random one
1404
basis_root_id = basis.get_root_id()
1405
if basis_root_id is not None:
1406
wt._set_root_id(basis_root_id)
1408
# If content filtering is supported, do not use the accelerator
1409
# tree - the cost of transforming the content both ways and
1410
# checking for changed content can outweight the gains it gives.
1411
# Note: do NOT move this logic up higher - using the basis from
1412
# the accelerator tree is still desirable because that can save
1413
# a minute or more of processing on large trees!
1414
# The original tree may not have the same content filters
1415
# applied so we can't safely build the inventory delta from
1417
if wt.supports_content_filtering():
1418
accelerator_tree = None
1419
delta_from_tree = False
1421
delta_from_tree = True
1422
# delta_from_tree is safe even for DirStateRevisionTrees,
1423
# because wt4.apply_inventory_delta does not mutate the input
1424
# inventory entries.
1425
transform.build_tree(basis, wt, accelerator_tree,
1427
delta_from_tree=delta_from_tree)
1431
control_files.unlock()
1435
def _init_custom_control_files(self, wt):
1436
"""Subclasses with custom control files should override this method.
1438
The working tree and control files are locked for writing when this
1441
:param wt: the WorkingTree object
1444
def _open(self, a_bzrdir, control_files):
1445
"""Open the tree itself.
1447
:param a_bzrdir: the dir for the tree.
1448
:param control_files: the control files for the tree.
1450
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1451
branch=a_bzrdir.open_branch(),
1454
_control_files=control_files)
1456
def __get_matchingbzrdir(self):
1457
return self._get_matchingbzrdir()
1459
def _get_matchingbzrdir(self):
1460
"""Overrideable method to get a bzrdir for testing."""
1461
# please test against something that will let us do tree references
1462
return bzrdir.format_registry.make_bzrdir(
1463
'dirstate-with-subtree')
1465
_matchingbzrdir = property(__get_matchingbzrdir)
1468
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1469
"""The first consolidated dirstate working tree format.
1472
- exists within a metadir controlling .bzr
1473
- includes an explicit version marker for the workingtree control
1474
files, separate from the BzrDir format
1475
- modifies the hash cache format
1476
- is new in bzr 0.15
1477
- uses a LockDir to guard access to it.
1480
upgrade_recommended = False
1482
_tree_class = WorkingTree4
1484
def get_format_string(self):
1485
"""See WorkingTreeFormat.get_format_string()."""
1486
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1488
def get_format_description(self):
1489
"""See WorkingTreeFormat.get_format_description()."""
1490
return "Working tree format 4"
1493
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1494
"""WorkingTree format supporting content filtering.
1497
upgrade_recommended = False
1499
_tree_class = WorkingTree5
1501
def get_format_string(self):
1502
"""See WorkingTreeFormat.get_format_string()."""
1503
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1505
def get_format_description(self):
1506
"""See WorkingTreeFormat.get_format_description()."""
1507
return "Working tree format 5"
1509
def supports_content_filtering(self):
1513
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1514
"""WorkingTree format supporting views.
1517
upgrade_recommended = False
1519
_tree_class = WorkingTree6
1521
def get_format_string(self):
1522
"""See WorkingTreeFormat.get_format_string()."""
1523
return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1525
def get_format_description(self):
1526
"""See WorkingTreeFormat.get_format_description()."""
1527
return "Working tree format 6"
1529
def _init_custom_control_files(self, wt):
1530
"""Subclasses with custom control files should override this method."""
1531
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1533
def supports_content_filtering(self):
1536
def supports_views(self):
1540
class DirStateRevisionTree(Tree):
1541
"""A revision tree pulling the inventory from a dirstate."""
1543
def __init__(self, dirstate, revision_id, repository):
1544
self._dirstate = dirstate
1545
self._revision_id = revision_id
1546
self._repository = repository
1547
self._inventory = None
1549
self._dirstate_locked = False
1550
self._repo_supports_tree_reference = getattr(
1551
repository._format, "supports_tree_reference",
1555
return "<%s of %s in %s>" % \
1556
(self.__class__.__name__, self._revision_id, self._dirstate)
1558
def annotate_iter(self, file_id,
1559
default_revision=_mod_revision.CURRENT_REVISION):
1560
"""See Tree.annotate_iter"""
1561
text_key = (file_id, self.inventory[file_id].revision)
1562
annotations = self._repository.texts.annotate(text_key)
1563
return [(key[-1], line) for (key, line) in annotations]
1565
def _get_ancestors(self, default_revision):
1566
return set(self._repository.get_ancestry(self._revision_id,
1568
def _comparison_data(self, entry, path):
1569
"""See Tree._comparison_data."""
1571
return None, False, None
1572
# trust the entry as RevisionTree does, but this may not be
1573
# sensible: the entry might not have come from us?
1574
return entry.kind, entry.executable, None
1576
def _file_size(self, entry, stat_value):
1577
return entry.text_size
1579
def filter_unversioned_files(self, paths):
1580
"""Filter out paths that are not versioned.
1582
:return: set of paths.
1584
pred = self.has_filename
1585
return set((p for p in paths if not pred(p)))
1587
def get_root_id(self):
1588
return self.path2id('')
1590
def id2path(self, file_id):
1591
"Convert a file-id to a path."
1592
entry = self._get_entry(file_id=file_id)
1593
if entry == (None, None):
1594
raise errors.NoSuchId(tree=self, file_id=file_id)
1595
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1596
return path_utf8.decode('utf8')
1598
def iter_references(self):
1599
if not self._repo_supports_tree_reference:
1600
# When the repo doesn't support references, we will have nothing to
1603
# Otherwise, fall back to the default implementation
1604
return super(DirStateRevisionTree, self).iter_references()
1606
def _get_parent_index(self):
1607
"""Return the index in the dirstate referenced by this tree."""
1608
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1610
def _get_entry(self, file_id=None, path=None):
1611
"""Get the dirstate row for file_id or path.
1613
If either file_id or path is supplied, it is used as the key to lookup.
1614
If both are supplied, the fastest lookup is used, and an error is
1615
raised if they do not both point at the same row.
1617
:param file_id: An optional unicode file_id to be looked up.
1618
:param path: An optional unicode path to be looked up.
1619
:return: The dirstate row tuple for path/file_id, or (None, None)
1621
if file_id is None and path is None:
1622
raise errors.BzrError('must supply file_id or path')
1623
if path is not None:
1624
path = path.encode('utf8')
1625
parent_index = self._get_parent_index()
1626
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1628
def _generate_inventory(self):
1629
"""Create and set self.inventory from the dirstate object.
1631
(So this is only called the first time the inventory is requested for
1632
this tree; it then remains in memory until it's out of date.)
1634
This is relatively expensive: we have to walk the entire dirstate.
1636
if not self._locked:
1637
raise AssertionError(
1638
'cannot generate inventory of an unlocked '
1639
'dirstate revision tree')
1640
# separate call for profiling - makes it clear where the costs are.
1641
self._dirstate._read_dirblocks_if_needed()
1642
if self._revision_id not in self._dirstate.get_parent_ids():
1643
raise AssertionError(
1644
'parent %s has disappeared from %s' % (
1645
self._revision_id, self._dirstate.get_parent_ids()))
1646
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1647
# This is identical now to the WorkingTree _generate_inventory except
1648
# for the tree index use.
1649
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1650
current_id = root_key[2]
1651
if current_entry[parent_index][0] != 'd':
1652
raise AssertionError()
1653
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1654
inv.root.revision = current_entry[parent_index][4]
1655
# Turn some things into local variables
1656
minikind_to_kind = dirstate.DirState._minikind_to_kind
1657
factory = entry_factory
1658
utf8_decode = cache_utf8._utf8_decode
1659
inv_byid = inv._byid
1660
# we could do this straight out of the dirstate; it might be fast
1661
# and should be profiled - RBC 20070216
1662
parent_ies = {'' : inv.root}
1663
for block in self._dirstate._dirblocks[1:]: #skip root
1666
parent_ie = parent_ies[dirname]
1668
# all the paths in this block are not versioned in this tree
1670
for key, entry in block[1]:
1671
minikind, fingerprint, size, executable, revid = entry[parent_index]
1672
if minikind in ('a', 'r'): # absent, relocated
1676
name_unicode = utf8_decode(name)[0]
1678
kind = minikind_to_kind[minikind]
1679
inv_entry = factory[kind](file_id, name_unicode,
1681
inv_entry.revision = revid
1683
inv_entry.executable = executable
1684
inv_entry.text_size = size
1685
inv_entry.text_sha1 = fingerprint
1686
elif kind == 'directory':
1687
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1688
elif kind == 'symlink':
1689
inv_entry.executable = False
1690
inv_entry.text_size = None
1691
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1692
elif kind == 'tree-reference':
1693
inv_entry.reference_revision = fingerprint or None
1695
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1697
# These checks cost us around 40ms on a 55k entry tree
1698
if file_id in inv_byid:
1699
raise AssertionError('file_id %s already in'
1700
' inventory as %s' % (file_id, inv_byid[file_id]))
1701
if name_unicode in parent_ie.children:
1702
raise AssertionError('name %r already in parent'
1704
inv_byid[file_id] = inv_entry
1705
parent_ie.children[name_unicode] = inv_entry
1706
self._inventory = inv
1708
def get_file_mtime(self, file_id, path=None):
1709
"""Return the modification time for this record.
1711
We return the timestamp of the last-changed revision.
1713
# Make sure the file exists
1714
entry = self._get_entry(file_id, path=path)
1715
if entry == (None, None): # do we raise?
1717
parent_index = self._get_parent_index()
1718
last_changed_revision = entry[1][parent_index][4]
1719
return self._repository.get_revision(last_changed_revision).timestamp
1721
def get_file_sha1(self, file_id, path=None, stat_value=None):
1722
entry = self._get_entry(file_id=file_id, path=path)
1723
parent_index = self._get_parent_index()
1724
parent_details = entry[1][parent_index]
1725
if parent_details[0] == 'f':
1726
return parent_details[1]
1729
def get_file(self, file_id, path=None):
1730
return StringIO(self.get_file_text(file_id))
1732
def get_file_size(self, file_id):
1733
"""See Tree.get_file_size"""
1734
return self.inventory[file_id].text_size
1736
def get_file_text(self, file_id, path=None):
1737
_, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1738
return ''.join(content)
1740
def get_reference_revision(self, file_id, path=None):
1741
return self.inventory[file_id].reference_revision
1743
def iter_files_bytes(self, desired_files):
1744
"""See Tree.iter_files_bytes.
1746
This version is implemented on top of Repository.iter_files_bytes"""
1747
parent_index = self._get_parent_index()
1748
repo_desired_files = []
1749
for file_id, identifier in desired_files:
1750
entry = self._get_entry(file_id)
1751
if entry == (None, None):
1752
raise errors.NoSuchId(self, file_id)
1753
repo_desired_files.append((file_id, entry[1][parent_index][4],
1755
return self._repository.iter_files_bytes(repo_desired_files)
1757
def get_symlink_target(self, file_id):
1758
entry = self._get_entry(file_id=file_id)
1759
parent_index = self._get_parent_index()
1760
if entry[1][parent_index][0] != 'l':
1763
target = entry[1][parent_index][1]
1764
target = target.decode('utf8')
1767
def get_revision_id(self):
1768
"""Return the revision id for this tree."""
1769
return self._revision_id
1771
def _get_inventory(self):
1772
if self._inventory is not None:
1773
return self._inventory
1774
self._must_be_locked()
1775
self._generate_inventory()
1776
return self._inventory
1778
inventory = property(_get_inventory,
1779
doc="Inventory of this Tree")
1781
def get_parent_ids(self):
1782
"""The parents of a tree in the dirstate are not cached."""
1783
return self._repository.get_revision(self._revision_id).parent_ids
1785
def has_filename(self, filename):
1786
return bool(self.path2id(filename))
1788
def kind(self, file_id):
1789
entry = self._get_entry(file_id=file_id)[1]
1791
raise errors.NoSuchId(tree=self, file_id=file_id)
1792
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1794
def stored_kind(self, file_id):
1795
"""See Tree.stored_kind"""
1796
return self.kind(file_id)
1798
def path_content_summary(self, path):
1799
"""See Tree.path_content_summary."""
1800
id = self.inventory.path2id(path)
1802
return ('missing', None, None, None)
1803
entry = self._inventory[id]
1806
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1807
elif kind == 'symlink':
1808
return (kind, None, None, entry.symlink_target)
1810
return (kind, None, None, None)
1812
def is_executable(self, file_id, path=None):
1813
ie = self.inventory[file_id]
1814
if ie.kind != "file":
1816
return ie.executable
1818
def list_files(self, include_root=False, from_dir=None, recursive=True):
1819
# We use a standard implementation, because DirStateRevisionTree is
1820
# dealing with one of the parents of the current state
1821
inv = self._get_inventory()
1822
if from_dir is None:
1825
from_dir_id = inv.path2id(from_dir)
1826
if from_dir_id is None:
1827
# Directory not versioned
1829
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1830
if inv.root is not None and not include_root and from_dir is None:
1832
for path, entry in entries:
1833
yield path, 'V', entry.kind, entry.file_id, entry
1835
def lock_read(self):
1836
"""Lock the tree for a set of operations."""
1837
if not self._locked:
1838
self._repository.lock_read()
1839
if self._dirstate._lock_token is None:
1840
self._dirstate.lock_read()
1841
self._dirstate_locked = True
1844
def _must_be_locked(self):
1845
if not self._locked:
1846
raise errors.ObjectNotLocked(self)
1849
def path2id(self, path):
1850
"""Return the id for path in this tree."""
1851
# lookup by path: faster than splitting and walking the ivnentory.
1852
entry = self._get_entry(path=path)
1853
if entry == (None, None):
1858
"""Unlock, freeing any cache memory used during the lock."""
1859
# outside of a lock, the inventory is suspect: release it.
1861
if not self._locked:
1862
self._inventory = None
1864
if self._dirstate_locked:
1865
self._dirstate.unlock()
1866
self._dirstate_locked = False
1867
self._repository.unlock()
1870
def supports_tree_reference(self):
1871
return self._repo_supports_tree_reference
1873
def walkdirs(self, prefix=""):
1874
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1875
# implementation based on an inventory.
1876
# This should be cleaned up to use the much faster Dirstate code
1877
# So for now, we just build up the parent inventory, and extract
1878
# it the same way RevisionTree does.
1879
_directory = 'directory'
1880
inv = self._get_inventory()
1881
top_id = inv.path2id(prefix)
1885
pending = [(prefix, top_id)]
1888
relpath, file_id = pending.pop()
1889
# 0 - relpath, 1- file-id
1891
relroot = relpath + '/'
1894
# FIXME: stash the node in pending
1895
entry = inv[file_id]
1896
for name, child in entry.sorted_children():
1897
toppath = relroot + name
1898
dirblock.append((toppath, name, child.kind, None,
1899
child.file_id, child.kind
1901
yield (relpath, entry.file_id), dirblock
1902
# push the user specified dirs from dirblock
1903
for dir in reversed(dirblock):
1904
if dir[2] == _directory:
1905
pending.append((dir[0], dir[4]))
1908
class InterDirStateTree(InterTree):
1909
"""Fast path optimiser for changes_from with dirstate trees.
1911
This is used only when both trees are in the dirstate working file, and
1912
the source is any parent within the dirstate, and the destination is
1913
the current working tree of the same dirstate.
1915
# this could be generalized to allow comparisons between any trees in the
1916
# dirstate, and possibly between trees stored in different dirstates.
1918
def __init__(self, source, target):
1919
super(InterDirStateTree, self).__init__(source, target)
1920
if not InterDirStateTree.is_compatible(source, target):
1921
raise Exception, "invalid source %r and target %r" % (source, target)
1924
def make_source_parent_tree(source, target):
1925
"""Change the source tree into a parent of the target."""
1926
revid = source.commit('record tree')
1927
target.branch.repository.fetch(source.branch.repository, revid)
1928
target.set_parent_ids([revid])
1929
return target.basis_tree(), target
1932
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1933
result = klass.make_source_parent_tree(source, target)
1934
result[1]._iter_changes = dirstate.ProcessEntryPython
1938
def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
1939
from bzrlib.tests.test__dirstate_helpers import \
1940
CompiledDirstateHelpersFeature
1941
if not CompiledDirstateHelpersFeature.available():
1942
from bzrlib.tests import UnavailableFeature
1943
raise UnavailableFeature(CompiledDirstateHelpersFeature)
1944
from bzrlib._dirstate_helpers_pyx import ProcessEntryC
1945
result = klass.make_source_parent_tree(source, target)
1946
result[1]._iter_changes = ProcessEntryC
1949
_matching_from_tree_format = WorkingTreeFormat4()
1950
_matching_to_tree_format = WorkingTreeFormat4()
1953
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1954
# This method shouldn't be called, because we have python and C
1955
# specific flavours.
1956
raise NotImplementedError
1958
def iter_changes(self, include_unchanged=False,
1959
specific_files=None, pb=None, extra_trees=[],
1960
require_versioned=True, want_unversioned=False):
1961
"""Return the changes from source to target.
1963
:return: An iterator that yields tuples. See InterTree.iter_changes
1965
:param specific_files: An optional list of file paths to restrict the
1966
comparison to. When mapping filenames to ids, all matches in all
1967
trees (including optional extra_trees) are used, and all children of
1968
matched directories are included.
1969
:param include_unchanged: An optional boolean requesting the inclusion of
1970
unchanged entries in the result.
1971
:param extra_trees: An optional list of additional trees to use when
1972
mapping the contents of specific_files (paths) to file_ids.
1973
:param require_versioned: If True, all files in specific_files must be
1974
versioned in one of source, target, extra_trees or
1975
PathsNotVersionedError is raised.
1976
:param want_unversioned: Should unversioned files be returned in the
1977
output. An unversioned file is defined as one with (False, False)
1978
for the versioned pair.
1980
# NB: show_status depends on being able to pass in non-versioned files
1981
# and report them as unknown
1982
# TODO: handle extra trees in the dirstate.
1983
if (extra_trees or specific_files == []):
1984
# we can't fast-path these cases (yet)
1985
return super(InterDirStateTree, self).iter_changes(
1986
include_unchanged, specific_files, pb, extra_trees,
1987
require_versioned, want_unversioned=want_unversioned)
1988
parent_ids = self.target.get_parent_ids()
1989
if not (self.source._revision_id in parent_ids
1990
or self.source._revision_id == _mod_revision.NULL_REVISION):
1991
raise AssertionError(
1992
"revision {%s} is not stored in {%s}, but %s "
1993
"can only be used for trees stored in the dirstate"
1994
% (self.source._revision_id, self.target, self.iter_changes))
1996
if self.source._revision_id == _mod_revision.NULL_REVISION:
1998
indices = (target_index,)
2000
if not (self.source._revision_id in parent_ids):
2001
raise AssertionError(
2002
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2003
self.source._revision_id, parent_ids))
2004
source_index = 1 + parent_ids.index(self.source._revision_id)
2005
indices = (source_index, target_index)
2006
# -- make all specific_files utf8 --
2008
specific_files_utf8 = set()
2009
for path in specific_files:
2010
# Note, if there are many specific files, using cache_utf8
2011
# would be good here.
2012
specific_files_utf8.add(path.encode('utf8'))
2013
specific_files = specific_files_utf8
2015
specific_files = set([''])
2016
# -- specific_files is now a utf8 path set --
2018
# -- get the state object and prepare it.
2019
state = self.target.current_dirstate()
2020
state._read_dirblocks_if_needed()
2021
if require_versioned:
2022
# -- check all supplied paths are versioned in a search tree. --
2024
for path in specific_files:
2025
path_entries = state._entries_for_path(path)
2026
if not path_entries:
2027
# this specified path is not present at all: error
2028
not_versioned.append(path)
2030
found_versioned = False
2031
# for each id at this path
2032
for entry in path_entries:
2034
for index in indices:
2035
if entry[1][index][0] != 'a': # absent
2036
found_versioned = True
2037
# all good: found a versioned cell
2039
if not found_versioned:
2040
# none of the indexes was not 'absent' at all ids for this
2042
not_versioned.append(path)
2043
if len(not_versioned) > 0:
2044
raise errors.PathsNotVersionedError(not_versioned)
2045
# -- remove redundancy in supplied specific_files to prevent over-scanning --
2046
search_specific_files = osutils.minimum_path_selection(specific_files)
2048
use_filesystem_for_exec = (sys.platform != 'win32')
2049
iter_changes = self.target._iter_changes(include_unchanged,
2050
use_filesystem_for_exec, search_specific_files, state,
2051
source_index, target_index, want_unversioned, self.target)
2052
return iter_changes.iter_changes()
2055
def is_compatible(source, target):
2056
# the target must be a dirstate working tree
2057
if not isinstance(target, DirStateWorkingTree):
2059
# the source must be a revtree or dirstate rev tree.
2060
if not isinstance(source,
2061
(revisiontree.RevisionTree, DirStateRevisionTree)):
2063
# the source revid must be in the target dirstate
2064
if not (source._revision_id == _mod_revision.NULL_REVISION or
2065
source._revision_id in target.get_parent_ids()):
2066
# TODO: what about ghosts? it may well need to
2067
# check for them explicitly.
2071
InterTree.register_optimiser(InterDirStateTree)
2074
class Converter3to4(object):
2075
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2078
self.target_format = WorkingTreeFormat4()
2080
def convert(self, tree):
2081
# lock the control files not the tree, so that we dont get tree
2082
# on-unlock behaviours, and so that noone else diddles with the
2083
# tree during upgrade.
2084
tree._control_files.lock_write()
2086
tree.read_working_inventory()
2087
self.create_dirstate_data(tree)
2088
self.update_format(tree)
2089
self.remove_xml_files(tree)
2091
tree._control_files.unlock()
2093
def create_dirstate_data(self, tree):
2094
"""Create the dirstate based data for tree."""
2095
local_path = tree.bzrdir.get_workingtree_transport(None
2096
).local_abspath('dirstate')
2097
state = dirstate.DirState.from_tree(tree, local_path)
2101
def remove_xml_files(self, tree):
2102
"""Remove the oldformat 3 data."""
2103
transport = tree.bzrdir.get_workingtree_transport(None)
2104
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2105
'pending-merges', 'stat-cache']:
2107
transport.delete(path)
2108
except errors.NoSuchFile:
2109
# some files are optional - just deal.
2112
def update_format(self, tree):
2113
"""Change the format marker."""
2114
tree._transport.put_bytes('format',
2115
self.target_format.get_format_string(),
2116
mode=tree.bzrdir._get_file_mode())
2119
class Converter4to5(object):
2120
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2123
self.target_format = WorkingTreeFormat5()
2125
def convert(self, tree):
2126
# lock the control files not the tree, so that we don't get tree
2127
# on-unlock behaviours, and so that no-one else diddles with the
2128
# tree during upgrade.
2129
tree._control_files.lock_write()
2131
self.update_format(tree)
2133
tree._control_files.unlock()
2135
def update_format(self, tree):
2136
"""Change the format marker."""
2137
tree._transport.put_bytes('format',
2138
self.target_format.get_format_string(),
2139
mode=tree.bzrdir._get_file_mode())
2142
class Converter4or5to6(object):
2143
"""Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2146
self.target_format = WorkingTreeFormat6()
2148
def convert(self, tree):
2149
# lock the control files not the tree, so that we don't get tree
2150
# on-unlock behaviours, and so that no-one else diddles with the
2151
# tree during upgrade.
2152
tree._control_files.lock_write()
2154
self.init_custom_control_files(tree)
2155
self.update_format(tree)
2157
tree._control_files.unlock()
2159
def init_custom_control_files(self, tree):
2160
"""Initialize custom control files."""
2161
tree._transport.put_bytes('views', '',
2162
mode=tree.bzrdir._get_file_mode())
2164
def update_format(self, tree):
2165
"""Change the format marker."""
2166
tree._transport.put_bytes('format',
2167
self.target_format.get_format_string(),
2168
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
