1
# Copyright (C) 2007-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""WorkingTree4 format and implementation.
19
WorkingTree4 provides the dirstate based working tree logic.
21
To get a WorkingTree, call bzrdir.open_workingtree() or
22
WorkingTree.open(dir).
25
from cStringIO import StringIO
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
43
revision as _mod_revision,
53
from bzrlib.decorators import needs_read_lock, needs_write_lock
54
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
55
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
56
from bzrlib.mutabletree import needs_tree_write_lock
57
from bzrlib.osutils import (
64
from bzrlib.trace import mutter
65
from bzrlib.transport.local import LocalTransport
66
from bzrlib.tree import InterTree
67
from bzrlib.tree import Tree
68
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
71
class DirStateWorkingTree(WorkingTree3):
72
def __init__(self, basedir,
77
"""Construct a WorkingTree for basedir.
79
If the branch is not supplied, it is opened automatically.
80
If the branch is supplied, it must be the branch for this basedir.
81
(branch.base is not cross checked, because for remote branches that
82
would be meaningless).
84
self._format = _format
86
basedir = safe_unicode(basedir)
87
mutter("opening working tree %r", basedir)
89
self.basedir = realpath(basedir)
90
# if branch is at our basedir and is a format 6 or less
91
# assume all other formats have their own control files.
92
self._control_files = _control_files
93
self._transport = self._control_files._transport
96
# during a read or write lock these objects are set, and are
97
# None the rest of the time.
99
self._inventory = None
101
self._setup_directory_is_tree_reference()
102
self._detect_case_handling()
103
self._rules_searcher = None
104
self.views = self._make_views()
105
#--- allow tests to select the dirstate iter_changes implementation
106
self._iter_changes = dirstate._process_entry
108
@needs_tree_write_lock
109
def _add(self, files, ids, kinds):
110
"""See MutableTree._add."""
111
state = self.current_dirstate()
112
for f, file_id, kind in zip(files, ids, kinds):
115
# special case tree root handling.
116
if f == '' and self.path2id(f) == ROOT_ID:
117
state.set_path_id('', generate_ids.gen_file_id(f))
120
file_id = generate_ids.gen_file_id(f)
121
# deliberately add the file with no cached stat or sha1
122
# - on the first access it will be gathered, and we can
123
# always change this once tests are all passing.
124
state.add(f, file_id, kind, None, '')
125
self._make_dirty(reset_inventory=True)
127
def _make_dirty(self, reset_inventory):
128
"""Make the tree state dirty.
130
:param reset_inventory: True if the cached inventory should be removed
131
(presuming there is one).
134
if reset_inventory and self._inventory is not None:
135
self._inventory = None
137
@needs_tree_write_lock
138
def add_reference(self, sub_tree):
139
# use standard implementation, which calls back to self._add
141
# So we don't store the reference_revision in the working dirstate,
142
# it's just recorded at the moment of commit.
143
self._add_reference(sub_tree)
145
def break_lock(self):
146
"""Break a lock if one is present from another instance.
148
Uses the ui factory to ask for confirmation if the lock may be from
151
This will probe the repository for its lock as well.
153
# if the dirstate is locked by an active process, reject the break lock
156
if self._dirstate is None:
160
state = self._current_dirstate()
161
if state._lock_token is not None:
162
# we already have it locked. sheese, cant break our own lock.
163
raise errors.LockActive(self.basedir)
166
# try for a write lock - need permission to get one anyhow
169
except errors.LockContention:
170
# oslocks fail when a process is still live: fail.
171
# TODO: get the locked lockdir info and give to the user to
172
# assist in debugging.
173
raise errors.LockActive(self.basedir)
178
self._dirstate = None
179
self._control_files.break_lock()
180
self.branch.break_lock()
182
def _comparison_data(self, entry, path):
183
kind, executable, stat_value = \
184
WorkingTree3._comparison_data(self, entry, path)
185
# it looks like a plain directory, but it's really a reference -- see
187
if (self._repo_supports_tree_reference and kind == 'directory'
188
and entry is not None and entry.kind == 'tree-reference'):
189
kind = 'tree-reference'
190
return kind, executable, stat_value
193
def commit(self, message=None, revprops=None, *args, **kwargs):
194
# mark the tree as dirty post commit - commit
195
# can change the current versioned list by doing deletes.
196
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
197
self._make_dirty(reset_inventory=True)
200
def current_dirstate(self):
201
"""Return the current dirstate object.
203
This is not part of the tree interface and only exposed for ease of
206
:raises errors.NotWriteLocked: when not in a lock.
208
self._must_be_locked()
209
return self._current_dirstate()
211
def _current_dirstate(self):
212
"""Internal function that does not check lock status.
214
This is needed for break_lock which also needs the dirstate.
216
if self._dirstate is not None:
217
return self._dirstate
218
local_path = self.bzrdir.get_workingtree_transport(None
219
).local_abspath('dirstate')
220
self._dirstate = dirstate.DirState.on_file(local_path,
221
self._sha1_provider())
222
return self._dirstate
224
def _sha1_provider(self):
225
"""A function that returns a SHA1Provider suitable for this tree.
227
:return: None if content filtering is not supported by this tree.
228
Otherwise, a SHA1Provider is returned that sha's the canonical
229
form of files, i.e. after read filters are applied.
231
if self.supports_content_filtering():
232
return ContentFilterAwareSHA1Provider(self)
236
def filter_unversioned_files(self, paths):
237
"""Filter out paths that are versioned.
239
:return: set of paths.
241
# TODO: make a generic multi-bisect routine roughly that should list
242
# the paths, then process one half at a time recursively, and feed the
243
# results of each bisect in further still
244
paths = sorted(paths)
246
state = self.current_dirstate()
247
# TODO we want a paths_to_dirblocks helper I think
249
dirname, basename = os.path.split(path.encode('utf8'))
250
_, _, _, path_is_versioned = state._get_block_entry_index(
251
dirname, basename, 0)
252
if not path_is_versioned:
257
"""Write all cached data to disk."""
258
if self._control_files._lock_mode != 'w':
259
raise errors.NotWriteLocked(self)
260
self.current_dirstate().save()
261
self._inventory = None
264
@needs_tree_write_lock
265
def _gather_kinds(self, files, kinds):
266
"""See MutableTree._gather_kinds."""
267
for pos, f in enumerate(files):
268
if kinds[pos] is None:
269
kinds[pos] = self._kind(f)
271
def _generate_inventory(self):
272
"""Create and set self.inventory from the dirstate object.
274
This is relatively expensive: we have to walk the entire dirstate.
275
Ideally we would not, and can deprecate this function.
277
#: uncomment to trap on inventory requests.
278
# import pdb;pdb.set_trace()
279
state = self.current_dirstate()
280
state._read_dirblocks_if_needed()
281
root_key, current_entry = self._get_entry(path='')
282
current_id = root_key[2]
283
if not (current_entry[0][0] == 'd'): # directory
284
raise AssertionError(current_entry)
285
inv = Inventory(root_id=current_id)
286
# Turn some things into local variables
287
minikind_to_kind = dirstate.DirState._minikind_to_kind
288
factory = entry_factory
289
utf8_decode = cache_utf8._utf8_decode
291
# we could do this straight out of the dirstate; it might be fast
292
# and should be profiled - RBC 20070216
293
parent_ies = {'' : inv.root}
294
for block in state._dirblocks[1:]: # skip the root
297
parent_ie = parent_ies[dirname]
299
# all the paths in this block are not versioned in this tree
301
for key, entry in block[1]:
302
minikind, link_or_sha1, size, executable, stat = entry[0]
303
if minikind in ('a', 'r'): # absent, relocated
304
# a parent tree only entry
307
name_unicode = utf8_decode(name)[0]
309
kind = minikind_to_kind[minikind]
310
inv_entry = factory[kind](file_id, name_unicode,
313
# This is only needed on win32, where this is the only way
314
# we know the executable bit.
315
inv_entry.executable = executable
316
# not strictly needed: working tree
317
#inv_entry.text_size = size
318
#inv_entry.text_sha1 = sha1
319
elif kind == 'directory':
320
# add this entry to the parent map.
321
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
322
elif kind == 'tree-reference':
323
if not self._repo_supports_tree_reference:
324
raise errors.UnsupportedOperation(
325
self._generate_inventory,
326
self.branch.repository)
327
inv_entry.reference_revision = link_or_sha1 or None
328
elif kind != 'symlink':
329
raise AssertionError("unknown kind %r" % kind)
330
# These checks cost us around 40ms on a 55k entry tree
331
if file_id in inv_byid:
332
raise AssertionError('file_id %s already in'
333
' inventory as %s' % (file_id, inv_byid[file_id]))
334
if name_unicode in parent_ie.children:
335
raise AssertionError('name %r already in parent'
337
inv_byid[file_id] = inv_entry
338
parent_ie.children[name_unicode] = inv_entry
339
self._inventory = inv
341
def _get_entry(self, file_id=None, path=None):
342
"""Get the dirstate row for file_id or path.
344
If either file_id or path is supplied, it is used as the key to lookup.
345
If both are supplied, the fastest lookup is used, and an error is
346
raised if they do not both point at the same row.
348
:param file_id: An optional unicode file_id to be looked up.
349
:param path: An optional unicode path to be looked up.
350
:return: The dirstate row tuple for path/file_id, or (None, None)
352
if file_id is None and path is None:
353
raise errors.BzrError('must supply file_id or path')
354
state = self.current_dirstate()
356
path = path.encode('utf8')
357
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
359
def get_file_sha1(self, file_id, path=None, stat_value=None):
360
# check file id is valid unconditionally.
361
entry = self._get_entry(file_id=file_id, path=path)
363
raise errors.NoSuchId(self, file_id)
365
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
367
file_abspath = self.abspath(path)
368
state = self.current_dirstate()
369
if stat_value is None:
371
stat_value = os.lstat(file_abspath)
373
if e.errno == errno.ENOENT:
377
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
378
stat_value=stat_value)
379
if entry[1][0][0] == 'f':
380
if link_or_sha1 is None:
381
file_obj, statvalue = self.get_file_with_stat(file_id, path)
383
sha1 = osutils.sha_file(file_obj)
386
self._observed_sha1(file_id, path, (sha1, statvalue))
392
def _get_inventory(self):
393
"""Get the inventory for the tree. This is only valid within a lock."""
394
if 'evil' in debug.debug_flags:
395
trace.mutter_callsite(2,
396
"accessing .inventory forces a size of tree translation.")
397
if self._inventory is not None:
398
return self._inventory
399
self._must_be_locked()
400
self._generate_inventory()
401
return self._inventory
403
inventory = property(_get_inventory,
404
doc="Inventory of this Tree")
407
def get_parent_ids(self):
408
"""See Tree.get_parent_ids.
410
This implementation requests the ids list from the dirstate file.
412
return self.current_dirstate().get_parent_ids()
414
def get_reference_revision(self, file_id, path=None):
415
# referenced tree's revision is whatever's currently there
416
return self.get_nested_tree(file_id, path).last_revision()
418
def get_nested_tree(self, file_id, path=None):
420
path = self.id2path(file_id)
421
# else: check file_id is at path?
422
return WorkingTree.open(self.abspath(path))
425
def get_root_id(self):
426
"""Return the id of this trees root"""
427
return self._get_entry(path='')[0][2]
429
def has_id(self, file_id):
430
state = self.current_dirstate()
431
row, parents = self._get_entry(file_id=file_id)
434
return osutils.lexists(pathjoin(
435
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
437
def has_or_had_id(self, file_id):
438
state = self.current_dirstate()
439
row, parents = self._get_entry(file_id=file_id)
440
return row is not None
443
def id2path(self, file_id):
444
"Convert a file-id to a path."
445
state = self.current_dirstate()
446
entry = self._get_entry(file_id=file_id)
447
if entry == (None, None):
448
raise errors.NoSuchId(tree=self, file_id=file_id)
449
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
450
return path_utf8.decode('utf8')
452
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
453
entry = self._get_entry(path=path)
454
if entry == (None, None):
455
return False # Missing entries are not executable
456
return entry[1][0][3] # Executable?
458
if not osutils.supports_executable():
459
def is_executable(self, file_id, path=None):
460
"""Test if a file is executable or not.
462
Note: The caller is expected to take a read-lock before calling this.
464
entry = self._get_entry(file_id=file_id, path=path)
465
if entry == (None, None):
467
return entry[1][0][3]
469
_is_executable_from_path_and_stat = \
470
_is_executable_from_path_and_stat_from_basis
472
def is_executable(self, file_id, path=None):
473
"""Test if a file is executable or not.
475
Note: The caller is expected to take a read-lock before calling this.
477
self._must_be_locked()
479
path = self.id2path(file_id)
480
mode = os.lstat(self.abspath(path)).st_mode
481
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
483
def all_file_ids(self):
484
"""See Tree.iter_all_file_ids"""
485
self._must_be_locked()
487
for key, tree_details in self.current_dirstate()._iter_entries():
488
if tree_details[0][0] in ('a', 'r'): # relocated
495
"""Iterate through file_ids for this tree.
497
file_ids are in a WorkingTree if they are in the working inventory
498
and the working file exists.
501
for key, tree_details in self.current_dirstate()._iter_entries():
502
if tree_details[0][0] in ('a', 'r'): # absent, relocated
503
# not relevant to the working tree
505
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
506
if osutils.lexists(path):
507
result.append(key[2])
510
def iter_references(self):
511
if not self._repo_supports_tree_reference:
512
# When the repo doesn't support references, we will have nothing to
515
for key, tree_details in self.current_dirstate()._iter_entries():
516
if tree_details[0][0] in ('a', 'r'): # absent, relocated
517
# not relevant to the working tree
520
# the root is not a reference.
522
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
524
if self._kind(relpath) == 'tree-reference':
525
yield relpath, key[2]
526
except errors.NoSuchFile:
527
# path is missing on disk.
530
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
531
"""See MutableTree._observed_sha1."""
532
state = self.current_dirstate()
533
entry = self._get_entry(file_id=file_id, path=path)
534
state._observed_sha1(entry, sha1, statvalue)
536
def kind(self, file_id):
537
"""Return the kind of a file.
539
This is always the actual kind that's on disk, regardless of what it
542
Note: The caller is expected to take a read-lock before calling this.
544
relpath = self.id2path(file_id)
546
raise AssertionError(
547
"path for id {%s} is None!" % file_id)
548
return self._kind(relpath)
550
def _kind(self, relpath):
551
abspath = self.abspath(relpath)
552
kind = file_kind(abspath)
553
if (self._repo_supports_tree_reference and kind == 'directory'):
554
entry = self._get_entry(path=relpath)
555
if entry[1] is not None:
556
if entry[1][0][0] == 't':
557
kind = 'tree-reference'
561
def _last_revision(self):
562
"""See Mutable.last_revision."""
563
parent_ids = self.current_dirstate().get_parent_ids()
567
return _mod_revision.NULL_REVISION
570
"""See Branch.lock_read, and WorkingTree.unlock."""
571
self.branch.lock_read()
573
self._control_files.lock_read()
575
state = self.current_dirstate()
576
if not state._lock_token:
578
# set our support for tree references from the repository in
580
self._repo_supports_tree_reference = getattr(
581
self.branch.repository._format, "supports_tree_reference",
584
self._control_files.unlock()
590
def _lock_self_write(self):
591
"""This should be called after the branch is locked."""
593
self._control_files.lock_write()
595
state = self.current_dirstate()
596
if not state._lock_token:
598
# set our support for tree references from the repository in
600
self._repo_supports_tree_reference = getattr(
601
self.branch.repository._format, "supports_tree_reference",
604
self._control_files.unlock()
610
def lock_tree_write(self):
611
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
612
self.branch.lock_read()
613
self._lock_self_write()
615
def lock_write(self):
616
"""See MutableTree.lock_write, and WorkingTree.unlock."""
617
self.branch.lock_write()
618
self._lock_self_write()
620
@needs_tree_write_lock
621
def move(self, from_paths, to_dir, after=False):
622
"""See WorkingTree.move()."""
626
state = self.current_dirstate()
627
if isinstance(from_paths, basestring):
629
to_dir_utf8 = to_dir.encode('utf8')
630
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
631
id_index = state._get_id_index()
632
# check destination directory
633
# get the details for it
634
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
635
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
636
if not entry_present:
637
raise errors.BzrMoveFailedError('', to_dir,
638
errors.NotVersionedError(to_dir))
639
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
640
# get a handle on the block itself.
641
to_block_index = state._ensure_block(
642
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
643
to_block = state._dirblocks[to_block_index]
644
to_abs = self.abspath(to_dir)
645
if not isdir(to_abs):
646
raise errors.BzrMoveFailedError('',to_dir,
647
errors.NotADirectory(to_abs))
649
if to_entry[1][0][0] != 'd':
650
raise errors.BzrMoveFailedError('',to_dir,
651
errors.NotADirectory(to_abs))
653
if self._inventory is not None:
654
update_inventory = True
656
to_dir_id = to_entry[0][2]
657
to_dir_ie = inv[to_dir_id]
659
update_inventory = False
662
def move_one(old_entry, from_path_utf8, minikind, executable,
663
fingerprint, packed_stat, size,
664
to_block, to_key, to_path_utf8):
665
state._make_absent(old_entry)
666
from_key = old_entry[0]
668
lambda:state.update_minimal(from_key,
670
executable=executable,
671
fingerprint=fingerprint,
672
packed_stat=packed_stat,
674
path_utf8=from_path_utf8))
675
state.update_minimal(to_key,
677
executable=executable,
678
fingerprint=fingerprint,
679
packed_stat=packed_stat,
681
path_utf8=to_path_utf8)
682
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
683
new_entry = to_block[1][added_entry_index]
684
rollbacks.append(lambda:state._make_absent(new_entry))
686
for from_rel in from_paths:
687
# from_rel is 'pathinroot/foo/bar'
688
from_rel_utf8 = from_rel.encode('utf8')
689
from_dirname, from_tail = osutils.split(from_rel)
690
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
691
from_entry = self._get_entry(path=from_rel)
692
if from_entry == (None, None):
693
raise errors.BzrMoveFailedError(from_rel,to_dir,
694
errors.NotVersionedError(path=from_rel))
696
from_id = from_entry[0][2]
697
to_rel = pathjoin(to_dir, from_tail)
698
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
699
item_to_entry = self._get_entry(path=to_rel)
700
if item_to_entry != (None, None):
701
raise errors.BzrMoveFailedError(from_rel, to_rel,
702
"Target is already versioned.")
704
if from_rel == to_rel:
705
raise errors.BzrMoveFailedError(from_rel, to_rel,
706
"Source and target are identical.")
708
from_missing = not self.has_filename(from_rel)
709
to_missing = not self.has_filename(to_rel)
716
raise errors.BzrMoveFailedError(from_rel, to_rel,
717
errors.NoSuchFile(path=to_rel,
718
extra="New file has not been created yet"))
720
# neither path exists
721
raise errors.BzrRenameFailedError(from_rel, to_rel,
722
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
724
if from_missing: # implicitly just update our path mapping
727
raise errors.RenameFailedFilesExist(from_rel, to_rel)
730
def rollback_rename():
731
"""A single rename has failed, roll it back."""
732
# roll back everything, even if we encounter trouble doing one
735
# TODO: at least log the other exceptions rather than just
736
# losing them mbp 20070307
738
for rollback in reversed(rollbacks):
742
exc_info = sys.exc_info()
744
raise exc_info[0], exc_info[1], exc_info[2]
746
# perform the disk move first - its the most likely failure point.
748
from_rel_abs = self.abspath(from_rel)
749
to_rel_abs = self.abspath(to_rel)
751
osutils.rename(from_rel_abs, to_rel_abs)
753
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
754
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
756
# perform the rename in the inventory next if needed: its easy
760
from_entry = inv[from_id]
761
current_parent = from_entry.parent_id
762
inv.rename(from_id, to_dir_id, from_tail)
764
lambda: inv.rename(from_id, current_parent, from_tail))
765
# finally do the rename in the dirstate, which is a little
766
# tricky to rollback, but least likely to need it.
767
old_block_index, old_entry_index, dir_present, file_present = \
768
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
769
old_block = state._dirblocks[old_block_index][1]
770
old_entry = old_block[old_entry_index]
771
from_key, old_entry_details = old_entry
772
cur_details = old_entry_details[0]
774
to_key = ((to_block[0],) + from_key[1:3])
775
minikind = cur_details[0]
776
move_one(old_entry, from_path_utf8=from_rel_utf8,
778
executable=cur_details[3],
779
fingerprint=cur_details[1],
780
packed_stat=cur_details[4],
784
to_path_utf8=to_rel_utf8)
787
def update_dirblock(from_dir, to_key, to_dir_utf8):
788
"""Recursively update all entries in this dirblock."""
790
raise AssertionError("renaming root not supported")
791
from_key = (from_dir, '')
792
from_block_idx, present = \
793
state._find_block_index_from_key(from_key)
795
# This is the old record, if it isn't present, then
796
# there is theoretically nothing to update.
797
# (Unless it isn't present because of lazy loading,
798
# but we don't do that yet)
800
from_block = state._dirblocks[from_block_idx]
801
to_block_index, to_entry_index, _, _ = \
802
state._get_block_entry_index(to_key[0], to_key[1], 0)
803
to_block_index = state._ensure_block(
804
to_block_index, to_entry_index, to_dir_utf8)
805
to_block = state._dirblocks[to_block_index]
807
# Grab a copy since move_one may update the list.
808
for entry in from_block[1][:]:
809
if not (entry[0][0] == from_dir):
810
raise AssertionError()
811
cur_details = entry[1][0]
812
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
813
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
814
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
815
minikind = cur_details[0]
817
# Deleted children of a renamed directory
818
# Do not need to be updated.
819
# Children that have been renamed out of this
820
# directory should also not be updated
822
move_one(entry, from_path_utf8=from_path_utf8,
824
executable=cur_details[3],
825
fingerprint=cur_details[1],
826
packed_stat=cur_details[4],
830
to_path_utf8=to_path_utf8)
832
# We need to move all the children of this
834
update_dirblock(from_path_utf8, to_key,
836
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
840
result.append((from_rel, to_rel))
841
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
842
self._make_dirty(reset_inventory=False)
846
def _must_be_locked(self):
847
if not self._control_files._lock_count:
848
raise errors.ObjectNotLocked(self)
851
"""Initialize the state in this tree to be a new tree."""
855
def path2id(self, path):
856
"""Return the id for path in this tree."""
857
path = path.strip('/')
858
entry = self._get_entry(path=path)
859
if entry == (None, None):
863
def paths2ids(self, paths, trees=[], require_versioned=True):
864
"""See Tree.paths2ids().
866
This specialisation fast-paths the case where all the trees are in the
871
parents = self.get_parent_ids()
873
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
875
return super(DirStateWorkingTree, self).paths2ids(paths,
876
trees, require_versioned)
877
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
878
# -- make all paths utf8 --
881
paths_utf8.add(path.encode('utf8'))
883
# -- paths is now a utf8 path set --
884
# -- get the state object and prepare it.
885
state = self.current_dirstate()
886
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
887
and '' not in paths):
888
paths2ids = self._paths2ids_using_bisect
890
paths2ids = self._paths2ids_in_memory
891
return paths2ids(paths, search_indexes,
892
require_versioned=require_versioned)
894
def _paths2ids_in_memory(self, paths, search_indexes,
895
require_versioned=True):
896
state = self.current_dirstate()
897
state._read_dirblocks_if_needed()
898
def _entries_for_path(path):
899
"""Return a list with all the entries that match path for all ids.
901
dirname, basename = os.path.split(path)
902
key = (dirname, basename, '')
903
block_index, present = state._find_block_index_from_key(key)
905
# the block which should contain path is absent.
908
block = state._dirblocks[block_index][1]
909
entry_index, _ = state._find_entry_index(key, block)
910
# we may need to look at multiple entries at this path: walk while the paths match.
911
while (entry_index < len(block) and
912
block[entry_index][0][0:2] == key[0:2]):
913
result.append(block[entry_index])
916
if require_versioned:
917
# -- check all supplied paths are versioned in a search tree. --
920
path_entries = _entries_for_path(path)
922
# this specified path is not present at all: error
923
all_versioned = False
925
found_versioned = False
926
# for each id at this path
927
for entry in path_entries:
929
for index in search_indexes:
930
if entry[1][index][0] != 'a': # absent
931
found_versioned = True
932
# all good: found a versioned cell
934
if not found_versioned:
935
# none of the indexes was not 'absent' at all ids for this
937
all_versioned = False
939
if not all_versioned:
940
raise errors.PathsNotVersionedError(paths)
941
# -- remove redundancy in supplied paths to prevent over-scanning --
942
search_paths = osutils.minimum_path_selection(paths)
944
# for all search_indexs in each path at or under each element of
945
# search_paths, if the detail is relocated: add the id, and add the
946
# relocated path as one to search if its not searched already. If the
947
# detail is not relocated, add the id.
948
searched_paths = set()
950
def _process_entry(entry):
951
"""Look at search_indexes within entry.
953
If a specific tree's details are relocated, add the relocation
954
target to search_paths if not searched already. If it is absent, do
955
nothing. Otherwise add the id to found_ids.
957
for index in search_indexes:
958
if entry[1][index][0] == 'r': # relocated
959
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
960
search_paths.add(entry[1][index][1])
961
elif entry[1][index][0] != 'a': # absent
962
found_ids.add(entry[0][2])
964
current_root = search_paths.pop()
965
searched_paths.add(current_root)
966
# process the entries for this containing directory: the rest will be
967
# found by their parents recursively.
968
root_entries = _entries_for_path(current_root)
970
# this specified path is not present at all, skip it.
972
for entry in root_entries:
973
_process_entry(entry)
974
initial_key = (current_root, '', '')
975
block_index, _ = state._find_block_index_from_key(initial_key)
976
while (block_index < len(state._dirblocks) and
977
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
978
for entry in state._dirblocks[block_index][1]:
979
_process_entry(entry)
983
def _paths2ids_using_bisect(self, paths, search_indexes,
984
require_versioned=True):
985
state = self.current_dirstate()
988
split_paths = sorted(osutils.split(p) for p in paths)
989
found = state._bisect_recursive(split_paths)
991
if require_versioned:
992
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
993
for dir_name in split_paths:
994
if dir_name not in found_dir_names:
995
raise errors.PathsNotVersionedError(paths)
997
for dir_name_id, trees_info in found.iteritems():
998
for index in search_indexes:
999
if trees_info[index][0] not in ('r', 'a'):
1000
found_ids.add(dir_name_id[2])
1003
def read_working_inventory(self):
1004
"""Read the working inventory.
1006
This is a meaningless operation for dirstate, but we obey it anyhow.
1008
return self.inventory
1011
def revision_tree(self, revision_id):
1012
"""See Tree.revision_tree.
1014
WorkingTree4 supplies revision_trees for any basis tree.
1016
dirstate = self.current_dirstate()
1017
parent_ids = dirstate.get_parent_ids()
1018
if revision_id not in parent_ids:
1019
raise errors.NoSuchRevisionInTree(self, revision_id)
1020
if revision_id in dirstate.get_ghosts():
1021
raise errors.NoSuchRevisionInTree(self, revision_id)
1022
return DirStateRevisionTree(dirstate, revision_id,
1023
self.branch.repository)
1025
@needs_tree_write_lock
1026
def set_last_revision(self, new_revision):
1027
"""Change the last revision in the working tree."""
1028
parents = self.get_parent_ids()
1029
if new_revision in (_mod_revision.NULL_REVISION, None):
1030
if len(parents) >= 2:
1031
raise AssertionError(
1032
"setting the last parent to none with a pending merge is "
1034
self.set_parent_ids([])
1036
self.set_parent_ids([new_revision] + parents[1:],
1037
allow_leftmost_as_ghost=True)
1039
@needs_tree_write_lock
1040
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1041
"""Set the parent ids to revision_ids.
1043
See also set_parent_trees. This api will try to retrieve the tree data
1044
for each element of revision_ids from the trees repository. If you have
1045
tree data already available, it is more efficient to use
1046
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1047
an easier API to use.
1049
:param revision_ids: The revision_ids to set as the parent ids of this
1050
working tree. Any of these may be ghosts.
1053
for revision_id in revision_ids:
1055
revtree = self.branch.repository.revision_tree(revision_id)
1056
# TODO: jam 20070213 KnitVersionedFile raises
1057
# RevisionNotPresent rather than NoSuchRevision if a
1058
# given revision_id is not present. Should Repository be
1059
# catching it and re-raising NoSuchRevision?
1060
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1062
trees.append((revision_id, revtree))
1063
self.set_parent_trees(trees,
1064
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1066
@needs_tree_write_lock
1067
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1068
"""Set the parents of the working tree.
1070
:param parents_list: A list of (revision_id, tree) tuples.
1071
If tree is None, then that element is treated as an unreachable
1072
parent tree - i.e. a ghost.
1074
dirstate = self.current_dirstate()
1075
if len(parents_list) > 0:
1076
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1077
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1081
parent_ids = [rev_id for rev_id, tree in parents_list]
1082
graph = self.branch.repository.get_graph()
1083
heads = graph.heads(parent_ids)
1084
accepted_revisions = set()
1086
# convert absent trees to the null tree, which we convert back to
1087
# missing on access.
1088
for rev_id, tree in parents_list:
1089
if len(accepted_revisions) > 0:
1090
# we always accept the first tree
1091
if rev_id in accepted_revisions or rev_id not in heads:
1092
# We have already included either this tree, or its
1093
# descendent, so we skip it.
1095
_mod_revision.check_not_reserved_id(rev_id)
1096
if tree is not None:
1097
real_trees.append((rev_id, tree))
1099
real_trees.append((rev_id,
1100
self.branch.repository.revision_tree(
1101
_mod_revision.NULL_REVISION)))
1102
ghosts.append(rev_id)
1103
accepted_revisions.add(rev_id)
1104
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1105
self._make_dirty(reset_inventory=False)
1107
def _set_root_id(self, file_id):
1108
"""See WorkingTree.set_root_id."""
1109
state = self.current_dirstate()
1110
state.set_path_id('', file_id)
1111
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1112
self._make_dirty(reset_inventory=True)
1114
def _sha_from_stat(self, path, stat_result):
1115
"""Get a sha digest from the tree's stat cache.
1117
The default implementation assumes no stat cache is present.
1119
:param path: The path.
1120
:param stat_result: The stat result being looked up.
1122
return self.current_dirstate().sha1_from_stat(path, stat_result)
1125
def supports_tree_reference(self):
1126
return self._repo_supports_tree_reference
1129
"""Unlock in format 4 trees needs to write the entire dirstate."""
1130
# do non-implementation specific cleanup
1133
if self._control_files._lock_count == 1:
1134
# eventually we should do signature checking during read locks for
1136
if self._control_files._lock_mode == 'w':
1139
if self._dirstate is not None:
1140
# This is a no-op if there are no modifications.
1141
self._dirstate.save()
1142
self._dirstate.unlock()
1143
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1144
# point. Instead, it could check if the header has been
1145
# modified when it is locked, and if not, it can hang on to
1146
# the data it has in memory.
1147
self._dirstate = None
1148
self._inventory = None
1149
# reverse order of locking.
1151
return self._control_files.unlock()
1153
self.branch.unlock()
1155
@needs_tree_write_lock
1156
def unversion(self, file_ids):
1157
"""Remove the file ids in file_ids from the current versioned set.
1159
When a file_id is unversioned, all of its children are automatically
1162
:param file_ids: The file ids to stop versioning.
1163
:raises: NoSuchId if any fileid is not currently versioned.
1167
state = self.current_dirstate()
1168
state._read_dirblocks_if_needed()
1169
ids_to_unversion = set(file_ids)
1170
paths_to_unversion = set()
1172
# check if the root is to be unversioned, if so, assert for now.
1173
# walk the state marking unversioned things as absent.
1174
# if there are any un-unversioned ids at the end, raise
1175
for key, details in state._dirblocks[0][1]:
1176
if (details[0][0] not in ('a', 'r') and # absent or relocated
1177
key[2] in ids_to_unversion):
1178
# I haven't written the code to unversion / yet - it should be
1180
raise errors.BzrError('Unversioning the / is not currently supported')
1182
while block_index < len(state._dirblocks):
1183
# process one directory at a time.
1184
block = state._dirblocks[block_index]
1185
# first check: is the path one to remove - it or its children
1186
delete_block = False
1187
for path in paths_to_unversion:
1188
if (block[0].startswith(path) and
1189
(len(block[0]) == len(path) or
1190
block[0][len(path)] == '/')):
1191
# this entire block should be deleted - its the block for a
1192
# path to unversion; or the child of one
1195
# TODO: trim paths_to_unversion as we pass by paths
1197
# this block is to be deleted: process it.
1198
# TODO: we can special case the no-parents case and
1199
# just forget the whole block.
1201
while entry_index < len(block[1]):
1202
entry = block[1][entry_index]
1203
if entry[1][0][0] in 'ar':
1204
# don't remove absent or renamed entries
1207
# Mark this file id as having been removed
1208
ids_to_unversion.discard(entry[0][2])
1209
if not state._make_absent(entry):
1210
# The block has not shrunk.
1212
# go to the next block. (At the moment we dont delete empty
1217
while entry_index < len(block[1]):
1218
entry = block[1][entry_index]
1219
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1220
# ^ some parent row.
1221
entry[0][2] not in ids_to_unversion):
1222
# ^ not an id to unversion
1225
if entry[1][0][0] == 'd':
1226
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1227
if not state._make_absent(entry):
1229
# we have unversioned this id
1230
ids_to_unversion.remove(entry[0][2])
1232
if ids_to_unversion:
1233
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1234
self._make_dirty(reset_inventory=False)
1235
# have to change the legacy inventory too.
1236
if self._inventory is not None:
1237
for file_id in file_ids:
1238
self._inventory.remove_recursive_id(file_id)
1240
@needs_tree_write_lock
1241
def rename_one(self, from_rel, to_rel, after=False):
1242
"""See WorkingTree.rename_one"""
1244
WorkingTree.rename_one(self, from_rel, to_rel, after)
1246
@needs_tree_write_lock
1247
def apply_inventory_delta(self, changes):
1248
"""See MutableTree.apply_inventory_delta"""
1249
state = self.current_dirstate()
1250
state.update_by_delta(changes)
1251
self._make_dirty(reset_inventory=True)
1253
def update_basis_by_delta(self, new_revid, delta):
1254
"""See MutableTree.update_basis_by_delta."""
1255
if self.last_revision() == new_revid:
1256
raise AssertionError()
1257
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1260
def _validate(self):
1261
self._dirstate._validate()
1263
@needs_tree_write_lock
1264
def _write_inventory(self, inv):
1265
"""Write inventory as the current inventory."""
1267
raise AssertionError("attempting to write an inventory when the "
1268
"dirstate is dirty will lose pending changes")
1269
had_inventory = self._inventory is not None
1270
# Setting self._inventory = None forces the dirstate to regenerate the
1271
# working inventory. We do this because self.inventory may be inv, or
1272
# may have been modified, and either case would prevent a clean delta
1274
self._inventory = None
1276
delta = inv._make_delta(self.inventory)
1278
self.apply_inventory_delta(delta)
1280
self._inventory = inv
1284
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1286
def __init__(self, tree):
1289
def sha1(self, abspath):
1290
"""See dirstate.SHA1Provider.sha1()."""
1291
filters = self.tree._content_filter_stack(
1292
self.tree.relpath(osutils.safe_unicode(abspath)))
1293
return internal_size_sha_file_byname(abspath, filters)[1]
1295
def stat_and_sha1(self, abspath):
1296
"""See dirstate.SHA1Provider.stat_and_sha1()."""
1297
filters = self.tree._content_filter_stack(
1298
self.tree.relpath(osutils.safe_unicode(abspath)))
1299
file_obj = file(abspath, 'rb', 65000)
1301
statvalue = os.fstat(file_obj.fileno())
1303
file_obj = filtered_input_file(file_obj, filters)
1304
sha1 = osutils.size_sha_file(file_obj)[1]
1307
return statvalue, sha1
1310
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1311
"""Dirstate working tree that supports content filtering.
1313
The dirstate holds the hash and size of the canonical form of the file,
1314
and most methods must return that.
1317
def _file_content_summary(self, path, stat_result):
1318
# This is to support the somewhat obsolete path_content_summary method
1319
# with content filtering: see
1320
# <https://bugs.edge.launchpad.net/bzr/+bug/415508>.
1322
# If the dirstate cache is up to date and knows the hash and size,
1324
# Otherwise if there are no content filters, return the on-disk size
1325
# and leave the hash blank.
1326
# Otherwise, read and filter the on-disk file and use its size and
1329
# The dirstate doesn't store the size of the canonical form so we
1330
# can't trust it for content-filtered trees. We just return None.
1331
dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1332
executable = self._is_executable_from_path_and_stat(path, stat_result)
1333
return ('file', None, executable, dirstate_sha1)
1336
class WorkingTree4(DirStateWorkingTree):
1337
"""This is the Format 4 working tree.
1339
This differs from WorkingTree3 by:
1340
- Having a consolidated internal dirstate, stored in a
1341
randomly-accessible sorted file on disk.
1342
- Not having a regular inventory attribute. One can be synthesized
1343
on demand but this is expensive and should be avoided.
1345
This is new in bzr 0.15.
1349
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1350
"""This is the Format 5 working tree.
1352
This differs from WorkingTree4 by:
1353
- Supporting content filtering.
1355
This is new in bzr 1.11.
1359
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1360
"""This is the Format 6 working tree.
1362
This differs from WorkingTree5 by:
1363
- Supporting a current view that may mask the set of files in a tree
1364
impacted by most user operations.
1366
This is new in bzr 1.14.
1369
def _make_views(self):
1370
return views.PathBasedViews(self)
1373
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1375
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1376
accelerator_tree=None, hardlink=False):
1377
"""See WorkingTreeFormat.initialize().
1379
:param revision_id: allows creating a working tree at a different
1380
revision than the branch is at.
1381
:param accelerator_tree: A tree which can be used for retrieving file
1382
contents more quickly than the revision tree, i.e. a workingtree.
1383
The revision tree will be used for cases where accelerator_tree's
1384
content is different.
1385
:param hardlink: If true, hard-link files from accelerator_tree,
1388
These trees get an initial random root id, if their repository supports
1389
rich root data, TREE_ROOT otherwise.
1391
if not isinstance(a_bzrdir.transport, LocalTransport):
1392
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1393
transport = a_bzrdir.get_workingtree_transport(self)
1394
control_files = self._open_control_files(a_bzrdir)
1395
control_files.create_lock()
1396
control_files.lock_write()
1397
transport.put_bytes('format', self.get_format_string(),
1398
mode=a_bzrdir._get_file_mode())
1399
if from_branch is not None:
1400
branch = from_branch
1402
branch = a_bzrdir.open_branch()
1403
if revision_id is None:
1404
revision_id = branch.last_revision()
1405
local_path = transport.local_abspath('dirstate')
1406
# write out new dirstate (must exist when we create the tree)
1407
state = dirstate.DirState.initialize(local_path)
1410
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1414
_control_files=control_files)
1416
wt.lock_tree_write()
1418
self._init_custom_control_files(wt)
1419
if revision_id in (None, _mod_revision.NULL_REVISION):
1420
if branch.repository.supports_rich_root():
1421
wt._set_root_id(generate_ids.gen_root_id())
1423
wt._set_root_id(ROOT_ID)
1426
# frequently, we will get here due to branching. The accelerator
1427
# tree will be the tree from the branch, so the desired basis
1428
# tree will often be a parent of the accelerator tree.
1429
if accelerator_tree is not None:
1431
basis = accelerator_tree.revision_tree(revision_id)
1432
except errors.NoSuchRevision:
1435
basis = branch.repository.revision_tree(revision_id)
1436
if revision_id == _mod_revision.NULL_REVISION:
1439
parents_list = [(revision_id, basis)]
1442
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1444
# if the basis has a root id we have to use that; otherwise we
1445
# use a new random one
1446
basis_root_id = basis.get_root_id()
1447
if basis_root_id is not None:
1448
wt._set_root_id(basis_root_id)
1450
if wt.supports_content_filtering():
1451
# The original tree may not have the same content filters
1452
# applied so we can't safely build the inventory delta from
1454
delta_from_tree = False
1456
delta_from_tree = True
1457
# delta_from_tree is safe even for DirStateRevisionTrees,
1458
# because wt4.apply_inventory_delta does not mutate the input
1459
# inventory entries.
1460
transform.build_tree(basis, wt, accelerator_tree,
1462
delta_from_tree=delta_from_tree)
1466
control_files.unlock()
1470
def _init_custom_control_files(self, wt):
1471
"""Subclasses with custom control files should override this method.
1473
The working tree and control files are locked for writing when this
1476
:param wt: the WorkingTree object
1479
def _open(self, a_bzrdir, control_files):
1480
"""Open the tree itself.
1482
:param a_bzrdir: the dir for the tree.
1483
:param control_files: the control files for the tree.
1485
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1486
branch=a_bzrdir.open_branch(),
1489
_control_files=control_files)
1491
def __get_matchingbzrdir(self):
1492
return self._get_matchingbzrdir()
1494
def _get_matchingbzrdir(self):
1495
"""Overrideable method to get a bzrdir for testing."""
1496
# please test against something that will let us do tree references
1497
return bzrdir.format_registry.make_bzrdir(
1498
'dirstate-with-subtree')
1500
_matchingbzrdir = property(__get_matchingbzrdir)
1503
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1504
"""The first consolidated dirstate working tree format.
1507
- exists within a metadir controlling .bzr
1508
- includes an explicit version marker for the workingtree control
1509
files, separate from the BzrDir format
1510
- modifies the hash cache format
1511
- is new in bzr 0.15
1512
- uses a LockDir to guard access to it.
1515
upgrade_recommended = False
1517
_tree_class = WorkingTree4
1519
def get_format_string(self):
1520
"""See WorkingTreeFormat.get_format_string()."""
1521
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1523
def get_format_description(self):
1524
"""See WorkingTreeFormat.get_format_description()."""
1525
return "Working tree format 4"
1528
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1529
"""WorkingTree format supporting content filtering.
1532
upgrade_recommended = False
1534
_tree_class = WorkingTree5
1536
def get_format_string(self):
1537
"""See WorkingTreeFormat.get_format_string()."""
1538
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1540
def get_format_description(self):
1541
"""See WorkingTreeFormat.get_format_description()."""
1542
return "Working tree format 5"
1544
def supports_content_filtering(self):
1548
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1549
"""WorkingTree format supporting views.
1552
upgrade_recommended = False
1554
_tree_class = WorkingTree6
1556
def get_format_string(self):
1557
"""See WorkingTreeFormat.get_format_string()."""
1558
return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1560
def get_format_description(self):
1561
"""See WorkingTreeFormat.get_format_description()."""
1562
return "Working tree format 6"
1564
def _init_custom_control_files(self, wt):
1565
"""Subclasses with custom control files should override this method."""
1566
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1568
def supports_content_filtering(self):
1571
def supports_views(self):
1575
class DirStateRevisionTree(Tree):
1576
"""A revision tree pulling the inventory from a dirstate.
1578
Note that this is one of the historical (ie revision) trees cached in the
1579
dirstate for easy access, not the workingtree.
1582
def __init__(self, dirstate, revision_id, repository):
1583
self._dirstate = dirstate
1584
self._revision_id = revision_id
1585
self._repository = repository
1586
self._inventory = None
1588
self._dirstate_locked = False
1589
self._repo_supports_tree_reference = getattr(
1590
repository._format, "supports_tree_reference",
1594
return "<%s of %s in %s>" % \
1595
(self.__class__.__name__, self._revision_id, self._dirstate)
1597
def annotate_iter(self, file_id,
1598
default_revision=_mod_revision.CURRENT_REVISION):
1599
"""See Tree.annotate_iter"""
1600
text_key = (file_id, self.inventory[file_id].revision)
1601
annotations = self._repository.texts.annotate(text_key)
1602
return [(key[-1], line) for (key, line) in annotations]
1604
def _get_ancestors(self, default_revision):
1605
return set(self._repository.get_ancestry(self._revision_id,
1607
def _comparison_data(self, entry, path):
1608
"""See Tree._comparison_data."""
1610
return None, False, None
1611
# trust the entry as RevisionTree does, but this may not be
1612
# sensible: the entry might not have come from us?
1613
return entry.kind, entry.executable, None
1615
def _file_size(self, entry, stat_value):
1616
return entry.text_size
1618
def filter_unversioned_files(self, paths):
1619
"""Filter out paths that are not versioned.
1621
:return: set of paths.
1623
pred = self.has_filename
1624
return set((p for p in paths if not pred(p)))
1626
def get_root_id(self):
1627
return self.path2id('')
1629
def id2path(self, file_id):
1630
"Convert a file-id to a path."
1631
entry = self._get_entry(file_id=file_id)
1632
if entry == (None, None):
1633
raise errors.NoSuchId(tree=self, file_id=file_id)
1634
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1635
return path_utf8.decode('utf8')
1637
def iter_references(self):
1638
if not self._repo_supports_tree_reference:
1639
# When the repo doesn't support references, we will have nothing to
1642
# Otherwise, fall back to the default implementation
1643
return super(DirStateRevisionTree, self).iter_references()
1645
def _get_parent_index(self):
1646
"""Return the index in the dirstate referenced by this tree."""
1647
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1649
def _get_entry(self, file_id=None, path=None):
1650
"""Get the dirstate row for file_id or path.
1652
If either file_id or path is supplied, it is used as the key to lookup.
1653
If both are supplied, the fastest lookup is used, and an error is
1654
raised if they do not both point at the same row.
1656
:param file_id: An optional unicode file_id to be looked up.
1657
:param path: An optional unicode path to be looked up.
1658
:return: The dirstate row tuple for path/file_id, or (None, None)
1660
if file_id is None and path is None:
1661
raise errors.BzrError('must supply file_id or path')
1662
if path is not None:
1663
path = path.encode('utf8')
1664
parent_index = self._get_parent_index()
1665
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1667
def _generate_inventory(self):
1668
"""Create and set self.inventory from the dirstate object.
1670
(So this is only called the first time the inventory is requested for
1671
this tree; it then remains in memory until it's out of date.)
1673
This is relatively expensive: we have to walk the entire dirstate.
1675
if not self._locked:
1676
raise AssertionError(
1677
'cannot generate inventory of an unlocked '
1678
'dirstate revision tree')
1679
# separate call for profiling - makes it clear where the costs are.
1680
self._dirstate._read_dirblocks_if_needed()
1681
if self._revision_id not in self._dirstate.get_parent_ids():
1682
raise AssertionError(
1683
'parent %s has disappeared from %s' % (
1684
self._revision_id, self._dirstate.get_parent_ids()))
1685
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1686
# This is identical now to the WorkingTree _generate_inventory except
1687
# for the tree index use.
1688
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1689
current_id = root_key[2]
1690
if current_entry[parent_index][0] != 'd':
1691
raise AssertionError()
1692
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1693
inv.root.revision = current_entry[parent_index][4]
1694
# Turn some things into local variables
1695
minikind_to_kind = dirstate.DirState._minikind_to_kind
1696
factory = entry_factory
1697
utf8_decode = cache_utf8._utf8_decode
1698
inv_byid = inv._byid
1699
# we could do this straight out of the dirstate; it might be fast
1700
# and should be profiled - RBC 20070216
1701
parent_ies = {'' : inv.root}
1702
for block in self._dirstate._dirblocks[1:]: #skip root
1705
parent_ie = parent_ies[dirname]
1707
# all the paths in this block are not versioned in this tree
1709
for key, entry in block[1]:
1710
minikind, fingerprint, size, executable, revid = entry[parent_index]
1711
if minikind in ('a', 'r'): # absent, relocated
1715
name_unicode = utf8_decode(name)[0]
1717
kind = minikind_to_kind[minikind]
1718
inv_entry = factory[kind](file_id, name_unicode,
1720
inv_entry.revision = revid
1722
inv_entry.executable = executable
1723
inv_entry.text_size = size
1724
inv_entry.text_sha1 = fingerprint
1725
elif kind == 'directory':
1726
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1727
elif kind == 'symlink':
1728
inv_entry.executable = False
1729
inv_entry.text_size = None
1730
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1731
elif kind == 'tree-reference':
1732
inv_entry.reference_revision = fingerprint or None
1734
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1736
# These checks cost us around 40ms on a 55k entry tree
1737
if file_id in inv_byid:
1738
raise AssertionError('file_id %s already in'
1739
' inventory as %s' % (file_id, inv_byid[file_id]))
1740
if name_unicode in parent_ie.children:
1741
raise AssertionError('name %r already in parent'
1743
inv_byid[file_id] = inv_entry
1744
parent_ie.children[name_unicode] = inv_entry
1745
self._inventory = inv
1747
def get_file_mtime(self, file_id, path=None):
1748
"""Return the modification time for this record.
1750
We return the timestamp of the last-changed revision.
1752
# Make sure the file exists
1753
entry = self._get_entry(file_id, path=path)
1754
if entry == (None, None): # do we raise?
1756
parent_index = self._get_parent_index()
1757
last_changed_revision = entry[1][parent_index][4]
1759
rev = self._repository.get_revision(last_changed_revision)
1760
except errors.NoSuchRevision:
1761
raise errors.FileTimestampUnavailable(self.id2path(file_id))
1762
return rev.timestamp
1764
def get_file_sha1(self, file_id, path=None, stat_value=None):
1765
entry = self._get_entry(file_id=file_id, path=path)
1766
parent_index = self._get_parent_index()
1767
parent_details = entry[1][parent_index]
1768
if parent_details[0] == 'f':
1769
return parent_details[1]
1772
def get_file(self, file_id, path=None):
1773
return StringIO(self.get_file_text(file_id))
1775
def get_file_size(self, file_id):
1776
"""See Tree.get_file_size"""
1777
return self.inventory[file_id].text_size
1779
def get_file_text(self, file_id, path=None):
1780
_, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1781
return ''.join(content)
1783
def get_reference_revision(self, file_id, path=None):
1784
return self.inventory[file_id].reference_revision
1786
def iter_files_bytes(self, desired_files):
1787
"""See Tree.iter_files_bytes.
1789
This version is implemented on top of Repository.iter_files_bytes"""
1790
parent_index = self._get_parent_index()
1791
repo_desired_files = []
1792
for file_id, identifier in desired_files:
1793
entry = self._get_entry(file_id)
1794
if entry == (None, None):
1795
raise errors.NoSuchId(self, file_id)
1796
repo_desired_files.append((file_id, entry[1][parent_index][4],
1798
return self._repository.iter_files_bytes(repo_desired_files)
1800
def get_symlink_target(self, file_id):
1801
entry = self._get_entry(file_id=file_id)
1802
parent_index = self._get_parent_index()
1803
if entry[1][parent_index][0] != 'l':
1806
target = entry[1][parent_index][1]
1807
target = target.decode('utf8')
1810
def get_revision_id(self):
1811
"""Return the revision id for this tree."""
1812
return self._revision_id
1814
def _get_inventory(self):
1815
if self._inventory is not None:
1816
return self._inventory
1817
self._must_be_locked()
1818
self._generate_inventory()
1819
return self._inventory
1821
inventory = property(_get_inventory,
1822
doc="Inventory of this Tree")
1824
def get_parent_ids(self):
1825
"""The parents of a tree in the dirstate are not cached."""
1826
return self._repository.get_revision(self._revision_id).parent_ids
1828
def has_filename(self, filename):
1829
return bool(self.path2id(filename))
1831
def kind(self, file_id):
1832
entry = self._get_entry(file_id=file_id)[1]
1834
raise errors.NoSuchId(tree=self, file_id=file_id)
1835
parent_index = self._get_parent_index()
1836
return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1838
def stored_kind(self, file_id):
1839
"""See Tree.stored_kind"""
1840
return self.kind(file_id)
1842
def path_content_summary(self, path):
1843
"""See Tree.path_content_summary."""
1844
id = self.inventory.path2id(path)
1846
return ('missing', None, None, None)
1847
entry = self._inventory[id]
1850
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1851
elif kind == 'symlink':
1852
return (kind, None, None, entry.symlink_target)
1854
return (kind, None, None, None)
1856
def is_executable(self, file_id, path=None):
1857
ie = self.inventory[file_id]
1858
if ie.kind != "file":
1860
return ie.executable
1862
def list_files(self, include_root=False, from_dir=None, recursive=True):
1863
# We use a standard implementation, because DirStateRevisionTree is
1864
# dealing with one of the parents of the current state
1865
inv = self._get_inventory()
1866
if from_dir is None:
1869
from_dir_id = inv.path2id(from_dir)
1870
if from_dir_id is None:
1871
# Directory not versioned
1873
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1874
if inv.root is not None and not include_root and from_dir is None:
1876
for path, entry in entries:
1877
yield path, 'V', entry.kind, entry.file_id, entry
1879
def lock_read(self):
1880
"""Lock the tree for a set of operations."""
1881
if not self._locked:
1882
self._repository.lock_read()
1883
if self._dirstate._lock_token is None:
1884
self._dirstate.lock_read()
1885
self._dirstate_locked = True
1888
def _must_be_locked(self):
1889
if not self._locked:
1890
raise errors.ObjectNotLocked(self)
1893
def path2id(self, path):
1894
"""Return the id for path in this tree."""
1895
# lookup by path: faster than splitting and walking the ivnentory.
1896
entry = self._get_entry(path=path)
1897
if entry == (None, None):
1902
"""Unlock, freeing any cache memory used during the lock."""
1903
# outside of a lock, the inventory is suspect: release it.
1905
if not self._locked:
1906
self._inventory = None
1908
if self._dirstate_locked:
1909
self._dirstate.unlock()
1910
self._dirstate_locked = False
1911
self._repository.unlock()
1914
def supports_tree_reference(self):
1915
return self._repo_supports_tree_reference
1917
def walkdirs(self, prefix=""):
1918
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1919
# implementation based on an inventory.
1920
# This should be cleaned up to use the much faster Dirstate code
1921
# So for now, we just build up the parent inventory, and extract
1922
# it the same way RevisionTree does.
1923
_directory = 'directory'
1924
inv = self._get_inventory()
1925
top_id = inv.path2id(prefix)
1929
pending = [(prefix, top_id)]
1932
relpath, file_id = pending.pop()
1933
# 0 - relpath, 1- file-id
1935
relroot = relpath + '/'
1938
# FIXME: stash the node in pending
1939
entry = inv[file_id]
1940
for name, child in entry.sorted_children():
1941
toppath = relroot + name
1942
dirblock.append((toppath, name, child.kind, None,
1943
child.file_id, child.kind
1945
yield (relpath, entry.file_id), dirblock
1946
# push the user specified dirs from dirblock
1947
for dir in reversed(dirblock):
1948
if dir[2] == _directory:
1949
pending.append((dir[0], dir[4]))
1952
class InterDirStateTree(InterTree):
1953
"""Fast path optimiser for changes_from with dirstate trees.
1955
This is used only when both trees are in the dirstate working file, and
1956
the source is any parent within the dirstate, and the destination is
1957
the current working tree of the same dirstate.
1959
# this could be generalized to allow comparisons between any trees in the
1960
# dirstate, and possibly between trees stored in different dirstates.
1962
def __init__(self, source, target):
1963
super(InterDirStateTree, self).__init__(source, target)
1964
if not InterDirStateTree.is_compatible(source, target):
1965
raise Exception, "invalid source %r and target %r" % (source, target)
1968
def make_source_parent_tree(source, target):
1969
"""Change the source tree into a parent of the target."""
1970
revid = source.commit('record tree')
1971
target.branch.repository.fetch(source.branch.repository, revid)
1972
target.set_parent_ids([revid])
1973
return target.basis_tree(), target
1976
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1977
result = klass.make_source_parent_tree(source, target)
1978
result[1]._iter_changes = dirstate.ProcessEntryPython
1982
def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
1984
from bzrlib.tests.test__dirstate_helpers import \
1985
compiled_dirstate_helpers_feature
1986
test_case.requireFeature(compiled_dirstate_helpers_feature)
1987
from bzrlib._dirstate_helpers_pyx import ProcessEntryC
1988
result = klass.make_source_parent_tree(source, target)
1989
result[1]._iter_changes = ProcessEntryC
1992
_matching_from_tree_format = WorkingTreeFormat4()
1993
_matching_to_tree_format = WorkingTreeFormat4()
1996
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1997
# This method shouldn't be called, because we have python and C
1998
# specific flavours.
1999
raise NotImplementedError
2001
def iter_changes(self, include_unchanged=False,
2002
specific_files=None, pb=None, extra_trees=[],
2003
require_versioned=True, want_unversioned=False):
2004
"""Return the changes from source to target.
2006
:return: An iterator that yields tuples. See InterTree.iter_changes
2008
:param specific_files: An optional list of file paths to restrict the
2009
comparison to. When mapping filenames to ids, all matches in all
2010
trees (including optional extra_trees) are used, and all children of
2011
matched directories are included.
2012
:param include_unchanged: An optional boolean requesting the inclusion of
2013
unchanged entries in the result.
2014
:param extra_trees: An optional list of additional trees to use when
2015
mapping the contents of specific_files (paths) to file_ids.
2016
:param require_versioned: If True, all files in specific_files must be
2017
versioned in one of source, target, extra_trees or
2018
PathsNotVersionedError is raised.
2019
:param want_unversioned: Should unversioned files be returned in the
2020
output. An unversioned file is defined as one with (False, False)
2021
for the versioned pair.
2023
# TODO: handle extra trees in the dirstate.
2024
if (extra_trees or specific_files == []):
2025
# we can't fast-path these cases (yet)
2026
return super(InterDirStateTree, self).iter_changes(
2027
include_unchanged, specific_files, pb, extra_trees,
2028
require_versioned, want_unversioned=want_unversioned)
2029
parent_ids = self.target.get_parent_ids()
2030
if not (self.source._revision_id in parent_ids
2031
or self.source._revision_id == _mod_revision.NULL_REVISION):
2032
raise AssertionError(
2033
"revision {%s} is not stored in {%s}, but %s "
2034
"can only be used for trees stored in the dirstate"
2035
% (self.source._revision_id, self.target, self.iter_changes))
2037
if self.source._revision_id == _mod_revision.NULL_REVISION:
2039
indices = (target_index,)
2041
if not (self.source._revision_id in parent_ids):
2042
raise AssertionError(
2043
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2044
self.source._revision_id, parent_ids))
2045
source_index = 1 + parent_ids.index(self.source._revision_id)
2046
indices = (source_index, target_index)
2047
# -- make all specific_files utf8 --
2049
specific_files_utf8 = set()
2050
for path in specific_files:
2051
# Note, if there are many specific files, using cache_utf8
2052
# would be good here.
2053
specific_files_utf8.add(path.encode('utf8'))
2054
specific_files = specific_files_utf8
2056
specific_files = set([''])
2057
# -- specific_files is now a utf8 path set --
2059
# -- get the state object and prepare it.
2060
state = self.target.current_dirstate()
2061
state._read_dirblocks_if_needed()
2062
if require_versioned:
2063
# -- check all supplied paths are versioned in a search tree. --
2065
for path in specific_files:
2066
path_entries = state._entries_for_path(path)
2067
if not path_entries:
2068
# this specified path is not present at all: error
2069
not_versioned.append(path)
2071
found_versioned = False
2072
# for each id at this path
2073
for entry in path_entries:
2075
for index in indices:
2076
if entry[1][index][0] != 'a': # absent
2077
found_versioned = True
2078
# all good: found a versioned cell
2080
if not found_versioned:
2081
# none of the indexes was not 'absent' at all ids for this
2083
not_versioned.append(path)
2084
if len(not_versioned) > 0:
2085
raise errors.PathsNotVersionedError(not_versioned)
2086
# -- remove redundancy in supplied specific_files to prevent over-scanning --
2087
search_specific_files = osutils.minimum_path_selection(specific_files)
2089
use_filesystem_for_exec = (sys.platform != 'win32')
2090
iter_changes = self.target._iter_changes(include_unchanged,
2091
use_filesystem_for_exec, search_specific_files, state,
2092
source_index, target_index, want_unversioned, self.target)
2093
return iter_changes.iter_changes()
2096
def is_compatible(source, target):
2097
# the target must be a dirstate working tree
2098
if not isinstance(target, DirStateWorkingTree):
2100
# the source must be a revtree or dirstate rev tree.
2101
if not isinstance(source,
2102
(revisiontree.RevisionTree, DirStateRevisionTree)):
2104
# the source revid must be in the target dirstate
2105
if not (source._revision_id == _mod_revision.NULL_REVISION or
2106
source._revision_id in target.get_parent_ids()):
2107
# TODO: what about ghosts? it may well need to
2108
# check for them explicitly.
2112
InterTree.register_optimiser(InterDirStateTree)
2115
class Converter3to4(object):
2116
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2119
self.target_format = WorkingTreeFormat4()
2121
def convert(self, tree):
2122
# lock the control files not the tree, so that we dont get tree
2123
# on-unlock behaviours, and so that noone else diddles with the
2124
# tree during upgrade.
2125
tree._control_files.lock_write()
2127
tree.read_working_inventory()
2128
self.create_dirstate_data(tree)
2129
self.update_format(tree)
2130
self.remove_xml_files(tree)
2132
tree._control_files.unlock()
2134
def create_dirstate_data(self, tree):
2135
"""Create the dirstate based data for tree."""
2136
local_path = tree.bzrdir.get_workingtree_transport(None
2137
).local_abspath('dirstate')
2138
state = dirstate.DirState.from_tree(tree, local_path)
2142
def remove_xml_files(self, tree):
2143
"""Remove the oldformat 3 data."""
2144
transport = tree.bzrdir.get_workingtree_transport(None)
2145
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2146
'pending-merges', 'stat-cache']:
2148
transport.delete(path)
2149
except errors.NoSuchFile:
2150
# some files are optional - just deal.
2153
def update_format(self, tree):
2154
"""Change the format marker."""
2155
tree._transport.put_bytes('format',
2156
self.target_format.get_format_string(),
2157
mode=tree.bzrdir._get_file_mode())
2160
class Converter4to5(object):
2161
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2164
self.target_format = WorkingTreeFormat5()
2166
def convert(self, tree):
2167
# lock the control files not the tree, so that we don't get tree
2168
# on-unlock behaviours, and so that no-one else diddles with the
2169
# tree during upgrade.
2170
tree._control_files.lock_write()
2172
self.update_format(tree)
2174
tree._control_files.unlock()
2176
def update_format(self, tree):
2177
"""Change the format marker."""
2178
tree._transport.put_bytes('format',
2179
self.target_format.get_format_string(),
2180
mode=tree.bzrdir._get_file_mode())
2183
class Converter4or5to6(object):
2184
"""Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2187
self.target_format = WorkingTreeFormat6()
2189
def convert(self, tree):
2190
# lock the control files not the tree, so that we don't get tree
2191
# on-unlock behaviours, and so that no-one else diddles with the
2192
# tree during upgrade.
2193
tree._control_files.lock_write()
2195
self.init_custom_control_files(tree)
2196
self.update_format(tree)
2198
tree._control_files.unlock()
2200
def init_custom_control_files(self, tree):
2201
"""Initialize custom control files."""
2202
tree._transport.put_bytes('views', '',
2203
mode=tree.bzrdir._get_file_mode())
2205
def update_format(self, tree):
2206
"""Change the format marker."""
2207
tree._transport.put_bytes('format',
2208
self.target_format.get_format_string(),
2209
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
