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.filters import filtered_input, filters_for_path
106
from bzrlib.trace import mutter, note
107
from bzrlib.transport.local import LocalTransport
108
from bzrlib.progress import DummyProgress, ProgressPhase
109
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
110
from bzrlib.rio import RioReader, rio_file, Stanza
111
from bzrlib.symbol_versioning import (deprecated_passed,
114
DEPRECATED_PARAMETER,
121
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
122
CONFLICT_HEADER_1 = "BZR conflict list format 1"
124
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
127
@deprecated_function(zero_thirteen)
128
def gen_file_id(name):
129
"""Return new file id for the basename 'name'.
131
Use bzrlib.generate_ids.gen_file_id() instead
133
return generate_ids.gen_file_id(name)
136
@deprecated_function(zero_thirteen)
138
"""Return a new tree-root file id.
140
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
142
return generate_ids.gen_root_id()
145
class TreeEntry(object):
146
"""An entry that implements the minimum interface used by commands.
148
This needs further inspection, it may be better to have
149
InventoryEntries without ids - though that seems wrong. For now,
150
this is a parallel hierarchy to InventoryEntry, and needs to become
151
one of several things: decorates to that hierarchy, children of, or
153
Another note is that these objects are currently only used when there is
154
no InventoryEntry available - i.e. for unversioned objects.
155
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
158
def __eq__(self, other):
159
# yes, this us ugly, TODO: best practice __eq__ style.
160
return (isinstance(other, TreeEntry)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class TreeDirectory(TreeEntry):
168
"""See TreeEntry. This is a directory in a working tree."""
170
def __eq__(self, other):
171
return (isinstance(other, TreeDirectory)
172
and other.__class__ == self.__class__)
174
def kind_character(self):
178
class TreeFile(TreeEntry):
179
"""See TreeEntry. This is a regular file in a working tree."""
181
def __eq__(self, other):
182
return (isinstance(other, TreeFile)
183
and other.__class__ == self.__class__)
185
def kind_character(self):
189
class TreeLink(TreeEntry):
190
"""See TreeEntry. This is a symlink in a working tree."""
192
def __eq__(self, other):
193
return (isinstance(other, TreeLink)
194
and other.__class__ == self.__class__)
196
def kind_character(self):
200
class WorkingTree(bzrlib.mutabletree.MutableTree):
201
"""Working copy tree.
203
The inventory is held in the `Branch` working-inventory, and the
204
files are in a directory on disk.
206
It is possible for a `WorkingTree` to have a filename which is
207
not listed in the Inventory and vice versa.
210
def __init__(self, basedir='.',
211
branch=DEPRECATED_PARAMETER,
217
"""Construct a WorkingTree instance. This is not a public API.
219
:param branch: A branch to override probing for the branch.
221
self._format = _format
222
self.bzrdir = _bzrdir
224
raise errors.BzrError("Please use bzrdir.open_workingtree or "
225
"WorkingTree.open() to obtain a WorkingTree.")
226
assert isinstance(basedir, basestring), \
227
"base directory %r is not a string" % basedir
228
basedir = safe_unicode(basedir)
229
mutter("opening working tree %r", basedir)
230
if deprecated_passed(branch):
231
self._branch = branch
233
self._branch = self.bzrdir.open_branch()
234
self.basedir = realpath(basedir)
235
# if branch is at our basedir and is a format 6 or less
236
if isinstance(self._format, WorkingTreeFormat2):
237
# share control object
238
self._control_files = self.branch.control_files
240
# assume all other formats have their own control files.
241
assert isinstance(_control_files, LockableFiles), \
242
"_control_files must be a LockableFiles, not %r" \
244
self._control_files = _control_files
245
# update the whole cache up front and write to disk if anything changed;
246
# in the future we might want to do this more selectively
247
# two possible ways offer themselves : in self._unlock, write the cache
248
# if needed, or, when the cache sees a change, append it to the hash
249
# cache file, and have the parser take the most recent entry for a
251
wt_trans = self.bzrdir.get_workingtree_transport(None)
252
cache_filename = wt_trans.local_abspath('stat-cache')
253
self._hashcache = hashcache.HashCache(basedir, cache_filename,
254
self._control_files._file_mode)
257
# is this scan needed ? it makes things kinda slow.
264
if _inventory is None:
265
# This will be acquired on lock_read() or lock_write()
266
self._inventory_is_modified = False
267
self._inventory = None
269
# the caller of __init__ has provided an inventory,
270
# we assume they know what they are doing - as its only
271
# the Format factory and creation methods that are
272
# permitted to do this.
273
self._set_inventory(_inventory, dirty=False)
274
self._detect_case_handling()
276
def _detect_case_handling(self):
277
wt_trans = self.bzrdir.get_workingtree_transport(None)
279
wt_trans.stat("FoRMaT")
280
except errors.NoSuchFile:
281
self.case_sensitive = True
283
self.case_sensitive = False
285
self._setup_directory_is_tree_reference()
288
fget=lambda self: self._branch,
289
doc="""The branch this WorkingTree is connected to.
291
This cannot be set - it is reflective of the actual disk structure
292
the working tree has been constructed from.
295
def break_lock(self):
296
"""Break a lock if one is present from another instance.
298
Uses the ui factory to ask for confirmation if the lock may be from
301
This will probe the repository for its lock as well.
303
self._control_files.break_lock()
304
self.branch.break_lock()
306
def requires_rich_root(self):
307
return self._format.requires_rich_root
309
def supports_tree_reference(self):
312
def _set_inventory(self, inv, dirty):
313
"""Set the internal cached inventory.
315
:param inv: The inventory to set.
316
:param dirty: A boolean indicating whether the inventory is the same
317
logical inventory as whats on disk. If True the inventory is not
318
the same and should be written to disk or data will be lost, if
319
False then the inventory is the same as that on disk and any
320
serialisation would be unneeded overhead.
322
assert inv.root is not None
323
self._inventory = inv
324
self._inventory_is_modified = dirty
327
def open(path=None, _unsupported=False):
328
"""Open an existing working tree at path.
332
path = os.path.getcwdu()
333
control = bzrdir.BzrDir.open(path, _unsupported)
334
return control.open_workingtree(_unsupported)
337
def open_containing(path=None):
338
"""Open an existing working tree which has its root about path.
340
This probes for a working tree at path and searches upwards from there.
342
Basically we keep looking up until we find the control directory or
343
run into /. If there isn't one, raises NotBranchError.
344
TODO: give this a new exception.
345
If there is one, it is returned, along with the unused portion of path.
347
:return: The WorkingTree that contains 'path', and the rest of path
350
path = osutils.getcwd()
351
control, relpath = bzrdir.BzrDir.open_containing(path)
353
return control.open_workingtree(), relpath
356
def open_downlevel(path=None):
357
"""Open an unsupported working tree.
359
Only intended for advanced situations like upgrading part of a bzrdir.
361
return WorkingTree.open(path, _unsupported=True)
364
def find_trees(location):
365
def list_current(transport):
366
return [d for d in transport.list_dir('') if d != '.bzr']
367
def evaluate(bzrdir):
369
tree = bzrdir.open_workingtree()
370
except errors.NoWorkingTree:
374
transport = get_transport(location)
375
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
376
list_current=list_current)
377
return [t for t in iterator if t is not None]
379
# should be deprecated - this is slow and in any case treating them as a
380
# container is (we now know) bad style -- mbp 20070302
381
## @deprecated_method(zero_fifteen)
383
"""Iterate through file_ids for this tree.
385
file_ids are in a WorkingTree if they are in the working inventory
386
and the working file exists.
388
inv = self._inventory
389
for path, ie in inv.iter_entries():
390
if osutils.lexists(self.abspath(path)):
393
def all_file_ids(self):
394
"""See Tree.iter_all_file_ids"""
395
return set(self.inventory)
398
return "<%s of %s>" % (self.__class__.__name__,
399
getattr(self, 'basedir', None))
401
def abspath(self, filename):
402
return pathjoin(self.basedir, filename)
404
def basis_tree(self):
405
"""Return RevisionTree for the current last revision.
407
If the left most parent is a ghost then the returned tree will be an
408
empty tree - one obtained by calling repository.revision_tree(None).
411
revision_id = self.get_parent_ids()[0]
413
# no parents, return an empty revision tree.
414
# in the future this should return the tree for
415
# 'empty:' - the implicit root empty tree.
416
return self.branch.repository.revision_tree(None)
418
return self.revision_tree(revision_id)
419
except errors.NoSuchRevision:
421
# No cached copy available, retrieve from the repository.
422
# FIXME? RBC 20060403 should we cache the inventory locally
425
return self.branch.repository.revision_tree(revision_id)
426
except errors.RevisionNotPresent:
427
# the basis tree *may* be a ghost or a low level error may have
428
# occured. If the revision is present, its a problem, if its not
430
if self.branch.repository.has_revision(revision_id):
432
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(None)
436
self._flush_ignore_list_cache()
439
@deprecated_method(zero_eight)
440
def create(branch, directory):
441
"""Create a workingtree for branch at directory.
443
If existing_directory already exists it must have a .bzr directory.
444
If it does not exist, it will be created.
446
This returns a new WorkingTree object for the new checkout.
448
TODO FIXME RBC 20060124 when we have checkout formats in place this
449
should accept an optional revisionid to checkout [and reject this if
450
checking out into the same dir as a pre-checkout-aware branch format.]
452
XXX: When BzrDir is present, these should be created through that
455
warnings.warn('delete WorkingTree.create', stacklevel=3)
456
transport = get_transport(directory)
457
if branch.bzrdir.root_transport.base == transport.base:
459
return branch.bzrdir.create_workingtree()
460
# different directory,
461
# create a branch reference
462
# and now a working tree.
463
raise NotImplementedError
466
@deprecated_method(zero_eight)
467
def create_standalone(directory):
468
"""Create a checkout and a branch and a repo at directory.
470
Directory must exist and be empty.
472
please use BzrDir.create_standalone_workingtree
474
return bzrdir.BzrDir.create_standalone_workingtree(directory)
476
def relpath(self, path):
477
"""Return the local path portion from a given path.
479
The path may be absolute or relative. If its a relative path it is
480
interpreted relative to the python current working directory.
482
return osutils.relpath(self.basedir, path)
484
def has_filename(self, filename):
485
return osutils.lexists(self.abspath(filename))
487
def get_file(self, file_id, path=None):
489
path = self.id2path(file_id)
490
return self.get_file_byname(path)
492
def get_file_text(self, file_id):
493
return self.get_file(file_id).read()
495
def get_file_byname(self, filename):
496
path = self.abspath(filename)
497
filters = filters_for_path(path)
498
return filtered_input(file(path, 'rb'), filters)
501
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
502
"""See Tree.annotate_iter
504
This implementation will use the basis tree implementation if possible.
505
Lines not in the basis are attributed to CURRENT_REVISION
507
If there are pending merges, lines added by those merges will be
508
incorrectly attributed to CURRENT_REVISION (but after committing, the
509
attribution will be correct).
511
basis = self.basis_tree()
514
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
515
require_versioned=True).next()
516
changed_content, kind = changes[2], changes[6]
517
if not changed_content:
518
return basis.annotate_iter(file_id)
522
if kind[0] != 'file':
525
old_lines = list(basis.annotate_iter(file_id))
527
for tree in self.branch.repository.revision_trees(
528
self.get_parent_ids()[1:]):
529
if file_id not in tree:
531
old.append(list(tree.annotate_iter(file_id)))
532
return annotate.reannotate(old, self.get_file(file_id).readlines(),
537
def _get_ancestors(self, default_revision):
538
ancestors = set([default_revision])
539
for parent_id in self.get_parent_ids():
540
ancestors.update(self.branch.repository.get_ancestry(
541
parent_id, topo_sorted=False))
544
def get_parent_ids(self):
545
"""See Tree.get_parent_ids.
547
This implementation reads the pending merges list and last_revision
548
value and uses that to decide what the parents list should be.
550
last_rev = _mod_revision.ensure_null(self._last_revision())
551
if _mod_revision.NULL_REVISION == last_rev:
556
merges_file = self._control_files.get('pending-merges')
557
except errors.NoSuchFile:
560
for l in merges_file.readlines():
561
revision_id = l.rstrip('\n')
562
parents.append(revision_id)
566
def get_root_id(self):
567
"""Return the id of this trees root"""
568
return self._inventory.root.file_id
570
def _get_store_filename(self, file_id):
571
## XXX: badly named; this is not in the store at all
572
return self.abspath(self.id2path(file_id))
575
def clone(self, to_bzrdir, revision_id=None):
576
"""Duplicate this working tree into to_bzr, including all state.
578
Specifically modified files are kept as modified, but
579
ignored and unknown files are discarded.
581
If you want to make a new line of development, see bzrdir.sprout()
584
If not None, the cloned tree will have its last revision set to
585
revision, and and difference between the source trees last revision
586
and this one merged in.
588
# assumes the target bzr dir format is compatible.
589
result = self._format.initialize(to_bzrdir)
590
self.copy_content_into(result, revision_id)
594
def copy_content_into(self, tree, revision_id=None):
595
"""Copy the current content and user files of this tree into tree."""
596
tree.set_root_id(self.get_root_id())
597
if revision_id is None:
598
merge.transform_tree(tree, self)
600
# TODO now merge from tree.last_revision to revision (to preserve
601
# user local changes)
602
merge.transform_tree(tree, self)
603
tree.set_parent_ids([revision_id])
605
def id2abspath(self, file_id):
606
return self.abspath(self.id2path(file_id))
608
def has_id(self, file_id):
609
# files that have been deleted are excluded
611
if not inv.has_id(file_id):
613
path = inv.id2path(file_id)
614
return osutils.lexists(self.abspath(path))
616
def has_or_had_id(self, file_id):
617
if file_id == self.inventory.root.file_id:
619
return self.inventory.has_id(file_id)
621
__contains__ = has_id
623
def get_file_size(self, file_id):
624
return os.path.getsize(self.id2abspath(file_id))
627
def get_file_sha1(self, file_id, path=None, stat_value=None):
629
path = self._inventory.id2path(file_id)
630
return self._hashcache.get_sha1(path, stat_value)
632
def get_file_mtime(self, file_id, path=None):
634
path = self.inventory.id2path(file_id)
635
return os.lstat(self.abspath(path)).st_mtime
637
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
638
file_id = self.path2id(path)
639
return self._inventory[file_id].executable
641
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
642
mode = stat_result.st_mode
643
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
645
if not supports_executable():
646
def is_executable(self, file_id, path=None):
647
return self._inventory[file_id].executable
649
_is_executable_from_path_and_stat = \
650
_is_executable_from_path_and_stat_from_basis
652
def is_executable(self, file_id, path=None):
654
path = self.id2path(file_id)
655
mode = os.lstat(self.abspath(path)).st_mode
656
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_stat
661
@needs_tree_write_lock
662
def _add(self, files, ids, kinds):
663
"""See MutableTree._add."""
664
# TODO: Re-adding a file that is removed in the working copy
665
# should probably put it back with the previous ID.
666
# the read and write working inventory should not occur in this
667
# function - they should be part of lock_write and unlock.
669
for f, file_id, kind in zip(files, ids, kinds):
670
assert kind is not None
672
inv.add_path(f, kind=kind)
674
inv.add_path(f, kind=kind, file_id=file_id)
675
self._inventory_is_modified = True
677
@needs_tree_write_lock
678
def _gather_kinds(self, files, kinds):
679
"""See MutableTree._gather_kinds."""
680
for pos, f in enumerate(files):
681
if kinds[pos] is None:
682
fullpath = normpath(self.abspath(f))
684
kinds[pos] = file_kind(fullpath)
686
if e.errno == errno.ENOENT:
687
raise errors.NoSuchFile(fullpath)
690
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
691
"""Add revision_id as a parent.
693
This is equivalent to retrieving the current list of parent ids
694
and setting the list to its value plus revision_id.
696
:param revision_id: The revision id to add to the parent list. It may
697
be a ghost revision as long as its not the first parent to be added,
698
or the allow_leftmost_as_ghost parameter is set True.
699
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
701
parents = self.get_parent_ids() + [revision_id]
702
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
703
or allow_leftmost_as_ghost)
705
@needs_tree_write_lock
706
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
707
"""Add revision_id, tree tuple as a parent.
709
This is equivalent to retrieving the current list of parent trees
710
and setting the list to its value plus parent_tuple. See also
711
add_parent_tree_id - if you only have a parent id available it will be
712
simpler to use that api. If you have the parent already available, using
713
this api is preferred.
715
:param parent_tuple: The (revision id, tree) to add to the parent list.
716
If the revision_id is a ghost, pass None for the tree.
717
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
719
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
720
if len(parent_ids) > 1:
721
# the leftmost may have already been a ghost, preserve that if it
723
allow_leftmost_as_ghost = True
724
self.set_parent_ids(parent_ids,
725
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
727
@needs_tree_write_lock
728
def add_pending_merge(self, *revision_ids):
729
# TODO: Perhaps should check at this point that the
730
# history of the revision is actually present?
731
parents = self.get_parent_ids()
733
for rev_id in revision_ids:
734
if rev_id in parents:
736
parents.append(rev_id)
739
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
741
def path_content_summary(self, path, _lstat=os.lstat,
742
_mapper=osutils.file_kind_from_stat_mode):
743
"""See Tree.path_content_summary."""
744
abspath = self.abspath(path)
746
stat_result = _lstat(abspath)
748
if getattr(e, 'errno', None) == errno.ENOENT:
750
return ('missing', None, None, None)
751
# propagate other errors
753
kind = _mapper(stat_result.st_mode)
755
size = stat_result.st_size
756
# try for a stat cache lookup
757
executable = self._is_executable_from_path_and_stat(path, stat_result)
758
return (kind, size, executable, self._sha_from_stat(
760
elif kind == 'directory':
761
# perhaps it looks like a plain directory, but it's really a
763
if self._directory_is_tree_reference(path):
764
kind = 'tree-reference'
765
return kind, None, None, None
766
elif kind == 'symlink':
767
return ('symlink', None, None, os.readlink(abspath))
769
return (kind, None, None, None)
771
@deprecated_method(zero_eleven)
773
def pending_merges(self):
774
"""Return a list of pending merges.
776
These are revisions that have been merged into the working
777
directory but not yet committed.
779
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
780
instead - which is available on all tree objects.
782
return self.get_parent_ids()[1:]
784
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
785
"""Common ghost checking functionality from set_parent_*.
787
This checks that the left hand-parent exists if there are any
790
if len(revision_ids) > 0:
791
leftmost_id = revision_ids[0]
792
if (not allow_leftmost_as_ghost and not
793
self.branch.repository.has_revision(leftmost_id)):
794
raise errors.GhostRevisionUnusableHere(leftmost_id)
796
def _set_merges_from_parent_ids(self, parent_ids):
797
merges = parent_ids[1:]
798
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
800
@needs_tree_write_lock
801
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
802
"""Set the parent ids to revision_ids.
804
See also set_parent_trees. This api will try to retrieve the tree data
805
for each element of revision_ids from the trees repository. If you have
806
tree data already available, it is more efficient to use
807
set_parent_trees rather than set_parent_ids. set_parent_ids is however
808
an easier API to use.
810
:param revision_ids: The revision_ids to set as the parent ids of this
811
working tree. Any of these may be ghosts.
813
self._check_parents_for_ghosts(revision_ids,
814
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
815
for revision_id in revision_ids:
816
_mod_revision.check_not_reserved_id(revision_id)
818
if len(revision_ids) > 0:
819
self.set_last_revision(revision_ids[0])
821
self.set_last_revision(_mod_revision.NULL_REVISION)
823
self._set_merges_from_parent_ids(revision_ids)
825
@needs_tree_write_lock
826
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
827
"""See MutableTree.set_parent_trees."""
828
parent_ids = [rev for (rev, tree) in parents_list]
829
for revision_id in parent_ids:
830
_mod_revision.check_not_reserved_id(revision_id)
832
self._check_parents_for_ghosts(parent_ids,
833
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
835
if len(parent_ids) == 0:
836
leftmost_parent_id = _mod_revision.NULL_REVISION
837
leftmost_parent_tree = None
839
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
841
if self._change_last_revision(leftmost_parent_id):
842
if leftmost_parent_tree is None:
843
# If we don't have a tree, fall back to reading the
844
# parent tree from the repository.
845
self._cache_basis_inventory(leftmost_parent_id)
847
inv = leftmost_parent_tree.inventory
848
xml = self._create_basis_xml_from_inventory(
849
leftmost_parent_id, inv)
850
self._write_basis_inventory(xml)
851
self._set_merges_from_parent_ids(parent_ids)
853
@needs_tree_write_lock
854
def set_pending_merges(self, rev_list):
855
parents = self.get_parent_ids()
856
leftmost = parents[:1]
857
new_parents = leftmost + rev_list
858
self.set_parent_ids(new_parents)
860
@needs_tree_write_lock
861
def set_merge_modified(self, modified_hashes):
863
for file_id, hash in modified_hashes.iteritems():
864
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
865
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
867
def _sha_from_stat(self, path, stat_result):
868
"""Get a sha digest from the tree's stat cache.
870
The default implementation assumes no stat cache is present.
872
:param path: The path.
873
:param stat_result: The stat result being looked up.
877
def _put_rio(self, filename, stanzas, header):
878
self._must_be_locked()
879
my_file = rio_file(stanzas, header)
880
self._control_files.put(filename, my_file)
882
@needs_write_lock # because merge pulls data into the branch.
883
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
885
"""Merge from a branch into this working tree.
887
:param branch: The branch to merge from.
888
:param to_revision: If non-None, the merge will merge to to_revision,
889
but not beyond it. to_revision does not need to be in the history
890
of the branch when it is supplied. If None, to_revision defaults to
891
branch.last_revision().
893
from bzrlib.merge import Merger, Merge3Merger
894
pb = bzrlib.ui.ui_factory.nested_progress_bar()
896
merger = Merger(self.branch, this_tree=self, pb=pb)
897
merger.pp = ProgressPhase("Merge phase", 5, pb)
898
merger.pp.next_phase()
899
# check that there are no
901
merger.check_basis(check_clean=True, require_commits=False)
902
if to_revision is None:
903
to_revision = _mod_revision.ensure_null(branch.last_revision())
904
merger.other_rev_id = to_revision
905
if _mod_revision.is_null(merger.other_rev_id):
906
raise errors.NoCommits(branch)
907
self.branch.fetch(branch, last_revision=merger.other_rev_id)
908
merger.other_basis = merger.other_rev_id
909
merger.other_tree = self.branch.repository.revision_tree(
911
merger.other_branch = branch
912
merger.pp.next_phase()
913
if from_revision is None:
916
merger.set_base_revision(from_revision, branch)
917
if merger.base_rev_id == merger.other_rev_id:
918
raise errors.PointlessMerge
919
merger.backup_files = False
920
if merge_type is None:
921
merger.merge_type = Merge3Merger
923
merger.merge_type = merge_type
924
merger.set_interesting_files(None)
925
merger.show_base = False
926
merger.reprocess = False
927
conflicts = merger.do_merge()
934
def merge_modified(self):
935
"""Return a dictionary of files modified by a merge.
937
The list is initialized by WorkingTree.set_merge_modified, which is
938
typically called after we make some automatic updates to the tree
941
This returns a map of file_id->sha1, containing only files which are
942
still in the working inventory and have that text hash.
945
hashfile = self._control_files.get('merge-hashes')
946
except errors.NoSuchFile:
950
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
951
raise errors.MergeModifiedFormatError()
952
except StopIteration:
953
raise errors.MergeModifiedFormatError()
954
for s in RioReader(hashfile):
955
# RioReader reads in Unicode, so convert file_ids back to utf8
956
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
957
if file_id not in self.inventory:
959
text_hash = s.get("hash")
960
if text_hash == self.get_file_sha1(file_id):
961
merge_hashes[file_id] = text_hash
965
def mkdir(self, path, file_id=None):
966
"""See MutableTree.mkdir()."""
968
file_id = generate_ids.gen_file_id(os.path.basename(path))
969
os.mkdir(self.abspath(path))
970
self.add(path, file_id, 'directory')
973
def get_symlink_target(self, file_id):
974
return os.readlink(self.id2abspath(file_id))
977
def subsume(self, other_tree):
978
def add_children(inventory, entry):
979
for child_entry in entry.children.values():
980
inventory._byid[child_entry.file_id] = child_entry
981
if child_entry.kind == 'directory':
982
add_children(inventory, child_entry)
983
if other_tree.get_root_id() == self.get_root_id():
984
raise errors.BadSubsumeSource(self, other_tree,
985
'Trees have the same root')
987
other_tree_path = self.relpath(other_tree.basedir)
988
except errors.PathNotChild:
989
raise errors.BadSubsumeSource(self, other_tree,
990
'Tree is not contained by the other')
991
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
992
if new_root_parent is None:
993
raise errors.BadSubsumeSource(self, other_tree,
994
'Parent directory is not versioned.')
995
# We need to ensure that the result of a fetch will have a
996
# versionedfile for the other_tree root, and only fetching into
997
# RepositoryKnit2 guarantees that.
998
if not self.branch.repository.supports_rich_root():
999
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1000
other_tree.lock_tree_write()
1002
new_parents = other_tree.get_parent_ids()
1003
other_root = other_tree.inventory.root
1004
other_root.parent_id = new_root_parent
1005
other_root.name = osutils.basename(other_tree_path)
1006
self.inventory.add(other_root)
1007
add_children(self.inventory, other_root)
1008
self._write_inventory(self.inventory)
1009
# normally we don't want to fetch whole repositories, but i think
1010
# here we really do want to consolidate the whole thing.
1011
for parent_id in other_tree.get_parent_ids():
1012
self.branch.fetch(other_tree.branch, parent_id)
1013
self.add_parent_tree_id(parent_id)
1016
other_tree.bzrdir.retire_bzrdir()
1018
def _setup_directory_is_tree_reference(self):
1019
if self._branch.repository._format.supports_tree_reference:
1020
self._directory_is_tree_reference = \
1021
self._directory_may_be_tree_reference
1023
self._directory_is_tree_reference = \
1024
self._directory_is_never_tree_reference
1026
def _directory_is_never_tree_reference(self, relpath):
1029
def _directory_may_be_tree_reference(self, relpath):
1030
# as a special case, if a directory contains control files then
1031
# it's a tree reference, except that the root of the tree is not
1032
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1033
# TODO: We could ask all the control formats whether they
1034
# recognize this directory, but at the moment there's no cheap api
1035
# to do that. Since we probably can only nest bzr checkouts and
1036
# they always use this name it's ok for now. -- mbp 20060306
1038
# FIXME: There is an unhandled case here of a subdirectory
1039
# containing .bzr but not a branch; that will probably blow up
1040
# when you try to commit it. It might happen if there is a
1041
# checkout in a subdirectory. This can be avoided by not adding
1044
@needs_tree_write_lock
1045
def extract(self, file_id, format=None):
1046
"""Extract a subtree from this tree.
1048
A new branch will be created, relative to the path for this tree.
1052
segments = osutils.splitpath(path)
1053
transport = self.branch.bzrdir.root_transport
1054
for name in segments:
1055
transport = transport.clone(name)
1056
transport.ensure_base()
1059
sub_path = self.id2path(file_id)
1060
branch_transport = mkdirs(sub_path)
1062
format = self.bzrdir.cloning_metadir()
1063
branch_transport.ensure_base()
1064
branch_bzrdir = format.initialize_on_transport(branch_transport)
1066
repo = branch_bzrdir.find_repository()
1067
except errors.NoRepositoryPresent:
1068
repo = branch_bzrdir.create_repository()
1069
if not repo.supports_rich_root():
1070
raise errors.RootNotRich()
1071
new_branch = branch_bzrdir.create_branch()
1072
new_branch.pull(self.branch)
1073
for parent_id in self.get_parent_ids():
1074
new_branch.fetch(self.branch, parent_id)
1075
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1076
if tree_transport.base != branch_transport.base:
1077
tree_bzrdir = format.initialize_on_transport(tree_transport)
1078
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1080
tree_bzrdir = branch_bzrdir
1081
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1082
wt.set_parent_ids(self.get_parent_ids())
1083
my_inv = self.inventory
1084
child_inv = Inventory(root_id=None)
1085
new_root = my_inv[file_id]
1086
my_inv.remove_recursive_id(file_id)
1087
new_root.parent_id = None
1088
child_inv.add(new_root)
1089
self._write_inventory(my_inv)
1090
wt._write_inventory(child_inv)
1093
def _serialize(self, inventory, out_file):
1094
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1097
def _deserialize(selt, in_file):
1098
return xml5.serializer_v5.read_inventory(in_file)
1101
"""Write the in memory inventory to disk."""
1102
# TODO: Maybe this should only write on dirty ?
1103
if self._control_files._lock_mode != 'w':
1104
raise errors.NotWriteLocked(self)
1106
self._serialize(self._inventory, sio)
1108
self._control_files.put('inventory', sio)
1109
self._inventory_is_modified = False
1111
def _kind(self, relpath):
1112
return osutils.file_kind(self.abspath(relpath))
1114
def list_files(self, include_root=False):
1115
"""Recursively list all files as (path, class, kind, id, entry).
1117
Lists, but does not descend into unversioned directories.
1119
This does not include files that have been deleted in this
1122
Skips the control directory.
1124
# list_files is an iterator, so @needs_read_lock doesn't work properly
1125
# with it. So callers should be careful to always read_lock the tree.
1126
if not self.is_locked():
1127
raise errors.ObjectNotLocked(self)
1129
inv = self.inventory
1130
if include_root is True:
1131
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1132
# Convert these into local objects to save lookup times
1133
pathjoin = osutils.pathjoin
1134
file_kind = self._kind
1136
# transport.base ends in a slash, we want the piece
1137
# between the last two slashes
1138
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1140
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1142
# directory file_id, relative path, absolute path, reverse sorted children
1143
children = os.listdir(self.basedir)
1145
# jam 20060527 The kernel sized tree seems equivalent whether we
1146
# use a deque and popleft to keep them sorted, or if we use a plain
1147
# list and just reverse() them.
1148
children = collections.deque(children)
1149
stack = [(inv.root.file_id, u'', self.basedir, children)]
1151
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1154
f = children.popleft()
1155
## TODO: If we find a subdirectory with its own .bzr
1156
## directory, then that is a separate tree and we
1157
## should exclude it.
1159
# the bzrdir for this tree
1160
if transport_base_dir == f:
1163
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1164
# and 'f' doesn't begin with one, we can do a string op, rather
1165
# than the checks of pathjoin(), all relative paths will have an extra slash
1167
fp = from_dir_relpath + '/' + f
1170
fap = from_dir_abspath + '/' + f
1172
f_ie = inv.get_child(from_dir_id, f)
1175
elif self.is_ignored(fp[1:]):
1178
# we may not have found this file, because of a unicode issue
1179
f_norm, can_access = osutils.normalized_filename(f)
1180
if f == f_norm or not can_access:
1181
# No change, so treat this file normally
1184
# this file can be accessed by a normalized path
1185
# check again if it is versioned
1186
# these lines are repeated here for performance
1188
fp = from_dir_relpath + '/' + f
1189
fap = from_dir_abspath + '/' + f
1190
f_ie = inv.get_child(from_dir_id, f)
1193
elif self.is_ignored(fp[1:]):
1200
# make a last minute entry
1202
yield fp[1:], c, fk, f_ie.file_id, f_ie
1205
yield fp[1:], c, fk, None, fk_entries[fk]()
1207
yield fp[1:], c, fk, None, TreeEntry()
1210
if fk != 'directory':
1213
# But do this child first
1214
new_children = os.listdir(fap)
1216
new_children = collections.deque(new_children)
1217
stack.append((f_ie.file_id, fp, fap, new_children))
1218
# Break out of inner loop,
1219
# so that we start outer loop with child
1222
# if we finished all children, pop it off the stack
1225
@needs_tree_write_lock
1226
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1229
to_dir must exist in the inventory.
1231
If to_dir exists and is a directory, the files are moved into
1232
it, keeping their old names.
1234
Note that to_dir is only the last component of the new name;
1235
this doesn't change the directory.
1237
For each entry in from_paths the move mode will be determined
1240
The first mode moves the file in the filesystem and updates the
1241
inventory. The second mode only updates the inventory without
1242
touching the file on the filesystem. This is the new mode introduced
1245
move uses the second mode if 'after == True' and the target is not
1246
versioned but present in the working tree.
1248
move uses the second mode if 'after == False' and the source is
1249
versioned but no longer in the working tree, and the target is not
1250
versioned but present in the working tree.
1252
move uses the first mode if 'after == False' and the source is
1253
versioned and present in the working tree, and the target is not
1254
versioned and not present in the working tree.
1256
Everything else results in an error.
1258
This returns a list of (from_path, to_path) pairs for each
1259
entry that is moved.
1264
# check for deprecated use of signature
1266
to_dir = kwargs.get('to_name', None)
1268
raise TypeError('You must supply a target directory')
1270
symbol_versioning.warn('The parameter to_name was deprecated'
1271
' in version 0.13. Use to_dir instead',
1274
# check destination directory
1275
assert not isinstance(from_paths, basestring)
1276
inv = self.inventory
1277
to_abs = self.abspath(to_dir)
1278
if not isdir(to_abs):
1279
raise errors.BzrMoveFailedError('',to_dir,
1280
errors.NotADirectory(to_abs))
1281
if not self.has_filename(to_dir):
1282
raise errors.BzrMoveFailedError('',to_dir,
1283
errors.NotInWorkingDirectory(to_dir))
1284
to_dir_id = inv.path2id(to_dir)
1285
if to_dir_id is None:
1286
raise errors.BzrMoveFailedError('',to_dir,
1287
errors.NotVersionedError(path=str(to_dir)))
1289
to_dir_ie = inv[to_dir_id]
1290
if to_dir_ie.kind != 'directory':
1291
raise errors.BzrMoveFailedError('',to_dir,
1292
errors.NotADirectory(to_abs))
1294
# create rename entries and tuples
1295
for from_rel in from_paths:
1296
from_tail = splitpath(from_rel)[-1]
1297
from_id = inv.path2id(from_rel)
1299
raise errors.BzrMoveFailedError(from_rel,to_dir,
1300
errors.NotVersionedError(path=str(from_rel)))
1302
from_entry = inv[from_id]
1303
from_parent_id = from_entry.parent_id
1304
to_rel = pathjoin(to_dir, from_tail)
1305
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1307
from_tail=from_tail,
1308
from_parent_id=from_parent_id,
1309
to_rel=to_rel, to_tail=from_tail,
1310
to_parent_id=to_dir_id)
1311
rename_entries.append(rename_entry)
1312
rename_tuples.append((from_rel, to_rel))
1314
# determine which move mode to use. checks also for movability
1315
rename_entries = self._determine_mv_mode(rename_entries, after)
1317
original_modified = self._inventory_is_modified
1320
self._inventory_is_modified = True
1321
self._move(rename_entries)
1323
# restore the inventory on error
1324
self._inventory_is_modified = original_modified
1326
self._write_inventory(inv)
1327
return rename_tuples
1329
def _determine_mv_mode(self, rename_entries, after=False):
1330
"""Determines for each from-to pair if both inventory and working tree
1331
or only the inventory has to be changed.
1333
Also does basic plausability tests.
1335
inv = self.inventory
1337
for rename_entry in rename_entries:
1338
# store to local variables for easier reference
1339
from_rel = rename_entry.from_rel
1340
from_id = rename_entry.from_id
1341
to_rel = rename_entry.to_rel
1342
to_id = inv.path2id(to_rel)
1343
only_change_inv = False
1345
# check the inventory for source and destination
1347
raise errors.BzrMoveFailedError(from_rel,to_rel,
1348
errors.NotVersionedError(path=str(from_rel)))
1349
if to_id is not None:
1350
raise errors.BzrMoveFailedError(from_rel,to_rel,
1351
errors.AlreadyVersionedError(path=str(to_rel)))
1353
# try to determine the mode for rename (only change inv or change
1354
# inv and file system)
1356
if not self.has_filename(to_rel):
1357
raise errors.BzrMoveFailedError(from_id,to_rel,
1358
errors.NoSuchFile(path=str(to_rel),
1359
extra="New file has not been created yet"))
1360
only_change_inv = True
1361
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1362
only_change_inv = True
1363
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1364
only_change_inv = False
1365
elif (sys.platform == 'win32'
1366
and from_rel.lower() == to_rel.lower()
1367
and self.has_filename(from_rel)):
1368
only_change_inv = False
1370
# something is wrong, so lets determine what exactly
1371
if not self.has_filename(from_rel) and \
1372
not self.has_filename(to_rel):
1373
raise errors.BzrRenameFailedError(from_rel,to_rel,
1374
errors.PathsDoNotExist(paths=(str(from_rel),
1377
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1378
rename_entry.only_change_inv = only_change_inv
1379
return rename_entries
1381
def _move(self, rename_entries):
1382
"""Moves a list of files.
1384
Depending on the value of the flag 'only_change_inv', the
1385
file will be moved on the file system or not.
1387
inv = self.inventory
1390
for entry in rename_entries:
1392
self._move_entry(entry)
1394
self._rollback_move(moved)
1398
def _rollback_move(self, moved):
1399
"""Try to rollback a previous move in case of an filesystem error."""
1400
inv = self.inventory
1403
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1404
entry.to_tail, entry.to_parent_id, entry.from_rel,
1405
entry.from_tail, entry.from_parent_id,
1406
entry.only_change_inv))
1407
except errors.BzrMoveFailedError, e:
1408
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1409
" The working tree is in an inconsistent state."
1410
" Please consider doing a 'bzr revert'."
1411
" Error message is: %s" % e)
1413
def _move_entry(self, entry):
1414
inv = self.inventory
1415
from_rel_abs = self.abspath(entry.from_rel)
1416
to_rel_abs = self.abspath(entry.to_rel)
1417
if from_rel_abs == to_rel_abs:
1418
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1419
"Source and target are identical.")
1421
if not entry.only_change_inv:
1423
osutils.rename(from_rel_abs, to_rel_abs)
1425
raise errors.BzrMoveFailedError(entry.from_rel,
1427
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1429
@needs_tree_write_lock
1430
def rename_one(self, from_rel, to_rel, after=False):
1433
This can change the directory or the filename or both.
1435
rename_one has several 'modes' to work. First, it can rename a physical
1436
file and change the file_id. That is the normal mode. Second, it can
1437
only change the file_id without touching any physical file. This is
1438
the new mode introduced in version 0.15.
1440
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1441
versioned but present in the working tree.
1443
rename_one uses the second mode if 'after == False' and 'from_rel' is
1444
versioned but no longer in the working tree, and 'to_rel' is not
1445
versioned but present in the working tree.
1447
rename_one uses the first mode if 'after == False' and 'from_rel' is
1448
versioned and present in the working tree, and 'to_rel' is not
1449
versioned and not present in the working tree.
1451
Everything else results in an error.
1453
inv = self.inventory
1456
# create rename entries and tuples
1457
from_tail = splitpath(from_rel)[-1]
1458
from_id = inv.path2id(from_rel)
1460
raise errors.BzrRenameFailedError(from_rel,to_rel,
1461
errors.NotVersionedError(path=str(from_rel)))
1462
from_entry = inv[from_id]
1463
from_parent_id = from_entry.parent_id
1464
to_dir, to_tail = os.path.split(to_rel)
1465
to_dir_id = inv.path2id(to_dir)
1466
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1468
from_tail=from_tail,
1469
from_parent_id=from_parent_id,
1470
to_rel=to_rel, to_tail=to_tail,
1471
to_parent_id=to_dir_id)
1472
rename_entries.append(rename_entry)
1474
# determine which move mode to use. checks also for movability
1475
rename_entries = self._determine_mv_mode(rename_entries, after)
1477
# check if the target changed directory and if the target directory is
1479
if to_dir_id is None:
1480
raise errors.BzrMoveFailedError(from_rel,to_rel,
1481
errors.NotVersionedError(path=str(to_dir)))
1483
# all checks done. now we can continue with our actual work
1484
mutter('rename_one:\n'
1489
' to_dir_id {%s}\n',
1490
from_id, from_rel, to_rel, to_dir, to_dir_id)
1492
self._move(rename_entries)
1493
self._write_inventory(inv)
1495
class _RenameEntry(object):
1496
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1497
to_rel, to_tail, to_parent_id, only_change_inv=False):
1498
self.from_rel = from_rel
1499
self.from_id = from_id
1500
self.from_tail = from_tail
1501
self.from_parent_id = from_parent_id
1502
self.to_rel = to_rel
1503
self.to_tail = to_tail
1504
self.to_parent_id = to_parent_id
1505
self.only_change_inv = only_change_inv
1509
"""Return all unknown files.
1511
These are files in the working directory that are not versioned or
1512
control files or ignored.
1514
# force the extras method to be fully executed before returning, to
1515
# prevent race conditions with the lock
1517
[subp for subp in self.extras() if not self.is_ignored(subp)])
1519
@needs_tree_write_lock
1520
def unversion(self, file_ids):
1521
"""Remove the file ids in file_ids from the current versioned set.
1523
When a file_id is unversioned, all of its children are automatically
1526
:param file_ids: The file ids to stop versioning.
1527
:raises: NoSuchId if any fileid is not currently versioned.
1529
for file_id in file_ids:
1530
if self._inventory.has_id(file_id):
1531
self._inventory.remove_recursive_id(file_id)
1533
raise errors.NoSuchId(self, file_id)
1535
# in the future this should just set a dirty bit to wait for the
1536
# final unlock. However, until all methods of workingtree start
1537
# with the current in -memory inventory rather than triggering
1538
# a read, it is more complex - we need to teach read_inventory
1539
# to know when to read, and when to not read first... and possibly
1540
# to save first when the in memory one may be corrupted.
1541
# so for now, we just only write it if it is indeed dirty.
1543
self._write_inventory(self._inventory)
1545
@deprecated_method(zero_eight)
1546
def iter_conflicts(self):
1547
"""List all files in the tree that have text or content conflicts.
1548
DEPRECATED. Use conflicts instead."""
1549
return self._iter_conflicts()
1551
def _iter_conflicts(self):
1553
for info in self.list_files():
1555
stem = get_conflicted_stem(path)
1558
if stem not in conflicted:
1559
conflicted.add(stem)
1563
def pull(self, source, overwrite=False, stop_revision=None,
1564
change_reporter=None, possible_transports=None):
1565
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1568
pp = ProgressPhase("Pull phase", 2, top_pb)
1570
old_revision_info = self.branch.last_revision_info()
1571
basis_tree = self.basis_tree()
1572
count = self.branch.pull(source, overwrite, stop_revision,
1573
possible_transports=possible_transports)
1574
new_revision_info = self.branch.last_revision_info()
1575
if new_revision_info != old_revision_info:
1577
repository = self.branch.repository
1578
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1579
basis_tree.lock_read()
1581
new_basis_tree = self.branch.basis_tree()
1588
change_reporter=change_reporter)
1589
if (basis_tree.inventory.root is None and
1590
new_basis_tree.inventory.root is not None):
1591
self.set_root_id(new_basis_tree.get_root_id())
1595
# TODO - dedup parents list with things merged by pull ?
1596
# reuse the revisiontree we merged against to set the new
1598
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1599
# we have to pull the merge trees out again, because
1600
# merge_inner has set the ids. - this corner is not yet
1601
# layered well enough to prevent double handling.
1602
# XXX TODO: Fix the double handling: telling the tree about
1603
# the already known parent data is wasteful.
1604
merges = self.get_parent_ids()[1:]
1605
parent_trees.extend([
1606
(parent, repository.revision_tree(parent)) for
1608
self.set_parent_trees(parent_trees)
1615
def put_file_bytes_non_atomic(self, file_id, bytes):
1616
"""See MutableTree.put_file_bytes_non_atomic."""
1617
stream = file(self.id2abspath(file_id), 'wb')
1622
# TODO: update the hashcache here ?
1625
"""Yield all unversioned files in this WorkingTree.
1627
If there are any unversioned directories then only the directory is
1628
returned, not all its children. But if there are unversioned files
1629
under a versioned subdirectory, they are returned.
1631
Currently returned depth-first, sorted by name within directories.
1632
This is the same order used by 'osutils.walkdirs'.
1634
## TODO: Work from given directory downwards
1635
for path, dir_entry in self.inventory.directories():
1636
# mutter("search for unknowns in %r", path)
1637
dirabs = self.abspath(path)
1638
if not isdir(dirabs):
1639
# e.g. directory deleted
1643
for subf in os.listdir(dirabs):
1646
if subf not in dir_entry.children:
1647
subf_norm, can_access = osutils.normalized_filename(subf)
1648
if subf_norm != subf and can_access:
1649
if subf_norm not in dir_entry.children:
1650
fl.append(subf_norm)
1656
subp = pathjoin(path, subf)
1659
def ignored_files(self):
1660
"""Yield list of PATH, IGNORE_PATTERN"""
1661
for subp in self.extras():
1662
pat = self.is_ignored(subp)
1666
def get_ignore_list(self):
1667
"""Return list of ignore patterns.
1669
Cached in the Tree object after the first call.
1671
ignoreset = getattr(self, '_ignoreset', None)
1672
if ignoreset is not None:
1675
ignore_globs = set()
1676
ignore_globs.update(ignores.get_runtime_ignores())
1677
ignore_globs.update(ignores.get_user_ignores())
1678
if self.has_filename(bzrlib.IGNORE_FILENAME):
1679
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1681
ignore_globs.update(ignores.parse_ignore_file(f))
1684
self._ignoreset = ignore_globs
1687
def _flush_ignore_list_cache(self):
1688
"""Resets the cached ignore list to force a cache rebuild."""
1689
self._ignoreset = None
1690
self._ignoreglobster = None
1692
def is_ignored(self, filename):
1693
r"""Check whether the filename matches an ignore pattern.
1695
Patterns containing '/' or '\' need to match the whole path;
1696
others match against only the last component.
1698
If the file is ignored, returns the pattern which caused it to
1699
be ignored, otherwise None. So this can simply be used as a
1700
boolean if desired."""
1701
if getattr(self, '_ignoreglobster', None) is None:
1702
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1703
return self._ignoreglobster.match(filename)
1705
def kind(self, file_id):
1706
return file_kind(self.id2abspath(file_id))
1708
def stored_kind(self, file_id):
1709
"""See Tree.stored_kind"""
1710
return self.inventory[file_id].kind
1712
def _comparison_data(self, entry, path):
1713
abspath = self.abspath(path)
1715
stat_value = os.lstat(abspath)
1717
if getattr(e, 'errno', None) == errno.ENOENT:
1724
mode = stat_value.st_mode
1725
kind = osutils.file_kind_from_stat_mode(mode)
1726
if not supports_executable():
1727
executable = entry is not None and entry.executable
1729
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1730
return kind, executable, stat_value
1732
def _file_size(self, entry, stat_value):
1733
return stat_value.st_size
1735
def last_revision(self):
1736
"""Return the last revision of the branch for this tree.
1738
This format tree does not support a separate marker for last-revision
1739
compared to the branch.
1741
See MutableTree.last_revision
1743
return self._last_revision()
1746
def _last_revision(self):
1747
"""helper for get_parent_ids."""
1748
return _mod_revision.ensure_null(self.branch.last_revision())
1750
def is_locked(self):
1751
return self._control_files.is_locked()
1753
def _must_be_locked(self):
1754
if not self.is_locked():
1755
raise errors.ObjectNotLocked(self)
1757
def lock_read(self):
1758
"""See Branch.lock_read, and WorkingTree.unlock."""
1759
if not self.is_locked():
1761
self.branch.lock_read()
1763
return self._control_files.lock_read()
1765
self.branch.unlock()
1768
def lock_tree_write(self):
1769
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1770
if not self.is_locked():
1772
self.branch.lock_read()
1774
return self._control_files.lock_write()
1776
self.branch.unlock()
1779
def lock_write(self):
1780
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1781
if not self.is_locked():
1783
self.branch.lock_write()
1785
return self._control_files.lock_write()
1787
self.branch.unlock()
1790
def get_physical_lock_status(self):
1791
return self._control_files.get_physical_lock_status()
1793
def _basis_inventory_name(self):
1794
return 'basis-inventory-cache'
1796
def _reset_data(self):
1797
"""Reset transient data that cannot be revalidated."""
1798
self._inventory_is_modified = False
1799
result = self._deserialize(self._control_files.get('inventory'))
1800
self._set_inventory(result, dirty=False)
1802
@needs_tree_write_lock
1803
def set_last_revision(self, new_revision):
1804
"""Change the last revision in the working tree."""
1805
if self._change_last_revision(new_revision):
1806
self._cache_basis_inventory(new_revision)
1808
def _change_last_revision(self, new_revision):
1809
"""Template method part of set_last_revision to perform the change.
1811
This is used to allow WorkingTree3 instances to not affect branch
1812
when their last revision is set.
1814
if _mod_revision.is_null(new_revision):
1815
self.branch.set_revision_history([])
1818
self.branch.generate_revision_history(new_revision)
1819
except errors.NoSuchRevision:
1820
# not present in the repo - dont try to set it deeper than the tip
1821
self.branch.set_revision_history([new_revision])
1824
def _write_basis_inventory(self, xml):
1825
"""Write the basis inventory XML to the basis-inventory file"""
1826
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1827
path = self._basis_inventory_name()
1829
self._control_files.put(path, sio)
1831
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1832
"""Create the text that will be saved in basis-inventory"""
1833
inventory.revision_id = revision_id
1834
return xml7.serializer_v7.write_inventory_to_string(inventory)
1836
def _cache_basis_inventory(self, new_revision):
1837
"""Cache new_revision as the basis inventory."""
1838
# TODO: this should allow the ready-to-use inventory to be passed in,
1839
# as commit already has that ready-to-use [while the format is the
1842
# this double handles the inventory - unpack and repack -
1843
# but is easier to understand. We can/should put a conditional
1844
# in here based on whether the inventory is in the latest format
1845
# - perhaps we should repack all inventories on a repository
1847
# the fast path is to copy the raw xml from the repository. If the
1848
# xml contains 'revision_id="', then we assume the right
1849
# revision_id is set. We must check for this full string, because a
1850
# root node id can legitimately look like 'revision_id' but cannot
1852
xml = self.branch.repository.get_inventory_xml(new_revision)
1853
firstline = xml.split('\n', 1)[0]
1854
if (not 'revision_id="' in firstline or
1855
'format="7"' not in firstline):
1856
inv = self.branch.repository.deserialise_inventory(
1858
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1859
self._write_basis_inventory(xml)
1860
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1863
def read_basis_inventory(self):
1864
"""Read the cached basis inventory."""
1865
path = self._basis_inventory_name()
1866
return self._control_files.get(path).read()
1869
def read_working_inventory(self):
1870
"""Read the working inventory.
1872
:raises errors.InventoryModified: read_working_inventory will fail
1873
when the current in memory inventory has been modified.
1875
# conceptually this should be an implementation detail of the tree.
1876
# XXX: Deprecate this.
1877
# ElementTree does its own conversion from UTF-8, so open in
1879
if self._inventory_is_modified:
1880
raise errors.InventoryModified(self)
1881
result = self._deserialize(self._control_files.get('inventory'))
1882
self._set_inventory(result, dirty=False)
1885
@needs_tree_write_lock
1886
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1888
"""Remove nominated files from the working inventory.
1890
:files: File paths relative to the basedir.
1891
:keep_files: If true, the files will also be kept.
1892
:force: Delete files and directories, even if they are changed and
1893
even if the directories are not empty.
1895
if isinstance(files, basestring):
1901
unknown_nested_files=set()
1903
def recurse_directory_to_add_files(directory):
1904
# Recurse directory and add all files
1905
# so we can check if they have changed.
1906
for parent_info, file_infos in\
1907
osutils.walkdirs(self.abspath(directory),
1909
for relpath, basename, kind, lstat, abspath in file_infos:
1910
# Is it versioned or ignored?
1911
if self.path2id(relpath) or self.is_ignored(relpath):
1912
# Add nested content for deletion.
1913
new_files.add(relpath)
1915
# Files which are not versioned and not ignored
1916
# should be treated as unknown.
1917
unknown_nested_files.add((relpath, None, kind))
1919
for filename in files:
1920
# Get file name into canonical form.
1921
abspath = self.abspath(filename)
1922
filename = self.relpath(abspath)
1923
if len(filename) > 0:
1924
new_files.add(filename)
1925
if osutils.isdir(abspath):
1926
recurse_directory_to_add_files(filename)
1928
files = list(new_files)
1931
return # nothing to do
1933
# Sort needed to first handle directory content before the directory
1934
files.sort(reverse=True)
1936
# Bail out if we are going to delete files we shouldn't
1937
if not keep_files and not force:
1938
has_changed_files = len(unknown_nested_files) > 0
1939
if not has_changed_files:
1940
for (file_id, path, content_change, versioned, parent_id, name,
1941
kind, executable) in self.iter_changes(self.basis_tree(),
1942
include_unchanged=True, require_versioned=False,
1943
want_unversioned=True, specific_files=files):
1944
if versioned == (False, False):
1945
# The record is unknown ...
1946
if not self.is_ignored(path[1]):
1947
# ... but not ignored
1948
has_changed_files = True
1950
elif content_change and (kind[1] != None):
1951
# Versioned and changed, but not deleted
1952
has_changed_files = True
1955
if has_changed_files:
1956
# Make delta show ALL applicable changes in error message.
1957
tree_delta = self.changes_from(self.basis_tree(),
1958
require_versioned=False, want_unversioned=True,
1959
specific_files=files)
1960
for unknown_file in unknown_nested_files:
1961
if unknown_file not in tree_delta.unversioned:
1962
tree_delta.unversioned.extend((unknown_file,))
1963
raise errors.BzrRemoveChangedFilesError(tree_delta)
1965
# Build inv_delta and delete files where applicaple,
1966
# do this before any modifications to inventory.
1968
fid = self.path2id(f)
1971
message = "%s is not versioned." % (f,)
1974
# having removed it, it must be either ignored or unknown
1975
if self.is_ignored(f):
1979
textui.show_status(new_status, self.kind(fid), f,
1982
inv_delta.append((f, None, fid, None))
1983
message = "removed %s" % (f,)
1986
abs_path = self.abspath(f)
1987
if osutils.lexists(abs_path):
1988
if (osutils.isdir(abs_path) and
1989
len(os.listdir(abs_path)) > 0):
1991
osutils.rmtree(abs_path)
1993
message = "%s is not an empty directory "\
1994
"and won't be deleted." % (f,)
1996
osutils.delete_any(abs_path)
1997
message = "deleted %s" % (f,)
1998
elif message is not None:
1999
# Only care if we haven't done anything yet.
2000
message = "%s does not exist." % (f,)
2002
# Print only one message (if any) per file.
2003
if message is not None:
2005
self.apply_inventory_delta(inv_delta)
2007
@needs_tree_write_lock
2008
def revert(self, filenames=None, old_tree=None, backups=True,
2009
pb=DummyProgress(), report_changes=False):
2010
from bzrlib.conflicts import resolve
2013
symbol_versioning.warn('Using [] to revert all files is deprecated'
2014
' as of bzr 0.91. Please use None (the default) instead.',
2015
DeprecationWarning, stacklevel=2)
2016
if old_tree is None:
2017
basis_tree = self.basis_tree()
2018
basis_tree.lock_read()
2019
old_tree = basis_tree
2023
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2025
if filenames is None and len(self.get_parent_ids()) > 1:
2027
last_revision = self.last_revision()
2028
if last_revision != NULL_REVISION:
2029
if basis_tree is None:
2030
basis_tree = self.basis_tree()
2031
basis_tree.lock_read()
2032
parent_trees.append((last_revision, basis_tree))
2033
self.set_parent_trees(parent_trees)
2036
resolve(self, filenames, ignore_misses=True, recursive=True)
2038
if basis_tree is not None:
2042
def revision_tree(self, revision_id):
2043
"""See Tree.revision_tree.
2045
WorkingTree can supply revision_trees for the basis revision only
2046
because there is only one cached inventory in the bzr directory.
2048
if revision_id == self.last_revision():
2050
xml = self.read_basis_inventory()
2051
except errors.NoSuchFile:
2055
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2056
# dont use the repository revision_tree api because we want
2057
# to supply the inventory.
2058
if inv.revision_id == revision_id:
2059
return revisiontree.RevisionTree(self.branch.repository,
2061
except errors.BadInventoryFormat:
2063
# raise if there was no inventory, or if we read the wrong inventory.
2064
raise errors.NoSuchRevisionInTree(self, revision_id)
2066
# XXX: This method should be deprecated in favour of taking in a proper
2067
# new Inventory object.
2068
@needs_tree_write_lock
2069
def set_inventory(self, new_inventory_list):
2070
from bzrlib.inventory import (Inventory,
2075
inv = Inventory(self.get_root_id())
2076
for path, file_id, parent, kind in new_inventory_list:
2077
name = os.path.basename(path)
2080
# fixme, there should be a factory function inv,add_??
2081
if kind == 'directory':
2082
inv.add(InventoryDirectory(file_id, name, parent))
2083
elif kind == 'file':
2084
inv.add(InventoryFile(file_id, name, parent))
2085
elif kind == 'symlink':
2086
inv.add(InventoryLink(file_id, name, parent))
2088
raise errors.BzrError("unknown kind %r" % kind)
2089
self._write_inventory(inv)
2091
@needs_tree_write_lock
2092
def set_root_id(self, file_id):
2093
"""Set the root id for this tree."""
2096
symbol_versioning.warn(symbol_versioning.zero_twelve
2097
% 'WorkingTree.set_root_id with fileid=None',
2102
file_id = osutils.safe_file_id(file_id)
2103
self._set_root_id(file_id)
2105
def _set_root_id(self, file_id):
2106
"""Set the root id for this tree, in a format specific manner.
2108
:param file_id: The file id to assign to the root. It must not be
2109
present in the current inventory or an error will occur. It must
2110
not be None, but rather a valid file id.
2112
inv = self._inventory
2113
orig_root_id = inv.root.file_id
2114
# TODO: it might be nice to exit early if there was nothing
2115
# to do, saving us from trigger a sync on unlock.
2116
self._inventory_is_modified = True
2117
# we preserve the root inventory entry object, but
2118
# unlinkit from the byid index
2119
del inv._byid[inv.root.file_id]
2120
inv.root.file_id = file_id
2121
# and link it into the index with the new changed id.
2122
inv._byid[inv.root.file_id] = inv.root
2123
# and finally update all children to reference the new id.
2124
# XXX: this should be safe to just look at the root.children
2125
# list, not the WHOLE INVENTORY.
2128
if entry.parent_id == orig_root_id:
2129
entry.parent_id = inv.root.file_id
2132
"""See Branch.unlock.
2134
WorkingTree locking just uses the Branch locking facilities.
2135
This is current because all working trees have an embedded branch
2136
within them. IF in the future, we were to make branch data shareable
2137
between multiple working trees, i.e. via shared storage, then we
2138
would probably want to lock both the local tree, and the branch.
2140
raise NotImplementedError(self.unlock)
2142
def update(self, change_reporter=None, possible_transports=None):
2143
"""Update a working tree along its branch.
2145
This will update the branch if its bound too, which means we have
2146
multiple trees involved:
2148
- The new basis tree of the master.
2149
- The old basis tree of the branch.
2150
- The old basis tree of the working tree.
2151
- The current working tree state.
2153
Pathologically, all three may be different, and non-ancestors of each
2154
other. Conceptually we want to:
2156
- Preserve the wt.basis->wt.state changes
2157
- Transform the wt.basis to the new master basis.
2158
- Apply a merge of the old branch basis to get any 'local' changes from
2160
- Restore the wt.basis->wt.state changes.
2162
There isn't a single operation at the moment to do that, so we:
2163
- Merge current state -> basis tree of the master w.r.t. the old tree
2165
- Do a 'normal' merge of the old branch basis if it is relevant.
2167
if self.branch.get_bound_location() is not None:
2169
update_branch = True
2171
self.lock_tree_write()
2172
update_branch = False
2175
old_tip = self.branch.update(possible_transports)
2178
return self._update_tree(old_tip, change_reporter)
2182
@needs_tree_write_lock
2183
def _update_tree(self, old_tip=None, change_reporter=None):
2184
"""Update a tree to the master branch.
2186
:param old_tip: if supplied, the previous tip revision the branch,
2187
before it was changed to the master branch's tip.
2189
# here if old_tip is not None, it is the old tip of the branch before
2190
# it was updated from the master branch. This should become a pending
2191
# merge in the working tree to preserve the user existing work. we
2192
# cant set that until we update the working trees last revision to be
2193
# one from the new branch, because it will just get absorbed by the
2194
# parent de-duplication logic.
2196
# We MUST save it even if an error occurs, because otherwise the users
2197
# local work is unreferenced and will appear to have been lost.
2201
last_rev = self.get_parent_ids()[0]
2203
last_rev = _mod_revision.NULL_REVISION
2204
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2205
# merge tree state up to new branch tip.
2206
basis = self.basis_tree()
2209
to_tree = self.branch.basis_tree()
2210
if basis.inventory.root is None:
2211
self.set_root_id(to_tree.get_root_id())
2213
result += merge.merge_inner(
2218
change_reporter=change_reporter)
2221
# TODO - dedup parents list with things merged by pull ?
2222
# reuse the tree we've updated to to set the basis:
2223
parent_trees = [(self.branch.last_revision(), to_tree)]
2224
merges = self.get_parent_ids()[1:]
2225
# Ideally we ask the tree for the trees here, that way the working
2226
# tree can decide whether to give us teh entire tree or give us a
2227
# lazy initialised tree. dirstate for instance will have the trees
2228
# in ram already, whereas a last-revision + basis-inventory tree
2229
# will not, but also does not need them when setting parents.
2230
for parent in merges:
2231
parent_trees.append(
2232
(parent, self.branch.repository.revision_tree(parent)))
2233
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2234
parent_trees.append(
2235
(old_tip, self.branch.repository.revision_tree(old_tip)))
2236
self.set_parent_trees(parent_trees)
2237
last_rev = parent_trees[0][0]
2239
# the working tree had the same last-revision as the master
2240
# branch did. We may still have pivot local work from the local
2241
# branch into old_tip:
2242
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2243
self.add_parent_tree_id(old_tip)
2244
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2245
and old_tip != last_rev):
2246
# our last revision was not the prior branch last revision
2247
# and we have converted that last revision to a pending merge.
2248
# base is somewhere between the branch tip now
2249
# and the now pending merge
2251
# Since we just modified the working tree and inventory, flush out
2252
# the current state, before we modify it again.
2253
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2254
# requires it only because TreeTransform directly munges the
2255
# inventory and calls tree._write_inventory(). Ultimately we
2256
# should be able to remove this extra flush.
2258
graph = self.branch.repository.get_graph()
2259
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2261
base_tree = self.branch.repository.revision_tree(base_rev_id)
2262
other_tree = self.branch.repository.revision_tree(old_tip)
2263
result += merge.merge_inner(
2268
change_reporter=change_reporter)
2271
def _write_hashcache_if_dirty(self):
2272
"""Write out the hashcache if it is dirty."""
2273
if self._hashcache.needs_write:
2275
self._hashcache.write()
2277
if e.errno not in (errno.EPERM, errno.EACCES):
2279
# TODO: jam 20061219 Should this be a warning? A single line
2280
# warning might be sufficient to let the user know what
2282
mutter('Could not write hashcache for %s\nError: %s',
2283
self._hashcache.cache_file_name(), e)
2285
@needs_tree_write_lock
2286
def _write_inventory(self, inv):
2287
"""Write inventory as the current inventory."""
2288
self._set_inventory(inv, dirty=True)
2291
def set_conflicts(self, arg):
2292
raise errors.UnsupportedOperation(self.set_conflicts, self)
2294
def add_conflicts(self, arg):
2295
raise errors.UnsupportedOperation(self.add_conflicts, self)
2298
def conflicts(self):
2299
conflicts = _mod_conflicts.ConflictList()
2300
for conflicted in self._iter_conflicts():
2303
if file_kind(self.abspath(conflicted)) != "file":
2305
except errors.NoSuchFile:
2308
for suffix in ('.THIS', '.OTHER'):
2310
kind = file_kind(self.abspath(conflicted+suffix))
2313
except errors.NoSuchFile:
2317
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2318
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2320
file_id=self.path2id(conflicted)))
2323
def walkdirs(self, prefix=""):
2324
"""Walk the directories of this tree.
2326
returns a generator which yields items in the form:
2327
((curren_directory_path, fileid),
2328
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2331
This API returns a generator, which is only valid during the current
2332
tree transaction - within a single lock_read or lock_write duration.
2334
If the tree is not locked, it may cause an error to be raised,
2335
depending on the tree implementation.
2337
disk_top = self.abspath(prefix)
2338
if disk_top.endswith('/'):
2339
disk_top = disk_top[:-1]
2340
top_strip_len = len(disk_top) + 1
2341
inventory_iterator = self._walkdirs(prefix)
2342
disk_iterator = osutils.walkdirs(disk_top, prefix)
2344
current_disk = disk_iterator.next()
2345
disk_finished = False
2347
if not (e.errno == errno.ENOENT or
2348
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2351
disk_finished = True
2353
current_inv = inventory_iterator.next()
2354
inv_finished = False
2355
except StopIteration:
2358
while not inv_finished or not disk_finished:
2360
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2361
cur_disk_dir_content) = current_disk
2363
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2364
cur_disk_dir_content) = ((None, None), None)
2365
if not disk_finished:
2366
# strip out .bzr dirs
2367
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2368
len(cur_disk_dir_content) > 0):
2369
# osutils.walkdirs can be made nicer -
2370
# yield the path-from-prefix rather than the pathjoined
2372
bzrdir_loc = bisect_left(cur_disk_dir_content,
2374
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2375
# we dont yield the contents of, or, .bzr itself.
2376
del cur_disk_dir_content[bzrdir_loc]
2378
# everything is unknown
2381
# everything is missing
2384
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2386
# disk is before inventory - unknown
2387
dirblock = [(relpath, basename, kind, stat, None, None) for
2388
relpath, basename, kind, stat, top_path in
2389
cur_disk_dir_content]
2390
yield (cur_disk_dir_relpath, None), dirblock
2392
current_disk = disk_iterator.next()
2393
except StopIteration:
2394
disk_finished = True
2396
# inventory is before disk - missing.
2397
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2398
for relpath, basename, dkind, stat, fileid, kind in
2400
yield (current_inv[0][0], current_inv[0][1]), dirblock
2402
current_inv = inventory_iterator.next()
2403
except StopIteration:
2406
# versioned present directory
2407
# merge the inventory and disk data together
2409
for relpath, subiterator in itertools.groupby(sorted(
2410
current_inv[1] + cur_disk_dir_content,
2411
key=operator.itemgetter(0)), operator.itemgetter(1)):
2412
path_elements = list(subiterator)
2413
if len(path_elements) == 2:
2414
inv_row, disk_row = path_elements
2415
# versioned, present file
2416
dirblock.append((inv_row[0],
2417
inv_row[1], disk_row[2],
2418
disk_row[3], inv_row[4],
2420
elif len(path_elements[0]) == 5:
2422
dirblock.append((path_elements[0][0],
2423
path_elements[0][1], path_elements[0][2],
2424
path_elements[0][3], None, None))
2425
elif len(path_elements[0]) == 6:
2426
# versioned, absent file.
2427
dirblock.append((path_elements[0][0],
2428
path_elements[0][1], 'unknown', None,
2429
path_elements[0][4], path_elements[0][5]))
2431
raise NotImplementedError('unreachable code')
2432
yield current_inv[0], dirblock
2434
current_inv = inventory_iterator.next()
2435
except StopIteration:
2438
current_disk = disk_iterator.next()
2439
except StopIteration:
2440
disk_finished = True
2442
def _walkdirs(self, prefix=""):
2443
"""Walk the directories of this tree.
2445
:prefix: is used as the directrory to start with.
2446
returns a generator which yields items in the form:
2447
((curren_directory_path, fileid),
2448
[(file1_path, file1_name, file1_kind, None, file1_id,
2451
_directory = 'directory'
2452
# get the root in the inventory
2453
inv = self.inventory
2454
top_id = inv.path2id(prefix)
2458
pending = [(prefix, '', _directory, None, top_id, None)]
2461
currentdir = pending.pop()
2462
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2463
top_id = currentdir[4]
2465
relroot = currentdir[0] + '/'
2468
# FIXME: stash the node in pending
2470
for name, child in entry.sorted_children():
2471
dirblock.append((relroot + name, name, child.kind, None,
2472
child.file_id, child.kind
2474
yield (currentdir[0], entry.file_id), dirblock
2475
# push the user specified dirs from dirblock
2476
for dir in reversed(dirblock):
2477
if dir[2] == _directory:
2480
@needs_tree_write_lock
2481
def auto_resolve(self):
2482
"""Automatically resolve text conflicts according to contents.
2484
Only text conflicts are auto_resolvable. Files with no conflict markers
2485
are considered 'resolved', because bzr always puts conflict markers
2486
into files that have text conflicts. The corresponding .THIS .BASE and
2487
.OTHER files are deleted, as per 'resolve'.
2488
:return: a tuple of ConflictLists: (un_resolved, resolved).
2490
un_resolved = _mod_conflicts.ConflictList()
2491
resolved = _mod_conflicts.ConflictList()
2492
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2493
for conflict in self.conflicts():
2494
if (conflict.typestring != 'text conflict' or
2495
self.kind(conflict.file_id) != 'file'):
2496
un_resolved.append(conflict)
2498
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2500
for line in my_file:
2501
if conflict_re.search(line):
2502
un_resolved.append(conflict)
2505
resolved.append(conflict)
2508
resolved.remove_files(self)
2509
self.set_conflicts(un_resolved)
2510
return un_resolved, resolved
2512
def _validate(self):
2513
"""Validate internal structures.
2515
This is meant mostly for the test suite. To give it a chance to detect
2516
corruption after actions have occurred. The default implementation is a
2519
:return: None. An exception should be raised if there is an error.
2524
class WorkingTree2(WorkingTree):
2525
"""This is the Format 2 working tree.
2527
This was the first weave based working tree.
2528
- uses os locks for locking.
2529
- uses the branch last-revision.
2532
def __init__(self, *args, **kwargs):
2533
super(WorkingTree2, self).__init__(*args, **kwargs)
2534
# WorkingTree2 has more of a constraint that self._inventory must
2535
# exist. Because this is an older format, we don't mind the overhead
2536
# caused by the extra computation here.
2538
# Newer WorkingTree's should only have self._inventory set when they
2540
if self._inventory is None:
2541
self.read_working_inventory()
2543
def lock_tree_write(self):
2544
"""See WorkingTree.lock_tree_write().
2546
In Format2 WorkingTrees we have a single lock for the branch and tree
2547
so lock_tree_write() degrades to lock_write().
2549
self.branch.lock_write()
2551
return self._control_files.lock_write()
2553
self.branch.unlock()
2557
# do non-implementation specific cleanup
2560
# we share control files:
2561
if self._control_files._lock_count == 3:
2562
# _inventory_is_modified is always False during a read lock.
2563
if self._inventory_is_modified:
2565
self._write_hashcache_if_dirty()
2567
# reverse order of locking.
2569
return self._control_files.unlock()
2571
self.branch.unlock()
2574
class WorkingTree3(WorkingTree):
2575
"""This is the Format 3 working tree.
2577
This differs from the base WorkingTree by:
2578
- having its own file lock
2579
- having its own last-revision property.
2581
This is new in bzr 0.8
2585
def _last_revision(self):
2586
"""See Mutable.last_revision."""
2588
return self._control_files.get('last-revision').read()
2589
except errors.NoSuchFile:
2590
return _mod_revision.NULL_REVISION
2592
def _change_last_revision(self, revision_id):
2593
"""See WorkingTree._change_last_revision."""
2594
if revision_id is None or revision_id == NULL_REVISION:
2596
self._control_files._transport.delete('last-revision')
2597
except errors.NoSuchFile:
2601
self._control_files.put_bytes('last-revision', revision_id)
2604
@needs_tree_write_lock
2605
def set_conflicts(self, conflicts):
2606
self._put_rio('conflicts', conflicts.to_stanzas(),
2609
@needs_tree_write_lock
2610
def add_conflicts(self, new_conflicts):
2611
conflict_set = set(self.conflicts())
2612
conflict_set.update(set(list(new_conflicts)))
2613
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2614
key=_mod_conflicts.Conflict.sort_key)))
2617
def conflicts(self):
2619
confile = self._control_files.get('conflicts')
2620
except errors.NoSuchFile:
2621
return _mod_conflicts.ConflictList()
2623
if confile.next() != CONFLICT_HEADER_1 + '\n':
2624
raise errors.ConflictFormatError()
2625
except StopIteration:
2626
raise errors.ConflictFormatError()
2627
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2630
# do non-implementation specific cleanup
2632
if self._control_files._lock_count == 1:
2633
# _inventory_is_modified is always False during a read lock.
2634
if self._inventory_is_modified:
2636
self._write_hashcache_if_dirty()
2637
# reverse order of locking.
2639
return self._control_files.unlock()
2641
self.branch.unlock()
2644
def get_conflicted_stem(path):
2645
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2646
if path.endswith(suffix):
2647
return path[:-len(suffix)]
2650
@deprecated_function(zero_eight)
2651
def is_control_file(filename):
2652
"""See WorkingTree.is_control_filename(filename)."""
2653
## FIXME: better check
2654
filename = normpath(filename)
2655
while filename != '':
2656
head, tail = os.path.split(filename)
2657
## mutter('check %r for control file' % ((head, tail),))
2660
if filename == head:
2666
class WorkingTreeFormat(object):
2667
"""An encapsulation of the initialization and open routines for a format.
2669
Formats provide three things:
2670
* An initialization routine,
2674
Formats are placed in an dict by their format string for reference
2675
during workingtree opening. Its not required that these be instances, they
2676
can be classes themselves with class methods - it simply depends on
2677
whether state is needed for a given format or not.
2679
Once a format is deprecated, just deprecate the initialize and open
2680
methods on the format class. Do not deprecate the object, as the
2681
object will be created every time regardless.
2684
_default_format = None
2685
"""The default format used for new trees."""
2688
"""The known formats."""
2690
requires_rich_root = False
2692
upgrade_recommended = False
2695
def find_format(klass, a_bzrdir):
2696
"""Return the format for the working tree object in a_bzrdir."""
2698
transport = a_bzrdir.get_workingtree_transport(None)
2699
format_string = transport.get("format").read()
2700
return klass._formats[format_string]
2701
except errors.NoSuchFile:
2702
raise errors.NoWorkingTree(base=transport.base)
2704
raise errors.UnknownFormatError(format=format_string,
2705
kind="working tree")
2707
def __eq__(self, other):
2708
return self.__class__ is other.__class__
2710
def __ne__(self, other):
2711
return not (self == other)
2714
def get_default_format(klass):
2715
"""Return the current default format."""
2716
return klass._default_format
2718
def get_format_string(self):
2719
"""Return the ASCII format string that identifies this format."""
2720
raise NotImplementedError(self.get_format_string)
2722
def get_format_description(self):
2723
"""Return the short description for this format."""
2724
raise NotImplementedError(self.get_format_description)
2726
def is_supported(self):
2727
"""Is this format supported?
2729
Supported formats can be initialized and opened.
2730
Unsupported formats may not support initialization or committing or
2731
some other features depending on the reason for not being supported.
2736
def register_format(klass, format):
2737
klass._formats[format.get_format_string()] = format
2740
def set_default_format(klass, format):
2741
klass._default_format = format
2744
def unregister_format(klass, format):
2745
assert klass._formats[format.get_format_string()] is format
2746
del klass._formats[format.get_format_string()]
2749
class WorkingTreeFormat2(WorkingTreeFormat):
2750
"""The second working tree format.
2752
This format modified the hash cache from the format 1 hash cache.
2755
upgrade_recommended = True
2757
def get_format_description(self):
2758
"""See WorkingTreeFormat.get_format_description()."""
2759
return "Working tree format 2"
2761
def stub_initialize_remote(self, control_files):
2762
"""As a special workaround create critical control files for a remote working tree
2764
This ensures that it can later be updated and dealt with locally,
2765
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2766
no working tree. (See bug #43064).
2770
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2772
control_files.put('inventory', sio)
2774
control_files.put_bytes('pending-merges', '')
2777
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2778
accelerator_tree=None, hardlink=False):
2779
"""See WorkingTreeFormat.initialize()."""
2780
if not isinstance(a_bzrdir.transport, LocalTransport):
2781
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2782
if from_branch is not None:
2783
branch = from_branch
2785
branch = a_bzrdir.open_branch()
2786
if revision_id is None:
2787
revision_id = _mod_revision.ensure_null(branch.last_revision())
2790
branch.generate_revision_history(revision_id)
2794
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2800
basis_tree = branch.repository.revision_tree(revision_id)
2801
if basis_tree.inventory.root is not None:
2802
wt.set_root_id(basis_tree.get_root_id())
2803
# set the parent list and cache the basis tree.
2804
if _mod_revision.is_null(revision_id):
2807
parent_trees = [(revision_id, basis_tree)]
2808
wt.set_parent_trees(parent_trees)
2809
transform.build_tree(basis_tree, wt)
2813
super(WorkingTreeFormat2, self).__init__()
2814
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2816
def open(self, a_bzrdir, _found=False):
2817
"""Return the WorkingTree object for a_bzrdir
2819
_found is a private parameter, do not use it. It is used to indicate
2820
if format probing has already been done.
2823
# we are being called directly and must probe.
2824
raise NotImplementedError
2825
if not isinstance(a_bzrdir.transport, LocalTransport):
2826
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2827
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2833
class WorkingTreeFormat3(WorkingTreeFormat):
2834
"""The second working tree format updated to record a format marker.
2837
- exists within a metadir controlling .bzr
2838
- includes an explicit version marker for the workingtree control
2839
files, separate from the BzrDir format
2840
- modifies the hash cache format
2842
- uses a LockDir to guard access for writes.
2845
upgrade_recommended = True
2847
def get_format_string(self):
2848
"""See WorkingTreeFormat.get_format_string()."""
2849
return "Bazaar-NG Working Tree format 3"
2851
def get_format_description(self):
2852
"""See WorkingTreeFormat.get_format_description()."""
2853
return "Working tree format 3"
2855
_lock_file_name = 'lock'
2856
_lock_class = LockDir
2858
_tree_class = WorkingTree3
2860
def __get_matchingbzrdir(self):
2861
return bzrdir.BzrDirMetaFormat1()
2863
_matchingbzrdir = property(__get_matchingbzrdir)
2865
def _open_control_files(self, a_bzrdir):
2866
transport = a_bzrdir.get_workingtree_transport(None)
2867
return LockableFiles(transport, self._lock_file_name,
2870
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2871
accelerator_tree=None, hardlink=False):
2872
"""See WorkingTreeFormat.initialize().
2874
:param revision_id: if supplied, create a working tree at a different
2875
revision than the branch is at.
2876
:param accelerator_tree: A tree which can be used for retrieving file
2877
contents more quickly than the revision tree, i.e. a workingtree.
2878
The revision tree will be used for cases where accelerator_tree's
2879
content is different.
2880
:param hardlink: If true, hard-link files from accelerator_tree,
2883
if not isinstance(a_bzrdir.transport, LocalTransport):
2884
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2885
transport = a_bzrdir.get_workingtree_transport(self)
2886
control_files = self._open_control_files(a_bzrdir)
2887
control_files.create_lock()
2888
control_files.lock_write()
2889
control_files.put_utf8('format', self.get_format_string())
2890
if from_branch is not None:
2891
branch = from_branch
2893
branch = a_bzrdir.open_branch()
2894
if revision_id is None:
2895
revision_id = _mod_revision.ensure_null(branch.last_revision())
2896
# WorkingTree3 can handle an inventory which has a unique root id.
2897
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2898
# those trees. And because there isn't a format bump inbetween, we
2899
# are maintaining compatibility with older clients.
2900
# inv = Inventory(root_id=gen_root_id())
2901
inv = self._initial_inventory()
2902
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2908
_control_files=control_files)
2909
wt.lock_tree_write()
2911
basis_tree = branch.repository.revision_tree(revision_id)
2912
# only set an explicit root id if there is one to set.
2913
if basis_tree.inventory.root is not None:
2914
wt.set_root_id(basis_tree.get_root_id())
2915
if revision_id == NULL_REVISION:
2916
wt.set_parent_trees([])
2918
wt.set_parent_trees([(revision_id, basis_tree)])
2919
transform.build_tree(basis_tree, wt)
2921
# Unlock in this order so that the unlock-triggers-flush in
2922
# WorkingTree is given a chance to fire.
2923
control_files.unlock()
2927
def _initial_inventory(self):
2931
super(WorkingTreeFormat3, self).__init__()
2933
def open(self, a_bzrdir, _found=False):
2934
"""Return the WorkingTree object for a_bzrdir
2936
_found is a private parameter, do not use it. It is used to indicate
2937
if format probing has already been done.
2940
# we are being called directly and must probe.
2941
raise NotImplementedError
2942
if not isinstance(a_bzrdir.transport, LocalTransport):
2943
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2944
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2947
def _open(self, a_bzrdir, control_files):
2948
"""Open the tree itself.
2950
:param a_bzrdir: the dir for the tree.
2951
:param control_files: the control files for the tree.
2953
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2957
_control_files=control_files)
2960
return self.get_format_string()
2963
__default_format = WorkingTreeFormat4()
2964
WorkingTreeFormat.register_format(__default_format)
2965
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2966
WorkingTreeFormat.set_default_format(__default_format)
2967
# formats which have no format string are not discoverable
2968
# and not independently creatable, so are not registered.
2969
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
