1
# Copyright (C) 2005, 2006, 2007 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
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
82
from bzrlib.transport import get_transport
84
from bzrlib.workingtree_4 import WorkingTreeFormat4
87
from bzrlib import symbol_versioning
88
from bzrlib.decorators import needs_read_lock, needs_write_lock
89
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
90
from bzrlib.lockable_files import LockableFiles, TransportLock
91
from bzrlib.lockdir import LockDir
92
import bzrlib.mutabletree
93
from bzrlib.mutabletree import needs_tree_write_lock
94
from bzrlib import osutils
95
from bzrlib.osutils import (
107
from bzrlib.trace import mutter, note
108
from bzrlib.transport.local import LocalTransport
109
from bzrlib.progress import DummyProgress, ProgressPhase
110
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
111
from bzrlib.rio import RioReader, rio_file, Stanza
112
from bzrlib.symbol_versioning import (deprecated_passed,
115
DEPRECATED_PARAMETER,
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
122
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
125
class TreeEntry(object):
126
"""An entry that implements the minimum interface used by commands.
128
This needs further inspection, it may be better to have
129
InventoryEntries without ids - though that seems wrong. For now,
130
this is a parallel hierarchy to InventoryEntry, and needs to become
131
one of several things: decorates to that hierarchy, children of, or
133
Another note is that these objects are currently only used when there is
134
no InventoryEntry available - i.e. for unversioned objects.
135
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
138
def __eq__(self, other):
139
# yes, this us ugly, TODO: best practice __eq__ style.
140
return (isinstance(other, TreeEntry)
141
and other.__class__ == self.__class__)
143
def kind_character(self):
147
class TreeDirectory(TreeEntry):
148
"""See TreeEntry. This is a directory in a working tree."""
150
def __eq__(self, other):
151
return (isinstance(other, TreeDirectory)
152
and other.__class__ == self.__class__)
154
def kind_character(self):
158
class TreeFile(TreeEntry):
159
"""See TreeEntry. This is a regular file in a working tree."""
161
def __eq__(self, other):
162
return (isinstance(other, TreeFile)
163
and other.__class__ == self.__class__)
165
def kind_character(self):
169
class TreeLink(TreeEntry):
170
"""See TreeEntry. This is a symlink in a working tree."""
172
def __eq__(self, other):
173
return (isinstance(other, TreeLink)
174
and other.__class__ == self.__class__)
176
def kind_character(self):
180
class WorkingTree(bzrlib.mutabletree.MutableTree):
181
"""Working copy tree.
183
The inventory is held in the `Branch` working-inventory, and the
184
files are in a directory on disk.
186
It is possible for a `WorkingTree` to have a filename which is
187
not listed in the Inventory and vice versa.
190
# override this to set the strategy for storing views
191
def _make_views(self):
192
return views.DisabledViews(self)
194
def __init__(self, basedir='.',
195
branch=DEPRECATED_PARAMETER,
201
"""Construct a WorkingTree instance. This is not a public API.
203
:param branch: A branch to override probing for the branch.
205
self._format = _format
206
self.bzrdir = _bzrdir
208
raise errors.BzrError("Please use bzrdir.open_workingtree or "
209
"WorkingTree.open() to obtain a WorkingTree.")
210
basedir = safe_unicode(basedir)
211
mutter("opening working tree %r", basedir)
212
if deprecated_passed(branch):
213
self._branch = branch
215
self._branch = self.bzrdir.open_branch()
216
self.basedir = realpath(basedir)
217
# if branch is at our basedir and is a format 6 or less
218
if isinstance(self._format, WorkingTreeFormat2):
219
# share control object
220
self._control_files = self.branch.control_files
222
# assume all other formats have their own control files.
223
self._control_files = _control_files
224
self._transport = self._control_files._transport
225
# update the whole cache up front and write to disk if anything changed;
226
# in the future we might want to do this more selectively
227
# two possible ways offer themselves : in self._unlock, write the cache
228
# if needed, or, when the cache sees a change, append it to the hash
229
# cache file, and have the parser take the most recent entry for a
231
wt_trans = self.bzrdir.get_workingtree_transport(None)
232
cache_filename = wt_trans.local_abspath('stat-cache')
233
self._hashcache = hashcache.HashCache(basedir, cache_filename,
234
self.bzrdir._get_file_mode())
237
# is this scan needed ? it makes things kinda slow.
244
if _inventory is None:
245
# This will be acquired on lock_read() or lock_write()
246
self._inventory_is_modified = False
247
self._inventory = None
249
# the caller of __init__ has provided an inventory,
250
# we assume they know what they are doing - as its only
251
# the Format factory and creation methods that are
252
# permitted to do this.
253
self._set_inventory(_inventory, dirty=False)
254
self._detect_case_handling()
255
self._rules_searcher = None
256
self.views = self._make_views()
258
def _detect_case_handling(self):
259
wt_trans = self.bzrdir.get_workingtree_transport(None)
261
wt_trans.stat("FoRMaT")
262
except errors.NoSuchFile:
263
self.case_sensitive = True
265
self.case_sensitive = False
267
self._setup_directory_is_tree_reference()
270
fget=lambda self: self._branch,
271
doc="""The branch this WorkingTree is connected to.
273
This cannot be set - it is reflective of the actual disk structure
274
the working tree has been constructed from.
277
def break_lock(self):
278
"""Break a lock if one is present from another instance.
280
Uses the ui factory to ask for confirmation if the lock may be from
283
This will probe the repository for its lock as well.
285
self._control_files.break_lock()
286
self.branch.break_lock()
288
def requires_rich_root(self):
289
return self._format.requires_rich_root
291
def supports_tree_reference(self):
294
def supports_views(self):
295
return self.views.supports_views()
297
def _set_inventory(self, inv, dirty):
298
"""Set the internal cached inventory.
300
:param inv: The inventory to set.
301
:param dirty: A boolean indicating whether the inventory is the same
302
logical inventory as whats on disk. If True the inventory is not
303
the same and should be written to disk or data will be lost, if
304
False then the inventory is the same as that on disk and any
305
serialisation would be unneeded overhead.
307
self._inventory = inv
308
self._inventory_is_modified = dirty
311
def open(path=None, _unsupported=False):
312
"""Open an existing working tree at path.
316
path = os.path.getcwdu()
317
control = bzrdir.BzrDir.open(path, _unsupported)
318
return control.open_workingtree(_unsupported)
321
def open_containing(path=None):
322
"""Open an existing working tree which has its root about path.
324
This probes for a working tree at path and searches upwards from there.
326
Basically we keep looking up until we find the control directory or
327
run into /. If there isn't one, raises NotBranchError.
328
TODO: give this a new exception.
329
If there is one, it is returned, along with the unused portion of path.
331
:return: The WorkingTree that contains 'path', and the rest of path
334
path = osutils.getcwd()
335
control, relpath = bzrdir.BzrDir.open_containing(path)
337
return control.open_workingtree(), relpath
340
def open_downlevel(path=None):
341
"""Open an unsupported working tree.
343
Only intended for advanced situations like upgrading part of a bzrdir.
345
return WorkingTree.open(path, _unsupported=True)
348
def find_trees(location):
349
def list_current(transport):
350
return [d for d in transport.list_dir('') if d != '.bzr']
351
def evaluate(bzrdir):
353
tree = bzrdir.open_workingtree()
354
except errors.NoWorkingTree:
358
transport = get_transport(location)
359
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
360
list_current=list_current)
361
return [t for t in iterator if t is not None]
363
# should be deprecated - this is slow and in any case treating them as a
364
# container is (we now know) bad style -- mbp 20070302
365
## @deprecated_method(zero_fifteen)
367
"""Iterate through file_ids for this tree.
369
file_ids are in a WorkingTree if they are in the working inventory
370
and the working file exists.
372
inv = self._inventory
373
for path, ie in inv.iter_entries():
374
if osutils.lexists(self.abspath(path)):
377
def all_file_ids(self):
378
"""See Tree.iter_all_file_ids"""
379
return set(self.inventory)
382
return "<%s of %s>" % (self.__class__.__name__,
383
getattr(self, 'basedir', None))
385
def abspath(self, filename):
386
return pathjoin(self.basedir, filename)
388
def basis_tree(self):
389
"""Return RevisionTree for the current last revision.
391
If the left most parent is a ghost then the returned tree will be an
392
empty tree - one obtained by calling repository.revision_tree(None).
395
revision_id = self.get_parent_ids()[0]
397
# no parents, return an empty revision tree.
398
# in the future this should return the tree for
399
# 'empty:' - the implicit root empty tree.
400
return self.branch.repository.revision_tree(None)
402
return self.revision_tree(revision_id)
403
except errors.NoSuchRevision:
405
# No cached copy available, retrieve from the repository.
406
# FIXME? RBC 20060403 should we cache the inventory locally
409
return self.branch.repository.revision_tree(revision_id)
410
except (errors.RevisionNotPresent, errors.NoSuchRevision):
411
# the basis tree *may* be a ghost or a low level error may have
412
# occured. If the revision is present, its a problem, if its not
414
if self.branch.repository.has_revision(revision_id):
416
# the basis tree is a ghost so return an empty tree.
417
return self.branch.repository.revision_tree(None)
420
self._flush_ignore_list_cache()
422
def relpath(self, path):
423
"""Return the local path portion from a given path.
425
The path may be absolute or relative. If its a relative path it is
426
interpreted relative to the python current working directory.
428
return osutils.relpath(self.basedir, path)
430
def has_filename(self, filename):
431
return osutils.lexists(self.abspath(filename))
433
def get_file(self, file_id, path=None):
435
path = self.id2path(file_id)
436
return self.get_file_byname(path)
438
def get_file_text(self, file_id):
439
return self.get_file(file_id).read()
441
def get_file_byname(self, filename):
442
return file(self.abspath(filename), 'rb')
445
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
446
"""See Tree.annotate_iter
448
This implementation will use the basis tree implementation if possible.
449
Lines not in the basis are attributed to CURRENT_REVISION
451
If there are pending merges, lines added by those merges will be
452
incorrectly attributed to CURRENT_REVISION (but after committing, the
453
attribution will be correct).
455
basis = self.basis_tree()
458
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
459
require_versioned=True).next()
460
changed_content, kind = changes[2], changes[6]
461
if not changed_content:
462
return basis.annotate_iter(file_id)
466
if kind[0] != 'file':
469
old_lines = list(basis.annotate_iter(file_id))
471
for tree in self.branch.repository.revision_trees(
472
self.get_parent_ids()[1:]):
473
if file_id not in tree:
475
old.append(list(tree.annotate_iter(file_id)))
476
return annotate.reannotate(old, self.get_file(file_id).readlines(),
481
def _get_ancestors(self, default_revision):
482
ancestors = set([default_revision])
483
for parent_id in self.get_parent_ids():
484
ancestors.update(self.branch.repository.get_ancestry(
485
parent_id, topo_sorted=False))
488
def get_parent_ids(self):
489
"""See Tree.get_parent_ids.
491
This implementation reads the pending merges list and last_revision
492
value and uses that to decide what the parents list should be.
494
last_rev = _mod_revision.ensure_null(self._last_revision())
495
if _mod_revision.NULL_REVISION == last_rev:
500
merges_file = self._transport.get('pending-merges')
501
except errors.NoSuchFile:
504
for l in merges_file.readlines():
505
revision_id = l.rstrip('\n')
506
parents.append(revision_id)
510
def get_root_id(self):
511
"""Return the id of this trees root"""
512
return self._inventory.root.file_id
514
def _get_store_filename(self, file_id):
515
## XXX: badly named; this is not in the store at all
516
return self.abspath(self.id2path(file_id))
519
def clone(self, to_bzrdir, revision_id=None):
520
"""Duplicate this working tree into to_bzr, including all state.
522
Specifically modified files are kept as modified, but
523
ignored and unknown files are discarded.
525
If you want to make a new line of development, see bzrdir.sprout()
528
If not None, the cloned tree will have its last revision set to
529
revision, and and difference between the source trees last revision
530
and this one merged in.
532
# assumes the target bzr dir format is compatible.
533
result = self._format.initialize(to_bzrdir)
534
self.copy_content_into(result, revision_id)
538
def copy_content_into(self, tree, revision_id=None):
539
"""Copy the current content and user files of this tree into tree."""
540
tree.set_root_id(self.get_root_id())
541
if revision_id is None:
542
merge.transform_tree(tree, self)
544
# TODO now merge from tree.last_revision to revision (to preserve
545
# user local changes)
546
merge.transform_tree(tree, self)
547
tree.set_parent_ids([revision_id])
549
def id2abspath(self, file_id):
550
return self.abspath(self.id2path(file_id))
552
def has_id(self, file_id):
553
# files that have been deleted are excluded
555
if not inv.has_id(file_id):
557
path = inv.id2path(file_id)
558
return osutils.lexists(self.abspath(path))
560
def has_or_had_id(self, file_id):
561
if file_id == self.inventory.root.file_id:
563
return self.inventory.has_id(file_id)
565
__contains__ = has_id
567
def get_file_size(self, file_id):
568
"""See Tree.get_file_size"""
570
return os.path.getsize(self.id2abspath(file_id))
572
if e.errno != errno.ENOENT:
578
def get_file_sha1(self, file_id, path=None, stat_value=None):
580
path = self._inventory.id2path(file_id)
581
return self._hashcache.get_sha1(path, stat_value)
583
def get_file_mtime(self, file_id, path=None):
585
path = self.inventory.id2path(file_id)
586
return os.lstat(self.abspath(path)).st_mtime
588
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
589
file_id = self.path2id(path)
590
return self._inventory[file_id].executable
592
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
593
mode = stat_result.st_mode
594
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
596
if not supports_executable():
597
def is_executable(self, file_id, path=None):
598
return self._inventory[file_id].executable
600
_is_executable_from_path_and_stat = \
601
_is_executable_from_path_and_stat_from_basis
603
def is_executable(self, file_id, path=None):
605
path = self.id2path(file_id)
606
mode = os.lstat(self.abspath(path)).st_mode
607
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
609
_is_executable_from_path_and_stat = \
610
_is_executable_from_path_and_stat_from_stat
612
@needs_tree_write_lock
613
def _add(self, files, ids, kinds):
614
"""See MutableTree._add."""
615
# TODO: Re-adding a file that is removed in the working copy
616
# should probably put it back with the previous ID.
617
# the read and write working inventory should not occur in this
618
# function - they should be part of lock_write and unlock.
620
for f, file_id, kind in zip(files, ids, kinds):
622
inv.add_path(f, kind=kind)
624
inv.add_path(f, kind=kind, file_id=file_id)
625
self._inventory_is_modified = True
627
@needs_tree_write_lock
628
def _gather_kinds(self, files, kinds):
629
"""See MutableTree._gather_kinds."""
630
for pos, f in enumerate(files):
631
if kinds[pos] is None:
632
fullpath = normpath(self.abspath(f))
634
kinds[pos] = file_kind(fullpath)
636
if e.errno == errno.ENOENT:
637
raise errors.NoSuchFile(fullpath)
640
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
641
"""Add revision_id as a parent.
643
This is equivalent to retrieving the current list of parent ids
644
and setting the list to its value plus revision_id.
646
:param revision_id: The revision id to add to the parent list. It may
647
be a ghost revision as long as its not the first parent to be added,
648
or the allow_leftmost_as_ghost parameter is set True.
649
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
651
parents = self.get_parent_ids() + [revision_id]
652
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
653
or allow_leftmost_as_ghost)
655
@needs_tree_write_lock
656
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
657
"""Add revision_id, tree tuple as a parent.
659
This is equivalent to retrieving the current list of parent trees
660
and setting the list to its value plus parent_tuple. See also
661
add_parent_tree_id - if you only have a parent id available it will be
662
simpler to use that api. If you have the parent already available, using
663
this api is preferred.
665
:param parent_tuple: The (revision id, tree) to add to the parent list.
666
If the revision_id is a ghost, pass None for the tree.
667
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
669
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
670
if len(parent_ids) > 1:
671
# the leftmost may have already been a ghost, preserve that if it
673
allow_leftmost_as_ghost = True
674
self.set_parent_ids(parent_ids,
675
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
677
@needs_tree_write_lock
678
def add_pending_merge(self, *revision_ids):
679
# TODO: Perhaps should check at this point that the
680
# history of the revision is actually present?
681
parents = self.get_parent_ids()
683
for rev_id in revision_ids:
684
if rev_id in parents:
686
parents.append(rev_id)
689
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
691
def path_content_summary(self, path, _lstat=os.lstat,
692
_mapper=osutils.file_kind_from_stat_mode):
693
"""See Tree.path_content_summary."""
694
abspath = self.abspath(path)
696
stat_result = _lstat(abspath)
698
if getattr(e, 'errno', None) == errno.ENOENT:
700
return ('missing', None, None, None)
701
# propagate other errors
703
kind = _mapper(stat_result.st_mode)
705
size = stat_result.st_size
706
# try for a stat cache lookup
707
executable = self._is_executable_from_path_and_stat(path, stat_result)
708
return (kind, size, executable, self._sha_from_stat(
710
elif kind == 'directory':
711
# perhaps it looks like a plain directory, but it's really a
713
if self._directory_is_tree_reference(path):
714
kind = 'tree-reference'
715
return kind, None, None, None
716
elif kind == 'symlink':
717
return ('symlink', None, None, os.readlink(abspath))
719
return (kind, None, None, None)
721
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
722
"""Common ghost checking functionality from set_parent_*.
724
This checks that the left hand-parent exists if there are any
727
if len(revision_ids) > 0:
728
leftmost_id = revision_ids[0]
729
if (not allow_leftmost_as_ghost and not
730
self.branch.repository.has_revision(leftmost_id)):
731
raise errors.GhostRevisionUnusableHere(leftmost_id)
733
def _set_merges_from_parent_ids(self, parent_ids):
734
merges = parent_ids[1:]
735
self._transport.put_bytes('pending-merges', '\n'.join(merges),
736
mode=self._control_files._file_mode)
738
def _filter_parent_ids_by_ancestry(self, revision_ids):
739
"""Check that all merged revisions are proper 'heads'.
741
This will always return the first revision_id, and any merged revisions
744
if len(revision_ids) == 0:
746
graph = self.branch.repository.get_graph()
747
heads = graph.heads(revision_ids)
748
new_revision_ids = revision_ids[:1]
749
for revision_id in revision_ids[1:]:
750
if revision_id in heads and revision_id not in new_revision_ids:
751
new_revision_ids.append(revision_id)
752
if new_revision_ids != revision_ids:
753
trace.mutter('requested to set revision_ids = %s,'
754
' but filtered to %s', revision_ids, new_revision_ids)
755
return new_revision_ids
757
@needs_tree_write_lock
758
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
759
"""Set the parent ids to revision_ids.
761
See also set_parent_trees. This api will try to retrieve the tree data
762
for each element of revision_ids from the trees repository. If you have
763
tree data already available, it is more efficient to use
764
set_parent_trees rather than set_parent_ids. set_parent_ids is however
765
an easier API to use.
767
:param revision_ids: The revision_ids to set as the parent ids of this
768
working tree. Any of these may be ghosts.
770
self._check_parents_for_ghosts(revision_ids,
771
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
772
for revision_id in revision_ids:
773
_mod_revision.check_not_reserved_id(revision_id)
775
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
777
if len(revision_ids) > 0:
778
self.set_last_revision(revision_ids[0])
780
self.set_last_revision(_mod_revision.NULL_REVISION)
782
self._set_merges_from_parent_ids(revision_ids)
784
@needs_tree_write_lock
785
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
786
"""See MutableTree.set_parent_trees."""
787
parent_ids = [rev for (rev, tree) in parents_list]
788
for revision_id in parent_ids:
789
_mod_revision.check_not_reserved_id(revision_id)
791
self._check_parents_for_ghosts(parent_ids,
792
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
794
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
796
if len(parent_ids) == 0:
797
leftmost_parent_id = _mod_revision.NULL_REVISION
798
leftmost_parent_tree = None
800
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
802
if self._change_last_revision(leftmost_parent_id):
803
if leftmost_parent_tree is None:
804
# If we don't have a tree, fall back to reading the
805
# parent tree from the repository.
806
self._cache_basis_inventory(leftmost_parent_id)
808
inv = leftmost_parent_tree.inventory
809
xml = self._create_basis_xml_from_inventory(
810
leftmost_parent_id, inv)
811
self._write_basis_inventory(xml)
812
self._set_merges_from_parent_ids(parent_ids)
814
@needs_tree_write_lock
815
def set_pending_merges(self, rev_list):
816
parents = self.get_parent_ids()
817
leftmost = parents[:1]
818
new_parents = leftmost + rev_list
819
self.set_parent_ids(new_parents)
821
@needs_tree_write_lock
822
def set_merge_modified(self, modified_hashes):
824
for file_id, hash in modified_hashes.iteritems():
825
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
826
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
828
def _sha_from_stat(self, path, stat_result):
829
"""Get a sha digest from the tree's stat cache.
831
The default implementation assumes no stat cache is present.
833
:param path: The path.
834
:param stat_result: The stat result being looked up.
838
def _put_rio(self, filename, stanzas, header):
839
self._must_be_locked()
840
my_file = rio_file(stanzas, header)
841
self._transport.put_file(filename, my_file,
842
mode=self._control_files._file_mode)
844
@needs_write_lock # because merge pulls data into the branch.
845
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
847
"""Merge from a branch into this working tree.
849
:param branch: The branch to merge from.
850
:param to_revision: If non-None, the merge will merge to to_revision,
851
but not beyond it. to_revision does not need to be in the history
852
of the branch when it is supplied. If None, to_revision defaults to
853
branch.last_revision().
855
from bzrlib.merge import Merger, Merge3Merger
856
pb = bzrlib.ui.ui_factory.nested_progress_bar()
858
merger = Merger(self.branch, this_tree=self, pb=pb)
859
merger.pp = ProgressPhase("Merge phase", 5, pb)
860
merger.pp.next_phase()
861
# check that there are no
863
merger.check_basis(check_clean=True, require_commits=False)
864
if to_revision is None:
865
to_revision = _mod_revision.ensure_null(branch.last_revision())
866
merger.other_rev_id = to_revision
867
if _mod_revision.is_null(merger.other_rev_id):
868
raise errors.NoCommits(branch)
869
self.branch.fetch(branch, last_revision=merger.other_rev_id)
870
merger.other_basis = merger.other_rev_id
871
merger.other_tree = self.branch.repository.revision_tree(
873
merger.other_branch = branch
874
merger.pp.next_phase()
875
if from_revision is None:
878
merger.set_base_revision(from_revision, branch)
879
if merger.base_rev_id == merger.other_rev_id:
880
raise errors.PointlessMerge
881
merger.backup_files = False
882
if merge_type is None:
883
merger.merge_type = Merge3Merger
885
merger.merge_type = merge_type
886
merger.set_interesting_files(None)
887
merger.show_base = False
888
merger.reprocess = False
889
conflicts = merger.do_merge()
896
def merge_modified(self):
897
"""Return a dictionary of files modified by a merge.
899
The list is initialized by WorkingTree.set_merge_modified, which is
900
typically called after we make some automatic updates to the tree
903
This returns a map of file_id->sha1, containing only files which are
904
still in the working inventory and have that text hash.
907
hashfile = self._transport.get('merge-hashes')
908
except errors.NoSuchFile:
912
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
913
raise errors.MergeModifiedFormatError()
914
except StopIteration:
915
raise errors.MergeModifiedFormatError()
916
for s in RioReader(hashfile):
917
# RioReader reads in Unicode, so convert file_ids back to utf8
918
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
919
if file_id not in self.inventory:
921
text_hash = s.get("hash")
922
if text_hash == self.get_file_sha1(file_id):
923
merge_hashes[file_id] = text_hash
927
def mkdir(self, path, file_id=None):
928
"""See MutableTree.mkdir()."""
930
file_id = generate_ids.gen_file_id(os.path.basename(path))
931
os.mkdir(self.abspath(path))
932
self.add(path, file_id, 'directory')
935
def get_symlink_target(self, file_id):
936
return os.readlink(self.id2abspath(file_id))
939
def subsume(self, other_tree):
940
def add_children(inventory, entry):
941
for child_entry in entry.children.values():
942
inventory._byid[child_entry.file_id] = child_entry
943
if child_entry.kind == 'directory':
944
add_children(inventory, child_entry)
945
if other_tree.get_root_id() == self.get_root_id():
946
raise errors.BadSubsumeSource(self, other_tree,
947
'Trees have the same root')
949
other_tree_path = self.relpath(other_tree.basedir)
950
except errors.PathNotChild:
951
raise errors.BadSubsumeSource(self, other_tree,
952
'Tree is not contained by the other')
953
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
954
if new_root_parent is None:
955
raise errors.BadSubsumeSource(self, other_tree,
956
'Parent directory is not versioned.')
957
# We need to ensure that the result of a fetch will have a
958
# versionedfile for the other_tree root, and only fetching into
959
# RepositoryKnit2 guarantees that.
960
if not self.branch.repository.supports_rich_root():
961
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
962
other_tree.lock_tree_write()
964
new_parents = other_tree.get_parent_ids()
965
other_root = other_tree.inventory.root
966
other_root.parent_id = new_root_parent
967
other_root.name = osutils.basename(other_tree_path)
968
self.inventory.add(other_root)
969
add_children(self.inventory, other_root)
970
self._write_inventory(self.inventory)
971
# normally we don't want to fetch whole repositories, but i think
972
# here we really do want to consolidate the whole thing.
973
for parent_id in other_tree.get_parent_ids():
974
self.branch.fetch(other_tree.branch, parent_id)
975
self.add_parent_tree_id(parent_id)
978
other_tree.bzrdir.retire_bzrdir()
980
def _setup_directory_is_tree_reference(self):
981
if self._branch.repository._format.supports_tree_reference:
982
self._directory_is_tree_reference = \
983
self._directory_may_be_tree_reference
985
self._directory_is_tree_reference = \
986
self._directory_is_never_tree_reference
988
def _directory_is_never_tree_reference(self, relpath):
991
def _directory_may_be_tree_reference(self, relpath):
992
# as a special case, if a directory contains control files then
993
# it's a tree reference, except that the root of the tree is not
994
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
995
# TODO: We could ask all the control formats whether they
996
# recognize this directory, but at the moment there's no cheap api
997
# to do that. Since we probably can only nest bzr checkouts and
998
# they always use this name it's ok for now. -- mbp 20060306
1000
# FIXME: There is an unhandled case here of a subdirectory
1001
# containing .bzr but not a branch; that will probably blow up
1002
# when you try to commit it. It might happen if there is a
1003
# checkout in a subdirectory. This can be avoided by not adding
1006
@needs_tree_write_lock
1007
def extract(self, file_id, format=None):
1008
"""Extract a subtree from this tree.
1010
A new branch will be created, relative to the path for this tree.
1014
segments = osutils.splitpath(path)
1015
transport = self.branch.bzrdir.root_transport
1016
for name in segments:
1017
transport = transport.clone(name)
1018
transport.ensure_base()
1021
sub_path = self.id2path(file_id)
1022
branch_transport = mkdirs(sub_path)
1024
format = self.bzrdir.cloning_metadir()
1025
branch_transport.ensure_base()
1026
branch_bzrdir = format.initialize_on_transport(branch_transport)
1028
repo = branch_bzrdir.find_repository()
1029
except errors.NoRepositoryPresent:
1030
repo = branch_bzrdir.create_repository()
1031
if not repo.supports_rich_root():
1032
raise errors.RootNotRich()
1033
new_branch = branch_bzrdir.create_branch()
1034
new_branch.pull(self.branch)
1035
for parent_id in self.get_parent_ids():
1036
new_branch.fetch(self.branch, parent_id)
1037
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1038
if tree_transport.base != branch_transport.base:
1039
tree_bzrdir = format.initialize_on_transport(tree_transport)
1040
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1042
tree_bzrdir = branch_bzrdir
1043
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1044
wt.set_parent_ids(self.get_parent_ids())
1045
my_inv = self.inventory
1046
child_inv = Inventory(root_id=None)
1047
new_root = my_inv[file_id]
1048
my_inv.remove_recursive_id(file_id)
1049
new_root.parent_id = None
1050
child_inv.add(new_root)
1051
self._write_inventory(my_inv)
1052
wt._write_inventory(child_inv)
1055
def _serialize(self, inventory, out_file):
1056
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1059
def _deserialize(selt, in_file):
1060
return xml5.serializer_v5.read_inventory(in_file)
1063
"""Write the in memory inventory to disk."""
1064
# TODO: Maybe this should only write on dirty ?
1065
if self._control_files._lock_mode != 'w':
1066
raise errors.NotWriteLocked(self)
1068
self._serialize(self._inventory, sio)
1070
self._transport.put_file('inventory', sio,
1071
mode=self._control_files._file_mode)
1072
self._inventory_is_modified = False
1074
def _kind(self, relpath):
1075
return osutils.file_kind(self.abspath(relpath))
1077
def list_files(self, include_root=False):
1078
"""Recursively list all files as (path, class, kind, id, entry).
1080
Lists, but does not descend into unversioned directories.
1082
This does not include files that have been deleted in this
1085
Skips the control directory.
1087
# list_files is an iterator, so @needs_read_lock doesn't work properly
1088
# with it. So callers should be careful to always read_lock the tree.
1089
if not self.is_locked():
1090
raise errors.ObjectNotLocked(self)
1092
inv = self.inventory
1093
if include_root is True:
1094
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1095
# Convert these into local objects to save lookup times
1096
pathjoin = osutils.pathjoin
1097
file_kind = self._kind
1099
# transport.base ends in a slash, we want the piece
1100
# between the last two slashes
1101
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1103
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1105
# directory file_id, relative path, absolute path, reverse sorted children
1106
children = os.listdir(self.basedir)
1108
# jam 20060527 The kernel sized tree seems equivalent whether we
1109
# use a deque and popleft to keep them sorted, or if we use a plain
1110
# list and just reverse() them.
1111
children = collections.deque(children)
1112
stack = [(inv.root.file_id, u'', self.basedir, children)]
1114
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1117
f = children.popleft()
1118
## TODO: If we find a subdirectory with its own .bzr
1119
## directory, then that is a separate tree and we
1120
## should exclude it.
1122
# the bzrdir for this tree
1123
if transport_base_dir == f:
1126
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1127
# and 'f' doesn't begin with one, we can do a string op, rather
1128
# than the checks of pathjoin(), all relative paths will have an extra slash
1130
fp = from_dir_relpath + '/' + f
1133
fap = from_dir_abspath + '/' + f
1135
f_ie = inv.get_child(from_dir_id, f)
1138
elif self.is_ignored(fp[1:]):
1141
# we may not have found this file, because of a unicode issue
1142
f_norm, can_access = osutils.normalized_filename(f)
1143
if f == f_norm or not can_access:
1144
# No change, so treat this file normally
1147
# this file can be accessed by a normalized path
1148
# check again if it is versioned
1149
# these lines are repeated here for performance
1151
fp = from_dir_relpath + '/' + f
1152
fap = from_dir_abspath + '/' + f
1153
f_ie = inv.get_child(from_dir_id, f)
1156
elif self.is_ignored(fp[1:]):
1163
# make a last minute entry
1165
yield fp[1:], c, fk, f_ie.file_id, f_ie
1168
yield fp[1:], c, fk, None, fk_entries[fk]()
1170
yield fp[1:], c, fk, None, TreeEntry()
1173
if fk != 'directory':
1176
# But do this child first
1177
new_children = os.listdir(fap)
1179
new_children = collections.deque(new_children)
1180
stack.append((f_ie.file_id, fp, fap, new_children))
1181
# Break out of inner loop,
1182
# so that we start outer loop with child
1185
# if we finished all children, pop it off the stack
1188
@needs_tree_write_lock
1189
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1192
to_dir must exist in the inventory.
1194
If to_dir exists and is a directory, the files are moved into
1195
it, keeping their old names.
1197
Note that to_dir is only the last component of the new name;
1198
this doesn't change the directory.
1200
For each entry in from_paths the move mode will be determined
1203
The first mode moves the file in the filesystem and updates the
1204
inventory. The second mode only updates the inventory without
1205
touching the file on the filesystem. This is the new mode introduced
1208
move uses the second mode if 'after == True' and the target is not
1209
versioned but present in the working tree.
1211
move uses the second mode if 'after == False' and the source is
1212
versioned but no longer in the working tree, and the target is not
1213
versioned but present in the working tree.
1215
move uses the first mode if 'after == False' and the source is
1216
versioned and present in the working tree, and the target is not
1217
versioned and not present in the working tree.
1219
Everything else results in an error.
1221
This returns a list of (from_path, to_path) pairs for each
1222
entry that is moved.
1227
# check for deprecated use of signature
1229
to_dir = kwargs.get('to_name', None)
1231
raise TypeError('You must supply a target directory')
1233
symbol_versioning.warn('The parameter to_name was deprecated'
1234
' in version 0.13. Use to_dir instead',
1237
# check destination directory
1238
if isinstance(from_paths, basestring):
1240
inv = self.inventory
1241
to_abs = self.abspath(to_dir)
1242
if not isdir(to_abs):
1243
raise errors.BzrMoveFailedError('',to_dir,
1244
errors.NotADirectory(to_abs))
1245
if not self.has_filename(to_dir):
1246
raise errors.BzrMoveFailedError('',to_dir,
1247
errors.NotInWorkingDirectory(to_dir))
1248
to_dir_id = inv.path2id(to_dir)
1249
if to_dir_id is None:
1250
raise errors.BzrMoveFailedError('',to_dir,
1251
errors.NotVersionedError(path=str(to_dir)))
1253
to_dir_ie = inv[to_dir_id]
1254
if to_dir_ie.kind != 'directory':
1255
raise errors.BzrMoveFailedError('',to_dir,
1256
errors.NotADirectory(to_abs))
1258
# create rename entries and tuples
1259
for from_rel in from_paths:
1260
from_tail = splitpath(from_rel)[-1]
1261
from_id = inv.path2id(from_rel)
1263
raise errors.BzrMoveFailedError(from_rel,to_dir,
1264
errors.NotVersionedError(path=str(from_rel)))
1266
from_entry = inv[from_id]
1267
from_parent_id = from_entry.parent_id
1268
to_rel = pathjoin(to_dir, from_tail)
1269
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1271
from_tail=from_tail,
1272
from_parent_id=from_parent_id,
1273
to_rel=to_rel, to_tail=from_tail,
1274
to_parent_id=to_dir_id)
1275
rename_entries.append(rename_entry)
1276
rename_tuples.append((from_rel, to_rel))
1278
# determine which move mode to use. checks also for movability
1279
rename_entries = self._determine_mv_mode(rename_entries, after)
1281
original_modified = self._inventory_is_modified
1284
self._inventory_is_modified = True
1285
self._move(rename_entries)
1287
# restore the inventory on error
1288
self._inventory_is_modified = original_modified
1290
self._write_inventory(inv)
1291
return rename_tuples
1293
def _determine_mv_mode(self, rename_entries, after=False):
1294
"""Determines for each from-to pair if both inventory and working tree
1295
or only the inventory has to be changed.
1297
Also does basic plausability tests.
1299
inv = self.inventory
1301
for rename_entry in rename_entries:
1302
# store to local variables for easier reference
1303
from_rel = rename_entry.from_rel
1304
from_id = rename_entry.from_id
1305
to_rel = rename_entry.to_rel
1306
to_id = inv.path2id(to_rel)
1307
only_change_inv = False
1309
# check the inventory for source and destination
1311
raise errors.BzrMoveFailedError(from_rel,to_rel,
1312
errors.NotVersionedError(path=str(from_rel)))
1313
if to_id is not None:
1314
raise errors.BzrMoveFailedError(from_rel,to_rel,
1315
errors.AlreadyVersionedError(path=str(to_rel)))
1317
# try to determine the mode for rename (only change inv or change
1318
# inv and file system)
1320
if not self.has_filename(to_rel):
1321
raise errors.BzrMoveFailedError(from_id,to_rel,
1322
errors.NoSuchFile(path=str(to_rel),
1323
extra="New file has not been created yet"))
1324
only_change_inv = True
1325
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1326
only_change_inv = True
1327
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1328
only_change_inv = False
1329
elif (sys.platform == 'win32'
1330
and from_rel.lower() == to_rel.lower()
1331
and self.has_filename(from_rel)):
1332
only_change_inv = False
1334
# something is wrong, so lets determine what exactly
1335
if not self.has_filename(from_rel) and \
1336
not self.has_filename(to_rel):
1337
raise errors.BzrRenameFailedError(from_rel,to_rel,
1338
errors.PathsDoNotExist(paths=(str(from_rel),
1341
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1342
rename_entry.only_change_inv = only_change_inv
1343
return rename_entries
1345
def _move(self, rename_entries):
1346
"""Moves a list of files.
1348
Depending on the value of the flag 'only_change_inv', the
1349
file will be moved on the file system or not.
1351
inv = self.inventory
1354
for entry in rename_entries:
1356
self._move_entry(entry)
1358
self._rollback_move(moved)
1362
def _rollback_move(self, moved):
1363
"""Try to rollback a previous move in case of an filesystem error."""
1364
inv = self.inventory
1367
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1368
entry.to_tail, entry.to_parent_id, entry.from_rel,
1369
entry.from_tail, entry.from_parent_id,
1370
entry.only_change_inv))
1371
except errors.BzrMoveFailedError, e:
1372
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1373
" The working tree is in an inconsistent state."
1374
" Please consider doing a 'bzr revert'."
1375
" Error message is: %s" % e)
1377
def _move_entry(self, entry):
1378
inv = self.inventory
1379
from_rel_abs = self.abspath(entry.from_rel)
1380
to_rel_abs = self.abspath(entry.to_rel)
1381
if from_rel_abs == to_rel_abs:
1382
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1383
"Source and target are identical.")
1385
if not entry.only_change_inv:
1387
osutils.rename(from_rel_abs, to_rel_abs)
1389
raise errors.BzrMoveFailedError(entry.from_rel,
1391
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1393
@needs_tree_write_lock
1394
def rename_one(self, from_rel, to_rel, after=False):
1397
This can change the directory or the filename or both.
1399
rename_one has several 'modes' to work. First, it can rename a physical
1400
file and change the file_id. That is the normal mode. Second, it can
1401
only change the file_id without touching any physical file. This is
1402
the new mode introduced in version 0.15.
1404
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1405
versioned but present in the working tree.
1407
rename_one uses the second mode if 'after == False' and 'from_rel' is
1408
versioned but no longer in the working tree, and 'to_rel' is not
1409
versioned but present in the working tree.
1411
rename_one uses the first mode if 'after == False' and 'from_rel' is
1412
versioned and present in the working tree, and 'to_rel' is not
1413
versioned and not present in the working tree.
1415
Everything else results in an error.
1417
inv = self.inventory
1420
# create rename entries and tuples
1421
from_tail = splitpath(from_rel)[-1]
1422
from_id = inv.path2id(from_rel)
1424
raise errors.BzrRenameFailedError(from_rel,to_rel,
1425
errors.NotVersionedError(path=str(from_rel)))
1426
from_entry = inv[from_id]
1427
from_parent_id = from_entry.parent_id
1428
to_dir, to_tail = os.path.split(to_rel)
1429
to_dir_id = inv.path2id(to_dir)
1430
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1432
from_tail=from_tail,
1433
from_parent_id=from_parent_id,
1434
to_rel=to_rel, to_tail=to_tail,
1435
to_parent_id=to_dir_id)
1436
rename_entries.append(rename_entry)
1438
# determine which move mode to use. checks also for movability
1439
rename_entries = self._determine_mv_mode(rename_entries, after)
1441
# check if the target changed directory and if the target directory is
1443
if to_dir_id is None:
1444
raise errors.BzrMoveFailedError(from_rel,to_rel,
1445
errors.NotVersionedError(path=str(to_dir)))
1447
# all checks done. now we can continue with our actual work
1448
mutter('rename_one:\n'
1453
' to_dir_id {%s}\n',
1454
from_id, from_rel, to_rel, to_dir, to_dir_id)
1456
self._move(rename_entries)
1457
self._write_inventory(inv)
1459
class _RenameEntry(object):
1460
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1461
to_rel, to_tail, to_parent_id, only_change_inv=False):
1462
self.from_rel = from_rel
1463
self.from_id = from_id
1464
self.from_tail = from_tail
1465
self.from_parent_id = from_parent_id
1466
self.to_rel = to_rel
1467
self.to_tail = to_tail
1468
self.to_parent_id = to_parent_id
1469
self.only_change_inv = only_change_inv
1473
"""Return all unknown files.
1475
These are files in the working directory that are not versioned or
1476
control files or ignored.
1478
# force the extras method to be fully executed before returning, to
1479
# prevent race conditions with the lock
1481
[subp for subp in self.extras() if not self.is_ignored(subp)])
1483
@needs_tree_write_lock
1484
def unversion(self, file_ids):
1485
"""Remove the file ids in file_ids from the current versioned set.
1487
When a file_id is unversioned, all of its children are automatically
1490
:param file_ids: The file ids to stop versioning.
1491
:raises: NoSuchId if any fileid is not currently versioned.
1493
for file_id in file_ids:
1494
if self._inventory.has_id(file_id):
1495
self._inventory.remove_recursive_id(file_id)
1497
raise errors.NoSuchId(self, file_id)
1499
# in the future this should just set a dirty bit to wait for the
1500
# final unlock. However, until all methods of workingtree start
1501
# with the current in -memory inventory rather than triggering
1502
# a read, it is more complex - we need to teach read_inventory
1503
# to know when to read, and when to not read first... and possibly
1504
# to save first when the in memory one may be corrupted.
1505
# so for now, we just only write it if it is indeed dirty.
1507
self._write_inventory(self._inventory)
1509
def _iter_conflicts(self):
1511
for info in self.list_files():
1513
stem = get_conflicted_stem(path)
1516
if stem not in conflicted:
1517
conflicted.add(stem)
1521
def pull(self, source, overwrite=False, stop_revision=None,
1522
change_reporter=None, possible_transports=None):
1523
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1526
pp = ProgressPhase("Pull phase", 2, top_pb)
1528
old_revision_info = self.branch.last_revision_info()
1529
basis_tree = self.basis_tree()
1530
count = self.branch.pull(source, overwrite, stop_revision,
1531
possible_transports=possible_transports)
1532
new_revision_info = self.branch.last_revision_info()
1533
if new_revision_info != old_revision_info:
1535
repository = self.branch.repository
1536
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1537
basis_tree.lock_read()
1539
new_basis_tree = self.branch.basis_tree()
1546
change_reporter=change_reporter)
1547
if (basis_tree.inventory.root is None and
1548
new_basis_tree.inventory.root is not None):
1549
self.set_root_id(new_basis_tree.get_root_id())
1553
# TODO - dedup parents list with things merged by pull ?
1554
# reuse the revisiontree we merged against to set the new
1556
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1557
# we have to pull the merge trees out again, because
1558
# merge_inner has set the ids. - this corner is not yet
1559
# layered well enough to prevent double handling.
1560
# XXX TODO: Fix the double handling: telling the tree about
1561
# the already known parent data is wasteful.
1562
merges = self.get_parent_ids()[1:]
1563
parent_trees.extend([
1564
(parent, repository.revision_tree(parent)) for
1566
self.set_parent_trees(parent_trees)
1573
def put_file_bytes_non_atomic(self, file_id, bytes):
1574
"""See MutableTree.put_file_bytes_non_atomic."""
1575
stream = file(self.id2abspath(file_id), 'wb')
1580
# TODO: update the hashcache here ?
1583
"""Yield all unversioned files in this WorkingTree.
1585
If there are any unversioned directories then only the directory is
1586
returned, not all its children. But if there are unversioned files
1587
under a versioned subdirectory, they are returned.
1589
Currently returned depth-first, sorted by name within directories.
1590
This is the same order used by 'osutils.walkdirs'.
1592
## TODO: Work from given directory downwards
1593
for path, dir_entry in self.inventory.directories():
1594
# mutter("search for unknowns in %r", path)
1595
dirabs = self.abspath(path)
1596
if not isdir(dirabs):
1597
# e.g. directory deleted
1601
for subf in os.listdir(dirabs):
1604
if subf not in dir_entry.children:
1607
can_access) = osutils.normalized_filename(subf)
1608
except UnicodeDecodeError:
1609
path_os_enc = path.encode(osutils._fs_enc)
1610
relpath = path_os_enc + '/' + subf
1611
raise errors.BadFilenameEncoding(relpath,
1613
if subf_norm != subf and can_access:
1614
if subf_norm not in dir_entry.children:
1615
fl.append(subf_norm)
1621
subp = pathjoin(path, subf)
1624
def ignored_files(self):
1625
"""Yield list of PATH, IGNORE_PATTERN"""
1626
for subp in self.extras():
1627
pat = self.is_ignored(subp)
1631
def get_ignore_list(self):
1632
"""Return list of ignore patterns.
1634
Cached in the Tree object after the first call.
1636
ignoreset = getattr(self, '_ignoreset', None)
1637
if ignoreset is not None:
1640
ignore_globs = set()
1641
ignore_globs.update(ignores.get_runtime_ignores())
1642
ignore_globs.update(ignores.get_user_ignores())
1643
if self.has_filename(bzrlib.IGNORE_FILENAME):
1644
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1646
ignore_globs.update(ignores.parse_ignore_file(f))
1649
self._ignoreset = ignore_globs
1652
def _flush_ignore_list_cache(self):
1653
"""Resets the cached ignore list to force a cache rebuild."""
1654
self._ignoreset = None
1655
self._ignoreglobster = None
1657
def is_ignored(self, filename):
1658
r"""Check whether the filename matches an ignore pattern.
1660
Patterns containing '/' or '\' need to match the whole path;
1661
others match against only the last component.
1663
If the file is ignored, returns the pattern which caused it to
1664
be ignored, otherwise None. So this can simply be used as a
1665
boolean if desired."""
1666
if getattr(self, '_ignoreglobster', None) is None:
1667
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1668
return self._ignoreglobster.match(filename)
1670
def kind(self, file_id):
1671
return file_kind(self.id2abspath(file_id))
1673
def stored_kind(self, file_id):
1674
"""See Tree.stored_kind"""
1675
return self.inventory[file_id].kind
1677
def _comparison_data(self, entry, path):
1678
abspath = self.abspath(path)
1680
stat_value = os.lstat(abspath)
1682
if getattr(e, 'errno', None) == errno.ENOENT:
1689
mode = stat_value.st_mode
1690
kind = osutils.file_kind_from_stat_mode(mode)
1691
if not supports_executable():
1692
executable = entry is not None and entry.executable
1694
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1695
return kind, executable, stat_value
1697
def _file_size(self, entry, stat_value):
1698
return stat_value.st_size
1700
def last_revision(self):
1701
"""Return the last revision of the branch for this tree.
1703
This format tree does not support a separate marker for last-revision
1704
compared to the branch.
1706
See MutableTree.last_revision
1708
return self._last_revision()
1711
def _last_revision(self):
1712
"""helper for get_parent_ids."""
1713
return _mod_revision.ensure_null(self.branch.last_revision())
1715
def is_locked(self):
1716
return self._control_files.is_locked()
1718
def _must_be_locked(self):
1719
if not self.is_locked():
1720
raise errors.ObjectNotLocked(self)
1722
def lock_read(self):
1723
"""See Branch.lock_read, and WorkingTree.unlock."""
1724
if not self.is_locked():
1726
self.branch.lock_read()
1728
return self._control_files.lock_read()
1730
self.branch.unlock()
1733
def lock_tree_write(self):
1734
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1735
if not self.is_locked():
1737
self.branch.lock_read()
1739
return self._control_files.lock_write()
1741
self.branch.unlock()
1744
def lock_write(self):
1745
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1746
if not self.is_locked():
1748
self.branch.lock_write()
1750
return self._control_files.lock_write()
1752
self.branch.unlock()
1755
def get_physical_lock_status(self):
1756
return self._control_files.get_physical_lock_status()
1758
def _basis_inventory_name(self):
1759
return 'basis-inventory-cache'
1761
def _reset_data(self):
1762
"""Reset transient data that cannot be revalidated."""
1763
self._inventory_is_modified = False
1764
result = self._deserialize(self._transport.get('inventory'))
1765
self._set_inventory(result, dirty=False)
1767
@needs_tree_write_lock
1768
def set_last_revision(self, new_revision):
1769
"""Change the last revision in the working tree."""
1770
if self._change_last_revision(new_revision):
1771
self._cache_basis_inventory(new_revision)
1773
def _change_last_revision(self, new_revision):
1774
"""Template method part of set_last_revision to perform the change.
1776
This is used to allow WorkingTree3 instances to not affect branch
1777
when their last revision is set.
1779
if _mod_revision.is_null(new_revision):
1780
self.branch.set_revision_history([])
1783
self.branch.generate_revision_history(new_revision)
1784
except errors.NoSuchRevision:
1785
# not present in the repo - dont try to set it deeper than the tip
1786
self.branch.set_revision_history([new_revision])
1789
def _write_basis_inventory(self, xml):
1790
"""Write the basis inventory XML to the basis-inventory file"""
1791
path = self._basis_inventory_name()
1793
self._transport.put_file(path, sio,
1794
mode=self._control_files._file_mode)
1796
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1797
"""Create the text that will be saved in basis-inventory"""
1798
inventory.revision_id = revision_id
1799
return xml7.serializer_v7.write_inventory_to_string(inventory)
1801
def _cache_basis_inventory(self, new_revision):
1802
"""Cache new_revision as the basis inventory."""
1803
# TODO: this should allow the ready-to-use inventory to be passed in,
1804
# as commit already has that ready-to-use [while the format is the
1807
# this double handles the inventory - unpack and repack -
1808
# but is easier to understand. We can/should put a conditional
1809
# in here based on whether the inventory is in the latest format
1810
# - perhaps we should repack all inventories on a repository
1812
# the fast path is to copy the raw xml from the repository. If the
1813
# xml contains 'revision_id="', then we assume the right
1814
# revision_id is set. We must check for this full string, because a
1815
# root node id can legitimately look like 'revision_id' but cannot
1817
xml = self.branch.repository.get_inventory_xml(new_revision)
1818
firstline = xml.split('\n', 1)[0]
1819
if (not 'revision_id="' in firstline or
1820
'format="7"' not in firstline):
1821
inv = self.branch.repository.deserialise_inventory(
1823
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1824
self._write_basis_inventory(xml)
1825
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1828
def read_basis_inventory(self):
1829
"""Read the cached basis inventory."""
1830
path = self._basis_inventory_name()
1831
return self._transport.get_bytes(path)
1834
def read_working_inventory(self):
1835
"""Read the working inventory.
1837
:raises errors.InventoryModified: read_working_inventory will fail
1838
when the current in memory inventory has been modified.
1840
# conceptually this should be an implementation detail of the tree.
1841
# XXX: Deprecate this.
1842
# ElementTree does its own conversion from UTF-8, so open in
1844
if self._inventory_is_modified:
1845
raise errors.InventoryModified(self)
1846
result = self._deserialize(self._transport.get('inventory'))
1847
self._set_inventory(result, dirty=False)
1850
@needs_tree_write_lock
1851
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1853
"""Remove nominated files from the working inventory.
1855
:files: File paths relative to the basedir.
1856
:keep_files: If true, the files will also be kept.
1857
:force: Delete files and directories, even if they are changed and
1858
even if the directories are not empty.
1860
if isinstance(files, basestring):
1866
unknown_nested_files=set()
1868
def recurse_directory_to_add_files(directory):
1869
# Recurse directory and add all files
1870
# so we can check if they have changed.
1871
for parent_info, file_infos in\
1872
osutils.walkdirs(self.abspath(directory),
1874
for relpath, basename, kind, lstat, abspath in file_infos:
1875
# Is it versioned or ignored?
1876
if self.path2id(relpath) or self.is_ignored(relpath):
1877
# Add nested content for deletion.
1878
new_files.add(relpath)
1880
# Files which are not versioned and not ignored
1881
# should be treated as unknown.
1882
unknown_nested_files.add((relpath, None, kind))
1884
for filename in files:
1885
# Get file name into canonical form.
1886
abspath = self.abspath(filename)
1887
filename = self.relpath(abspath)
1888
if len(filename) > 0:
1889
new_files.add(filename)
1890
if osutils.isdir(abspath):
1891
recurse_directory_to_add_files(filename)
1893
files = list(new_files)
1896
return # nothing to do
1898
# Sort needed to first handle directory content before the directory
1899
files.sort(reverse=True)
1901
# Bail out if we are going to delete files we shouldn't
1902
if not keep_files and not force:
1903
has_changed_files = len(unknown_nested_files) > 0
1904
if not has_changed_files:
1905
for (file_id, path, content_change, versioned, parent_id, name,
1906
kind, executable) in self.iter_changes(self.basis_tree(),
1907
include_unchanged=True, require_versioned=False,
1908
want_unversioned=True, specific_files=files):
1909
if versioned == (False, False):
1910
# The record is unknown ...
1911
if not self.is_ignored(path[1]):
1912
# ... but not ignored
1913
has_changed_files = True
1915
elif content_change and (kind[1] is not None):
1916
# Versioned and changed, but not deleted
1917
has_changed_files = True
1920
if has_changed_files:
1921
# Make delta show ALL applicable changes in error message.
1922
tree_delta = self.changes_from(self.basis_tree(),
1923
require_versioned=False, want_unversioned=True,
1924
specific_files=files)
1925
for unknown_file in unknown_nested_files:
1926
if unknown_file not in tree_delta.unversioned:
1927
tree_delta.unversioned.extend((unknown_file,))
1928
raise errors.BzrRemoveChangedFilesError(tree_delta)
1930
# Build inv_delta and delete files where applicaple,
1931
# do this before any modifications to inventory.
1933
fid = self.path2id(f)
1936
message = "%s is not versioned." % (f,)
1939
# having removed it, it must be either ignored or unknown
1940
if self.is_ignored(f):
1944
textui.show_status(new_status, self.kind(fid), f,
1947
inv_delta.append((f, None, fid, None))
1948
message = "removed %s" % (f,)
1951
abs_path = self.abspath(f)
1952
if osutils.lexists(abs_path):
1953
if (osutils.isdir(abs_path) and
1954
len(os.listdir(abs_path)) > 0):
1956
osutils.rmtree(abs_path)
1958
message = "%s is not an empty directory "\
1959
"and won't be deleted." % (f,)
1961
osutils.delete_any(abs_path)
1962
message = "deleted %s" % (f,)
1963
elif message is not None:
1964
# Only care if we haven't done anything yet.
1965
message = "%s does not exist." % (f,)
1967
# Print only one message (if any) per file.
1968
if message is not None:
1970
self.apply_inventory_delta(inv_delta)
1972
@needs_tree_write_lock
1973
def revert(self, filenames=None, old_tree=None, backups=True,
1974
pb=DummyProgress(), report_changes=False):
1975
from bzrlib.conflicts import resolve
1978
symbol_versioning.warn('Using [] to revert all files is deprecated'
1979
' as of bzr 0.91. Please use None (the default) instead.',
1980
DeprecationWarning, stacklevel=2)
1981
if old_tree is None:
1982
basis_tree = self.basis_tree()
1983
basis_tree.lock_read()
1984
old_tree = basis_tree
1988
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1990
if filenames is None and len(self.get_parent_ids()) > 1:
1992
last_revision = self.last_revision()
1993
if last_revision != NULL_REVISION:
1994
if basis_tree is None:
1995
basis_tree = self.basis_tree()
1996
basis_tree.lock_read()
1997
parent_trees.append((last_revision, basis_tree))
1998
self.set_parent_trees(parent_trees)
2001
resolve(self, filenames, ignore_misses=True, recursive=True)
2003
if basis_tree is not None:
2007
def revision_tree(self, revision_id):
2008
"""See Tree.revision_tree.
2010
WorkingTree can supply revision_trees for the basis revision only
2011
because there is only one cached inventory in the bzr directory.
2013
if revision_id == self.last_revision():
2015
xml = self.read_basis_inventory()
2016
except errors.NoSuchFile:
2020
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2021
# dont use the repository revision_tree api because we want
2022
# to supply the inventory.
2023
if inv.revision_id == revision_id:
2024
return revisiontree.RevisionTree(self.branch.repository,
2026
except errors.BadInventoryFormat:
2028
# raise if there was no inventory, or if we read the wrong inventory.
2029
raise errors.NoSuchRevisionInTree(self, revision_id)
2031
# XXX: This method should be deprecated in favour of taking in a proper
2032
# new Inventory object.
2033
@needs_tree_write_lock
2034
def set_inventory(self, new_inventory_list):
2035
from bzrlib.inventory import (Inventory,
2040
inv = Inventory(self.get_root_id())
2041
for path, file_id, parent, kind in new_inventory_list:
2042
name = os.path.basename(path)
2045
# fixme, there should be a factory function inv,add_??
2046
if kind == 'directory':
2047
inv.add(InventoryDirectory(file_id, name, parent))
2048
elif kind == 'file':
2049
inv.add(InventoryFile(file_id, name, parent))
2050
elif kind == 'symlink':
2051
inv.add(InventoryLink(file_id, name, parent))
2053
raise errors.BzrError("unknown kind %r" % kind)
2054
self._write_inventory(inv)
2056
@needs_tree_write_lock
2057
def set_root_id(self, file_id):
2058
"""Set the root id for this tree."""
2062
'WorkingTree.set_root_id with fileid=None')
2063
file_id = osutils.safe_file_id(file_id)
2064
self._set_root_id(file_id)
2066
def _set_root_id(self, file_id):
2067
"""Set the root id for this tree, in a format specific manner.
2069
:param file_id: The file id to assign to the root. It must not be
2070
present in the current inventory or an error will occur. It must
2071
not be None, but rather a valid file id.
2073
inv = self._inventory
2074
orig_root_id = inv.root.file_id
2075
# TODO: it might be nice to exit early if there was nothing
2076
# to do, saving us from trigger a sync on unlock.
2077
self._inventory_is_modified = True
2078
# we preserve the root inventory entry object, but
2079
# unlinkit from the byid index
2080
del inv._byid[inv.root.file_id]
2081
inv.root.file_id = file_id
2082
# and link it into the index with the new changed id.
2083
inv._byid[inv.root.file_id] = inv.root
2084
# and finally update all children to reference the new id.
2085
# XXX: this should be safe to just look at the root.children
2086
# list, not the WHOLE INVENTORY.
2089
if entry.parent_id == orig_root_id:
2090
entry.parent_id = inv.root.file_id
2093
"""See Branch.unlock.
2095
WorkingTree locking just uses the Branch locking facilities.
2096
This is current because all working trees have an embedded branch
2097
within them. IF in the future, we were to make branch data shareable
2098
between multiple working trees, i.e. via shared storage, then we
2099
would probably want to lock both the local tree, and the branch.
2101
raise NotImplementedError(self.unlock)
2103
def update(self, change_reporter=None, possible_transports=None):
2104
"""Update a working tree along its branch.
2106
This will update the branch if its bound too, which means we have
2107
multiple trees involved:
2109
- The new basis tree of the master.
2110
- The old basis tree of the branch.
2111
- The old basis tree of the working tree.
2112
- The current working tree state.
2114
Pathologically, all three may be different, and non-ancestors of each
2115
other. Conceptually we want to:
2117
- Preserve the wt.basis->wt.state changes
2118
- Transform the wt.basis to the new master basis.
2119
- Apply a merge of the old branch basis to get any 'local' changes from
2121
- Restore the wt.basis->wt.state changes.
2123
There isn't a single operation at the moment to do that, so we:
2124
- Merge current state -> basis tree of the master w.r.t. the old tree
2126
- Do a 'normal' merge of the old branch basis if it is relevant.
2128
if self.branch.get_bound_location() is not None:
2130
update_branch = True
2132
self.lock_tree_write()
2133
update_branch = False
2136
old_tip = self.branch.update(possible_transports)
2139
return self._update_tree(old_tip, change_reporter)
2143
@needs_tree_write_lock
2144
def _update_tree(self, old_tip=None, change_reporter=None):
2145
"""Update a tree to the master branch.
2147
:param old_tip: if supplied, the previous tip revision the branch,
2148
before it was changed to the master branch's tip.
2150
# here if old_tip is not None, it is the old tip of the branch before
2151
# it was updated from the master branch. This should become a pending
2152
# merge in the working tree to preserve the user existing work. we
2153
# cant set that until we update the working trees last revision to be
2154
# one from the new branch, because it will just get absorbed by the
2155
# parent de-duplication logic.
2157
# We MUST save it even if an error occurs, because otherwise the users
2158
# local work is unreferenced and will appear to have been lost.
2162
last_rev = self.get_parent_ids()[0]
2164
last_rev = _mod_revision.NULL_REVISION
2165
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2166
# merge tree state up to new branch tip.
2167
basis = self.basis_tree()
2170
to_tree = self.branch.basis_tree()
2171
if basis.inventory.root is None:
2172
self.set_root_id(to_tree.get_root_id())
2174
result += merge.merge_inner(
2179
change_reporter=change_reporter)
2182
# TODO - dedup parents list with things merged by pull ?
2183
# reuse the tree we've updated to to set the basis:
2184
parent_trees = [(self.branch.last_revision(), to_tree)]
2185
merges = self.get_parent_ids()[1:]
2186
# Ideally we ask the tree for the trees here, that way the working
2187
# tree can decide whether to give us teh entire tree or give us a
2188
# lazy initialised tree. dirstate for instance will have the trees
2189
# in ram already, whereas a last-revision + basis-inventory tree
2190
# will not, but also does not need them when setting parents.
2191
for parent in merges:
2192
parent_trees.append(
2193
(parent, self.branch.repository.revision_tree(parent)))
2194
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2195
parent_trees.append(
2196
(old_tip, self.branch.repository.revision_tree(old_tip)))
2197
self.set_parent_trees(parent_trees)
2198
last_rev = parent_trees[0][0]
2200
# the working tree had the same last-revision as the master
2201
# branch did. We may still have pivot local work from the local
2202
# branch into old_tip:
2203
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2204
self.add_parent_tree_id(old_tip)
2205
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2206
and old_tip != last_rev):
2207
# our last revision was not the prior branch last revision
2208
# and we have converted that last revision to a pending merge.
2209
# base is somewhere between the branch tip now
2210
# and the now pending merge
2212
# Since we just modified the working tree and inventory, flush out
2213
# the current state, before we modify it again.
2214
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2215
# requires it only because TreeTransform directly munges the
2216
# inventory and calls tree._write_inventory(). Ultimately we
2217
# should be able to remove this extra flush.
2219
graph = self.branch.repository.get_graph()
2220
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2222
base_tree = self.branch.repository.revision_tree(base_rev_id)
2223
other_tree = self.branch.repository.revision_tree(old_tip)
2224
result += merge.merge_inner(
2229
change_reporter=change_reporter)
2232
def _write_hashcache_if_dirty(self):
2233
"""Write out the hashcache if it is dirty."""
2234
if self._hashcache.needs_write:
2236
self._hashcache.write()
2238
if e.errno not in (errno.EPERM, errno.EACCES):
2240
# TODO: jam 20061219 Should this be a warning? A single line
2241
# warning might be sufficient to let the user know what
2243
mutter('Could not write hashcache for %s\nError: %s',
2244
self._hashcache.cache_file_name(), e)
2246
@needs_tree_write_lock
2247
def _write_inventory(self, inv):
2248
"""Write inventory as the current inventory."""
2249
self._set_inventory(inv, dirty=True)
2252
def set_conflicts(self, arg):
2253
raise errors.UnsupportedOperation(self.set_conflicts, self)
2255
def add_conflicts(self, arg):
2256
raise errors.UnsupportedOperation(self.add_conflicts, self)
2259
def conflicts(self):
2260
conflicts = _mod_conflicts.ConflictList()
2261
for conflicted in self._iter_conflicts():
2264
if file_kind(self.abspath(conflicted)) != "file":
2266
except errors.NoSuchFile:
2269
for suffix in ('.THIS', '.OTHER'):
2271
kind = file_kind(self.abspath(conflicted+suffix))
2274
except errors.NoSuchFile:
2278
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2279
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2281
file_id=self.path2id(conflicted)))
2284
def walkdirs(self, prefix=""):
2285
"""Walk the directories of this tree.
2287
returns a generator which yields items in the form:
2288
((curren_directory_path, fileid),
2289
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2292
This API returns a generator, which is only valid during the current
2293
tree transaction - within a single lock_read or lock_write duration.
2295
If the tree is not locked, it may cause an error to be raised,
2296
depending on the tree implementation.
2298
disk_top = self.abspath(prefix)
2299
if disk_top.endswith('/'):
2300
disk_top = disk_top[:-1]
2301
top_strip_len = len(disk_top) + 1
2302
inventory_iterator = self._walkdirs(prefix)
2303
disk_iterator = osutils.walkdirs(disk_top, prefix)
2305
current_disk = disk_iterator.next()
2306
disk_finished = False
2308
if not (e.errno == errno.ENOENT or
2309
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2312
disk_finished = True
2314
current_inv = inventory_iterator.next()
2315
inv_finished = False
2316
except StopIteration:
2319
while not inv_finished or not disk_finished:
2321
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2322
cur_disk_dir_content) = current_disk
2324
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2325
cur_disk_dir_content) = ((None, None), None)
2326
if not disk_finished:
2327
# strip out .bzr dirs
2328
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2329
len(cur_disk_dir_content) > 0):
2330
# osutils.walkdirs can be made nicer -
2331
# yield the path-from-prefix rather than the pathjoined
2333
bzrdir_loc = bisect_left(cur_disk_dir_content,
2335
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2336
# we dont yield the contents of, or, .bzr itself.
2337
del cur_disk_dir_content[bzrdir_loc]
2339
# everything is unknown
2342
# everything is missing
2345
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2347
# disk is before inventory - unknown
2348
dirblock = [(relpath, basename, kind, stat, None, None) for
2349
relpath, basename, kind, stat, top_path in
2350
cur_disk_dir_content]
2351
yield (cur_disk_dir_relpath, None), dirblock
2353
current_disk = disk_iterator.next()
2354
except StopIteration:
2355
disk_finished = True
2357
# inventory is before disk - missing.
2358
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2359
for relpath, basename, dkind, stat, fileid, kind in
2361
yield (current_inv[0][0], current_inv[0][1]), dirblock
2363
current_inv = inventory_iterator.next()
2364
except StopIteration:
2367
# versioned present directory
2368
# merge the inventory and disk data together
2370
for relpath, subiterator in itertools.groupby(sorted(
2371
current_inv[1] + cur_disk_dir_content,
2372
key=operator.itemgetter(0)), operator.itemgetter(1)):
2373
path_elements = list(subiterator)
2374
if len(path_elements) == 2:
2375
inv_row, disk_row = path_elements
2376
# versioned, present file
2377
dirblock.append((inv_row[0],
2378
inv_row[1], disk_row[2],
2379
disk_row[3], inv_row[4],
2381
elif len(path_elements[0]) == 5:
2383
dirblock.append((path_elements[0][0],
2384
path_elements[0][1], path_elements[0][2],
2385
path_elements[0][3], None, None))
2386
elif len(path_elements[0]) == 6:
2387
# versioned, absent file.
2388
dirblock.append((path_elements[0][0],
2389
path_elements[0][1], 'unknown', None,
2390
path_elements[0][4], path_elements[0][5]))
2392
raise NotImplementedError('unreachable code')
2393
yield current_inv[0], dirblock
2395
current_inv = inventory_iterator.next()
2396
except StopIteration:
2399
current_disk = disk_iterator.next()
2400
except StopIteration:
2401
disk_finished = True
2403
def _walkdirs(self, prefix=""):
2404
"""Walk the directories of this tree.
2406
:prefix: is used as the directrory to start with.
2407
returns a generator which yields items in the form:
2408
((curren_directory_path, fileid),
2409
[(file1_path, file1_name, file1_kind, None, file1_id,
2412
_directory = 'directory'
2413
# get the root in the inventory
2414
inv = self.inventory
2415
top_id = inv.path2id(prefix)
2419
pending = [(prefix, '', _directory, None, top_id, None)]
2422
currentdir = pending.pop()
2423
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2424
top_id = currentdir[4]
2426
relroot = currentdir[0] + '/'
2429
# FIXME: stash the node in pending
2431
for name, child in entry.sorted_children():
2432
dirblock.append((relroot + name, name, child.kind, None,
2433
child.file_id, child.kind
2435
yield (currentdir[0], entry.file_id), dirblock
2436
# push the user specified dirs from dirblock
2437
for dir in reversed(dirblock):
2438
if dir[2] == _directory:
2441
@needs_tree_write_lock
2442
def auto_resolve(self):
2443
"""Automatically resolve text conflicts according to contents.
2445
Only text conflicts are auto_resolvable. Files with no conflict markers
2446
are considered 'resolved', because bzr always puts conflict markers
2447
into files that have text conflicts. The corresponding .THIS .BASE and
2448
.OTHER files are deleted, as per 'resolve'.
2449
:return: a tuple of ConflictLists: (un_resolved, resolved).
2451
un_resolved = _mod_conflicts.ConflictList()
2452
resolved = _mod_conflicts.ConflictList()
2453
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2454
for conflict in self.conflicts():
2455
if (conflict.typestring != 'text conflict' or
2456
self.kind(conflict.file_id) != 'file'):
2457
un_resolved.append(conflict)
2459
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2461
for line in my_file:
2462
if conflict_re.search(line):
2463
un_resolved.append(conflict)
2466
resolved.append(conflict)
2469
resolved.remove_files(self)
2470
self.set_conflicts(un_resolved)
2471
return un_resolved, resolved
2475
tree_basis = self.basis_tree()
2476
tree_basis.lock_read()
2478
repo_basis = self.branch.repository.revision_tree(
2479
self.last_revision())
2480
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2481
raise errors.BzrCheckError(
2482
"Mismatched basis inventory content.")
2487
def _validate(self):
2488
"""Validate internal structures.
2490
This is meant mostly for the test suite. To give it a chance to detect
2491
corruption after actions have occurred. The default implementation is a
2494
:return: None. An exception should be raised if there is an error.
2499
def _get_rules_searcher(self, default_searcher):
2500
"""See Tree._get_rules_searcher."""
2501
if self._rules_searcher is None:
2502
self._rules_searcher = super(WorkingTree,
2503
self)._get_rules_searcher(default_searcher)
2504
return self._rules_searcher
2507
class WorkingTree2(WorkingTree):
2508
"""This is the Format 2 working tree.
2510
This was the first weave based working tree.
2511
- uses os locks for locking.
2512
- uses the branch last-revision.
2515
def __init__(self, *args, **kwargs):
2516
super(WorkingTree2, self).__init__(*args, **kwargs)
2517
# WorkingTree2 has more of a constraint that self._inventory must
2518
# exist. Because this is an older format, we don't mind the overhead
2519
# caused by the extra computation here.
2521
# Newer WorkingTree's should only have self._inventory set when they
2523
if self._inventory is None:
2524
self.read_working_inventory()
2526
def lock_tree_write(self):
2527
"""See WorkingTree.lock_tree_write().
2529
In Format2 WorkingTrees we have a single lock for the branch and tree
2530
so lock_tree_write() degrades to lock_write().
2532
self.branch.lock_write()
2534
return self._control_files.lock_write()
2536
self.branch.unlock()
2540
# do non-implementation specific cleanup
2543
# we share control files:
2544
if self._control_files._lock_count == 3:
2545
# _inventory_is_modified is always False during a read lock.
2546
if self._inventory_is_modified:
2548
self._write_hashcache_if_dirty()
2550
# reverse order of locking.
2552
return self._control_files.unlock()
2554
self.branch.unlock()
2557
class WorkingTree3(WorkingTree):
2558
"""This is the Format 3 working tree.
2560
This differs from the base WorkingTree by:
2561
- having its own file lock
2562
- having its own last-revision property.
2564
This is new in bzr 0.8
2568
def _last_revision(self):
2569
"""See Mutable.last_revision."""
2571
return self._transport.get_bytes('last-revision')
2572
except errors.NoSuchFile:
2573
return _mod_revision.NULL_REVISION
2575
def _change_last_revision(self, revision_id):
2576
"""See WorkingTree._change_last_revision."""
2577
if revision_id is None or revision_id == NULL_REVISION:
2579
self._transport.delete('last-revision')
2580
except errors.NoSuchFile:
2584
self._transport.put_bytes('last-revision', revision_id,
2585
mode=self._control_files._file_mode)
2588
@needs_tree_write_lock
2589
def set_conflicts(self, conflicts):
2590
self._put_rio('conflicts', conflicts.to_stanzas(),
2593
@needs_tree_write_lock
2594
def add_conflicts(self, new_conflicts):
2595
conflict_set = set(self.conflicts())
2596
conflict_set.update(set(list(new_conflicts)))
2597
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2598
key=_mod_conflicts.Conflict.sort_key)))
2601
def conflicts(self):
2603
confile = self._transport.get('conflicts')
2604
except errors.NoSuchFile:
2605
return _mod_conflicts.ConflictList()
2607
if confile.next() != CONFLICT_HEADER_1 + '\n':
2608
raise errors.ConflictFormatError()
2609
except StopIteration:
2610
raise errors.ConflictFormatError()
2611
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2614
# do non-implementation specific cleanup
2616
if self._control_files._lock_count == 1:
2617
# _inventory_is_modified is always False during a read lock.
2618
if self._inventory_is_modified:
2620
self._write_hashcache_if_dirty()
2621
# reverse order of locking.
2623
return self._control_files.unlock()
2625
self.branch.unlock()
2628
def get_conflicted_stem(path):
2629
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2630
if path.endswith(suffix):
2631
return path[:-len(suffix)]
2634
class WorkingTreeFormat(object):
2635
"""An encapsulation of the initialization and open routines for a format.
2637
Formats provide three things:
2638
* An initialization routine,
2642
Formats are placed in an dict by their format string for reference
2643
during workingtree opening. Its not required that these be instances, they
2644
can be classes themselves with class methods - it simply depends on
2645
whether state is needed for a given format or not.
2647
Once a format is deprecated, just deprecate the initialize and open
2648
methods on the format class. Do not deprecate the object, as the
2649
object will be created every time regardless.
2652
_default_format = None
2653
"""The default format used for new trees."""
2656
"""The known formats."""
2658
requires_rich_root = False
2660
upgrade_recommended = False
2663
def find_format(klass, a_bzrdir):
2664
"""Return the format for the working tree object in a_bzrdir."""
2666
transport = a_bzrdir.get_workingtree_transport(None)
2667
format_string = transport.get("format").read()
2668
return klass._formats[format_string]
2669
except errors.NoSuchFile:
2670
raise errors.NoWorkingTree(base=transport.base)
2672
raise errors.UnknownFormatError(format=format_string,
2673
kind="working tree")
2675
def __eq__(self, other):
2676
return self.__class__ is other.__class__
2678
def __ne__(self, other):
2679
return not (self == other)
2682
def get_default_format(klass):
2683
"""Return the current default format."""
2684
return klass._default_format
2686
def get_format_string(self):
2687
"""Return the ASCII format string that identifies this format."""
2688
raise NotImplementedError(self.get_format_string)
2690
def get_format_description(self):
2691
"""Return the short description for this format."""
2692
raise NotImplementedError(self.get_format_description)
2694
def is_supported(self):
2695
"""Is this format supported?
2697
Supported formats can be initialized and opened.
2698
Unsupported formats may not support initialization or committing or
2699
some other features depending on the reason for not being supported.
2703
def supports_views(self):
2704
"""True if this format supports stored views."""
2708
def register_format(klass, format):
2709
klass._formats[format.get_format_string()] = format
2712
def set_default_format(klass, format):
2713
klass._default_format = format
2716
def unregister_format(klass, format):
2717
del klass._formats[format.get_format_string()]
2720
class WorkingTreeFormat2(WorkingTreeFormat):
2721
"""The second working tree format.
2723
This format modified the hash cache from the format 1 hash cache.
2726
upgrade_recommended = True
2728
def get_format_description(self):
2729
"""See WorkingTreeFormat.get_format_description()."""
2730
return "Working tree format 2"
2732
def _stub_initialize_remote(self, branch):
2733
"""As a special workaround create critical control files for a remote working tree.
2735
This ensures that it can later be updated and dealt with locally,
2736
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2737
no working tree. (See bug #43064).
2741
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2743
branch._transport.put_file('inventory', sio,
2744
mode=branch.control_files._file_mode)
2745
branch._transport.put_bytes('pending-merges', '',
2746
mode=branch.control_files._file_mode)
2749
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2750
accelerator_tree=None, hardlink=False):
2751
"""See WorkingTreeFormat.initialize()."""
2752
if not isinstance(a_bzrdir.transport, LocalTransport):
2753
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2754
if from_branch is not None:
2755
branch = from_branch
2757
branch = a_bzrdir.open_branch()
2758
if revision_id is None:
2759
revision_id = _mod_revision.ensure_null(branch.last_revision())
2762
branch.generate_revision_history(revision_id)
2766
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2772
basis_tree = branch.repository.revision_tree(revision_id)
2773
if basis_tree.inventory.root is not None:
2774
wt.set_root_id(basis_tree.get_root_id())
2775
# set the parent list and cache the basis tree.
2776
if _mod_revision.is_null(revision_id):
2779
parent_trees = [(revision_id, basis_tree)]
2780
wt.set_parent_trees(parent_trees)
2781
transform.build_tree(basis_tree, wt)
2785
super(WorkingTreeFormat2, self).__init__()
2786
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2788
def open(self, a_bzrdir, _found=False):
2789
"""Return the WorkingTree object for a_bzrdir
2791
_found is a private parameter, do not use it. It is used to indicate
2792
if format probing has already been done.
2795
# we are being called directly and must probe.
2796
raise NotImplementedError
2797
if not isinstance(a_bzrdir.transport, LocalTransport):
2798
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2799
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2805
class WorkingTreeFormat3(WorkingTreeFormat):
2806
"""The second working tree format updated to record a format marker.
2809
- exists within a metadir controlling .bzr
2810
- includes an explicit version marker for the workingtree control
2811
files, separate from the BzrDir format
2812
- modifies the hash cache format
2814
- uses a LockDir to guard access for writes.
2817
upgrade_recommended = True
2819
def get_format_string(self):
2820
"""See WorkingTreeFormat.get_format_string()."""
2821
return "Bazaar-NG Working Tree format 3"
2823
def get_format_description(self):
2824
"""See WorkingTreeFormat.get_format_description()."""
2825
return "Working tree format 3"
2827
_lock_file_name = 'lock'
2828
_lock_class = LockDir
2830
_tree_class = WorkingTree3
2832
def __get_matchingbzrdir(self):
2833
return bzrdir.BzrDirMetaFormat1()
2835
_matchingbzrdir = property(__get_matchingbzrdir)
2837
def _open_control_files(self, a_bzrdir):
2838
transport = a_bzrdir.get_workingtree_transport(None)
2839
return LockableFiles(transport, self._lock_file_name,
2842
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2843
accelerator_tree=None, hardlink=False):
2844
"""See WorkingTreeFormat.initialize().
2846
:param revision_id: if supplied, create a working tree at a different
2847
revision than the branch is at.
2848
:param accelerator_tree: A tree which can be used for retrieving file
2849
contents more quickly than the revision tree, i.e. a workingtree.
2850
The revision tree will be used for cases where accelerator_tree's
2851
content is different.
2852
:param hardlink: If true, hard-link files from accelerator_tree,
2855
if not isinstance(a_bzrdir.transport, LocalTransport):
2856
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2857
transport = a_bzrdir.get_workingtree_transport(self)
2858
control_files = self._open_control_files(a_bzrdir)
2859
control_files.create_lock()
2860
control_files.lock_write()
2861
transport.put_bytes('format', self.get_format_string(),
2862
mode=control_files._file_mode)
2863
if from_branch is not None:
2864
branch = from_branch
2866
branch = a_bzrdir.open_branch()
2867
if revision_id is None:
2868
revision_id = _mod_revision.ensure_null(branch.last_revision())
2869
# WorkingTree3 can handle an inventory which has a unique root id.
2870
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2871
# those trees. And because there isn't a format bump inbetween, we
2872
# are maintaining compatibility with older clients.
2873
# inv = Inventory(root_id=gen_root_id())
2874
inv = self._initial_inventory()
2875
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2881
_control_files=control_files)
2882
wt.lock_tree_write()
2884
basis_tree = branch.repository.revision_tree(revision_id)
2885
# only set an explicit root id if there is one to set.
2886
if basis_tree.inventory.root is not None:
2887
wt.set_root_id(basis_tree.get_root_id())
2888
if revision_id == NULL_REVISION:
2889
wt.set_parent_trees([])
2891
wt.set_parent_trees([(revision_id, basis_tree)])
2892
transform.build_tree(basis_tree, wt)
2894
# Unlock in this order so that the unlock-triggers-flush in
2895
# WorkingTree is given a chance to fire.
2896
control_files.unlock()
2900
def _initial_inventory(self):
2904
super(WorkingTreeFormat3, self).__init__()
2906
def open(self, a_bzrdir, _found=False):
2907
"""Return the WorkingTree object for a_bzrdir
2909
_found is a private parameter, do not use it. It is used to indicate
2910
if format probing has already been done.
2913
# we are being called directly and must probe.
2914
raise NotImplementedError
2915
if not isinstance(a_bzrdir.transport, LocalTransport):
2916
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2917
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2920
def _open(self, a_bzrdir, control_files):
2921
"""Open the tree itself.
2923
:param a_bzrdir: the dir for the tree.
2924
:param control_files: the control files for the tree.
2926
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2930
_control_files=control_files)
2933
return self.get_format_string()
2936
__default_format = WorkingTreeFormat4()
2937
WorkingTreeFormat.register_format(__default_format)
2938
WorkingTreeFormat.register_format(workingtree_5.WorkingTreeFormat5())
2939
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2940
WorkingTreeFormat.set_default_format(__default_format)
2941
# formats which have no format string are not discoverable
2942
# and not independently creatable, so are not registered.
2943
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
