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)
273
self._detect_case_handling()
275
def _detect_case_handling(self):
276
wt_trans = self.bzrdir.get_workingtree_transport(None)
278
wt_trans.stat("FoRMaT")
279
except errors.NoSuchFile:
280
self.case_sensitive = True
282
self.case_sensitive = False
285
fget=lambda self: self._branch,
286
doc="""The branch this WorkingTree is connected to.
288
This cannot be set - it is reflective of the actual disk structure
289
the working tree has been constructed from.
292
def break_lock(self):
293
"""Break a lock if one is present from another instance.
295
Uses the ui factory to ask for confirmation if the lock may be from
298
This will probe the repository for its lock as well.
300
self._control_files.break_lock()
301
self.branch.break_lock()
303
def requires_rich_root(self):
304
return self._format.requires_rich_root
306
def supports_tree_reference(self):
309
def _set_inventory(self, inv, dirty):
310
"""Set the internal cached inventory.
312
:param inv: The inventory to set.
313
:param dirty: A boolean indicating whether the inventory is the same
314
logical inventory as whats on disk. If True the inventory is not
315
the same and should be written to disk or data will be lost, if
316
False then the inventory is the same as that on disk and any
317
serialisation would be unneeded overhead.
319
assert inv.root is not None
320
self._inventory = inv
321
self._inventory_is_modified = dirty
324
def open(path=None, _unsupported=False):
325
"""Open an existing working tree at path.
329
path = os.path.getcwdu()
330
control = bzrdir.BzrDir.open(path, _unsupported)
331
return control.open_workingtree(_unsupported)
334
def open_containing(path=None):
335
"""Open an existing working tree which has its root about path.
337
This probes for a working tree at path and searches upwards from there.
339
Basically we keep looking up until we find the control directory or
340
run into /. If there isn't one, raises NotBranchError.
341
TODO: give this a new exception.
342
If there is one, it is returned, along with the unused portion of path.
344
:return: The WorkingTree that contains 'path', and the rest of path
347
path = osutils.getcwd()
348
control, relpath = bzrdir.BzrDir.open_containing(path)
350
return control.open_workingtree(), relpath
353
def open_downlevel(path=None):
354
"""Open an unsupported working tree.
356
Only intended for advanced situations like upgrading part of a bzrdir.
358
return WorkingTree.open(path, _unsupported=True)
360
# should be deprecated - this is slow and in any case treating them as a
361
# container is (we now know) bad style -- mbp 20070302
362
## @deprecated_method(zero_fifteen)
364
"""Iterate through file_ids for this tree.
366
file_ids are in a WorkingTree if they are in the working inventory
367
and the working file exists.
369
inv = self._inventory
370
for path, ie in inv.iter_entries():
371
if osutils.lexists(self.abspath(path)):
375
return "<%s of %s>" % (self.__class__.__name__,
376
getattr(self, 'basedir', None))
378
def abspath(self, filename):
379
return pathjoin(self.basedir, filename)
381
def basis_tree(self):
382
"""Return RevisionTree for the current last revision.
384
If the left most parent is a ghost then the returned tree will be an
385
empty tree - one obtained by calling repository.revision_tree(None).
388
revision_id = self.get_parent_ids()[0]
390
# no parents, return an empty revision tree.
391
# in the future this should return the tree for
392
# 'empty:' - the implicit root empty tree.
393
return self.branch.repository.revision_tree(None)
395
return self.revision_tree(revision_id)
396
except errors.NoSuchRevision:
398
# No cached copy available, retrieve from the repository.
399
# FIXME? RBC 20060403 should we cache the inventory locally
402
return self.branch.repository.revision_tree(revision_id)
403
except errors.RevisionNotPresent:
404
# the basis tree *may* be a ghost or a low level error may have
405
# occured. If the revision is present, its a problem, if its not
407
if self.branch.repository.has_revision(revision_id):
409
# the basis tree is a ghost so return an empty tree.
410
return self.branch.repository.revision_tree(None)
413
self._flush_ignore_list_cache()
416
@deprecated_method(zero_eight)
417
def create(branch, directory):
418
"""Create a workingtree for branch at directory.
420
If existing_directory already exists it must have a .bzr directory.
421
If it does not exist, it will be created.
423
This returns a new WorkingTree object for the new checkout.
425
TODO FIXME RBC 20060124 when we have checkout formats in place this
426
should accept an optional revisionid to checkout [and reject this if
427
checking out into the same dir as a pre-checkout-aware branch format.]
429
XXX: When BzrDir is present, these should be created through that
432
warnings.warn('delete WorkingTree.create', stacklevel=3)
433
transport = get_transport(directory)
434
if branch.bzrdir.root_transport.base == transport.base:
436
return branch.bzrdir.create_workingtree()
437
# different directory,
438
# create a branch reference
439
# and now a working tree.
440
raise NotImplementedError
443
@deprecated_method(zero_eight)
444
def create_standalone(directory):
445
"""Create a checkout and a branch and a repo at directory.
447
Directory must exist and be empty.
449
please use BzrDir.create_standalone_workingtree
451
return bzrdir.BzrDir.create_standalone_workingtree(directory)
453
def relpath(self, path):
454
"""Return the local path portion from a given path.
456
The path may be absolute or relative. If its a relative path it is
457
interpreted relative to the python current working directory.
459
return osutils.relpath(self.basedir, path)
461
def has_filename(self, filename):
462
return osutils.lexists(self.abspath(filename))
464
def get_file(self, file_id, path=None):
466
path = self.id2path(file_id)
467
return self.get_file_byname(path)
469
def get_file_text(self, file_id):
470
return self.get_file(file_id).read()
472
def get_file_byname(self, filename):
473
return file(self.abspath(filename), 'rb')
476
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
477
"""See Tree.annotate_iter
479
This implementation will use the basis tree implementation if possible.
480
Lines not in the basis are attributed to CURRENT_REVISION
482
If there are pending merges, lines added by those merges will be
483
incorrectly attributed to CURRENT_REVISION (but after committing, the
484
attribution will be correct).
486
basis = self.basis_tree()
489
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
490
require_versioned=True).next()
491
changed_content, kind = changes[2], changes[6]
492
if not changed_content:
493
return basis.annotate_iter(file_id)
497
if kind[0] != 'file':
500
old_lines = list(basis.annotate_iter(file_id))
502
for tree in self.branch.repository.revision_trees(
503
self.get_parent_ids()[1:]):
504
if file_id not in tree:
506
old.append(list(tree.annotate_iter(file_id)))
507
return annotate.reannotate(old, self.get_file(file_id).readlines(),
512
def _get_ancestors(self, default_revision):
513
ancestors = set([default_revision])
514
for parent_id in self.get_parent_ids():
515
ancestors.update(self.branch.repository.get_ancestry(
516
parent_id, topo_sorted=False))
519
def get_parent_ids(self):
520
"""See Tree.get_parent_ids.
522
This implementation reads the pending merges list and last_revision
523
value and uses that to decide what the parents list should be.
525
last_rev = _mod_revision.ensure_null(self._last_revision())
526
if _mod_revision.NULL_REVISION == last_rev:
531
merges_file = self._control_files.get('pending-merges')
532
except errors.NoSuchFile:
535
for l in merges_file.readlines():
536
revision_id = l.rstrip('\n')
537
parents.append(revision_id)
541
def get_root_id(self):
542
"""Return the id of this trees root"""
543
return self._inventory.root.file_id
545
def _get_store_filename(self, file_id):
546
## XXX: badly named; this is not in the store at all
547
return self.abspath(self.id2path(file_id))
550
def clone(self, to_bzrdir, revision_id=None):
551
"""Duplicate this working tree into to_bzr, including all state.
553
Specifically modified files are kept as modified, but
554
ignored and unknown files are discarded.
556
If you want to make a new line of development, see bzrdir.sprout()
559
If not None, the cloned tree will have its last revision set to
560
revision, and and difference between the source trees last revision
561
and this one merged in.
563
# assumes the target bzr dir format is compatible.
564
result = self._format.initialize(to_bzrdir)
565
self.copy_content_into(result, revision_id)
569
def copy_content_into(self, tree, revision_id=None):
570
"""Copy the current content and user files of this tree into tree."""
571
tree.set_root_id(self.get_root_id())
572
if revision_id is None:
573
merge.transform_tree(tree, self)
575
# TODO now merge from tree.last_revision to revision (to preserve
576
# user local changes)
577
merge.transform_tree(tree, self)
578
tree.set_parent_ids([revision_id])
580
def id2abspath(self, file_id):
581
return self.abspath(self.id2path(file_id))
583
def has_id(self, file_id):
584
# files that have been deleted are excluded
586
if not inv.has_id(file_id):
588
path = inv.id2path(file_id)
589
return osutils.lexists(self.abspath(path))
591
def has_or_had_id(self, file_id):
592
if file_id == self.inventory.root.file_id:
594
return self.inventory.has_id(file_id)
596
__contains__ = has_id
598
def get_file_size(self, file_id):
599
return os.path.getsize(self.id2abspath(file_id))
602
def get_file_sha1(self, file_id, path=None, stat_value=None):
604
path = self._inventory.id2path(file_id)
605
return self._hashcache.get_sha1(path, stat_value)
607
def get_file_mtime(self, file_id, path=None):
609
path = self.inventory.id2path(file_id)
610
return os.lstat(self.abspath(path)).st_mtime
612
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
613
file_id = self.path2id(path)
614
return self._inventory[file_id].executable
616
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
617
mode = stat_result.st_mode
618
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
620
if not supports_executable():
621
def is_executable(self, file_id, path=None):
622
return self._inventory[file_id].executable
624
_is_executable_from_path_and_stat = \
625
_is_executable_from_path_and_stat_from_basis
627
def is_executable(self, file_id, path=None):
629
path = self.id2path(file_id)
630
mode = os.lstat(self.abspath(path)).st_mode
631
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
633
_is_executable_from_path_and_stat = \
634
_is_executable_from_path_and_stat_from_stat
636
@needs_tree_write_lock
637
def _add(self, files, ids, kinds):
638
"""See MutableTree._add."""
639
# TODO: Re-adding a file that is removed in the working copy
640
# should probably put it back with the previous ID.
641
# the read and write working inventory should not occur in this
642
# function - they should be part of lock_write and unlock.
644
for f, file_id, kind in zip(files, ids, kinds):
645
assert kind is not None
647
inv.add_path(f, kind=kind)
649
inv.add_path(f, kind=kind, file_id=file_id)
650
self._inventory_is_modified = True
652
@needs_tree_write_lock
653
def _gather_kinds(self, files, kinds):
654
"""See MutableTree._gather_kinds."""
655
for pos, f in enumerate(files):
656
if kinds[pos] is None:
657
fullpath = normpath(self.abspath(f))
659
kinds[pos] = file_kind(fullpath)
661
if e.errno == errno.ENOENT:
662
raise errors.NoSuchFile(fullpath)
665
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
666
"""Add revision_id as a parent.
668
This is equivalent to retrieving the current list of parent ids
669
and setting the list to its value plus revision_id.
671
:param revision_id: The revision id to add to the parent list. It may
672
be a ghost revision as long as its not the first parent to be added,
673
or the allow_leftmost_as_ghost parameter is set True.
674
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
676
parents = self.get_parent_ids() + [revision_id]
677
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
678
or allow_leftmost_as_ghost)
680
@needs_tree_write_lock
681
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
682
"""Add revision_id, tree tuple as a parent.
684
This is equivalent to retrieving the current list of parent trees
685
and setting the list to its value plus parent_tuple. See also
686
add_parent_tree_id - if you only have a parent id available it will be
687
simpler to use that api. If you have the parent already available, using
688
this api is preferred.
690
:param parent_tuple: The (revision id, tree) to add to the parent list.
691
If the revision_id is a ghost, pass None for the tree.
692
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
694
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
695
if len(parent_ids) > 1:
696
# the leftmost may have already been a ghost, preserve that if it
698
allow_leftmost_as_ghost = True
699
self.set_parent_ids(parent_ids,
700
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
702
@needs_tree_write_lock
703
def add_pending_merge(self, *revision_ids):
704
# TODO: Perhaps should check at this point that the
705
# history of the revision is actually present?
706
parents = self.get_parent_ids()
708
for rev_id in revision_ids:
709
if rev_id in parents:
711
parents.append(rev_id)
714
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
716
def path_content_summary(self, path, _lstat=os.lstat,
717
_mapper=osutils.file_kind_from_stat_mode):
718
"""See Tree.path_content_summary."""
719
abspath = self.abspath(path)
721
stat_result = _lstat(abspath)
723
if getattr(e, 'errno', None) == errno.ENOENT:
725
return ('missing', None, None, None)
726
# propagate other errors
728
kind = _mapper(stat_result.st_mode)
730
size = stat_result.st_size
731
# try for a stat cache lookup
732
executable = self._is_executable_from_path_and_stat(path, stat_result)
733
return (kind, size, executable, self._sha_from_stat(
735
elif kind == 'directory':
736
# perhaps it looks like a plain directory, but it's really a
738
if self._directory_is_tree_reference(path):
739
kind = 'tree-reference'
740
return kind, None, None, None
741
elif kind == 'symlink':
742
return ('symlink', None, None, os.readlink(abspath))
744
return (kind, None, None, None)
746
@deprecated_method(zero_eleven)
748
def pending_merges(self):
749
"""Return a list of pending merges.
751
These are revisions that have been merged into the working
752
directory but not yet committed.
754
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
755
instead - which is available on all tree objects.
757
return self.get_parent_ids()[1:]
759
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
760
"""Common ghost checking functionality from set_parent_*.
762
This checks that the left hand-parent exists if there are any
765
if len(revision_ids) > 0:
766
leftmost_id = revision_ids[0]
767
if (not allow_leftmost_as_ghost and not
768
self.branch.repository.has_revision(leftmost_id)):
769
raise errors.GhostRevisionUnusableHere(leftmost_id)
771
def _set_merges_from_parent_ids(self, parent_ids):
772
merges = parent_ids[1:]
773
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
775
@needs_tree_write_lock
776
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
777
"""Set the parent ids to revision_ids.
779
See also set_parent_trees. This api will try to retrieve the tree data
780
for each element of revision_ids from the trees repository. If you have
781
tree data already available, it is more efficient to use
782
set_parent_trees rather than set_parent_ids. set_parent_ids is however
783
an easier API to use.
785
:param revision_ids: The revision_ids to set as the parent ids of this
786
working tree. Any of these may be ghosts.
788
self._check_parents_for_ghosts(revision_ids,
789
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
790
for revision_id in revision_ids:
791
_mod_revision.check_not_reserved_id(revision_id)
793
if len(revision_ids) > 0:
794
self.set_last_revision(revision_ids[0])
796
self.set_last_revision(_mod_revision.NULL_REVISION)
798
self._set_merges_from_parent_ids(revision_ids)
800
@needs_tree_write_lock
801
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
802
"""See MutableTree.set_parent_trees."""
803
parent_ids = [rev for (rev, tree) in parents_list]
804
for revision_id in parent_ids:
805
_mod_revision.check_not_reserved_id(revision_id)
807
self._check_parents_for_ghosts(parent_ids,
808
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
810
if len(parent_ids) == 0:
811
leftmost_parent_id = _mod_revision.NULL_REVISION
812
leftmost_parent_tree = None
814
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
816
if self._change_last_revision(leftmost_parent_id):
817
if leftmost_parent_tree is None:
818
# If we don't have a tree, fall back to reading the
819
# parent tree from the repository.
820
self._cache_basis_inventory(leftmost_parent_id)
822
inv = leftmost_parent_tree.inventory
823
xml = self._create_basis_xml_from_inventory(
824
leftmost_parent_id, inv)
825
self._write_basis_inventory(xml)
826
self._set_merges_from_parent_ids(parent_ids)
828
@needs_tree_write_lock
829
def set_pending_merges(self, rev_list):
830
parents = self.get_parent_ids()
831
leftmost = parents[:1]
832
new_parents = leftmost + rev_list
833
self.set_parent_ids(new_parents)
835
@needs_tree_write_lock
836
def set_merge_modified(self, modified_hashes):
838
for file_id, hash in modified_hashes.iteritems():
839
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
840
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
842
def _sha_from_stat(self, path, stat_result):
843
"""Get a sha digest from the tree's stat cache.
845
The default implementation assumes no stat cache is present.
847
:param path: The path.
848
:param stat_result: The stat result being looked up.
852
def _put_rio(self, filename, stanzas, header):
853
self._must_be_locked()
854
my_file = rio_file(stanzas, header)
855
self._control_files.put(filename, my_file)
857
@needs_write_lock # because merge pulls data into the branch.
858
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
860
"""Merge from a branch into this working tree.
862
:param branch: The branch to merge from.
863
:param to_revision: If non-None, the merge will merge to to_revision,
864
but not beyond it. to_revision does not need to be in the history
865
of the branch when it is supplied. If None, to_revision defaults to
866
branch.last_revision().
868
from bzrlib.merge import Merger, Merge3Merger
869
pb = bzrlib.ui.ui_factory.nested_progress_bar()
871
merger = Merger(self.branch, this_tree=self, pb=pb)
872
merger.pp = ProgressPhase("Merge phase", 5, pb)
873
merger.pp.next_phase()
874
# check that there are no
876
merger.check_basis(check_clean=True, require_commits=False)
877
if to_revision is None:
878
to_revision = _mod_revision.ensure_null(branch.last_revision())
879
merger.other_rev_id = to_revision
880
if _mod_revision.is_null(merger.other_rev_id):
881
raise errors.NoCommits(branch)
882
self.branch.fetch(branch, last_revision=merger.other_rev_id)
883
merger.other_basis = merger.other_rev_id
884
merger.other_tree = self.branch.repository.revision_tree(
886
merger.other_branch = branch
887
merger.pp.next_phase()
888
if from_revision is None:
891
merger.set_base_revision(from_revision, branch)
892
if merger.base_rev_id == merger.other_rev_id:
893
raise errors.PointlessMerge
894
merger.backup_files = False
895
if merge_type is None:
896
merger.merge_type = Merge3Merger
898
merger.merge_type = merge_type
899
merger.set_interesting_files(None)
900
merger.show_base = False
901
merger.reprocess = False
902
conflicts = merger.do_merge()
909
def merge_modified(self):
910
"""Return a dictionary of files modified by a merge.
912
The list is initialized by WorkingTree.set_merge_modified, which is
913
typically called after we make some automatic updates to the tree
916
This returns a map of file_id->sha1, containing only files which are
917
still in the working inventory and have that text hash.
920
hashfile = self._control_files.get('merge-hashes')
921
except errors.NoSuchFile:
925
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
926
raise errors.MergeModifiedFormatError()
927
except StopIteration:
928
raise errors.MergeModifiedFormatError()
929
for s in RioReader(hashfile):
930
# RioReader reads in Unicode, so convert file_ids back to utf8
931
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
932
if file_id not in self.inventory:
934
text_hash = s.get("hash")
935
if text_hash == self.get_file_sha1(file_id):
936
merge_hashes[file_id] = text_hash
940
def mkdir(self, path, file_id=None):
941
"""See MutableTree.mkdir()."""
943
file_id = generate_ids.gen_file_id(os.path.basename(path))
944
os.mkdir(self.abspath(path))
945
self.add(path, file_id, 'directory')
948
def get_symlink_target(self, file_id):
949
return os.readlink(self.id2abspath(file_id))
952
def subsume(self, other_tree):
953
def add_children(inventory, entry):
954
for child_entry in entry.children.values():
955
inventory._byid[child_entry.file_id] = child_entry
956
if child_entry.kind == 'directory':
957
add_children(inventory, child_entry)
958
if other_tree.get_root_id() == self.get_root_id():
959
raise errors.BadSubsumeSource(self, other_tree,
960
'Trees have the same root')
962
other_tree_path = self.relpath(other_tree.basedir)
963
except errors.PathNotChild:
964
raise errors.BadSubsumeSource(self, other_tree,
965
'Tree is not contained by the other')
966
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
967
if new_root_parent is None:
968
raise errors.BadSubsumeSource(self, other_tree,
969
'Parent directory is not versioned.')
970
# We need to ensure that the result of a fetch will have a
971
# versionedfile for the other_tree root, and only fetching into
972
# RepositoryKnit2 guarantees that.
973
if not self.branch.repository.supports_rich_root():
974
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
975
other_tree.lock_tree_write()
977
new_parents = other_tree.get_parent_ids()
978
other_root = other_tree.inventory.root
979
other_root.parent_id = new_root_parent
980
other_root.name = osutils.basename(other_tree_path)
981
self.inventory.add(other_root)
982
add_children(self.inventory, other_root)
983
self._write_inventory(self.inventory)
984
# normally we don't want to fetch whole repositories, but i think
985
# here we really do want to consolidate the whole thing.
986
for parent_id in other_tree.get_parent_ids():
987
self.branch.fetch(other_tree.branch, parent_id)
988
self.add_parent_tree_id(parent_id)
991
other_tree.bzrdir.retire_bzrdir()
993
def _directory_is_tree_reference(self, relpath):
994
# as a special case, if a directory contains control files then
995
# it's a tree reference, except that the root of the tree is not
996
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
997
# TODO: We could ask all the control formats whether they
998
# recognize this directory, but at the moment there's no cheap api
999
# to do that. Since we probably can only nest bzr checkouts and
1000
# they always use this name it's ok for now. -- mbp 20060306
1002
# FIXME: There is an unhandled case here of a subdirectory
1003
# containing .bzr but not a branch; that will probably blow up
1004
# when you try to commit it. It might happen if there is a
1005
# checkout in a subdirectory. This can be avoided by not adding
1008
@needs_tree_write_lock
1009
def extract(self, file_id, format=None):
1010
"""Extract a subtree from this tree.
1012
A new branch will be created, relative to the path for this tree.
1016
segments = osutils.splitpath(path)
1017
transport = self.branch.bzrdir.root_transport
1018
for name in segments:
1019
transport = transport.clone(name)
1020
transport.ensure_base()
1023
sub_path = self.id2path(file_id)
1024
branch_transport = mkdirs(sub_path)
1026
format = self.bzrdir.cloning_metadir()
1027
if not format._repository_format.rich_root_data:
1028
format = bzrdir.format_registry.make_bzrdir('rich-root')
1029
branch_transport.ensure_base()
1030
branch_bzrdir = format.initialize_on_transport(branch_transport)
1032
repo = branch_bzrdir.find_repository()
1033
except errors.NoRepositoryPresent:
1034
repo = branch_bzrdir.create_repository()
1035
assert repo.supports_rich_root()
1037
if not repo.supports_rich_root():
1038
raise errors.RootNotRich()
1039
new_branch = branch_bzrdir.create_branch()
1040
new_branch.pull(self.branch)
1041
for parent_id in self.get_parent_ids():
1042
new_branch.fetch(self.branch, parent_id)
1043
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1044
if tree_transport.base != branch_transport.base:
1045
tree_bzrdir = format.initialize_on_transport(tree_transport)
1046
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1048
tree_bzrdir = branch_bzrdir
1049
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1050
wt.set_parent_ids(self.get_parent_ids())
1051
my_inv = self.inventory
1052
child_inv = Inventory(root_id=None)
1053
new_root = my_inv[file_id]
1054
my_inv.remove_recursive_id(file_id)
1055
new_root.parent_id = None
1056
child_inv.add(new_root)
1057
self._write_inventory(my_inv)
1058
wt._write_inventory(child_inv)
1061
def _serialize(self, inventory, out_file):
1062
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1065
def _deserialize(selt, in_file):
1066
return xml5.serializer_v5.read_inventory(in_file)
1069
"""Write the in memory inventory to disk."""
1070
# TODO: Maybe this should only write on dirty ?
1071
if self._control_files._lock_mode != 'w':
1072
raise errors.NotWriteLocked(self)
1074
self._serialize(self._inventory, sio)
1076
self._control_files.put('inventory', sio)
1077
self._inventory_is_modified = False
1079
def _kind(self, relpath):
1080
return osutils.file_kind(self.abspath(relpath))
1082
def list_files(self, include_root=False):
1083
"""Recursively list all files as (path, class, kind, id, entry).
1085
Lists, but does not descend into unversioned directories.
1087
This does not include files that have been deleted in this
1090
Skips the control directory.
1092
# list_files is an iterator, so @needs_read_lock doesn't work properly
1093
# with it. So callers should be careful to always read_lock the tree.
1094
if not self.is_locked():
1095
raise errors.ObjectNotLocked(self)
1097
inv = self.inventory
1098
if include_root is True:
1099
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1100
# Convert these into local objects to save lookup times
1101
pathjoin = osutils.pathjoin
1102
file_kind = self._kind
1104
# transport.base ends in a slash, we want the piece
1105
# between the last two slashes
1106
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1108
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1110
# directory file_id, relative path, absolute path, reverse sorted children
1111
children = os.listdir(self.basedir)
1113
# jam 20060527 The kernel sized tree seems equivalent whether we
1114
# use a deque and popleft to keep them sorted, or if we use a plain
1115
# list and just reverse() them.
1116
children = collections.deque(children)
1117
stack = [(inv.root.file_id, u'', self.basedir, children)]
1119
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1122
f = children.popleft()
1123
## TODO: If we find a subdirectory with its own .bzr
1124
## directory, then that is a separate tree and we
1125
## should exclude it.
1127
# the bzrdir for this tree
1128
if transport_base_dir == f:
1131
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1132
# and 'f' doesn't begin with one, we can do a string op, rather
1133
# than the checks of pathjoin(), all relative paths will have an extra slash
1135
fp = from_dir_relpath + '/' + f
1138
fap = from_dir_abspath + '/' + f
1140
f_ie = inv.get_child(from_dir_id, f)
1143
elif self.is_ignored(fp[1:]):
1146
# we may not have found this file, because of a unicode issue
1147
f_norm, can_access = osutils.normalized_filename(f)
1148
if f == f_norm or not can_access:
1149
# No change, so treat this file normally
1152
# this file can be accessed by a normalized path
1153
# check again if it is versioned
1154
# these lines are repeated here for performance
1156
fp = from_dir_relpath + '/' + f
1157
fap = from_dir_abspath + '/' + f
1158
f_ie = inv.get_child(from_dir_id, f)
1161
elif self.is_ignored(fp[1:]):
1168
# make a last minute entry
1170
yield fp[1:], c, fk, f_ie.file_id, f_ie
1173
yield fp[1:], c, fk, None, fk_entries[fk]()
1175
yield fp[1:], c, fk, None, TreeEntry()
1178
if fk != 'directory':
1181
# But do this child first
1182
new_children = os.listdir(fap)
1184
new_children = collections.deque(new_children)
1185
stack.append((f_ie.file_id, fp, fap, new_children))
1186
# Break out of inner loop,
1187
# so that we start outer loop with child
1190
# if we finished all children, pop it off the stack
1193
@needs_tree_write_lock
1194
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1197
to_dir must exist in the inventory.
1199
If to_dir exists and is a directory, the files are moved into
1200
it, keeping their old names.
1202
Note that to_dir is only the last component of the new name;
1203
this doesn't change the directory.
1205
For each entry in from_paths the move mode will be determined
1208
The first mode moves the file in the filesystem and updates the
1209
inventory. The second mode only updates the inventory without
1210
touching the file on the filesystem. This is the new mode introduced
1213
move uses the second mode if 'after == True' and the target is not
1214
versioned but present in the working tree.
1216
move uses the second mode if 'after == False' and the source is
1217
versioned but no longer in the working tree, and the target is not
1218
versioned but present in the working tree.
1220
move uses the first mode if 'after == False' and the source is
1221
versioned and present in the working tree, and the target is not
1222
versioned and not present in the working tree.
1224
Everything else results in an error.
1226
This returns a list of (from_path, to_path) pairs for each
1227
entry that is moved.
1232
# check for deprecated use of signature
1234
to_dir = kwargs.get('to_name', None)
1236
raise TypeError('You must supply a target directory')
1238
symbol_versioning.warn('The parameter to_name was deprecated'
1239
' in version 0.13. Use to_dir instead',
1242
# check destination directory
1243
assert not isinstance(from_paths, basestring)
1244
inv = self.inventory
1245
to_abs = self.abspath(to_dir)
1246
if not isdir(to_abs):
1247
raise errors.BzrMoveFailedError('',to_dir,
1248
errors.NotADirectory(to_abs))
1249
if not self.has_filename(to_dir):
1250
raise errors.BzrMoveFailedError('',to_dir,
1251
errors.NotInWorkingDirectory(to_dir))
1252
to_dir_id = inv.path2id(to_dir)
1253
if to_dir_id is None:
1254
raise errors.BzrMoveFailedError('',to_dir,
1255
errors.NotVersionedError(path=str(to_dir)))
1257
to_dir_ie = inv[to_dir_id]
1258
if to_dir_ie.kind != 'directory':
1259
raise errors.BzrMoveFailedError('',to_dir,
1260
errors.NotADirectory(to_abs))
1262
# create rename entries and tuples
1263
for from_rel in from_paths:
1264
from_tail = splitpath(from_rel)[-1]
1265
from_id = inv.path2id(from_rel)
1267
raise errors.BzrMoveFailedError(from_rel,to_dir,
1268
errors.NotVersionedError(path=str(from_rel)))
1270
from_entry = inv[from_id]
1271
from_parent_id = from_entry.parent_id
1272
to_rel = pathjoin(to_dir, from_tail)
1273
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1275
from_tail=from_tail,
1276
from_parent_id=from_parent_id,
1277
to_rel=to_rel, to_tail=from_tail,
1278
to_parent_id=to_dir_id)
1279
rename_entries.append(rename_entry)
1280
rename_tuples.append((from_rel, to_rel))
1282
# determine which move mode to use. checks also for movability
1283
rename_entries = self._determine_mv_mode(rename_entries, after)
1285
original_modified = self._inventory_is_modified
1288
self._inventory_is_modified = True
1289
self._move(rename_entries)
1291
# restore the inventory on error
1292
self._inventory_is_modified = original_modified
1294
self._write_inventory(inv)
1295
return rename_tuples
1297
def _determine_mv_mode(self, rename_entries, after=False):
1298
"""Determines for each from-to pair if both inventory and working tree
1299
or only the inventory has to be changed.
1301
Also does basic plausability tests.
1303
inv = self.inventory
1305
for rename_entry in rename_entries:
1306
# store to local variables for easier reference
1307
from_rel = rename_entry.from_rel
1308
from_id = rename_entry.from_id
1309
to_rel = rename_entry.to_rel
1310
to_id = inv.path2id(to_rel)
1311
only_change_inv = False
1313
# check the inventory for source and destination
1315
raise errors.BzrMoveFailedError(from_rel,to_rel,
1316
errors.NotVersionedError(path=str(from_rel)))
1317
if to_id is not None:
1318
raise errors.BzrMoveFailedError(from_rel,to_rel,
1319
errors.AlreadyVersionedError(path=str(to_rel)))
1321
# try to determine the mode for rename (only change inv or change
1322
# inv and file system)
1324
if not self.has_filename(to_rel):
1325
raise errors.BzrMoveFailedError(from_id,to_rel,
1326
errors.NoSuchFile(path=str(to_rel),
1327
extra="New file has not been created yet"))
1328
only_change_inv = True
1329
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1330
only_change_inv = True
1331
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1332
only_change_inv = False
1333
elif (sys.platform == 'win32'
1334
and from_rel.lower() == to_rel.lower()
1335
and self.has_filename(from_rel)):
1336
only_change_inv = False
1338
# something is wrong, so lets determine what exactly
1339
if not self.has_filename(from_rel) and \
1340
not self.has_filename(to_rel):
1341
raise errors.BzrRenameFailedError(from_rel,to_rel,
1342
errors.PathsDoNotExist(paths=(str(from_rel),
1345
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1346
rename_entry.only_change_inv = only_change_inv
1347
return rename_entries
1349
def _move(self, rename_entries):
1350
"""Moves a list of files.
1352
Depending on the value of the flag 'only_change_inv', the
1353
file will be moved on the file system or not.
1355
inv = self.inventory
1358
for entry in rename_entries:
1360
self._move_entry(entry)
1362
self._rollback_move(moved)
1366
def _rollback_move(self, moved):
1367
"""Try to rollback a previous move in case of an filesystem error."""
1368
inv = self.inventory
1371
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1372
entry.to_tail, entry.to_parent_id, entry.from_rel,
1373
entry.from_tail, entry.from_parent_id,
1374
entry.only_change_inv))
1375
except errors.BzrMoveFailedError, e:
1376
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1377
" The working tree is in an inconsistent state."
1378
" Please consider doing a 'bzr revert'."
1379
" Error message is: %s" % e)
1381
def _move_entry(self, entry):
1382
inv = self.inventory
1383
from_rel_abs = self.abspath(entry.from_rel)
1384
to_rel_abs = self.abspath(entry.to_rel)
1385
if from_rel_abs == to_rel_abs:
1386
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1387
"Source and target are identical.")
1389
if not entry.only_change_inv:
1391
osutils.rename(from_rel_abs, to_rel_abs)
1393
raise errors.BzrMoveFailedError(entry.from_rel,
1395
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1397
@needs_tree_write_lock
1398
def rename_one(self, from_rel, to_rel, after=False):
1401
This can change the directory or the filename or both.
1403
rename_one has several 'modes' to work. First, it can rename a physical
1404
file and change the file_id. That is the normal mode. Second, it can
1405
only change the file_id without touching any physical file. This is
1406
the new mode introduced in version 0.15.
1408
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1409
versioned but present in the working tree.
1411
rename_one uses the second mode if 'after == False' and 'from_rel' is
1412
versioned but no longer in the working tree, and 'to_rel' is not
1413
versioned but present in the working tree.
1415
rename_one uses the first mode if 'after == False' and 'from_rel' is
1416
versioned and present in the working tree, and 'to_rel' is not
1417
versioned and not present in the working tree.
1419
Everything else results in an error.
1421
inv = self.inventory
1424
# create rename entries and tuples
1425
from_tail = splitpath(from_rel)[-1]
1426
from_id = inv.path2id(from_rel)
1428
raise errors.BzrRenameFailedError(from_rel,to_rel,
1429
errors.NotVersionedError(path=str(from_rel)))
1430
from_entry = inv[from_id]
1431
from_parent_id = from_entry.parent_id
1432
to_dir, to_tail = os.path.split(to_rel)
1433
to_dir_id = inv.path2id(to_dir)
1434
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1436
from_tail=from_tail,
1437
from_parent_id=from_parent_id,
1438
to_rel=to_rel, to_tail=to_tail,
1439
to_parent_id=to_dir_id)
1440
rename_entries.append(rename_entry)
1442
# determine which move mode to use. checks also for movability
1443
rename_entries = self._determine_mv_mode(rename_entries, after)
1445
# check if the target changed directory and if the target directory is
1447
if to_dir_id is None:
1448
raise errors.BzrMoveFailedError(from_rel,to_rel,
1449
errors.NotVersionedError(path=str(to_dir)))
1451
# all checks done. now we can continue with our actual work
1452
mutter('rename_one:\n'
1457
' to_dir_id {%s}\n',
1458
from_id, from_rel, to_rel, to_dir, to_dir_id)
1460
self._move(rename_entries)
1461
self._write_inventory(inv)
1463
class _RenameEntry(object):
1464
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1465
to_rel, to_tail, to_parent_id, only_change_inv=False):
1466
self.from_rel = from_rel
1467
self.from_id = from_id
1468
self.from_tail = from_tail
1469
self.from_parent_id = from_parent_id
1470
self.to_rel = to_rel
1471
self.to_tail = to_tail
1472
self.to_parent_id = to_parent_id
1473
self.only_change_inv = only_change_inv
1477
"""Return all unknown files.
1479
These are files in the working directory that are not versioned or
1480
control files or ignored.
1482
# force the extras method to be fully executed before returning, to
1483
# prevent race conditions with the lock
1485
[subp for subp in self.extras() if not self.is_ignored(subp)])
1487
@needs_tree_write_lock
1488
def unversion(self, file_ids):
1489
"""Remove the file ids in file_ids from the current versioned set.
1491
When a file_id is unversioned, all of its children are automatically
1494
:param file_ids: The file ids to stop versioning.
1495
:raises: NoSuchId if any fileid is not currently versioned.
1497
for file_id in file_ids:
1498
if self._inventory.has_id(file_id):
1499
self._inventory.remove_recursive_id(file_id)
1501
raise errors.NoSuchId(self, file_id)
1503
# in the future this should just set a dirty bit to wait for the
1504
# final unlock. However, until all methods of workingtree start
1505
# with the current in -memory inventory rather than triggering
1506
# a read, it is more complex - we need to teach read_inventory
1507
# to know when to read, and when to not read first... and possibly
1508
# to save first when the in memory one may be corrupted.
1509
# so for now, we just only write it if it is indeed dirty.
1511
self._write_inventory(self._inventory)
1513
@deprecated_method(zero_eight)
1514
def iter_conflicts(self):
1515
"""List all files in the tree that have text or content conflicts.
1516
DEPRECATED. Use conflicts instead."""
1517
return self._iter_conflicts()
1519
def _iter_conflicts(self):
1521
for info in self.list_files():
1523
stem = get_conflicted_stem(path)
1526
if stem not in conflicted:
1527
conflicted.add(stem)
1531
def pull(self, source, overwrite=False, stop_revision=None,
1532
change_reporter=None, possible_transports=None):
1533
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1536
pp = ProgressPhase("Pull phase", 2, top_pb)
1538
old_revision_info = self.branch.last_revision_info()
1539
basis_tree = self.basis_tree()
1540
count = self.branch.pull(source, overwrite, stop_revision,
1541
possible_transports=possible_transports)
1542
new_revision_info = self.branch.last_revision_info()
1543
if new_revision_info != old_revision_info:
1545
repository = self.branch.repository
1546
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1547
basis_tree.lock_read()
1549
new_basis_tree = self.branch.basis_tree()
1556
change_reporter=change_reporter)
1557
if (basis_tree.inventory.root is None and
1558
new_basis_tree.inventory.root is not None):
1559
self.set_root_id(new_basis_tree.get_root_id())
1563
# TODO - dedup parents list with things merged by pull ?
1564
# reuse the revisiontree we merged against to set the new
1566
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1567
# we have to pull the merge trees out again, because
1568
# merge_inner has set the ids. - this corner is not yet
1569
# layered well enough to prevent double handling.
1570
# XXX TODO: Fix the double handling: telling the tree about
1571
# the already known parent data is wasteful.
1572
merges = self.get_parent_ids()[1:]
1573
parent_trees.extend([
1574
(parent, repository.revision_tree(parent)) for
1576
self.set_parent_trees(parent_trees)
1583
def put_file_bytes_non_atomic(self, file_id, bytes):
1584
"""See MutableTree.put_file_bytes_non_atomic."""
1585
stream = file(self.id2abspath(file_id), 'wb')
1590
# TODO: update the hashcache here ?
1593
"""Yield all unversioned files in this WorkingTree.
1595
If there are any unversioned directories then only the directory is
1596
returned, not all its children. But if there are unversioned files
1597
under a versioned subdirectory, they are returned.
1599
Currently returned depth-first, sorted by name within directories.
1600
This is the same order used by 'osutils.walkdirs'.
1602
## TODO: Work from given directory downwards
1603
for path, dir_entry in self.inventory.directories():
1604
# mutter("search for unknowns in %r", path)
1605
dirabs = self.abspath(path)
1606
if not isdir(dirabs):
1607
# e.g. directory deleted
1611
for subf in os.listdir(dirabs):
1614
if subf not in dir_entry.children:
1615
subf_norm, can_access = osutils.normalized_filename(subf)
1616
if subf_norm != subf and can_access:
1617
if subf_norm not in dir_entry.children:
1618
fl.append(subf_norm)
1624
subp = pathjoin(path, subf)
1627
def ignored_files(self):
1628
"""Yield list of PATH, IGNORE_PATTERN"""
1629
for subp in self.extras():
1630
pat = self.is_ignored(subp)
1634
def get_ignore_list(self):
1635
"""Return list of ignore patterns.
1637
Cached in the Tree object after the first call.
1639
ignoreset = getattr(self, '_ignoreset', None)
1640
if ignoreset is not None:
1643
ignore_globs = set()
1644
ignore_globs.update(ignores.get_runtime_ignores())
1645
ignore_globs.update(ignores.get_user_ignores())
1646
if self.has_filename(bzrlib.IGNORE_FILENAME):
1647
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1649
ignore_globs.update(ignores.parse_ignore_file(f))
1652
self._ignoreset = ignore_globs
1655
def _flush_ignore_list_cache(self):
1656
"""Resets the cached ignore list to force a cache rebuild."""
1657
self._ignoreset = None
1658
self._ignoreglobster = None
1660
def is_ignored(self, filename):
1661
r"""Check whether the filename matches an ignore pattern.
1663
Patterns containing '/' or '\' need to match the whole path;
1664
others match against only the last component.
1666
If the file is ignored, returns the pattern which caused it to
1667
be ignored, otherwise None. So this can simply be used as a
1668
boolean if desired."""
1669
if getattr(self, '_ignoreglobster', None) is None:
1670
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1671
return self._ignoreglobster.match(filename)
1673
def kind(self, file_id):
1674
return file_kind(self.id2abspath(file_id))
1676
def _comparison_data(self, entry, path):
1677
abspath = self.abspath(path)
1679
stat_value = os.lstat(abspath)
1681
if getattr(e, 'errno', None) == errno.ENOENT:
1688
mode = stat_value.st_mode
1689
kind = osutils.file_kind_from_stat_mode(mode)
1690
if not supports_executable():
1691
executable = entry is not None and entry.executable
1693
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1694
return kind, executable, stat_value
1696
def _file_size(self, entry, stat_value):
1697
return stat_value.st_size
1699
def last_revision(self):
1700
"""Return the last revision of the branch for this tree.
1702
This format tree does not support a separate marker for last-revision
1703
compared to the branch.
1705
See MutableTree.last_revision
1707
return self._last_revision()
1710
def _last_revision(self):
1711
"""helper for get_parent_ids."""
1712
return _mod_revision.ensure_null(self.branch.last_revision())
1714
def is_locked(self):
1715
return self._control_files.is_locked()
1717
def _must_be_locked(self):
1718
if not self.is_locked():
1719
raise errors.ObjectNotLocked(self)
1721
def lock_read(self):
1722
"""See Branch.lock_read, and WorkingTree.unlock."""
1723
if not self.is_locked():
1725
self.branch.lock_read()
1727
return self._control_files.lock_read()
1729
self.branch.unlock()
1732
def lock_tree_write(self):
1733
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1734
if not self.is_locked():
1736
self.branch.lock_read()
1738
return self._control_files.lock_write()
1740
self.branch.unlock()
1743
def lock_write(self):
1744
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1745
if not self.is_locked():
1747
self.branch.lock_write()
1749
return self._control_files.lock_write()
1751
self.branch.unlock()
1754
def get_physical_lock_status(self):
1755
return self._control_files.get_physical_lock_status()
1757
def _basis_inventory_name(self):
1758
return 'basis-inventory-cache'
1760
def _reset_data(self):
1761
"""Reset transient data that cannot be revalidated."""
1762
self._inventory_is_modified = False
1763
result = self._deserialize(self._control_files.get('inventory'))
1764
self._set_inventory(result, dirty=False)
1766
@needs_tree_write_lock
1767
def set_last_revision(self, new_revision):
1768
"""Change the last revision in the working tree."""
1769
if self._change_last_revision(new_revision):
1770
self._cache_basis_inventory(new_revision)
1772
def _change_last_revision(self, new_revision):
1773
"""Template method part of set_last_revision to perform the change.
1775
This is used to allow WorkingTree3 instances to not affect branch
1776
when their last revision is set.
1778
if _mod_revision.is_null(new_revision):
1779
self.branch.set_revision_history([])
1782
self.branch.generate_revision_history(new_revision)
1783
except errors.NoSuchRevision:
1784
# not present in the repo - dont try to set it deeper than the tip
1785
self.branch.set_revision_history([new_revision])
1788
def _write_basis_inventory(self, xml):
1789
"""Write the basis inventory XML to the basis-inventory file"""
1790
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1791
path = self._basis_inventory_name()
1793
self._control_files.put(path, sio)
1795
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1796
"""Create the text that will be saved in basis-inventory"""
1797
inventory.revision_id = revision_id
1798
return xml7.serializer_v7.write_inventory_to_string(inventory)
1800
def _cache_basis_inventory(self, new_revision):
1801
"""Cache new_revision as the basis inventory."""
1802
# TODO: this should allow the ready-to-use inventory to be passed in,
1803
# as commit already has that ready-to-use [while the format is the
1806
# this double handles the inventory - unpack and repack -
1807
# but is easier to understand. We can/should put a conditional
1808
# in here based on whether the inventory is in the latest format
1809
# - perhaps we should repack all inventories on a repository
1811
# the fast path is to copy the raw xml from the repository. If the
1812
# xml contains 'revision_id="', then we assume the right
1813
# revision_id is set. We must check for this full string, because a
1814
# root node id can legitimately look like 'revision_id' but cannot
1816
xml = self.branch.repository.get_inventory_xml(new_revision)
1817
firstline = xml.split('\n', 1)[0]
1818
if (not 'revision_id="' in firstline or
1819
'format="7"' not in firstline):
1820
inv = self.branch.repository.deserialise_inventory(
1822
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1823
self._write_basis_inventory(xml)
1824
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1827
def read_basis_inventory(self):
1828
"""Read the cached basis inventory."""
1829
path = self._basis_inventory_name()
1830
return self._control_files.get(path).read()
1833
def read_working_inventory(self):
1834
"""Read the working inventory.
1836
:raises errors.InventoryModified: read_working_inventory will fail
1837
when the current in memory inventory has been modified.
1839
# conceptually this should be an implementation detail of the tree.
1840
# XXX: Deprecate this.
1841
# ElementTree does its own conversion from UTF-8, so open in
1843
if self._inventory_is_modified:
1844
raise errors.InventoryModified(self)
1845
result = self._deserialize(self._control_files.get('inventory'))
1846
self._set_inventory(result, dirty=False)
1849
@needs_tree_write_lock
1850
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1852
"""Remove nominated files from the working inventory.
1854
:files: File paths relative to the basedir.
1855
:keep_files: If true, the files will also be kept.
1856
:force: Delete files and directories, even if they are changed and
1857
even if the directories are not empty.
1859
if isinstance(files, basestring):
1865
unknown_nested_files=set()
1867
def recurse_directory_to_add_files(directory):
1868
# Recurse directory and add all files
1869
# so we can check if they have changed.
1870
for parent_info, file_infos in\
1871
osutils.walkdirs(self.abspath(directory),
1873
for relpath, basename, kind, lstat, abspath in file_infos:
1874
# Is it versioned or ignored?
1875
if self.path2id(relpath) or self.is_ignored(relpath):
1876
# Add nested content for deletion.
1877
new_files.add(relpath)
1879
# Files which are not versioned and not ignored
1880
# should be treated as unknown.
1881
unknown_nested_files.add((relpath, None, kind))
1883
for filename in files:
1884
# Get file name into canonical form.
1885
abspath = self.abspath(filename)
1886
filename = self.relpath(abspath)
1887
if len(filename) > 0:
1888
new_files.add(filename)
1889
if osutils.isdir(abspath):
1890
recurse_directory_to_add_files(filename)
1892
files = list(new_files)
1895
return # nothing to do
1897
# Sort needed to first handle directory content before the directory
1898
files.sort(reverse=True)
1900
# Bail out if we are going to delete files we shouldn't
1901
if not keep_files and not force:
1902
has_changed_files = len(unknown_nested_files) > 0
1903
if not has_changed_files:
1904
for (file_id, path, content_change, versioned, parent_id, name,
1905
kind, executable) in self._iter_changes(self.basis_tree(),
1906
include_unchanged=True, require_versioned=False,
1907
want_unversioned=True, specific_files=files):
1908
if versioned == (False, False):
1909
# The record is unknown ...
1910
if not self.is_ignored(path[1]):
1911
# ... but not ignored
1912
has_changed_files = True
1914
elif content_change and (kind[1] != None):
1915
# Versioned and changed, but not deleted
1916
has_changed_files = True
1919
if has_changed_files:
1920
# Make delta show ALL applicable changes in error message.
1921
tree_delta = self.changes_from(self.basis_tree(),
1922
require_versioned=False, want_unversioned=True,
1923
specific_files=files)
1924
for unknown_file in unknown_nested_files:
1925
if unknown_file not in tree_delta.unversioned:
1926
tree_delta.unversioned.extend((unknown_file,))
1927
raise errors.BzrRemoveChangedFilesError(tree_delta)
1929
# Build inv_delta and delete files where applicaple,
1930
# do this before any modifications to inventory.
1932
fid = self.path2id(f)
1935
message = "%s is not versioned." % (f,)
1938
# having removed it, it must be either ignored or unknown
1939
if self.is_ignored(f):
1943
textui.show_status(new_status, self.kind(fid), f,
1946
inv_delta.append((f, None, fid, None))
1947
message = "removed %s" % (f,)
1950
abs_path = self.abspath(f)
1951
if osutils.lexists(abs_path):
1952
if (osutils.isdir(abs_path) and
1953
len(os.listdir(abs_path)) > 0):
1955
osutils.rmtree(abs_path)
1957
message = "%s is not an empty directory "\
1958
"and won't be deleted." % (f,)
1960
osutils.delete_any(abs_path)
1961
message = "deleted %s" % (f,)
1962
elif message is not None:
1963
# Only care if we haven't done anything yet.
1964
message = "%s does not exist." % (f,)
1966
# Print only one message (if any) per file.
1967
if message is not None:
1969
self.apply_inventory_delta(inv_delta)
1971
@needs_tree_write_lock
1972
def revert(self, filenames=None, old_tree=None, backups=True,
1973
pb=DummyProgress(), report_changes=False):
1974
from bzrlib.conflicts import resolve
1977
symbol_versioning.warn('Using [] to revert all files is deprecated'
1978
' as of bzr 0.91. Please use None (the default) instead.',
1979
DeprecationWarning, stacklevel=2)
1980
if old_tree is None:
1981
basis_tree = self.basis_tree()
1982
basis_tree.lock_read()
1983
old_tree = basis_tree
1987
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1989
if filenames is None and len(self.get_parent_ids()) > 1:
1991
last_revision = self.last_revision()
1992
if last_revision != NULL_REVISION:
1993
if basis_tree is None:
1994
basis_tree = self.basis_tree()
1995
basis_tree.lock_read()
1996
parent_trees.append((last_revision, basis_tree))
1997
self.set_parent_trees(parent_trees)
2000
resolve(self, filenames, ignore_misses=True, recursive=True)
2002
if basis_tree is not None:
2006
def revision_tree(self, revision_id):
2007
"""See Tree.revision_tree.
2009
WorkingTree can supply revision_trees for the basis revision only
2010
because there is only one cached inventory in the bzr directory.
2012
if revision_id == self.last_revision():
2014
xml = self.read_basis_inventory()
2015
except errors.NoSuchFile:
2019
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2020
# dont use the repository revision_tree api because we want
2021
# to supply the inventory.
2022
if inv.revision_id == revision_id:
2023
return revisiontree.RevisionTree(self.branch.repository,
2025
except errors.BadInventoryFormat:
2027
# raise if there was no inventory, or if we read the wrong inventory.
2028
raise errors.NoSuchRevisionInTree(self, revision_id)
2030
# XXX: This method should be deprecated in favour of taking in a proper
2031
# new Inventory object.
2032
@needs_tree_write_lock
2033
def set_inventory(self, new_inventory_list):
2034
from bzrlib.inventory import (Inventory,
2039
inv = Inventory(self.get_root_id())
2040
for path, file_id, parent, kind in new_inventory_list:
2041
name = os.path.basename(path)
2044
# fixme, there should be a factory function inv,add_??
2045
if kind == 'directory':
2046
inv.add(InventoryDirectory(file_id, name, parent))
2047
elif kind == 'file':
2048
inv.add(InventoryFile(file_id, name, parent))
2049
elif kind == 'symlink':
2050
inv.add(InventoryLink(file_id, name, parent))
2052
raise errors.BzrError("unknown kind %r" % kind)
2053
self._write_inventory(inv)
2055
@needs_tree_write_lock
2056
def set_root_id(self, file_id):
2057
"""Set the root id for this tree."""
2060
symbol_versioning.warn(symbol_versioning.zero_twelve
2061
% 'WorkingTree.set_root_id with fileid=None',
2066
file_id = osutils.safe_file_id(file_id)
2067
self._set_root_id(file_id)
2069
def _set_root_id(self, file_id):
2070
"""Set the root id for this tree, in a format specific manner.
2072
:param file_id: The file id to assign to the root. It must not be
2073
present in the current inventory or an error will occur. It must
2074
not be None, but rather a valid file id.
2076
inv = self._inventory
2077
orig_root_id = inv.root.file_id
2078
# TODO: it might be nice to exit early if there was nothing
2079
# to do, saving us from trigger a sync on unlock.
2080
self._inventory_is_modified = True
2081
# we preserve the root inventory entry object, but
2082
# unlinkit from the byid index
2083
del inv._byid[inv.root.file_id]
2084
inv.root.file_id = file_id
2085
# and link it into the index with the new changed id.
2086
inv._byid[inv.root.file_id] = inv.root
2087
# and finally update all children to reference the new id.
2088
# XXX: this should be safe to just look at the root.children
2089
# list, not the WHOLE INVENTORY.
2092
if entry.parent_id == orig_root_id:
2093
entry.parent_id = inv.root.file_id
2096
"""See Branch.unlock.
2098
WorkingTree locking just uses the Branch locking facilities.
2099
This is current because all working trees have an embedded branch
2100
within them. IF in the future, we were to make branch data shareable
2101
between multiple working trees, i.e. via shared storage, then we
2102
would probably want to lock both the local tree, and the branch.
2104
raise NotImplementedError(self.unlock)
2106
def update(self, change_reporter=None, possible_transports=None):
2107
"""Update a working tree along its branch.
2109
This will update the branch if its bound too, which means we have
2110
multiple trees involved:
2112
- The new basis tree of the master.
2113
- The old basis tree of the branch.
2114
- The old basis tree of the working tree.
2115
- The current working tree state.
2117
Pathologically, all three may be different, and non-ancestors of each
2118
other. Conceptually we want to:
2120
- Preserve the wt.basis->wt.state changes
2121
- Transform the wt.basis to the new master basis.
2122
- Apply a merge of the old branch basis to get any 'local' changes from
2124
- Restore the wt.basis->wt.state changes.
2126
There isn't a single operation at the moment to do that, so we:
2127
- Merge current state -> basis tree of the master w.r.t. the old tree
2129
- Do a 'normal' merge of the old branch basis if it is relevant.
2131
if self.branch.get_master_branch(possible_transports) is not None:
2133
update_branch = True
2135
self.lock_tree_write()
2136
update_branch = False
2139
old_tip = self.branch.update(possible_transports)
2142
return self._update_tree(old_tip, change_reporter)
2146
@needs_tree_write_lock
2147
def _update_tree(self, old_tip=None, change_reporter=None):
2148
"""Update a tree to the master branch.
2150
:param old_tip: if supplied, the previous tip revision the branch,
2151
before it was changed to the master branch's tip.
2153
# here if old_tip is not None, it is the old tip of the branch before
2154
# it was updated from the master branch. This should become a pending
2155
# merge in the working tree to preserve the user existing work. we
2156
# cant set that until we update the working trees last revision to be
2157
# one from the new branch, because it will just get absorbed by the
2158
# parent de-duplication logic.
2160
# We MUST save it even if an error occurs, because otherwise the users
2161
# local work is unreferenced and will appear to have been lost.
2165
last_rev = self.get_parent_ids()[0]
2167
last_rev = _mod_revision.NULL_REVISION
2168
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2169
# merge tree state up to new branch tip.
2170
basis = self.basis_tree()
2173
to_tree = self.branch.basis_tree()
2174
if basis.inventory.root is None:
2175
self.set_root_id(to_tree.get_root_id())
2177
result += merge.merge_inner(
2182
change_reporter=change_reporter)
2185
# TODO - dedup parents list with things merged by pull ?
2186
# reuse the tree we've updated to to set the basis:
2187
parent_trees = [(self.branch.last_revision(), to_tree)]
2188
merges = self.get_parent_ids()[1:]
2189
# Ideally we ask the tree for the trees here, that way the working
2190
# tree can decide whether to give us teh entire tree or give us a
2191
# lazy initialised tree. dirstate for instance will have the trees
2192
# in ram already, whereas a last-revision + basis-inventory tree
2193
# will not, but also does not need them when setting parents.
2194
for parent in merges:
2195
parent_trees.append(
2196
(parent, self.branch.repository.revision_tree(parent)))
2197
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2198
parent_trees.append(
2199
(old_tip, self.branch.repository.revision_tree(old_tip)))
2200
self.set_parent_trees(parent_trees)
2201
last_rev = parent_trees[0][0]
2203
# the working tree had the same last-revision as the master
2204
# branch did. We may still have pivot local work from the local
2205
# branch into old_tip:
2206
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2207
self.add_parent_tree_id(old_tip)
2208
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2209
and old_tip != last_rev):
2210
# our last revision was not the prior branch last revision
2211
# and we have converted that last revision to a pending merge.
2212
# base is somewhere between the branch tip now
2213
# and the now pending merge
2215
# Since we just modified the working tree and inventory, flush out
2216
# the current state, before we modify it again.
2217
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2218
# requires it only because TreeTransform directly munges the
2219
# inventory and calls tree._write_inventory(). Ultimately we
2220
# should be able to remove this extra flush.
2222
graph = self.branch.repository.get_graph()
2223
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2225
base_tree = self.branch.repository.revision_tree(base_rev_id)
2226
other_tree = self.branch.repository.revision_tree(old_tip)
2227
result += merge.merge_inner(
2232
change_reporter=change_reporter)
2235
def _write_hashcache_if_dirty(self):
2236
"""Write out the hashcache if it is dirty."""
2237
if self._hashcache.needs_write:
2239
self._hashcache.write()
2241
if e.errno not in (errno.EPERM, errno.EACCES):
2243
# TODO: jam 20061219 Should this be a warning? A single line
2244
# warning might be sufficient to let the user know what
2246
mutter('Could not write hashcache for %s\nError: %s',
2247
self._hashcache.cache_file_name(), e)
2249
@needs_tree_write_lock
2250
def _write_inventory(self, inv):
2251
"""Write inventory as the current inventory."""
2252
self._set_inventory(inv, dirty=True)
2255
def set_conflicts(self, arg):
2256
raise errors.UnsupportedOperation(self.set_conflicts, self)
2258
def add_conflicts(self, arg):
2259
raise errors.UnsupportedOperation(self.add_conflicts, self)
2262
def conflicts(self):
2263
conflicts = _mod_conflicts.ConflictList()
2264
for conflicted in self._iter_conflicts():
2267
if file_kind(self.abspath(conflicted)) != "file":
2269
except errors.NoSuchFile:
2272
for suffix in ('.THIS', '.OTHER'):
2274
kind = file_kind(self.abspath(conflicted+suffix))
2277
except errors.NoSuchFile:
2281
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2282
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2284
file_id=self.path2id(conflicted)))
2287
def walkdirs(self, prefix=""):
2288
"""Walk the directories of this tree.
2290
returns a generator which yields items in the form:
2291
((curren_directory_path, fileid),
2292
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2295
This API returns a generator, which is only valid during the current
2296
tree transaction - within a single lock_read or lock_write duration.
2298
If the tree is not locked, it may cause an error to be raised,
2299
depending on the tree implementation.
2301
disk_top = self.abspath(prefix)
2302
if disk_top.endswith('/'):
2303
disk_top = disk_top[:-1]
2304
top_strip_len = len(disk_top) + 1
2305
inventory_iterator = self._walkdirs(prefix)
2306
disk_iterator = osutils.walkdirs(disk_top, prefix)
2308
current_disk = disk_iterator.next()
2309
disk_finished = False
2311
if not (e.errno == errno.ENOENT or
2312
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2315
disk_finished = True
2317
current_inv = inventory_iterator.next()
2318
inv_finished = False
2319
except StopIteration:
2322
while not inv_finished or not disk_finished:
2324
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2325
cur_disk_dir_content) = current_disk
2327
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2328
cur_disk_dir_content) = ((None, None), None)
2329
if not disk_finished:
2330
# strip out .bzr dirs
2331
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2332
len(cur_disk_dir_content) > 0):
2333
# osutils.walkdirs can be made nicer -
2334
# yield the path-from-prefix rather than the pathjoined
2336
bzrdir_loc = bisect_left(cur_disk_dir_content,
2338
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2339
# we dont yield the contents of, or, .bzr itself.
2340
del cur_disk_dir_content[bzrdir_loc]
2342
# everything is unknown
2345
# everything is missing
2348
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2350
# disk is before inventory - unknown
2351
dirblock = [(relpath, basename, kind, stat, None, None) for
2352
relpath, basename, kind, stat, top_path in
2353
cur_disk_dir_content]
2354
yield (cur_disk_dir_relpath, None), dirblock
2356
current_disk = disk_iterator.next()
2357
except StopIteration:
2358
disk_finished = True
2360
# inventory is before disk - missing.
2361
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2362
for relpath, basename, dkind, stat, fileid, kind in
2364
yield (current_inv[0][0], current_inv[0][1]), dirblock
2366
current_inv = inventory_iterator.next()
2367
except StopIteration:
2370
# versioned present directory
2371
# merge the inventory and disk data together
2373
for relpath, subiterator in itertools.groupby(sorted(
2374
current_inv[1] + cur_disk_dir_content,
2375
key=operator.itemgetter(0)), operator.itemgetter(1)):
2376
path_elements = list(subiterator)
2377
if len(path_elements) == 2:
2378
inv_row, disk_row = path_elements
2379
# versioned, present file
2380
dirblock.append((inv_row[0],
2381
inv_row[1], disk_row[2],
2382
disk_row[3], inv_row[4],
2384
elif len(path_elements[0]) == 5:
2386
dirblock.append((path_elements[0][0],
2387
path_elements[0][1], path_elements[0][2],
2388
path_elements[0][3], None, None))
2389
elif len(path_elements[0]) == 6:
2390
# versioned, absent file.
2391
dirblock.append((path_elements[0][0],
2392
path_elements[0][1], 'unknown', None,
2393
path_elements[0][4], path_elements[0][5]))
2395
raise NotImplementedError('unreachable code')
2396
yield current_inv[0], dirblock
2398
current_inv = inventory_iterator.next()
2399
except StopIteration:
2402
current_disk = disk_iterator.next()
2403
except StopIteration:
2404
disk_finished = True
2406
def _walkdirs(self, prefix=""):
2407
"""Walk the directories of this tree.
2409
:prefix: is used as the directrory to start with.
2410
returns a generator which yields items in the form:
2411
((curren_directory_path, fileid),
2412
[(file1_path, file1_name, file1_kind, None, file1_id,
2415
_directory = 'directory'
2416
# get the root in the inventory
2417
inv = self.inventory
2418
top_id = inv.path2id(prefix)
2422
pending = [(prefix, '', _directory, None, top_id, None)]
2425
currentdir = pending.pop()
2426
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2427
top_id = currentdir[4]
2429
relroot = currentdir[0] + '/'
2432
# FIXME: stash the node in pending
2434
for name, child in entry.sorted_children():
2435
dirblock.append((relroot + name, name, child.kind, None,
2436
child.file_id, child.kind
2438
yield (currentdir[0], entry.file_id), dirblock
2439
# push the user specified dirs from dirblock
2440
for dir in reversed(dirblock):
2441
if dir[2] == _directory:
2444
@needs_tree_write_lock
2445
def auto_resolve(self):
2446
"""Automatically resolve text conflicts according to contents.
2448
Only text conflicts are auto_resolvable. Files with no conflict markers
2449
are considered 'resolved', because bzr always puts conflict markers
2450
into files that have text conflicts. The corresponding .THIS .BASE and
2451
.OTHER files are deleted, as per 'resolve'.
2452
:return: a tuple of ConflictLists: (un_resolved, resolved).
2454
un_resolved = _mod_conflicts.ConflictList()
2455
resolved = _mod_conflicts.ConflictList()
2456
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2457
for conflict in self.conflicts():
2458
if (conflict.typestring != 'text conflict' or
2459
self.kind(conflict.file_id) != 'file'):
2460
un_resolved.append(conflict)
2462
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2464
for line in my_file:
2465
if conflict_re.search(line):
2466
un_resolved.append(conflict)
2469
resolved.append(conflict)
2472
resolved.remove_files(self)
2473
self.set_conflicts(un_resolved)
2474
return un_resolved, resolved
2476
def _validate(self):
2477
"""Validate internal structures.
2479
This is meant mostly for the test suite. To give it a chance to detect
2480
corruption after actions have occurred. The default implementation is a
2483
:return: None. An exception should be raised if there is an error.
2488
class WorkingTree2(WorkingTree):
2489
"""This is the Format 2 working tree.
2491
This was the first weave based working tree.
2492
- uses os locks for locking.
2493
- uses the branch last-revision.
2496
def __init__(self, *args, **kwargs):
2497
super(WorkingTree2, self).__init__(*args, **kwargs)
2498
# WorkingTree2 has more of a constraint that self._inventory must
2499
# exist. Because this is an older format, we don't mind the overhead
2500
# caused by the extra computation here.
2502
# Newer WorkingTree's should only have self._inventory set when they
2504
if self._inventory is None:
2505
self.read_working_inventory()
2507
def lock_tree_write(self):
2508
"""See WorkingTree.lock_tree_write().
2510
In Format2 WorkingTrees we have a single lock for the branch and tree
2511
so lock_tree_write() degrades to lock_write().
2513
self.branch.lock_write()
2515
return self._control_files.lock_write()
2517
self.branch.unlock()
2521
# do non-implementation specific cleanup
2524
# we share control files:
2525
if self._control_files._lock_count == 3:
2526
# _inventory_is_modified is always False during a read lock.
2527
if self._inventory_is_modified:
2529
self._write_hashcache_if_dirty()
2531
# reverse order of locking.
2533
return self._control_files.unlock()
2535
self.branch.unlock()
2538
class WorkingTree3(WorkingTree):
2539
"""This is the Format 3 working tree.
2541
This differs from the base WorkingTree by:
2542
- having its own file lock
2543
- having its own last-revision property.
2545
This is new in bzr 0.8
2549
def _last_revision(self):
2550
"""See Mutable.last_revision."""
2552
return self._control_files.get('last-revision').read()
2553
except errors.NoSuchFile:
2554
return _mod_revision.NULL_REVISION
2556
def _change_last_revision(self, revision_id):
2557
"""See WorkingTree._change_last_revision."""
2558
if revision_id is None or revision_id == NULL_REVISION:
2560
self._control_files._transport.delete('last-revision')
2561
except errors.NoSuchFile:
2565
self._control_files.put_bytes('last-revision', revision_id)
2568
@needs_tree_write_lock
2569
def set_conflicts(self, conflicts):
2570
self._put_rio('conflicts', conflicts.to_stanzas(),
2573
@needs_tree_write_lock
2574
def add_conflicts(self, new_conflicts):
2575
conflict_set = set(self.conflicts())
2576
conflict_set.update(set(list(new_conflicts)))
2577
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2578
key=_mod_conflicts.Conflict.sort_key)))
2581
def conflicts(self):
2583
confile = self._control_files.get('conflicts')
2584
except errors.NoSuchFile:
2585
return _mod_conflicts.ConflictList()
2587
if confile.next() != CONFLICT_HEADER_1 + '\n':
2588
raise errors.ConflictFormatError()
2589
except StopIteration:
2590
raise errors.ConflictFormatError()
2591
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2594
# do non-implementation specific cleanup
2596
if self._control_files._lock_count == 1:
2597
# _inventory_is_modified is always False during a read lock.
2598
if self._inventory_is_modified:
2600
self._write_hashcache_if_dirty()
2601
# reverse order of locking.
2603
return self._control_files.unlock()
2605
self.branch.unlock()
2608
def get_conflicted_stem(path):
2609
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2610
if path.endswith(suffix):
2611
return path[:-len(suffix)]
2614
@deprecated_function(zero_eight)
2615
def is_control_file(filename):
2616
"""See WorkingTree.is_control_filename(filename)."""
2617
## FIXME: better check
2618
filename = normpath(filename)
2619
while filename != '':
2620
head, tail = os.path.split(filename)
2621
## mutter('check %r for control file' % ((head, tail),))
2624
if filename == head:
2630
class WorkingTreeFormat(object):
2631
"""An encapsulation of the initialization and open routines for a format.
2633
Formats provide three things:
2634
* An initialization routine,
2638
Formats are placed in an dict by their format string for reference
2639
during workingtree opening. Its not required that these be instances, they
2640
can be classes themselves with class methods - it simply depends on
2641
whether state is needed for a given format or not.
2643
Once a format is deprecated, just deprecate the initialize and open
2644
methods on the format class. Do not deprecate the object, as the
2645
object will be created every time regardless.
2648
_default_format = None
2649
"""The default format used for new trees."""
2652
"""The known formats."""
2654
requires_rich_root = False
2656
upgrade_recommended = False
2659
def find_format(klass, a_bzrdir):
2660
"""Return the format for the working tree object in a_bzrdir."""
2662
transport = a_bzrdir.get_workingtree_transport(None)
2663
format_string = transport.get("format").read()
2664
return klass._formats[format_string]
2665
except errors.NoSuchFile:
2666
raise errors.NoWorkingTree(base=transport.base)
2668
raise errors.UnknownFormatError(format=format_string)
2670
def __eq__(self, other):
2671
return self.__class__ is other.__class__
2673
def __ne__(self, other):
2674
return not (self == other)
2677
def get_default_format(klass):
2678
"""Return the current default format."""
2679
return klass._default_format
2681
def get_format_string(self):
2682
"""Return the ASCII format string that identifies this format."""
2683
raise NotImplementedError(self.get_format_string)
2685
def get_format_description(self):
2686
"""Return the short description for this format."""
2687
raise NotImplementedError(self.get_format_description)
2689
def is_supported(self):
2690
"""Is this format supported?
2692
Supported formats can be initialized and opened.
2693
Unsupported formats may not support initialization or committing or
2694
some other features depending on the reason for not being supported.
2699
def register_format(klass, format):
2700
klass._formats[format.get_format_string()] = format
2703
def set_default_format(klass, format):
2704
klass._default_format = format
2707
def unregister_format(klass, format):
2708
assert klass._formats[format.get_format_string()] is format
2709
del klass._formats[format.get_format_string()]
2712
class WorkingTreeFormat2(WorkingTreeFormat):
2713
"""The second working tree format.
2715
This format modified the hash cache from the format 1 hash cache.
2718
upgrade_recommended = True
2720
def get_format_description(self):
2721
"""See WorkingTreeFormat.get_format_description()."""
2722
return "Working tree format 2"
2724
def stub_initialize_remote(self, control_files):
2725
"""As a special workaround create critical control files for a remote working tree
2727
This ensures that it can later be updated and dealt with locally,
2728
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2729
no working tree. (See bug #43064).
2733
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2735
control_files.put('inventory', sio)
2737
control_files.put_bytes('pending-merges', '')
2740
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2741
"""See WorkingTreeFormat.initialize()."""
2742
if not isinstance(a_bzrdir.transport, LocalTransport):
2743
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2744
if from_branch is not None:
2745
branch = from_branch
2747
branch = a_bzrdir.open_branch()
2748
if revision_id is None:
2749
revision_id = _mod_revision.ensure_null(branch.last_revision())
2752
branch.generate_revision_history(revision_id)
2756
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2762
basis_tree = branch.repository.revision_tree(revision_id)
2763
if basis_tree.inventory.root is not None:
2764
wt.set_root_id(basis_tree.get_root_id())
2765
# set the parent list and cache the basis tree.
2766
if _mod_revision.is_null(revision_id):
2769
parent_trees = [(revision_id, basis_tree)]
2770
wt.set_parent_trees(parent_trees)
2771
transform.build_tree(basis_tree, wt)
2775
super(WorkingTreeFormat2, self).__init__()
2776
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2778
def open(self, a_bzrdir, _found=False):
2779
"""Return the WorkingTree object for a_bzrdir
2781
_found is a private parameter, do not use it. It is used to indicate
2782
if format probing has already been done.
2785
# we are being called directly and must probe.
2786
raise NotImplementedError
2787
if not isinstance(a_bzrdir.transport, LocalTransport):
2788
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2789
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2795
class WorkingTreeFormat3(WorkingTreeFormat):
2796
"""The second working tree format updated to record a format marker.
2799
- exists within a metadir controlling .bzr
2800
- includes an explicit version marker for the workingtree control
2801
files, separate from the BzrDir format
2802
- modifies the hash cache format
2804
- uses a LockDir to guard access for writes.
2807
upgrade_recommended = True
2809
def get_format_string(self):
2810
"""See WorkingTreeFormat.get_format_string()."""
2811
return "Bazaar-NG Working Tree format 3"
2813
def get_format_description(self):
2814
"""See WorkingTreeFormat.get_format_description()."""
2815
return "Working tree format 3"
2817
_lock_file_name = 'lock'
2818
_lock_class = LockDir
2820
_tree_class = WorkingTree3
2822
def __get_matchingbzrdir(self):
2823
return bzrdir.BzrDirMetaFormat1()
2825
_matchingbzrdir = property(__get_matchingbzrdir)
2827
def _open_control_files(self, a_bzrdir):
2828
transport = a_bzrdir.get_workingtree_transport(None)
2829
return LockableFiles(transport, self._lock_file_name,
2832
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2833
"""See WorkingTreeFormat.initialize().
2835
revision_id allows creating a working tree at a different
2836
revision than the branch is at.
2838
if not isinstance(a_bzrdir.transport, LocalTransport):
2839
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2840
transport = a_bzrdir.get_workingtree_transport(self)
2841
control_files = self._open_control_files(a_bzrdir)
2842
control_files.create_lock()
2843
control_files.lock_write()
2844
control_files.put_utf8('format', self.get_format_string())
2845
if from_branch is not None:
2846
branch = from_branch
2848
branch = a_bzrdir.open_branch()
2849
if revision_id is None:
2850
revision_id = _mod_revision.ensure_null(branch.last_revision())
2851
# WorkingTree3 can handle an inventory which has a unique root id.
2852
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2853
# those trees. And because there isn't a format bump inbetween, we
2854
# are maintaining compatibility with older clients.
2855
# inv = Inventory(root_id=gen_root_id())
2856
inv = self._initial_inventory()
2857
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2863
_control_files=control_files)
2864
wt.lock_tree_write()
2866
basis_tree = branch.repository.revision_tree(revision_id)
2867
# only set an explicit root id if there is one to set.
2868
if basis_tree.inventory.root is not None:
2869
wt.set_root_id(basis_tree.get_root_id())
2870
if revision_id == NULL_REVISION:
2871
wt.set_parent_trees([])
2873
wt.set_parent_trees([(revision_id, basis_tree)])
2874
transform.build_tree(basis_tree, wt)
2876
# Unlock in this order so that the unlock-triggers-flush in
2877
# WorkingTree is given a chance to fire.
2878
control_files.unlock()
2882
def _initial_inventory(self):
2886
super(WorkingTreeFormat3, self).__init__()
2888
def open(self, a_bzrdir, _found=False):
2889
"""Return the WorkingTree object for a_bzrdir
2891
_found is a private parameter, do not use it. It is used to indicate
2892
if format probing has already been done.
2895
# we are being called directly and must probe.
2896
raise NotImplementedError
2897
if not isinstance(a_bzrdir.transport, LocalTransport):
2898
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2899
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2902
def _open(self, a_bzrdir, control_files):
2903
"""Open the tree itself.
2905
:param a_bzrdir: the dir for the tree.
2906
:param control_files: the control files for the tree.
2908
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2912
_control_files=control_files)
2915
return self.get_format_string()
2918
__default_format = WorkingTreeFormat4()
2919
WorkingTreeFormat.register_format(__default_format)
2920
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2921
WorkingTreeFormat.set_default_format(__default_format)
2922
# formats which have no format string are not discoverable
2923
# and not independently creatable, so are not registered.
2924
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
