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.
572
:return: An object with an unlock method which will release the lock
575
self.branch.lock_read()
577
self._control_files.lock_read()
579
state = self.current_dirstate()
580
if not state._lock_token:
582
# set our support for tree references from the repository in
584
self._repo_supports_tree_reference = getattr(
585
self.branch.repository._format, "supports_tree_reference",
588
self._control_files.unlock()
595
def _lock_self_write(self):
596
"""This should be called after the branch is locked."""
598
self._control_files.lock_write()
600
state = self.current_dirstate()
601
if not state._lock_token:
603
# set our support for tree references from the repository in
605
self._repo_supports_tree_reference = getattr(
606
self.branch.repository._format, "supports_tree_reference",
609
self._control_files.unlock()
616
def lock_tree_write(self):
617
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
619
:return: An object with an unlock method which will release the lock
622
self.branch.lock_read()
623
return self._lock_self_write()
625
def lock_write(self):
626
"""See MutableTree.lock_write, and WorkingTree.unlock.
628
:return: An object with an unlock method which will release the lock
631
self.branch.lock_write()
632
return self._lock_self_write()
634
@needs_tree_write_lock
635
def move(self, from_paths, to_dir, after=False):
636
"""See WorkingTree.move()."""
640
state = self.current_dirstate()
641
if isinstance(from_paths, basestring):
643
to_dir_utf8 = to_dir.encode('utf8')
644
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
645
id_index = state._get_id_index()
646
# check destination directory
647
# get the details for it
648
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
649
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
650
if not entry_present:
651
raise errors.BzrMoveFailedError('', to_dir,
652
errors.NotVersionedError(to_dir))
653
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
654
# get a handle on the block itself.
655
to_block_index = state._ensure_block(
656
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
657
to_block = state._dirblocks[to_block_index]
658
to_abs = self.abspath(to_dir)
659
if not isdir(to_abs):
660
raise errors.BzrMoveFailedError('',to_dir,
661
errors.NotADirectory(to_abs))
663
if to_entry[1][0][0] != 'd':
664
raise errors.BzrMoveFailedError('',to_dir,
665
errors.NotADirectory(to_abs))
667
if self._inventory is not None:
668
update_inventory = True
670
to_dir_id = to_entry[0][2]
671
to_dir_ie = inv[to_dir_id]
673
update_inventory = False
676
def move_one(old_entry, from_path_utf8, minikind, executable,
677
fingerprint, packed_stat, size,
678
to_block, to_key, to_path_utf8):
679
state._make_absent(old_entry)
680
from_key = old_entry[0]
682
lambda:state.update_minimal(from_key,
684
executable=executable,
685
fingerprint=fingerprint,
686
packed_stat=packed_stat,
688
path_utf8=from_path_utf8))
689
state.update_minimal(to_key,
691
executable=executable,
692
fingerprint=fingerprint,
693
packed_stat=packed_stat,
695
path_utf8=to_path_utf8)
696
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
697
new_entry = to_block[1][added_entry_index]
698
rollbacks.append(lambda:state._make_absent(new_entry))
700
for from_rel in from_paths:
701
# from_rel is 'pathinroot/foo/bar'
702
from_rel_utf8 = from_rel.encode('utf8')
703
from_dirname, from_tail = osutils.split(from_rel)
704
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
705
from_entry = self._get_entry(path=from_rel)
706
if from_entry == (None, None):
707
raise errors.BzrMoveFailedError(from_rel,to_dir,
708
errors.NotVersionedError(path=from_rel))
710
from_id = from_entry[0][2]
711
to_rel = pathjoin(to_dir, from_tail)
712
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
713
item_to_entry = self._get_entry(path=to_rel)
714
if item_to_entry != (None, None):
715
raise errors.BzrMoveFailedError(from_rel, to_rel,
716
"Target is already versioned.")
718
if from_rel == to_rel:
719
raise errors.BzrMoveFailedError(from_rel, to_rel,
720
"Source and target are identical.")
722
from_missing = not self.has_filename(from_rel)
723
to_missing = not self.has_filename(to_rel)
730
raise errors.BzrMoveFailedError(from_rel, to_rel,
731
errors.NoSuchFile(path=to_rel,
732
extra="New file has not been created yet"))
734
# neither path exists
735
raise errors.BzrRenameFailedError(from_rel, to_rel,
736
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
738
if from_missing: # implicitly just update our path mapping
741
raise errors.RenameFailedFilesExist(from_rel, to_rel)
744
def rollback_rename():
745
"""A single rename has failed, roll it back."""
746
# roll back everything, even if we encounter trouble doing one
749
# TODO: at least log the other exceptions rather than just
750
# losing them mbp 20070307
752
for rollback in reversed(rollbacks):
756
exc_info = sys.exc_info()
758
raise exc_info[0], exc_info[1], exc_info[2]
760
# perform the disk move first - its the most likely failure point.
762
from_rel_abs = self.abspath(from_rel)
763
to_rel_abs = self.abspath(to_rel)
765
osutils.rename(from_rel_abs, to_rel_abs)
767
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
768
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
770
# perform the rename in the inventory next if needed: its easy
774
from_entry = inv[from_id]
775
current_parent = from_entry.parent_id
776
inv.rename(from_id, to_dir_id, from_tail)
778
lambda: inv.rename(from_id, current_parent, from_tail))
779
# finally do the rename in the dirstate, which is a little
780
# tricky to rollback, but least likely to need it.
781
old_block_index, old_entry_index, dir_present, file_present = \
782
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
783
old_block = state._dirblocks[old_block_index][1]
784
old_entry = old_block[old_entry_index]
785
from_key, old_entry_details = old_entry
786
cur_details = old_entry_details[0]
788
to_key = ((to_block[0],) + from_key[1:3])
789
minikind = cur_details[0]
790
move_one(old_entry, from_path_utf8=from_rel_utf8,
792
executable=cur_details[3],
793
fingerprint=cur_details[1],
794
packed_stat=cur_details[4],
798
to_path_utf8=to_rel_utf8)
801
def update_dirblock(from_dir, to_key, to_dir_utf8):
802
"""Recursively update all entries in this dirblock."""
804
raise AssertionError("renaming root not supported")
805
from_key = (from_dir, '')
806
from_block_idx, present = \
807
state._find_block_index_from_key(from_key)
809
# This is the old record, if it isn't present, then
810
# there is theoretically nothing to update.
811
# (Unless it isn't present because of lazy loading,
812
# but we don't do that yet)
814
from_block = state._dirblocks[from_block_idx]
815
to_block_index, to_entry_index, _, _ = \
816
state._get_block_entry_index(to_key[0], to_key[1], 0)
817
to_block_index = state._ensure_block(
818
to_block_index, to_entry_index, to_dir_utf8)
819
to_block = state._dirblocks[to_block_index]
821
# Grab a copy since move_one may update the list.
822
for entry in from_block[1][:]:
823
if not (entry[0][0] == from_dir):
824
raise AssertionError()
825
cur_details = entry[1][0]
826
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
827
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
828
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
829
minikind = cur_details[0]
831
# Deleted children of a renamed directory
832
# Do not need to be updated.
833
# Children that have been renamed out of this
834
# directory should also not be updated
836
move_one(entry, from_path_utf8=from_path_utf8,
838
executable=cur_details[3],
839
fingerprint=cur_details[1],
840
packed_stat=cur_details[4],
844
to_path_utf8=to_path_utf8)
846
# We need to move all the children of this
848
update_dirblock(from_path_utf8, to_key,
850
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
854
result.append((from_rel, to_rel))
855
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
856
self._make_dirty(reset_inventory=False)
860
def _must_be_locked(self):
861
if not self._control_files._lock_count:
862
raise errors.ObjectNotLocked(self)
865
"""Initialize the state in this tree to be a new tree."""
869
def path2id(self, path):
870
"""Return the id for path in this tree."""
871
path = path.strip('/')
872
entry = self._get_entry(path=path)
873
if entry == (None, None):
877
def paths2ids(self, paths, trees=[], require_versioned=True):
878
"""See Tree.paths2ids().
880
This specialisation fast-paths the case where all the trees are in the
885
parents = self.get_parent_ids()
887
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
889
return super(DirStateWorkingTree, self).paths2ids(paths,
890
trees, require_versioned)
891
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
892
# -- make all paths utf8 --
895
paths_utf8.add(path.encode('utf8'))
897
# -- paths is now a utf8 path set --
898
# -- get the state object and prepare it.
899
state = self.current_dirstate()
900
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
901
and '' not in paths):
902
paths2ids = self._paths2ids_using_bisect
904
paths2ids = self._paths2ids_in_memory
905
return paths2ids(paths, search_indexes,
906
require_versioned=require_versioned)
908
def _paths2ids_in_memory(self, paths, search_indexes,
909
require_versioned=True):
910
state = self.current_dirstate()
911
state._read_dirblocks_if_needed()
912
def _entries_for_path(path):
913
"""Return a list with all the entries that match path for all ids.
915
dirname, basename = os.path.split(path)
916
key = (dirname, basename, '')
917
block_index, present = state._find_block_index_from_key(key)
919
# the block which should contain path is absent.
922
block = state._dirblocks[block_index][1]
923
entry_index, _ = state._find_entry_index(key, block)
924
# we may need to look at multiple entries at this path: walk while the paths match.
925
while (entry_index < len(block) and
926
block[entry_index][0][0:2] == key[0:2]):
927
result.append(block[entry_index])
930
if require_versioned:
931
# -- check all supplied paths are versioned in a search tree. --
934
path_entries = _entries_for_path(path)
936
# this specified path is not present at all: error
937
all_versioned = False
939
found_versioned = False
940
# for each id at this path
941
for entry in path_entries:
943
for index in search_indexes:
944
if entry[1][index][0] != 'a': # absent
945
found_versioned = True
946
# all good: found a versioned cell
948
if not found_versioned:
949
# none of the indexes was not 'absent' at all ids for this
951
all_versioned = False
953
if not all_versioned:
954
raise errors.PathsNotVersionedError(paths)
955
# -- remove redundancy in supplied paths to prevent over-scanning --
956
search_paths = osutils.minimum_path_selection(paths)
958
# for all search_indexs in each path at or under each element of
959
# search_paths, if the detail is relocated: add the id, and add the
960
# relocated path as one to search if its not searched already. If the
961
# detail is not relocated, add the id.
962
searched_paths = set()
964
def _process_entry(entry):
965
"""Look at search_indexes within entry.
967
If a specific tree's details are relocated, add the relocation
968
target to search_paths if not searched already. If it is absent, do
969
nothing. Otherwise add the id to found_ids.
971
for index in search_indexes:
972
if entry[1][index][0] == 'r': # relocated
973
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
974
search_paths.add(entry[1][index][1])
975
elif entry[1][index][0] != 'a': # absent
976
found_ids.add(entry[0][2])
978
current_root = search_paths.pop()
979
searched_paths.add(current_root)
980
# process the entries for this containing directory: the rest will be
981
# found by their parents recursively.
982
root_entries = _entries_for_path(current_root)
984
# this specified path is not present at all, skip it.
986
for entry in root_entries:
987
_process_entry(entry)
988
initial_key = (current_root, '', '')
989
block_index, _ = state._find_block_index_from_key(initial_key)
990
while (block_index < len(state._dirblocks) and
991
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
992
for entry in state._dirblocks[block_index][1]:
993
_process_entry(entry)
997
def _paths2ids_using_bisect(self, paths, search_indexes,
998
require_versioned=True):
999
state = self.current_dirstate()
1002
split_paths = sorted(osutils.split(p) for p in paths)
1003
found = state._bisect_recursive(split_paths)
1005
if require_versioned:
1006
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1007
for dir_name in split_paths:
1008
if dir_name not in found_dir_names:
1009
raise errors.PathsNotVersionedError(paths)
1011
for dir_name_id, trees_info in found.iteritems():
1012
for index in search_indexes:
1013
if trees_info[index][0] not in ('r', 'a'):
1014
found_ids.add(dir_name_id[2])
1017
def read_working_inventory(self):
1018
"""Read the working inventory.
1020
This is a meaningless operation for dirstate, but we obey it anyhow.
1022
return self.inventory
1025
def revision_tree(self, revision_id):
1026
"""See Tree.revision_tree.
1028
WorkingTree4 supplies revision_trees for any basis tree.
1030
dirstate = self.current_dirstate()
1031
parent_ids = dirstate.get_parent_ids()
1032
if revision_id not in parent_ids:
1033
raise errors.NoSuchRevisionInTree(self, revision_id)
1034
if revision_id in dirstate.get_ghosts():
1035
raise errors.NoSuchRevisionInTree(self, revision_id)
1036
return DirStateRevisionTree(dirstate, revision_id,
1037
self.branch.repository)
1039
@needs_tree_write_lock
1040
def set_last_revision(self, new_revision):
1041
"""Change the last revision in the working tree."""
1042
parents = self.get_parent_ids()
1043
if new_revision in (_mod_revision.NULL_REVISION, None):
1044
if len(parents) >= 2:
1045
raise AssertionError(
1046
"setting the last parent to none with a pending merge is "
1048
self.set_parent_ids([])
1050
self.set_parent_ids([new_revision] + parents[1:],
1051
allow_leftmost_as_ghost=True)
1053
@needs_tree_write_lock
1054
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1055
"""Set the parent ids to revision_ids.
1057
See also set_parent_trees. This api will try to retrieve the tree data
1058
for each element of revision_ids from the trees repository. If you have
1059
tree data already available, it is more efficient to use
1060
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1061
an easier API to use.
1063
:param revision_ids: The revision_ids to set as the parent ids of this
1064
working tree. Any of these may be ghosts.
1067
for revision_id in revision_ids:
1069
revtree = self.branch.repository.revision_tree(revision_id)
1070
# TODO: jam 20070213 KnitVersionedFile raises
1071
# RevisionNotPresent rather than NoSuchRevision if a
1072
# given revision_id is not present. Should Repository be
1073
# catching it and re-raising NoSuchRevision?
1074
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1076
trees.append((revision_id, revtree))
1077
self.set_parent_trees(trees,
1078
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1080
@needs_tree_write_lock
1081
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1082
"""Set the parents of the working tree.
1084
:param parents_list: A list of (revision_id, tree) tuples.
1085
If tree is None, then that element is treated as an unreachable
1086
parent tree - i.e. a ghost.
1088
dirstate = self.current_dirstate()
1089
if len(parents_list) > 0:
1090
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1091
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1095
parent_ids = [rev_id for rev_id, tree in parents_list]
1096
graph = self.branch.repository.get_graph()
1097
heads = graph.heads(parent_ids)
1098
accepted_revisions = set()
1100
# convert absent trees to the null tree, which we convert back to
1101
# missing on access.
1102
for rev_id, tree in parents_list:
1103
if len(accepted_revisions) > 0:
1104
# we always accept the first tree
1105
if rev_id in accepted_revisions or rev_id not in heads:
1106
# We have already included either this tree, or its
1107
# descendent, so we skip it.
1109
_mod_revision.check_not_reserved_id(rev_id)
1110
if tree is not None:
1111
real_trees.append((rev_id, tree))
1113
real_trees.append((rev_id,
1114
self.branch.repository.revision_tree(
1115
_mod_revision.NULL_REVISION)))
1116
ghosts.append(rev_id)
1117
accepted_revisions.add(rev_id)
1118
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1119
self._make_dirty(reset_inventory=False)
1121
def _set_root_id(self, file_id):
1122
"""See WorkingTree.set_root_id."""
1123
state = self.current_dirstate()
1124
state.set_path_id('', file_id)
1125
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1126
self._make_dirty(reset_inventory=True)
1128
def _sha_from_stat(self, path, stat_result):
1129
"""Get a sha digest from the tree's stat cache.
1131
The default implementation assumes no stat cache is present.
1133
:param path: The path.
1134
:param stat_result: The stat result being looked up.
1136
return self.current_dirstate().sha1_from_stat(path, stat_result)
1139
def supports_tree_reference(self):
1140
return self._repo_supports_tree_reference
1143
"""Unlock in format 4 trees needs to write the entire dirstate."""
1144
# do non-implementation specific cleanup
1147
if self._control_files._lock_count == 1:
1148
# eventually we should do signature checking during read locks for
1150
if self._control_files._lock_mode == 'w':
1153
if self._dirstate is not None:
1154
# This is a no-op if there are no modifications.
1155
self._dirstate.save()
1156
self._dirstate.unlock()
1157
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1158
# point. Instead, it could check if the header has been
1159
# modified when it is locked, and if not, it can hang on to
1160
# the data it has in memory.
1161
self._dirstate = None
1162
self._inventory = None
1163
# reverse order of locking.
1165
return self._control_files.unlock()
1167
self.branch.unlock()
1169
@needs_tree_write_lock
1170
def unversion(self, file_ids):
1171
"""Remove the file ids in file_ids from the current versioned set.
1173
When a file_id is unversioned, all of its children are automatically
1176
:param file_ids: The file ids to stop versioning.
1177
:raises: NoSuchId if any fileid is not currently versioned.
1181
state = self.current_dirstate()
1182
state._read_dirblocks_if_needed()
1183
ids_to_unversion = set(file_ids)
1184
paths_to_unversion = set()
1186
# check if the root is to be unversioned, if so, assert for now.
1187
# walk the state marking unversioned things as absent.
1188
# if there are any un-unversioned ids at the end, raise
1189
for key, details in state._dirblocks[0][1]:
1190
if (details[0][0] not in ('a', 'r') and # absent or relocated
1191
key[2] in ids_to_unversion):
1192
# I haven't written the code to unversion / yet - it should be
1194
raise errors.BzrError('Unversioning the / is not currently supported')
1196
while block_index < len(state._dirblocks):
1197
# process one directory at a time.
1198
block = state._dirblocks[block_index]
1199
# first check: is the path one to remove - it or its children
1200
delete_block = False
1201
for path in paths_to_unversion:
1202
if (block[0].startswith(path) and
1203
(len(block[0]) == len(path) or
1204
block[0][len(path)] == '/')):
1205
# this entire block should be deleted - its the block for a
1206
# path to unversion; or the child of one
1209
# TODO: trim paths_to_unversion as we pass by paths
1211
# this block is to be deleted: process it.
1212
# TODO: we can special case the no-parents case and
1213
# just forget the whole block.
1215
while entry_index < len(block[1]):
1216
entry = block[1][entry_index]
1217
if entry[1][0][0] in 'ar':
1218
# don't remove absent or renamed entries
1221
# Mark this file id as having been removed
1222
ids_to_unversion.discard(entry[0][2])
1223
if not state._make_absent(entry):
1224
# The block has not shrunk.
1226
# go to the next block. (At the moment we dont delete empty
1231
while entry_index < len(block[1]):
1232
entry = block[1][entry_index]
1233
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1234
# ^ some parent row.
1235
entry[0][2] not in ids_to_unversion):
1236
# ^ not an id to unversion
1239
if entry[1][0][0] == 'd':
1240
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1241
if not state._make_absent(entry):
1243
# we have unversioned this id
1244
ids_to_unversion.remove(entry[0][2])
1246
if ids_to_unversion:
1247
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1248
self._make_dirty(reset_inventory=False)
1249
# have to change the legacy inventory too.
1250
if self._inventory is not None:
1251
for file_id in file_ids:
1252
self._inventory.remove_recursive_id(file_id)
1254
@needs_tree_write_lock
1255
def rename_one(self, from_rel, to_rel, after=False):
1256
"""See WorkingTree.rename_one"""
1258
WorkingTree.rename_one(self, from_rel, to_rel, after)
1260
@needs_tree_write_lock
1261
def apply_inventory_delta(self, changes):
1262
"""See MutableTree.apply_inventory_delta"""
1263
state = self.current_dirstate()
1264
state.update_by_delta(changes)
1265
self._make_dirty(reset_inventory=True)
1267
def update_basis_by_delta(self, new_revid, delta):
1268
"""See MutableTree.update_basis_by_delta."""
1269
if self.last_revision() == new_revid:
1270
raise AssertionError()
1271
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1274
def _validate(self):
1275
self._dirstate._validate()
1277
@needs_tree_write_lock
1278
def _write_inventory(self, inv):
1279
"""Write inventory as the current inventory."""
1281
raise AssertionError("attempting to write an inventory when the "
1282
"dirstate is dirty will lose pending changes")
1283
had_inventory = self._inventory is not None
1284
# Setting self._inventory = None forces the dirstate to regenerate the
1285
# working inventory. We do this because self.inventory may be inv, or
1286
# may have been modified, and either case would prevent a clean delta
1288
self._inventory = None
1290
delta = inv._make_delta(self.inventory)
1292
self.apply_inventory_delta(delta)
1294
self._inventory = inv
1298
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1300
def __init__(self, tree):
1303
def sha1(self, abspath):
1304
"""See dirstate.SHA1Provider.sha1()."""
1305
filters = self.tree._content_filter_stack(
1306
self.tree.relpath(osutils.safe_unicode(abspath)))
1307
return internal_size_sha_file_byname(abspath, filters)[1]
1309
def stat_and_sha1(self, abspath):
1310
"""See dirstate.SHA1Provider.stat_and_sha1()."""
1311
filters = self.tree._content_filter_stack(
1312
self.tree.relpath(osutils.safe_unicode(abspath)))
1313
file_obj = file(abspath, 'rb', 65000)
1315
statvalue = os.fstat(file_obj.fileno())
1317
file_obj = filtered_input_file(file_obj, filters)
1318
sha1 = osutils.size_sha_file(file_obj)[1]
1321
return statvalue, sha1
1324
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1325
"""Dirstate working tree that supports content filtering.
1327
The dirstate holds the hash and size of the canonical form of the file,
1328
and most methods must return that.
1331
def _file_content_summary(self, path, stat_result):
1332
# This is to support the somewhat obsolete path_content_summary method
1333
# with content filtering: see
1334
# <https://bugs.edge.launchpad.net/bzr/+bug/415508>.
1336
# If the dirstate cache is up to date and knows the hash and size,
1338
# Otherwise if there are no content filters, return the on-disk size
1339
# and leave the hash blank.
1340
# Otherwise, read and filter the on-disk file and use its size and
1343
# The dirstate doesn't store the size of the canonical form so we
1344
# can't trust it for content-filtered trees. We just return None.
1345
dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1346
executable = self._is_executable_from_path_and_stat(path, stat_result)
1347
return ('file', None, executable, dirstate_sha1)
1350
class WorkingTree4(DirStateWorkingTree):
1351
"""This is the Format 4 working tree.
1353
This differs from WorkingTree3 by:
1354
- Having a consolidated internal dirstate, stored in a
1355
randomly-accessible sorted file on disk.
1356
- Not having a regular inventory attribute. One can be synthesized
1357
on demand but this is expensive and should be avoided.
1359
This is new in bzr 0.15.
1363
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1364
"""This is the Format 5 working tree.
1366
This differs from WorkingTree4 by:
1367
- Supporting content filtering.
1369
This is new in bzr 1.11.
1373
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1374
"""This is the Format 6 working tree.
1376
This differs from WorkingTree5 by:
1377
- Supporting a current view that may mask the set of files in a tree
1378
impacted by most user operations.
1380
This is new in bzr 1.14.
1383
def _make_views(self):
1384
return views.PathBasedViews(self)
1387
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1389
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1390
accelerator_tree=None, hardlink=False):
1391
"""See WorkingTreeFormat.initialize().
1393
:param revision_id: allows creating a working tree at a different
1394
revision than the branch is at.
1395
:param accelerator_tree: A tree which can be used for retrieving file
1396
contents more quickly than the revision tree, i.e. a workingtree.
1397
The revision tree will be used for cases where accelerator_tree's
1398
content is different.
1399
:param hardlink: If true, hard-link files from accelerator_tree,
1402
These trees get an initial random root id, if their repository supports
1403
rich root data, TREE_ROOT otherwise.
1405
if not isinstance(a_bzrdir.transport, LocalTransport):
1406
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1407
transport = a_bzrdir.get_workingtree_transport(self)
1408
control_files = self._open_control_files(a_bzrdir)
1409
control_files.create_lock()
1410
control_files.lock_write()
1411
transport.put_bytes('format', self.get_format_string(),
1412
mode=a_bzrdir._get_file_mode())
1413
if from_branch is not None:
1414
branch = from_branch
1416
branch = a_bzrdir.open_branch()
1417
if revision_id is None:
1418
revision_id = branch.last_revision()
1419
local_path = transport.local_abspath('dirstate')
1420
# write out new dirstate (must exist when we create the tree)
1421
state = dirstate.DirState.initialize(local_path)
1424
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1428
_control_files=control_files)
1430
wt.lock_tree_write()
1432
self._init_custom_control_files(wt)
1433
if revision_id in (None, _mod_revision.NULL_REVISION):
1434
if branch.repository.supports_rich_root():
1435
wt._set_root_id(generate_ids.gen_root_id())
1437
wt._set_root_id(ROOT_ID)
1440
# frequently, we will get here due to branching. The accelerator
1441
# tree will be the tree from the branch, so the desired basis
1442
# tree will often be a parent of the accelerator tree.
1443
if accelerator_tree is not None:
1445
basis = accelerator_tree.revision_tree(revision_id)
1446
except errors.NoSuchRevision:
1449
basis = branch.repository.revision_tree(revision_id)
1450
if revision_id == _mod_revision.NULL_REVISION:
1453
parents_list = [(revision_id, basis)]
1456
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1458
# if the basis has a root id we have to use that; otherwise we
1459
# use a new random one
1460
basis_root_id = basis.get_root_id()
1461
if basis_root_id is not None:
1462
wt._set_root_id(basis_root_id)
1464
if wt.supports_content_filtering():
1465
# The original tree may not have the same content filters
1466
# applied so we can't safely build the inventory delta from
1468
delta_from_tree = False
1470
delta_from_tree = True
1471
# delta_from_tree is safe even for DirStateRevisionTrees,
1472
# because wt4.apply_inventory_delta does not mutate the input
1473
# inventory entries.
1474
transform.build_tree(basis, wt, accelerator_tree,
1476
delta_from_tree=delta_from_tree)
1480
control_files.unlock()
1484
def _init_custom_control_files(self, wt):
1485
"""Subclasses with custom control files should override this method.
1487
The working tree and control files are locked for writing when this
1490
:param wt: the WorkingTree object
1493
def _open(self, a_bzrdir, control_files):
1494
"""Open the tree itself.
1496
:param a_bzrdir: the dir for the tree.
1497
:param control_files: the control files for the tree.
1499
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1500
branch=a_bzrdir.open_branch(),
1503
_control_files=control_files)
1505
def __get_matchingbzrdir(self):
1506
return self._get_matchingbzrdir()
1508
def _get_matchingbzrdir(self):
1509
"""Overrideable method to get a bzrdir for testing."""
1510
# please test against something that will let us do tree references
1511
return bzrdir.format_registry.make_bzrdir(
1512
'dirstate-with-subtree')
1514
_matchingbzrdir = property(__get_matchingbzrdir)
1517
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1518
"""The first consolidated dirstate working tree format.
1521
- exists within a metadir controlling .bzr
1522
- includes an explicit version marker for the workingtree control
1523
files, separate from the BzrDir format
1524
- modifies the hash cache format
1525
- is new in bzr 0.15
1526
- uses a LockDir to guard access to it.
1529
upgrade_recommended = False
1531
_tree_class = WorkingTree4
1533
def get_format_string(self):
1534
"""See WorkingTreeFormat.get_format_string()."""
1535
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1537
def get_format_description(self):
1538
"""See WorkingTreeFormat.get_format_description()."""
1539
return "Working tree format 4"
1542
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1543
"""WorkingTree format supporting content filtering.
1546
upgrade_recommended = False
1548
_tree_class = WorkingTree5
1550
def get_format_string(self):
1551
"""See WorkingTreeFormat.get_format_string()."""
1552
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1554
def get_format_description(self):
1555
"""See WorkingTreeFormat.get_format_description()."""
1556
return "Working tree format 5"
1558
def supports_content_filtering(self):
1562
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1563
"""WorkingTree format supporting views.
1566
upgrade_recommended = False
1568
_tree_class = WorkingTree6
1570
def get_format_string(self):
1571
"""See WorkingTreeFormat.get_format_string()."""
1572
return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1574
def get_format_description(self):
1575
"""See WorkingTreeFormat.get_format_description()."""
1576
return "Working tree format 6"
1578
def _init_custom_control_files(self, wt):
1579
"""Subclasses with custom control files should override this method."""
1580
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1582
def supports_content_filtering(self):
1585
def supports_views(self):
1589
class DirStateRevisionTree(Tree):
1590
"""A revision tree pulling the inventory from a dirstate.
1592
Note that this is one of the historical (ie revision) trees cached in the
1593
dirstate for easy access, not the workingtree.
1596
def __init__(self, dirstate, revision_id, repository):
1597
self._dirstate = dirstate
1598
self._revision_id = revision_id
1599
self._repository = repository
1600
self._inventory = None
1602
self._dirstate_locked = False
1603
self._repo_supports_tree_reference = getattr(
1604
repository._format, "supports_tree_reference",
1608
return "<%s of %s in %s>" % \
1609
(self.__class__.__name__, self._revision_id, self._dirstate)
1611
def annotate_iter(self, file_id,
1612
default_revision=_mod_revision.CURRENT_REVISION):
1613
"""See Tree.annotate_iter"""
1614
text_key = (file_id, self.inventory[file_id].revision)
1615
annotations = self._repository.texts.annotate(text_key)
1616
return [(key[-1], line) for (key, line) in annotations]
1618
def _get_ancestors(self, default_revision):
1619
return set(self._repository.get_ancestry(self._revision_id,
1621
def _comparison_data(self, entry, path):
1622
"""See Tree._comparison_data."""
1624
return None, False, None
1625
# trust the entry as RevisionTree does, but this may not be
1626
# sensible: the entry might not have come from us?
1627
return entry.kind, entry.executable, None
1629
def _file_size(self, entry, stat_value):
1630
return entry.text_size
1632
def filter_unversioned_files(self, paths):
1633
"""Filter out paths that are not versioned.
1635
:return: set of paths.
1637
pred = self.has_filename
1638
return set((p for p in paths if not pred(p)))
1640
def get_root_id(self):
1641
return self.path2id('')
1643
def id2path(self, file_id):
1644
"Convert a file-id to a path."
1645
entry = self._get_entry(file_id=file_id)
1646
if entry == (None, None):
1647
raise errors.NoSuchId(tree=self, file_id=file_id)
1648
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1649
return path_utf8.decode('utf8')
1651
def iter_references(self):
1652
if not self._repo_supports_tree_reference:
1653
# When the repo doesn't support references, we will have nothing to
1656
# Otherwise, fall back to the default implementation
1657
return super(DirStateRevisionTree, self).iter_references()
1659
def _get_parent_index(self):
1660
"""Return the index in the dirstate referenced by this tree."""
1661
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1663
def _get_entry(self, file_id=None, path=None):
1664
"""Get the dirstate row for file_id or path.
1666
If either file_id or path is supplied, it is used as the key to lookup.
1667
If both are supplied, the fastest lookup is used, and an error is
1668
raised if they do not both point at the same row.
1670
:param file_id: An optional unicode file_id to be looked up.
1671
:param path: An optional unicode path to be looked up.
1672
:return: The dirstate row tuple for path/file_id, or (None, None)
1674
if file_id is None and path is None:
1675
raise errors.BzrError('must supply file_id or path')
1676
if path is not None:
1677
path = path.encode('utf8')
1678
parent_index = self._get_parent_index()
1679
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1681
def _generate_inventory(self):
1682
"""Create and set self.inventory from the dirstate object.
1684
(So this is only called the first time the inventory is requested for
1685
this tree; it then remains in memory until it's out of date.)
1687
This is relatively expensive: we have to walk the entire dirstate.
1689
if not self._locked:
1690
raise AssertionError(
1691
'cannot generate inventory of an unlocked '
1692
'dirstate revision tree')
1693
# separate call for profiling - makes it clear where the costs are.
1694
self._dirstate._read_dirblocks_if_needed()
1695
if self._revision_id not in self._dirstate.get_parent_ids():
1696
raise AssertionError(
1697
'parent %s has disappeared from %s' % (
1698
self._revision_id, self._dirstate.get_parent_ids()))
1699
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1700
# This is identical now to the WorkingTree _generate_inventory except
1701
# for the tree index use.
1702
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1703
current_id = root_key[2]
1704
if current_entry[parent_index][0] != 'd':
1705
raise AssertionError()
1706
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1707
inv.root.revision = current_entry[parent_index][4]
1708
# Turn some things into local variables
1709
minikind_to_kind = dirstate.DirState._minikind_to_kind
1710
factory = entry_factory
1711
utf8_decode = cache_utf8._utf8_decode
1712
inv_byid = inv._byid
1713
# we could do this straight out of the dirstate; it might be fast
1714
# and should be profiled - RBC 20070216
1715
parent_ies = {'' : inv.root}
1716
for block in self._dirstate._dirblocks[1:]: #skip root
1719
parent_ie = parent_ies[dirname]
1721
# all the paths in this block are not versioned in this tree
1723
for key, entry in block[1]:
1724
minikind, fingerprint, size, executable, revid = entry[parent_index]
1725
if minikind in ('a', 'r'): # absent, relocated
1729
name_unicode = utf8_decode(name)[0]
1731
kind = minikind_to_kind[minikind]
1732
inv_entry = factory[kind](file_id, name_unicode,
1734
inv_entry.revision = revid
1736
inv_entry.executable = executable
1737
inv_entry.text_size = size
1738
inv_entry.text_sha1 = fingerprint
1739
elif kind == 'directory':
1740
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1741
elif kind == 'symlink':
1742
inv_entry.executable = False
1743
inv_entry.text_size = None
1744
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1745
elif kind == 'tree-reference':
1746
inv_entry.reference_revision = fingerprint or None
1748
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1750
# These checks cost us around 40ms on a 55k entry tree
1751
if file_id in inv_byid:
1752
raise AssertionError('file_id %s already in'
1753
' inventory as %s' % (file_id, inv_byid[file_id]))
1754
if name_unicode in parent_ie.children:
1755
raise AssertionError('name %r already in parent'
1757
inv_byid[file_id] = inv_entry
1758
parent_ie.children[name_unicode] = inv_entry
1759
self._inventory = inv
1761
def get_file_mtime(self, file_id, path=None):
1762
"""Return the modification time for this record.
1764
We return the timestamp of the last-changed revision.
1766
# Make sure the file exists
1767
entry = self._get_entry(file_id, path=path)
1768
if entry == (None, None): # do we raise?
1770
parent_index = self._get_parent_index()
1771
last_changed_revision = entry[1][parent_index][4]
1773
rev = self._repository.get_revision(last_changed_revision)
1774
except errors.NoSuchRevision:
1775
raise errors.FileTimestampUnavailable(self.id2path(file_id))
1776
return rev.timestamp
1778
def get_file_sha1(self, file_id, path=None, stat_value=None):
1779
entry = self._get_entry(file_id=file_id, path=path)
1780
parent_index = self._get_parent_index()
1781
parent_details = entry[1][parent_index]
1782
if parent_details[0] == 'f':
1783
return parent_details[1]
1786
def get_file(self, file_id, path=None):
1787
return StringIO(self.get_file_text(file_id))
1789
def get_file_size(self, file_id):
1790
"""See Tree.get_file_size"""
1791
return self.inventory[file_id].text_size
1793
def get_file_text(self, file_id, path=None):
1794
_, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1795
return ''.join(content)
1797
def get_reference_revision(self, file_id, path=None):
1798
return self.inventory[file_id].reference_revision
1800
def iter_files_bytes(self, desired_files):
1801
"""See Tree.iter_files_bytes.
1803
This version is implemented on top of Repository.iter_files_bytes"""
1804
parent_index = self._get_parent_index()
1805
repo_desired_files = []
1806
for file_id, identifier in desired_files:
1807
entry = self._get_entry(file_id)
1808
if entry == (None, None):
1809
raise errors.NoSuchId(self, file_id)
1810
repo_desired_files.append((file_id, entry[1][parent_index][4],
1812
return self._repository.iter_files_bytes(repo_desired_files)
1814
def get_symlink_target(self, file_id):
1815
entry = self._get_entry(file_id=file_id)
1816
parent_index = self._get_parent_index()
1817
if entry[1][parent_index][0] != 'l':
1820
target = entry[1][parent_index][1]
1821
target = target.decode('utf8')
1824
def get_revision_id(self):
1825
"""Return the revision id for this tree."""
1826
return self._revision_id
1828
def _get_inventory(self):
1829
if self._inventory is not None:
1830
return self._inventory
1831
self._must_be_locked()
1832
self._generate_inventory()
1833
return self._inventory
1835
inventory = property(_get_inventory,
1836
doc="Inventory of this Tree")
1838
def get_parent_ids(self):
1839
"""The parents of a tree in the dirstate are not cached."""
1840
return self._repository.get_revision(self._revision_id).parent_ids
1842
def has_filename(self, filename):
1843
return bool(self.path2id(filename))
1845
def kind(self, file_id):
1846
entry = self._get_entry(file_id=file_id)[1]
1848
raise errors.NoSuchId(tree=self, file_id=file_id)
1849
parent_index = self._get_parent_index()
1850
return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1852
def stored_kind(self, file_id):
1853
"""See Tree.stored_kind"""
1854
return self.kind(file_id)
1856
def path_content_summary(self, path):
1857
"""See Tree.path_content_summary."""
1858
id = self.inventory.path2id(path)
1860
return ('missing', None, None, None)
1861
entry = self._inventory[id]
1864
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1865
elif kind == 'symlink':
1866
return (kind, None, None, entry.symlink_target)
1868
return (kind, None, None, None)
1870
def is_executable(self, file_id, path=None):
1871
ie = self.inventory[file_id]
1872
if ie.kind != "file":
1874
return ie.executable
1876
def is_locked(self):
1879
def list_files(self, include_root=False, from_dir=None, recursive=True):
1880
# We use a standard implementation, because DirStateRevisionTree is
1881
# dealing with one of the parents of the current state
1882
inv = self._get_inventory()
1883
if from_dir is None:
1886
from_dir_id = inv.path2id(from_dir)
1887
if from_dir_id is None:
1888
# Directory not versioned
1890
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1891
if inv.root is not None and not include_root and from_dir is None:
1893
for path, entry in entries:
1894
yield path, 'V', entry.kind, entry.file_id, entry
1896
def lock_read(self):
1897
"""Lock the tree for a set of operations.
1899
:return: An object with an unlock method which will release the lock
1902
if not self._locked:
1903
self._repository.lock_read()
1904
if self._dirstate._lock_token is None:
1905
self._dirstate.lock_read()
1906
self._dirstate_locked = True
1910
def _must_be_locked(self):
1911
if not self._locked:
1912
raise errors.ObjectNotLocked(self)
1915
def path2id(self, path):
1916
"""Return the id for path in this tree."""
1917
# lookup by path: faster than splitting and walking the ivnentory.
1918
entry = self._get_entry(path=path)
1919
if entry == (None, None):
1924
"""Unlock, freeing any cache memory used during the lock."""
1925
# outside of a lock, the inventory is suspect: release it.
1927
if not self._locked:
1928
self._inventory = None
1930
if self._dirstate_locked:
1931
self._dirstate.unlock()
1932
self._dirstate_locked = False
1933
self._repository.unlock()
1936
def supports_tree_reference(self):
1937
return self._repo_supports_tree_reference
1939
def walkdirs(self, prefix=""):
1940
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1941
# implementation based on an inventory.
1942
# This should be cleaned up to use the much faster Dirstate code
1943
# So for now, we just build up the parent inventory, and extract
1944
# it the same way RevisionTree does.
1945
_directory = 'directory'
1946
inv = self._get_inventory()
1947
top_id = inv.path2id(prefix)
1951
pending = [(prefix, top_id)]
1954
relpath, file_id = pending.pop()
1955
# 0 - relpath, 1- file-id
1957
relroot = relpath + '/'
1960
# FIXME: stash the node in pending
1961
entry = inv[file_id]
1962
for name, child in entry.sorted_children():
1963
toppath = relroot + name
1964
dirblock.append((toppath, name, child.kind, None,
1965
child.file_id, child.kind
1967
yield (relpath, entry.file_id), dirblock
1968
# push the user specified dirs from dirblock
1969
for dir in reversed(dirblock):
1970
if dir[2] == _directory:
1971
pending.append((dir[0], dir[4]))
1974
class InterDirStateTree(InterTree):
1975
"""Fast path optimiser for changes_from with dirstate trees.
1977
This is used only when both trees are in the dirstate working file, and
1978
the source is any parent within the dirstate, and the destination is
1979
the current working tree of the same dirstate.
1981
# this could be generalized to allow comparisons between any trees in the
1982
# dirstate, and possibly between trees stored in different dirstates.
1984
def __init__(self, source, target):
1985
super(InterDirStateTree, self).__init__(source, target)
1986
if not InterDirStateTree.is_compatible(source, target):
1987
raise Exception, "invalid source %r and target %r" % (source, target)
1990
def make_source_parent_tree(source, target):
1991
"""Change the source tree into a parent of the target."""
1992
revid = source.commit('record tree')
1993
target.branch.repository.fetch(source.branch.repository, revid)
1994
target.set_parent_ids([revid])
1995
return target.basis_tree(), target
1998
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1999
result = klass.make_source_parent_tree(source, target)
2000
result[1]._iter_changes = dirstate.ProcessEntryPython
2004
def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
2006
from bzrlib.tests.test__dirstate_helpers import \
2007
compiled_dirstate_helpers_feature
2008
test_case.requireFeature(compiled_dirstate_helpers_feature)
2009
from bzrlib._dirstate_helpers_pyx import ProcessEntryC
2010
result = klass.make_source_parent_tree(source, target)
2011
result[1]._iter_changes = ProcessEntryC
2014
_matching_from_tree_format = WorkingTreeFormat4()
2015
_matching_to_tree_format = WorkingTreeFormat4()
2018
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
2019
# This method shouldn't be called, because we have python and C
2020
# specific flavours.
2021
raise NotImplementedError
2023
def iter_changes(self, include_unchanged=False,
2024
specific_files=None, pb=None, extra_trees=[],
2025
require_versioned=True, want_unversioned=False):
2026
"""Return the changes from source to target.
2028
:return: An iterator that yields tuples. See InterTree.iter_changes
2030
:param specific_files: An optional list of file paths to restrict the
2031
comparison to. When mapping filenames to ids, all matches in all
2032
trees (including optional extra_trees) are used, and all children of
2033
matched directories are included.
2034
:param include_unchanged: An optional boolean requesting the inclusion of
2035
unchanged entries in the result.
2036
:param extra_trees: An optional list of additional trees to use when
2037
mapping the contents of specific_files (paths) to file_ids.
2038
:param require_versioned: If True, all files in specific_files must be
2039
versioned in one of source, target, extra_trees or
2040
PathsNotVersionedError is raised.
2041
:param want_unversioned: Should unversioned files be returned in the
2042
output. An unversioned file is defined as one with (False, False)
2043
for the versioned pair.
2045
# TODO: handle extra trees in the dirstate.
2046
if (extra_trees or specific_files == []):
2047
# we can't fast-path these cases (yet)
2048
return super(InterDirStateTree, self).iter_changes(
2049
include_unchanged, specific_files, pb, extra_trees,
2050
require_versioned, want_unversioned=want_unversioned)
2051
parent_ids = self.target.get_parent_ids()
2052
if not (self.source._revision_id in parent_ids
2053
or self.source._revision_id == _mod_revision.NULL_REVISION):
2054
raise AssertionError(
2055
"revision {%s} is not stored in {%s}, but %s "
2056
"can only be used for trees stored in the dirstate"
2057
% (self.source._revision_id, self.target, self.iter_changes))
2059
if self.source._revision_id == _mod_revision.NULL_REVISION:
2061
indices = (target_index,)
2063
if not (self.source._revision_id in parent_ids):
2064
raise AssertionError(
2065
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2066
self.source._revision_id, parent_ids))
2067
source_index = 1 + parent_ids.index(self.source._revision_id)
2068
indices = (source_index, target_index)
2069
# -- make all specific_files utf8 --
2071
specific_files_utf8 = set()
2072
for path in specific_files:
2073
# Note, if there are many specific files, using cache_utf8
2074
# would be good here.
2075
specific_files_utf8.add(path.encode('utf8'))
2076
specific_files = specific_files_utf8
2078
specific_files = set([''])
2079
# -- specific_files is now a utf8 path set --
2081
# -- get the state object and prepare it.
2082
state = self.target.current_dirstate()
2083
state._read_dirblocks_if_needed()
2084
if require_versioned:
2085
# -- check all supplied paths are versioned in a search tree. --
2087
for path in specific_files:
2088
path_entries = state._entries_for_path(path)
2089
if not path_entries:
2090
# this specified path is not present at all: error
2091
not_versioned.append(path)
2093
found_versioned = False
2094
# for each id at this path
2095
for entry in path_entries:
2097
for index in indices:
2098
if entry[1][index][0] != 'a': # absent
2099
found_versioned = True
2100
# all good: found a versioned cell
2102
if not found_versioned:
2103
# none of the indexes was not 'absent' at all ids for this
2105
not_versioned.append(path)
2106
if len(not_versioned) > 0:
2107
raise errors.PathsNotVersionedError(not_versioned)
2108
# -- remove redundancy in supplied specific_files to prevent over-scanning --
2109
search_specific_files = osutils.minimum_path_selection(specific_files)
2111
use_filesystem_for_exec = (sys.platform != 'win32')
2112
iter_changes = self.target._iter_changes(include_unchanged,
2113
use_filesystem_for_exec, search_specific_files, state,
2114
source_index, target_index, want_unversioned, self.target)
2115
return iter_changes.iter_changes()
2118
def is_compatible(source, target):
2119
# the target must be a dirstate working tree
2120
if not isinstance(target, DirStateWorkingTree):
2122
# the source must be a revtree or dirstate rev tree.
2123
if not isinstance(source,
2124
(revisiontree.RevisionTree, DirStateRevisionTree)):
2126
# the source revid must be in the target dirstate
2127
if not (source._revision_id == _mod_revision.NULL_REVISION or
2128
source._revision_id in target.get_parent_ids()):
2129
# TODO: what about ghosts? it may well need to
2130
# check for them explicitly.
2134
InterTree.register_optimiser(InterDirStateTree)
2137
class Converter3to4(object):
2138
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2141
self.target_format = WorkingTreeFormat4()
2143
def convert(self, tree):
2144
# lock the control files not the tree, so that we dont get tree
2145
# on-unlock behaviours, and so that noone else diddles with the
2146
# tree during upgrade.
2147
tree._control_files.lock_write()
2149
tree.read_working_inventory()
2150
self.create_dirstate_data(tree)
2151
self.update_format(tree)
2152
self.remove_xml_files(tree)
2154
tree._control_files.unlock()
2156
def create_dirstate_data(self, tree):
2157
"""Create the dirstate based data for tree."""
2158
local_path = tree.bzrdir.get_workingtree_transport(None
2159
).local_abspath('dirstate')
2160
state = dirstate.DirState.from_tree(tree, local_path)
2164
def remove_xml_files(self, tree):
2165
"""Remove the oldformat 3 data."""
2166
transport = tree.bzrdir.get_workingtree_transport(None)
2167
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2168
'pending-merges', 'stat-cache']:
2170
transport.delete(path)
2171
except errors.NoSuchFile:
2172
# some files are optional - just deal.
2175
def update_format(self, tree):
2176
"""Change the format marker."""
2177
tree._transport.put_bytes('format',
2178
self.target_format.get_format_string(),
2179
mode=tree.bzrdir._get_file_mode())
2182
class Converter4to5(object):
2183
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2186
self.target_format = WorkingTreeFormat5()
2188
def convert(self, tree):
2189
# lock the control files not the tree, so that we don't get tree
2190
# on-unlock behaviours, and so that no-one else diddles with the
2191
# tree during upgrade.
2192
tree._control_files.lock_write()
2194
self.update_format(tree)
2196
tree._control_files.unlock()
2198
def update_format(self, tree):
2199
"""Change the format marker."""
2200
tree._transport.put_bytes('format',
2201
self.target_format.get_format_string(),
2202
mode=tree.bzrdir._get_file_mode())
2205
class Converter4or5to6(object):
2206
"""Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2209
self.target_format = WorkingTreeFormat6()
2211
def convert(self, tree):
2212
# lock the control files not the tree, so that we don't get tree
2213
# on-unlock behaviours, and so that no-one else diddles with the
2214
# tree during upgrade.
2215
tree._control_files.lock_write()
2217
self.init_custom_control_files(tree)
2218
self.update_format(tree)
2220
tree._control_files.unlock()
2222
def init_custom_control_files(self, tree):
2223
"""Initialize custom control files."""
2224
tree._transport.put_bytes('views', '',
2225
mode=tree.bzrdir._get_file_mode())
2227
def update_format(self, tree):
2228
"""Change the format marker."""
2229
tree._transport.put_bytes('format',
2230
self.target_format.get_format_string(),
2231
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
