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
284
self._setup_directory_is_tree_reference()
287
fget=lambda self: self._branch,
288
doc="""The branch this WorkingTree is connected to.
290
This cannot be set - it is reflective of the actual disk structure
291
the working tree has been constructed from.
294
def break_lock(self):
295
"""Break a lock if one is present from another instance.
297
Uses the ui factory to ask for confirmation if the lock may be from
300
This will probe the repository for its lock as well.
302
self._control_files.break_lock()
303
self.branch.break_lock()
305
def requires_rich_root(self):
306
return self._format.requires_rich_root
308
def supports_tree_reference(self):
311
def _set_inventory(self, inv, dirty):
312
"""Set the internal cached inventory.
314
:param inv: The inventory to set.
315
:param dirty: A boolean indicating whether the inventory is the same
316
logical inventory as whats on disk. If True the inventory is not
317
the same and should be written to disk or data will be lost, if
318
False then the inventory is the same as that on disk and any
319
serialisation would be unneeded overhead.
321
assert inv.root is not None
322
self._inventory = inv
323
self._inventory_is_modified = dirty
326
def open(path=None, _unsupported=False):
327
"""Open an existing working tree at path.
331
path = os.path.getcwdu()
332
control = bzrdir.BzrDir.open(path, _unsupported)
333
return control.open_workingtree(_unsupported)
336
def open_containing(path=None):
337
"""Open an existing working tree which has its root about path.
339
This probes for a working tree at path and searches upwards from there.
341
Basically we keep looking up until we find the control directory or
342
run into /. If there isn't one, raises NotBranchError.
343
TODO: give this a new exception.
344
If there is one, it is returned, along with the unused portion of path.
346
:return: The WorkingTree that contains 'path', and the rest of path
349
path = osutils.getcwd()
350
control, relpath = bzrdir.BzrDir.open_containing(path)
352
return control.open_workingtree(), relpath
355
def open_downlevel(path=None):
356
"""Open an unsupported working tree.
358
Only intended for advanced situations like upgrading part of a bzrdir.
360
return WorkingTree.open(path, _unsupported=True)
363
def find_trees(location):
364
def list_current(transport):
365
return [d for d in transport.list_dir('') if d != '.bzr']
366
def evaluate(bzrdir):
368
tree = bzrdir.open_workingtree()
369
except errors.NoWorkingTree:
373
transport = get_transport(location)
374
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
375
list_current=list_current)
376
return [t for t in iterator if t is not None]
378
# should be deprecated - this is slow and in any case treating them as a
379
# container is (we now know) bad style -- mbp 20070302
380
## @deprecated_method(zero_fifteen)
382
"""Iterate through file_ids for this tree.
384
file_ids are in a WorkingTree if they are in the working inventory
385
and the working file exists.
387
inv = self._inventory
388
for path, ie in inv.iter_entries():
389
if osutils.lexists(self.abspath(path)):
393
return "<%s of %s>" % (self.__class__.__name__,
394
getattr(self, 'basedir', None))
396
def abspath(self, filename):
397
return pathjoin(self.basedir, filename)
399
def basis_tree(self):
400
"""Return RevisionTree for the current last revision.
402
If the left most parent is a ghost then the returned tree will be an
403
empty tree - one obtained by calling repository.revision_tree(None).
406
revision_id = self.get_parent_ids()[0]
408
# no parents, return an empty revision tree.
409
# in the future this should return the tree for
410
# 'empty:' - the implicit root empty tree.
411
return self.branch.repository.revision_tree(None)
413
return self.revision_tree(revision_id)
414
except errors.NoSuchRevision:
416
# No cached copy available, retrieve from the repository.
417
# FIXME? RBC 20060403 should we cache the inventory locally
420
return self.branch.repository.revision_tree(revision_id)
421
except errors.RevisionNotPresent:
422
# the basis tree *may* be a ghost or a low level error may have
423
# occured. If the revision is present, its a problem, if its not
425
if self.branch.repository.has_revision(revision_id):
427
# the basis tree is a ghost so return an empty tree.
428
return self.branch.repository.revision_tree(None)
431
self._flush_ignore_list_cache()
434
@deprecated_method(zero_eight)
435
def create(branch, directory):
436
"""Create a workingtree for branch at directory.
438
If existing_directory already exists it must have a .bzr directory.
439
If it does not exist, it will be created.
441
This returns a new WorkingTree object for the new checkout.
443
TODO FIXME RBC 20060124 when we have checkout formats in place this
444
should accept an optional revisionid to checkout [and reject this if
445
checking out into the same dir as a pre-checkout-aware branch format.]
447
XXX: When BzrDir is present, these should be created through that
450
warnings.warn('delete WorkingTree.create', stacklevel=3)
451
transport = get_transport(directory)
452
if branch.bzrdir.root_transport.base == transport.base:
454
return branch.bzrdir.create_workingtree()
455
# different directory,
456
# create a branch reference
457
# and now a working tree.
458
raise NotImplementedError
461
@deprecated_method(zero_eight)
462
def create_standalone(directory):
463
"""Create a checkout and a branch and a repo at directory.
465
Directory must exist and be empty.
467
please use BzrDir.create_standalone_workingtree
469
return bzrdir.BzrDir.create_standalone_workingtree(directory)
471
def relpath(self, path):
472
"""Return the local path portion from a given path.
474
The path may be absolute or relative. If its a relative path it is
475
interpreted relative to the python current working directory.
477
return osutils.relpath(self.basedir, path)
479
def has_filename(self, filename):
480
return osutils.lexists(self.abspath(filename))
482
def get_file(self, file_id, path=None):
484
path = self.id2path(file_id)
485
return self.get_file_byname(path)
487
def get_file_text(self, file_id):
488
return self.get_file(file_id).read()
490
def get_file_byname(self, filename):
491
return file(self.abspath(filename), 'rb')
494
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
495
"""See Tree.annotate_iter
497
This implementation will use the basis tree implementation if possible.
498
Lines not in the basis are attributed to CURRENT_REVISION
500
If there are pending merges, lines added by those merges will be
501
incorrectly attributed to CURRENT_REVISION (but after committing, the
502
attribution will be correct).
504
basis = self.basis_tree()
507
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
508
require_versioned=True).next()
509
changed_content, kind = changes[2], changes[6]
510
if not changed_content:
511
return basis.annotate_iter(file_id)
515
if kind[0] != 'file':
518
old_lines = list(basis.annotate_iter(file_id))
520
for tree in self.branch.repository.revision_trees(
521
self.get_parent_ids()[1:]):
522
if file_id not in tree:
524
old.append(list(tree.annotate_iter(file_id)))
525
return annotate.reannotate(old, self.get_file(file_id).readlines(),
530
def _get_ancestors(self, default_revision):
531
ancestors = set([default_revision])
532
for parent_id in self.get_parent_ids():
533
ancestors.update(self.branch.repository.get_ancestry(
534
parent_id, topo_sorted=False))
537
def get_parent_ids(self):
538
"""See Tree.get_parent_ids.
540
This implementation reads the pending merges list and last_revision
541
value and uses that to decide what the parents list should be.
543
last_rev = _mod_revision.ensure_null(self._last_revision())
544
if _mod_revision.NULL_REVISION == last_rev:
549
merges_file = self._control_files.get('pending-merges')
550
except errors.NoSuchFile:
553
for l in merges_file.readlines():
554
revision_id = l.rstrip('\n')
555
parents.append(revision_id)
559
def get_root_id(self):
560
"""Return the id of this trees root"""
561
return self._inventory.root.file_id
563
def _get_store_filename(self, file_id):
564
## XXX: badly named; this is not in the store at all
565
return self.abspath(self.id2path(file_id))
568
def clone(self, to_bzrdir, revision_id=None):
569
"""Duplicate this working tree into to_bzr, including all state.
571
Specifically modified files are kept as modified, but
572
ignored and unknown files are discarded.
574
If you want to make a new line of development, see bzrdir.sprout()
577
If not None, the cloned tree will have its last revision set to
578
revision, and and difference between the source trees last revision
579
and this one merged in.
581
# assumes the target bzr dir format is compatible.
582
result = self._format.initialize(to_bzrdir)
583
self.copy_content_into(result, revision_id)
587
def copy_content_into(self, tree, revision_id=None):
588
"""Copy the current content and user files of this tree into tree."""
589
tree.set_root_id(self.get_root_id())
590
if revision_id is None:
591
merge.transform_tree(tree, self)
593
# TODO now merge from tree.last_revision to revision (to preserve
594
# user local changes)
595
merge.transform_tree(tree, self)
596
tree.set_parent_ids([revision_id])
598
def id2abspath(self, file_id):
599
return self.abspath(self.id2path(file_id))
601
def has_id(self, file_id):
602
# files that have been deleted are excluded
604
if not inv.has_id(file_id):
606
path = inv.id2path(file_id)
607
return osutils.lexists(self.abspath(path))
609
def has_or_had_id(self, file_id):
610
if file_id == self.inventory.root.file_id:
612
return self.inventory.has_id(file_id)
614
__contains__ = has_id
616
def get_file_size(self, file_id):
617
return os.path.getsize(self.id2abspath(file_id))
620
def get_file_sha1(self, file_id, path=None, stat_value=None):
622
path = self._inventory.id2path(file_id)
623
return self._hashcache.get_sha1(path, stat_value)
625
def get_file_mtime(self, file_id, path=None):
627
path = self.inventory.id2path(file_id)
628
return os.lstat(self.abspath(path)).st_mtime
630
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
631
file_id = self.path2id(path)
632
return self._inventory[file_id].executable
634
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
635
mode = stat_result.st_mode
636
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
638
if not supports_executable():
639
def is_executable(self, file_id, path=None):
640
return self._inventory[file_id].executable
642
_is_executable_from_path_and_stat = \
643
_is_executable_from_path_and_stat_from_basis
645
def is_executable(self, file_id, path=None):
647
path = self.id2path(file_id)
648
mode = os.lstat(self.abspath(path)).st_mode
649
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
651
_is_executable_from_path_and_stat = \
652
_is_executable_from_path_and_stat_from_stat
654
@needs_tree_write_lock
655
def _add(self, files, ids, kinds):
656
"""See MutableTree._add."""
657
# TODO: Re-adding a file that is removed in the working copy
658
# should probably put it back with the previous ID.
659
# the read and write working inventory should not occur in this
660
# function - they should be part of lock_write and unlock.
662
for f, file_id, kind in zip(files, ids, kinds):
663
assert kind is not None
665
inv.add_path(f, kind=kind)
667
inv.add_path(f, kind=kind, file_id=file_id)
668
self._inventory_is_modified = True
670
@needs_tree_write_lock
671
def _gather_kinds(self, files, kinds):
672
"""See MutableTree._gather_kinds."""
673
for pos, f in enumerate(files):
674
if kinds[pos] is None:
675
fullpath = normpath(self.abspath(f))
677
kinds[pos] = file_kind(fullpath)
679
if e.errno == errno.ENOENT:
680
raise errors.NoSuchFile(fullpath)
683
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
684
"""Add revision_id as a parent.
686
This is equivalent to retrieving the current list of parent ids
687
and setting the list to its value plus revision_id.
689
:param revision_id: The revision id to add to the parent list. It may
690
be a ghost revision as long as its not the first parent to be added,
691
or the allow_leftmost_as_ghost parameter is set True.
692
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
694
parents = self.get_parent_ids() + [revision_id]
695
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
696
or allow_leftmost_as_ghost)
698
@needs_tree_write_lock
699
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
700
"""Add revision_id, tree tuple as a parent.
702
This is equivalent to retrieving the current list of parent trees
703
and setting the list to its value plus parent_tuple. See also
704
add_parent_tree_id - if you only have a parent id available it will be
705
simpler to use that api. If you have the parent already available, using
706
this api is preferred.
708
:param parent_tuple: The (revision id, tree) to add to the parent list.
709
If the revision_id is a ghost, pass None for the tree.
710
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
712
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
713
if len(parent_ids) > 1:
714
# the leftmost may have already been a ghost, preserve that if it
716
allow_leftmost_as_ghost = True
717
self.set_parent_ids(parent_ids,
718
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
720
@needs_tree_write_lock
721
def add_pending_merge(self, *revision_ids):
722
# TODO: Perhaps should check at this point that the
723
# history of the revision is actually present?
724
parents = self.get_parent_ids()
726
for rev_id in revision_ids:
727
if rev_id in parents:
729
parents.append(rev_id)
732
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
734
def path_content_summary(self, path, _lstat=os.lstat,
735
_mapper=osutils.file_kind_from_stat_mode):
736
"""See Tree.path_content_summary."""
737
abspath = self.abspath(path)
739
stat_result = _lstat(abspath)
741
if getattr(e, 'errno', None) == errno.ENOENT:
743
return ('missing', None, None, None)
744
# propagate other errors
746
kind = _mapper(stat_result.st_mode)
748
size = stat_result.st_size
749
# try for a stat cache lookup
750
executable = self._is_executable_from_path_and_stat(path, stat_result)
751
return (kind, size, executable, self._sha_from_stat(
753
elif kind == 'directory':
754
# perhaps it looks like a plain directory, but it's really a
756
if self._directory_is_tree_reference(path):
757
kind = 'tree-reference'
758
return kind, None, None, None
759
elif kind == 'symlink':
760
return ('symlink', None, None, os.readlink(abspath))
762
return (kind, None, None, None)
764
@deprecated_method(zero_eleven)
766
def pending_merges(self):
767
"""Return a list of pending merges.
769
These are revisions that have been merged into the working
770
directory but not yet committed.
772
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
773
instead - which is available on all tree objects.
775
return self.get_parent_ids()[1:]
777
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
778
"""Common ghost checking functionality from set_parent_*.
780
This checks that the left hand-parent exists if there are any
783
if len(revision_ids) > 0:
784
leftmost_id = revision_ids[0]
785
if (not allow_leftmost_as_ghost and not
786
self.branch.repository.has_revision(leftmost_id)):
787
raise errors.GhostRevisionUnusableHere(leftmost_id)
789
def _set_merges_from_parent_ids(self, parent_ids):
790
merges = parent_ids[1:]
791
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
793
@needs_tree_write_lock
794
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
795
"""Set the parent ids to revision_ids.
797
See also set_parent_trees. This api will try to retrieve the tree data
798
for each element of revision_ids from the trees repository. If you have
799
tree data already available, it is more efficient to use
800
set_parent_trees rather than set_parent_ids. set_parent_ids is however
801
an easier API to use.
803
:param revision_ids: The revision_ids to set as the parent ids of this
804
working tree. Any of these may be ghosts.
806
self._check_parents_for_ghosts(revision_ids,
807
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
808
for revision_id in revision_ids:
809
_mod_revision.check_not_reserved_id(revision_id)
811
if len(revision_ids) > 0:
812
self.set_last_revision(revision_ids[0])
814
self.set_last_revision(_mod_revision.NULL_REVISION)
816
self._set_merges_from_parent_ids(revision_ids)
818
@needs_tree_write_lock
819
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
820
"""See MutableTree.set_parent_trees."""
821
parent_ids = [rev for (rev, tree) in parents_list]
822
for revision_id in parent_ids:
823
_mod_revision.check_not_reserved_id(revision_id)
825
self._check_parents_for_ghosts(parent_ids,
826
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
828
if len(parent_ids) == 0:
829
leftmost_parent_id = _mod_revision.NULL_REVISION
830
leftmost_parent_tree = None
832
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
834
if self._change_last_revision(leftmost_parent_id):
835
if leftmost_parent_tree is None:
836
# If we don't have a tree, fall back to reading the
837
# parent tree from the repository.
838
self._cache_basis_inventory(leftmost_parent_id)
840
inv = leftmost_parent_tree.inventory
841
xml = self._create_basis_xml_from_inventory(
842
leftmost_parent_id, inv)
843
self._write_basis_inventory(xml)
844
self._set_merges_from_parent_ids(parent_ids)
846
@needs_tree_write_lock
847
def set_pending_merges(self, rev_list):
848
parents = self.get_parent_ids()
849
leftmost = parents[:1]
850
new_parents = leftmost + rev_list
851
self.set_parent_ids(new_parents)
853
@needs_tree_write_lock
854
def set_merge_modified(self, modified_hashes):
856
for file_id, hash in modified_hashes.iteritems():
857
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
858
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
860
def _sha_from_stat(self, path, stat_result):
861
"""Get a sha digest from the tree's stat cache.
863
The default implementation assumes no stat cache is present.
865
:param path: The path.
866
:param stat_result: The stat result being looked up.
870
def _put_rio(self, filename, stanzas, header):
871
self._must_be_locked()
872
my_file = rio_file(stanzas, header)
873
self._control_files.put(filename, my_file)
875
@needs_write_lock # because merge pulls data into the branch.
876
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
878
"""Merge from a branch into this working tree.
880
:param branch: The branch to merge from.
881
:param to_revision: If non-None, the merge will merge to to_revision,
882
but not beyond it. to_revision does not need to be in the history
883
of the branch when it is supplied. If None, to_revision defaults to
884
branch.last_revision().
886
from bzrlib.merge import Merger, Merge3Merger
887
pb = bzrlib.ui.ui_factory.nested_progress_bar()
889
merger = Merger(self.branch, this_tree=self, pb=pb)
890
merger.pp = ProgressPhase("Merge phase", 5, pb)
891
merger.pp.next_phase()
892
# check that there are no
894
merger.check_basis(check_clean=True, require_commits=False)
895
if to_revision is None:
896
to_revision = _mod_revision.ensure_null(branch.last_revision())
897
merger.other_rev_id = to_revision
898
if _mod_revision.is_null(merger.other_rev_id):
899
raise errors.NoCommits(branch)
900
self.branch.fetch(branch, last_revision=merger.other_rev_id)
901
merger.other_basis = merger.other_rev_id
902
merger.other_tree = self.branch.repository.revision_tree(
904
merger.other_branch = branch
905
merger.pp.next_phase()
906
if from_revision is None:
909
merger.set_base_revision(from_revision, branch)
910
if merger.base_rev_id == merger.other_rev_id:
911
raise errors.PointlessMerge
912
merger.backup_files = False
913
if merge_type is None:
914
merger.merge_type = Merge3Merger
916
merger.merge_type = merge_type
917
merger.set_interesting_files(None)
918
merger.show_base = False
919
merger.reprocess = False
920
conflicts = merger.do_merge()
927
def merge_modified(self):
928
"""Return a dictionary of files modified by a merge.
930
The list is initialized by WorkingTree.set_merge_modified, which is
931
typically called after we make some automatic updates to the tree
934
This returns a map of file_id->sha1, containing only files which are
935
still in the working inventory and have that text hash.
938
hashfile = self._control_files.get('merge-hashes')
939
except errors.NoSuchFile:
943
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
944
raise errors.MergeModifiedFormatError()
945
except StopIteration:
946
raise errors.MergeModifiedFormatError()
947
for s in RioReader(hashfile):
948
# RioReader reads in Unicode, so convert file_ids back to utf8
949
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
950
if file_id not in self.inventory:
952
text_hash = s.get("hash")
953
if text_hash == self.get_file_sha1(file_id):
954
merge_hashes[file_id] = text_hash
958
def mkdir(self, path, file_id=None):
959
"""See MutableTree.mkdir()."""
961
file_id = generate_ids.gen_file_id(os.path.basename(path))
962
os.mkdir(self.abspath(path))
963
self.add(path, file_id, 'directory')
966
def get_symlink_target(self, file_id):
967
return os.readlink(self.id2abspath(file_id))
970
def subsume(self, other_tree):
971
def add_children(inventory, entry):
972
for child_entry in entry.children.values():
973
inventory._byid[child_entry.file_id] = child_entry
974
if child_entry.kind == 'directory':
975
add_children(inventory, child_entry)
976
if other_tree.get_root_id() == self.get_root_id():
977
raise errors.BadSubsumeSource(self, other_tree,
978
'Trees have the same root')
980
other_tree_path = self.relpath(other_tree.basedir)
981
except errors.PathNotChild:
982
raise errors.BadSubsumeSource(self, other_tree,
983
'Tree is not contained by the other')
984
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
985
if new_root_parent is None:
986
raise errors.BadSubsumeSource(self, other_tree,
987
'Parent directory is not versioned.')
988
# We need to ensure that the result of a fetch will have a
989
# versionedfile for the other_tree root, and only fetching into
990
# RepositoryKnit2 guarantees that.
991
if not self.branch.repository.supports_rich_root():
992
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
993
other_tree.lock_tree_write()
995
new_parents = other_tree.get_parent_ids()
996
other_root = other_tree.inventory.root
997
other_root.parent_id = new_root_parent
998
other_root.name = osutils.basename(other_tree_path)
999
self.inventory.add(other_root)
1000
add_children(self.inventory, other_root)
1001
self._write_inventory(self.inventory)
1002
# normally we don't want to fetch whole repositories, but i think
1003
# here we really do want to consolidate the whole thing.
1004
for parent_id in other_tree.get_parent_ids():
1005
self.branch.fetch(other_tree.branch, parent_id)
1006
self.add_parent_tree_id(parent_id)
1009
other_tree.bzrdir.retire_bzrdir()
1011
def _setup_directory_is_tree_reference(self):
1012
if self._branch.repository._format.supports_tree_reference:
1013
self._directory_is_tree_reference = \
1014
self._directory_may_be_tree_reference
1016
self._directory_is_tree_reference = \
1017
self._directory_is_never_tree_reference
1019
def _directory_is_never_tree_reference(self, relpath):
1022
def _directory_may_be_tree_reference(self, relpath):
1023
# as a special case, if a directory contains control files then
1024
# it's a tree reference, except that the root of the tree is not
1025
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1026
# TODO: We could ask all the control formats whether they
1027
# recognize this directory, but at the moment there's no cheap api
1028
# to do that. Since we probably can only nest bzr checkouts and
1029
# they always use this name it's ok for now. -- mbp 20060306
1031
# FIXME: There is an unhandled case here of a subdirectory
1032
# containing .bzr but not a branch; that will probably blow up
1033
# when you try to commit it. It might happen if there is a
1034
# checkout in a subdirectory. This can be avoided by not adding
1037
@needs_tree_write_lock
1038
def extract(self, file_id, format=None):
1039
"""Extract a subtree from this tree.
1041
A new branch will be created, relative to the path for this tree.
1045
segments = osutils.splitpath(path)
1046
transport = self.branch.bzrdir.root_transport
1047
for name in segments:
1048
transport = transport.clone(name)
1049
transport.ensure_base()
1052
sub_path = self.id2path(file_id)
1053
branch_transport = mkdirs(sub_path)
1055
format = self.bzrdir.cloning_metadir()
1056
branch_transport.ensure_base()
1057
branch_bzrdir = format.initialize_on_transport(branch_transport)
1059
repo = branch_bzrdir.find_repository()
1060
except errors.NoRepositoryPresent:
1061
repo = branch_bzrdir.create_repository()
1062
if not repo.supports_rich_root():
1063
raise errors.RootNotRich()
1064
new_branch = branch_bzrdir.create_branch()
1065
new_branch.pull(self.branch)
1066
for parent_id in self.get_parent_ids():
1067
new_branch.fetch(self.branch, parent_id)
1068
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1069
if tree_transport.base != branch_transport.base:
1070
tree_bzrdir = format.initialize_on_transport(tree_transport)
1071
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1073
tree_bzrdir = branch_bzrdir
1074
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1075
wt.set_parent_ids(self.get_parent_ids())
1076
my_inv = self.inventory
1077
child_inv = Inventory(root_id=None)
1078
new_root = my_inv[file_id]
1079
my_inv.remove_recursive_id(file_id)
1080
new_root.parent_id = None
1081
child_inv.add(new_root)
1082
self._write_inventory(my_inv)
1083
wt._write_inventory(child_inv)
1086
def _serialize(self, inventory, out_file):
1087
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1090
def _deserialize(selt, in_file):
1091
return xml5.serializer_v5.read_inventory(in_file)
1094
"""Write the in memory inventory to disk."""
1095
# TODO: Maybe this should only write on dirty ?
1096
if self._control_files._lock_mode != 'w':
1097
raise errors.NotWriteLocked(self)
1099
self._serialize(self._inventory, sio)
1101
self._control_files.put('inventory', sio)
1102
self._inventory_is_modified = False
1104
def _kind(self, relpath):
1105
return osutils.file_kind(self.abspath(relpath))
1107
def list_files(self, include_root=False):
1108
"""Recursively list all files as (path, class, kind, id, entry).
1110
Lists, but does not descend into unversioned directories.
1112
This does not include files that have been deleted in this
1115
Skips the control directory.
1117
# list_files is an iterator, so @needs_read_lock doesn't work properly
1118
# with it. So callers should be careful to always read_lock the tree.
1119
if not self.is_locked():
1120
raise errors.ObjectNotLocked(self)
1122
inv = self.inventory
1123
if include_root is True:
1124
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1125
# Convert these into local objects to save lookup times
1126
pathjoin = osutils.pathjoin
1127
file_kind = self._kind
1129
# transport.base ends in a slash, we want the piece
1130
# between the last two slashes
1131
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1133
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1135
# directory file_id, relative path, absolute path, reverse sorted children
1136
children = os.listdir(self.basedir)
1138
# jam 20060527 The kernel sized tree seems equivalent whether we
1139
# use a deque and popleft to keep them sorted, or if we use a plain
1140
# list and just reverse() them.
1141
children = collections.deque(children)
1142
stack = [(inv.root.file_id, u'', self.basedir, children)]
1144
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1147
f = children.popleft()
1148
## TODO: If we find a subdirectory with its own .bzr
1149
## directory, then that is a separate tree and we
1150
## should exclude it.
1152
# the bzrdir for this tree
1153
if transport_base_dir == f:
1156
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1157
# and 'f' doesn't begin with one, we can do a string op, rather
1158
# than the checks of pathjoin(), all relative paths will have an extra slash
1160
fp = from_dir_relpath + '/' + f
1163
fap = from_dir_abspath + '/' + f
1165
f_ie = inv.get_child(from_dir_id, f)
1168
elif self.is_ignored(fp[1:]):
1171
# we may not have found this file, because of a unicode issue
1172
f_norm, can_access = osutils.normalized_filename(f)
1173
if f == f_norm or not can_access:
1174
# No change, so treat this file normally
1177
# this file can be accessed by a normalized path
1178
# check again if it is versioned
1179
# these lines are repeated here for performance
1181
fp = from_dir_relpath + '/' + f
1182
fap = from_dir_abspath + '/' + f
1183
f_ie = inv.get_child(from_dir_id, f)
1186
elif self.is_ignored(fp[1:]):
1193
# make a last minute entry
1195
yield fp[1:], c, fk, f_ie.file_id, f_ie
1198
yield fp[1:], c, fk, None, fk_entries[fk]()
1200
yield fp[1:], c, fk, None, TreeEntry()
1203
if fk != 'directory':
1206
# But do this child first
1207
new_children = os.listdir(fap)
1209
new_children = collections.deque(new_children)
1210
stack.append((f_ie.file_id, fp, fap, new_children))
1211
# Break out of inner loop,
1212
# so that we start outer loop with child
1215
# if we finished all children, pop it off the stack
1218
@needs_tree_write_lock
1219
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1222
to_dir must exist in the inventory.
1224
If to_dir exists and is a directory, the files are moved into
1225
it, keeping their old names.
1227
Note that to_dir is only the last component of the new name;
1228
this doesn't change the directory.
1230
For each entry in from_paths the move mode will be determined
1233
The first mode moves the file in the filesystem and updates the
1234
inventory. The second mode only updates the inventory without
1235
touching the file on the filesystem. This is the new mode introduced
1238
move uses the second mode if 'after == True' and the target is not
1239
versioned but present in the working tree.
1241
move uses the second mode if 'after == False' and the source is
1242
versioned but no longer in the working tree, and the target is not
1243
versioned but present in the working tree.
1245
move uses the first mode if 'after == False' and the source is
1246
versioned and present in the working tree, and the target is not
1247
versioned and not present in the working tree.
1249
Everything else results in an error.
1251
This returns a list of (from_path, to_path) pairs for each
1252
entry that is moved.
1257
# check for deprecated use of signature
1259
to_dir = kwargs.get('to_name', None)
1261
raise TypeError('You must supply a target directory')
1263
symbol_versioning.warn('The parameter to_name was deprecated'
1264
' in version 0.13. Use to_dir instead',
1267
# check destination directory
1268
assert not isinstance(from_paths, basestring)
1269
inv = self.inventory
1270
to_abs = self.abspath(to_dir)
1271
if not isdir(to_abs):
1272
raise errors.BzrMoveFailedError('',to_dir,
1273
errors.NotADirectory(to_abs))
1274
if not self.has_filename(to_dir):
1275
raise errors.BzrMoveFailedError('',to_dir,
1276
errors.NotInWorkingDirectory(to_dir))
1277
to_dir_id = inv.path2id(to_dir)
1278
if to_dir_id is None:
1279
raise errors.BzrMoveFailedError('',to_dir,
1280
errors.NotVersionedError(path=str(to_dir)))
1282
to_dir_ie = inv[to_dir_id]
1283
if to_dir_ie.kind != 'directory':
1284
raise errors.BzrMoveFailedError('',to_dir,
1285
errors.NotADirectory(to_abs))
1287
# create rename entries and tuples
1288
for from_rel in from_paths:
1289
from_tail = splitpath(from_rel)[-1]
1290
from_id = inv.path2id(from_rel)
1292
raise errors.BzrMoveFailedError(from_rel,to_dir,
1293
errors.NotVersionedError(path=str(from_rel)))
1295
from_entry = inv[from_id]
1296
from_parent_id = from_entry.parent_id
1297
to_rel = pathjoin(to_dir, from_tail)
1298
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1300
from_tail=from_tail,
1301
from_parent_id=from_parent_id,
1302
to_rel=to_rel, to_tail=from_tail,
1303
to_parent_id=to_dir_id)
1304
rename_entries.append(rename_entry)
1305
rename_tuples.append((from_rel, to_rel))
1307
# determine which move mode to use. checks also for movability
1308
rename_entries = self._determine_mv_mode(rename_entries, after)
1310
original_modified = self._inventory_is_modified
1313
self._inventory_is_modified = True
1314
self._move(rename_entries)
1316
# restore the inventory on error
1317
self._inventory_is_modified = original_modified
1319
self._write_inventory(inv)
1320
return rename_tuples
1322
def _determine_mv_mode(self, rename_entries, after=False):
1323
"""Determines for each from-to pair if both inventory and working tree
1324
or only the inventory has to be changed.
1326
Also does basic plausability tests.
1328
inv = self.inventory
1330
for rename_entry in rename_entries:
1331
# store to local variables for easier reference
1332
from_rel = rename_entry.from_rel
1333
from_id = rename_entry.from_id
1334
to_rel = rename_entry.to_rel
1335
to_id = inv.path2id(to_rel)
1336
only_change_inv = False
1338
# check the inventory for source and destination
1340
raise errors.BzrMoveFailedError(from_rel,to_rel,
1341
errors.NotVersionedError(path=str(from_rel)))
1342
if to_id is not None:
1343
raise errors.BzrMoveFailedError(from_rel,to_rel,
1344
errors.AlreadyVersionedError(path=str(to_rel)))
1346
# try to determine the mode for rename (only change inv or change
1347
# inv and file system)
1349
if not self.has_filename(to_rel):
1350
raise errors.BzrMoveFailedError(from_id,to_rel,
1351
errors.NoSuchFile(path=str(to_rel),
1352
extra="New file has not been created yet"))
1353
only_change_inv = True
1354
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1355
only_change_inv = True
1356
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1357
only_change_inv = False
1358
elif (sys.platform == 'win32'
1359
and from_rel.lower() == to_rel.lower()
1360
and self.has_filename(from_rel)):
1361
only_change_inv = False
1363
# something is wrong, so lets determine what exactly
1364
if not self.has_filename(from_rel) and \
1365
not self.has_filename(to_rel):
1366
raise errors.BzrRenameFailedError(from_rel,to_rel,
1367
errors.PathsDoNotExist(paths=(str(from_rel),
1370
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1371
rename_entry.only_change_inv = only_change_inv
1372
return rename_entries
1374
def _move(self, rename_entries):
1375
"""Moves a list of files.
1377
Depending on the value of the flag 'only_change_inv', the
1378
file will be moved on the file system or not.
1380
inv = self.inventory
1383
for entry in rename_entries:
1385
self._move_entry(entry)
1387
self._rollback_move(moved)
1391
def _rollback_move(self, moved):
1392
"""Try to rollback a previous move in case of an filesystem error."""
1393
inv = self.inventory
1396
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1397
entry.to_tail, entry.to_parent_id, entry.from_rel,
1398
entry.from_tail, entry.from_parent_id,
1399
entry.only_change_inv))
1400
except errors.BzrMoveFailedError, e:
1401
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1402
" The working tree is in an inconsistent state."
1403
" Please consider doing a 'bzr revert'."
1404
" Error message is: %s" % e)
1406
def _move_entry(self, entry):
1407
inv = self.inventory
1408
from_rel_abs = self.abspath(entry.from_rel)
1409
to_rel_abs = self.abspath(entry.to_rel)
1410
if from_rel_abs == to_rel_abs:
1411
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1412
"Source and target are identical.")
1414
if not entry.only_change_inv:
1416
osutils.rename(from_rel_abs, to_rel_abs)
1418
raise errors.BzrMoveFailedError(entry.from_rel,
1420
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1422
@needs_tree_write_lock
1423
def rename_one(self, from_rel, to_rel, after=False):
1426
This can change the directory or the filename or both.
1428
rename_one has several 'modes' to work. First, it can rename a physical
1429
file and change the file_id. That is the normal mode. Second, it can
1430
only change the file_id without touching any physical file. This is
1431
the new mode introduced in version 0.15.
1433
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1434
versioned but present in the working tree.
1436
rename_one uses the second mode if 'after == False' and 'from_rel' is
1437
versioned but no longer in the working tree, and 'to_rel' is not
1438
versioned but present in the working tree.
1440
rename_one uses the first mode if 'after == False' and 'from_rel' is
1441
versioned and present in the working tree, and 'to_rel' is not
1442
versioned and not present in the working tree.
1444
Everything else results in an error.
1446
inv = self.inventory
1449
# create rename entries and tuples
1450
from_tail = splitpath(from_rel)[-1]
1451
from_id = inv.path2id(from_rel)
1453
raise errors.BzrRenameFailedError(from_rel,to_rel,
1454
errors.NotVersionedError(path=str(from_rel)))
1455
from_entry = inv[from_id]
1456
from_parent_id = from_entry.parent_id
1457
to_dir, to_tail = os.path.split(to_rel)
1458
to_dir_id = inv.path2id(to_dir)
1459
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1461
from_tail=from_tail,
1462
from_parent_id=from_parent_id,
1463
to_rel=to_rel, to_tail=to_tail,
1464
to_parent_id=to_dir_id)
1465
rename_entries.append(rename_entry)
1467
# determine which move mode to use. checks also for movability
1468
rename_entries = self._determine_mv_mode(rename_entries, after)
1470
# check if the target changed directory and if the target directory is
1472
if to_dir_id is None:
1473
raise errors.BzrMoveFailedError(from_rel,to_rel,
1474
errors.NotVersionedError(path=str(to_dir)))
1476
# all checks done. now we can continue with our actual work
1477
mutter('rename_one:\n'
1482
' to_dir_id {%s}\n',
1483
from_id, from_rel, to_rel, to_dir, to_dir_id)
1485
self._move(rename_entries)
1486
self._write_inventory(inv)
1488
class _RenameEntry(object):
1489
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1490
to_rel, to_tail, to_parent_id, only_change_inv=False):
1491
self.from_rel = from_rel
1492
self.from_id = from_id
1493
self.from_tail = from_tail
1494
self.from_parent_id = from_parent_id
1495
self.to_rel = to_rel
1496
self.to_tail = to_tail
1497
self.to_parent_id = to_parent_id
1498
self.only_change_inv = only_change_inv
1502
"""Return all unknown files.
1504
These are files in the working directory that are not versioned or
1505
control files or ignored.
1507
# force the extras method to be fully executed before returning, to
1508
# prevent race conditions with the lock
1510
[subp for subp in self.extras() if not self.is_ignored(subp)])
1512
@needs_tree_write_lock
1513
def unversion(self, file_ids):
1514
"""Remove the file ids in file_ids from the current versioned set.
1516
When a file_id is unversioned, all of its children are automatically
1519
:param file_ids: The file ids to stop versioning.
1520
:raises: NoSuchId if any fileid is not currently versioned.
1522
for file_id in file_ids:
1523
if self._inventory.has_id(file_id):
1524
self._inventory.remove_recursive_id(file_id)
1526
raise errors.NoSuchId(self, file_id)
1528
# in the future this should just set a dirty bit to wait for the
1529
# final unlock. However, until all methods of workingtree start
1530
# with the current in -memory inventory rather than triggering
1531
# a read, it is more complex - we need to teach read_inventory
1532
# to know when to read, and when to not read first... and possibly
1533
# to save first when the in memory one may be corrupted.
1534
# so for now, we just only write it if it is indeed dirty.
1536
self._write_inventory(self._inventory)
1538
@deprecated_method(zero_eight)
1539
def iter_conflicts(self):
1540
"""List all files in the tree that have text or content conflicts.
1541
DEPRECATED. Use conflicts instead."""
1542
return self._iter_conflicts()
1544
def _iter_conflicts(self):
1546
for info in self.list_files():
1548
stem = get_conflicted_stem(path)
1551
if stem not in conflicted:
1552
conflicted.add(stem)
1556
def pull(self, source, overwrite=False, stop_revision=None,
1557
change_reporter=None, possible_transports=None):
1558
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1561
pp = ProgressPhase("Pull phase", 2, top_pb)
1563
old_revision_info = self.branch.last_revision_info()
1564
basis_tree = self.basis_tree()
1565
count = self.branch.pull(source, overwrite, stop_revision,
1566
possible_transports=possible_transports)
1567
new_revision_info = self.branch.last_revision_info()
1568
if new_revision_info != old_revision_info:
1570
repository = self.branch.repository
1571
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1572
basis_tree.lock_read()
1574
new_basis_tree = self.branch.basis_tree()
1581
change_reporter=change_reporter)
1582
if (basis_tree.inventory.root is None and
1583
new_basis_tree.inventory.root is not None):
1584
self.set_root_id(new_basis_tree.get_root_id())
1588
# TODO - dedup parents list with things merged by pull ?
1589
# reuse the revisiontree we merged against to set the new
1591
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1592
# we have to pull the merge trees out again, because
1593
# merge_inner has set the ids. - this corner is not yet
1594
# layered well enough to prevent double handling.
1595
# XXX TODO: Fix the double handling: telling the tree about
1596
# the already known parent data is wasteful.
1597
merges = self.get_parent_ids()[1:]
1598
parent_trees.extend([
1599
(parent, repository.revision_tree(parent)) for
1601
self.set_parent_trees(parent_trees)
1608
def put_file_bytes_non_atomic(self, file_id, bytes):
1609
"""See MutableTree.put_file_bytes_non_atomic."""
1610
stream = file(self.id2abspath(file_id), 'wb')
1615
# TODO: update the hashcache here ?
1618
"""Yield all unversioned files in this WorkingTree.
1620
If there are any unversioned directories then only the directory is
1621
returned, not all its children. But if there are unversioned files
1622
under a versioned subdirectory, they are returned.
1624
Currently returned depth-first, sorted by name within directories.
1625
This is the same order used by 'osutils.walkdirs'.
1627
## TODO: Work from given directory downwards
1628
for path, dir_entry in self.inventory.directories():
1629
# mutter("search for unknowns in %r", path)
1630
dirabs = self.abspath(path)
1631
if not isdir(dirabs):
1632
# e.g. directory deleted
1636
for subf in os.listdir(dirabs):
1639
if subf not in dir_entry.children:
1640
subf_norm, can_access = osutils.normalized_filename(subf)
1641
if subf_norm != subf and can_access:
1642
if subf_norm not in dir_entry.children:
1643
fl.append(subf_norm)
1649
subp = pathjoin(path, subf)
1652
def ignored_files(self):
1653
"""Yield list of PATH, IGNORE_PATTERN"""
1654
for subp in self.extras():
1655
pat = self.is_ignored(subp)
1659
def get_ignore_list(self):
1660
"""Return list of ignore patterns.
1662
Cached in the Tree object after the first call.
1664
ignoreset = getattr(self, '_ignoreset', None)
1665
if ignoreset is not None:
1668
ignore_globs = set()
1669
ignore_globs.update(ignores.get_runtime_ignores())
1670
ignore_globs.update(ignores.get_user_ignores())
1671
if self.has_filename(bzrlib.IGNORE_FILENAME):
1672
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1674
ignore_globs.update(ignores.parse_ignore_file(f))
1677
self._ignoreset = ignore_globs
1680
def _flush_ignore_list_cache(self):
1681
"""Resets the cached ignore list to force a cache rebuild."""
1682
self._ignoreset = None
1683
self._ignoreglobster = None
1685
def is_ignored(self, filename):
1686
r"""Check whether the filename matches an ignore pattern.
1688
Patterns containing '/' or '\' need to match the whole path;
1689
others match against only the last component.
1691
If the file is ignored, returns the pattern which caused it to
1692
be ignored, otherwise None. So this can simply be used as a
1693
boolean if desired."""
1694
if getattr(self, '_ignoreglobster', None) is None:
1695
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1696
return self._ignoreglobster.match(filename)
1698
def kind(self, file_id):
1699
return file_kind(self.id2abspath(file_id))
1701
def _comparison_data(self, entry, path):
1702
abspath = self.abspath(path)
1704
stat_value = os.lstat(abspath)
1706
if getattr(e, 'errno', None) == errno.ENOENT:
1713
mode = stat_value.st_mode
1714
kind = osutils.file_kind_from_stat_mode(mode)
1715
if not supports_executable():
1716
executable = entry is not None and entry.executable
1718
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1719
return kind, executable, stat_value
1721
def _file_size(self, entry, stat_value):
1722
return stat_value.st_size
1724
def last_revision(self):
1725
"""Return the last revision of the branch for this tree.
1727
This format tree does not support a separate marker for last-revision
1728
compared to the branch.
1730
See MutableTree.last_revision
1732
return self._last_revision()
1735
def _last_revision(self):
1736
"""helper for get_parent_ids."""
1737
return _mod_revision.ensure_null(self.branch.last_revision())
1739
def is_locked(self):
1740
return self._control_files.is_locked()
1742
def _must_be_locked(self):
1743
if not self.is_locked():
1744
raise errors.ObjectNotLocked(self)
1746
def lock_read(self):
1747
"""See Branch.lock_read, and WorkingTree.unlock."""
1748
if not self.is_locked():
1750
self.branch.lock_read()
1752
return self._control_files.lock_read()
1754
self.branch.unlock()
1757
def lock_tree_write(self):
1758
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1759
if not self.is_locked():
1761
self.branch.lock_read()
1763
return self._control_files.lock_write()
1765
self.branch.unlock()
1768
def lock_write(self):
1769
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1770
if not self.is_locked():
1772
self.branch.lock_write()
1774
return self._control_files.lock_write()
1776
self.branch.unlock()
1779
def get_physical_lock_status(self):
1780
return self._control_files.get_physical_lock_status()
1782
def _basis_inventory_name(self):
1783
return 'basis-inventory-cache'
1785
def _reset_data(self):
1786
"""Reset transient data that cannot be revalidated."""
1787
self._inventory_is_modified = False
1788
result = self._deserialize(self._control_files.get('inventory'))
1789
self._set_inventory(result, dirty=False)
1791
@needs_tree_write_lock
1792
def set_last_revision(self, new_revision):
1793
"""Change the last revision in the working tree."""
1794
if self._change_last_revision(new_revision):
1795
self._cache_basis_inventory(new_revision)
1797
def _change_last_revision(self, new_revision):
1798
"""Template method part of set_last_revision to perform the change.
1800
This is used to allow WorkingTree3 instances to not affect branch
1801
when their last revision is set.
1803
if _mod_revision.is_null(new_revision):
1804
self.branch.set_revision_history([])
1807
self.branch.generate_revision_history(new_revision)
1808
except errors.NoSuchRevision:
1809
# not present in the repo - dont try to set it deeper than the tip
1810
self.branch.set_revision_history([new_revision])
1813
def _write_basis_inventory(self, xml):
1814
"""Write the basis inventory XML to the basis-inventory file"""
1815
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1816
path = self._basis_inventory_name()
1818
self._control_files.put(path, sio)
1820
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1821
"""Create the text that will be saved in basis-inventory"""
1822
inventory.revision_id = revision_id
1823
return xml7.serializer_v7.write_inventory_to_string(inventory)
1825
def _cache_basis_inventory(self, new_revision):
1826
"""Cache new_revision as the basis inventory."""
1827
# TODO: this should allow the ready-to-use inventory to be passed in,
1828
# as commit already has that ready-to-use [while the format is the
1831
# this double handles the inventory - unpack and repack -
1832
# but is easier to understand. We can/should put a conditional
1833
# in here based on whether the inventory is in the latest format
1834
# - perhaps we should repack all inventories on a repository
1836
# the fast path is to copy the raw xml from the repository. If the
1837
# xml contains 'revision_id="', then we assume the right
1838
# revision_id is set. We must check for this full string, because a
1839
# root node id can legitimately look like 'revision_id' but cannot
1841
xml = self.branch.repository.get_inventory_xml(new_revision)
1842
firstline = xml.split('\n', 1)[0]
1843
if (not 'revision_id="' in firstline or
1844
'format="7"' not in firstline):
1845
inv = self.branch.repository.deserialise_inventory(
1847
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1848
self._write_basis_inventory(xml)
1849
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1852
def read_basis_inventory(self):
1853
"""Read the cached basis inventory."""
1854
path = self._basis_inventory_name()
1855
return self._control_files.get(path).read()
1858
def read_working_inventory(self):
1859
"""Read the working inventory.
1861
:raises errors.InventoryModified: read_working_inventory will fail
1862
when the current in memory inventory has been modified.
1864
# conceptually this should be an implementation detail of the tree.
1865
# XXX: Deprecate this.
1866
# ElementTree does its own conversion from UTF-8, so open in
1868
if self._inventory_is_modified:
1869
raise errors.InventoryModified(self)
1870
result = self._deserialize(self._control_files.get('inventory'))
1871
self._set_inventory(result, dirty=False)
1874
@needs_tree_write_lock
1875
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1877
"""Remove nominated files from the working inventory.
1879
:files: File paths relative to the basedir.
1880
:keep_files: If true, the files will also be kept.
1881
:force: Delete files and directories, even if they are changed and
1882
even if the directories are not empty.
1884
if isinstance(files, basestring):
1890
unknown_nested_files=set()
1892
def recurse_directory_to_add_files(directory):
1893
# Recurse directory and add all files
1894
# so we can check if they have changed.
1895
for parent_info, file_infos in\
1896
osutils.walkdirs(self.abspath(directory),
1898
for relpath, basename, kind, lstat, abspath in file_infos:
1899
# Is it versioned or ignored?
1900
if self.path2id(relpath) or self.is_ignored(relpath):
1901
# Add nested content for deletion.
1902
new_files.add(relpath)
1904
# Files which are not versioned and not ignored
1905
# should be treated as unknown.
1906
unknown_nested_files.add((relpath, None, kind))
1908
for filename in files:
1909
# Get file name into canonical form.
1910
abspath = self.abspath(filename)
1911
filename = self.relpath(abspath)
1912
if len(filename) > 0:
1913
new_files.add(filename)
1914
if osutils.isdir(abspath):
1915
recurse_directory_to_add_files(filename)
1917
files = list(new_files)
1920
return # nothing to do
1922
# Sort needed to first handle directory content before the directory
1923
files.sort(reverse=True)
1925
# Bail out if we are going to delete files we shouldn't
1926
if not keep_files and not force:
1927
has_changed_files = len(unknown_nested_files) > 0
1928
if not has_changed_files:
1929
for (file_id, path, content_change, versioned, parent_id, name,
1930
kind, executable) in self._iter_changes(self.basis_tree(),
1931
include_unchanged=True, require_versioned=False,
1932
want_unversioned=True, specific_files=files):
1933
if versioned == (False, False):
1934
# The record is unknown ...
1935
if not self.is_ignored(path[1]):
1936
# ... but not ignored
1937
has_changed_files = True
1939
elif content_change and (kind[1] != None):
1940
# Versioned and changed, but not deleted
1941
has_changed_files = True
1944
if has_changed_files:
1945
# Make delta show ALL applicable changes in error message.
1946
tree_delta = self.changes_from(self.basis_tree(),
1947
require_versioned=False, want_unversioned=True,
1948
specific_files=files)
1949
for unknown_file in unknown_nested_files:
1950
if unknown_file not in tree_delta.unversioned:
1951
tree_delta.unversioned.extend((unknown_file,))
1952
raise errors.BzrRemoveChangedFilesError(tree_delta)
1954
# Build inv_delta and delete files where applicaple,
1955
# do this before any modifications to inventory.
1957
fid = self.path2id(f)
1960
message = "%s is not versioned." % (f,)
1963
# having removed it, it must be either ignored or unknown
1964
if self.is_ignored(f):
1968
textui.show_status(new_status, self.kind(fid), f,
1971
inv_delta.append((f, None, fid, None))
1972
message = "removed %s" % (f,)
1975
abs_path = self.abspath(f)
1976
if osutils.lexists(abs_path):
1977
if (osutils.isdir(abs_path) and
1978
len(os.listdir(abs_path)) > 0):
1980
osutils.rmtree(abs_path)
1982
message = "%s is not an empty directory "\
1983
"and won't be deleted." % (f,)
1985
osutils.delete_any(abs_path)
1986
message = "deleted %s" % (f,)
1987
elif message is not None:
1988
# Only care if we haven't done anything yet.
1989
message = "%s does not exist." % (f,)
1991
# Print only one message (if any) per file.
1992
if message is not None:
1994
self.apply_inventory_delta(inv_delta)
1996
@needs_tree_write_lock
1997
def revert(self, filenames=None, old_tree=None, backups=True,
1998
pb=DummyProgress(), report_changes=False):
1999
from bzrlib.conflicts import resolve
2002
symbol_versioning.warn('Using [] to revert all files is deprecated'
2003
' as of bzr 0.91. Please use None (the default) instead.',
2004
DeprecationWarning, stacklevel=2)
2005
if old_tree is None:
2006
basis_tree = self.basis_tree()
2007
basis_tree.lock_read()
2008
old_tree = basis_tree
2012
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2014
if filenames is None and len(self.get_parent_ids()) > 1:
2016
last_revision = self.last_revision()
2017
if last_revision != NULL_REVISION:
2018
if basis_tree is None:
2019
basis_tree = self.basis_tree()
2020
basis_tree.lock_read()
2021
parent_trees.append((last_revision, basis_tree))
2022
self.set_parent_trees(parent_trees)
2025
resolve(self, filenames, ignore_misses=True, recursive=True)
2027
if basis_tree is not None:
2031
def revision_tree(self, revision_id):
2032
"""See Tree.revision_tree.
2034
WorkingTree can supply revision_trees for the basis revision only
2035
because there is only one cached inventory in the bzr directory.
2037
if revision_id == self.last_revision():
2039
xml = self.read_basis_inventory()
2040
except errors.NoSuchFile:
2044
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2045
# dont use the repository revision_tree api because we want
2046
# to supply the inventory.
2047
if inv.revision_id == revision_id:
2048
return revisiontree.RevisionTree(self.branch.repository,
2050
except errors.BadInventoryFormat:
2052
# raise if there was no inventory, or if we read the wrong inventory.
2053
raise errors.NoSuchRevisionInTree(self, revision_id)
2055
# XXX: This method should be deprecated in favour of taking in a proper
2056
# new Inventory object.
2057
@needs_tree_write_lock
2058
def set_inventory(self, new_inventory_list):
2059
from bzrlib.inventory import (Inventory,
2064
inv = Inventory(self.get_root_id())
2065
for path, file_id, parent, kind in new_inventory_list:
2066
name = os.path.basename(path)
2069
# fixme, there should be a factory function inv,add_??
2070
if kind == 'directory':
2071
inv.add(InventoryDirectory(file_id, name, parent))
2072
elif kind == 'file':
2073
inv.add(InventoryFile(file_id, name, parent))
2074
elif kind == 'symlink':
2075
inv.add(InventoryLink(file_id, name, parent))
2077
raise errors.BzrError("unknown kind %r" % kind)
2078
self._write_inventory(inv)
2080
@needs_tree_write_lock
2081
def set_root_id(self, file_id):
2082
"""Set the root id for this tree."""
2085
symbol_versioning.warn(symbol_versioning.zero_twelve
2086
% 'WorkingTree.set_root_id with fileid=None',
2091
file_id = osutils.safe_file_id(file_id)
2092
self._set_root_id(file_id)
2094
def _set_root_id(self, file_id):
2095
"""Set the root id for this tree, in a format specific manner.
2097
:param file_id: The file id to assign to the root. It must not be
2098
present in the current inventory or an error will occur. It must
2099
not be None, but rather a valid file id.
2101
inv = self._inventory
2102
orig_root_id = inv.root.file_id
2103
# TODO: it might be nice to exit early if there was nothing
2104
# to do, saving us from trigger a sync on unlock.
2105
self._inventory_is_modified = True
2106
# we preserve the root inventory entry object, but
2107
# unlinkit from the byid index
2108
del inv._byid[inv.root.file_id]
2109
inv.root.file_id = file_id
2110
# and link it into the index with the new changed id.
2111
inv._byid[inv.root.file_id] = inv.root
2112
# and finally update all children to reference the new id.
2113
# XXX: this should be safe to just look at the root.children
2114
# list, not the WHOLE INVENTORY.
2117
if entry.parent_id == orig_root_id:
2118
entry.parent_id = inv.root.file_id
2121
"""See Branch.unlock.
2123
WorkingTree locking just uses the Branch locking facilities.
2124
This is current because all working trees have an embedded branch
2125
within them. IF in the future, we were to make branch data shareable
2126
between multiple working trees, i.e. via shared storage, then we
2127
would probably want to lock both the local tree, and the branch.
2129
raise NotImplementedError(self.unlock)
2131
def update(self, change_reporter=None, possible_transports=None):
2132
"""Update a working tree along its branch.
2134
This will update the branch if its bound too, which means we have
2135
multiple trees involved:
2137
- The new basis tree of the master.
2138
- The old basis tree of the branch.
2139
- The old basis tree of the working tree.
2140
- The current working tree state.
2142
Pathologically, all three may be different, and non-ancestors of each
2143
other. Conceptually we want to:
2145
- Preserve the wt.basis->wt.state changes
2146
- Transform the wt.basis to the new master basis.
2147
- Apply a merge of the old branch basis to get any 'local' changes from
2149
- Restore the wt.basis->wt.state changes.
2151
There isn't a single operation at the moment to do that, so we:
2152
- Merge current state -> basis tree of the master w.r.t. the old tree
2154
- Do a 'normal' merge of the old branch basis if it is relevant.
2156
if self.branch.get_master_branch(possible_transports) is not None:
2158
update_branch = True
2160
self.lock_tree_write()
2161
update_branch = False
2164
old_tip = self.branch.update(possible_transports)
2167
return self._update_tree(old_tip, change_reporter)
2171
@needs_tree_write_lock
2172
def _update_tree(self, old_tip=None, change_reporter=None):
2173
"""Update a tree to the master branch.
2175
:param old_tip: if supplied, the previous tip revision the branch,
2176
before it was changed to the master branch's tip.
2178
# here if old_tip is not None, it is the old tip of the branch before
2179
# it was updated from the master branch. This should become a pending
2180
# merge in the working tree to preserve the user existing work. we
2181
# cant set that until we update the working trees last revision to be
2182
# one from the new branch, because it will just get absorbed by the
2183
# parent de-duplication logic.
2185
# We MUST save it even if an error occurs, because otherwise the users
2186
# local work is unreferenced and will appear to have been lost.
2190
last_rev = self.get_parent_ids()[0]
2192
last_rev = _mod_revision.NULL_REVISION
2193
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2194
# merge tree state up to new branch tip.
2195
basis = self.basis_tree()
2198
to_tree = self.branch.basis_tree()
2199
if basis.inventory.root is None:
2200
self.set_root_id(to_tree.get_root_id())
2202
result += merge.merge_inner(
2207
change_reporter=change_reporter)
2210
# TODO - dedup parents list with things merged by pull ?
2211
# reuse the tree we've updated to to set the basis:
2212
parent_trees = [(self.branch.last_revision(), to_tree)]
2213
merges = self.get_parent_ids()[1:]
2214
# Ideally we ask the tree for the trees here, that way the working
2215
# tree can decide whether to give us teh entire tree or give us a
2216
# lazy initialised tree. dirstate for instance will have the trees
2217
# in ram already, whereas a last-revision + basis-inventory tree
2218
# will not, but also does not need them when setting parents.
2219
for parent in merges:
2220
parent_trees.append(
2221
(parent, self.branch.repository.revision_tree(parent)))
2222
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2223
parent_trees.append(
2224
(old_tip, self.branch.repository.revision_tree(old_tip)))
2225
self.set_parent_trees(parent_trees)
2226
last_rev = parent_trees[0][0]
2228
# the working tree had the same last-revision as the master
2229
# branch did. We may still have pivot local work from the local
2230
# branch into old_tip:
2231
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2232
self.add_parent_tree_id(old_tip)
2233
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2234
and old_tip != last_rev):
2235
# our last revision was not the prior branch last revision
2236
# and we have converted that last revision to a pending merge.
2237
# base is somewhere between the branch tip now
2238
# and the now pending merge
2240
# Since we just modified the working tree and inventory, flush out
2241
# the current state, before we modify it again.
2242
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2243
# requires it only because TreeTransform directly munges the
2244
# inventory and calls tree._write_inventory(). Ultimately we
2245
# should be able to remove this extra flush.
2247
graph = self.branch.repository.get_graph()
2248
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2250
base_tree = self.branch.repository.revision_tree(base_rev_id)
2251
other_tree = self.branch.repository.revision_tree(old_tip)
2252
result += merge.merge_inner(
2257
change_reporter=change_reporter)
2260
def _write_hashcache_if_dirty(self):
2261
"""Write out the hashcache if it is dirty."""
2262
if self._hashcache.needs_write:
2264
self._hashcache.write()
2266
if e.errno not in (errno.EPERM, errno.EACCES):
2268
# TODO: jam 20061219 Should this be a warning? A single line
2269
# warning might be sufficient to let the user know what
2271
mutter('Could not write hashcache for %s\nError: %s',
2272
self._hashcache.cache_file_name(), e)
2274
@needs_tree_write_lock
2275
def _write_inventory(self, inv):
2276
"""Write inventory as the current inventory."""
2277
self._set_inventory(inv, dirty=True)
2280
def set_conflicts(self, arg):
2281
raise errors.UnsupportedOperation(self.set_conflicts, self)
2283
def add_conflicts(self, arg):
2284
raise errors.UnsupportedOperation(self.add_conflicts, self)
2287
def conflicts(self):
2288
conflicts = _mod_conflicts.ConflictList()
2289
for conflicted in self._iter_conflicts():
2292
if file_kind(self.abspath(conflicted)) != "file":
2294
except errors.NoSuchFile:
2297
for suffix in ('.THIS', '.OTHER'):
2299
kind = file_kind(self.abspath(conflicted+suffix))
2302
except errors.NoSuchFile:
2306
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2307
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2309
file_id=self.path2id(conflicted)))
2312
def walkdirs(self, prefix=""):
2313
"""Walk the directories of this tree.
2315
returns a generator which yields items in the form:
2316
((curren_directory_path, fileid),
2317
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2320
This API returns a generator, which is only valid during the current
2321
tree transaction - within a single lock_read or lock_write duration.
2323
If the tree is not locked, it may cause an error to be raised,
2324
depending on the tree implementation.
2326
disk_top = self.abspath(prefix)
2327
if disk_top.endswith('/'):
2328
disk_top = disk_top[:-1]
2329
top_strip_len = len(disk_top) + 1
2330
inventory_iterator = self._walkdirs(prefix)
2331
disk_iterator = osutils.walkdirs(disk_top, prefix)
2333
current_disk = disk_iterator.next()
2334
disk_finished = False
2336
if not (e.errno == errno.ENOENT or
2337
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2340
disk_finished = True
2342
current_inv = inventory_iterator.next()
2343
inv_finished = False
2344
except StopIteration:
2347
while not inv_finished or not disk_finished:
2349
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2350
cur_disk_dir_content) = current_disk
2352
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2353
cur_disk_dir_content) = ((None, None), None)
2354
if not disk_finished:
2355
# strip out .bzr dirs
2356
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2357
len(cur_disk_dir_content) > 0):
2358
# osutils.walkdirs can be made nicer -
2359
# yield the path-from-prefix rather than the pathjoined
2361
bzrdir_loc = bisect_left(cur_disk_dir_content,
2363
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2364
# we dont yield the contents of, or, .bzr itself.
2365
del cur_disk_dir_content[bzrdir_loc]
2367
# everything is unknown
2370
# everything is missing
2373
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2375
# disk is before inventory - unknown
2376
dirblock = [(relpath, basename, kind, stat, None, None) for
2377
relpath, basename, kind, stat, top_path in
2378
cur_disk_dir_content]
2379
yield (cur_disk_dir_relpath, None), dirblock
2381
current_disk = disk_iterator.next()
2382
except StopIteration:
2383
disk_finished = True
2385
# inventory is before disk - missing.
2386
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2387
for relpath, basename, dkind, stat, fileid, kind in
2389
yield (current_inv[0][0], current_inv[0][1]), dirblock
2391
current_inv = inventory_iterator.next()
2392
except StopIteration:
2395
# versioned present directory
2396
# merge the inventory and disk data together
2398
for relpath, subiterator in itertools.groupby(sorted(
2399
current_inv[1] + cur_disk_dir_content,
2400
key=operator.itemgetter(0)), operator.itemgetter(1)):
2401
path_elements = list(subiterator)
2402
if len(path_elements) == 2:
2403
inv_row, disk_row = path_elements
2404
# versioned, present file
2405
dirblock.append((inv_row[0],
2406
inv_row[1], disk_row[2],
2407
disk_row[3], inv_row[4],
2409
elif len(path_elements[0]) == 5:
2411
dirblock.append((path_elements[0][0],
2412
path_elements[0][1], path_elements[0][2],
2413
path_elements[0][3], None, None))
2414
elif len(path_elements[0]) == 6:
2415
# versioned, absent file.
2416
dirblock.append((path_elements[0][0],
2417
path_elements[0][1], 'unknown', None,
2418
path_elements[0][4], path_elements[0][5]))
2420
raise NotImplementedError('unreachable code')
2421
yield current_inv[0], dirblock
2423
current_inv = inventory_iterator.next()
2424
except StopIteration:
2427
current_disk = disk_iterator.next()
2428
except StopIteration:
2429
disk_finished = True
2431
def _walkdirs(self, prefix=""):
2432
"""Walk the directories of this tree.
2434
:prefix: is used as the directrory to start with.
2435
returns a generator which yields items in the form:
2436
((curren_directory_path, fileid),
2437
[(file1_path, file1_name, file1_kind, None, file1_id,
2440
_directory = 'directory'
2441
# get the root in the inventory
2442
inv = self.inventory
2443
top_id = inv.path2id(prefix)
2447
pending = [(prefix, '', _directory, None, top_id, None)]
2450
currentdir = pending.pop()
2451
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2452
top_id = currentdir[4]
2454
relroot = currentdir[0] + '/'
2457
# FIXME: stash the node in pending
2459
for name, child in entry.sorted_children():
2460
dirblock.append((relroot + name, name, child.kind, None,
2461
child.file_id, child.kind
2463
yield (currentdir[0], entry.file_id), dirblock
2464
# push the user specified dirs from dirblock
2465
for dir in reversed(dirblock):
2466
if dir[2] == _directory:
2469
@needs_tree_write_lock
2470
def auto_resolve(self):
2471
"""Automatically resolve text conflicts according to contents.
2473
Only text conflicts are auto_resolvable. Files with no conflict markers
2474
are considered 'resolved', because bzr always puts conflict markers
2475
into files that have text conflicts. The corresponding .THIS .BASE and
2476
.OTHER files are deleted, as per 'resolve'.
2477
:return: a tuple of ConflictLists: (un_resolved, resolved).
2479
un_resolved = _mod_conflicts.ConflictList()
2480
resolved = _mod_conflicts.ConflictList()
2481
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2482
for conflict in self.conflicts():
2483
if (conflict.typestring != 'text conflict' or
2484
self.kind(conflict.file_id) != 'file'):
2485
un_resolved.append(conflict)
2487
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2489
for line in my_file:
2490
if conflict_re.search(line):
2491
un_resolved.append(conflict)
2494
resolved.append(conflict)
2497
resolved.remove_files(self)
2498
self.set_conflicts(un_resolved)
2499
return un_resolved, resolved
2501
def _validate(self):
2502
"""Validate internal structures.
2504
This is meant mostly for the test suite. To give it a chance to detect
2505
corruption after actions have occurred. The default implementation is a
2508
:return: None. An exception should be raised if there is an error.
2513
class WorkingTree2(WorkingTree):
2514
"""This is the Format 2 working tree.
2516
This was the first weave based working tree.
2517
- uses os locks for locking.
2518
- uses the branch last-revision.
2521
def __init__(self, *args, **kwargs):
2522
super(WorkingTree2, self).__init__(*args, **kwargs)
2523
# WorkingTree2 has more of a constraint that self._inventory must
2524
# exist. Because this is an older format, we don't mind the overhead
2525
# caused by the extra computation here.
2527
# Newer WorkingTree's should only have self._inventory set when they
2529
if self._inventory is None:
2530
self.read_working_inventory()
2532
def lock_tree_write(self):
2533
"""See WorkingTree.lock_tree_write().
2535
In Format2 WorkingTrees we have a single lock for the branch and tree
2536
so lock_tree_write() degrades to lock_write().
2538
self.branch.lock_write()
2540
return self._control_files.lock_write()
2542
self.branch.unlock()
2546
# do non-implementation specific cleanup
2549
# we share control files:
2550
if self._control_files._lock_count == 3:
2551
# _inventory_is_modified is always False during a read lock.
2552
if self._inventory_is_modified:
2554
self._write_hashcache_if_dirty()
2556
# reverse order of locking.
2558
return self._control_files.unlock()
2560
self.branch.unlock()
2563
class WorkingTree3(WorkingTree):
2564
"""This is the Format 3 working tree.
2566
This differs from the base WorkingTree by:
2567
- having its own file lock
2568
- having its own last-revision property.
2570
This is new in bzr 0.8
2574
def _last_revision(self):
2575
"""See Mutable.last_revision."""
2577
return self._control_files.get('last-revision').read()
2578
except errors.NoSuchFile:
2579
return _mod_revision.NULL_REVISION
2581
def _change_last_revision(self, revision_id):
2582
"""See WorkingTree._change_last_revision."""
2583
if revision_id is None or revision_id == NULL_REVISION:
2585
self._control_files._transport.delete('last-revision')
2586
except errors.NoSuchFile:
2590
self._control_files.put_bytes('last-revision', revision_id)
2593
@needs_tree_write_lock
2594
def set_conflicts(self, conflicts):
2595
self._put_rio('conflicts', conflicts.to_stanzas(),
2598
@needs_tree_write_lock
2599
def add_conflicts(self, new_conflicts):
2600
conflict_set = set(self.conflicts())
2601
conflict_set.update(set(list(new_conflicts)))
2602
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2603
key=_mod_conflicts.Conflict.sort_key)))
2606
def conflicts(self):
2608
confile = self._control_files.get('conflicts')
2609
except errors.NoSuchFile:
2610
return _mod_conflicts.ConflictList()
2612
if confile.next() != CONFLICT_HEADER_1 + '\n':
2613
raise errors.ConflictFormatError()
2614
except StopIteration:
2615
raise errors.ConflictFormatError()
2616
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2619
# do non-implementation specific cleanup
2621
if self._control_files._lock_count == 1:
2622
# _inventory_is_modified is always False during a read lock.
2623
if self._inventory_is_modified:
2625
self._write_hashcache_if_dirty()
2626
# reverse order of locking.
2628
return self._control_files.unlock()
2630
self.branch.unlock()
2633
def get_conflicted_stem(path):
2634
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2635
if path.endswith(suffix):
2636
return path[:-len(suffix)]
2639
@deprecated_function(zero_eight)
2640
def is_control_file(filename):
2641
"""See WorkingTree.is_control_filename(filename)."""
2642
## FIXME: better check
2643
filename = normpath(filename)
2644
while filename != '':
2645
head, tail = os.path.split(filename)
2646
## mutter('check %r for control file' % ((head, tail),))
2649
if filename == head:
2655
class WorkingTreeFormat(object):
2656
"""An encapsulation of the initialization and open routines for a format.
2658
Formats provide three things:
2659
* An initialization routine,
2663
Formats are placed in an dict by their format string for reference
2664
during workingtree opening. Its not required that these be instances, they
2665
can be classes themselves with class methods - it simply depends on
2666
whether state is needed for a given format or not.
2668
Once a format is deprecated, just deprecate the initialize and open
2669
methods on the format class. Do not deprecate the object, as the
2670
object will be created every time regardless.
2673
_default_format = None
2674
"""The default format used for new trees."""
2677
"""The known formats."""
2679
requires_rich_root = False
2681
upgrade_recommended = False
2684
def find_format(klass, a_bzrdir):
2685
"""Return the format for the working tree object in a_bzrdir."""
2687
transport = a_bzrdir.get_workingtree_transport(None)
2688
format_string = transport.get("format").read()
2689
return klass._formats[format_string]
2690
except errors.NoSuchFile:
2691
raise errors.NoWorkingTree(base=transport.base)
2693
raise errors.UnknownFormatError(format=format_string)
2695
def __eq__(self, other):
2696
return self.__class__ is other.__class__
2698
def __ne__(self, other):
2699
return not (self == other)
2702
def get_default_format(klass):
2703
"""Return the current default format."""
2704
return klass._default_format
2706
def get_format_string(self):
2707
"""Return the ASCII format string that identifies this format."""
2708
raise NotImplementedError(self.get_format_string)
2710
def get_format_description(self):
2711
"""Return the short description for this format."""
2712
raise NotImplementedError(self.get_format_description)
2714
def is_supported(self):
2715
"""Is this format supported?
2717
Supported formats can be initialized and opened.
2718
Unsupported formats may not support initialization or committing or
2719
some other features depending on the reason for not being supported.
2724
def register_format(klass, format):
2725
klass._formats[format.get_format_string()] = format
2728
def set_default_format(klass, format):
2729
klass._default_format = format
2732
def unregister_format(klass, format):
2733
assert klass._formats[format.get_format_string()] is format
2734
del klass._formats[format.get_format_string()]
2737
class WorkingTreeFormat2(WorkingTreeFormat):
2738
"""The second working tree format.
2740
This format modified the hash cache from the format 1 hash cache.
2743
upgrade_recommended = True
2745
def get_format_description(self):
2746
"""See WorkingTreeFormat.get_format_description()."""
2747
return "Working tree format 2"
2749
def stub_initialize_remote(self, control_files):
2750
"""As a special workaround create critical control files for a remote working tree
2752
This ensures that it can later be updated and dealt with locally,
2753
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2754
no working tree. (See bug #43064).
2758
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2760
control_files.put('inventory', sio)
2762
control_files.put_bytes('pending-merges', '')
2765
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2766
accelerator_tree=None, hardlink=False):
2767
"""See WorkingTreeFormat.initialize()."""
2768
if not isinstance(a_bzrdir.transport, LocalTransport):
2769
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2770
if from_branch is not None:
2771
branch = from_branch
2773
branch = a_bzrdir.open_branch()
2774
if revision_id is None:
2775
revision_id = _mod_revision.ensure_null(branch.last_revision())
2778
branch.generate_revision_history(revision_id)
2782
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2788
basis_tree = branch.repository.revision_tree(revision_id)
2789
if basis_tree.inventory.root is not None:
2790
wt.set_root_id(basis_tree.get_root_id())
2791
# set the parent list and cache the basis tree.
2792
if _mod_revision.is_null(revision_id):
2795
parent_trees = [(revision_id, basis_tree)]
2796
wt.set_parent_trees(parent_trees)
2797
transform.build_tree(basis_tree, wt)
2801
super(WorkingTreeFormat2, self).__init__()
2802
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2804
def open(self, a_bzrdir, _found=False):
2805
"""Return the WorkingTree object for a_bzrdir
2807
_found is a private parameter, do not use it. It is used to indicate
2808
if format probing has already been done.
2811
# we are being called directly and must probe.
2812
raise NotImplementedError
2813
if not isinstance(a_bzrdir.transport, LocalTransport):
2814
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2815
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2821
class WorkingTreeFormat3(WorkingTreeFormat):
2822
"""The second working tree format updated to record a format marker.
2825
- exists within a metadir controlling .bzr
2826
- includes an explicit version marker for the workingtree control
2827
files, separate from the BzrDir format
2828
- modifies the hash cache format
2830
- uses a LockDir to guard access for writes.
2833
upgrade_recommended = True
2835
def get_format_string(self):
2836
"""See WorkingTreeFormat.get_format_string()."""
2837
return "Bazaar-NG Working Tree format 3"
2839
def get_format_description(self):
2840
"""See WorkingTreeFormat.get_format_description()."""
2841
return "Working tree format 3"
2843
_lock_file_name = 'lock'
2844
_lock_class = LockDir
2846
_tree_class = WorkingTree3
2848
def __get_matchingbzrdir(self):
2849
return bzrdir.BzrDirMetaFormat1()
2851
_matchingbzrdir = property(__get_matchingbzrdir)
2853
def _open_control_files(self, a_bzrdir):
2854
transport = a_bzrdir.get_workingtree_transport(None)
2855
return LockableFiles(transport, self._lock_file_name,
2858
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2859
accelerator_tree=None, hardlink=False):
2860
"""See WorkingTreeFormat.initialize().
2862
:param revision_id: if supplied, create a working tree at a different
2863
revision than the branch is at.
2864
:param accelerator_tree: A tree which can be used for retrieving file
2865
contents more quickly than the revision tree, i.e. a workingtree.
2866
The revision tree will be used for cases where accelerator_tree's
2867
content is different.
2868
:param hardlink: If true, hard-link files from accelerator_tree,
2871
if not isinstance(a_bzrdir.transport, LocalTransport):
2872
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2873
transport = a_bzrdir.get_workingtree_transport(self)
2874
control_files = self._open_control_files(a_bzrdir)
2875
control_files.create_lock()
2876
control_files.lock_write()
2877
control_files.put_utf8('format', self.get_format_string())
2878
if from_branch is not None:
2879
branch = from_branch
2881
branch = a_bzrdir.open_branch()
2882
if revision_id is None:
2883
revision_id = _mod_revision.ensure_null(branch.last_revision())
2884
# WorkingTree3 can handle an inventory which has a unique root id.
2885
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2886
# those trees. And because there isn't a format bump inbetween, we
2887
# are maintaining compatibility with older clients.
2888
# inv = Inventory(root_id=gen_root_id())
2889
inv = self._initial_inventory()
2890
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2896
_control_files=control_files)
2897
wt.lock_tree_write()
2899
basis_tree = branch.repository.revision_tree(revision_id)
2900
# only set an explicit root id if there is one to set.
2901
if basis_tree.inventory.root is not None:
2902
wt.set_root_id(basis_tree.get_root_id())
2903
if revision_id == NULL_REVISION:
2904
wt.set_parent_trees([])
2906
wt.set_parent_trees([(revision_id, basis_tree)])
2907
transform.build_tree(basis_tree, wt)
2909
# Unlock in this order so that the unlock-triggers-flush in
2910
# WorkingTree is given a chance to fire.
2911
control_files.unlock()
2915
def _initial_inventory(self):
2919
super(WorkingTreeFormat3, self).__init__()
2921
def open(self, a_bzrdir, _found=False):
2922
"""Return the WorkingTree object for a_bzrdir
2924
_found is a private parameter, do not use it. It is used to indicate
2925
if format probing has already been done.
2928
# we are being called directly and must probe.
2929
raise NotImplementedError
2930
if not isinstance(a_bzrdir.transport, LocalTransport):
2931
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2932
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2935
def _open(self, a_bzrdir, control_files):
2936
"""Open the tree itself.
2938
:param a_bzrdir: the dir for the tree.
2939
:param control_files: the control files for the tree.
2941
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2945
_control_files=control_files)
2948
return self.get_format_string()
2951
__default_format = WorkingTreeFormat4()
2952
WorkingTreeFormat.register_format(__default_format)
2953
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2954
WorkingTreeFormat.set_default_format(__default_format)
2955
# formats which have no format string are not discoverable
2956
# and not independently creatable, so are not registered.
2957
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
