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,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
assert isinstance(basedir, basestring), \
226
"base directory %r is not a string" % basedir
227
basedir = safe_unicode(basedir)
228
mutter("opening working tree %r", basedir)
229
if deprecated_passed(branch):
230
self._branch = branch
232
self._branch = self.bzrdir.open_branch()
233
self.basedir = realpath(basedir)
234
# if branch is at our basedir and is a format 6 or less
235
if isinstance(self._format, WorkingTreeFormat2):
236
# share control object
237
self._control_files = self.branch.control_files
239
# assume all other formats have their own control files.
240
assert isinstance(_control_files, LockableFiles), \
241
"_control_files must be a LockableFiles, not %r" \
243
self._control_files = _control_files
244
# update the whole cache up front and write to disk if anything changed;
245
# in the future we might want to do this more selectively
246
# two possible ways offer themselves : in self._unlock, write the cache
247
# if needed, or, when the cache sees a change, append it to the hash
248
# cache file, and have the parser take the most recent entry for a
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
251
cache_filename = wt_trans.local_abspath('stat-cache')
252
self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
self._control_files._file_mode)
256
# is this scan needed ? it makes things kinda slow.
263
if _inventory is None:
264
# This will be acquired on lock_read() or lock_write()
265
self._inventory_is_modified = False
266
self._inventory = None
268
# the caller of __init__ has provided an inventory,
269
# we assume they know what they are doing - as its only
270
# the Format factory and creation methods that are
271
# permitted to do this.
272
self._set_inventory(_inventory, dirty=False)
275
fget=lambda self: self._branch,
276
doc="""The branch this WorkingTree is connected to.
278
This cannot be set - it is reflective of the actual disk structure
279
the working tree has been constructed from.
282
def break_lock(self):
283
"""Break a lock if one is present from another instance.
285
Uses the ui factory to ask for confirmation if the lock may be from
288
This will probe the repository for its lock as well.
290
self._control_files.break_lock()
291
self.branch.break_lock()
293
def requires_rich_root(self):
294
return self._format.requires_rich_root
296
def supports_tree_reference(self):
299
def _set_inventory(self, inv, dirty):
300
"""Set the internal cached inventory.
302
:param inv: The inventory to set.
303
:param dirty: A boolean indicating whether the inventory is the same
304
logical inventory as whats on disk. If True the inventory is not
305
the same and should be written to disk or data will be lost, if
306
False then the inventory is the same as that on disk and any
307
serialisation would be unneeded overhead.
309
assert inv.root is not None
310
self._inventory = inv
311
self._inventory_is_modified = dirty
314
def open(path=None, _unsupported=False):
315
"""Open an existing working tree at path.
319
path = os.path.getcwdu()
320
control = bzrdir.BzrDir.open(path, _unsupported)
321
return control.open_workingtree(_unsupported)
324
def open_containing(path=None):
325
"""Open an existing working tree which has its root about path.
327
This probes for a working tree at path and searches upwards from there.
329
Basically we keep looking up until we find the control directory or
330
run into /. If there isn't one, raises NotBranchError.
331
TODO: give this a new exception.
332
If there is one, it is returned, along with the unused portion of path.
334
:return: The WorkingTree that contains 'path', and the rest of path
337
path = osutils.getcwd()
338
control, relpath = bzrdir.BzrDir.open_containing(path)
340
return control.open_workingtree(), relpath
343
def open_downlevel(path=None):
344
"""Open an unsupported working tree.
346
Only intended for advanced situations like upgrading part of a bzrdir.
348
return WorkingTree.open(path, _unsupported=True)
350
# should be deprecated - this is slow and in any case treating them as a
351
# container is (we now know) bad style -- mbp 20070302
352
## @deprecated_method(zero_fifteen)
354
"""Iterate through file_ids for this tree.
356
file_ids are in a WorkingTree if they are in the working inventory
357
and the working file exists.
359
inv = self._inventory
360
for path, ie in inv.iter_entries():
361
if osutils.lexists(self.abspath(path)):
365
return "<%s of %s>" % (self.__class__.__name__,
366
getattr(self, 'basedir', None))
368
def abspath(self, filename):
369
return pathjoin(self.basedir, filename)
371
def basis_tree(self):
372
"""Return RevisionTree for the current last revision.
374
If the left most parent is a ghost then the returned tree will be an
375
empty tree - one obtained by calling repository.revision_tree(None).
378
revision_id = self.get_parent_ids()[0]
380
# no parents, return an empty revision tree.
381
# in the future this should return the tree for
382
# 'empty:' - the implicit root empty tree.
383
return self.branch.repository.revision_tree(None)
385
return self.revision_tree(revision_id)
386
except errors.NoSuchRevision:
388
# No cached copy available, retrieve from the repository.
389
# FIXME? RBC 20060403 should we cache the inventory locally
392
return self.branch.repository.revision_tree(revision_id)
393
except errors.RevisionNotPresent:
394
# the basis tree *may* be a ghost or a low level error may have
395
# occured. If the revision is present, its a problem, if its not
397
if self.branch.repository.has_revision(revision_id):
399
# the basis tree is a ghost so return an empty tree.
400
return self.branch.repository.revision_tree(None)
403
self._flush_ignore_list_cache()
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
451
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id, path=None):
456
path = self.id2path(file_id)
457
return self.get_file_byname(path)
459
def get_file_text(self, file_id):
460
return self.get_file(file_id).read()
462
def get_file_byname(self, filename):
463
return file(self.abspath(filename), 'rb')
466
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
467
"""See Tree.annotate_iter
469
This implementation will use the basis tree implementation if possible.
470
Lines not in the basis are attributed to CURRENT_REVISION
472
If there are pending merges, lines added by those merges will be
473
incorrectly attributed to CURRENT_REVISION (but after committing, the
474
attribution will be correct).
476
basis = self.basis_tree()
479
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
480
require_versioned=True).next()
481
changed_content, kind = changes[2], changes[6]
482
if not changed_content:
483
return basis.annotate_iter(file_id)
487
if kind[0] != 'file':
490
old_lines = list(basis.annotate_iter(file_id))
492
for tree in self.branch.repository.revision_trees(
493
self.get_parent_ids()[1:]):
494
if file_id not in tree:
496
old.append(list(tree.annotate_iter(file_id)))
497
return annotate.reannotate(old, self.get_file(file_id).readlines(),
502
def _get_ancestors(self, default_revision):
503
ancestors = set([default_revision])
504
for parent_id in self.get_parent_ids():
505
ancestors.update(self.branch.repository.get_ancestry(
506
parent_id, topo_sorted=False))
509
def get_parent_ids(self):
510
"""See Tree.get_parent_ids.
512
This implementation reads the pending merges list and last_revision
513
value and uses that to decide what the parents list should be.
515
last_rev = _mod_revision.ensure_null(self._last_revision())
516
if _mod_revision.NULL_REVISION == last_rev:
521
merges_file = self._control_files.get('pending-merges')
522
except errors.NoSuchFile:
525
for l in merges_file.readlines():
526
revision_id = l.rstrip('\n')
527
parents.append(revision_id)
531
def get_root_id(self):
532
"""Return the id of this trees root"""
533
return self._inventory.root.file_id
535
def _get_store_filename(self, file_id):
536
## XXX: badly named; this is not in the store at all
537
return self.abspath(self.id2path(file_id))
540
def clone(self, to_bzrdir, revision_id=None):
541
"""Duplicate this working tree into to_bzr, including all state.
543
Specifically modified files are kept as modified, but
544
ignored and unknown files are discarded.
546
If you want to make a new line of development, see bzrdir.sprout()
549
If not None, the cloned tree will have its last revision set to
550
revision, and and difference between the source trees last revision
551
and this one merged in.
553
# assumes the target bzr dir format is compatible.
554
result = self._format.initialize(to_bzrdir)
555
self.copy_content_into(result, revision_id)
559
def copy_content_into(self, tree, revision_id=None):
560
"""Copy the current content and user files of this tree into tree."""
561
tree.set_root_id(self.get_root_id())
562
if revision_id is None:
563
merge.transform_tree(tree, self)
565
# TODO now merge from tree.last_revision to revision (to preserve
566
# user local changes)
567
merge.transform_tree(tree, self)
568
tree.set_parent_ids([revision_id])
570
def id2abspath(self, file_id):
571
return self.abspath(self.id2path(file_id))
573
def has_id(self, file_id):
574
# files that have been deleted are excluded
576
if not inv.has_id(file_id):
578
path = inv.id2path(file_id)
579
return osutils.lexists(self.abspath(path))
581
def has_or_had_id(self, file_id):
582
if file_id == self.inventory.root.file_id:
584
return self.inventory.has_id(file_id)
586
__contains__ = has_id
588
def get_file_size(self, file_id):
589
return os.path.getsize(self.id2abspath(file_id))
592
def get_file_sha1(self, file_id, path=None, stat_value=None):
594
path = self._inventory.id2path(file_id)
595
return self._hashcache.get_sha1(path, stat_value)
597
def get_file_mtime(self, file_id, path=None):
599
path = self.inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
603
file_id = self.path2id(path)
604
return self._inventory[file_id].executable
606
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
607
mode = stat_result.st_mode
608
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
610
if not supports_executable():
611
def is_executable(self, file_id, path=None):
612
return self._inventory[file_id].executable
614
_is_executable_from_path_and_stat = \
615
_is_executable_from_path_and_stat_from_basis
617
def is_executable(self, file_id, path=None):
619
path = self.id2path(file_id)
620
mode = os.lstat(self.abspath(path)).st_mode
621
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
623
_is_executable_from_path_and_stat = \
624
_is_executable_from_path_and_stat_from_stat
626
@needs_tree_write_lock
627
def _add(self, files, ids, kinds):
628
"""See MutableTree._add."""
629
# TODO: Re-adding a file that is removed in the working copy
630
# should probably put it back with the previous ID.
631
# the read and write working inventory should not occur in this
632
# function - they should be part of lock_write and unlock.
634
for f, file_id, kind in zip(files, ids, kinds):
635
assert kind is not None
637
inv.add_path(f, kind=kind)
639
inv.add_path(f, kind=kind, file_id=file_id)
640
self._inventory_is_modified = True
642
@needs_tree_write_lock
643
def _gather_kinds(self, files, kinds):
644
"""See MutableTree._gather_kinds."""
645
for pos, f in enumerate(files):
646
if kinds[pos] is None:
647
fullpath = normpath(self.abspath(f))
649
kinds[pos] = file_kind(fullpath)
651
if e.errno == errno.ENOENT:
652
raise errors.NoSuchFile(fullpath)
655
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
656
"""Add revision_id as a parent.
658
This is equivalent to retrieving the current list of parent ids
659
and setting the list to its value plus revision_id.
661
:param revision_id: The revision id to add to the parent list. It may
662
be a ghost revision as long as its not the first parent to be added,
663
or the allow_leftmost_as_ghost parameter is set True.
664
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
666
parents = self.get_parent_ids() + [revision_id]
667
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
668
or allow_leftmost_as_ghost)
670
@needs_tree_write_lock
671
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
672
"""Add revision_id, tree tuple as a parent.
674
This is equivalent to retrieving the current list of parent trees
675
and setting the list to its value plus parent_tuple. See also
676
add_parent_tree_id - if you only have a parent id available it will be
677
simpler to use that api. If you have the parent already available, using
678
this api is preferred.
680
:param parent_tuple: The (revision id, tree) to add to the parent list.
681
If the revision_id is a ghost, pass None for the tree.
682
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
684
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
685
if len(parent_ids) > 1:
686
# the leftmost may have already been a ghost, preserve that if it
688
allow_leftmost_as_ghost = True
689
self.set_parent_ids(parent_ids,
690
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
692
@needs_tree_write_lock
693
def add_pending_merge(self, *revision_ids):
694
# TODO: Perhaps should check at this point that the
695
# history of the revision is actually present?
696
parents = self.get_parent_ids()
698
for rev_id in revision_ids:
699
if rev_id in parents:
701
parents.append(rev_id)
704
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
706
def path_content_summary(self, path, _lstat=os.lstat,
707
_mapper=osutils.file_kind_from_stat_mode):
708
"""See Tree.path_content_summary."""
709
abspath = self.abspath(path)
711
stat_result = _lstat(abspath)
713
if getattr(e, 'errno', None) == errno.ENOENT:
715
return ('missing', None, None, None)
716
# propagate other errors
718
kind = _mapper(stat_result.st_mode)
720
size = stat_result.st_size
721
# try for a stat cache lookup
722
executable = self._is_executable_from_path_and_stat(path, stat_result)
723
return (kind, size, executable, self._sha_from_stat(
725
elif kind == 'directory':
726
# perhaps it looks like a plain directory, but it's really a
728
if self._directory_is_tree_reference(path):
729
kind = 'tree-reference'
730
return kind, None, None, None
731
elif kind == 'symlink':
732
return ('symlink', None, None, os.readlink(abspath))
734
return (kind, None, None, None)
736
@deprecated_method(zero_eleven)
738
def pending_merges(self):
739
"""Return a list of pending merges.
741
These are revisions that have been merged into the working
742
directory but not yet committed.
744
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
745
instead - which is available on all tree objects.
747
return self.get_parent_ids()[1:]
749
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
750
"""Common ghost checking functionality from set_parent_*.
752
This checks that the left hand-parent exists if there are any
755
if len(revision_ids) > 0:
756
leftmost_id = revision_ids[0]
757
if (not allow_leftmost_as_ghost and not
758
self.branch.repository.has_revision(leftmost_id)):
759
raise errors.GhostRevisionUnusableHere(leftmost_id)
761
def _set_merges_from_parent_ids(self, parent_ids):
762
merges = parent_ids[1:]
763
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
765
@needs_tree_write_lock
766
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
767
"""Set the parent ids to revision_ids.
769
See also set_parent_trees. This api will try to retrieve the tree data
770
for each element of revision_ids from the trees repository. If you have
771
tree data already available, it is more efficient to use
772
set_parent_trees rather than set_parent_ids. set_parent_ids is however
773
an easier API to use.
775
:param revision_ids: The revision_ids to set as the parent ids of this
776
working tree. Any of these may be ghosts.
778
self._check_parents_for_ghosts(revision_ids,
779
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
780
for revision_id in revision_ids:
781
_mod_revision.check_not_reserved_id(revision_id)
783
if len(revision_ids) > 0:
784
self.set_last_revision(revision_ids[0])
786
self.set_last_revision(_mod_revision.NULL_REVISION)
788
self._set_merges_from_parent_ids(revision_ids)
790
@needs_tree_write_lock
791
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
792
"""See MutableTree.set_parent_trees."""
793
parent_ids = [rev for (rev, tree) in parents_list]
794
for revision_id in parent_ids:
795
_mod_revision.check_not_reserved_id(revision_id)
797
self._check_parents_for_ghosts(parent_ids,
798
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
800
if len(parent_ids) == 0:
801
leftmost_parent_id = _mod_revision.NULL_REVISION
802
leftmost_parent_tree = None
804
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
806
if self._change_last_revision(leftmost_parent_id):
807
if leftmost_parent_tree is None:
808
# If we don't have a tree, fall back to reading the
809
# parent tree from the repository.
810
self._cache_basis_inventory(leftmost_parent_id)
812
inv = leftmost_parent_tree.inventory
813
xml = self._create_basis_xml_from_inventory(
814
leftmost_parent_id, inv)
815
self._write_basis_inventory(xml)
816
self._set_merges_from_parent_ids(parent_ids)
818
@needs_tree_write_lock
819
def set_pending_merges(self, rev_list):
820
parents = self.get_parent_ids()
821
leftmost = parents[:1]
822
new_parents = leftmost + rev_list
823
self.set_parent_ids(new_parents)
825
@needs_tree_write_lock
826
def set_merge_modified(self, modified_hashes):
828
for file_id, hash in modified_hashes.iteritems():
829
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
830
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
832
def _sha_from_stat(self, path, stat_result):
833
"""Get a sha digest from the tree's stat cache.
835
The default implementation assumes no stat cache is present.
837
:param path: The path.
838
:param stat_result: The stat result being looked up.
842
def _put_rio(self, filename, stanzas, header):
843
self._must_be_locked()
844
my_file = rio_file(stanzas, header)
845
self._control_files.put(filename, my_file)
847
@needs_write_lock # because merge pulls data into the branch.
848
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
850
"""Merge from a branch into this working tree.
852
:param branch: The branch to merge from.
853
:param to_revision: If non-None, the merge will merge to to_revision,
854
but not beyond it. to_revision does not need to be in the history
855
of the branch when it is supplied. If None, to_revision defaults to
856
branch.last_revision().
858
from bzrlib.merge import Merger, Merge3Merger
859
pb = bzrlib.ui.ui_factory.nested_progress_bar()
861
merger = Merger(self.branch, this_tree=self, pb=pb)
862
merger.pp = ProgressPhase("Merge phase", 5, pb)
863
merger.pp.next_phase()
864
# check that there are no
866
merger.check_basis(check_clean=True, require_commits=False)
867
if to_revision is None:
868
to_revision = _mod_revision.ensure_null(branch.last_revision())
869
merger.other_rev_id = to_revision
870
if _mod_revision.is_null(merger.other_rev_id):
871
raise errors.NoCommits(branch)
872
self.branch.fetch(branch, last_revision=merger.other_rev_id)
873
merger.other_basis = merger.other_rev_id
874
merger.other_tree = self.branch.repository.revision_tree(
876
merger.other_branch = branch
877
merger.pp.next_phase()
878
if from_revision is None:
881
merger.set_base_revision(from_revision, branch)
882
if merger.base_rev_id == merger.other_rev_id:
883
raise errors.PointlessMerge
884
merger.backup_files = False
885
if merge_type is None:
886
merger.merge_type = Merge3Merger
888
merger.merge_type = merge_type
889
merger.set_interesting_files(None)
890
merger.show_base = False
891
merger.reprocess = False
892
conflicts = merger.do_merge()
899
def merge_modified(self):
900
"""Return a dictionary of files modified by a merge.
902
The list is initialized by WorkingTree.set_merge_modified, which is
903
typically called after we make some automatic updates to the tree
906
This returns a map of file_id->sha1, containing only files which are
907
still in the working inventory and have that text hash.
910
hashfile = self._control_files.get('merge-hashes')
911
except errors.NoSuchFile:
915
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
916
raise errors.MergeModifiedFormatError()
917
except StopIteration:
918
raise errors.MergeModifiedFormatError()
919
for s in RioReader(hashfile):
920
# RioReader reads in Unicode, so convert file_ids back to utf8
921
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
922
if file_id not in self.inventory:
924
text_hash = s.get("hash")
925
if text_hash == self.get_file_sha1(file_id):
926
merge_hashes[file_id] = text_hash
930
def mkdir(self, path, file_id=None):
931
"""See MutableTree.mkdir()."""
933
file_id = generate_ids.gen_file_id(os.path.basename(path))
934
os.mkdir(self.abspath(path))
935
self.add(path, file_id, 'directory')
938
def get_symlink_target(self, file_id):
939
return os.readlink(self.id2abspath(file_id))
942
def subsume(self, other_tree):
943
def add_children(inventory, entry):
944
for child_entry in entry.children.values():
945
inventory._byid[child_entry.file_id] = child_entry
946
if child_entry.kind == 'directory':
947
add_children(inventory, child_entry)
948
if other_tree.get_root_id() == self.get_root_id():
949
raise errors.BadSubsumeSource(self, other_tree,
950
'Trees have the same root')
952
other_tree_path = self.relpath(other_tree.basedir)
953
except errors.PathNotChild:
954
raise errors.BadSubsumeSource(self, other_tree,
955
'Tree is not contained by the other')
956
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
957
if new_root_parent is None:
958
raise errors.BadSubsumeSource(self, other_tree,
959
'Parent directory is not versioned.')
960
# We need to ensure that the result of a fetch will have a
961
# versionedfile for the other_tree root, and only fetching into
962
# RepositoryKnit2 guarantees that.
963
if not self.branch.repository.supports_rich_root():
964
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
965
other_tree.lock_tree_write()
967
new_parents = other_tree.get_parent_ids()
968
other_root = other_tree.inventory.root
969
other_root.parent_id = new_root_parent
970
other_root.name = osutils.basename(other_tree_path)
971
self.inventory.add(other_root)
972
add_children(self.inventory, other_root)
973
self._write_inventory(self.inventory)
974
# normally we don't want to fetch whole repositories, but i think
975
# here we really do want to consolidate the whole thing.
976
for parent_id in other_tree.get_parent_ids():
977
self.branch.fetch(other_tree.branch, parent_id)
978
self.add_parent_tree_id(parent_id)
981
other_tree.bzrdir.retire_bzrdir()
983
def _directory_is_tree_reference(self, relpath):
984
# as a special case, if a directory contains control files then
985
# it's a tree reference, except that the root of the tree is not
986
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
987
# TODO: We could ask all the control formats whether they
988
# recognize this directory, but at the moment there's no cheap api
989
# to do that. Since we probably can only nest bzr checkouts and
990
# they always use this name it's ok for now. -- mbp 20060306
992
# FIXME: There is an unhandled case here of a subdirectory
993
# containing .bzr but not a branch; that will probably blow up
994
# when you try to commit it. It might happen if there is a
995
# checkout in a subdirectory. This can be avoided by not adding
998
@needs_tree_write_lock
999
def extract(self, file_id, format=None):
1000
"""Extract a subtree from this tree.
1002
A new branch will be created, relative to the path for this tree.
1006
segments = osutils.splitpath(path)
1007
transport = self.branch.bzrdir.root_transport
1008
for name in segments:
1009
transport = transport.clone(name)
1010
transport.ensure_base()
1013
sub_path = self.id2path(file_id)
1014
branch_transport = mkdirs(sub_path)
1016
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1017
branch_transport.ensure_base()
1018
branch_bzrdir = format.initialize_on_transport(branch_transport)
1020
repo = branch_bzrdir.find_repository()
1021
except errors.NoRepositoryPresent:
1022
repo = branch_bzrdir.create_repository()
1023
assert repo.supports_rich_root()
1025
if not repo.supports_rich_root():
1026
raise errors.RootNotRich()
1027
new_branch = branch_bzrdir.create_branch()
1028
new_branch.pull(self.branch)
1029
for parent_id in self.get_parent_ids():
1030
new_branch.fetch(self.branch, parent_id)
1031
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1032
if tree_transport.base != branch_transport.base:
1033
tree_bzrdir = format.initialize_on_transport(tree_transport)
1034
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1036
tree_bzrdir = branch_bzrdir
1037
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1038
wt.set_parent_ids(self.get_parent_ids())
1039
my_inv = self.inventory
1040
child_inv = Inventory(root_id=None)
1041
new_root = my_inv[file_id]
1042
my_inv.remove_recursive_id(file_id)
1043
new_root.parent_id = None
1044
child_inv.add(new_root)
1045
self._write_inventory(my_inv)
1046
wt._write_inventory(child_inv)
1049
def _serialize(self, inventory, out_file):
1050
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1053
def _deserialize(selt, in_file):
1054
return xml5.serializer_v5.read_inventory(in_file)
1057
"""Write the in memory inventory to disk."""
1058
# TODO: Maybe this should only write on dirty ?
1059
if self._control_files._lock_mode != 'w':
1060
raise errors.NotWriteLocked(self)
1062
self._serialize(self._inventory, sio)
1064
self._control_files.put('inventory', sio)
1065
self._inventory_is_modified = False
1067
def _kind(self, relpath):
1068
return osutils.file_kind(self.abspath(relpath))
1070
def list_files(self, include_root=False):
1071
"""Recursively list all files as (path, class, kind, id, entry).
1073
Lists, but does not descend into unversioned directories.
1075
This does not include files that have been deleted in this
1078
Skips the control directory.
1080
# list_files is an iterator, so @needs_read_lock doesn't work properly
1081
# with it. So callers should be careful to always read_lock the tree.
1082
if not self.is_locked():
1083
raise errors.ObjectNotLocked(self)
1085
inv = self.inventory
1086
if include_root is True:
1087
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1088
# Convert these into local objects to save lookup times
1089
pathjoin = osutils.pathjoin
1090
file_kind = self._kind
1092
# transport.base ends in a slash, we want the piece
1093
# between the last two slashes
1094
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1096
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1098
# directory file_id, relative path, absolute path, reverse sorted children
1099
children = os.listdir(self.basedir)
1101
# jam 20060527 The kernel sized tree seems equivalent whether we
1102
# use a deque and popleft to keep them sorted, or if we use a plain
1103
# list and just reverse() them.
1104
children = collections.deque(children)
1105
stack = [(inv.root.file_id, u'', self.basedir, children)]
1107
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1110
f = children.popleft()
1111
## TODO: If we find a subdirectory with its own .bzr
1112
## directory, then that is a separate tree and we
1113
## should exclude it.
1115
# the bzrdir for this tree
1116
if transport_base_dir == f:
1119
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1120
# and 'f' doesn't begin with one, we can do a string op, rather
1121
# than the checks of pathjoin(), all relative paths will have an extra slash
1123
fp = from_dir_relpath + '/' + f
1126
fap = from_dir_abspath + '/' + f
1128
f_ie = inv.get_child(from_dir_id, f)
1131
elif self.is_ignored(fp[1:]):
1134
# we may not have found this file, because of a unicode issue
1135
f_norm, can_access = osutils.normalized_filename(f)
1136
if f == f_norm or not can_access:
1137
# No change, so treat this file normally
1140
# this file can be accessed by a normalized path
1141
# check again if it is versioned
1142
# these lines are repeated here for performance
1144
fp = from_dir_relpath + '/' + f
1145
fap = from_dir_abspath + '/' + f
1146
f_ie = inv.get_child(from_dir_id, f)
1149
elif self.is_ignored(fp[1:]):
1156
# make a last minute entry
1158
yield fp[1:], c, fk, f_ie.file_id, f_ie
1161
yield fp[1:], c, fk, None, fk_entries[fk]()
1163
yield fp[1:], c, fk, None, TreeEntry()
1166
if fk != 'directory':
1169
# But do this child first
1170
new_children = os.listdir(fap)
1172
new_children = collections.deque(new_children)
1173
stack.append((f_ie.file_id, fp, fap, new_children))
1174
# Break out of inner loop,
1175
# so that we start outer loop with child
1178
# if we finished all children, pop it off the stack
1181
@needs_tree_write_lock
1182
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1185
to_dir must exist in the inventory.
1187
If to_dir exists and is a directory, the files are moved into
1188
it, keeping their old names.
1190
Note that to_dir is only the last component of the new name;
1191
this doesn't change the directory.
1193
For each entry in from_paths the move mode will be determined
1196
The first mode moves the file in the filesystem and updates the
1197
inventory. The second mode only updates the inventory without
1198
touching the file on the filesystem. This is the new mode introduced
1201
move uses the second mode if 'after == True' and the target is not
1202
versioned but present in the working tree.
1204
move uses the second mode if 'after == False' and the source is
1205
versioned but no longer in the working tree, and the target is not
1206
versioned but present in the working tree.
1208
move uses the first mode if 'after == False' and the source is
1209
versioned and present in the working tree, and the target is not
1210
versioned and not present in the working tree.
1212
Everything else results in an error.
1214
This returns a list of (from_path, to_path) pairs for each
1215
entry that is moved.
1220
# check for deprecated use of signature
1222
to_dir = kwargs.get('to_name', None)
1224
raise TypeError('You must supply a target directory')
1226
symbol_versioning.warn('The parameter to_name was deprecated'
1227
' in version 0.13. Use to_dir instead',
1230
# check destination directory
1231
assert not isinstance(from_paths, basestring)
1232
inv = self.inventory
1233
to_abs = self.abspath(to_dir)
1234
if not isdir(to_abs):
1235
raise errors.BzrMoveFailedError('',to_dir,
1236
errors.NotADirectory(to_abs))
1237
if not self.has_filename(to_dir):
1238
raise errors.BzrMoveFailedError('',to_dir,
1239
errors.NotInWorkingDirectory(to_dir))
1240
to_dir_id = inv.path2id(to_dir)
1241
if to_dir_id is None:
1242
raise errors.BzrMoveFailedError('',to_dir,
1243
errors.NotVersionedError(path=str(to_dir)))
1245
to_dir_ie = inv[to_dir_id]
1246
if to_dir_ie.kind != 'directory':
1247
raise errors.BzrMoveFailedError('',to_dir,
1248
errors.NotADirectory(to_abs))
1250
# create rename entries and tuples
1251
for from_rel in from_paths:
1252
from_tail = splitpath(from_rel)[-1]
1253
from_id = inv.path2id(from_rel)
1255
raise errors.BzrMoveFailedError(from_rel,to_dir,
1256
errors.NotVersionedError(path=str(from_rel)))
1258
from_entry = inv[from_id]
1259
from_parent_id = from_entry.parent_id
1260
to_rel = pathjoin(to_dir, from_tail)
1261
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1263
from_tail=from_tail,
1264
from_parent_id=from_parent_id,
1265
to_rel=to_rel, to_tail=from_tail,
1266
to_parent_id=to_dir_id)
1267
rename_entries.append(rename_entry)
1268
rename_tuples.append((from_rel, to_rel))
1270
# determine which move mode to use. checks also for movability
1271
rename_entries = self._determine_mv_mode(rename_entries, after)
1273
original_modified = self._inventory_is_modified
1276
self._inventory_is_modified = True
1277
self._move(rename_entries)
1279
# restore the inventory on error
1280
self._inventory_is_modified = original_modified
1282
self._write_inventory(inv)
1283
return rename_tuples
1285
def _determine_mv_mode(self, rename_entries, after=False):
1286
"""Determines for each from-to pair if both inventory and working tree
1287
or only the inventory has to be changed.
1289
Also does basic plausability tests.
1291
inv = self.inventory
1293
for rename_entry in rename_entries:
1294
# store to local variables for easier reference
1295
from_rel = rename_entry.from_rel
1296
from_id = rename_entry.from_id
1297
to_rel = rename_entry.to_rel
1298
to_id = inv.path2id(to_rel)
1299
only_change_inv = False
1301
# check the inventory for source and destination
1303
raise errors.BzrMoveFailedError(from_rel,to_rel,
1304
errors.NotVersionedError(path=str(from_rel)))
1305
if to_id is not None:
1306
raise errors.BzrMoveFailedError(from_rel,to_rel,
1307
errors.AlreadyVersionedError(path=str(to_rel)))
1309
# try to determine the mode for rename (only change inv or change
1310
# inv and file system)
1312
if not self.has_filename(to_rel):
1313
raise errors.BzrMoveFailedError(from_id,to_rel,
1314
errors.NoSuchFile(path=str(to_rel),
1315
extra="New file has not been created yet"))
1316
only_change_inv = True
1317
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1318
only_change_inv = True
1319
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1320
only_change_inv = False
1321
elif (sys.platform == 'win32'
1322
and from_rel.lower() == to_rel.lower()
1323
and self.has_filename(from_rel)):
1324
only_change_inv = False
1326
# something is wrong, so lets determine what exactly
1327
if not self.has_filename(from_rel) and \
1328
not self.has_filename(to_rel):
1329
raise errors.BzrRenameFailedError(from_rel,to_rel,
1330
errors.PathsDoNotExist(paths=(str(from_rel),
1333
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1334
rename_entry.only_change_inv = only_change_inv
1335
return rename_entries
1337
def _move(self, rename_entries):
1338
"""Moves a list of files.
1340
Depending on the value of the flag 'only_change_inv', the
1341
file will be moved on the file system or not.
1343
inv = self.inventory
1346
for entry in rename_entries:
1348
self._move_entry(entry)
1350
self._rollback_move(moved)
1354
def _rollback_move(self, moved):
1355
"""Try to rollback a previous move in case of an filesystem error."""
1356
inv = self.inventory
1359
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1360
entry.to_tail, entry.to_parent_id, entry.from_rel,
1361
entry.from_tail, entry.from_parent_id,
1362
entry.only_change_inv))
1363
except errors.BzrMoveFailedError, e:
1364
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1365
" The working tree is in an inconsistent state."
1366
" Please consider doing a 'bzr revert'."
1367
" Error message is: %s" % e)
1369
def _move_entry(self, entry):
1370
inv = self.inventory
1371
from_rel_abs = self.abspath(entry.from_rel)
1372
to_rel_abs = self.abspath(entry.to_rel)
1373
if from_rel_abs == to_rel_abs:
1374
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1375
"Source and target are identical.")
1377
if not entry.only_change_inv:
1379
osutils.rename(from_rel_abs, to_rel_abs)
1381
raise errors.BzrMoveFailedError(entry.from_rel,
1383
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1385
@needs_tree_write_lock
1386
def rename_one(self, from_rel, to_rel, after=False):
1389
This can change the directory or the filename or both.
1391
rename_one has several 'modes' to work. First, it can rename a physical
1392
file and change the file_id. That is the normal mode. Second, it can
1393
only change the file_id without touching any physical file. This is
1394
the new mode introduced in version 0.15.
1396
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1397
versioned but present in the working tree.
1399
rename_one uses the second mode if 'after == False' and 'from_rel' is
1400
versioned but no longer in the working tree, and 'to_rel' is not
1401
versioned but present in the working tree.
1403
rename_one uses the first mode if 'after == False' and 'from_rel' is
1404
versioned and present in the working tree, and 'to_rel' is not
1405
versioned and not present in the working tree.
1407
Everything else results in an error.
1409
inv = self.inventory
1412
# create rename entries and tuples
1413
from_tail = splitpath(from_rel)[-1]
1414
from_id = inv.path2id(from_rel)
1416
raise errors.BzrRenameFailedError(from_rel,to_rel,
1417
errors.NotVersionedError(path=str(from_rel)))
1418
from_entry = inv[from_id]
1419
from_parent_id = from_entry.parent_id
1420
to_dir, to_tail = os.path.split(to_rel)
1421
to_dir_id = inv.path2id(to_dir)
1422
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1424
from_tail=from_tail,
1425
from_parent_id=from_parent_id,
1426
to_rel=to_rel, to_tail=to_tail,
1427
to_parent_id=to_dir_id)
1428
rename_entries.append(rename_entry)
1430
# determine which move mode to use. checks also for movability
1431
rename_entries = self._determine_mv_mode(rename_entries, after)
1433
# check if the target changed directory and if the target directory is
1435
if to_dir_id is None:
1436
raise errors.BzrMoveFailedError(from_rel,to_rel,
1437
errors.NotVersionedError(path=str(to_dir)))
1439
# all checks done. now we can continue with our actual work
1440
mutter('rename_one:\n'
1445
' to_dir_id {%s}\n',
1446
from_id, from_rel, to_rel, to_dir, to_dir_id)
1448
self._move(rename_entries)
1449
self._write_inventory(inv)
1451
class _RenameEntry(object):
1452
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1453
to_rel, to_tail, to_parent_id, only_change_inv=False):
1454
self.from_rel = from_rel
1455
self.from_id = from_id
1456
self.from_tail = from_tail
1457
self.from_parent_id = from_parent_id
1458
self.to_rel = to_rel
1459
self.to_tail = to_tail
1460
self.to_parent_id = to_parent_id
1461
self.only_change_inv = only_change_inv
1465
"""Return all unknown files.
1467
These are files in the working directory that are not versioned or
1468
control files or ignored.
1470
# force the extras method to be fully executed before returning, to
1471
# prevent race conditions with the lock
1473
[subp for subp in self.extras() if not self.is_ignored(subp)])
1475
@needs_tree_write_lock
1476
def unversion(self, file_ids):
1477
"""Remove the file ids in file_ids from the current versioned set.
1479
When a file_id is unversioned, all of its children are automatically
1482
:param file_ids: The file ids to stop versioning.
1483
:raises: NoSuchId if any fileid is not currently versioned.
1485
for file_id in file_ids:
1486
if self._inventory.has_id(file_id):
1487
self._inventory.remove_recursive_id(file_id)
1489
raise errors.NoSuchId(self, file_id)
1491
# in the future this should just set a dirty bit to wait for the
1492
# final unlock. However, until all methods of workingtree start
1493
# with the current in -memory inventory rather than triggering
1494
# a read, it is more complex - we need to teach read_inventory
1495
# to know when to read, and when to not read first... and possibly
1496
# to save first when the in memory one may be corrupted.
1497
# so for now, we just only write it if it is indeed dirty.
1499
self._write_inventory(self._inventory)
1501
@deprecated_method(zero_eight)
1502
def iter_conflicts(self):
1503
"""List all files in the tree that have text or content conflicts.
1504
DEPRECATED. Use conflicts instead."""
1505
return self._iter_conflicts()
1507
def _iter_conflicts(self):
1509
for info in self.list_files():
1511
stem = get_conflicted_stem(path)
1514
if stem not in conflicted:
1515
conflicted.add(stem)
1519
def pull(self, source, overwrite=False, stop_revision=None,
1520
change_reporter=None, possible_transports=None):
1521
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
pp = ProgressPhase("Pull phase", 2, top_pb)
1526
old_revision_info = self.branch.last_revision_info()
1527
basis_tree = self.basis_tree()
1528
count = self.branch.pull(source, overwrite, stop_revision,
1529
possible_transports=possible_transports)
1530
new_revision_info = self.branch.last_revision_info()
1531
if new_revision_info != old_revision_info:
1533
repository = self.branch.repository
1534
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1535
basis_tree.lock_read()
1537
new_basis_tree = self.branch.basis_tree()
1544
change_reporter=change_reporter)
1545
if (basis_tree.inventory.root is None and
1546
new_basis_tree.inventory.root is not None):
1547
self.set_root_id(new_basis_tree.get_root_id())
1551
# TODO - dedup parents list with things merged by pull ?
1552
# reuse the revisiontree we merged against to set the new
1554
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1555
# we have to pull the merge trees out again, because
1556
# merge_inner has set the ids. - this corner is not yet
1557
# layered well enough to prevent double handling.
1558
# XXX TODO: Fix the double handling: telling the tree about
1559
# the already known parent data is wasteful.
1560
merges = self.get_parent_ids()[1:]
1561
parent_trees.extend([
1562
(parent, repository.revision_tree(parent)) for
1564
self.set_parent_trees(parent_trees)
1571
def put_file_bytes_non_atomic(self, file_id, bytes):
1572
"""See MutableTree.put_file_bytes_non_atomic."""
1573
stream = file(self.id2abspath(file_id), 'wb')
1578
# TODO: update the hashcache here ?
1581
"""Yield all unversioned files in this WorkingTree.
1583
If there are any unversioned directories then only the directory is
1584
returned, not all its children. But if there are unversioned files
1585
under a versioned subdirectory, they are returned.
1587
Currently returned depth-first, sorted by name within directories.
1588
This is the same order used by 'osutils.walkdirs'.
1590
## TODO: Work from given directory downwards
1591
for path, dir_entry in self.inventory.directories():
1592
# mutter("search for unknowns in %r", path)
1593
dirabs = self.abspath(path)
1594
if not isdir(dirabs):
1595
# e.g. directory deleted
1599
for subf in os.listdir(dirabs):
1602
if subf not in dir_entry.children:
1603
subf_norm, can_access = osutils.normalized_filename(subf)
1604
if subf_norm != subf and can_access:
1605
if subf_norm not in dir_entry.children:
1606
fl.append(subf_norm)
1612
subp = pathjoin(path, subf)
1615
def ignored_files(self):
1616
"""Yield list of PATH, IGNORE_PATTERN"""
1617
for subp in self.extras():
1618
pat = self.is_ignored(subp)
1622
def get_ignore_list(self):
1623
"""Return list of ignore patterns.
1625
Cached in the Tree object after the first call.
1627
ignoreset = getattr(self, '_ignoreset', None)
1628
if ignoreset is not None:
1631
ignore_globs = set()
1632
ignore_globs.update(ignores.get_runtime_ignores())
1633
ignore_globs.update(ignores.get_user_ignores())
1634
if self.has_filename(bzrlib.IGNORE_FILENAME):
1635
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1637
ignore_globs.update(ignores.parse_ignore_file(f))
1640
self._ignoreset = ignore_globs
1643
def _flush_ignore_list_cache(self):
1644
"""Resets the cached ignore list to force a cache rebuild."""
1645
self._ignoreset = None
1646
self._ignoreglobster = None
1648
def is_ignored(self, filename):
1649
r"""Check whether the filename matches an ignore pattern.
1651
Patterns containing '/' or '\' need to match the whole path;
1652
others match against only the last component.
1654
If the file is ignored, returns the pattern which caused it to
1655
be ignored, otherwise None. So this can simply be used as a
1656
boolean if desired."""
1657
if getattr(self, '_ignoreglobster', None) is None:
1658
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1659
return self._ignoreglobster.match(filename)
1661
def kind(self, file_id):
1662
return file_kind(self.id2abspath(file_id))
1664
def _comparison_data(self, entry, path):
1665
abspath = self.abspath(path)
1667
stat_value = os.lstat(abspath)
1669
if getattr(e, 'errno', None) == errno.ENOENT:
1676
mode = stat_value.st_mode
1677
kind = osutils.file_kind_from_stat_mode(mode)
1678
if not supports_executable():
1679
executable = entry is not None and entry.executable
1681
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1682
return kind, executable, stat_value
1684
def _file_size(self, entry, stat_value):
1685
return stat_value.st_size
1687
def last_revision(self):
1688
"""Return the last revision of the branch for this tree.
1690
This format tree does not support a separate marker for last-revision
1691
compared to the branch.
1693
See MutableTree.last_revision
1695
return self._last_revision()
1698
def _last_revision(self):
1699
"""helper for get_parent_ids."""
1700
return _mod_revision.ensure_null(self.branch.last_revision())
1702
def is_locked(self):
1703
return self._control_files.is_locked()
1705
def _must_be_locked(self):
1706
if not self.is_locked():
1707
raise errors.ObjectNotLocked(self)
1709
def lock_read(self):
1710
"""See Branch.lock_read, and WorkingTree.unlock."""
1711
if not self.is_locked():
1713
self.branch.lock_read()
1715
return self._control_files.lock_read()
1717
self.branch.unlock()
1720
def lock_tree_write(self):
1721
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1722
if not self.is_locked():
1724
self.branch.lock_read()
1726
return self._control_files.lock_write()
1728
self.branch.unlock()
1731
def lock_write(self):
1732
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1733
if not self.is_locked():
1735
self.branch.lock_write()
1737
return self._control_files.lock_write()
1739
self.branch.unlock()
1742
def get_physical_lock_status(self):
1743
return self._control_files.get_physical_lock_status()
1745
def _basis_inventory_name(self):
1746
return 'basis-inventory-cache'
1748
def _reset_data(self):
1749
"""Reset transient data that cannot be revalidated."""
1750
self._inventory_is_modified = False
1751
result = self._deserialize(self._control_files.get('inventory'))
1752
self._set_inventory(result, dirty=False)
1754
@needs_tree_write_lock
1755
def set_last_revision(self, new_revision):
1756
"""Change the last revision in the working tree."""
1757
if self._change_last_revision(new_revision):
1758
self._cache_basis_inventory(new_revision)
1760
def _change_last_revision(self, new_revision):
1761
"""Template method part of set_last_revision to perform the change.
1763
This is used to allow WorkingTree3 instances to not affect branch
1764
when their last revision is set.
1766
if _mod_revision.is_null(new_revision):
1767
self.branch.set_revision_history([])
1770
self.branch.generate_revision_history(new_revision)
1771
except errors.NoSuchRevision:
1772
# not present in the repo - dont try to set it deeper than the tip
1773
self.branch.set_revision_history([new_revision])
1776
def _write_basis_inventory(self, xml):
1777
"""Write the basis inventory XML to the basis-inventory file"""
1778
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1779
path = self._basis_inventory_name()
1781
self._control_files.put(path, sio)
1783
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1784
"""Create the text that will be saved in basis-inventory"""
1785
inventory.revision_id = revision_id
1786
return xml7.serializer_v7.write_inventory_to_string(inventory)
1788
def _cache_basis_inventory(self, new_revision):
1789
"""Cache new_revision as the basis inventory."""
1790
# TODO: this should allow the ready-to-use inventory to be passed in,
1791
# as commit already has that ready-to-use [while the format is the
1794
# this double handles the inventory - unpack and repack -
1795
# but is easier to understand. We can/should put a conditional
1796
# in here based on whether the inventory is in the latest format
1797
# - perhaps we should repack all inventories on a repository
1799
# the fast path is to copy the raw xml from the repository. If the
1800
# xml contains 'revision_id="', then we assume the right
1801
# revision_id is set. We must check for this full string, because a
1802
# root node id can legitimately look like 'revision_id' but cannot
1804
xml = self.branch.repository.get_inventory_xml(new_revision)
1805
firstline = xml.split('\n', 1)[0]
1806
if (not 'revision_id="' in firstline or
1807
'format="7"' not in firstline):
1808
inv = self.branch.repository.deserialise_inventory(
1810
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1811
self._write_basis_inventory(xml)
1812
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1815
def read_basis_inventory(self):
1816
"""Read the cached basis inventory."""
1817
path = self._basis_inventory_name()
1818
return self._control_files.get(path).read()
1821
def read_working_inventory(self):
1822
"""Read the working inventory.
1824
:raises errors.InventoryModified: read_working_inventory will fail
1825
when the current in memory inventory has been modified.
1827
# conceptually this should be an implementation detail of the tree.
1828
# XXX: Deprecate this.
1829
# ElementTree does its own conversion from UTF-8, so open in
1831
if self._inventory_is_modified:
1832
raise errors.InventoryModified(self)
1833
result = self._deserialize(self._control_files.get('inventory'))
1834
self._set_inventory(result, dirty=False)
1837
@needs_tree_write_lock
1838
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1840
"""Remove nominated files from the working inventory.
1842
:files: File paths relative to the basedir.
1843
:keep_files: If true, the files will also be kept.
1844
:force: Delete files and directories, even if they are changed and
1845
even if the directories are not empty.
1847
if isinstance(files, basestring):
1853
unknown_nested_files=set()
1855
def recurse_directory_to_add_files(directory):
1856
# Recurse directory and add all files
1857
# so we can check if they have changed.
1858
for parent_info, file_infos in\
1859
osutils.walkdirs(self.abspath(directory),
1861
for relpath, basename, kind, lstat, abspath in file_infos:
1862
# Is it versioned or ignored?
1863
if self.path2id(relpath) or self.is_ignored(relpath):
1864
# Add nested content for deletion.
1865
new_files.add(relpath)
1867
# Files which are not versioned and not ignored
1868
# should be treated as unknown.
1869
unknown_nested_files.add((relpath, None, kind))
1871
for filename in files:
1872
# Get file name into canonical form.
1873
abspath = self.abspath(filename)
1874
filename = self.relpath(abspath)
1875
if len(filename) > 0:
1876
new_files.add(filename)
1877
if osutils.isdir(abspath):
1878
recurse_directory_to_add_files(filename)
1880
files = list(new_files)
1883
return # nothing to do
1885
# Sort needed to first handle directory content before the directory
1886
files.sort(reverse=True)
1888
# Bail out if we are going to delete files we shouldn't
1889
if not keep_files and not force:
1890
has_changed_files = len(unknown_nested_files) > 0
1891
if not has_changed_files:
1892
for (file_id, path, content_change, versioned, parent_id, name,
1893
kind, executable) in self._iter_changes(self.basis_tree(),
1894
include_unchanged=True, require_versioned=False,
1895
want_unversioned=True, specific_files=files):
1896
# Check if it's an unknown (but not ignored) OR
1897
# changed (but not deleted) :
1898
if ((versioned == (False, False) or
1899
content_change and kind[1] != None)
1900
and not self.is_ignored(path[1])):
1901
has_changed_files = True
1904
if has_changed_files:
1905
# Make delta show ALL applicable changes in error message.
1906
tree_delta = self.changes_from(self.basis_tree(),
1907
require_versioned=False, want_unversioned=True,
1908
specific_files=files)
1909
for unknown_file in unknown_nested_files:
1910
if unknown_file not in tree_delta.unversioned:
1911
tree_delta.unversioned.extend((unknown_file,))
1912
raise errors.BzrRemoveChangedFilesError(tree_delta)
1914
# Build inv_delta and delete files where applicaple,
1915
# do this before any modifications to inventory.
1917
fid = self.path2id(f)
1920
message = "%s is not versioned." % (f,)
1923
# having removed it, it must be either ignored or unknown
1924
if self.is_ignored(f):
1928
textui.show_status(new_status, self.kind(fid), f,
1931
inv_delta.append((f, None, fid, None))
1932
message = "removed %s" % (f,)
1935
abs_path = self.abspath(f)
1936
if osutils.lexists(abs_path):
1937
if (osutils.isdir(abs_path) and
1938
len(os.listdir(abs_path)) > 0):
1940
osutils.rmtree(abs_path)
1942
message = "%s is not an empty directory "\
1943
"and won't be deleted." % (f,)
1945
osutils.delete_any(abs_path)
1946
message = "deleted %s" % (f,)
1947
elif message is not None:
1948
# Only care if we haven't done anything yet.
1949
message = "%s does not exist." % (f,)
1951
# Print only one message (if any) per file.
1952
if message is not None:
1954
self.apply_inventory_delta(inv_delta)
1956
@needs_tree_write_lock
1957
def revert(self, filenames=None, old_tree=None, backups=True,
1958
pb=DummyProgress(), report_changes=False):
1959
from bzrlib.conflicts import resolve
1962
symbol_versioning.warn('Using [] to revert all files is deprecated'
1963
' as of bzr 0.91. Please use None (the default) instead.',
1964
DeprecationWarning, stacklevel=2)
1965
if old_tree is None:
1966
basis_tree = self.basis_tree()
1967
basis_tree.lock_read()
1968
old_tree = basis_tree
1972
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1974
if filenames is None and len(self.get_parent_ids()) > 1:
1976
last_revision = self.last_revision()
1977
if last_revision != NULL_REVISION:
1978
if basis_tree is None:
1979
basis_tree = self.basis_tree()
1980
basis_tree.lock_read()
1981
parent_trees.append((last_revision, basis_tree))
1982
self.set_parent_trees(parent_trees)
1985
resolve(self, filenames, ignore_misses=True)
1987
if basis_tree is not None:
1991
def revision_tree(self, revision_id):
1992
"""See Tree.revision_tree.
1994
WorkingTree can supply revision_trees for the basis revision only
1995
because there is only one cached inventory in the bzr directory.
1997
if revision_id == self.last_revision():
1999
xml = self.read_basis_inventory()
2000
except errors.NoSuchFile:
2004
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2005
# dont use the repository revision_tree api because we want
2006
# to supply the inventory.
2007
if inv.revision_id == revision_id:
2008
return revisiontree.RevisionTree(self.branch.repository,
2010
except errors.BadInventoryFormat:
2012
# raise if there was no inventory, or if we read the wrong inventory.
2013
raise errors.NoSuchRevisionInTree(self, revision_id)
2015
# XXX: This method should be deprecated in favour of taking in a proper
2016
# new Inventory object.
2017
@needs_tree_write_lock
2018
def set_inventory(self, new_inventory_list):
2019
from bzrlib.inventory import (Inventory,
2024
inv = Inventory(self.get_root_id())
2025
for path, file_id, parent, kind in new_inventory_list:
2026
name = os.path.basename(path)
2029
# fixme, there should be a factory function inv,add_??
2030
if kind == 'directory':
2031
inv.add(InventoryDirectory(file_id, name, parent))
2032
elif kind == 'file':
2033
inv.add(InventoryFile(file_id, name, parent))
2034
elif kind == 'symlink':
2035
inv.add(InventoryLink(file_id, name, parent))
2037
raise errors.BzrError("unknown kind %r" % kind)
2038
self._write_inventory(inv)
2040
@needs_tree_write_lock
2041
def set_root_id(self, file_id):
2042
"""Set the root id for this tree."""
2045
symbol_versioning.warn(symbol_versioning.zero_twelve
2046
% 'WorkingTree.set_root_id with fileid=None',
2051
file_id = osutils.safe_file_id(file_id)
2052
self._set_root_id(file_id)
2054
def _set_root_id(self, file_id):
2055
"""Set the root id for this tree, in a format specific manner.
2057
:param file_id: The file id to assign to the root. It must not be
2058
present in the current inventory or an error will occur. It must
2059
not be None, but rather a valid file id.
2061
inv = self._inventory
2062
orig_root_id = inv.root.file_id
2063
# TODO: it might be nice to exit early if there was nothing
2064
# to do, saving us from trigger a sync on unlock.
2065
self._inventory_is_modified = True
2066
# we preserve the root inventory entry object, but
2067
# unlinkit from the byid index
2068
del inv._byid[inv.root.file_id]
2069
inv.root.file_id = file_id
2070
# and link it into the index with the new changed id.
2071
inv._byid[inv.root.file_id] = inv.root
2072
# and finally update all children to reference the new id.
2073
# XXX: this should be safe to just look at the root.children
2074
# list, not the WHOLE INVENTORY.
2077
if entry.parent_id == orig_root_id:
2078
entry.parent_id = inv.root.file_id
2081
"""See Branch.unlock.
2083
WorkingTree locking just uses the Branch locking facilities.
2084
This is current because all working trees have an embedded branch
2085
within them. IF in the future, we were to make branch data shareable
2086
between multiple working trees, i.e. via shared storage, then we
2087
would probably want to lock both the local tree, and the branch.
2089
raise NotImplementedError(self.unlock)
2091
def update(self, change_reporter=None, possible_transports=None):
2092
"""Update a working tree along its branch.
2094
This will update the branch if its bound too, which means we have
2095
multiple trees involved:
2097
- The new basis tree of the master.
2098
- The old basis tree of the branch.
2099
- The old basis tree of the working tree.
2100
- The current working tree state.
2102
Pathologically, all three may be different, and non-ancestors of each
2103
other. Conceptually we want to:
2105
- Preserve the wt.basis->wt.state changes
2106
- Transform the wt.basis to the new master basis.
2107
- Apply a merge of the old branch basis to get any 'local' changes from
2109
- Restore the wt.basis->wt.state changes.
2111
There isn't a single operation at the moment to do that, so we:
2112
- Merge current state -> basis tree of the master w.r.t. the old tree
2114
- Do a 'normal' merge of the old branch basis if it is relevant.
2116
if self.branch.get_master_branch(possible_transports) is not None:
2118
update_branch = True
2120
self.lock_tree_write()
2121
update_branch = False
2124
old_tip = self.branch.update(possible_transports)
2127
return self._update_tree(old_tip, change_reporter)
2131
@needs_tree_write_lock
2132
def _update_tree(self, old_tip=None, change_reporter=None):
2133
"""Update a tree to the master branch.
2135
:param old_tip: if supplied, the previous tip revision the branch,
2136
before it was changed to the master branch's tip.
2138
# here if old_tip is not None, it is the old tip of the branch before
2139
# it was updated from the master branch. This should become a pending
2140
# merge in the working tree to preserve the user existing work. we
2141
# cant set that until we update the working trees last revision to be
2142
# one from the new branch, because it will just get absorbed by the
2143
# parent de-duplication logic.
2145
# We MUST save it even if an error occurs, because otherwise the users
2146
# local work is unreferenced and will appear to have been lost.
2150
last_rev = self.get_parent_ids()[0]
2152
last_rev = _mod_revision.NULL_REVISION
2153
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2154
# merge tree state up to new branch tip.
2155
basis = self.basis_tree()
2158
to_tree = self.branch.basis_tree()
2159
if basis.inventory.root is None:
2160
self.set_root_id(to_tree.get_root_id())
2162
result += merge.merge_inner(
2167
change_reporter=change_reporter)
2170
# TODO - dedup parents list with things merged by pull ?
2171
# reuse the tree we've updated to to set the basis:
2172
parent_trees = [(self.branch.last_revision(), to_tree)]
2173
merges = self.get_parent_ids()[1:]
2174
# Ideally we ask the tree for the trees here, that way the working
2175
# tree can decide whether to give us teh entire tree or give us a
2176
# lazy initialised tree. dirstate for instance will have the trees
2177
# in ram already, whereas a last-revision + basis-inventory tree
2178
# will not, but also does not need them when setting parents.
2179
for parent in merges:
2180
parent_trees.append(
2181
(parent, self.branch.repository.revision_tree(parent)))
2182
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2183
parent_trees.append(
2184
(old_tip, self.branch.repository.revision_tree(old_tip)))
2185
self.set_parent_trees(parent_trees)
2186
last_rev = parent_trees[0][0]
2188
# the working tree had the same last-revision as the master
2189
# branch did. We may still have pivot local work from the local
2190
# branch into old_tip:
2191
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2192
self.add_parent_tree_id(old_tip)
2193
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2194
and old_tip != last_rev):
2195
# our last revision was not the prior branch last revision
2196
# and we have converted that last revision to a pending merge.
2197
# base is somewhere between the branch tip now
2198
# and the now pending merge
2200
# Since we just modified the working tree and inventory, flush out
2201
# the current state, before we modify it again.
2202
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2203
# requires it only because TreeTransform directly munges the
2204
# inventory and calls tree._write_inventory(). Ultimately we
2205
# should be able to remove this extra flush.
2207
graph = self.branch.repository.get_graph()
2208
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2210
base_tree = self.branch.repository.revision_tree(base_rev_id)
2211
other_tree = self.branch.repository.revision_tree(old_tip)
2212
result += merge.merge_inner(
2217
change_reporter=change_reporter)
2220
def _write_hashcache_if_dirty(self):
2221
"""Write out the hashcache if it is dirty."""
2222
if self._hashcache.needs_write:
2224
self._hashcache.write()
2226
if e.errno not in (errno.EPERM, errno.EACCES):
2228
# TODO: jam 20061219 Should this be a warning? A single line
2229
# warning might be sufficient to let the user know what
2231
mutter('Could not write hashcache for %s\nError: %s',
2232
self._hashcache.cache_file_name(), e)
2234
@needs_tree_write_lock
2235
def _write_inventory(self, inv):
2236
"""Write inventory as the current inventory."""
2237
self._set_inventory(inv, dirty=True)
2240
def set_conflicts(self, arg):
2241
raise errors.UnsupportedOperation(self.set_conflicts, self)
2243
def add_conflicts(self, arg):
2244
raise errors.UnsupportedOperation(self.add_conflicts, self)
2247
def conflicts(self):
2248
conflicts = _mod_conflicts.ConflictList()
2249
for conflicted in self._iter_conflicts():
2252
if file_kind(self.abspath(conflicted)) != "file":
2254
except errors.NoSuchFile:
2257
for suffix in ('.THIS', '.OTHER'):
2259
kind = file_kind(self.abspath(conflicted+suffix))
2262
except errors.NoSuchFile:
2266
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2267
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2269
file_id=self.path2id(conflicted)))
2272
def walkdirs(self, prefix=""):
2273
"""Walk the directories of this tree.
2275
returns a generator which yields items in the form:
2276
((curren_directory_path, fileid),
2277
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2280
This API returns a generator, which is only valid during the current
2281
tree transaction - within a single lock_read or lock_write duration.
2283
If the tree is not locked, it may cause an error to be raised,
2284
depending on the tree implementation.
2286
disk_top = self.abspath(prefix)
2287
if disk_top.endswith('/'):
2288
disk_top = disk_top[:-1]
2289
top_strip_len = len(disk_top) + 1
2290
inventory_iterator = self._walkdirs(prefix)
2291
disk_iterator = osutils.walkdirs(disk_top, prefix)
2293
current_disk = disk_iterator.next()
2294
disk_finished = False
2296
if not (e.errno == errno.ENOENT or
2297
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2300
disk_finished = True
2302
current_inv = inventory_iterator.next()
2303
inv_finished = False
2304
except StopIteration:
2307
while not inv_finished or not disk_finished:
2309
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2310
cur_disk_dir_content) = current_disk
2312
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2313
cur_disk_dir_content) = ((None, None), None)
2314
if not disk_finished:
2315
# strip out .bzr dirs
2316
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2317
len(cur_disk_dir_content) > 0):
2318
# osutils.walkdirs can be made nicer -
2319
# yield the path-from-prefix rather than the pathjoined
2321
bzrdir_loc = bisect_left(cur_disk_dir_content,
2323
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2324
# we dont yield the contents of, or, .bzr itself.
2325
del cur_disk_dir_content[bzrdir_loc]
2327
# everything is unknown
2330
# everything is missing
2333
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2335
# disk is before inventory - unknown
2336
dirblock = [(relpath, basename, kind, stat, None, None) for
2337
relpath, basename, kind, stat, top_path in
2338
cur_disk_dir_content]
2339
yield (cur_disk_dir_relpath, None), dirblock
2341
current_disk = disk_iterator.next()
2342
except StopIteration:
2343
disk_finished = True
2345
# inventory is before disk - missing.
2346
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2347
for relpath, basename, dkind, stat, fileid, kind in
2349
yield (current_inv[0][0], current_inv[0][1]), dirblock
2351
current_inv = inventory_iterator.next()
2352
except StopIteration:
2355
# versioned present directory
2356
# merge the inventory and disk data together
2358
for relpath, subiterator in itertools.groupby(sorted(
2359
current_inv[1] + cur_disk_dir_content,
2360
key=operator.itemgetter(0)), operator.itemgetter(1)):
2361
path_elements = list(subiterator)
2362
if len(path_elements) == 2:
2363
inv_row, disk_row = path_elements
2364
# versioned, present file
2365
dirblock.append((inv_row[0],
2366
inv_row[1], disk_row[2],
2367
disk_row[3], inv_row[4],
2369
elif len(path_elements[0]) == 5:
2371
dirblock.append((path_elements[0][0],
2372
path_elements[0][1], path_elements[0][2],
2373
path_elements[0][3], None, None))
2374
elif len(path_elements[0]) == 6:
2375
# versioned, absent file.
2376
dirblock.append((path_elements[0][0],
2377
path_elements[0][1], 'unknown', None,
2378
path_elements[0][4], path_elements[0][5]))
2380
raise NotImplementedError('unreachable code')
2381
yield current_inv[0], dirblock
2383
current_inv = inventory_iterator.next()
2384
except StopIteration:
2387
current_disk = disk_iterator.next()
2388
except StopIteration:
2389
disk_finished = True
2391
def _walkdirs(self, prefix=""):
2392
"""Walk the directories of this tree.
2394
:prefix: is used as the directrory to start with.
2395
returns a generator which yields items in the form:
2396
((curren_directory_path, fileid),
2397
[(file1_path, file1_name, file1_kind, None, file1_id,
2400
_directory = 'directory'
2401
# get the root in the inventory
2402
inv = self.inventory
2403
top_id = inv.path2id(prefix)
2407
pending = [(prefix, '', _directory, None, top_id, None)]
2410
currentdir = pending.pop()
2411
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2412
top_id = currentdir[4]
2414
relroot = currentdir[0] + '/'
2417
# FIXME: stash the node in pending
2419
for name, child in entry.sorted_children():
2420
dirblock.append((relroot + name, name, child.kind, None,
2421
child.file_id, child.kind
2423
yield (currentdir[0], entry.file_id), dirblock
2424
# push the user specified dirs from dirblock
2425
for dir in reversed(dirblock):
2426
if dir[2] == _directory:
2429
@needs_tree_write_lock
2430
def auto_resolve(self):
2431
"""Automatically resolve text conflicts according to contents.
2433
Only text conflicts are auto_resolvable. Files with no conflict markers
2434
are considered 'resolved', because bzr always puts conflict markers
2435
into files that have text conflicts. The corresponding .THIS .BASE and
2436
.OTHER files are deleted, as per 'resolve'.
2437
:return: a tuple of ConflictLists: (un_resolved, resolved).
2439
un_resolved = _mod_conflicts.ConflictList()
2440
resolved = _mod_conflicts.ConflictList()
2441
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2442
for conflict in self.conflicts():
2443
if (conflict.typestring != 'text conflict' or
2444
self.kind(conflict.file_id) != 'file'):
2445
un_resolved.append(conflict)
2447
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2449
for line in my_file:
2450
if conflict_re.search(line):
2451
un_resolved.append(conflict)
2454
resolved.append(conflict)
2457
resolved.remove_files(self)
2458
self.set_conflicts(un_resolved)
2459
return un_resolved, resolved
2461
def _validate(self):
2462
"""Validate internal structures.
2464
This is meant mostly for the test suite. To give it a chance to detect
2465
corruption after actions have occurred. The default implementation is a
2468
:return: None. An exception should be raised if there is an error.
2473
class WorkingTree2(WorkingTree):
2474
"""This is the Format 2 working tree.
2476
This was the first weave based working tree.
2477
- uses os locks for locking.
2478
- uses the branch last-revision.
2481
def __init__(self, *args, **kwargs):
2482
super(WorkingTree2, self).__init__(*args, **kwargs)
2483
# WorkingTree2 has more of a constraint that self._inventory must
2484
# exist. Because this is an older format, we don't mind the overhead
2485
# caused by the extra computation here.
2487
# Newer WorkingTree's should only have self._inventory set when they
2489
if self._inventory is None:
2490
self.read_working_inventory()
2492
def lock_tree_write(self):
2493
"""See WorkingTree.lock_tree_write().
2495
In Format2 WorkingTrees we have a single lock for the branch and tree
2496
so lock_tree_write() degrades to lock_write().
2498
self.branch.lock_write()
2500
return self._control_files.lock_write()
2502
self.branch.unlock()
2506
# do non-implementation specific cleanup
2509
# we share control files:
2510
if self._control_files._lock_count == 3:
2511
# _inventory_is_modified is always False during a read lock.
2512
if self._inventory_is_modified:
2514
self._write_hashcache_if_dirty()
2516
# reverse order of locking.
2518
return self._control_files.unlock()
2520
self.branch.unlock()
2523
class WorkingTree3(WorkingTree):
2524
"""This is the Format 3 working tree.
2526
This differs from the base WorkingTree by:
2527
- having its own file lock
2528
- having its own last-revision property.
2530
This is new in bzr 0.8
2534
def _last_revision(self):
2535
"""See Mutable.last_revision."""
2537
return self._control_files.get('last-revision').read()
2538
except errors.NoSuchFile:
2539
return _mod_revision.NULL_REVISION
2541
def _change_last_revision(self, revision_id):
2542
"""See WorkingTree._change_last_revision."""
2543
if revision_id is None or revision_id == NULL_REVISION:
2545
self._control_files._transport.delete('last-revision')
2546
except errors.NoSuchFile:
2550
self._control_files.put_bytes('last-revision', revision_id)
2553
@needs_tree_write_lock
2554
def set_conflicts(self, conflicts):
2555
self._put_rio('conflicts', conflicts.to_stanzas(),
2558
@needs_tree_write_lock
2559
def add_conflicts(self, new_conflicts):
2560
conflict_set = set(self.conflicts())
2561
conflict_set.update(set(list(new_conflicts)))
2562
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2563
key=_mod_conflicts.Conflict.sort_key)))
2566
def conflicts(self):
2568
confile = self._control_files.get('conflicts')
2569
except errors.NoSuchFile:
2570
return _mod_conflicts.ConflictList()
2572
if confile.next() != CONFLICT_HEADER_1 + '\n':
2573
raise errors.ConflictFormatError()
2574
except StopIteration:
2575
raise errors.ConflictFormatError()
2576
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2579
# do non-implementation specific cleanup
2581
if self._control_files._lock_count == 1:
2582
# _inventory_is_modified is always False during a read lock.
2583
if self._inventory_is_modified:
2585
self._write_hashcache_if_dirty()
2586
# reverse order of locking.
2588
return self._control_files.unlock()
2590
self.branch.unlock()
2593
def get_conflicted_stem(path):
2594
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2595
if path.endswith(suffix):
2596
return path[:-len(suffix)]
2599
@deprecated_function(zero_eight)
2600
def is_control_file(filename):
2601
"""See WorkingTree.is_control_filename(filename)."""
2602
## FIXME: better check
2603
filename = normpath(filename)
2604
while filename != '':
2605
head, tail = os.path.split(filename)
2606
## mutter('check %r for control file' % ((head, tail),))
2609
if filename == head:
2615
class WorkingTreeFormat(object):
2616
"""An encapsulation of the initialization and open routines for a format.
2618
Formats provide three things:
2619
* An initialization routine,
2623
Formats are placed in an dict by their format string for reference
2624
during workingtree opening. Its not required that these be instances, they
2625
can be classes themselves with class methods - it simply depends on
2626
whether state is needed for a given format or not.
2628
Once a format is deprecated, just deprecate the initialize and open
2629
methods on the format class. Do not deprecate the object, as the
2630
object will be created every time regardless.
2633
_default_format = None
2634
"""The default format used for new trees."""
2637
"""The known formats."""
2639
requires_rich_root = False
2641
upgrade_recommended = False
2644
def find_format(klass, a_bzrdir):
2645
"""Return the format for the working tree object in a_bzrdir."""
2647
transport = a_bzrdir.get_workingtree_transport(None)
2648
format_string = transport.get("format").read()
2649
return klass._formats[format_string]
2650
except errors.NoSuchFile:
2651
raise errors.NoWorkingTree(base=transport.base)
2653
raise errors.UnknownFormatError(format=format_string)
2655
def __eq__(self, other):
2656
return self.__class__ is other.__class__
2658
def __ne__(self, other):
2659
return not (self == other)
2662
def get_default_format(klass):
2663
"""Return the current default format."""
2664
return klass._default_format
2666
def get_format_string(self):
2667
"""Return the ASCII format string that identifies this format."""
2668
raise NotImplementedError(self.get_format_string)
2670
def get_format_description(self):
2671
"""Return the short description for this format."""
2672
raise NotImplementedError(self.get_format_description)
2674
def is_supported(self):
2675
"""Is this format supported?
2677
Supported formats can be initialized and opened.
2678
Unsupported formats may not support initialization or committing or
2679
some other features depending on the reason for not being supported.
2684
def register_format(klass, format):
2685
klass._formats[format.get_format_string()] = format
2688
def set_default_format(klass, format):
2689
klass._default_format = format
2692
def unregister_format(klass, format):
2693
assert klass._formats[format.get_format_string()] is format
2694
del klass._formats[format.get_format_string()]
2697
class WorkingTreeFormat2(WorkingTreeFormat):
2698
"""The second working tree format.
2700
This format modified the hash cache from the format 1 hash cache.
2703
upgrade_recommended = True
2705
def get_format_description(self):
2706
"""See WorkingTreeFormat.get_format_description()."""
2707
return "Working tree format 2"
2709
def stub_initialize_remote(self, control_files):
2710
"""As a special workaround create critical control files for a remote working tree
2712
This ensures that it can later be updated and dealt with locally,
2713
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2714
no working tree. (See bug #43064).
2718
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2720
control_files.put('inventory', sio)
2722
control_files.put_bytes('pending-merges', '')
2725
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2726
"""See WorkingTreeFormat.initialize()."""
2727
if not isinstance(a_bzrdir.transport, LocalTransport):
2728
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2729
if from_branch is not None:
2730
branch = from_branch
2732
branch = a_bzrdir.open_branch()
2733
if revision_id is None:
2734
revision_id = _mod_revision.ensure_null(branch.last_revision())
2737
branch.generate_revision_history(revision_id)
2741
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2747
basis_tree = branch.repository.revision_tree(revision_id)
2748
if basis_tree.inventory.root is not None:
2749
wt.set_root_id(basis_tree.get_root_id())
2750
# set the parent list and cache the basis tree.
2751
if _mod_revision.is_null(revision_id):
2754
parent_trees = [(revision_id, basis_tree)]
2755
wt.set_parent_trees(parent_trees)
2756
transform.build_tree(basis_tree, wt)
2760
super(WorkingTreeFormat2, self).__init__()
2761
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2763
def open(self, a_bzrdir, _found=False):
2764
"""Return the WorkingTree object for a_bzrdir
2766
_found is a private parameter, do not use it. It is used to indicate
2767
if format probing has already been done.
2770
# we are being called directly and must probe.
2771
raise NotImplementedError
2772
if not isinstance(a_bzrdir.transport, LocalTransport):
2773
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2774
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2780
class WorkingTreeFormat3(WorkingTreeFormat):
2781
"""The second working tree format updated to record a format marker.
2784
- exists within a metadir controlling .bzr
2785
- includes an explicit version marker for the workingtree control
2786
files, separate from the BzrDir format
2787
- modifies the hash cache format
2789
- uses a LockDir to guard access for writes.
2792
upgrade_recommended = True
2794
def get_format_string(self):
2795
"""See WorkingTreeFormat.get_format_string()."""
2796
return "Bazaar-NG Working Tree format 3"
2798
def get_format_description(self):
2799
"""See WorkingTreeFormat.get_format_description()."""
2800
return "Working tree format 3"
2802
_lock_file_name = 'lock'
2803
_lock_class = LockDir
2805
_tree_class = WorkingTree3
2807
def __get_matchingbzrdir(self):
2808
return bzrdir.BzrDirMetaFormat1()
2810
_matchingbzrdir = property(__get_matchingbzrdir)
2812
def _open_control_files(self, a_bzrdir):
2813
transport = a_bzrdir.get_workingtree_transport(None)
2814
return LockableFiles(transport, self._lock_file_name,
2817
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2818
"""See WorkingTreeFormat.initialize().
2820
revision_id allows creating a working tree at a different
2821
revision than the branch is at.
2823
if not isinstance(a_bzrdir.transport, LocalTransport):
2824
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2825
transport = a_bzrdir.get_workingtree_transport(self)
2826
control_files = self._open_control_files(a_bzrdir)
2827
control_files.create_lock()
2828
control_files.lock_write()
2829
control_files.put_utf8('format', self.get_format_string())
2830
if from_branch is not None:
2831
branch = from_branch
2833
branch = a_bzrdir.open_branch()
2834
if revision_id is None:
2835
revision_id = _mod_revision.ensure_null(branch.last_revision())
2836
# WorkingTree3 can handle an inventory which has a unique root id.
2837
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2838
# those trees. And because there isn't a format bump inbetween, we
2839
# are maintaining compatibility with older clients.
2840
# inv = Inventory(root_id=gen_root_id())
2841
inv = self._initial_inventory()
2842
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2848
_control_files=control_files)
2849
wt.lock_tree_write()
2851
basis_tree = branch.repository.revision_tree(revision_id)
2852
# only set an explicit root id if there is one to set.
2853
if basis_tree.inventory.root is not None:
2854
wt.set_root_id(basis_tree.get_root_id())
2855
if revision_id == NULL_REVISION:
2856
wt.set_parent_trees([])
2858
wt.set_parent_trees([(revision_id, basis_tree)])
2859
transform.build_tree(basis_tree, wt)
2861
# Unlock in this order so that the unlock-triggers-flush in
2862
# WorkingTree is given a chance to fire.
2863
control_files.unlock()
2867
def _initial_inventory(self):
2871
super(WorkingTreeFormat3, self).__init__()
2873
def open(self, a_bzrdir, _found=False):
2874
"""Return the WorkingTree object for a_bzrdir
2876
_found is a private parameter, do not use it. It is used to indicate
2877
if format probing has already been done.
2880
# we are being called directly and must probe.
2881
raise NotImplementedError
2882
if not isinstance(a_bzrdir.transport, LocalTransport):
2883
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2884
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2887
def _open(self, a_bzrdir, control_files):
2888
"""Open the tree itself.
2890
:param a_bzrdir: the dir for the tree.
2891
:param control_files: the control files for the tree.
2893
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2897
_control_files=control_files)
2900
return self.get_format_string()
2903
__default_format = WorkingTreeFormat4()
2904
WorkingTreeFormat.register_format(__default_format)
2905
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2906
WorkingTreeFormat.set_default_format(__default_format)
2907
# formats which have no format string are not discoverable
2908
# and not independently creatable, so are not registered.
2909
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
