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')))
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."""
572
self.branch.lock_read()
574
self._control_files.lock_read()
576
state = self.current_dirstate()
577
if not state._lock_token:
579
# set our support for tree references from the repository in
581
self._repo_supports_tree_reference = getattr(
582
self.branch.repository._format, "supports_tree_reference",
585
self._control_files.unlock()
591
def _lock_self_write(self):
592
"""This should be called after the branch is locked."""
594
self._control_files.lock_write()
596
state = self.current_dirstate()
597
if not state._lock_token:
599
# set our support for tree references from the repository in
601
self._repo_supports_tree_reference = getattr(
602
self.branch.repository._format, "supports_tree_reference",
605
self._control_files.unlock()
611
def lock_tree_write(self):
612
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
613
self.branch.lock_read()
614
self._lock_self_write()
616
def lock_write(self):
617
"""See MutableTree.lock_write, and WorkingTree.unlock."""
618
self.branch.lock_write()
619
self._lock_self_write()
621
@needs_tree_write_lock
622
def move(self, from_paths, to_dir, after=False):
623
"""See WorkingTree.move()."""
627
state = self.current_dirstate()
628
if isinstance(from_paths, basestring):
630
to_dir_utf8 = to_dir.encode('utf8')
631
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
632
id_index = state._get_id_index()
633
# check destination directory
634
# get the details for it
635
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
636
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
637
if not entry_present:
638
raise errors.BzrMoveFailedError('', to_dir,
639
errors.NotVersionedError(to_dir))
640
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
641
# get a handle on the block itself.
642
to_block_index = state._ensure_block(
643
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
644
to_block = state._dirblocks[to_block_index]
645
to_abs = self.abspath(to_dir)
646
if not isdir(to_abs):
647
raise errors.BzrMoveFailedError('',to_dir,
648
errors.NotADirectory(to_abs))
650
if to_entry[1][0][0] != 'd':
651
raise errors.BzrMoveFailedError('',to_dir,
652
errors.NotADirectory(to_abs))
654
if self._inventory is not None:
655
update_inventory = True
657
to_dir_id = to_entry[0][2]
658
to_dir_ie = inv[to_dir_id]
660
update_inventory = False
663
def move_one(old_entry, from_path_utf8, minikind, executable,
664
fingerprint, packed_stat, size,
665
to_block, to_key, to_path_utf8):
666
state._make_absent(old_entry)
667
from_key = old_entry[0]
669
lambda:state.update_minimal(from_key,
671
executable=executable,
672
fingerprint=fingerprint,
673
packed_stat=packed_stat,
675
path_utf8=from_path_utf8))
676
state.update_minimal(to_key,
678
executable=executable,
679
fingerprint=fingerprint,
680
packed_stat=packed_stat,
682
path_utf8=to_path_utf8)
683
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
684
new_entry = to_block[1][added_entry_index]
685
rollbacks.append(lambda:state._make_absent(new_entry))
687
for from_rel in from_paths:
688
# from_rel is 'pathinroot/foo/bar'
689
from_rel_utf8 = from_rel.encode('utf8')
690
from_dirname, from_tail = osutils.split(from_rel)
691
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
692
from_entry = self._get_entry(path=from_rel)
693
if from_entry == (None, None):
694
raise errors.BzrMoveFailedError(from_rel,to_dir,
695
errors.NotVersionedError(path=from_rel))
697
from_id = from_entry[0][2]
698
to_rel = pathjoin(to_dir, from_tail)
699
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
700
item_to_entry = self._get_entry(path=to_rel)
701
if item_to_entry != (None, None):
702
raise errors.BzrMoveFailedError(from_rel, to_rel,
703
"Target is already versioned.")
705
if from_rel == to_rel:
706
raise errors.BzrMoveFailedError(from_rel, to_rel,
707
"Source and target are identical.")
709
from_missing = not self.has_filename(from_rel)
710
to_missing = not self.has_filename(to_rel)
717
raise errors.BzrMoveFailedError(from_rel, to_rel,
718
errors.NoSuchFile(path=to_rel,
719
extra="New file has not been created yet"))
721
# neither path exists
722
raise errors.BzrRenameFailedError(from_rel, to_rel,
723
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
725
if from_missing: # implicitly just update our path mapping
728
raise errors.RenameFailedFilesExist(from_rel, to_rel)
731
def rollback_rename():
732
"""A single rename has failed, roll it back."""
733
# roll back everything, even if we encounter trouble doing one
736
# TODO: at least log the other exceptions rather than just
737
# losing them mbp 20070307
739
for rollback in reversed(rollbacks):
743
exc_info = sys.exc_info()
745
raise exc_info[0], exc_info[1], exc_info[2]
747
# perform the disk move first - its the most likely failure point.
749
from_rel_abs = self.abspath(from_rel)
750
to_rel_abs = self.abspath(to_rel)
752
osutils.rename(from_rel_abs, to_rel_abs)
754
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
755
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
757
# perform the rename in the inventory next if needed: its easy
761
from_entry = inv[from_id]
762
current_parent = from_entry.parent_id
763
inv.rename(from_id, to_dir_id, from_tail)
765
lambda: inv.rename(from_id, current_parent, from_tail))
766
# finally do the rename in the dirstate, which is a little
767
# tricky to rollback, but least likely to need it.
768
old_block_index, old_entry_index, dir_present, file_present = \
769
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
770
old_block = state._dirblocks[old_block_index][1]
771
old_entry = old_block[old_entry_index]
772
from_key, old_entry_details = old_entry
773
cur_details = old_entry_details[0]
775
to_key = ((to_block[0],) + from_key[1:3])
776
minikind = cur_details[0]
777
move_one(old_entry, from_path_utf8=from_rel_utf8,
779
executable=cur_details[3],
780
fingerprint=cur_details[1],
781
packed_stat=cur_details[4],
785
to_path_utf8=to_rel_utf8)
788
def update_dirblock(from_dir, to_key, to_dir_utf8):
789
"""Recursively update all entries in this dirblock."""
791
raise AssertionError("renaming root not supported")
792
from_key = (from_dir, '')
793
from_block_idx, present = \
794
state._find_block_index_from_key(from_key)
796
# This is the old record, if it isn't present, then
797
# there is theoretically nothing to update.
798
# (Unless it isn't present because of lazy loading,
799
# but we don't do that yet)
801
from_block = state._dirblocks[from_block_idx]
802
to_block_index, to_entry_index, _, _ = \
803
state._get_block_entry_index(to_key[0], to_key[1], 0)
804
to_block_index = state._ensure_block(
805
to_block_index, to_entry_index, to_dir_utf8)
806
to_block = state._dirblocks[to_block_index]
808
# Grab a copy since move_one may update the list.
809
for entry in from_block[1][:]:
810
if not (entry[0][0] == from_dir):
811
raise AssertionError()
812
cur_details = entry[1][0]
813
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
814
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
815
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
816
minikind = cur_details[0]
818
# Deleted children of a renamed directory
819
# Do not need to be updated.
820
# Children that have been renamed out of this
821
# directory should also not be updated
823
move_one(entry, from_path_utf8=from_path_utf8,
825
executable=cur_details[3],
826
fingerprint=cur_details[1],
827
packed_stat=cur_details[4],
831
to_path_utf8=to_path_utf8)
833
# We need to move all the children of this
835
update_dirblock(from_path_utf8, to_key,
837
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
841
result.append((from_rel, to_rel))
842
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
843
self._make_dirty(reset_inventory=False)
847
def _must_be_locked(self):
848
if not self._control_files._lock_count:
849
raise errors.ObjectNotLocked(self)
852
"""Initialize the state in this tree to be a new tree."""
856
def path2id(self, path):
857
"""Return the id for path in this tree."""
858
path = path.strip('/')
859
entry = self._get_entry(path=path)
860
if entry == (None, None):
864
def paths2ids(self, paths, trees=[], require_versioned=True):
865
"""See Tree.paths2ids().
867
This specialisation fast-paths the case where all the trees are in the
872
parents = self.get_parent_ids()
874
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
876
return super(DirStateWorkingTree, self).paths2ids(paths,
877
trees, require_versioned)
878
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
879
# -- make all paths utf8 --
882
paths_utf8.add(path.encode('utf8'))
884
# -- paths is now a utf8 path set --
885
# -- get the state object and prepare it.
886
state = self.current_dirstate()
887
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
888
and '' not in paths):
889
paths2ids = self._paths2ids_using_bisect
891
paths2ids = self._paths2ids_in_memory
892
return paths2ids(paths, search_indexes,
893
require_versioned=require_versioned)
895
def _paths2ids_in_memory(self, paths, search_indexes,
896
require_versioned=True):
897
state = self.current_dirstate()
898
state._read_dirblocks_if_needed()
899
def _entries_for_path(path):
900
"""Return a list with all the entries that match path for all ids.
902
dirname, basename = os.path.split(path)
903
key = (dirname, basename, '')
904
block_index, present = state._find_block_index_from_key(key)
906
# the block which should contain path is absent.
909
block = state._dirblocks[block_index][1]
910
entry_index, _ = state._find_entry_index(key, block)
911
# we may need to look at multiple entries at this path: walk while the paths match.
912
while (entry_index < len(block) and
913
block[entry_index][0][0:2] == key[0:2]):
914
result.append(block[entry_index])
917
if require_versioned:
918
# -- check all supplied paths are versioned in a search tree. --
921
path_entries = _entries_for_path(path)
923
# this specified path is not present at all: error
924
all_versioned = False
926
found_versioned = False
927
# for each id at this path
928
for entry in path_entries:
930
for index in search_indexes:
931
if entry[1][index][0] != 'a': # absent
932
found_versioned = True
933
# all good: found a versioned cell
935
if not found_versioned:
936
# none of the indexes was not 'absent' at all ids for this
938
all_versioned = False
940
if not all_versioned:
941
raise errors.PathsNotVersionedError(paths)
942
# -- remove redundancy in supplied paths to prevent over-scanning --
943
search_paths = osutils.minimum_path_selection(paths)
945
# for all search_indexs in each path at or under each element of
946
# search_paths, if the detail is relocated: add the id, and add the
947
# relocated path as one to search if its not searched already. If the
948
# detail is not relocated, add the id.
949
searched_paths = set()
951
def _process_entry(entry):
952
"""Look at search_indexes within entry.
954
If a specific tree's details are relocated, add the relocation
955
target to search_paths if not searched already. If it is absent, do
956
nothing. Otherwise add the id to found_ids.
958
for index in search_indexes:
959
if entry[1][index][0] == 'r': # relocated
960
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
961
search_paths.add(entry[1][index][1])
962
elif entry[1][index][0] != 'a': # absent
963
found_ids.add(entry[0][2])
965
current_root = search_paths.pop()
966
searched_paths.add(current_root)
967
# process the entries for this containing directory: the rest will be
968
# found by their parents recursively.
969
root_entries = _entries_for_path(current_root)
971
# this specified path is not present at all, skip it.
973
for entry in root_entries:
974
_process_entry(entry)
975
initial_key = (current_root, '', '')
976
block_index, _ = state._find_block_index_from_key(initial_key)
977
while (block_index < len(state._dirblocks) and
978
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
979
for entry in state._dirblocks[block_index][1]:
980
_process_entry(entry)
984
def _paths2ids_using_bisect(self, paths, search_indexes,
985
require_versioned=True):
986
state = self.current_dirstate()
989
split_paths = sorted(osutils.split(p) for p in paths)
990
found = state._bisect_recursive(split_paths)
992
if require_versioned:
993
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
994
for dir_name in split_paths:
995
if dir_name not in found_dir_names:
996
raise errors.PathsNotVersionedError(paths)
998
for dir_name_id, trees_info in found.iteritems():
999
for index in search_indexes:
1000
if trees_info[index][0] not in ('r', 'a'):
1001
found_ids.add(dir_name_id[2])
1004
def read_working_inventory(self):
1005
"""Read the working inventory.
1007
This is a meaningless operation for dirstate, but we obey it anyhow.
1009
return self.inventory
1012
def revision_tree(self, revision_id):
1013
"""See Tree.revision_tree.
1015
WorkingTree4 supplies revision_trees for any basis tree.
1017
dirstate = self.current_dirstate()
1018
parent_ids = dirstate.get_parent_ids()
1019
if revision_id not in parent_ids:
1020
raise errors.NoSuchRevisionInTree(self, revision_id)
1021
if revision_id in dirstate.get_ghosts():
1022
raise errors.NoSuchRevisionInTree(self, revision_id)
1023
return DirStateRevisionTree(dirstate, revision_id,
1024
self.branch.repository)
1026
@needs_tree_write_lock
1027
def set_last_revision(self, new_revision):
1028
"""Change the last revision in the working tree."""
1029
parents = self.get_parent_ids()
1030
if new_revision in (_mod_revision.NULL_REVISION, None):
1031
if len(parents) >= 2:
1032
raise AssertionError(
1033
"setting the last parent to none with a pending merge is "
1035
self.set_parent_ids([])
1037
self.set_parent_ids([new_revision] + parents[1:],
1038
allow_leftmost_as_ghost=True)
1040
@needs_tree_write_lock
1041
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1042
"""Set the parent ids to revision_ids.
1044
See also set_parent_trees. This api will try to retrieve the tree data
1045
for each element of revision_ids from the trees repository. If you have
1046
tree data already available, it is more efficient to use
1047
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1048
an easier API to use.
1050
:param revision_ids: The revision_ids to set as the parent ids of this
1051
working tree. Any of these may be ghosts.
1054
for revision_id in revision_ids:
1056
revtree = self.branch.repository.revision_tree(revision_id)
1057
# TODO: jam 20070213 KnitVersionedFile raises
1058
# RevisionNotPresent rather than NoSuchRevision if a
1059
# given revision_id is not present. Should Repository be
1060
# catching it and re-raising NoSuchRevision?
1061
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1063
trees.append((revision_id, revtree))
1064
self.set_parent_trees(trees,
1065
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1067
@needs_tree_write_lock
1068
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1069
"""Set the parents of the working tree.
1071
:param parents_list: A list of (revision_id, tree) tuples.
1072
If tree is None, then that element is treated as an unreachable
1073
parent tree - i.e. a ghost.
1075
dirstate = self.current_dirstate()
1076
if len(parents_list) > 0:
1077
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1078
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1082
parent_ids = [rev_id for rev_id, tree in parents_list]
1083
graph = self.branch.repository.get_graph()
1084
heads = graph.heads(parent_ids)
1085
accepted_revisions = set()
1087
# convert absent trees to the null tree, which we convert back to
1088
# missing on access.
1089
for rev_id, tree in parents_list:
1090
if len(accepted_revisions) > 0:
1091
# we always accept the first tree
1092
if rev_id in accepted_revisions or rev_id not in heads:
1093
# We have already included either this tree, or its
1094
# descendent, so we skip it.
1096
_mod_revision.check_not_reserved_id(rev_id)
1097
if tree is not None:
1098
real_trees.append((rev_id, tree))
1100
real_trees.append((rev_id,
1101
self.branch.repository.revision_tree(
1102
_mod_revision.NULL_REVISION)))
1103
ghosts.append(rev_id)
1104
accepted_revisions.add(rev_id)
1105
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1106
self._make_dirty(reset_inventory=False)
1108
def _set_root_id(self, file_id):
1109
"""See WorkingTree.set_root_id."""
1110
state = self.current_dirstate()
1111
state.set_path_id('', file_id)
1112
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1113
self._make_dirty(reset_inventory=True)
1115
def _sha_from_stat(self, path, stat_result):
1116
"""Get a sha digest from the tree's stat cache.
1118
The default implementation assumes no stat cache is present.
1120
:param path: The path.
1121
:param stat_result: The stat result being looked up.
1123
return self.current_dirstate().sha1_from_stat(path, stat_result)
1126
def supports_tree_reference(self):
1127
return self._repo_supports_tree_reference
1130
"""Unlock in format 4 trees needs to write the entire dirstate."""
1131
# do non-implementation specific cleanup
1134
if self._control_files._lock_count == 1:
1135
# eventually we should do signature checking during read locks for
1137
if self._control_files._lock_mode == 'w':
1140
if self._dirstate is not None:
1141
# This is a no-op if there are no modifications.
1142
self._dirstate.save()
1143
self._dirstate.unlock()
1144
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1145
# point. Instead, it could check if the header has been
1146
# modified when it is locked, and if not, it can hang on to
1147
# the data it has in memory.
1148
self._dirstate = None
1149
self._inventory = None
1150
# reverse order of locking.
1152
return self._control_files.unlock()
1154
self.branch.unlock()
1156
@needs_tree_write_lock
1157
def unversion(self, file_ids):
1158
"""Remove the file ids in file_ids from the current versioned set.
1160
When a file_id is unversioned, all of its children are automatically
1163
:param file_ids: The file ids to stop versioning.
1164
:raises: NoSuchId if any fileid is not currently versioned.
1168
state = self.current_dirstate()
1169
state._read_dirblocks_if_needed()
1170
ids_to_unversion = set(file_ids)
1171
paths_to_unversion = set()
1173
# check if the root is to be unversioned, if so, assert for now.
1174
# walk the state marking unversioned things as absent.
1175
# if there are any un-unversioned ids at the end, raise
1176
for key, details in state._dirblocks[0][1]:
1177
if (details[0][0] not in ('a', 'r') and # absent or relocated
1178
key[2] in ids_to_unversion):
1179
# I haven't written the code to unversion / yet - it should be
1181
raise errors.BzrError('Unversioning the / is not currently supported')
1183
while block_index < len(state._dirblocks):
1184
# process one directory at a time.
1185
block = state._dirblocks[block_index]
1186
# first check: is the path one to remove - it or its children
1187
delete_block = False
1188
for path in paths_to_unversion:
1189
if (block[0].startswith(path) and
1190
(len(block[0]) == len(path) or
1191
block[0][len(path)] == '/')):
1192
# this entire block should be deleted - its the block for a
1193
# path to unversion; or the child of one
1196
# TODO: trim paths_to_unversion as we pass by paths
1198
# this block is to be deleted: process it.
1199
# TODO: we can special case the no-parents case and
1200
# just forget the whole block.
1202
while entry_index < len(block[1]):
1203
entry = block[1][entry_index]
1204
if entry[1][0][0] in 'ar':
1205
# don't remove absent or renamed entries
1208
# Mark this file id as having been removed
1209
ids_to_unversion.discard(entry[0][2])
1210
if not state._make_absent(entry):
1211
# The block has not shrunk.
1213
# go to the next block. (At the moment we dont delete empty
1218
while entry_index < len(block[1]):
1219
entry = block[1][entry_index]
1220
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1221
# ^ some parent row.
1222
entry[0][2] not in ids_to_unversion):
1223
# ^ not an id to unversion
1226
if entry[1][0][0] == 'd':
1227
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1228
if not state._make_absent(entry):
1230
# we have unversioned this id
1231
ids_to_unversion.remove(entry[0][2])
1233
if ids_to_unversion:
1234
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1235
self._make_dirty(reset_inventory=False)
1236
# have to change the legacy inventory too.
1237
if self._inventory is not None:
1238
for file_id in file_ids:
1239
self._inventory.remove_recursive_id(file_id)
1241
@needs_tree_write_lock
1242
def rename_one(self, from_rel, to_rel, after=False):
1243
"""See WorkingTree.rename_one"""
1245
WorkingTree.rename_one(self, from_rel, to_rel, after)
1247
@needs_tree_write_lock
1248
def apply_inventory_delta(self, changes):
1249
"""See MutableTree.apply_inventory_delta"""
1250
state = self.current_dirstate()
1251
state.update_by_delta(changes)
1252
self._make_dirty(reset_inventory=True)
1254
def update_basis_by_delta(self, new_revid, delta):
1255
"""See MutableTree.update_basis_by_delta."""
1256
if self.last_revision() == new_revid:
1257
raise AssertionError()
1258
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1261
def _validate(self):
1262
self._dirstate._validate()
1264
@needs_tree_write_lock
1265
def _write_inventory(self, inv):
1266
"""Write inventory as the current inventory."""
1268
raise AssertionError("attempting to write an inventory when the "
1269
"dirstate is dirty will lose pending changes")
1270
self.current_dirstate().set_state_from_inventory(inv)
1271
self._make_dirty(reset_inventory=False)
1272
if self._inventory is not None:
1273
self._inventory = inv
1277
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1279
def __init__(self, tree):
1282
def sha1(self, abspath):
1283
"""See dirstate.SHA1Provider.sha1()."""
1284
filters = self.tree._content_filter_stack(
1285
self.tree.relpath(osutils.safe_unicode(abspath)))
1286
return internal_size_sha_file_byname(abspath, filters)[1]
1288
def stat_and_sha1(self, abspath):
1289
"""See dirstate.SHA1Provider.stat_and_sha1()."""
1290
filters = self.tree._content_filter_stack(
1291
self.tree.relpath(osutils.safe_unicode(abspath)))
1292
file_obj = file(abspath, 'rb', 65000)
1294
statvalue = os.fstat(file_obj.fileno())
1296
file_obj = filtered_input_file(file_obj, filters)
1297
sha1 = osutils.size_sha_file(file_obj)[1]
1300
return statvalue, sha1
1303
class WorkingTree4(DirStateWorkingTree):
1304
"""This is the Format 4 working tree.
1306
This differs from WorkingTree3 by:
1307
- Having a consolidated internal dirstate, stored in a
1308
randomly-accessible sorted file on disk.
1309
- Not having a regular inventory attribute. One can be synthesized
1310
on demand but this is expensive and should be avoided.
1312
This is new in bzr 0.15.
1316
class WorkingTree5(DirStateWorkingTree):
1317
"""This is the Format 5 working tree.
1319
This differs from WorkingTree4 by:
1320
- Supporting content filtering.
1322
This is new in bzr 1.11.
1326
class WorkingTree6(DirStateWorkingTree):
1327
"""This is the Format 6 working tree.
1329
This differs from WorkingTree5 by:
1330
- Supporting a current view that may mask the set of files in a tree
1331
impacted by most user operations.
1333
This is new in bzr 1.14.
1336
def _make_views(self):
1337
return views.PathBasedViews(self)
1340
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1341
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1342
accelerator_tree=None, hardlink=False):
1343
"""See WorkingTreeFormat.initialize().
1345
:param revision_id: allows creating a working tree at a different
1346
revision than the branch is at.
1347
:param accelerator_tree: A tree which can be used for retrieving file
1348
contents more quickly than the revision tree, i.e. a workingtree.
1349
The revision tree will be used for cases where accelerator_tree's
1350
content is different.
1351
:param hardlink: If true, hard-link files from accelerator_tree,
1354
These trees get an initial random root id, if their repository supports
1355
rich root data, TREE_ROOT otherwise.
1357
if not isinstance(a_bzrdir.transport, LocalTransport):
1358
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1359
transport = a_bzrdir.get_workingtree_transport(self)
1360
control_files = self._open_control_files(a_bzrdir)
1361
control_files.create_lock()
1362
control_files.lock_write()
1363
transport.put_bytes('format', self.get_format_string(),
1364
mode=a_bzrdir._get_file_mode())
1365
if from_branch is not None:
1366
branch = from_branch
1368
branch = a_bzrdir.open_branch()
1369
if revision_id is None:
1370
revision_id = branch.last_revision()
1371
local_path = transport.local_abspath('dirstate')
1372
# write out new dirstate (must exist when we create the tree)
1373
state = dirstate.DirState.initialize(local_path)
1376
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1380
_control_files=control_files)
1382
wt.lock_tree_write()
1384
self._init_custom_control_files(wt)
1385
if revision_id in (None, _mod_revision.NULL_REVISION):
1386
if branch.repository.supports_rich_root():
1387
wt._set_root_id(generate_ids.gen_root_id())
1389
wt._set_root_id(ROOT_ID)
1392
# frequently, we will get here due to branching. The accelerator
1393
# tree will be the tree from the branch, so the desired basis
1394
# tree will often be a parent of the accelerator tree.
1395
if accelerator_tree is not None:
1397
basis = accelerator_tree.revision_tree(revision_id)
1398
except errors.NoSuchRevision:
1401
basis = branch.repository.revision_tree(revision_id)
1402
if revision_id == _mod_revision.NULL_REVISION:
1405
parents_list = [(revision_id, basis)]
1408
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1410
# if the basis has a root id we have to use that; otherwise we
1411
# use a new random one
1412
basis_root_id = basis.get_root_id()
1413
if basis_root_id is not None:
1414
wt._set_root_id(basis_root_id)
1416
# If content filtering is supported, do not use the accelerator
1417
# tree - the cost of transforming the content both ways and
1418
# checking for changed content can outweight the gains it gives.
1419
# Note: do NOT move this logic up higher - using the basis from
1420
# the accelerator tree is still desirable because that can save
1421
# a minute or more of processing on large trees!
1422
# The original tree may not have the same content filters
1423
# applied so we can't safely build the inventory delta from
1425
if wt.supports_content_filtering():
1426
accelerator_tree = None
1427
delta_from_tree = False
1429
delta_from_tree = True
1430
# delta_from_tree is safe even for DirStateRevisionTrees,
1431
# because wt4.apply_inventory_delta does not mutate the input
1432
# inventory entries.
1433
transform.build_tree(basis, wt, accelerator_tree,
1435
delta_from_tree=delta_from_tree)
1439
control_files.unlock()
1443
def _init_custom_control_files(self, wt):
1444
"""Subclasses with custom control files should override this method.
1446
The working tree and control files are locked for writing when this
1449
:param wt: the WorkingTree object
1452
def _open(self, a_bzrdir, control_files):
1453
"""Open the tree itself.
1455
:param a_bzrdir: the dir for the tree.
1456
:param control_files: the control files for the tree.
1458
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1459
branch=a_bzrdir.open_branch(),
1462
_control_files=control_files)
1464
def __get_matchingbzrdir(self):
1465
return self._get_matchingbzrdir()
1467
def _get_matchingbzrdir(self):
1468
"""Overrideable method to get a bzrdir for testing."""
1469
# please test against something that will let us do tree references
1470
return bzrdir.format_registry.make_bzrdir(
1471
'dirstate-with-subtree')
1473
_matchingbzrdir = property(__get_matchingbzrdir)
1476
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1477
"""The first consolidated dirstate working tree format.
1480
- exists within a metadir controlling .bzr
1481
- includes an explicit version marker for the workingtree control
1482
files, separate from the BzrDir format
1483
- modifies the hash cache format
1484
- is new in bzr 0.15
1485
- uses a LockDir to guard access to it.
1488
upgrade_recommended = False
1490
_tree_class = WorkingTree4
1492
def get_format_string(self):
1493
"""See WorkingTreeFormat.get_format_string()."""
1494
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1496
def get_format_description(self):
1497
"""See WorkingTreeFormat.get_format_description()."""
1498
return "Working tree format 4"
1501
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1502
"""WorkingTree format supporting content filtering.
1505
upgrade_recommended = False
1507
_tree_class = WorkingTree5
1509
def get_format_string(self):
1510
"""See WorkingTreeFormat.get_format_string()."""
1511
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1513
def get_format_description(self):
1514
"""See WorkingTreeFormat.get_format_description()."""
1515
return "Working tree format 5"
1517
def supports_content_filtering(self):
1521
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1522
"""WorkingTree format supporting views.
1525
upgrade_recommended = False
1527
_tree_class = WorkingTree6
1529
def get_format_string(self):
1530
"""See WorkingTreeFormat.get_format_string()."""
1531
return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1533
def get_format_description(self):
1534
"""See WorkingTreeFormat.get_format_description()."""
1535
return "Working tree format 6"
1537
def _init_custom_control_files(self, wt):
1538
"""Subclasses with custom control files should override this method."""
1539
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1541
def supports_content_filtering(self):
1544
def supports_views(self):
1548
class DirStateRevisionTree(Tree):
1549
"""A revision tree pulling the inventory from a dirstate."""
1551
def __init__(self, dirstate, revision_id, repository):
1552
self._dirstate = dirstate
1553
self._revision_id = revision_id
1554
self._repository = repository
1555
self._inventory = None
1557
self._dirstate_locked = False
1558
self._repo_supports_tree_reference = getattr(
1559
repository._format, "supports_tree_reference",
1563
return "<%s of %s in %s>" % \
1564
(self.__class__.__name__, self._revision_id, self._dirstate)
1566
def annotate_iter(self, file_id,
1567
default_revision=_mod_revision.CURRENT_REVISION):
1568
"""See Tree.annotate_iter"""
1569
text_key = (file_id, self.inventory[file_id].revision)
1570
annotations = self._repository.texts.annotate(text_key)
1571
return [(key[-1], line) for (key, line) in annotations]
1573
def _get_ancestors(self, default_revision):
1574
return set(self._repository.get_ancestry(self._revision_id,
1576
def _comparison_data(self, entry, path):
1577
"""See Tree._comparison_data."""
1579
return None, False, None
1580
# trust the entry as RevisionTree does, but this may not be
1581
# sensible: the entry might not have come from us?
1582
return entry.kind, entry.executable, None
1584
def _file_size(self, entry, stat_value):
1585
return entry.text_size
1587
def filter_unversioned_files(self, paths):
1588
"""Filter out paths that are not versioned.
1590
:return: set of paths.
1592
pred = self.has_filename
1593
return set((p for p in paths if not pred(p)))
1595
def get_root_id(self):
1596
return self.path2id('')
1598
def id2path(self, file_id):
1599
"Convert a file-id to a path."
1600
entry = self._get_entry(file_id=file_id)
1601
if entry == (None, None):
1602
raise errors.NoSuchId(tree=self, file_id=file_id)
1603
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1604
return path_utf8.decode('utf8')
1606
def iter_references(self):
1607
if not self._repo_supports_tree_reference:
1608
# When the repo doesn't support references, we will have nothing to
1611
# Otherwise, fall back to the default implementation
1612
return super(DirStateRevisionTree, self).iter_references()
1614
def _get_parent_index(self):
1615
"""Return the index in the dirstate referenced by this tree."""
1616
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1618
def _get_entry(self, file_id=None, path=None):
1619
"""Get the dirstate row for file_id or path.
1621
If either file_id or path is supplied, it is used as the key to lookup.
1622
If both are supplied, the fastest lookup is used, and an error is
1623
raised if they do not both point at the same row.
1625
:param file_id: An optional unicode file_id to be looked up.
1626
:param path: An optional unicode path to be looked up.
1627
:return: The dirstate row tuple for path/file_id, or (None, None)
1629
if file_id is None and path is None:
1630
raise errors.BzrError('must supply file_id or path')
1631
if path is not None:
1632
path = path.encode('utf8')
1633
parent_index = self._get_parent_index()
1634
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1636
def _generate_inventory(self):
1637
"""Create and set self.inventory from the dirstate object.
1639
(So this is only called the first time the inventory is requested for
1640
this tree; it then remains in memory until it's out of date.)
1642
This is relatively expensive: we have to walk the entire dirstate.
1644
if not self._locked:
1645
raise AssertionError(
1646
'cannot generate inventory of an unlocked '
1647
'dirstate revision tree')
1648
# separate call for profiling - makes it clear where the costs are.
1649
self._dirstate._read_dirblocks_if_needed()
1650
if self._revision_id not in self._dirstate.get_parent_ids():
1651
raise AssertionError(
1652
'parent %s has disappeared from %s' % (
1653
self._revision_id, self._dirstate.get_parent_ids()))
1654
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1655
# This is identical now to the WorkingTree _generate_inventory except
1656
# for the tree index use.
1657
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1658
current_id = root_key[2]
1659
if current_entry[parent_index][0] != 'd':
1660
raise AssertionError()
1661
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1662
inv.root.revision = current_entry[parent_index][4]
1663
# Turn some things into local variables
1664
minikind_to_kind = dirstate.DirState._minikind_to_kind
1665
factory = entry_factory
1666
utf8_decode = cache_utf8._utf8_decode
1667
inv_byid = inv._byid
1668
# we could do this straight out of the dirstate; it might be fast
1669
# and should be profiled - RBC 20070216
1670
parent_ies = {'' : inv.root}
1671
for block in self._dirstate._dirblocks[1:]: #skip root
1674
parent_ie = parent_ies[dirname]
1676
# all the paths in this block are not versioned in this tree
1678
for key, entry in block[1]:
1679
minikind, fingerprint, size, executable, revid = entry[parent_index]
1680
if minikind in ('a', 'r'): # absent, relocated
1684
name_unicode = utf8_decode(name)[0]
1686
kind = minikind_to_kind[minikind]
1687
inv_entry = factory[kind](file_id, name_unicode,
1689
inv_entry.revision = revid
1691
inv_entry.executable = executable
1692
inv_entry.text_size = size
1693
inv_entry.text_sha1 = fingerprint
1694
elif kind == 'directory':
1695
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1696
elif kind == 'symlink':
1697
inv_entry.executable = False
1698
inv_entry.text_size = None
1699
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1700
elif kind == 'tree-reference':
1701
inv_entry.reference_revision = fingerprint or None
1703
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1705
# These checks cost us around 40ms on a 55k entry tree
1706
if file_id in inv_byid:
1707
raise AssertionError('file_id %s already in'
1708
' inventory as %s' % (file_id, inv_byid[file_id]))
1709
if name_unicode in parent_ie.children:
1710
raise AssertionError('name %r already in parent'
1712
inv_byid[file_id] = inv_entry
1713
parent_ie.children[name_unicode] = inv_entry
1714
self._inventory = inv
1716
def get_file_mtime(self, file_id, path=None):
1717
"""Return the modification time for this record.
1719
We return the timestamp of the last-changed revision.
1721
# Make sure the file exists
1722
entry = self._get_entry(file_id, path=path)
1723
if entry == (None, None): # do we raise?
1725
parent_index = self._get_parent_index()
1726
last_changed_revision = entry[1][parent_index][4]
1727
return self._repository.get_revision(last_changed_revision).timestamp
1729
def get_file_sha1(self, file_id, path=None, stat_value=None):
1730
entry = self._get_entry(file_id=file_id, path=path)
1731
parent_index = self._get_parent_index()
1732
parent_details = entry[1][parent_index]
1733
if parent_details[0] == 'f':
1734
return parent_details[1]
1737
def get_file(self, file_id, path=None):
1738
return StringIO(self.get_file_text(file_id))
1740
def get_file_size(self, file_id):
1741
"""See Tree.get_file_size"""
1742
return self.inventory[file_id].text_size
1744
def get_file_text(self, file_id, path=None):
1745
_, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1746
return ''.join(content)
1748
def get_reference_revision(self, file_id, path=None):
1749
return self.inventory[file_id].reference_revision
1751
def iter_files_bytes(self, desired_files):
1752
"""See Tree.iter_files_bytes.
1754
This version is implemented on top of Repository.iter_files_bytes"""
1755
parent_index = self._get_parent_index()
1756
repo_desired_files = []
1757
for file_id, identifier in desired_files:
1758
entry = self._get_entry(file_id)
1759
if entry == (None, None):
1760
raise errors.NoSuchId(self, file_id)
1761
repo_desired_files.append((file_id, entry[1][parent_index][4],
1763
return self._repository.iter_files_bytes(repo_desired_files)
1765
def get_symlink_target(self, file_id):
1766
entry = self._get_entry(file_id=file_id)
1767
parent_index = self._get_parent_index()
1768
if entry[1][parent_index][0] != 'l':
1771
target = entry[1][parent_index][1]
1772
target = target.decode('utf8')
1775
def get_revision_id(self):
1776
"""Return the revision id for this tree."""
1777
return self._revision_id
1779
def _get_inventory(self):
1780
if self._inventory is not None:
1781
return self._inventory
1782
self._must_be_locked()
1783
self._generate_inventory()
1784
return self._inventory
1786
inventory = property(_get_inventory,
1787
doc="Inventory of this Tree")
1789
def get_parent_ids(self):
1790
"""The parents of a tree in the dirstate are not cached."""
1791
return self._repository.get_revision(self._revision_id).parent_ids
1793
def has_filename(self, filename):
1794
return bool(self.path2id(filename))
1796
def kind(self, file_id):
1797
entry = self._get_entry(file_id=file_id)[1]
1799
raise errors.NoSuchId(tree=self, file_id=file_id)
1800
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1802
def stored_kind(self, file_id):
1803
"""See Tree.stored_kind"""
1804
return self.kind(file_id)
1806
def path_content_summary(self, path):
1807
"""See Tree.path_content_summary."""
1808
id = self.inventory.path2id(path)
1810
return ('missing', None, None, None)
1811
entry = self._inventory[id]
1814
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1815
elif kind == 'symlink':
1816
return (kind, None, None, entry.symlink_target)
1818
return (kind, None, None, None)
1820
def is_executable(self, file_id, path=None):
1821
ie = self.inventory[file_id]
1822
if ie.kind != "file":
1824
return ie.executable
1826
def list_files(self, include_root=False, from_dir=None, recursive=True):
1827
# We use a standard implementation, because DirStateRevisionTree is
1828
# dealing with one of the parents of the current state
1829
inv = self._get_inventory()
1830
if from_dir is None:
1833
from_dir_id = inv.path2id(from_dir)
1834
if from_dir_id is None:
1835
# Directory not versioned
1837
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1838
if inv.root is not None and not include_root and from_dir is None:
1840
for path, entry in entries:
1841
yield path, 'V', entry.kind, entry.file_id, entry
1843
def lock_read(self):
1844
"""Lock the tree for a set of operations."""
1845
if not self._locked:
1846
self._repository.lock_read()
1847
if self._dirstate._lock_token is None:
1848
self._dirstate.lock_read()
1849
self._dirstate_locked = True
1852
def _must_be_locked(self):
1853
if not self._locked:
1854
raise errors.ObjectNotLocked(self)
1857
def path2id(self, path):
1858
"""Return the id for path in this tree."""
1859
# lookup by path: faster than splitting and walking the ivnentory.
1860
entry = self._get_entry(path=path)
1861
if entry == (None, None):
1866
"""Unlock, freeing any cache memory used during the lock."""
1867
# outside of a lock, the inventory is suspect: release it.
1869
if not self._locked:
1870
self._inventory = None
1872
if self._dirstate_locked:
1873
self._dirstate.unlock()
1874
self._dirstate_locked = False
1875
self._repository.unlock()
1878
def supports_tree_reference(self):
1879
return self._repo_supports_tree_reference
1881
def walkdirs(self, prefix=""):
1882
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1883
# implementation based on an inventory.
1884
# This should be cleaned up to use the much faster Dirstate code
1885
# So for now, we just build up the parent inventory, and extract
1886
# it the same way RevisionTree does.
1887
_directory = 'directory'
1888
inv = self._get_inventory()
1889
top_id = inv.path2id(prefix)
1893
pending = [(prefix, top_id)]
1896
relpath, file_id = pending.pop()
1897
# 0 - relpath, 1- file-id
1899
relroot = relpath + '/'
1902
# FIXME: stash the node in pending
1903
entry = inv[file_id]
1904
for name, child in entry.sorted_children():
1905
toppath = relroot + name
1906
dirblock.append((toppath, name, child.kind, None,
1907
child.file_id, child.kind
1909
yield (relpath, entry.file_id), dirblock
1910
# push the user specified dirs from dirblock
1911
for dir in reversed(dirblock):
1912
if dir[2] == _directory:
1913
pending.append((dir[0], dir[4]))
1916
class InterDirStateTree(InterTree):
1917
"""Fast path optimiser for changes_from with dirstate trees.
1919
This is used only when both trees are in the dirstate working file, and
1920
the source is any parent within the dirstate, and the destination is
1921
the current working tree of the same dirstate.
1923
# this could be generalized to allow comparisons between any trees in the
1924
# dirstate, and possibly between trees stored in different dirstates.
1926
def __init__(self, source, target):
1927
super(InterDirStateTree, self).__init__(source, target)
1928
if not InterDirStateTree.is_compatible(source, target):
1929
raise Exception, "invalid source %r and target %r" % (source, target)
1932
def make_source_parent_tree(source, target):
1933
"""Change the source tree into a parent of the target."""
1934
revid = source.commit('record tree')
1935
target.branch.repository.fetch(source.branch.repository, revid)
1936
target.set_parent_ids([revid])
1937
return target.basis_tree(), target
1940
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1941
result = klass.make_source_parent_tree(source, target)
1942
result[1]._iter_changes = dirstate.ProcessEntryPython
1946
def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
1947
from bzrlib.tests.test__dirstate_helpers import \
1948
CompiledDirstateHelpersFeature
1949
if not CompiledDirstateHelpersFeature.available():
1950
from bzrlib.tests import UnavailableFeature
1951
raise UnavailableFeature(CompiledDirstateHelpersFeature)
1952
from bzrlib._dirstate_helpers_pyx import ProcessEntryC
1953
result = klass.make_source_parent_tree(source, target)
1954
result[1]._iter_changes = ProcessEntryC
1957
_matching_from_tree_format = WorkingTreeFormat4()
1958
_matching_to_tree_format = WorkingTreeFormat4()
1961
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1962
# This method shouldn't be called, because we have python and C
1963
# specific flavours.
1964
raise NotImplementedError
1966
def iter_changes(self, include_unchanged=False,
1967
specific_files=None, pb=None, extra_trees=[],
1968
require_versioned=True, want_unversioned=False):
1969
"""Return the changes from source to target.
1971
:return: An iterator that yields tuples. See InterTree.iter_changes
1973
:param specific_files: An optional list of file paths to restrict the
1974
comparison to. When mapping filenames to ids, all matches in all
1975
trees (including optional extra_trees) are used, and all children of
1976
matched directories are included.
1977
:param include_unchanged: An optional boolean requesting the inclusion of
1978
unchanged entries in the result.
1979
:param extra_trees: An optional list of additional trees to use when
1980
mapping the contents of specific_files (paths) to file_ids.
1981
:param require_versioned: If True, all files in specific_files must be
1982
versioned in one of source, target, extra_trees or
1983
PathsNotVersionedError is raised.
1984
:param want_unversioned: Should unversioned files be returned in the
1985
output. An unversioned file is defined as one with (False, False)
1986
for the versioned pair.
1988
# NB: show_status depends on being able to pass in non-versioned files
1989
# and report them as unknown
1990
# TODO: handle extra trees in the dirstate.
1991
if (extra_trees or specific_files == []):
1992
# we can't fast-path these cases (yet)
1993
return super(InterDirStateTree, self).iter_changes(
1994
include_unchanged, specific_files, pb, extra_trees,
1995
require_versioned, want_unversioned=want_unversioned)
1996
parent_ids = self.target.get_parent_ids()
1997
if not (self.source._revision_id in parent_ids
1998
or self.source._revision_id == _mod_revision.NULL_REVISION):
1999
raise AssertionError(
2000
"revision {%s} is not stored in {%s}, but %s "
2001
"can only be used for trees stored in the dirstate"
2002
% (self.source._revision_id, self.target, self.iter_changes))
2004
if self.source._revision_id == _mod_revision.NULL_REVISION:
2006
indices = (target_index,)
2008
if not (self.source._revision_id in parent_ids):
2009
raise AssertionError(
2010
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2011
self.source._revision_id, parent_ids))
2012
source_index = 1 + parent_ids.index(self.source._revision_id)
2013
indices = (source_index, target_index)
2014
# -- make all specific_files utf8 --
2016
specific_files_utf8 = set()
2017
for path in specific_files:
2018
# Note, if there are many specific files, using cache_utf8
2019
# would be good here.
2020
specific_files_utf8.add(path.encode('utf8'))
2021
specific_files = specific_files_utf8
2023
specific_files = set([''])
2024
# -- specific_files is now a utf8 path set --
2026
# -- get the state object and prepare it.
2027
state = self.target.current_dirstate()
2028
state._read_dirblocks_if_needed()
2029
if require_versioned:
2030
# -- check all supplied paths are versioned in a search tree. --
2032
for path in specific_files:
2033
path_entries = state._entries_for_path(path)
2034
if not path_entries:
2035
# this specified path is not present at all: error
2036
not_versioned.append(path)
2038
found_versioned = False
2039
# for each id at this path
2040
for entry in path_entries:
2042
for index in indices:
2043
if entry[1][index][0] != 'a': # absent
2044
found_versioned = True
2045
# all good: found a versioned cell
2047
if not found_versioned:
2048
# none of the indexes was not 'absent' at all ids for this
2050
not_versioned.append(path)
2051
if len(not_versioned) > 0:
2052
raise errors.PathsNotVersionedError(not_versioned)
2053
# -- remove redundancy in supplied specific_files to prevent over-scanning --
2054
search_specific_files = osutils.minimum_path_selection(specific_files)
2056
use_filesystem_for_exec = (sys.platform != 'win32')
2057
iter_changes = self.target._iter_changes(include_unchanged,
2058
use_filesystem_for_exec, search_specific_files, state,
2059
source_index, target_index, want_unversioned, self.target)
2060
return iter_changes.iter_changes()
2063
def is_compatible(source, target):
2064
# the target must be a dirstate working tree
2065
if not isinstance(target, DirStateWorkingTree):
2067
# the source must be a revtree or dirstate rev tree.
2068
if not isinstance(source,
2069
(revisiontree.RevisionTree, DirStateRevisionTree)):
2071
# the source revid must be in the target dirstate
2072
if not (source._revision_id == _mod_revision.NULL_REVISION or
2073
source._revision_id in target.get_parent_ids()):
2074
# TODO: what about ghosts? it may well need to
2075
# check for them explicitly.
2079
InterTree.register_optimiser(InterDirStateTree)
2082
class Converter3to4(object):
2083
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2086
self.target_format = WorkingTreeFormat4()
2088
def convert(self, tree):
2089
# lock the control files not the tree, so that we dont get tree
2090
# on-unlock behaviours, and so that noone else diddles with the
2091
# tree during upgrade.
2092
tree._control_files.lock_write()
2094
tree.read_working_inventory()
2095
self.create_dirstate_data(tree)
2096
self.update_format(tree)
2097
self.remove_xml_files(tree)
2099
tree._control_files.unlock()
2101
def create_dirstate_data(self, tree):
2102
"""Create the dirstate based data for tree."""
2103
local_path = tree.bzrdir.get_workingtree_transport(None
2104
).local_abspath('dirstate')
2105
state = dirstate.DirState.from_tree(tree, local_path)
2109
def remove_xml_files(self, tree):
2110
"""Remove the oldformat 3 data."""
2111
transport = tree.bzrdir.get_workingtree_transport(None)
2112
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2113
'pending-merges', 'stat-cache']:
2115
transport.delete(path)
2116
except errors.NoSuchFile:
2117
# some files are optional - just deal.
2120
def update_format(self, tree):
2121
"""Change the format marker."""
2122
tree._transport.put_bytes('format',
2123
self.target_format.get_format_string(),
2124
mode=tree.bzrdir._get_file_mode())
2127
class Converter4to5(object):
2128
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2131
self.target_format = WorkingTreeFormat5()
2133
def convert(self, tree):
2134
# lock the control files not the tree, so that we don't get tree
2135
# on-unlock behaviours, and so that no-one else diddles with the
2136
# tree during upgrade.
2137
tree._control_files.lock_write()
2139
self.update_format(tree)
2141
tree._control_files.unlock()
2143
def update_format(self, tree):
2144
"""Change the format marker."""
2145
tree._transport.put_bytes('format',
2146
self.target_format.get_format_string(),
2147
mode=tree.bzrdir._get_file_mode())
2150
class Converter4or5to6(object):
2151
"""Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2154
self.target_format = WorkingTreeFormat6()
2156
def convert(self, tree):
2157
# lock the control files not the tree, so that we don't get tree
2158
# on-unlock behaviours, and so that no-one else diddles with the
2159
# tree during upgrade.
2160
tree._control_files.lock_write()
2162
self.init_custom_control_files(tree)
2163
self.update_format(tree)
2165
tree._control_files.unlock()
2167
def init_custom_control_files(self, tree):
2168
"""Initialize custom control files."""
2169
tree._transport.put_bytes('views', '',
2170
mode=tree.bzrdir._get_file_mode())
2172
def update_format(self, tree):
2173
"""Change the format marker."""
2174
tree._transport.put_bytes('format',
2175
self.target_format.get_format_string(),
2176
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
