1
# Copyright (C) 2007-2011 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(), """
37
conflicts as _mod_conflicts,
41
filters as _mod_filters,
44
revision as _mod_revision,
52
from bzrlib.decorators import needs_read_lock, needs_write_lock
53
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
54
from bzrlib.lock import LogicalLockResult
55
from bzrlib.lockable_files import LockableFiles
56
from bzrlib.lockdir import LockDir
57
from bzrlib.mutabletree import needs_tree_write_lock
58
from bzrlib.osutils import (
65
from bzrlib.transport.local import LocalTransport
66
from bzrlib.tree import (
70
from bzrlib.workingtree import (
77
class DirStateWorkingTree(InventoryWorkingTree):
79
def __init__(self, basedir,
84
"""Construct a WorkingTree for basedir.
86
If the branch is not supplied, it is opened automatically.
87
If the branch is supplied, it must be the branch for this basedir.
88
(branch.base is not cross checked, because for remote branches that
89
would be meaningless).
91
self._format = _format
93
basedir = safe_unicode(basedir)
94
trace.mutter("opening working tree %r", basedir)
96
self.basedir = realpath(basedir)
97
# if branch is at our basedir and is a format 6 or less
98
# assume all other formats have their own control files.
99
self._control_files = _control_files
100
self._transport = self._control_files._transport
103
# during a read or write lock these objects are set, and are
104
# None the rest of the time.
105
self._dirstate = None
106
self._inventory = None
108
self._setup_directory_is_tree_reference()
109
self._detect_case_handling()
110
self._rules_searcher = None
111
self.views = self._make_views()
112
#--- allow tests to select the dirstate iter_changes implementation
113
self._iter_changes = dirstate._process_entry
115
@needs_tree_write_lock
116
def _add(self, files, ids, kinds):
117
"""See MutableTree._add."""
118
state = self.current_dirstate()
119
for f, file_id, kind in zip(files, ids, kinds):
122
# special case tree root handling.
123
if f == '' and self.path2id(f) == ROOT_ID:
124
state.set_path_id('', generate_ids.gen_file_id(f))
127
file_id = generate_ids.gen_file_id(f)
128
# deliberately add the file with no cached stat or sha1
129
# - on the first access it will be gathered, and we can
130
# always change this once tests are all passing.
131
state.add(f, file_id, kind, None, '')
132
self._make_dirty(reset_inventory=True)
134
def _get_check_refs(self):
135
"""Return the references needed to perform a check of this tree."""
136
return [('trees', self.last_revision())]
138
def _make_dirty(self, reset_inventory):
139
"""Make the tree state dirty.
141
:param reset_inventory: True if the cached inventory should be removed
142
(presuming there is one).
145
if reset_inventory and self._inventory is not None:
146
self._inventory = None
148
@needs_tree_write_lock
149
def add_reference(self, sub_tree):
150
# use standard implementation, which calls back to self._add
152
# So we don't store the reference_revision in the working dirstate,
153
# it's just recorded at the moment of commit.
154
self._add_reference(sub_tree)
156
def break_lock(self):
157
"""Break a lock if one is present from another instance.
159
Uses the ui factory to ask for confirmation if the lock may be from
162
This will probe the repository for its lock as well.
164
# if the dirstate is locked by an active process, reject the break lock
167
if self._dirstate is None:
171
state = self._current_dirstate()
172
if state._lock_token is not None:
173
# we already have it locked. sheese, cant break our own lock.
174
raise errors.LockActive(self.basedir)
177
# try for a write lock - need permission to get one anyhow
180
except errors.LockContention:
181
# oslocks fail when a process is still live: fail.
182
# TODO: get the locked lockdir info and give to the user to
183
# assist in debugging.
184
raise errors.LockActive(self.basedir)
189
self._dirstate = None
190
self._control_files.break_lock()
191
self.branch.break_lock()
193
def _comparison_data(self, entry, path):
194
kind, executable, stat_value = \
195
WorkingTree._comparison_data(self, entry, path)
196
# it looks like a plain directory, but it's really a reference -- see
198
if (self._repo_supports_tree_reference and kind == 'directory'
199
and entry is not None and entry.kind == 'tree-reference'):
200
kind = 'tree-reference'
201
return kind, executable, stat_value
204
def commit(self, message=None, revprops=None, *args, **kwargs):
205
# mark the tree as dirty post commit - commit
206
# can change the current versioned list by doing deletes.
207
result = WorkingTree.commit(self, message, revprops, *args, **kwargs)
208
self._make_dirty(reset_inventory=True)
211
def current_dirstate(self):
212
"""Return the current dirstate object.
214
This is not part of the tree interface and only exposed for ease of
217
:raises errors.NotWriteLocked: when not in a lock.
219
self._must_be_locked()
220
return self._current_dirstate()
222
def _current_dirstate(self):
223
"""Internal function that does not check lock status.
225
This is needed for break_lock which also needs the dirstate.
227
if self._dirstate is not None:
228
return self._dirstate
229
local_path = self.bzrdir.get_workingtree_transport(None
230
).local_abspath('dirstate')
231
self._dirstate = dirstate.DirState.on_file(local_path,
232
self._sha1_provider())
233
return self._dirstate
235
def _sha1_provider(self):
236
"""A function that returns a SHA1Provider suitable for this tree.
238
:return: None if content filtering is not supported by this tree.
239
Otherwise, a SHA1Provider is returned that sha's the canonical
240
form of files, i.e. after read filters are applied.
242
if self.supports_content_filtering():
243
return ContentFilterAwareSHA1Provider(self)
247
def filter_unversioned_files(self, paths):
248
"""Filter out paths that are versioned.
250
:return: set of paths.
252
# TODO: make a generic multi-bisect routine roughly that should list
253
# the paths, then process one half at a time recursively, and feed the
254
# results of each bisect in further still
255
paths = sorted(paths)
257
state = self.current_dirstate()
258
# TODO we want a paths_to_dirblocks helper I think
260
dirname, basename = os.path.split(path.encode('utf8'))
261
_, _, _, path_is_versioned = state._get_block_entry_index(
262
dirname, basename, 0)
263
if not path_is_versioned:
268
"""Write all cached data to disk."""
269
if self._control_files._lock_mode != 'w':
270
raise errors.NotWriteLocked(self)
271
self.current_dirstate().save()
272
self._inventory = None
275
@needs_tree_write_lock
276
def _gather_kinds(self, files, kinds):
277
"""See MutableTree._gather_kinds."""
278
for pos, f in enumerate(files):
279
if kinds[pos] is None:
280
kinds[pos] = self._kind(f)
282
def _generate_inventory(self):
283
"""Create and set self.inventory from the dirstate object.
285
This is relatively expensive: we have to walk the entire dirstate.
286
Ideally we would not, and can deprecate this function.
288
#: uncomment to trap on inventory requests.
289
# import pdb;pdb.set_trace()
290
state = self.current_dirstate()
291
state._read_dirblocks_if_needed()
292
root_key, current_entry = self._get_entry(path='')
293
current_id = root_key[2]
294
if not (current_entry[0][0] == 'd'): # directory
295
raise AssertionError(current_entry)
296
inv = Inventory(root_id=current_id)
297
# Turn some things into local variables
298
minikind_to_kind = dirstate.DirState._minikind_to_kind
299
factory = entry_factory
300
utf8_decode = cache_utf8._utf8_decode
302
# we could do this straight out of the dirstate; it might be fast
303
# and should be profiled - RBC 20070216
304
parent_ies = {'' : inv.root}
305
for block in state._dirblocks[1:]: # skip the root
308
parent_ie = parent_ies[dirname]
310
# all the paths in this block are not versioned in this tree
312
for key, entry in block[1]:
313
minikind, link_or_sha1, size, executable, stat = entry[0]
314
if minikind in ('a', 'r'): # absent, relocated
315
# a parent tree only entry
318
name_unicode = utf8_decode(name)[0]
320
kind = minikind_to_kind[minikind]
321
inv_entry = factory[kind](file_id, name_unicode,
324
# This is only needed on win32, where this is the only way
325
# we know the executable bit.
326
inv_entry.executable = executable
327
# not strictly needed: working tree
328
#inv_entry.text_size = size
329
#inv_entry.text_sha1 = sha1
330
elif kind == 'directory':
331
# add this entry to the parent map.
332
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
333
elif kind == 'tree-reference':
334
if not self._repo_supports_tree_reference:
335
raise errors.UnsupportedOperation(
336
self._generate_inventory,
337
self.branch.repository)
338
inv_entry.reference_revision = link_or_sha1 or None
339
elif kind != 'symlink':
340
raise AssertionError("unknown kind %r" % kind)
341
# These checks cost us around 40ms on a 55k entry tree
342
if file_id in inv_byid:
343
raise AssertionError('file_id %s already in'
344
' inventory as %s' % (file_id, inv_byid[file_id]))
345
if name_unicode in parent_ie.children:
346
raise AssertionError('name %r already in parent'
348
inv_byid[file_id] = inv_entry
349
parent_ie.children[name_unicode] = inv_entry
350
self._inventory = inv
352
def _get_entry(self, file_id=None, path=None):
353
"""Get the dirstate row for file_id or path.
355
If either file_id or path is supplied, it is used as the key to lookup.
356
If both are supplied, the fastest lookup is used, and an error is
357
raised if they do not both point at the same row.
359
:param file_id: An optional unicode file_id to be looked up.
360
:param path: An optional unicode path to be looked up.
361
:return: The dirstate row tuple for path/file_id, or (None, None)
363
if file_id is None and path is None:
364
raise errors.BzrError('must supply file_id or path')
365
state = self.current_dirstate()
367
path = path.encode('utf8')
368
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
370
def get_file_sha1(self, file_id, path=None, stat_value=None):
371
# check file id is valid unconditionally.
372
entry = self._get_entry(file_id=file_id, path=path)
374
raise errors.NoSuchId(self, file_id)
376
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
378
file_abspath = self.abspath(path)
379
state = self.current_dirstate()
380
if stat_value is None:
382
stat_value = osutils.lstat(file_abspath)
384
if e.errno == errno.ENOENT:
388
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
389
stat_value=stat_value)
390
if entry[1][0][0] == 'f':
391
if link_or_sha1 is None:
392
file_obj, statvalue = self.get_file_with_stat(file_id, path)
394
sha1 = osutils.sha_file(file_obj)
397
self._observed_sha1(file_id, path, (sha1, statvalue))
403
def _get_inventory(self):
404
"""Get the inventory for the tree. This is only valid within a lock."""
405
if 'evil' in debug.debug_flags:
406
trace.mutter_callsite(2,
407
"accessing .inventory forces a size of tree translation.")
408
if self._inventory is not None:
409
return self._inventory
410
self._must_be_locked()
411
self._generate_inventory()
412
return self._inventory
414
inventory = property(_get_inventory,
415
doc="Inventory of this Tree")
418
def get_parent_ids(self):
419
"""See Tree.get_parent_ids.
421
This implementation requests the ids list from the dirstate file.
423
return self.current_dirstate().get_parent_ids()
425
def get_reference_revision(self, file_id, path=None):
426
# referenced tree's revision is whatever's currently there
427
return self.get_nested_tree(file_id, path).last_revision()
429
def get_nested_tree(self, file_id, path=None):
431
path = self.id2path(file_id)
432
# else: check file_id is at path?
433
return WorkingTree.open(self.abspath(path))
436
def get_root_id(self):
437
"""Return the id of this trees root"""
438
return self._get_entry(path='')[0][2]
440
def has_id(self, file_id):
441
state = self.current_dirstate()
442
row, parents = self._get_entry(file_id=file_id)
445
return osutils.lexists(pathjoin(
446
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
448
def has_or_had_id(self, file_id):
449
state = self.current_dirstate()
450
row, parents = self._get_entry(file_id=file_id)
451
return row is not None
454
def id2path(self, file_id):
455
"Convert a file-id to a path."
456
state = self.current_dirstate()
457
entry = self._get_entry(file_id=file_id)
458
if entry == (None, None):
459
raise errors.NoSuchId(tree=self, file_id=file_id)
460
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
461
return path_utf8.decode('utf8')
463
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
464
entry = self._get_entry(path=path)
465
if entry == (None, None):
466
return False # Missing entries are not executable
467
return entry[1][0][3] # Executable?
469
if not osutils.supports_executable():
470
def is_executable(self, file_id, path=None):
471
"""Test if a file is executable or not.
473
Note: The caller is expected to take a read-lock before calling this.
475
entry = self._get_entry(file_id=file_id, path=path)
476
if entry == (None, None):
478
return entry[1][0][3]
480
_is_executable_from_path_and_stat = \
481
_is_executable_from_path_and_stat_from_basis
483
def is_executable(self, file_id, path=None):
484
"""Test if a file is executable or not.
486
Note: The caller is expected to take a read-lock before calling this.
488
self._must_be_locked()
490
path = self.id2path(file_id)
491
mode = osutils.lstat(self.abspath(path)).st_mode
492
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
494
def all_file_ids(self):
495
"""See Tree.iter_all_file_ids"""
496
self._must_be_locked()
498
for key, tree_details in self.current_dirstate()._iter_entries():
499
if tree_details[0][0] in ('a', 'r'): # relocated
506
"""Iterate through file_ids for this tree.
508
file_ids are in a WorkingTree if they are in the working inventory
509
and the working file exists.
512
for key, tree_details in self.current_dirstate()._iter_entries():
513
if tree_details[0][0] in ('a', 'r'): # absent, relocated
514
# not relevant to the working tree
516
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
517
if osutils.lexists(path):
518
result.append(key[2])
521
def iter_references(self):
522
if not self._repo_supports_tree_reference:
523
# When the repo doesn't support references, we will have nothing to
526
for key, tree_details in self.current_dirstate()._iter_entries():
527
if tree_details[0][0] in ('a', 'r'): # absent, relocated
528
# not relevant to the working tree
531
# the root is not a reference.
533
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
535
if self._kind(relpath) == 'tree-reference':
536
yield relpath, key[2]
537
except errors.NoSuchFile:
538
# path is missing on disk.
541
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
542
"""See MutableTree._observed_sha1."""
543
state = self.current_dirstate()
544
entry = self._get_entry(file_id=file_id, path=path)
545
state._observed_sha1(entry, sha1, statvalue)
547
def kind(self, file_id):
548
"""Return the kind of a file.
550
This is always the actual kind that's on disk, regardless of what it
553
Note: The caller is expected to take a read-lock before calling this.
555
relpath = self.id2path(file_id)
557
raise AssertionError(
558
"path for id {%s} is None!" % file_id)
559
return self._kind(relpath)
561
def _kind(self, relpath):
562
abspath = self.abspath(relpath)
563
kind = file_kind(abspath)
564
if (self._repo_supports_tree_reference and kind == 'directory'):
565
entry = self._get_entry(path=relpath)
566
if entry[1] is not None:
567
if entry[1][0][0] == 't':
568
kind = 'tree-reference'
572
def _last_revision(self):
573
"""See Mutable.last_revision."""
574
parent_ids = self.current_dirstate().get_parent_ids()
578
return _mod_revision.NULL_REVISION
581
"""See Branch.lock_read, and WorkingTree.unlock.
583
:return: A bzrlib.lock.LogicalLockResult.
585
self.branch.lock_read()
587
self._control_files.lock_read()
589
state = self.current_dirstate()
590
if not state._lock_token:
592
# set our support for tree references from the repository in
594
self._repo_supports_tree_reference = getattr(
595
self.branch.repository._format, "supports_tree_reference",
598
self._control_files.unlock()
603
return LogicalLockResult(self.unlock)
605
def _lock_self_write(self):
606
"""This should be called after the branch is locked."""
608
self._control_files.lock_write()
610
state = self.current_dirstate()
611
if not state._lock_token:
613
# set our support for tree references from the repository in
615
self._repo_supports_tree_reference = getattr(
616
self.branch.repository._format, "supports_tree_reference",
619
self._control_files.unlock()
624
return LogicalLockResult(self.unlock)
626
def lock_tree_write(self):
627
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
629
:return: A bzrlib.lock.LogicalLockResult.
631
self.branch.lock_read()
632
return self._lock_self_write()
634
def lock_write(self):
635
"""See MutableTree.lock_write, and WorkingTree.unlock.
637
:return: A bzrlib.lock.LogicalLockResult.
639
self.branch.lock_write()
640
return self._lock_self_write()
642
@needs_tree_write_lock
643
def move(self, from_paths, to_dir, after=False):
644
"""See WorkingTree.move()."""
648
state = self.current_dirstate()
649
if isinstance(from_paths, basestring):
651
to_dir_utf8 = to_dir.encode('utf8')
652
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
653
id_index = state._get_id_index()
654
# check destination directory
655
# get the details for it
656
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
657
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
658
if not entry_present:
659
raise errors.BzrMoveFailedError('', to_dir,
660
errors.NotVersionedError(to_dir))
661
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
662
# get a handle on the block itself.
663
to_block_index = state._ensure_block(
664
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
665
to_block = state._dirblocks[to_block_index]
666
to_abs = self.abspath(to_dir)
667
if not isdir(to_abs):
668
raise errors.BzrMoveFailedError('',to_dir,
669
errors.NotADirectory(to_abs))
671
if to_entry[1][0][0] != 'd':
672
raise errors.BzrMoveFailedError('',to_dir,
673
errors.NotADirectory(to_abs))
675
if self._inventory is not None:
676
update_inventory = True
678
to_dir_id = to_entry[0][2]
679
to_dir_ie = inv[to_dir_id]
681
update_inventory = False
684
def move_one(old_entry, from_path_utf8, minikind, executable,
685
fingerprint, packed_stat, size,
686
to_block, to_key, to_path_utf8):
687
state._make_absent(old_entry)
688
from_key = old_entry[0]
690
lambda:state.update_minimal(from_key,
692
executable=executable,
693
fingerprint=fingerprint,
694
packed_stat=packed_stat,
696
path_utf8=from_path_utf8))
697
state.update_minimal(to_key,
699
executable=executable,
700
fingerprint=fingerprint,
701
packed_stat=packed_stat,
703
path_utf8=to_path_utf8)
704
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
705
new_entry = to_block[1][added_entry_index]
706
rollbacks.append(lambda:state._make_absent(new_entry))
708
for from_rel in from_paths:
709
# from_rel is 'pathinroot/foo/bar'
710
from_rel_utf8 = from_rel.encode('utf8')
711
from_dirname, from_tail = osutils.split(from_rel)
712
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
713
from_entry = self._get_entry(path=from_rel)
714
if from_entry == (None, None):
715
raise errors.BzrMoveFailedError(from_rel,to_dir,
716
errors.NotVersionedError(path=from_rel))
718
from_id = from_entry[0][2]
719
to_rel = pathjoin(to_dir, from_tail)
720
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
721
item_to_entry = self._get_entry(path=to_rel)
722
if item_to_entry != (None, None):
723
raise errors.BzrMoveFailedError(from_rel, to_rel,
724
"Target is already versioned.")
726
if from_rel == to_rel:
727
raise errors.BzrMoveFailedError(from_rel, to_rel,
728
"Source and target are identical.")
730
from_missing = not self.has_filename(from_rel)
731
to_missing = not self.has_filename(to_rel)
738
raise errors.BzrMoveFailedError(from_rel, to_rel,
739
errors.NoSuchFile(path=to_rel,
740
extra="New file has not been created yet"))
742
# neither path exists
743
raise errors.BzrRenameFailedError(from_rel, to_rel,
744
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
746
if from_missing: # implicitly just update our path mapping
749
raise errors.RenameFailedFilesExist(from_rel, to_rel)
752
def rollback_rename():
753
"""A single rename has failed, roll it back."""
754
# roll back everything, even if we encounter trouble doing one
757
# TODO: at least log the other exceptions rather than just
758
# losing them mbp 20070307
760
for rollback in reversed(rollbacks):
764
exc_info = sys.exc_info()
766
raise exc_info[0], exc_info[1], exc_info[2]
768
# perform the disk move first - its the most likely failure point.
770
from_rel_abs = self.abspath(from_rel)
771
to_rel_abs = self.abspath(to_rel)
773
osutils.rename(from_rel_abs, to_rel_abs)
775
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
776
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
778
# perform the rename in the inventory next if needed: its easy
782
from_entry = inv[from_id]
783
current_parent = from_entry.parent_id
784
inv.rename(from_id, to_dir_id, from_tail)
786
lambda: inv.rename(from_id, current_parent, from_tail))
787
# finally do the rename in the dirstate, which is a little
788
# tricky to rollback, but least likely to need it.
789
old_block_index, old_entry_index, dir_present, file_present = \
790
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
791
old_block = state._dirblocks[old_block_index][1]
792
old_entry = old_block[old_entry_index]
793
from_key, old_entry_details = old_entry
794
cur_details = old_entry_details[0]
796
to_key = ((to_block[0],) + from_key[1:3])
797
minikind = cur_details[0]
798
move_one(old_entry, from_path_utf8=from_rel_utf8,
800
executable=cur_details[3],
801
fingerprint=cur_details[1],
802
packed_stat=cur_details[4],
806
to_path_utf8=to_rel_utf8)
809
def update_dirblock(from_dir, to_key, to_dir_utf8):
810
"""Recursively update all entries in this dirblock."""
812
raise AssertionError("renaming root not supported")
813
from_key = (from_dir, '')
814
from_block_idx, present = \
815
state._find_block_index_from_key(from_key)
817
# This is the old record, if it isn't present, then
818
# there is theoretically nothing to update.
819
# (Unless it isn't present because of lazy loading,
820
# but we don't do that yet)
822
from_block = state._dirblocks[from_block_idx]
823
to_block_index, to_entry_index, _, _ = \
824
state._get_block_entry_index(to_key[0], to_key[1], 0)
825
to_block_index = state._ensure_block(
826
to_block_index, to_entry_index, to_dir_utf8)
827
to_block = state._dirblocks[to_block_index]
829
# Grab a copy since move_one may update the list.
830
for entry in from_block[1][:]:
831
if not (entry[0][0] == from_dir):
832
raise AssertionError()
833
cur_details = entry[1][0]
834
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
835
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
836
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
837
minikind = cur_details[0]
839
# Deleted children of a renamed directory
840
# Do not need to be updated.
841
# Children that have been renamed out of this
842
# directory should also not be updated
844
move_one(entry, from_path_utf8=from_path_utf8,
846
executable=cur_details[3],
847
fingerprint=cur_details[1],
848
packed_stat=cur_details[4],
852
to_path_utf8=to_path_utf8)
854
# We need to move all the children of this
856
update_dirblock(from_path_utf8, to_key,
858
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
862
result.append((from_rel, to_rel))
863
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
864
self._make_dirty(reset_inventory=False)
868
def _must_be_locked(self):
869
if not self._control_files._lock_count:
870
raise errors.ObjectNotLocked(self)
873
"""Initialize the state in this tree to be a new tree."""
877
def path2id(self, path):
878
"""Return the id for path in this tree."""
879
path = path.strip('/')
880
entry = self._get_entry(path=path)
881
if entry == (None, None):
885
def paths2ids(self, paths, trees=[], require_versioned=True):
886
"""See Tree.paths2ids().
888
This specialisation fast-paths the case where all the trees are in the
893
parents = self.get_parent_ids()
895
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
897
return super(DirStateWorkingTree, self).paths2ids(paths,
898
trees, require_versioned)
899
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
900
# -- make all paths utf8 --
903
paths_utf8.add(path.encode('utf8'))
905
# -- paths is now a utf8 path set --
906
# -- get the state object and prepare it.
907
state = self.current_dirstate()
908
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
909
and '' not in paths):
910
paths2ids = self._paths2ids_using_bisect
912
paths2ids = self._paths2ids_in_memory
913
return paths2ids(paths, search_indexes,
914
require_versioned=require_versioned)
916
def _paths2ids_in_memory(self, paths, search_indexes,
917
require_versioned=True):
918
state = self.current_dirstate()
919
state._read_dirblocks_if_needed()
920
def _entries_for_path(path):
921
"""Return a list with all the entries that match path for all ids.
923
dirname, basename = os.path.split(path)
924
key = (dirname, basename, '')
925
block_index, present = state._find_block_index_from_key(key)
927
# the block which should contain path is absent.
930
block = state._dirblocks[block_index][1]
931
entry_index, _ = state._find_entry_index(key, block)
932
# we may need to look at multiple entries at this path: walk while the paths match.
933
while (entry_index < len(block) and
934
block[entry_index][0][0:2] == key[0:2]):
935
result.append(block[entry_index])
938
if require_versioned:
939
# -- check all supplied paths are versioned in a search tree. --
942
path_entries = _entries_for_path(path)
944
# this specified path is not present at all: error
945
all_versioned = False
947
found_versioned = False
948
# for each id at this path
949
for entry in path_entries:
951
for index in search_indexes:
952
if entry[1][index][0] != 'a': # absent
953
found_versioned = True
954
# all good: found a versioned cell
956
if not found_versioned:
957
# none of the indexes was not 'absent' at all ids for this
959
all_versioned = False
961
if not all_versioned:
962
raise errors.PathsNotVersionedError(paths)
963
# -- remove redundancy in supplied paths to prevent over-scanning --
964
search_paths = osutils.minimum_path_selection(paths)
966
# for all search_indexs in each path at or under each element of
967
# search_paths, if the detail is relocated: add the id, and add the
968
# relocated path as one to search if its not searched already. If the
969
# detail is not relocated, add the id.
970
searched_paths = set()
972
def _process_entry(entry):
973
"""Look at search_indexes within entry.
975
If a specific tree's details are relocated, add the relocation
976
target to search_paths if not searched already. If it is absent, do
977
nothing. Otherwise add the id to found_ids.
979
for index in search_indexes:
980
if entry[1][index][0] == 'r': # relocated
981
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
982
search_paths.add(entry[1][index][1])
983
elif entry[1][index][0] != 'a': # absent
984
found_ids.add(entry[0][2])
986
current_root = search_paths.pop()
987
searched_paths.add(current_root)
988
# process the entries for this containing directory: the rest will be
989
# found by their parents recursively.
990
root_entries = _entries_for_path(current_root)
992
# this specified path is not present at all, skip it.
994
for entry in root_entries:
995
_process_entry(entry)
996
initial_key = (current_root, '', '')
997
block_index, _ = state._find_block_index_from_key(initial_key)
998
while (block_index < len(state._dirblocks) and
999
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
1000
for entry in state._dirblocks[block_index][1]:
1001
_process_entry(entry)
1005
def _paths2ids_using_bisect(self, paths, search_indexes,
1006
require_versioned=True):
1007
state = self.current_dirstate()
1010
split_paths = sorted(osutils.split(p) for p in paths)
1011
found = state._bisect_recursive(split_paths)
1013
if require_versioned:
1014
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1015
for dir_name in split_paths:
1016
if dir_name not in found_dir_names:
1017
raise errors.PathsNotVersionedError(paths)
1019
for dir_name_id, trees_info in found.iteritems():
1020
for index in search_indexes:
1021
if trees_info[index][0] not in ('r', 'a'):
1022
found_ids.add(dir_name_id[2])
1025
def read_working_inventory(self):
1026
"""Read the working inventory.
1028
This is a meaningless operation for dirstate, but we obey it anyhow.
1030
return self.inventory
1033
def revision_tree(self, revision_id):
1034
"""See Tree.revision_tree.
1036
WorkingTree4 supplies revision_trees for any basis tree.
1038
dirstate = self.current_dirstate()
1039
parent_ids = dirstate.get_parent_ids()
1040
if revision_id not in parent_ids:
1041
raise errors.NoSuchRevisionInTree(self, revision_id)
1042
if revision_id in dirstate.get_ghosts():
1043
raise errors.NoSuchRevisionInTree(self, revision_id)
1044
return DirStateRevisionTree(dirstate, revision_id,
1045
self.branch.repository)
1047
@needs_tree_write_lock
1048
def set_last_revision(self, new_revision):
1049
"""Change the last revision in the working tree."""
1050
parents = self.get_parent_ids()
1051
if new_revision in (_mod_revision.NULL_REVISION, None):
1052
if len(parents) >= 2:
1053
raise AssertionError(
1054
"setting the last parent to none with a pending merge is "
1056
self.set_parent_ids([])
1058
self.set_parent_ids([new_revision] + parents[1:],
1059
allow_leftmost_as_ghost=True)
1061
@needs_tree_write_lock
1062
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1063
"""Set the parent ids to revision_ids.
1065
See also set_parent_trees. This api will try to retrieve the tree data
1066
for each element of revision_ids from the trees repository. If you have
1067
tree data already available, it is more efficient to use
1068
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1069
an easier API to use.
1071
:param revision_ids: The revision_ids to set as the parent ids of this
1072
working tree. Any of these may be ghosts.
1075
for revision_id in revision_ids:
1077
revtree = self.branch.repository.revision_tree(revision_id)
1078
# TODO: jam 20070213 KnitVersionedFile raises
1079
# RevisionNotPresent rather than NoSuchRevision if a
1080
# given revision_id is not present. Should Repository be
1081
# catching it and re-raising NoSuchRevision?
1082
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1084
trees.append((revision_id, revtree))
1085
self.set_parent_trees(trees,
1086
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1088
@needs_tree_write_lock
1089
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1090
"""Set the parents of the working tree.
1092
:param parents_list: A list of (revision_id, tree) tuples.
1093
If tree is None, then that element is treated as an unreachable
1094
parent tree - i.e. a ghost.
1096
dirstate = self.current_dirstate()
1097
if len(parents_list) > 0:
1098
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1099
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1103
parent_ids = [rev_id for rev_id, tree in parents_list]
1104
graph = self.branch.repository.get_graph()
1105
heads = graph.heads(parent_ids)
1106
accepted_revisions = set()
1108
# convert absent trees to the null tree, which we convert back to
1109
# missing on access.
1110
for rev_id, tree in parents_list:
1111
if len(accepted_revisions) > 0:
1112
# we always accept the first tree
1113
if rev_id in accepted_revisions or rev_id not in heads:
1114
# We have already included either this tree, or its
1115
# descendent, so we skip it.
1117
_mod_revision.check_not_reserved_id(rev_id)
1118
if tree is not None:
1119
real_trees.append((rev_id, tree))
1121
real_trees.append((rev_id,
1122
self.branch.repository.revision_tree(
1123
_mod_revision.NULL_REVISION)))
1124
ghosts.append(rev_id)
1125
accepted_revisions.add(rev_id)
1126
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1127
self._make_dirty(reset_inventory=False)
1129
def _set_root_id(self, file_id):
1130
"""See WorkingTree.set_root_id."""
1131
state = self.current_dirstate()
1132
state.set_path_id('', file_id)
1133
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1134
self._make_dirty(reset_inventory=True)
1136
def _sha_from_stat(self, path, stat_result):
1137
"""Get a sha digest from the tree's stat cache.
1139
The default implementation assumes no stat cache is present.
1141
:param path: The path.
1142
:param stat_result: The stat result being looked up.
1144
return self.current_dirstate().sha1_from_stat(path, stat_result)
1147
def supports_tree_reference(self):
1148
return self._repo_supports_tree_reference
1151
"""Unlock in format 4 trees needs to write the entire dirstate."""
1152
# do non-implementation specific cleanup
1155
if self._control_files._lock_count == 1:
1156
# eventually we should do signature checking during read locks for
1158
if self._control_files._lock_mode == 'w':
1161
if self._dirstate is not None:
1162
# This is a no-op if there are no modifications.
1163
self._dirstate.save()
1164
self._dirstate.unlock()
1165
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1166
# point. Instead, it could check if the header has been
1167
# modified when it is locked, and if not, it can hang on to
1168
# the data it has in memory.
1169
self._dirstate = None
1170
self._inventory = None
1171
# reverse order of locking.
1173
return self._control_files.unlock()
1175
self.branch.unlock()
1177
@needs_tree_write_lock
1178
def unversion(self, file_ids):
1179
"""Remove the file ids in file_ids from the current versioned set.
1181
When a file_id is unversioned, all of its children are automatically
1184
:param file_ids: The file ids to stop versioning.
1185
:raises: NoSuchId if any fileid is not currently versioned.
1189
state = self.current_dirstate()
1190
state._read_dirblocks_if_needed()
1191
ids_to_unversion = set(file_ids)
1192
paths_to_unversion = set()
1194
# check if the root is to be unversioned, if so, assert for now.
1195
# walk the state marking unversioned things as absent.
1196
# if there are any un-unversioned ids at the end, raise
1197
for key, details in state._dirblocks[0][1]:
1198
if (details[0][0] not in ('a', 'r') and # absent or relocated
1199
key[2] in ids_to_unversion):
1200
# I haven't written the code to unversion / yet - it should be
1202
raise errors.BzrError('Unversioning the / is not currently supported')
1204
while block_index < len(state._dirblocks):
1205
# process one directory at a time.
1206
block = state._dirblocks[block_index]
1207
# first check: is the path one to remove - it or its children
1208
delete_block = False
1209
for path in paths_to_unversion:
1210
if (block[0].startswith(path) and
1211
(len(block[0]) == len(path) or
1212
block[0][len(path)] == '/')):
1213
# this entire block should be deleted - its the block for a
1214
# path to unversion; or the child of one
1217
# TODO: trim paths_to_unversion as we pass by paths
1219
# this block is to be deleted: process it.
1220
# TODO: we can special case the no-parents case and
1221
# just forget the whole block.
1223
while entry_index < len(block[1]):
1224
entry = block[1][entry_index]
1225
if entry[1][0][0] in 'ar':
1226
# don't remove absent or renamed entries
1229
# Mark this file id as having been removed
1230
ids_to_unversion.discard(entry[0][2])
1231
if not state._make_absent(entry):
1232
# The block has not shrunk.
1234
# go to the next block. (At the moment we dont delete empty
1239
while entry_index < len(block[1]):
1240
entry = block[1][entry_index]
1241
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1242
# ^ some parent row.
1243
entry[0][2] not in ids_to_unversion):
1244
# ^ not an id to unversion
1247
if entry[1][0][0] == 'd':
1248
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1249
if not state._make_absent(entry):
1251
# we have unversioned this id
1252
ids_to_unversion.remove(entry[0][2])
1254
if ids_to_unversion:
1255
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1256
self._make_dirty(reset_inventory=False)
1257
# have to change the legacy inventory too.
1258
if self._inventory is not None:
1259
for file_id in file_ids:
1260
if self._inventory.has_id(file_id):
1261
self._inventory.remove_recursive_id(file_id)
1263
@needs_tree_write_lock
1264
def rename_one(self, from_rel, to_rel, after=False):
1265
"""See WorkingTree.rename_one"""
1267
super(DirStateWorkingTree, self).rename_one(from_rel, to_rel, after)
1269
@needs_tree_write_lock
1270
def apply_inventory_delta(self, changes):
1271
"""See MutableTree.apply_inventory_delta"""
1272
state = self.current_dirstate()
1273
state.update_by_delta(changes)
1274
self._make_dirty(reset_inventory=True)
1276
def update_basis_by_delta(self, new_revid, delta):
1277
"""See MutableTree.update_basis_by_delta."""
1278
if self.last_revision() == new_revid:
1279
raise AssertionError()
1280
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1283
def _validate(self):
1284
self._dirstate._validate()
1286
@needs_tree_write_lock
1287
def _write_inventory(self, inv):
1288
"""Write inventory as the current inventory."""
1290
raise AssertionError("attempting to write an inventory when the "
1291
"dirstate is dirty will lose pending changes")
1292
had_inventory = self._inventory is not None
1293
# Setting self._inventory = None forces the dirstate to regenerate the
1294
# working inventory. We do this because self.inventory may be inv, or
1295
# may have been modified, and either case would prevent a clean delta
1297
self._inventory = None
1299
delta = inv._make_delta(self.inventory)
1301
self.apply_inventory_delta(delta)
1303
self._inventory = inv
1306
@needs_tree_write_lock
1307
def reset_state(self, revision_ids=None):
1308
"""Reset the state of the working tree.
1310
This does a hard-reset to a last-known-good state. This is a way to
1311
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1313
if revision_ids is None:
1314
revision_ids = self.get_parent_ids()
1315
if not revision_ids:
1316
base_tree = self.branch.repository.revision_tree(
1317
_mod_revision.NULL_REVISION)
1320
trees = zip(revision_ids,
1321
self.branch.repository.revision_trees(revision_ids))
1322
base_tree = trees[0][1]
1323
state = self.current_dirstate()
1324
# We don't support ghosts yet
1325
state.set_state_from_scratch(base_tree.inventory, trees, [])
1328
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1330
def __init__(self, tree):
1333
def sha1(self, abspath):
1334
"""See dirstate.SHA1Provider.sha1()."""
1335
filters = self.tree._content_filter_stack(
1336
self.tree.relpath(osutils.safe_unicode(abspath)))
1337
return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
1339
def stat_and_sha1(self, abspath):
1340
"""See dirstate.SHA1Provider.stat_and_sha1()."""
1341
filters = self.tree._content_filter_stack(
1342
self.tree.relpath(osutils.safe_unicode(abspath)))
1343
file_obj = file(abspath, 'rb', 65000)
1345
statvalue = os.fstat(file_obj.fileno())
1347
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
1348
sha1 = osutils.size_sha_file(file_obj)[1]
1351
return statvalue, sha1
1354
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1355
"""Dirstate working tree that supports content filtering.
1357
The dirstate holds the hash and size of the canonical form of the file,
1358
and most methods must return that.
1361
def _file_content_summary(self, path, stat_result):
1362
# This is to support the somewhat obsolete path_content_summary method
1363
# with content filtering: see
1364
# <https://bugs.launchpad.net/bzr/+bug/415508>.
1366
# If the dirstate cache is up to date and knows the hash and size,
1368
# Otherwise if there are no content filters, return the on-disk size
1369
# and leave the hash blank.
1370
# Otherwise, read and filter the on-disk file and use its size and
1373
# The dirstate doesn't store the size of the canonical form so we
1374
# can't trust it for content-filtered trees. We just return None.
1375
dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1376
executable = self._is_executable_from_path_and_stat(path, stat_result)
1377
return ('file', None, executable, dirstate_sha1)
1380
class WorkingTree4(DirStateWorkingTree):
1381
"""This is the Format 4 working tree.
1383
This differs from WorkingTree by:
1384
- Having a consolidated internal dirstate, stored in a
1385
randomly-accessible sorted file on disk.
1386
- Not having a regular inventory attribute. One can be synthesized
1387
on demand but this is expensive and should be avoided.
1389
This is new in bzr 0.15.
1393
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1394
"""This is the Format 5 working tree.
1396
This differs from WorkingTree4 by:
1397
- Supporting content filtering.
1399
This is new in bzr 1.11.
1403
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1404
"""This is the Format 6 working tree.
1406
This differs from WorkingTree5 by:
1407
- Supporting a current view that may mask the set of files in a tree
1408
impacted by most user operations.
1410
This is new in bzr 1.14.
1413
def _make_views(self):
1414
return views.PathBasedViews(self)
1417
class DirStateWorkingTreeFormat(WorkingTreeFormat):
1419
missing_parent_conflicts = True
1421
_lock_class = LockDir
1422
_lock_file_name = 'lock'
1424
def _open_control_files(self, a_bzrdir):
1425
transport = a_bzrdir.get_workingtree_transport(None)
1426
return LockableFiles(transport, self._lock_file_name,
1429
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1430
accelerator_tree=None, hardlink=False):
1431
"""See WorkingTreeFormat.initialize().
1433
:param revision_id: allows creating a working tree at a different
1434
revision than the branch is at.
1435
:param accelerator_tree: A tree which can be used for retrieving file
1436
contents more quickly than the revision tree, i.e. a workingtree.
1437
The revision tree will be used for cases where accelerator_tree's
1438
content is different.
1439
:param hardlink: If true, hard-link files from accelerator_tree,
1442
These trees get an initial random root id, if their repository supports
1443
rich root data, TREE_ROOT otherwise.
1445
if not isinstance(a_bzrdir.transport, LocalTransport):
1446
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1447
transport = a_bzrdir.get_workingtree_transport(self)
1448
control_files = self._open_control_files(a_bzrdir)
1449
control_files.create_lock()
1450
control_files.lock_write()
1451
transport.put_bytes('format', self.get_format_string(),
1452
mode=a_bzrdir._get_file_mode())
1453
if from_branch is not None:
1454
branch = from_branch
1456
branch = a_bzrdir.open_branch()
1457
if revision_id is None:
1458
revision_id = branch.last_revision()
1459
local_path = transport.local_abspath('dirstate')
1460
# write out new dirstate (must exist when we create the tree)
1461
state = dirstate.DirState.initialize(local_path)
1464
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1468
_control_files=control_files)
1470
wt.lock_tree_write()
1472
self._init_custom_control_files(wt)
1473
if revision_id in (None, _mod_revision.NULL_REVISION):
1474
if branch.repository.supports_rich_root():
1475
wt._set_root_id(generate_ids.gen_root_id())
1477
wt._set_root_id(ROOT_ID)
1480
# frequently, we will get here due to branching. The accelerator
1481
# tree will be the tree from the branch, so the desired basis
1482
# tree will often be a parent of the accelerator tree.
1483
if accelerator_tree is not None:
1485
basis = accelerator_tree.revision_tree(revision_id)
1486
except errors.NoSuchRevision:
1489
basis = branch.repository.revision_tree(revision_id)
1490
if revision_id == _mod_revision.NULL_REVISION:
1493
parents_list = [(revision_id, basis)]
1496
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1498
# if the basis has a root id we have to use that; otherwise we
1499
# use a new random one
1500
basis_root_id = basis.get_root_id()
1501
if basis_root_id is not None:
1502
wt._set_root_id(basis_root_id)
1504
if wt.supports_content_filtering():
1505
# The original tree may not have the same content filters
1506
# applied so we can't safely build the inventory delta from
1508
delta_from_tree = False
1510
delta_from_tree = True
1511
# delta_from_tree is safe even for DirStateRevisionTrees,
1512
# because wt4.apply_inventory_delta does not mutate the input
1513
# inventory entries.
1514
transform.build_tree(basis, wt, accelerator_tree,
1516
delta_from_tree=delta_from_tree)
1520
control_files.unlock()
1524
def _init_custom_control_files(self, wt):
1525
"""Subclasses with custom control files should override this method.
1527
The working tree and control files are locked for writing when this
1530
:param wt: the WorkingTree object
1533
def open(self, a_bzrdir, _found=False):
1534
"""Return the WorkingTree object for a_bzrdir
1536
_found is a private parameter, do not use it. It is used to indicate
1537
if format probing has already been done.
1540
# we are being called directly and must probe.
1541
raise NotImplementedError
1542
if not isinstance(a_bzrdir.transport, LocalTransport):
1543
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1544
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1547
def _open(self, a_bzrdir, control_files):
1548
"""Open the tree itself.
1550
:param a_bzrdir: the dir for the tree.
1551
:param control_files: the control files for the tree.
1553
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1554
branch=a_bzrdir.open_branch(),
1557
_control_files=control_files)
1559
def __get_matchingbzrdir(self):
1560
return self._get_matchingbzrdir()
1562
def _get_matchingbzrdir(self):
1563
"""Overrideable method to get a bzrdir for testing."""
1564
# please test against something that will let us do tree references
1565
return bzrdir.format_registry.make_bzrdir(
1566
'dirstate-with-subtree')
1568
_matchingbzrdir = property(__get_matchingbzrdir)
1571
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1572
"""The first consolidated dirstate working tree format.
1575
- exists within a metadir controlling .bzr
1576
- includes an explicit version marker for the workingtree control
1577
files, separate from the BzrDir format
1578
- modifies the hash cache format
1579
- is new in bzr 0.15
1580
- uses a LockDir to guard access to it.
1583
upgrade_recommended = False
1585
_tree_class = WorkingTree4
1587
def get_format_string(self):
1588
"""See WorkingTreeFormat.get_format_string()."""
1589
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1591
def get_format_description(self):
1592
"""See WorkingTreeFormat.get_format_description()."""
1593
return "Working tree format 4"
1596
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1597
"""WorkingTree format supporting content filtering.
1600
upgrade_recommended = False
1602
_tree_class = WorkingTree5
1604
def get_format_string(self):
1605
"""See WorkingTreeFormat.get_format_string()."""
1606
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1608
def get_format_description(self):
1609
"""See WorkingTreeFormat.get_format_description()."""
1610
return "Working tree format 5"
1612
def supports_content_filtering(self):
1616
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1617
"""WorkingTree format supporting views.
1620
upgrade_recommended = False
1622
_tree_class = WorkingTree6
1624
def get_format_string(self):
1625
"""See WorkingTreeFormat.get_format_string()."""
1626
return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1628
def get_format_description(self):
1629
"""See WorkingTreeFormat.get_format_description()."""
1630
return "Working tree format 6"
1632
def _init_custom_control_files(self, wt):
1633
"""Subclasses with custom control files should override this method."""
1634
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1636
def supports_content_filtering(self):
1639
def supports_views(self):
1643
class DirStateRevisionTree(InventoryTree):
1644
"""A revision tree pulling the inventory from a dirstate.
1646
Note that this is one of the historical (ie revision) trees cached in the
1647
dirstate for easy access, not the workingtree.
1650
def __init__(self, dirstate, revision_id, repository):
1651
self._dirstate = dirstate
1652
self._revision_id = revision_id
1653
self._repository = repository
1654
self._inventory = None
1656
self._dirstate_locked = False
1657
self._repo_supports_tree_reference = getattr(
1658
repository._format, "supports_tree_reference",
1662
return "<%s of %s in %s>" % \
1663
(self.__class__.__name__, self._revision_id, self._dirstate)
1665
def annotate_iter(self, file_id,
1666
default_revision=_mod_revision.CURRENT_REVISION):
1667
"""See Tree.annotate_iter"""
1668
text_key = (file_id, self.get_file_revision(file_id))
1669
annotations = self._repository.texts.annotate(text_key)
1670
return [(key[-1], line) for (key, line) in annotations]
1672
def _get_ancestors(self, default_revision):
1673
return set(self._repository.get_ancestry(self._revision_id,
1675
def _comparison_data(self, entry, path):
1676
"""See Tree._comparison_data."""
1678
return None, False, None
1679
# trust the entry as RevisionTree does, but this may not be
1680
# sensible: the entry might not have come from us?
1681
return entry.kind, entry.executable, None
1683
def _file_size(self, entry, stat_value):
1684
return entry.text_size
1686
def filter_unversioned_files(self, paths):
1687
"""Filter out paths that are not versioned.
1689
:return: set of paths.
1691
pred = self.has_filename
1692
return set((p for p in paths if not pred(p)))
1694
def get_root_id(self):
1695
return self.path2id('')
1697
def id2path(self, file_id):
1698
"Convert a file-id to a path."
1699
entry = self._get_entry(file_id=file_id)
1700
if entry == (None, None):
1701
raise errors.NoSuchId(tree=self, file_id=file_id)
1702
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1703
return path_utf8.decode('utf8')
1705
def iter_references(self):
1706
if not self._repo_supports_tree_reference:
1707
# When the repo doesn't support references, we will have nothing to
1710
# Otherwise, fall back to the default implementation
1711
return super(DirStateRevisionTree, self).iter_references()
1713
def _get_parent_index(self):
1714
"""Return the index in the dirstate referenced by this tree."""
1715
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1717
def _get_entry(self, file_id=None, path=None):
1718
"""Get the dirstate row for file_id or path.
1720
If either file_id or path is supplied, it is used as the key to lookup.
1721
If both are supplied, the fastest lookup is used, and an error is
1722
raised if they do not both point at the same row.
1724
:param file_id: An optional unicode file_id to be looked up.
1725
:param path: An optional unicode path to be looked up.
1726
:return: The dirstate row tuple for path/file_id, or (None, None)
1728
if file_id is None and path is None:
1729
raise errors.BzrError('must supply file_id or path')
1730
if path is not None:
1731
path = path.encode('utf8')
1732
parent_index = self._get_parent_index()
1733
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1735
def _generate_inventory(self):
1736
"""Create and set self.inventory from the dirstate object.
1738
(So this is only called the first time the inventory is requested for
1739
this tree; it then remains in memory until it's out of date.)
1741
This is relatively expensive: we have to walk the entire dirstate.
1743
if not self._locked:
1744
raise AssertionError(
1745
'cannot generate inventory of an unlocked '
1746
'dirstate revision tree')
1747
# separate call for profiling - makes it clear where the costs are.
1748
self._dirstate._read_dirblocks_if_needed()
1749
if self._revision_id not in self._dirstate.get_parent_ids():
1750
raise AssertionError(
1751
'parent %s has disappeared from %s' % (
1752
self._revision_id, self._dirstate.get_parent_ids()))
1753
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1754
# This is identical now to the WorkingTree _generate_inventory except
1755
# for the tree index use.
1756
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1757
current_id = root_key[2]
1758
if current_entry[parent_index][0] != 'd':
1759
raise AssertionError()
1760
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1761
inv.root.revision = current_entry[parent_index][4]
1762
# Turn some things into local variables
1763
minikind_to_kind = dirstate.DirState._minikind_to_kind
1764
factory = entry_factory
1765
utf8_decode = cache_utf8._utf8_decode
1766
inv_byid = inv._byid
1767
# we could do this straight out of the dirstate; it might be fast
1768
# and should be profiled - RBC 20070216
1769
parent_ies = {'' : inv.root}
1770
for block in self._dirstate._dirblocks[1:]: #skip root
1773
parent_ie = parent_ies[dirname]
1775
# all the paths in this block are not versioned in this tree
1777
for key, entry in block[1]:
1778
minikind, fingerprint, size, executable, revid = entry[parent_index]
1779
if minikind in ('a', 'r'): # absent, relocated
1783
name_unicode = utf8_decode(name)[0]
1785
kind = minikind_to_kind[minikind]
1786
inv_entry = factory[kind](file_id, name_unicode,
1788
inv_entry.revision = revid
1790
inv_entry.executable = executable
1791
inv_entry.text_size = size
1792
inv_entry.text_sha1 = fingerprint
1793
elif kind == 'directory':
1794
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1795
elif kind == 'symlink':
1796
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1797
elif kind == 'tree-reference':
1798
inv_entry.reference_revision = fingerprint or None
1800
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1802
# These checks cost us around 40ms on a 55k entry tree
1803
if file_id in inv_byid:
1804
raise AssertionError('file_id %s already in'
1805
' inventory as %s' % (file_id, inv_byid[file_id]))
1806
if name_unicode in parent_ie.children:
1807
raise AssertionError('name %r already in parent'
1809
inv_byid[file_id] = inv_entry
1810
parent_ie.children[name_unicode] = inv_entry
1811
self._inventory = inv
1813
def get_file_mtime(self, file_id, path=None):
1814
"""Return the modification time for this record.
1816
We return the timestamp of the last-changed revision.
1818
# Make sure the file exists
1819
entry = self._get_entry(file_id, path=path)
1820
if entry == (None, None): # do we raise?
1822
parent_index = self._get_parent_index()
1823
last_changed_revision = entry[1][parent_index][4]
1825
rev = self._repository.get_revision(last_changed_revision)
1826
except errors.NoSuchRevision:
1827
raise errors.FileTimestampUnavailable(self.id2path(file_id))
1828
return rev.timestamp
1830
def get_file_sha1(self, file_id, path=None, stat_value=None):
1831
entry = self._get_entry(file_id=file_id, path=path)
1832
parent_index = self._get_parent_index()
1833
parent_details = entry[1][parent_index]
1834
if parent_details[0] == 'f':
1835
return parent_details[1]
1839
def get_file_revision(self, file_id):
1840
return self.inventory[file_id].revision
1842
def get_file(self, file_id, path=None):
1843
return StringIO(self.get_file_text(file_id))
1845
def get_file_size(self, file_id):
1846
"""See Tree.get_file_size"""
1847
return self.inventory[file_id].text_size
1849
def get_file_text(self, file_id, path=None):
1850
_, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1851
return ''.join(content)
1853
def get_reference_revision(self, file_id, path=None):
1854
return self.inventory[file_id].reference_revision
1856
def iter_files_bytes(self, desired_files):
1857
"""See Tree.iter_files_bytes.
1859
This version is implemented on top of Repository.iter_files_bytes"""
1860
parent_index = self._get_parent_index()
1861
repo_desired_files = []
1862
for file_id, identifier in desired_files:
1863
entry = self._get_entry(file_id)
1864
if entry == (None, None):
1865
raise errors.NoSuchId(self, file_id)
1866
repo_desired_files.append((file_id, entry[1][parent_index][4],
1868
return self._repository.iter_files_bytes(repo_desired_files)
1870
def get_symlink_target(self, file_id):
1871
entry = self._get_entry(file_id=file_id)
1872
parent_index = self._get_parent_index()
1873
if entry[1][parent_index][0] != 'l':
1876
target = entry[1][parent_index][1]
1877
target = target.decode('utf8')
1880
def get_revision_id(self):
1881
"""Return the revision id for this tree."""
1882
return self._revision_id
1884
def _get_inventory(self):
1885
if self._inventory is not None:
1886
return self._inventory
1887
self._must_be_locked()
1888
self._generate_inventory()
1889
return self._inventory
1891
inventory = property(_get_inventory,
1892
doc="Inventory of this Tree")
1894
def get_parent_ids(self):
1895
"""The parents of a tree in the dirstate are not cached."""
1896
return self._repository.get_revision(self._revision_id).parent_ids
1898
def has_filename(self, filename):
1899
return bool(self.path2id(filename))
1901
def kind(self, file_id):
1902
entry = self._get_entry(file_id=file_id)[1]
1904
raise errors.NoSuchId(tree=self, file_id=file_id)
1905
parent_index = self._get_parent_index()
1906
return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1908
def stored_kind(self, file_id):
1909
"""See Tree.stored_kind"""
1910
return self.kind(file_id)
1912
def path_content_summary(self, path):
1913
"""See Tree.path_content_summary."""
1914
id = self.inventory.path2id(path)
1916
return ('missing', None, None, None)
1917
entry = self._inventory[id]
1920
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1921
elif kind == 'symlink':
1922
return (kind, None, None, entry.symlink_target)
1924
return (kind, None, None, None)
1926
def is_executable(self, file_id, path=None):
1927
ie = self.inventory[file_id]
1928
if ie.kind != "file":
1930
return ie.executable
1932
def is_locked(self):
1935
def list_files(self, include_root=False, from_dir=None, recursive=True):
1936
# We use a standard implementation, because DirStateRevisionTree is
1937
# dealing with one of the parents of the current state
1938
inv = self._get_inventory()
1939
if from_dir is None:
1942
from_dir_id = inv.path2id(from_dir)
1943
if from_dir_id is None:
1944
# Directory not versioned
1946
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1947
if inv.root is not None and not include_root and from_dir is None:
1949
for path, entry in entries:
1950
yield path, 'V', entry.kind, entry.file_id, entry
1952
def lock_read(self):
1953
"""Lock the tree for a set of operations.
1955
:return: A bzrlib.lock.LogicalLockResult.
1957
if not self._locked:
1958
self._repository.lock_read()
1959
if self._dirstate._lock_token is None:
1960
self._dirstate.lock_read()
1961
self._dirstate_locked = True
1963
return LogicalLockResult(self.unlock)
1965
def _must_be_locked(self):
1966
if not self._locked:
1967
raise errors.ObjectNotLocked(self)
1970
def path2id(self, path):
1971
"""Return the id for path in this tree."""
1972
# lookup by path: faster than splitting and walking the ivnentory.
1973
entry = self._get_entry(path=path)
1974
if entry == (None, None):
1979
"""Unlock, freeing any cache memory used during the lock."""
1980
# outside of a lock, the inventory is suspect: release it.
1982
if not self._locked:
1983
self._inventory = None
1985
if self._dirstate_locked:
1986
self._dirstate.unlock()
1987
self._dirstate_locked = False
1988
self._repository.unlock()
1991
def supports_tree_reference(self):
1992
return self._repo_supports_tree_reference
1994
def walkdirs(self, prefix=""):
1995
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1996
# implementation based on an inventory.
1997
# This should be cleaned up to use the much faster Dirstate code
1998
# So for now, we just build up the parent inventory, and extract
1999
# it the same way RevisionTree does.
2000
_directory = 'directory'
2001
inv = self._get_inventory()
2002
top_id = inv.path2id(prefix)
2006
pending = [(prefix, top_id)]
2009
relpath, file_id = pending.pop()
2010
# 0 - relpath, 1- file-id
2012
relroot = relpath + '/'
2015
# FIXME: stash the node in pending
2016
entry = inv[file_id]
2017
for name, child in entry.sorted_children():
2018
toppath = relroot + name
2019
dirblock.append((toppath, name, child.kind, None,
2020
child.file_id, child.kind
2022
yield (relpath, entry.file_id), dirblock
2023
# push the user specified dirs from dirblock
2024
for dir in reversed(dirblock):
2025
if dir[2] == _directory:
2026
pending.append((dir[0], dir[4]))
2029
class InterDirStateTree(InterTree):
2030
"""Fast path optimiser for changes_from with dirstate trees.
2032
This is used only when both trees are in the dirstate working file, and
2033
the source is any parent within the dirstate, and the destination is
2034
the current working tree of the same dirstate.
2036
# this could be generalized to allow comparisons between any trees in the
2037
# dirstate, and possibly between trees stored in different dirstates.
2039
def __init__(self, source, target):
2040
super(InterDirStateTree, self).__init__(source, target)
2041
if not InterDirStateTree.is_compatible(source, target):
2042
raise Exception, "invalid source %r and target %r" % (source, target)
2045
def make_source_parent_tree(source, target):
2046
"""Change the source tree into a parent of the target."""
2047
revid = source.commit('record tree')
2048
target.branch.fetch(source.branch, revid)
2049
target.set_parent_ids([revid])
2050
return target.basis_tree(), target
2053
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
2054
result = klass.make_source_parent_tree(source, target)
2055
result[1]._iter_changes = dirstate.ProcessEntryPython
2059
def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
2061
from bzrlib.tests.test__dirstate_helpers import \
2062
compiled_dirstate_helpers_feature
2063
test_case.requireFeature(compiled_dirstate_helpers_feature)
2064
from bzrlib._dirstate_helpers_pyx import ProcessEntryC
2065
result = klass.make_source_parent_tree(source, target)
2066
result[1]._iter_changes = ProcessEntryC
2069
_matching_from_tree_format = WorkingTreeFormat4()
2070
_matching_to_tree_format = WorkingTreeFormat4()
2073
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
2074
# This method shouldn't be called, because we have python and C
2075
# specific flavours.
2076
raise NotImplementedError
2078
def iter_changes(self, include_unchanged=False,
2079
specific_files=None, pb=None, extra_trees=[],
2080
require_versioned=True, want_unversioned=False):
2081
"""Return the changes from source to target.
2083
:return: An iterator that yields tuples. See InterTree.iter_changes
2085
:param specific_files: An optional list of file paths to restrict the
2086
comparison to. When mapping filenames to ids, all matches in all
2087
trees (including optional extra_trees) are used, and all children of
2088
matched directories are included.
2089
:param include_unchanged: An optional boolean requesting the inclusion of
2090
unchanged entries in the result.
2091
:param extra_trees: An optional list of additional trees to use when
2092
mapping the contents of specific_files (paths) to file_ids.
2093
:param require_versioned: If True, all files in specific_files must be
2094
versioned in one of source, target, extra_trees or
2095
PathsNotVersionedError is raised.
2096
:param want_unversioned: Should unversioned files be returned in the
2097
output. An unversioned file is defined as one with (False, False)
2098
for the versioned pair.
2100
# TODO: handle extra trees in the dirstate.
2101
if (extra_trees or specific_files == []):
2102
# we can't fast-path these cases (yet)
2103
return super(InterDirStateTree, self).iter_changes(
2104
include_unchanged, specific_files, pb, extra_trees,
2105
require_versioned, want_unversioned=want_unversioned)
2106
parent_ids = self.target.get_parent_ids()
2107
if not (self.source._revision_id in parent_ids
2108
or self.source._revision_id == _mod_revision.NULL_REVISION):
2109
raise AssertionError(
2110
"revision {%s} is not stored in {%s}, but %s "
2111
"can only be used for trees stored in the dirstate"
2112
% (self.source._revision_id, self.target, self.iter_changes))
2114
if self.source._revision_id == _mod_revision.NULL_REVISION:
2116
indices = (target_index,)
2118
if not (self.source._revision_id in parent_ids):
2119
raise AssertionError(
2120
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2121
self.source._revision_id, parent_ids))
2122
source_index = 1 + parent_ids.index(self.source._revision_id)
2123
indices = (source_index, target_index)
2124
# -- make all specific_files utf8 --
2126
specific_files_utf8 = set()
2127
for path in specific_files:
2128
# Note, if there are many specific files, using cache_utf8
2129
# would be good here.
2130
specific_files_utf8.add(path.encode('utf8'))
2131
specific_files = specific_files_utf8
2133
specific_files = set([''])
2134
# -- specific_files is now a utf8 path set --
2136
# -- get the state object and prepare it.
2137
state = self.target.current_dirstate()
2138
state._read_dirblocks_if_needed()
2139
if require_versioned:
2140
# -- check all supplied paths are versioned in a search tree. --
2142
for path in specific_files:
2143
path_entries = state._entries_for_path(path)
2144
if not path_entries:
2145
# this specified path is not present at all: error
2146
not_versioned.append(path)
2148
found_versioned = False
2149
# for each id at this path
2150
for entry in path_entries:
2152
for index in indices:
2153
if entry[1][index][0] != 'a': # absent
2154
found_versioned = True
2155
# all good: found a versioned cell
2157
if not found_versioned:
2158
# none of the indexes was not 'absent' at all ids for this
2160
not_versioned.append(path)
2161
if len(not_versioned) > 0:
2162
raise errors.PathsNotVersionedError(not_versioned)
2163
# -- remove redundancy in supplied specific_files to prevent over-scanning --
2164
search_specific_files = osutils.minimum_path_selection(specific_files)
2166
use_filesystem_for_exec = (sys.platform != 'win32')
2167
iter_changes = self.target._iter_changes(include_unchanged,
2168
use_filesystem_for_exec, search_specific_files, state,
2169
source_index, target_index, want_unversioned, self.target)
2170
return iter_changes.iter_changes()
2173
def is_compatible(source, target):
2174
# the target must be a dirstate working tree
2175
if not isinstance(target, DirStateWorkingTree):
2177
# the source must be a revtree or dirstate rev tree.
2178
if not isinstance(source,
2179
(revisiontree.RevisionTree, DirStateRevisionTree)):
2181
# the source revid must be in the target dirstate
2182
if not (source._revision_id == _mod_revision.NULL_REVISION or
2183
source._revision_id in target.get_parent_ids()):
2184
# TODO: what about ghosts? it may well need to
2185
# check for them explicitly.
2189
InterTree.register_optimiser(InterDirStateTree)
2192
class Converter3to4(object):
2193
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2196
self.target_format = WorkingTreeFormat4()
2198
def convert(self, tree):
2199
# lock the control files not the tree, so that we dont get tree
2200
# on-unlock behaviours, and so that noone else diddles with the
2201
# tree during upgrade.
2202
tree._control_files.lock_write()
2204
tree.read_working_inventory()
2205
self.create_dirstate_data(tree)
2206
self.update_format(tree)
2207
self.remove_xml_files(tree)
2209
tree._control_files.unlock()
2211
def create_dirstate_data(self, tree):
2212
"""Create the dirstate based data for tree."""
2213
local_path = tree.bzrdir.get_workingtree_transport(None
2214
).local_abspath('dirstate')
2215
state = dirstate.DirState.from_tree(tree, local_path)
2219
def remove_xml_files(self, tree):
2220
"""Remove the oldformat 3 data."""
2221
transport = tree.bzrdir.get_workingtree_transport(None)
2222
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2223
'pending-merges', 'stat-cache']:
2225
transport.delete(path)
2226
except errors.NoSuchFile:
2227
# some files are optional - just deal.
2230
def update_format(self, tree):
2231
"""Change the format marker."""
2232
tree._transport.put_bytes('format',
2233
self.target_format.get_format_string(),
2234
mode=tree.bzrdir._get_file_mode())
2237
class Converter4to5(object):
2238
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2241
self.target_format = WorkingTreeFormat5()
2243
def convert(self, tree):
2244
# lock the control files not the tree, so that we don't get tree
2245
# on-unlock behaviours, and so that no-one else diddles with the
2246
# tree during upgrade.
2247
tree._control_files.lock_write()
2249
self.update_format(tree)
2251
tree._control_files.unlock()
2253
def update_format(self, tree):
2254
"""Change the format marker."""
2255
tree._transport.put_bytes('format',
2256
self.target_format.get_format_string(),
2257
mode=tree.bzrdir._get_file_mode())
2260
class Converter4or5to6(object):
2261
"""Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2264
self.target_format = WorkingTreeFormat6()
2266
def convert(self, tree):
2267
# lock the control files not the tree, so that we don't get tree
2268
# on-unlock behaviours, and so that no-one else diddles with the
2269
# tree during upgrade.
2270
tree._control_files.lock_write()
2272
self.init_custom_control_files(tree)
2273
self.update_format(tree)
2275
tree._control_files.unlock()
2277
def init_custom_control_files(self, tree):
2278
"""Initialize custom control files."""
2279
tree._transport.put_bytes('views', '',
2280
mode=tree.bzrdir._get_file_mode())
2282
def update_format(self, tree):
2283
"""Change the format marker."""
2284
tree._transport.put_bytes('format',
2285
self.target_format.get_format_string(),
2286
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
