1
# Copyright (C) 2005, 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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(), """
31
from bisect import bisect_left
33
from copy import deepcopy
45
conflicts as _mod_conflicts,
55
revision as _mod_revision,
66
from bzrlib.transport import get_transport
70
from bzrlib import symbol_versioning
71
from bzrlib.decorators import needs_read_lock, needs_write_lock
72
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
73
import bzrlib.mutabletree
74
from bzrlib.mutabletree import needs_tree_write_lock
75
from bzrlib.osutils import (
85
from bzrlib.trace import mutter, note
86
from bzrlib.transport.local import LocalTransport
87
from bzrlib.tree import InterTree
88
from bzrlib.progress import DummyProgress, ProgressPhase
89
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
90
from bzrlib.rio import RioReader, rio_file, Stanza
91
from bzrlib.symbol_versioning import (deprecated_passed,
96
from bzrlib.tree import Tree
97
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
100
class DirStateWorkingTree(WorkingTree3):
101
def __init__(self, basedir,
106
"""Construct a WorkingTree for basedir.
108
If the branch is not supplied, it is opened automatically.
109
If the branch is supplied, it must be the branch for this basedir.
110
(branch.base is not cross checked, because for remote branches that
111
would be meaningless).
113
self._format = _format
114
self.bzrdir = _bzrdir
115
basedir = safe_unicode(basedir)
116
mutter("opening working tree %r", basedir)
117
self._branch = branch
118
self.basedir = realpath(basedir)
119
# if branch is at our basedir and is a format 6 or less
120
# assume all other formats have their own control files.
121
self._control_files = _control_files
122
self._transport = self._control_files._transport
125
# during a read or write lock these objects are set, and are
126
# None the rest of the time.
127
self._dirstate = None
128
self._inventory = None
130
self._setup_directory_is_tree_reference()
131
self._detect_case_handling()
132
self._rules_searcher = None
133
self.views = self._make_views()
134
#--- allow tests to select the dirstate iter_changes implementation
135
self._iter_changes = dirstate._process_entry
137
@needs_tree_write_lock
138
def _add(self, files, ids, kinds):
139
"""See MutableTree._add."""
140
state = self.current_dirstate()
141
for f, file_id, kind in zip(files, ids, kinds):
144
# special case tree root handling.
145
if f == '' and self.path2id(f) == ROOT_ID:
146
state.set_path_id('', generate_ids.gen_file_id(f))
149
file_id = generate_ids.gen_file_id(f)
150
# deliberately add the file with no cached stat or sha1
151
# - on the first access it will be gathered, and we can
152
# always change this once tests are all passing.
153
state.add(f, file_id, kind, None, '')
154
self._make_dirty(reset_inventory=True)
156
def _make_dirty(self, reset_inventory):
157
"""Make the tree state dirty.
159
:param reset_inventory: True if the cached inventory should be removed
160
(presuming there is one).
163
if reset_inventory and self._inventory is not None:
164
self._inventory = None
166
@needs_tree_write_lock
167
def add_reference(self, sub_tree):
168
# use standard implementation, which calls back to self._add
170
# So we don't store the reference_revision in the working dirstate,
171
# it's just recorded at the moment of commit.
172
self._add_reference(sub_tree)
174
def break_lock(self):
175
"""Break a lock if one is present from another instance.
177
Uses the ui factory to ask for confirmation if the lock may be from
180
This will probe the repository for its lock as well.
182
# if the dirstate is locked by an active process, reject the break lock
185
if self._dirstate is None:
189
state = self._current_dirstate()
190
if state._lock_token is not None:
191
# we already have it locked. sheese, cant break our own lock.
192
raise errors.LockActive(self.basedir)
195
# try for a write lock - need permission to get one anyhow
198
except errors.LockContention:
199
# oslocks fail when a process is still live: fail.
200
# TODO: get the locked lockdir info and give to the user to
201
# assist in debugging.
202
raise errors.LockActive(self.basedir)
207
self._dirstate = None
208
self._control_files.break_lock()
209
self.branch.break_lock()
211
def _comparison_data(self, entry, path):
212
kind, executable, stat_value = \
213
WorkingTree3._comparison_data(self, entry, path)
214
# it looks like a plain directory, but it's really a reference -- see
216
if (self._repo_supports_tree_reference and
217
kind == 'directory' and
218
self._directory_is_tree_reference(path)):
219
kind = 'tree-reference'
220
return kind, executable, stat_value
223
def commit(self, message=None, revprops=None, *args, **kwargs):
224
# mark the tree as dirty post commit - commit
225
# can change the current versioned list by doing deletes.
226
result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
227
self._make_dirty(reset_inventory=True)
230
def current_dirstate(self):
231
"""Return the current dirstate object.
233
This is not part of the tree interface and only exposed for ease of
236
:raises errors.NotWriteLocked: when not in a lock.
238
self._must_be_locked()
239
return self._current_dirstate()
241
def _current_dirstate(self):
242
"""Internal function that does not check lock status.
244
This is needed for break_lock which also needs the dirstate.
246
if self._dirstate is not None:
247
return self._dirstate
248
local_path = self.bzrdir.get_workingtree_transport(None
249
).local_abspath('dirstate')
250
self._dirstate = dirstate.DirState.on_file(local_path)
251
return self._dirstate
253
def filter_unversioned_files(self, paths):
254
"""Filter out paths that are versioned.
256
:return: set of paths.
258
# TODO: make a generic multi-bisect routine roughly that should list
259
# the paths, then process one half at a time recursively, and feed the
260
# results of each bisect in further still
261
paths = sorted(paths)
263
state = self.current_dirstate()
264
# TODO we want a paths_to_dirblocks helper I think
266
dirname, basename = os.path.split(path.encode('utf8'))
267
_, _, _, path_is_versioned = state._get_block_entry_index(
268
dirname, basename, 0)
269
if not path_is_versioned:
274
"""Write all cached data to disk."""
275
if self._control_files._lock_mode != 'w':
276
raise errors.NotWriteLocked(self)
277
self.current_dirstate().save()
278
self._inventory = None
281
@needs_tree_write_lock
282
def _gather_kinds(self, files, kinds):
283
"""See MutableTree._gather_kinds."""
284
for pos, f in enumerate(files):
285
if kinds[pos] is None:
286
kinds[pos] = self._kind(f)
288
def _generate_inventory(self):
289
"""Create and set self.inventory from the dirstate object.
291
This is relatively expensive: we have to walk the entire dirstate.
292
Ideally we would not, and can deprecate this function.
294
#: uncomment to trap on inventory requests.
295
# import pdb;pdb.set_trace()
296
state = self.current_dirstate()
297
state._read_dirblocks_if_needed()
298
root_key, current_entry = self._get_entry(path='')
299
current_id = root_key[2]
300
if not (current_entry[0][0] == 'd'): # directory
301
raise AssertionError(current_entry)
302
inv = Inventory(root_id=current_id)
303
# Turn some things into local variables
304
minikind_to_kind = dirstate.DirState._minikind_to_kind
305
factory = entry_factory
306
utf8_decode = cache_utf8._utf8_decode
308
# we could do this straight out of the dirstate; it might be fast
309
# and should be profiled - RBC 20070216
310
parent_ies = {'' : inv.root}
311
for block in state._dirblocks[1:]: # skip the root
314
parent_ie = parent_ies[dirname]
316
# all the paths in this block are not versioned in this tree
318
for key, entry in block[1]:
319
minikind, link_or_sha1, size, executable, stat = entry[0]
320
if minikind in ('a', 'r'): # absent, relocated
321
# a parent tree only entry
324
name_unicode = utf8_decode(name)[0]
326
kind = minikind_to_kind[minikind]
327
inv_entry = factory[kind](file_id, name_unicode,
330
# This is only needed on win32, where this is the only way
331
# we know the executable bit.
332
inv_entry.executable = executable
333
# not strictly needed: working tree
334
#inv_entry.text_size = size
335
#inv_entry.text_sha1 = sha1
336
elif kind == 'directory':
337
# add this entry to the parent map.
338
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
339
elif kind == 'tree-reference':
340
if not self._repo_supports_tree_reference:
341
raise AssertionError(
343
"doesn't support tree references "
344
"required by entry %r"
346
inv_entry.reference_revision = link_or_sha1 or None
347
elif kind != 'symlink':
348
raise AssertionError("unknown kind %r" % kind)
349
# These checks cost us around 40ms on a 55k entry tree
350
if file_id in inv_byid:
351
raise AssertionError('file_id %s already in'
352
' inventory as %s' % (file_id, inv_byid[file_id]))
353
if name_unicode in parent_ie.children:
354
raise AssertionError('name %r already in parent'
356
inv_byid[file_id] = inv_entry
357
parent_ie.children[name_unicode] = inv_entry
358
self._inventory = inv
360
def _get_entry(self, file_id=None, path=None):
361
"""Get the dirstate row for file_id or path.
363
If either file_id or path is supplied, it is used as the key to lookup.
364
If both are supplied, the fastest lookup is used, and an error is
365
raised if they do not both point at the same row.
367
:param file_id: An optional unicode file_id to be looked up.
368
:param path: An optional unicode path to be looked up.
369
:return: The dirstate row tuple for path/file_id, or (None, None)
371
if file_id is None and path is None:
372
raise errors.BzrError('must supply file_id or path')
373
state = self.current_dirstate()
375
path = path.encode('utf8')
376
return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
378
def get_file_sha1(self, file_id, path=None, stat_value=None):
379
# check file id is valid unconditionally.
380
entry = self._get_entry(file_id=file_id, path=path)
382
raise errors.NoSuchId(self, file_id)
384
path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
386
file_abspath = self.abspath(path)
387
state = self.current_dirstate()
388
if stat_value is None:
390
stat_value = os.lstat(file_abspath)
392
if e.errno == errno.ENOENT:
396
link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
397
stat_value=stat_value)
398
if entry[1][0][0] == 'f':
399
if link_or_sha1 is None:
400
file_obj, statvalue = self.get_file_with_stat(file_id, path)
402
sha1 = osutils.sha_file(file_obj)
405
self._observed_sha1(file_id, path, (sha1, statvalue))
411
def _get_inventory(self):
412
"""Get the inventory for the tree. This is only valid within a lock."""
413
if 'evil' in debug.debug_flags:
414
trace.mutter_callsite(2,
415
"accessing .inventory forces a size of tree translation.")
416
if self._inventory is not None:
417
return self._inventory
418
self._must_be_locked()
419
self._generate_inventory()
420
return self._inventory
422
inventory = property(_get_inventory,
423
doc="Inventory of this Tree")
426
def get_parent_ids(self):
427
"""See Tree.get_parent_ids.
429
This implementation requests the ids list from the dirstate file.
431
return self.current_dirstate().get_parent_ids()
433
def get_reference_revision(self, file_id, path=None):
434
# referenced tree's revision is whatever's currently there
435
return self.get_nested_tree(file_id, path).last_revision()
437
def get_nested_tree(self, file_id, path=None):
439
path = self.id2path(file_id)
440
# else: check file_id is at path?
441
return WorkingTree.open(self.abspath(path))
444
def get_root_id(self):
445
"""Return the id of this trees root"""
446
return self._get_entry(path='')[0][2]
448
def has_id(self, file_id):
449
state = self.current_dirstate()
450
row, parents = self._get_entry(file_id=file_id)
453
return osutils.lexists(pathjoin(
454
self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
457
def id2path(self, file_id):
458
"Convert a file-id to a path."
459
state = self.current_dirstate()
460
entry = self._get_entry(file_id=file_id)
461
if entry == (None, None):
462
raise errors.NoSuchId(tree=self, file_id=file_id)
463
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
464
return path_utf8.decode('utf8')
466
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
467
entry = self._get_entry(path=path)
468
if entry == (None, None):
469
return False # Missing entries are not executable
470
return entry[1][0][3] # Executable?
472
if not osutils.supports_executable():
473
def is_executable(self, file_id, path=None):
474
"""Test if a file is executable or not.
476
Note: The caller is expected to take a read-lock before calling this.
478
entry = self._get_entry(file_id=file_id, path=path)
479
if entry == (None, None):
481
return entry[1][0][3]
483
_is_executable_from_path_and_stat = \
484
_is_executable_from_path_and_stat_from_basis
486
def is_executable(self, file_id, path=None):
487
"""Test if a file is executable or not.
489
Note: The caller is expected to take a read-lock before calling this.
491
self._must_be_locked()
493
path = self.id2path(file_id)
494
mode = os.lstat(self.abspath(path)).st_mode
495
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
497
def all_file_ids(self):
498
"""See Tree.iter_all_file_ids"""
499
self._must_be_locked()
501
for key, tree_details in self.current_dirstate()._iter_entries():
502
if tree_details[0][0] in ('a', 'r'): # relocated
509
"""Iterate through file_ids for this tree.
511
file_ids are in a WorkingTree if they are in the working inventory
512
and the working file exists.
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
519
path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
520
if osutils.lexists(path):
521
result.append(key[2])
524
def iter_references(self):
525
if not self._repo_supports_tree_reference:
526
# When the repo doesn't support references, we will have nothing to
529
for key, tree_details in self.current_dirstate()._iter_entries():
530
if tree_details[0][0] in ('a', 'r'): # absent, relocated
531
# not relevant to the working tree
534
# the root is not a reference.
536
relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
538
if self._kind(relpath) == 'tree-reference':
539
yield relpath, key[2]
540
except errors.NoSuchFile:
541
# path is missing on disk.
544
def _observed_sha1(self, file_id, path, (sha1, statvalue)):
545
"""See MutableTree._observed_sha1."""
546
state = self.current_dirstate()
547
entry = self._get_entry(file_id=file_id, path=path)
548
state._observed_sha1(entry, sha1, statvalue)
550
def kind(self, file_id):
551
"""Return the kind of a file.
553
This is always the actual kind that's on disk, regardless of what it
556
Note: The caller is expected to take a read-lock before calling this.
558
relpath = self.id2path(file_id)
560
raise AssertionError(
561
"path for id {%s} is None!" % file_id)
562
return self._kind(relpath)
564
def _kind(self, relpath):
565
abspath = self.abspath(relpath)
566
kind = file_kind(abspath)
567
if (self._repo_supports_tree_reference and
568
kind == 'directory' and
569
self._directory_is_tree_reference(relpath)):
570
kind = 'tree-reference'
574
def _last_revision(self):
575
"""See Mutable.last_revision."""
576
parent_ids = self.current_dirstate().get_parent_ids()
580
return _mod_revision.NULL_REVISION
583
"""See Branch.lock_read, and WorkingTree.unlock."""
584
self.branch.lock_read()
586
self._control_files.lock_read()
588
state = self.current_dirstate()
589
if not state._lock_token:
591
# set our support for tree references from the repository in
593
self._repo_supports_tree_reference = getattr(
594
self.branch.repository._format, "supports_tree_reference",
597
self._control_files.unlock()
603
def _lock_self_write(self):
604
"""This should be called after the branch is locked."""
606
self._control_files.lock_write()
608
state = self.current_dirstate()
609
if not state._lock_token:
611
# set our support for tree references from the repository in
613
self._repo_supports_tree_reference = getattr(
614
self.branch.repository._format, "supports_tree_reference",
617
self._control_files.unlock()
623
def lock_tree_write(self):
624
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
625
self.branch.lock_read()
626
self._lock_self_write()
628
def lock_write(self):
629
"""See MutableTree.lock_write, and WorkingTree.unlock."""
630
self.branch.lock_write()
631
self._lock_self_write()
633
@needs_tree_write_lock
634
def move(self, from_paths, to_dir, after=False):
635
"""See WorkingTree.move()."""
639
state = self.current_dirstate()
640
if isinstance(from_paths, basestring):
642
to_dir_utf8 = to_dir.encode('utf8')
643
to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
644
id_index = state._get_id_index()
645
# check destination directory
646
# get the details for it
647
to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
648
state._get_block_entry_index(to_entry_dirname, to_basename, 0)
649
if not entry_present:
650
raise errors.BzrMoveFailedError('', to_dir,
651
errors.NotVersionedError(to_dir))
652
to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
653
# get a handle on the block itself.
654
to_block_index = state._ensure_block(
655
to_entry_block_index, to_entry_entry_index, to_dir_utf8)
656
to_block = state._dirblocks[to_block_index]
657
to_abs = self.abspath(to_dir)
658
if not isdir(to_abs):
659
raise errors.BzrMoveFailedError('',to_dir,
660
errors.NotADirectory(to_abs))
662
if to_entry[1][0][0] != 'd':
663
raise errors.BzrMoveFailedError('',to_dir,
664
errors.NotADirectory(to_abs))
666
if self._inventory is not None:
667
update_inventory = True
669
to_dir_id = to_entry[0][2]
670
to_dir_ie = inv[to_dir_id]
672
update_inventory = False
675
def move_one(old_entry, from_path_utf8, minikind, executable,
676
fingerprint, packed_stat, size,
677
to_block, to_key, to_path_utf8):
678
state._make_absent(old_entry)
679
from_key = old_entry[0]
681
lambda:state.update_minimal(from_key,
683
executable=executable,
684
fingerprint=fingerprint,
685
packed_stat=packed_stat,
687
path_utf8=from_path_utf8))
688
state.update_minimal(to_key,
690
executable=executable,
691
fingerprint=fingerprint,
692
packed_stat=packed_stat,
694
path_utf8=to_path_utf8)
695
added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
696
new_entry = to_block[1][added_entry_index]
697
rollbacks.append(lambda:state._make_absent(new_entry))
699
for from_rel in from_paths:
700
# from_rel is 'pathinroot/foo/bar'
701
from_rel_utf8 = from_rel.encode('utf8')
702
from_dirname, from_tail = osutils.split(from_rel)
703
from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
704
from_entry = self._get_entry(path=from_rel)
705
if from_entry == (None, None):
706
raise errors.BzrMoveFailedError(from_rel,to_dir,
707
errors.NotVersionedError(path=str(from_rel)))
709
from_id = from_entry[0][2]
710
to_rel = pathjoin(to_dir, from_tail)
711
to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
712
item_to_entry = self._get_entry(path=to_rel)
713
if item_to_entry != (None, None):
714
raise errors.BzrMoveFailedError(from_rel, to_rel,
715
"Target is already versioned.")
717
if from_rel == to_rel:
718
raise errors.BzrMoveFailedError(from_rel, to_rel,
719
"Source and target are identical.")
721
from_missing = not self.has_filename(from_rel)
722
to_missing = not self.has_filename(to_rel)
729
raise errors.BzrMoveFailedError(from_rel, to_rel,
730
errors.NoSuchFile(path=to_rel,
731
extra="New file has not been created yet"))
733
# neither path exists
734
raise errors.BzrRenameFailedError(from_rel, to_rel,
735
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
737
if from_missing: # implicitly just update our path mapping
740
raise errors.RenameFailedFilesExist(from_rel, to_rel)
743
def rollback_rename():
744
"""A single rename has failed, roll it back."""
745
# roll back everything, even if we encounter trouble doing one
748
# TODO: at least log the other exceptions rather than just
749
# losing them mbp 20070307
751
for rollback in reversed(rollbacks):
755
exc_info = sys.exc_info()
757
raise exc_info[0], exc_info[1], exc_info[2]
759
# perform the disk move first - its the most likely failure point.
761
from_rel_abs = self.abspath(from_rel)
762
to_rel_abs = self.abspath(to_rel)
764
osutils.rename(from_rel_abs, to_rel_abs)
766
raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
767
rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
769
# perform the rename in the inventory next if needed: its easy
773
from_entry = inv[from_id]
774
current_parent = from_entry.parent_id
775
inv.rename(from_id, to_dir_id, from_tail)
777
lambda: inv.rename(from_id, current_parent, from_tail))
778
# finally do the rename in the dirstate, which is a little
779
# tricky to rollback, but least likely to need it.
780
old_block_index, old_entry_index, dir_present, file_present = \
781
state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
782
old_block = state._dirblocks[old_block_index][1]
783
old_entry = old_block[old_entry_index]
784
from_key, old_entry_details = old_entry
785
cur_details = old_entry_details[0]
787
to_key = ((to_block[0],) + from_key[1:3])
788
minikind = cur_details[0]
789
move_one(old_entry, from_path_utf8=from_rel_utf8,
791
executable=cur_details[3],
792
fingerprint=cur_details[1],
793
packed_stat=cur_details[4],
797
to_path_utf8=to_rel_utf8)
800
def update_dirblock(from_dir, to_key, to_dir_utf8):
801
"""Recursively update all entries in this dirblock."""
803
raise AssertionError("renaming root not supported")
804
from_key = (from_dir, '')
805
from_block_idx, present = \
806
state._find_block_index_from_key(from_key)
808
# This is the old record, if it isn't present, then
809
# there is theoretically nothing to update.
810
# (Unless it isn't present because of lazy loading,
811
# but we don't do that yet)
813
from_block = state._dirblocks[from_block_idx]
814
to_block_index, to_entry_index, _, _ = \
815
state._get_block_entry_index(to_key[0], to_key[1], 0)
816
to_block_index = state._ensure_block(
817
to_block_index, to_entry_index, to_dir_utf8)
818
to_block = state._dirblocks[to_block_index]
820
# Grab a copy since move_one may update the list.
821
for entry in from_block[1][:]:
822
if not (entry[0][0] == from_dir):
823
raise AssertionError()
824
cur_details = entry[1][0]
825
to_key = (to_dir_utf8, entry[0][1], entry[0][2])
826
from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
827
to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
828
minikind = cur_details[0]
830
# Deleted children of a renamed directory
831
# Do not need to be updated.
832
# Children that have been renamed out of this
833
# directory should also not be updated
835
move_one(entry, from_path_utf8=from_path_utf8,
837
executable=cur_details[3],
838
fingerprint=cur_details[1],
839
packed_stat=cur_details[4],
843
to_path_utf8=to_path_utf8)
845
# We need to move all the children of this
847
update_dirblock(from_path_utf8, to_key,
849
update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
853
result.append((from_rel, to_rel))
854
state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
855
self._make_dirty(reset_inventory=False)
859
def _must_be_locked(self):
860
if not self._control_files._lock_count:
861
raise errors.ObjectNotLocked(self)
864
"""Initialize the state in this tree to be a new tree."""
868
def path2id(self, path):
869
"""Return the id for path in this tree."""
870
path = path.strip('/')
871
entry = self._get_entry(path=path)
872
if entry == (None, None):
876
def paths2ids(self, paths, trees=[], require_versioned=True):
877
"""See Tree.paths2ids().
879
This specialisation fast-paths the case where all the trees are in the
884
parents = self.get_parent_ids()
886
if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
888
return super(DirStateWorkingTree, self).paths2ids(paths,
889
trees, require_versioned)
890
search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
891
# -- make all paths utf8 --
894
paths_utf8.add(path.encode('utf8'))
896
# -- paths is now a utf8 path set --
897
# -- get the state object and prepare it.
898
state = self.current_dirstate()
899
if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
900
and '' not in paths):
901
paths2ids = self._paths2ids_using_bisect
903
paths2ids = self._paths2ids_in_memory
904
return paths2ids(paths, search_indexes,
905
require_versioned=require_versioned)
907
def _paths2ids_in_memory(self, paths, search_indexes,
908
require_versioned=True):
909
state = self.current_dirstate()
910
state._read_dirblocks_if_needed()
911
def _entries_for_path(path):
912
"""Return a list with all the entries that match path for all ids.
914
dirname, basename = os.path.split(path)
915
key = (dirname, basename, '')
916
block_index, present = state._find_block_index_from_key(key)
918
# the block which should contain path is absent.
921
block = state._dirblocks[block_index][1]
922
entry_index, _ = state._find_entry_index(key, block)
923
# we may need to look at multiple entries at this path: walk while the paths match.
924
while (entry_index < len(block) and
925
block[entry_index][0][0:2] == key[0:2]):
926
result.append(block[entry_index])
929
if require_versioned:
930
# -- check all supplied paths are versioned in a search tree. --
933
path_entries = _entries_for_path(path)
935
# this specified path is not present at all: error
936
all_versioned = False
938
found_versioned = False
939
# for each id at this path
940
for entry in path_entries:
942
for index in search_indexes:
943
if entry[1][index][0] != 'a': # absent
944
found_versioned = True
945
# all good: found a versioned cell
947
if not found_versioned:
948
# none of the indexes was not 'absent' at all ids for this
950
all_versioned = False
952
if not all_versioned:
953
raise errors.PathsNotVersionedError(paths)
954
# -- remove redundancy in supplied paths to prevent over-scanning --
955
search_paths = osutils.minimum_path_selection(paths)
957
# for all search_indexs in each path at or under each element of
958
# search_paths, if the detail is relocated: add the id, and add the
959
# relocated path as one to search if its not searched already. If the
960
# detail is not relocated, add the id.
961
searched_paths = set()
963
def _process_entry(entry):
964
"""Look at search_indexes within entry.
966
If a specific tree's details are relocated, add the relocation
967
target to search_paths if not searched already. If it is absent, do
968
nothing. Otherwise add the id to found_ids.
970
for index in search_indexes:
971
if entry[1][index][0] == 'r': # relocated
972
if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
973
search_paths.add(entry[1][index][1])
974
elif entry[1][index][0] != 'a': # absent
975
found_ids.add(entry[0][2])
977
current_root = search_paths.pop()
978
searched_paths.add(current_root)
979
# process the entries for this containing directory: the rest will be
980
# found by their parents recursively.
981
root_entries = _entries_for_path(current_root)
983
# this specified path is not present at all, skip it.
985
for entry in root_entries:
986
_process_entry(entry)
987
initial_key = (current_root, '', '')
988
block_index, _ = state._find_block_index_from_key(initial_key)
989
while (block_index < len(state._dirblocks) and
990
osutils.is_inside(current_root, state._dirblocks[block_index][0])):
991
for entry in state._dirblocks[block_index][1]:
992
_process_entry(entry)
996
def _paths2ids_using_bisect(self, paths, search_indexes,
997
require_versioned=True):
998
state = self.current_dirstate()
1001
split_paths = sorted(osutils.split(p) for p in paths)
1002
found = state._bisect_recursive(split_paths)
1004
if require_versioned:
1005
found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1006
for dir_name in split_paths:
1007
if dir_name not in found_dir_names:
1008
raise errors.PathsNotVersionedError(paths)
1010
for dir_name_id, trees_info in found.iteritems():
1011
for index in search_indexes:
1012
if trees_info[index][0] not in ('r', 'a'):
1013
found_ids.add(dir_name_id[2])
1016
def read_working_inventory(self):
1017
"""Read the working inventory.
1019
This is a meaningless operation for dirstate, but we obey it anyhow.
1021
return self.inventory
1024
def revision_tree(self, revision_id):
1025
"""See Tree.revision_tree.
1027
WorkingTree4 supplies revision_trees for any basis tree.
1029
dirstate = self.current_dirstate()
1030
parent_ids = dirstate.get_parent_ids()
1031
if revision_id not in parent_ids:
1032
raise errors.NoSuchRevisionInTree(self, revision_id)
1033
if revision_id in dirstate.get_ghosts():
1034
raise errors.NoSuchRevisionInTree(self, revision_id)
1035
return DirStateRevisionTree(dirstate, revision_id,
1036
self.branch.repository)
1038
@needs_tree_write_lock
1039
def set_last_revision(self, new_revision):
1040
"""Change the last revision in the working tree."""
1041
parents = self.get_parent_ids()
1042
if new_revision in (NULL_REVISION, None):
1043
if len(parents) >= 2:
1044
raise AssertionError(
1045
"setting the last parent to none with a pending merge is "
1047
self.set_parent_ids([])
1049
self.set_parent_ids([new_revision] + parents[1:],
1050
allow_leftmost_as_ghost=True)
1052
@needs_tree_write_lock
1053
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1054
"""Set the parent ids to revision_ids.
1056
See also set_parent_trees. This api will try to retrieve the tree data
1057
for each element of revision_ids from the trees repository. If you have
1058
tree data already available, it is more efficient to use
1059
set_parent_trees rather than set_parent_ids. set_parent_ids is however
1060
an easier API to use.
1062
:param revision_ids: The revision_ids to set as the parent ids of this
1063
working tree. Any of these may be ghosts.
1066
for revision_id in revision_ids:
1068
revtree = self.branch.repository.revision_tree(revision_id)
1069
# TODO: jam 20070213 KnitVersionedFile raises
1070
# RevisionNotPresent rather than NoSuchRevision if a
1071
# given revision_id is not present. Should Repository be
1072
# catching it and re-raising NoSuchRevision?
1073
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1075
trees.append((revision_id, revtree))
1076
self.set_parent_trees(trees,
1077
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1079
@needs_tree_write_lock
1080
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1081
"""Set the parents of the working tree.
1083
:param parents_list: A list of (revision_id, tree) tuples.
1084
If tree is None, then that element is treated as an unreachable
1085
parent tree - i.e. a ghost.
1087
dirstate = self.current_dirstate()
1088
if len(parents_list) > 0:
1089
if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1090
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1094
parent_ids = [rev_id for rev_id, tree in parents_list]
1095
graph = self.branch.repository.get_graph()
1096
heads = graph.heads(parent_ids)
1097
accepted_revisions = set()
1099
# convert absent trees to the null tree, which we convert back to
1100
# missing on access.
1101
for rev_id, tree in parents_list:
1102
if len(accepted_revisions) > 0:
1103
# we always accept the first tree
1104
if rev_id in accepted_revisions or rev_id not in heads:
1105
# We have already included either this tree, or its
1106
# descendent, so we skip it.
1108
_mod_revision.check_not_reserved_id(rev_id)
1109
if tree is not None:
1110
real_trees.append((rev_id, tree))
1112
real_trees.append((rev_id,
1113
self.branch.repository.revision_tree(
1114
_mod_revision.NULL_REVISION)))
1115
ghosts.append(rev_id)
1116
accepted_revisions.add(rev_id)
1117
dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1118
self._make_dirty(reset_inventory=False)
1120
def _set_root_id(self, file_id):
1121
"""See WorkingTree.set_root_id."""
1122
state = self.current_dirstate()
1123
state.set_path_id('', file_id)
1124
if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1125
self._make_dirty(reset_inventory=True)
1127
def _sha_from_stat(self, path, stat_result):
1128
"""Get a sha digest from the tree's stat cache.
1130
The default implementation assumes no stat cache is present.
1132
:param path: The path.
1133
:param stat_result: The stat result being looked up.
1135
return self.current_dirstate().sha1_from_stat(path, stat_result)
1138
def supports_tree_reference(self):
1139
return self._repo_supports_tree_reference
1142
"""Unlock in format 4 trees needs to write the entire dirstate."""
1143
# do non-implementation specific cleanup
1146
if self._control_files._lock_count == 1:
1147
# eventually we should do signature checking during read locks for
1149
if self._control_files._lock_mode == 'w':
1152
if self._dirstate is not None:
1153
# This is a no-op if there are no modifications.
1154
self._dirstate.save()
1155
self._dirstate.unlock()
1156
# TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1157
# point. Instead, it could check if the header has been
1158
# modified when it is locked, and if not, it can hang on to
1159
# the data it has in memory.
1160
self._dirstate = None
1161
self._inventory = None
1162
# reverse order of locking.
1164
return self._control_files.unlock()
1166
self.branch.unlock()
1168
@needs_tree_write_lock
1169
def unversion(self, file_ids):
1170
"""Remove the file ids in file_ids from the current versioned set.
1172
When a file_id is unversioned, all of its children are automatically
1175
:param file_ids: The file ids to stop versioning.
1176
:raises: NoSuchId if any fileid is not currently versioned.
1180
state = self.current_dirstate()
1181
state._read_dirblocks_if_needed()
1182
ids_to_unversion = set(file_ids)
1183
paths_to_unversion = set()
1185
# check if the root is to be unversioned, if so, assert for now.
1186
# walk the state marking unversioned things as absent.
1187
# if there are any un-unversioned ids at the end, raise
1188
for key, details in state._dirblocks[0][1]:
1189
if (details[0][0] not in ('a', 'r') and # absent or relocated
1190
key[2] in ids_to_unversion):
1191
# I haven't written the code to unversion / yet - it should be
1193
raise errors.BzrError('Unversioning the / is not currently supported')
1195
while block_index < len(state._dirblocks):
1196
# process one directory at a time.
1197
block = state._dirblocks[block_index]
1198
# first check: is the path one to remove - it or its children
1199
delete_block = False
1200
for path in paths_to_unversion:
1201
if (block[0].startswith(path) and
1202
(len(block[0]) == len(path) or
1203
block[0][len(path)] == '/')):
1204
# this entire block should be deleted - its the block for a
1205
# path to unversion; or the child of one
1208
# TODO: trim paths_to_unversion as we pass by paths
1210
# this block is to be deleted: process it.
1211
# TODO: we can special case the no-parents case and
1212
# just forget the whole block.
1214
while entry_index < len(block[1]):
1215
# Mark this file id as having been removed
1216
entry = block[1][entry_index]
1217
ids_to_unversion.discard(entry[0][2])
1218
if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1220
or not state._make_absent(entry)):
1222
# go to the next block. (At the moment we dont delete empty
1227
while entry_index < len(block[1]):
1228
entry = block[1][entry_index]
1229
if (entry[1][0][0] in ('a', 'r') or # absent, relocated
1230
# ^ some parent row.
1231
entry[0][2] not in ids_to_unversion):
1232
# ^ not an id to unversion
1235
if entry[1][0][0] == 'd':
1236
paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
1237
if not state._make_absent(entry):
1239
# we have unversioned this id
1240
ids_to_unversion.remove(entry[0][2])
1242
if ids_to_unversion:
1243
raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1244
self._make_dirty(reset_inventory=False)
1245
# have to change the legacy inventory too.
1246
if self._inventory is not None:
1247
for file_id in file_ids:
1248
self._inventory.remove_recursive_id(file_id)
1250
@needs_tree_write_lock
1251
def rename_one(self, from_rel, to_rel, after=False):
1252
"""See WorkingTree.rename_one"""
1254
WorkingTree.rename_one(self, from_rel, to_rel, after)
1256
@needs_tree_write_lock
1257
def apply_inventory_delta(self, changes):
1258
"""See MutableTree.apply_inventory_delta"""
1259
state = self.current_dirstate()
1260
state.update_by_delta(changes)
1261
self._make_dirty(reset_inventory=True)
1263
def update_basis_by_delta(self, new_revid, delta):
1264
"""See MutableTree.update_basis_by_delta."""
1265
if self.last_revision() == new_revid:
1266
raise AssertionError()
1267
self.current_dirstate().update_basis_by_delta(delta, new_revid)
1270
def _validate(self):
1271
self._dirstate._validate()
1273
@needs_tree_write_lock
1274
def _write_inventory(self, inv):
1275
"""Write inventory as the current inventory."""
1277
raise AssertionError("attempting to write an inventory when the "
1278
"dirstate is dirty will lose pending changes")
1279
self.current_dirstate().set_state_from_inventory(inv)
1280
self._make_dirty(reset_inventory=False)
1281
if self._inventory is not None:
1282
self._inventory = inv
1286
class WorkingTree4(DirStateWorkingTree):
1287
"""This is the Format 4 working tree.
1289
This differs from WorkingTree3 by:
1290
- Having a consolidated internal dirstate, stored in a
1291
randomly-accessible sorted file on disk.
1292
- Not having a regular inventory attribute. One can be synthesized
1293
on demand but this is expensive and should be avoided.
1295
This is new in bzr 0.15.
1299
class WorkingTree5(DirStateWorkingTree):
1300
"""This is the Format 5 working tree.
1302
This differs from WorkingTree4 by:
1303
- Supporting content filtering.
1304
- Supporting a current view that may mask the set of files in a tree
1305
impacted by most user operations.
1307
This is new in bzr 1.11.
1310
def _make_views(self):
1311
return views.PathBasedViews(self)
1314
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1315
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1316
accelerator_tree=None, hardlink=False):
1317
"""See WorkingTreeFormat.initialize().
1319
:param revision_id: allows creating a working tree at a different
1320
revision than the branch is at.
1321
:param accelerator_tree: A tree which can be used for retrieving file
1322
contents more quickly than the revision tree, i.e. a workingtree.
1323
The revision tree will be used for cases where accelerator_tree's
1324
content is different.
1325
:param hardlink: If true, hard-link files from accelerator_tree,
1328
These trees get an initial random root id, if their repository supports
1329
rich root data, TREE_ROOT otherwise.
1331
if not isinstance(a_bzrdir.transport, LocalTransport):
1332
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1333
transport = a_bzrdir.get_workingtree_transport(self)
1334
control_files = self._open_control_files(a_bzrdir)
1335
control_files.create_lock()
1336
control_files.lock_write()
1337
transport.put_bytes('format', self.get_format_string(),
1338
mode=a_bzrdir._get_file_mode())
1339
if from_branch is not None:
1340
branch = from_branch
1342
branch = a_bzrdir.open_branch()
1343
if revision_id is None:
1344
revision_id = branch.last_revision()
1345
local_path = transport.local_abspath('dirstate')
1346
# write out new dirstate (must exist when we create the tree)
1347
state = dirstate.DirState.initialize(local_path)
1350
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1354
_control_files=control_files)
1356
wt.lock_tree_write()
1358
self._init_custom_control_files(wt)
1359
if revision_id in (None, NULL_REVISION):
1360
if branch.repository.supports_rich_root():
1361
wt._set_root_id(generate_ids.gen_root_id())
1363
wt._set_root_id(ROOT_ID)
1366
# frequently, we will get here due to branching. The accelerator
1367
# tree will be the tree from the branch, so the desired basis
1368
# tree will often be a parent of the accelerator tree.
1369
if accelerator_tree is not None:
1371
basis = accelerator_tree.revision_tree(revision_id)
1372
except errors.NoSuchRevision:
1375
basis = branch.repository.revision_tree(revision_id)
1376
if revision_id == NULL_REVISION:
1379
parents_list = [(revision_id, basis)]
1382
wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1384
# if the basis has a root id we have to use that; otherwise we
1385
# use a new random one
1386
basis_root_id = basis.get_root_id()
1387
if basis_root_id is not None:
1388
wt._set_root_id(basis_root_id)
1390
# delta_from_tree is safe even for DirStateRevisionTrees,
1391
# because wt4.apply_inventory_delta does not mutate the input
1392
# inventory entries.
1393
transform.build_tree(basis, wt, accelerator_tree,
1394
hardlink=hardlink, delta_from_tree=True)
1398
control_files.unlock()
1402
def _init_custom_control_files(self, wt):
1403
"""Subclasses with custom control files should override this method.
1405
The working tree and control files are locked for writing when this
1408
:param wt: the WorkingTree object
1411
def _open(self, a_bzrdir, control_files):
1412
"""Open the tree itself.
1414
:param a_bzrdir: the dir for the tree.
1415
:param control_files: the control files for the tree.
1417
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1418
branch=a_bzrdir.open_branch(),
1421
_control_files=control_files)
1423
def __get_matchingbzrdir(self):
1424
# please test against something that will let us do tree references
1425
return bzrdir.format_registry.make_bzrdir(
1426
'dirstate-with-subtree')
1428
_matchingbzrdir = property(__get_matchingbzrdir)
1431
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1432
"""The first consolidated dirstate working tree format.
1435
- exists within a metadir controlling .bzr
1436
- includes an explicit version marker for the workingtree control
1437
files, separate from the BzrDir format
1438
- modifies the hash cache format
1439
- is new in bzr 0.15
1440
- uses a LockDir to guard access to it.
1443
upgrade_recommended = False
1445
_tree_class = WorkingTree4
1447
def get_format_string(self):
1448
"""See WorkingTreeFormat.get_format_string()."""
1449
return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1451
def get_format_description(self):
1452
"""See WorkingTreeFormat.get_format_description()."""
1453
return "Working tree format 4"
1456
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1457
"""WorkingTree format supporting views.
1460
upgrade_recommended = False
1462
_tree_class = WorkingTree5
1464
def get_format_string(self):
1465
"""See WorkingTreeFormat.get_format_string()."""
1466
return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1468
def get_format_description(self):
1469
"""See WorkingTreeFormat.get_format_description()."""
1470
return "Working tree format 5"
1472
def _init_custom_control_files(self, wt):
1473
"""Subclasses with custom control files should override this method."""
1474
wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1476
def supports_content_filtering(self):
1479
def supports_views(self):
1483
class DirStateRevisionTree(Tree):
1484
"""A revision tree pulling the inventory from a dirstate."""
1486
def __init__(self, dirstate, revision_id, repository):
1487
self._dirstate = dirstate
1488
self._revision_id = revision_id
1489
self._repository = repository
1490
self._inventory = None
1492
self._dirstate_locked = False
1493
self._repo_supports_tree_reference = getattr(
1494
repository._format, "supports_tree_reference",
1498
return "<%s of %s in %s>" % \
1499
(self.__class__.__name__, self._revision_id, self._dirstate)
1501
def annotate_iter(self, file_id,
1502
default_revision=_mod_revision.CURRENT_REVISION):
1503
"""See Tree.annotate_iter"""
1504
text_key = (file_id, self.inventory[file_id].revision)
1505
annotations = self._repository.texts.annotate(text_key)
1506
return [(key[-1], line) for (key, line) in annotations]
1508
def _get_ancestors(self, default_revision):
1509
return set(self._repository.get_ancestry(self._revision_id,
1511
def _comparison_data(self, entry, path):
1512
"""See Tree._comparison_data."""
1514
return None, False, None
1515
# trust the entry as RevisionTree does, but this may not be
1516
# sensible: the entry might not have come from us?
1517
return entry.kind, entry.executable, None
1519
def _file_size(self, entry, stat_value):
1520
return entry.text_size
1522
def filter_unversioned_files(self, paths):
1523
"""Filter out paths that are not versioned.
1525
:return: set of paths.
1527
pred = self.has_filename
1528
return set((p for p in paths if not pred(p)))
1530
def get_root_id(self):
1531
return self.path2id('')
1533
def id2path(self, file_id):
1534
"Convert a file-id to a path."
1535
entry = self._get_entry(file_id=file_id)
1536
if entry == (None, None):
1537
raise errors.NoSuchId(tree=self, file_id=file_id)
1538
path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1539
return path_utf8.decode('utf8')
1541
def iter_references(self):
1542
if not self._repo_supports_tree_reference:
1543
# When the repo doesn't support references, we will have nothing to
1546
# Otherwise, fall back to the default implementation
1547
return super(DirStateRevisionTree, self).iter_references()
1549
def _get_parent_index(self):
1550
"""Return the index in the dirstate referenced by this tree."""
1551
return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1553
def _get_entry(self, file_id=None, path=None):
1554
"""Get the dirstate row for file_id or path.
1556
If either file_id or path is supplied, it is used as the key to lookup.
1557
If both are supplied, the fastest lookup is used, and an error is
1558
raised if they do not both point at the same row.
1560
:param file_id: An optional unicode file_id to be looked up.
1561
:param path: An optional unicode path to be looked up.
1562
:return: The dirstate row tuple for path/file_id, or (None, None)
1564
if file_id is None and path is None:
1565
raise errors.BzrError('must supply file_id or path')
1566
if path is not None:
1567
path = path.encode('utf8')
1568
parent_index = self._get_parent_index()
1569
return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1571
def _generate_inventory(self):
1572
"""Create and set self.inventory from the dirstate object.
1574
(So this is only called the first time the inventory is requested for
1575
this tree; it then remains in memory until it's out of date.)
1577
This is relatively expensive: we have to walk the entire dirstate.
1579
if not self._locked:
1580
raise AssertionError(
1581
'cannot generate inventory of an unlocked '
1582
'dirstate revision tree')
1583
# separate call for profiling - makes it clear where the costs are.
1584
self._dirstate._read_dirblocks_if_needed()
1585
if self._revision_id not in self._dirstate.get_parent_ids():
1586
raise AssertionError(
1587
'parent %s has disappeared from %s' % (
1588
self._revision_id, self._dirstate.get_parent_ids()))
1589
parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1590
# This is identical now to the WorkingTree _generate_inventory except
1591
# for the tree index use.
1592
root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1593
current_id = root_key[2]
1594
if current_entry[parent_index][0] != 'd':
1595
raise AssertionError()
1596
inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1597
inv.root.revision = current_entry[parent_index][4]
1598
# Turn some things into local variables
1599
minikind_to_kind = dirstate.DirState._minikind_to_kind
1600
factory = entry_factory
1601
utf8_decode = cache_utf8._utf8_decode
1602
inv_byid = inv._byid
1603
# we could do this straight out of the dirstate; it might be fast
1604
# and should be profiled - RBC 20070216
1605
parent_ies = {'' : inv.root}
1606
for block in self._dirstate._dirblocks[1:]: #skip root
1609
parent_ie = parent_ies[dirname]
1611
# all the paths in this block are not versioned in this tree
1613
for key, entry in block[1]:
1614
minikind, fingerprint, size, executable, revid = entry[parent_index]
1615
if minikind in ('a', 'r'): # absent, relocated
1619
name_unicode = utf8_decode(name)[0]
1621
kind = minikind_to_kind[minikind]
1622
inv_entry = factory[kind](file_id, name_unicode,
1624
inv_entry.revision = revid
1626
inv_entry.executable = executable
1627
inv_entry.text_size = size
1628
inv_entry.text_sha1 = fingerprint
1629
elif kind == 'directory':
1630
parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1631
elif kind == 'symlink':
1632
inv_entry.executable = False
1633
inv_entry.text_size = None
1634
inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1635
elif kind == 'tree-reference':
1636
inv_entry.reference_revision = fingerprint or None
1638
raise AssertionError("cannot convert entry %r into an InventoryEntry"
1640
# These checks cost us around 40ms on a 55k entry tree
1641
if file_id in inv_byid:
1642
raise AssertionError('file_id %s already in'
1643
' inventory as %s' % (file_id, inv_byid[file_id]))
1644
if name_unicode in parent_ie.children:
1645
raise AssertionError('name %r already in parent'
1647
inv_byid[file_id] = inv_entry
1648
parent_ie.children[name_unicode] = inv_entry
1649
self._inventory = inv
1651
def get_file_mtime(self, file_id, path=None):
1652
"""Return the modification time for this record.
1654
We return the timestamp of the last-changed revision.
1656
# Make sure the file exists
1657
entry = self._get_entry(file_id, path=path)
1658
if entry == (None, None): # do we raise?
1660
parent_index = self._get_parent_index()
1661
last_changed_revision = entry[1][parent_index][4]
1662
return self._repository.get_revision(last_changed_revision).timestamp
1664
def get_file_sha1(self, file_id, path=None, stat_value=None):
1665
entry = self._get_entry(file_id=file_id, path=path)
1666
parent_index = self._get_parent_index()
1667
parent_details = entry[1][parent_index]
1668
if parent_details[0] == 'f':
1669
return parent_details[1]
1672
def get_file(self, file_id, path=None):
1673
return StringIO(self.get_file_text(file_id))
1675
def get_file_size(self, file_id):
1676
"""See Tree.get_file_size"""
1677
return self.inventory[file_id].text_size
1679
def get_file_text(self, file_id, path=None):
1680
return list(self.iter_files_bytes([(file_id, None)]))[0][1]
1682
def get_reference_revision(self, file_id, path=None):
1683
return self.inventory[file_id].reference_revision
1685
def iter_files_bytes(self, desired_files):
1686
"""See Tree.iter_files_bytes.
1688
This version is implemented on top of Repository.iter_files_bytes"""
1689
parent_index = self._get_parent_index()
1690
repo_desired_files = []
1691
for file_id, identifier in desired_files:
1692
entry = self._get_entry(file_id)
1693
if entry == (None, None):
1694
raise errors.NoSuchId(self, file_id)
1695
repo_desired_files.append((file_id, entry[1][parent_index][4],
1697
return self._repository.iter_files_bytes(repo_desired_files)
1699
def get_symlink_target(self, file_id):
1700
entry = self._get_entry(file_id=file_id)
1701
parent_index = self._get_parent_index()
1702
if entry[1][parent_index][0] != 'l':
1705
# At present, none of the tree implementations supports non-ascii
1706
# symlink targets. So we will just assume that the dirstate path is
1708
return entry[1][parent_index][1]
1710
def get_revision_id(self):
1711
"""Return the revision id for this tree."""
1712
return self._revision_id
1714
def _get_inventory(self):
1715
if self._inventory is not None:
1716
return self._inventory
1717
self._must_be_locked()
1718
self._generate_inventory()
1719
return self._inventory
1721
inventory = property(_get_inventory,
1722
doc="Inventory of this Tree")
1724
def get_parent_ids(self):
1725
"""The parents of a tree in the dirstate are not cached."""
1726
return self._repository.get_revision(self._revision_id).parent_ids
1728
def has_filename(self, filename):
1729
return bool(self.path2id(filename))
1731
def kind(self, file_id):
1732
entry = self._get_entry(file_id=file_id)[1]
1734
raise errors.NoSuchId(tree=self, file_id=file_id)
1735
return dirstate.DirState._minikind_to_kind[entry[1][0]]
1737
def stored_kind(self, file_id):
1738
"""See Tree.stored_kind"""
1739
return self.kind(file_id)
1741
def path_content_summary(self, path):
1742
"""See Tree.path_content_summary."""
1743
id = self.inventory.path2id(path)
1745
return ('missing', None, None, None)
1746
entry = self._inventory[id]
1749
return (kind, entry.text_size, entry.executable, entry.text_sha1)
1750
elif kind == 'symlink':
1751
return (kind, None, None, entry.symlink_target)
1753
return (kind, None, None, None)
1755
def is_executable(self, file_id, path=None):
1756
ie = self.inventory[file_id]
1757
if ie.kind != "file":
1759
return ie.executable
1761
def list_files(self, include_root=False):
1762
# We use a standard implementation, because DirStateRevisionTree is
1763
# dealing with one of the parents of the current state
1764
inv = self._get_inventory()
1765
entries = inv.iter_entries()
1766
if self.inventory.root is not None and not include_root:
1768
for path, entry in entries:
1769
yield path, 'V', entry.kind, entry.file_id, entry
1771
def lock_read(self):
1772
"""Lock the tree for a set of operations."""
1773
if not self._locked:
1774
self._repository.lock_read()
1775
if self._dirstate._lock_token is None:
1776
self._dirstate.lock_read()
1777
self._dirstate_locked = True
1780
def _must_be_locked(self):
1781
if not self._locked:
1782
raise errors.ObjectNotLocked(self)
1785
def path2id(self, path):
1786
"""Return the id for path in this tree."""
1787
# lookup by path: faster than splitting and walking the ivnentory.
1788
entry = self._get_entry(path=path)
1789
if entry == (None, None):
1794
"""Unlock, freeing any cache memory used during the lock."""
1795
# outside of a lock, the inventory is suspect: release it.
1797
if not self._locked:
1798
self._inventory = None
1800
if self._dirstate_locked:
1801
self._dirstate.unlock()
1802
self._dirstate_locked = False
1803
self._repository.unlock()
1806
def supports_tree_reference(self):
1807
return self._repo_supports_tree_reference
1809
def walkdirs(self, prefix=""):
1810
# TODO: jam 20070215 This is the lazy way by using the RevisionTree
1811
# implementation based on an inventory.
1812
# This should be cleaned up to use the much faster Dirstate code
1813
# So for now, we just build up the parent inventory, and extract
1814
# it the same way RevisionTree does.
1815
_directory = 'directory'
1816
inv = self._get_inventory()
1817
top_id = inv.path2id(prefix)
1821
pending = [(prefix, top_id)]
1824
relpath, file_id = pending.pop()
1825
# 0 - relpath, 1- file-id
1827
relroot = relpath + '/'
1830
# FIXME: stash the node in pending
1831
entry = inv[file_id]
1832
for name, child in entry.sorted_children():
1833
toppath = relroot + name
1834
dirblock.append((toppath, name, child.kind, None,
1835
child.file_id, child.kind
1837
yield (relpath, entry.file_id), dirblock
1838
# push the user specified dirs from dirblock
1839
for dir in reversed(dirblock):
1840
if dir[2] == _directory:
1841
pending.append((dir[0], dir[4]))
1844
class InterDirStateTree(InterTree):
1845
"""Fast path optimiser for changes_from with dirstate trees.
1847
This is used only when both trees are in the dirstate working file, and
1848
the source is any parent within the dirstate, and the destination is
1849
the current working tree of the same dirstate.
1851
# this could be generalized to allow comparisons between any trees in the
1852
# dirstate, and possibly between trees stored in different dirstates.
1854
def __init__(self, source, target):
1855
super(InterDirStateTree, self).__init__(source, target)
1856
if not InterDirStateTree.is_compatible(source, target):
1857
raise Exception, "invalid source %r and target %r" % (source, target)
1860
def make_source_parent_tree(source, target):
1861
"""Change the source tree into a parent of the target."""
1862
revid = source.commit('record tree')
1863
target.branch.repository.fetch(source.branch.repository, revid)
1864
target.set_parent_ids([revid])
1865
return target.basis_tree(), target
1868
def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1869
result = klass.make_source_parent_tree(source, target)
1870
result[1]._iter_changes = dirstate.ProcessEntryPython
1874
def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
1875
from bzrlib.tests.test__dirstate_helpers import \
1876
CompiledDirstateHelpersFeature
1877
if not CompiledDirstateHelpersFeature.available():
1878
from bzrlib.tests import UnavailableFeature
1879
raise UnavailableFeature(CompiledDirstateHelpersFeature)
1880
from bzrlib._dirstate_helpers_c import ProcessEntryC
1881
result = klass.make_source_parent_tree(source, target)
1882
result[1]._iter_changes = ProcessEntryC
1885
_matching_from_tree_format = WorkingTreeFormat4()
1886
_matching_to_tree_format = WorkingTreeFormat4()
1889
def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1890
# This method shouldn't be called, because we have python and C
1891
# specific flavours.
1892
raise NotImplementedError
1894
def iter_changes(self, include_unchanged=False,
1895
specific_files=None, pb=None, extra_trees=[],
1896
require_versioned=True, want_unversioned=False):
1897
"""Return the changes from source to target.
1899
:return: An iterator that yields tuples. See InterTree.iter_changes
1901
:param specific_files: An optional list of file paths to restrict the
1902
comparison to. When mapping filenames to ids, all matches in all
1903
trees (including optional extra_trees) are used, and all children of
1904
matched directories are included.
1905
:param include_unchanged: An optional boolean requesting the inclusion of
1906
unchanged entries in the result.
1907
:param extra_trees: An optional list of additional trees to use when
1908
mapping the contents of specific_files (paths) to file_ids.
1909
:param require_versioned: If True, all files in specific_files must be
1910
versioned in one of source, target, extra_trees or
1911
PathsNotVersionedError is raised.
1912
:param want_unversioned: Should unversioned files be returned in the
1913
output. An unversioned file is defined as one with (False, False)
1914
for the versioned pair.
1916
# NB: show_status depends on being able to pass in non-versioned files
1917
# and report them as unknown
1918
# TODO: handle extra trees in the dirstate.
1919
if (extra_trees or specific_files == []):
1920
# we can't fast-path these cases (yet)
1921
return super(InterDirStateTree, self).iter_changes(
1922
include_unchanged, specific_files, pb, extra_trees,
1923
require_versioned, want_unversioned=want_unversioned)
1924
parent_ids = self.target.get_parent_ids()
1925
if not (self.source._revision_id in parent_ids
1926
or self.source._revision_id == NULL_REVISION):
1927
raise AssertionError(
1928
"revision {%s} is not stored in {%s}, but %s "
1929
"can only be used for trees stored in the dirstate"
1930
% (self.source._revision_id, self.target, self.iter_changes))
1932
if self.source._revision_id == NULL_REVISION:
1934
indices = (target_index,)
1936
if not (self.source._revision_id in parent_ids):
1937
raise AssertionError(
1938
"Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1939
self.source._revision_id, parent_ids))
1940
source_index = 1 + parent_ids.index(self.source._revision_id)
1941
indices = (source_index, target_index)
1942
# -- make all specific_files utf8 --
1944
specific_files_utf8 = set()
1945
for path in specific_files:
1946
# Note, if there are many specific files, using cache_utf8
1947
# would be good here.
1948
specific_files_utf8.add(path.encode('utf8'))
1949
specific_files = specific_files_utf8
1951
specific_files = set([''])
1952
# -- specific_files is now a utf8 path set --
1953
search_specific_files = set()
1954
# -- get the state object and prepare it.
1955
state = self.target.current_dirstate()
1956
state._read_dirblocks_if_needed()
1957
if require_versioned:
1958
# -- check all supplied paths are versioned in a search tree. --
1959
all_versioned = True
1960
for path in specific_files:
1961
path_entries = state._entries_for_path(path)
1962
if not path_entries:
1963
# this specified path is not present at all: error
1964
all_versioned = False
1966
found_versioned = False
1967
# for each id at this path
1968
for entry in path_entries:
1970
for index in indices:
1971
if entry[1][index][0] != 'a': # absent
1972
found_versioned = True
1973
# all good: found a versioned cell
1975
if not found_versioned:
1976
# none of the indexes was not 'absent' at all ids for this
1978
all_versioned = False
1980
if not all_versioned:
1981
raise errors.PathsNotVersionedError(specific_files)
1982
# -- remove redundancy in supplied specific_files to prevent over-scanning --
1983
for path in specific_files:
1984
other_specific_files = specific_files.difference(set([path]))
1985
if not osutils.is_inside_any(other_specific_files, path):
1986
# this is a top level path, we must check it.
1987
search_specific_files.add(path)
1989
use_filesystem_for_exec = (sys.platform != 'win32')
1990
iter_changes = self.target._iter_changes(include_unchanged,
1991
use_filesystem_for_exec, search_specific_files, state,
1992
source_index, target_index, want_unversioned, self.target)
1993
return iter_changes.iter_changes()
1996
def is_compatible(source, target):
1997
# the target must be a dirstate working tree
1998
if not isinstance(target, DirStateWorkingTree):
2000
# the source must be a revtree or dirstate rev tree.
2001
if not isinstance(source,
2002
(revisiontree.RevisionTree, DirStateRevisionTree)):
2004
# the source revid must be in the target dirstate
2005
if not (source._revision_id == NULL_REVISION or
2006
source._revision_id in target.get_parent_ids()):
2007
# TODO: what about ghosts? it may well need to
2008
# check for them explicitly.
2012
InterTree.register_optimiser(InterDirStateTree)
2015
class Converter3to4(object):
2016
"""Perform an in-place upgrade of format 3 to format 4 trees."""
2019
self.target_format = WorkingTreeFormat4()
2021
def convert(self, tree):
2022
# lock the control files not the tree, so that we dont get tree
2023
# on-unlock behaviours, and so that noone else diddles with the
2024
# tree during upgrade.
2025
tree._control_files.lock_write()
2027
tree.read_working_inventory()
2028
self.create_dirstate_data(tree)
2029
self.update_format(tree)
2030
self.remove_xml_files(tree)
2032
tree._control_files.unlock()
2034
def create_dirstate_data(self, tree):
2035
"""Create the dirstate based data for tree."""
2036
local_path = tree.bzrdir.get_workingtree_transport(None
2037
).local_abspath('dirstate')
2038
state = dirstate.DirState.from_tree(tree, local_path)
2042
def remove_xml_files(self, tree):
2043
"""Remove the oldformat 3 data."""
2044
transport = tree.bzrdir.get_workingtree_transport(None)
2045
for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2046
'pending-merges', 'stat-cache']:
2048
transport.delete(path)
2049
except errors.NoSuchFile:
2050
# some files are optional - just deal.
2053
def update_format(self, tree):
2054
"""Change the format marker."""
2055
tree._transport.put_bytes('format',
2056
self.target_format.get_format_string(),
2057
mode=tree.bzrdir._get_file_mode())
2060
class Converter4to5(object):
2061
"""Perform an in-place upgrade of format 4 to format 5 trees."""
2064
self.target_format = WorkingTreeFormat5()
2066
def convert(self, tree):
2067
# lock the control files not the tree, so that we don't get tree
2068
# on-unlock behaviours, and so that no-one else diddles with the
2069
# tree during upgrade.
2070
tree._control_files.lock_write()
2072
self.init_custom_control_files(tree)
2073
self.update_format(tree)
2075
tree._control_files.unlock()
2077
def init_custom_control_files(self, tree):
2078
"""Initialize custom control files."""
2079
tree._transport.put_bytes('views', '',
2080
mode=tree.bzrdir._get_file_mode())
2082
def update_format(self, tree):
2083
"""Change the format marker."""
2084
tree._transport.put_bytes('format',
2085
self.target_format.get_format_string(),
2086
mode=tree.bzrdir._get_file_mode())
added
removed
bzrlib/workingtree_4.py
