1
# Copyright (C) 2005, 2006, 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import (
90
from bzrlib import symbol_versioning
91
from bzrlib.decorators import needs_read_lock, needs_write_lock
92
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
93
from bzrlib.lockable_files import LockableFiles
94
from bzrlib.lockdir import LockDir
95
import bzrlib.mutabletree
96
from bzrlib.mutabletree import needs_tree_write_lock
97
from bzrlib import osutils
98
from bzrlib.osutils import (
110
from bzrlib.filters import filtered_input_file
111
from bzrlib.trace import mutter, note
112
from bzrlib.transport.local import LocalTransport
113
from bzrlib.progress import DummyProgress, ProgressPhase
114
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
115
from bzrlib.rio import RioReader, rio_file, Stanza
116
from bzrlib.symbol_versioning import (deprecated_passed,
119
DEPRECATED_PARAMETER,
123
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
124
CONFLICT_HEADER_1 = "BZR conflict list format 1"
126
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
129
class TreeEntry(object):
130
"""An entry that implements the minimum interface used by commands.
132
This needs further inspection, it may be better to have
133
InventoryEntries without ids - though that seems wrong. For now,
134
this is a parallel hierarchy to InventoryEntry, and needs to become
135
one of several things: decorates to that hierarchy, children of, or
137
Another note is that these objects are currently only used when there is
138
no InventoryEntry available - i.e. for unversioned objects.
139
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
142
def __eq__(self, other):
143
# yes, this us ugly, TODO: best practice __eq__ style.
144
return (isinstance(other, TreeEntry)
145
and other.__class__ == self.__class__)
147
def kind_character(self):
151
class TreeDirectory(TreeEntry):
152
"""See TreeEntry. This is a directory in a working tree."""
154
def __eq__(self, other):
155
return (isinstance(other, TreeDirectory)
156
and other.__class__ == self.__class__)
158
def kind_character(self):
162
class TreeFile(TreeEntry):
163
"""See TreeEntry. This is a regular file in a working tree."""
165
def __eq__(self, other):
166
return (isinstance(other, TreeFile)
167
and other.__class__ == self.__class__)
169
def kind_character(self):
173
class TreeLink(TreeEntry):
174
"""See TreeEntry. This is a symlink in a working tree."""
176
def __eq__(self, other):
177
return (isinstance(other, TreeLink)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class WorkingTree(bzrlib.mutabletree.MutableTree):
185
"""Working copy tree.
187
The inventory is held in the `Branch` working-inventory, and the
188
files are in a directory on disk.
190
It is possible for a `WorkingTree` to have a filename which is
191
not listed in the Inventory and vice versa.
194
# override this to set the strategy for storing views
195
def _make_views(self):
196
return views.DisabledViews(self)
198
def __init__(self, basedir='.',
199
branch=DEPRECATED_PARAMETER,
205
"""Construct a WorkingTree instance. This is not a public API.
207
:param branch: A branch to override probing for the branch.
209
self._format = _format
210
self.bzrdir = _bzrdir
212
raise errors.BzrError("Please use bzrdir.open_workingtree or "
213
"WorkingTree.open() to obtain a WorkingTree.")
214
basedir = safe_unicode(basedir)
215
mutter("opening working tree %r", basedir)
216
if deprecated_passed(branch):
217
self._branch = branch
219
self._branch = self.bzrdir.open_branch()
220
self.basedir = realpath(basedir)
221
# if branch is at our basedir and is a format 6 or less
222
if isinstance(self._format, WorkingTreeFormat2):
223
# share control object
224
self._control_files = self.branch.control_files
226
# assume all other formats have their own control files.
227
self._control_files = _control_files
228
self._transport = self._control_files._transport
229
# update the whole cache up front and write to disk if anything changed;
230
# in the future we might want to do this more selectively
231
# two possible ways offer themselves : in self._unlock, write the cache
232
# if needed, or, when the cache sees a change, append it to the hash
233
# cache file, and have the parser take the most recent entry for a
235
wt_trans = self.bzrdir.get_workingtree_transport(None)
236
cache_filename = wt_trans.local_abspath('stat-cache')
237
self._hashcache = hashcache.HashCache(basedir, cache_filename,
238
self.bzrdir._get_file_mode(),
239
self._content_filter_stack_provider())
242
# is this scan needed ? it makes things kinda slow.
249
if _inventory is None:
250
# This will be acquired on lock_read() or lock_write()
251
self._inventory_is_modified = False
252
self._inventory = None
254
# the caller of __init__ has provided an inventory,
255
# we assume they know what they are doing - as its only
256
# the Format factory and creation methods that are
257
# permitted to do this.
258
self._set_inventory(_inventory, dirty=False)
259
self._detect_case_handling()
260
self._rules_searcher = None
261
self.views = self._make_views()
263
def _detect_case_handling(self):
264
wt_trans = self.bzrdir.get_workingtree_transport(None)
266
wt_trans.stat("FoRMaT")
267
except errors.NoSuchFile:
268
self.case_sensitive = True
270
self.case_sensitive = False
272
self._setup_directory_is_tree_reference()
275
fget=lambda self: self._branch,
276
doc="""The branch this WorkingTree is connected to.
278
This cannot be set - it is reflective of the actual disk structure
279
the working tree has been constructed from.
282
def break_lock(self):
283
"""Break a lock if one is present from another instance.
285
Uses the ui factory to ask for confirmation if the lock may be from
288
This will probe the repository for its lock as well.
290
self._control_files.break_lock()
291
self.branch.break_lock()
293
def _get_check_refs(self):
294
"""Return the references needed to perform a check of this tree.
296
The default implementation returns no refs, and is only suitable for
297
trees that have no local caching and can commit on ghosts at any time.
299
:seealso: bzrlib.check for details about check_refs.
303
def requires_rich_root(self):
304
return self._format.requires_rich_root
306
def supports_tree_reference(self):
309
def supports_content_filtering(self):
310
return self._format.supports_content_filtering()
312
def supports_views(self):
313
return self.views.supports_views()
315
def _set_inventory(self, inv, dirty):
316
"""Set the internal cached inventory.
318
:param inv: The inventory to set.
319
:param dirty: A boolean indicating whether the inventory is the same
320
logical inventory as whats on disk. If True the inventory is not
321
the same and should be written to disk or data will be lost, if
322
False then the inventory is the same as that on disk and any
323
serialisation would be unneeded overhead.
325
self._inventory = inv
326
self._inventory_is_modified = dirty
329
def open(path=None, _unsupported=False):
330
"""Open an existing working tree at path.
334
path = osutils.getcwd()
335
control = bzrdir.BzrDir.open(path, _unsupported)
336
return control.open_workingtree(_unsupported)
339
def open_containing(path=None):
340
"""Open an existing working tree which has its root about path.
342
This probes for a working tree at path and searches upwards from there.
344
Basically we keep looking up until we find the control directory or
345
run into /. If there isn't one, raises NotBranchError.
346
TODO: give this a new exception.
347
If there is one, it is returned, along with the unused portion of path.
349
:return: The WorkingTree that contains 'path', and the rest of path
352
path = osutils.getcwd()
353
control, relpath = bzrdir.BzrDir.open_containing(path)
355
return control.open_workingtree(), relpath
358
def open_downlevel(path=None):
359
"""Open an unsupported working tree.
361
Only intended for advanced situations like upgrading part of a bzrdir.
363
return WorkingTree.open(path, _unsupported=True)
366
def find_trees(location):
367
def list_current(transport):
368
return [d for d in transport.list_dir('') if d != '.bzr']
369
def evaluate(bzrdir):
371
tree = bzrdir.open_workingtree()
372
except errors.NoWorkingTree:
376
transport = get_transport(location)
377
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
378
list_current=list_current)
379
return [t for t in iterator if t is not None]
381
# should be deprecated - this is slow and in any case treating them as a
382
# container is (we now know) bad style -- mbp 20070302
383
## @deprecated_method(zero_fifteen)
385
"""Iterate through file_ids for this tree.
387
file_ids are in a WorkingTree if they are in the working inventory
388
and the working file exists.
390
inv = self._inventory
391
for path, ie in inv.iter_entries():
392
if osutils.lexists(self.abspath(path)):
395
def all_file_ids(self):
396
"""See Tree.iter_all_file_ids"""
397
return set(self.inventory)
400
return "<%s of %s>" % (self.__class__.__name__,
401
getattr(self, 'basedir', None))
403
def abspath(self, filename):
404
return pathjoin(self.basedir, filename)
406
def basis_tree(self):
407
"""Return RevisionTree for the current last revision.
409
If the left most parent is a ghost then the returned tree will be an
410
empty tree - one obtained by calling
411
repository.revision_tree(NULL_REVISION).
414
revision_id = self.get_parent_ids()[0]
416
# no parents, return an empty revision tree.
417
# in the future this should return the tree for
418
# 'empty:' - the implicit root empty tree.
419
return self.branch.repository.revision_tree(
420
_mod_revision.NULL_REVISION)
422
return self.revision_tree(revision_id)
423
except errors.NoSuchRevision:
425
# No cached copy available, retrieve from the repository.
426
# FIXME? RBC 20060403 should we cache the inventory locally
429
return self.branch.repository.revision_tree(revision_id)
430
except (errors.RevisionNotPresent, errors.NoSuchRevision):
431
# the basis tree *may* be a ghost or a low level error may have
432
# occurred. If the revision is present, its a problem, if its not
434
if self.branch.repository.has_revision(revision_id):
436
# the basis tree is a ghost so return an empty tree.
437
return self.branch.repository.revision_tree(
438
_mod_revision.NULL_REVISION)
441
self._flush_ignore_list_cache()
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
451
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id, path=None, filtered=True):
455
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
457
def get_file_with_stat(self, file_id, path=None, filtered=True,
459
"""See MutableTree.get_file_with_stat."""
461
path = self.id2path(file_id)
462
file_obj = self.get_file_byname(path, filtered=False)
463
stat_value = _fstat(file_obj.fileno())
464
if self.supports_content_filtering() and filtered:
465
filters = self._content_filter_stack(path)
466
file_obj = filtered_input_file(file_obj, filters)
467
return (file_obj, stat_value)
469
def get_file_text(self, file_id, path=None, filtered=True):
470
return self.get_file(file_id, path=path, filtered=filtered).read()
472
def get_file_byname(self, filename, filtered=True):
473
path = self.abspath(filename)
475
if self.supports_content_filtering() and filtered:
476
filters = self._content_filter_stack(filename)
477
return filtered_input_file(f, filters)
481
def get_file_lines(self, file_id, path=None, filtered=True):
482
"""See Tree.get_file_lines()"""
483
file = self.get_file(file_id, path, filtered=filtered)
485
return file.readlines()
490
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
491
"""See Tree.annotate_iter
493
This implementation will use the basis tree implementation if possible.
494
Lines not in the basis are attributed to CURRENT_REVISION
496
If there are pending merges, lines added by those merges will be
497
incorrectly attributed to CURRENT_REVISION (but after committing, the
498
attribution will be correct).
500
basis = self.basis_tree()
503
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
504
require_versioned=True).next()
505
changed_content, kind = changes[2], changes[6]
506
if not changed_content:
507
return basis.annotate_iter(file_id)
511
if kind[0] != 'file':
514
old_lines = list(basis.annotate_iter(file_id))
516
for tree in self.branch.repository.revision_trees(
517
self.get_parent_ids()[1:]):
518
if file_id not in tree:
520
old.append(list(tree.annotate_iter(file_id)))
521
return annotate.reannotate(old, self.get_file(file_id).readlines(),
526
def _get_ancestors(self, default_revision):
527
ancestors = set([default_revision])
528
for parent_id in self.get_parent_ids():
529
ancestors.update(self.branch.repository.get_ancestry(
530
parent_id, topo_sorted=False))
533
def get_parent_ids(self):
534
"""See Tree.get_parent_ids.
536
This implementation reads the pending merges list and last_revision
537
value and uses that to decide what the parents list should be.
539
last_rev = _mod_revision.ensure_null(self._last_revision())
540
if _mod_revision.NULL_REVISION == last_rev:
545
merges_file = self._transport.get('pending-merges')
546
except errors.NoSuchFile:
549
for l in merges_file.readlines():
550
revision_id = l.rstrip('\n')
551
parents.append(revision_id)
555
def get_root_id(self):
556
"""Return the id of this trees root"""
557
return self._inventory.root.file_id
559
def _get_store_filename(self, file_id):
560
## XXX: badly named; this is not in the store at all
561
return self.abspath(self.id2path(file_id))
564
def clone(self, to_bzrdir, revision_id=None):
565
"""Duplicate this working tree into to_bzr, including all state.
567
Specifically modified files are kept as modified, but
568
ignored and unknown files are discarded.
570
If you want to make a new line of development, see bzrdir.sprout()
573
If not None, the cloned tree will have its last revision set to
574
revision, and difference between the source trees last revision
575
and this one merged in.
577
# assumes the target bzr dir format is compatible.
578
result = to_bzrdir.create_workingtree()
579
self.copy_content_into(result, revision_id)
583
def copy_content_into(self, tree, revision_id=None):
584
"""Copy the current content and user files of this tree into tree."""
585
tree.set_root_id(self.get_root_id())
586
if revision_id is None:
587
merge.transform_tree(tree, self)
589
# TODO now merge from tree.last_revision to revision (to preserve
590
# user local changes)
591
merge.transform_tree(tree, self)
592
tree.set_parent_ids([revision_id])
594
def id2abspath(self, file_id):
595
return self.abspath(self.id2path(file_id))
597
def has_id(self, file_id):
598
# files that have been deleted are excluded
600
if not inv.has_id(file_id):
602
path = inv.id2path(file_id)
603
return osutils.lexists(self.abspath(path))
605
def has_or_had_id(self, file_id):
606
if file_id == self.inventory.root.file_id:
608
return self.inventory.has_id(file_id)
610
__contains__ = has_id
612
def get_file_size(self, file_id):
613
"""See Tree.get_file_size"""
615
return os.path.getsize(self.id2abspath(file_id))
617
if e.errno != errno.ENOENT:
623
def get_file_sha1(self, file_id, path=None, stat_value=None):
625
path = self._inventory.id2path(file_id)
626
return self._hashcache.get_sha1(path, stat_value)
628
def get_file_mtime(self, file_id, path=None):
630
path = self.inventory.id2path(file_id)
631
return os.lstat(self.abspath(path)).st_mtime
633
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
634
file_id = self.path2id(path)
635
return self._inventory[file_id].executable
637
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
638
mode = stat_result.st_mode
639
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
641
if not supports_executable():
642
def is_executable(self, file_id, path=None):
643
return self._inventory[file_id].executable
645
_is_executable_from_path_and_stat = \
646
_is_executable_from_path_and_stat_from_basis
648
def is_executable(self, file_id, path=None):
650
path = self.id2path(file_id)
651
mode = os.lstat(self.abspath(path)).st_mode
652
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
654
_is_executable_from_path_and_stat = \
655
_is_executable_from_path_and_stat_from_stat
657
@needs_tree_write_lock
658
def _add(self, files, ids, kinds):
659
"""See MutableTree._add."""
660
# TODO: Re-adding a file that is removed in the working copy
661
# should probably put it back with the previous ID.
662
# the read and write working inventory should not occur in this
663
# function - they should be part of lock_write and unlock.
665
for f, file_id, kind in zip(files, ids, kinds):
667
inv.add_path(f, kind=kind)
669
inv.add_path(f, kind=kind, file_id=file_id)
670
self._inventory_is_modified = True
672
@needs_tree_write_lock
673
def _gather_kinds(self, files, kinds):
674
"""See MutableTree._gather_kinds."""
675
for pos, f in enumerate(files):
676
if kinds[pos] is None:
677
fullpath = normpath(self.abspath(f))
679
kinds[pos] = file_kind(fullpath)
681
if e.errno == errno.ENOENT:
682
raise errors.NoSuchFile(fullpath)
685
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
686
"""Add revision_id as a parent.
688
This is equivalent to retrieving the current list of parent ids
689
and setting the list to its value plus revision_id.
691
:param revision_id: The revision id to add to the parent list. It may
692
be a ghost revision as long as its not the first parent to be added,
693
or the allow_leftmost_as_ghost parameter is set True.
694
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
696
parents = self.get_parent_ids() + [revision_id]
697
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
698
or allow_leftmost_as_ghost)
700
@needs_tree_write_lock
701
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
702
"""Add revision_id, tree tuple as a parent.
704
This is equivalent to retrieving the current list of parent trees
705
and setting the list to its value plus parent_tuple. See also
706
add_parent_tree_id - if you only have a parent id available it will be
707
simpler to use that api. If you have the parent already available, using
708
this api is preferred.
710
:param parent_tuple: The (revision id, tree) to add to the parent list.
711
If the revision_id is a ghost, pass None for the tree.
712
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
714
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
715
if len(parent_ids) > 1:
716
# the leftmost may have already been a ghost, preserve that if it
718
allow_leftmost_as_ghost = True
719
self.set_parent_ids(parent_ids,
720
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
722
@needs_tree_write_lock
723
def add_pending_merge(self, *revision_ids):
724
# TODO: Perhaps should check at this point that the
725
# history of the revision is actually present?
726
parents = self.get_parent_ids()
728
for rev_id in revision_ids:
729
if rev_id in parents:
731
parents.append(rev_id)
734
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
736
def path_content_summary(self, path, _lstat=os.lstat,
737
_mapper=osutils.file_kind_from_stat_mode):
738
"""See Tree.path_content_summary."""
739
abspath = self.abspath(path)
741
stat_result = _lstat(abspath)
743
if getattr(e, 'errno', None) == errno.ENOENT:
745
return ('missing', None, None, None)
746
# propagate other errors
748
kind = _mapper(stat_result.st_mode)
750
size = stat_result.st_size
751
# try for a stat cache lookup
752
executable = self._is_executable_from_path_and_stat(path, stat_result)
753
return (kind, size, executable, self._sha_from_stat(
755
elif kind == 'directory':
756
# perhaps it looks like a plain directory, but it's really a
758
if self._directory_is_tree_reference(path):
759
kind = 'tree-reference'
760
return kind, None, None, None
761
elif kind == 'symlink':
762
target = osutils.readlink(abspath)
763
return ('symlink', None, None, target)
765
return (kind, None, None, None)
767
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
768
"""Common ghost checking functionality from set_parent_*.
770
This checks that the left hand-parent exists if there are any
773
if len(revision_ids) > 0:
774
leftmost_id = revision_ids[0]
775
if (not allow_leftmost_as_ghost and not
776
self.branch.repository.has_revision(leftmost_id)):
777
raise errors.GhostRevisionUnusableHere(leftmost_id)
779
def _set_merges_from_parent_ids(self, parent_ids):
780
merges = parent_ids[1:]
781
self._transport.put_bytes('pending-merges', '\n'.join(merges),
782
mode=self.bzrdir._get_file_mode())
784
def _filter_parent_ids_by_ancestry(self, revision_ids):
785
"""Check that all merged revisions are proper 'heads'.
787
This will always return the first revision_id, and any merged revisions
790
if len(revision_ids) == 0:
792
graph = self.branch.repository.get_graph()
793
heads = graph.heads(revision_ids)
794
new_revision_ids = revision_ids[:1]
795
for revision_id in revision_ids[1:]:
796
if revision_id in heads and revision_id not in new_revision_ids:
797
new_revision_ids.append(revision_id)
798
if new_revision_ids != revision_ids:
799
trace.mutter('requested to set revision_ids = %s,'
800
' but filtered to %s', revision_ids, new_revision_ids)
801
return new_revision_ids
803
@needs_tree_write_lock
804
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
805
"""Set the parent ids to revision_ids.
807
See also set_parent_trees. This api will try to retrieve the tree data
808
for each element of revision_ids from the trees repository. If you have
809
tree data already available, it is more efficient to use
810
set_parent_trees rather than set_parent_ids. set_parent_ids is however
811
an easier API to use.
813
:param revision_ids: The revision_ids to set as the parent ids of this
814
working tree. Any of these may be ghosts.
816
self._check_parents_for_ghosts(revision_ids,
817
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
818
for revision_id in revision_ids:
819
_mod_revision.check_not_reserved_id(revision_id)
821
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
823
if len(revision_ids) > 0:
824
self.set_last_revision(revision_ids[0])
826
self.set_last_revision(_mod_revision.NULL_REVISION)
828
self._set_merges_from_parent_ids(revision_ids)
830
@needs_tree_write_lock
831
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
832
"""See MutableTree.set_parent_trees."""
833
parent_ids = [rev for (rev, tree) in parents_list]
834
for revision_id in parent_ids:
835
_mod_revision.check_not_reserved_id(revision_id)
837
self._check_parents_for_ghosts(parent_ids,
838
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
840
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
842
if len(parent_ids) == 0:
843
leftmost_parent_id = _mod_revision.NULL_REVISION
844
leftmost_parent_tree = None
846
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
848
if self._change_last_revision(leftmost_parent_id):
849
if leftmost_parent_tree is None:
850
# If we don't have a tree, fall back to reading the
851
# parent tree from the repository.
852
self._cache_basis_inventory(leftmost_parent_id)
854
inv = leftmost_parent_tree.inventory
855
xml = self._create_basis_xml_from_inventory(
856
leftmost_parent_id, inv)
857
self._write_basis_inventory(xml)
858
self._set_merges_from_parent_ids(parent_ids)
860
@needs_tree_write_lock
861
def set_pending_merges(self, rev_list):
862
parents = self.get_parent_ids()
863
leftmost = parents[:1]
864
new_parents = leftmost + rev_list
865
self.set_parent_ids(new_parents)
867
@needs_tree_write_lock
868
def set_merge_modified(self, modified_hashes):
870
for file_id, hash in modified_hashes.iteritems():
871
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
872
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
874
def _sha_from_stat(self, path, stat_result):
875
"""Get a sha digest from the tree's stat cache.
877
The default implementation assumes no stat cache is present.
879
:param path: The path.
880
:param stat_result: The stat result being looked up.
884
def _put_rio(self, filename, stanzas, header):
885
self._must_be_locked()
886
my_file = rio_file(stanzas, header)
887
self._transport.put_file(filename, my_file,
888
mode=self.bzrdir._get_file_mode())
890
@needs_write_lock # because merge pulls data into the branch.
891
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
893
"""Merge from a branch into this working tree.
895
:param branch: The branch to merge from.
896
:param to_revision: If non-None, the merge will merge to to_revision,
897
but not beyond it. to_revision does not need to be in the history
898
of the branch when it is supplied. If None, to_revision defaults to
899
branch.last_revision().
901
from bzrlib.merge import Merger, Merge3Merger
902
pb = bzrlib.ui.ui_factory.nested_progress_bar()
904
merger = Merger(self.branch, this_tree=self, pb=pb)
905
merger.pp = ProgressPhase("Merge phase", 5, pb)
906
merger.pp.next_phase()
907
# check that there are no
909
merger.check_basis(check_clean=True, require_commits=False)
910
if to_revision is None:
911
to_revision = _mod_revision.ensure_null(branch.last_revision())
912
merger.other_rev_id = to_revision
913
if _mod_revision.is_null(merger.other_rev_id):
914
raise errors.NoCommits(branch)
915
self.branch.fetch(branch, last_revision=merger.other_rev_id)
916
merger.other_basis = merger.other_rev_id
917
merger.other_tree = self.branch.repository.revision_tree(
919
merger.other_branch = branch
920
merger.pp.next_phase()
921
if from_revision is None:
924
merger.set_base_revision(from_revision, branch)
925
if merger.base_rev_id == merger.other_rev_id:
926
raise errors.PointlessMerge
927
merger.backup_files = False
928
if merge_type is None:
929
merger.merge_type = Merge3Merger
931
merger.merge_type = merge_type
932
merger.set_interesting_files(None)
933
merger.show_base = False
934
merger.reprocess = False
935
conflicts = merger.do_merge()
942
def merge_modified(self):
943
"""Return a dictionary of files modified by a merge.
945
The list is initialized by WorkingTree.set_merge_modified, which is
946
typically called after we make some automatic updates to the tree
949
This returns a map of file_id->sha1, containing only files which are
950
still in the working inventory and have that text hash.
953
hashfile = self._transport.get('merge-hashes')
954
except errors.NoSuchFile:
959
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
960
raise errors.MergeModifiedFormatError()
961
except StopIteration:
962
raise errors.MergeModifiedFormatError()
963
for s in RioReader(hashfile):
964
# RioReader reads in Unicode, so convert file_ids back to utf8
965
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
966
if file_id not in self.inventory:
968
text_hash = s.get("hash")
969
if text_hash == self.get_file_sha1(file_id):
970
merge_hashes[file_id] = text_hash
976
def mkdir(self, path, file_id=None):
977
"""See MutableTree.mkdir()."""
979
file_id = generate_ids.gen_file_id(os.path.basename(path))
980
os.mkdir(self.abspath(path))
981
self.add(path, file_id, 'directory')
984
def get_symlink_target(self, file_id):
985
abspath = self.id2abspath(file_id)
986
target = osutils.readlink(abspath)
990
def subsume(self, other_tree):
991
def add_children(inventory, entry):
992
for child_entry in entry.children.values():
993
inventory._byid[child_entry.file_id] = child_entry
994
if child_entry.kind == 'directory':
995
add_children(inventory, child_entry)
996
if other_tree.get_root_id() == self.get_root_id():
997
raise errors.BadSubsumeSource(self, other_tree,
998
'Trees have the same root')
1000
other_tree_path = self.relpath(other_tree.basedir)
1001
except errors.PathNotChild:
1002
raise errors.BadSubsumeSource(self, other_tree,
1003
'Tree is not contained by the other')
1004
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1005
if new_root_parent is None:
1006
raise errors.BadSubsumeSource(self, other_tree,
1007
'Parent directory is not versioned.')
1008
# We need to ensure that the result of a fetch will have a
1009
# versionedfile for the other_tree root, and only fetching into
1010
# RepositoryKnit2 guarantees that.
1011
if not self.branch.repository.supports_rich_root():
1012
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1013
other_tree.lock_tree_write()
1015
new_parents = other_tree.get_parent_ids()
1016
other_root = other_tree.inventory.root
1017
other_root.parent_id = new_root_parent
1018
other_root.name = osutils.basename(other_tree_path)
1019
self.inventory.add(other_root)
1020
add_children(self.inventory, other_root)
1021
self._write_inventory(self.inventory)
1022
# normally we don't want to fetch whole repositories, but i think
1023
# here we really do want to consolidate the whole thing.
1024
for parent_id in other_tree.get_parent_ids():
1025
self.branch.fetch(other_tree.branch, parent_id)
1026
self.add_parent_tree_id(parent_id)
1029
other_tree.bzrdir.retire_bzrdir()
1031
def _setup_directory_is_tree_reference(self):
1032
if self._branch.repository._format.supports_tree_reference:
1033
self._directory_is_tree_reference = \
1034
self._directory_may_be_tree_reference
1036
self._directory_is_tree_reference = \
1037
self._directory_is_never_tree_reference
1039
def _directory_is_never_tree_reference(self, relpath):
1042
def _directory_may_be_tree_reference(self, relpath):
1043
# as a special case, if a directory contains control files then
1044
# it's a tree reference, except that the root of the tree is not
1045
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1046
# TODO: We could ask all the control formats whether they
1047
# recognize this directory, but at the moment there's no cheap api
1048
# to do that. Since we probably can only nest bzr checkouts and
1049
# they always use this name it's ok for now. -- mbp 20060306
1051
# FIXME: There is an unhandled case here of a subdirectory
1052
# containing .bzr but not a branch; that will probably blow up
1053
# when you try to commit it. It might happen if there is a
1054
# checkout in a subdirectory. This can be avoided by not adding
1057
@needs_tree_write_lock
1058
def extract(self, file_id, format=None):
1059
"""Extract a subtree from this tree.
1061
A new branch will be created, relative to the path for this tree.
1065
segments = osutils.splitpath(path)
1066
transport = self.branch.bzrdir.root_transport
1067
for name in segments:
1068
transport = transport.clone(name)
1069
transport.ensure_base()
1072
sub_path = self.id2path(file_id)
1073
branch_transport = mkdirs(sub_path)
1075
format = self.bzrdir.cloning_metadir()
1076
branch_transport.ensure_base()
1077
branch_bzrdir = format.initialize_on_transport(branch_transport)
1079
repo = branch_bzrdir.find_repository()
1080
except errors.NoRepositoryPresent:
1081
repo = branch_bzrdir.create_repository()
1082
if not repo.supports_rich_root():
1083
raise errors.RootNotRich()
1084
new_branch = branch_bzrdir.create_branch()
1085
new_branch.pull(self.branch)
1086
for parent_id in self.get_parent_ids():
1087
new_branch.fetch(self.branch, parent_id)
1088
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1089
if tree_transport.base != branch_transport.base:
1090
tree_bzrdir = format.initialize_on_transport(tree_transport)
1091
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1093
tree_bzrdir = branch_bzrdir
1094
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1095
wt.set_parent_ids(self.get_parent_ids())
1096
my_inv = self.inventory
1097
child_inv = Inventory(root_id=None)
1098
new_root = my_inv[file_id]
1099
my_inv.remove_recursive_id(file_id)
1100
new_root.parent_id = None
1101
child_inv.add(new_root)
1102
self._write_inventory(my_inv)
1103
wt._write_inventory(child_inv)
1106
def _serialize(self, inventory, out_file):
1107
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1110
def _deserialize(selt, in_file):
1111
return xml5.serializer_v5.read_inventory(in_file)
1114
"""Write the in memory inventory to disk."""
1115
# TODO: Maybe this should only write on dirty ?
1116
if self._control_files._lock_mode != 'w':
1117
raise errors.NotWriteLocked(self)
1119
self._serialize(self._inventory, sio)
1121
self._transport.put_file('inventory', sio,
1122
mode=self.bzrdir._get_file_mode())
1123
self._inventory_is_modified = False
1125
def _kind(self, relpath):
1126
return osutils.file_kind(self.abspath(relpath))
1128
def list_files(self, include_root=False):
1129
"""Recursively list all files as (path, class, kind, id, entry).
1131
Lists, but does not descend into unversioned directories.
1133
This does not include files that have been deleted in this
1136
Skips the control directory.
1138
# list_files is an iterator, so @needs_read_lock doesn't work properly
1139
# with it. So callers should be careful to always read_lock the tree.
1140
if not self.is_locked():
1141
raise errors.ObjectNotLocked(self)
1143
inv = self.inventory
1144
if include_root is True:
1145
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1146
# Convert these into local objects to save lookup times
1147
pathjoin = osutils.pathjoin
1148
file_kind = self._kind
1150
# transport.base ends in a slash, we want the piece
1151
# between the last two slashes
1152
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1154
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1156
# directory file_id, relative path, absolute path, reverse sorted children
1157
children = os.listdir(self.basedir)
1159
# jam 20060527 The kernel sized tree seems equivalent whether we
1160
# use a deque and popleft to keep them sorted, or if we use a plain
1161
# list and just reverse() them.
1162
children = collections.deque(children)
1163
stack = [(inv.root.file_id, u'', self.basedir, children)]
1165
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1168
f = children.popleft()
1169
## TODO: If we find a subdirectory with its own .bzr
1170
## directory, then that is a separate tree and we
1171
## should exclude it.
1173
# the bzrdir for this tree
1174
if transport_base_dir == f:
1177
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1178
# and 'f' doesn't begin with one, we can do a string op, rather
1179
# than the checks of pathjoin(), all relative paths will have an extra slash
1181
fp = from_dir_relpath + '/' + f
1184
fap = from_dir_abspath + '/' + f
1186
f_ie = inv.get_child(from_dir_id, f)
1189
elif self.is_ignored(fp[1:]):
1192
# we may not have found this file, because of a unicode issue
1193
f_norm, can_access = osutils.normalized_filename(f)
1194
if f == f_norm or not can_access:
1195
# No change, so treat this file normally
1198
# this file can be accessed by a normalized path
1199
# check again if it is versioned
1200
# these lines are repeated here for performance
1202
fp = from_dir_relpath + '/' + f
1203
fap = from_dir_abspath + '/' + f
1204
f_ie = inv.get_child(from_dir_id, f)
1207
elif self.is_ignored(fp[1:]):
1214
# make a last minute entry
1216
yield fp[1:], c, fk, f_ie.file_id, f_ie
1219
yield fp[1:], c, fk, None, fk_entries[fk]()
1221
yield fp[1:], c, fk, None, TreeEntry()
1224
if fk != 'directory':
1227
# But do this child first
1228
new_children = os.listdir(fap)
1230
new_children = collections.deque(new_children)
1231
stack.append((f_ie.file_id, fp, fap, new_children))
1232
# Break out of inner loop,
1233
# so that we start outer loop with child
1236
# if we finished all children, pop it off the stack
1239
@needs_tree_write_lock
1240
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1243
to_dir must exist in the inventory.
1245
If to_dir exists and is a directory, the files are moved into
1246
it, keeping their old names.
1248
Note that to_dir is only the last component of the new name;
1249
this doesn't change the directory.
1251
For each entry in from_paths the move mode will be determined
1254
The first mode moves the file in the filesystem and updates the
1255
inventory. The second mode only updates the inventory without
1256
touching the file on the filesystem. This is the new mode introduced
1259
move uses the second mode if 'after == True' and the target is not
1260
versioned but present in the working tree.
1262
move uses the second mode if 'after == False' and the source is
1263
versioned but no longer in the working tree, and the target is not
1264
versioned but present in the working tree.
1266
move uses the first mode if 'after == False' and the source is
1267
versioned and present in the working tree, and the target is not
1268
versioned and not present in the working tree.
1270
Everything else results in an error.
1272
This returns a list of (from_path, to_path) pairs for each
1273
entry that is moved.
1278
# check for deprecated use of signature
1280
to_dir = kwargs.get('to_name', None)
1282
raise TypeError('You must supply a target directory')
1284
symbol_versioning.warn('The parameter to_name was deprecated'
1285
' in version 0.13. Use to_dir instead',
1288
# check destination directory
1289
if isinstance(from_paths, basestring):
1291
inv = self.inventory
1292
to_abs = self.abspath(to_dir)
1293
if not isdir(to_abs):
1294
raise errors.BzrMoveFailedError('',to_dir,
1295
errors.NotADirectory(to_abs))
1296
if not self.has_filename(to_dir):
1297
raise errors.BzrMoveFailedError('',to_dir,
1298
errors.NotInWorkingDirectory(to_dir))
1299
to_dir_id = inv.path2id(to_dir)
1300
if to_dir_id is None:
1301
raise errors.BzrMoveFailedError('',to_dir,
1302
errors.NotVersionedError(path=str(to_dir)))
1304
to_dir_ie = inv[to_dir_id]
1305
if to_dir_ie.kind != 'directory':
1306
raise errors.BzrMoveFailedError('',to_dir,
1307
errors.NotADirectory(to_abs))
1309
# create rename entries and tuples
1310
for from_rel in from_paths:
1311
from_tail = splitpath(from_rel)[-1]
1312
from_id = inv.path2id(from_rel)
1314
raise errors.BzrMoveFailedError(from_rel,to_dir,
1315
errors.NotVersionedError(path=str(from_rel)))
1317
from_entry = inv[from_id]
1318
from_parent_id = from_entry.parent_id
1319
to_rel = pathjoin(to_dir, from_tail)
1320
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1322
from_tail=from_tail,
1323
from_parent_id=from_parent_id,
1324
to_rel=to_rel, to_tail=from_tail,
1325
to_parent_id=to_dir_id)
1326
rename_entries.append(rename_entry)
1327
rename_tuples.append((from_rel, to_rel))
1329
# determine which move mode to use. checks also for movability
1330
rename_entries = self._determine_mv_mode(rename_entries, after)
1332
original_modified = self._inventory_is_modified
1335
self._inventory_is_modified = True
1336
self._move(rename_entries)
1338
# restore the inventory on error
1339
self._inventory_is_modified = original_modified
1341
self._write_inventory(inv)
1342
return rename_tuples
1344
def _determine_mv_mode(self, rename_entries, after=False):
1345
"""Determines for each from-to pair if both inventory and working tree
1346
or only the inventory has to be changed.
1348
Also does basic plausability tests.
1350
inv = self.inventory
1352
for rename_entry in rename_entries:
1353
# store to local variables for easier reference
1354
from_rel = rename_entry.from_rel
1355
from_id = rename_entry.from_id
1356
to_rel = rename_entry.to_rel
1357
to_id = inv.path2id(to_rel)
1358
only_change_inv = False
1360
# check the inventory for source and destination
1362
raise errors.BzrMoveFailedError(from_rel,to_rel,
1363
errors.NotVersionedError(path=str(from_rel)))
1364
if to_id is not None:
1365
raise errors.BzrMoveFailedError(from_rel,to_rel,
1366
errors.AlreadyVersionedError(path=str(to_rel)))
1368
# try to determine the mode for rename (only change inv or change
1369
# inv and file system)
1371
if not self.has_filename(to_rel):
1372
raise errors.BzrMoveFailedError(from_id,to_rel,
1373
errors.NoSuchFile(path=str(to_rel),
1374
extra="New file has not been created yet"))
1375
only_change_inv = True
1376
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1377
only_change_inv = True
1378
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1379
only_change_inv = False
1380
elif (not self.case_sensitive
1381
and from_rel.lower() == to_rel.lower()
1382
and self.has_filename(from_rel)):
1383
only_change_inv = False
1385
# something is wrong, so lets determine what exactly
1386
if not self.has_filename(from_rel) and \
1387
not self.has_filename(to_rel):
1388
raise errors.BzrRenameFailedError(from_rel,to_rel,
1389
errors.PathsDoNotExist(paths=(str(from_rel),
1392
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1393
rename_entry.only_change_inv = only_change_inv
1394
return rename_entries
1396
def _move(self, rename_entries):
1397
"""Moves a list of files.
1399
Depending on the value of the flag 'only_change_inv', the
1400
file will be moved on the file system or not.
1402
inv = self.inventory
1405
for entry in rename_entries:
1407
self._move_entry(entry)
1409
self._rollback_move(moved)
1413
def _rollback_move(self, moved):
1414
"""Try to rollback a previous move in case of an filesystem error."""
1415
inv = self.inventory
1418
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1419
entry.to_tail, entry.to_parent_id, entry.from_rel,
1420
entry.from_tail, entry.from_parent_id,
1421
entry.only_change_inv))
1422
except errors.BzrMoveFailedError, e:
1423
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1424
" The working tree is in an inconsistent state."
1425
" Please consider doing a 'bzr revert'."
1426
" Error message is: %s" % e)
1428
def _move_entry(self, entry):
1429
inv = self.inventory
1430
from_rel_abs = self.abspath(entry.from_rel)
1431
to_rel_abs = self.abspath(entry.to_rel)
1432
if from_rel_abs == to_rel_abs:
1433
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1434
"Source and target are identical.")
1436
if not entry.only_change_inv:
1438
osutils.rename(from_rel_abs, to_rel_abs)
1440
raise errors.BzrMoveFailedError(entry.from_rel,
1442
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1444
@needs_tree_write_lock
1445
def rename_one(self, from_rel, to_rel, after=False):
1448
This can change the directory or the filename or both.
1450
rename_one has several 'modes' to work. First, it can rename a physical
1451
file and change the file_id. That is the normal mode. Second, it can
1452
only change the file_id without touching any physical file. This is
1453
the new mode introduced in version 0.15.
1455
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1456
versioned but present in the working tree.
1458
rename_one uses the second mode if 'after == False' and 'from_rel' is
1459
versioned but no longer in the working tree, and 'to_rel' is not
1460
versioned but present in the working tree.
1462
rename_one uses the first mode if 'after == False' and 'from_rel' is
1463
versioned and present in the working tree, and 'to_rel' is not
1464
versioned and not present in the working tree.
1466
Everything else results in an error.
1468
inv = self.inventory
1471
# create rename entries and tuples
1472
from_tail = splitpath(from_rel)[-1]
1473
from_id = inv.path2id(from_rel)
1475
raise errors.BzrRenameFailedError(from_rel,to_rel,
1476
errors.NotVersionedError(path=str(from_rel)))
1477
from_entry = inv[from_id]
1478
from_parent_id = from_entry.parent_id
1479
to_dir, to_tail = os.path.split(to_rel)
1480
to_dir_id = inv.path2id(to_dir)
1481
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1483
from_tail=from_tail,
1484
from_parent_id=from_parent_id,
1485
to_rel=to_rel, to_tail=to_tail,
1486
to_parent_id=to_dir_id)
1487
rename_entries.append(rename_entry)
1489
# determine which move mode to use. checks also for movability
1490
rename_entries = self._determine_mv_mode(rename_entries, after)
1492
# check if the target changed directory and if the target directory is
1494
if to_dir_id is None:
1495
raise errors.BzrMoveFailedError(from_rel,to_rel,
1496
errors.NotVersionedError(path=str(to_dir)))
1498
# all checks done. now we can continue with our actual work
1499
mutter('rename_one:\n'
1504
' to_dir_id {%s}\n',
1505
from_id, from_rel, to_rel, to_dir, to_dir_id)
1507
self._move(rename_entries)
1508
self._write_inventory(inv)
1510
class _RenameEntry(object):
1511
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1512
to_rel, to_tail, to_parent_id, only_change_inv=False):
1513
self.from_rel = from_rel
1514
self.from_id = from_id
1515
self.from_tail = from_tail
1516
self.from_parent_id = from_parent_id
1517
self.to_rel = to_rel
1518
self.to_tail = to_tail
1519
self.to_parent_id = to_parent_id
1520
self.only_change_inv = only_change_inv
1524
"""Return all unknown files.
1526
These are files in the working directory that are not versioned or
1527
control files or ignored.
1529
# force the extras method to be fully executed before returning, to
1530
# prevent race conditions with the lock
1532
[subp for subp in self.extras() if not self.is_ignored(subp)])
1534
@needs_tree_write_lock
1535
def unversion(self, file_ids):
1536
"""Remove the file ids in file_ids from the current versioned set.
1538
When a file_id is unversioned, all of its children are automatically
1541
:param file_ids: The file ids to stop versioning.
1542
:raises: NoSuchId if any fileid is not currently versioned.
1544
for file_id in file_ids:
1545
if file_id not in self._inventory:
1546
raise errors.NoSuchId(self, file_id)
1547
for file_id in file_ids:
1548
if self._inventory.has_id(file_id):
1549
self._inventory.remove_recursive_id(file_id)
1551
# in the future this should just set a dirty bit to wait for the
1552
# final unlock. However, until all methods of workingtree start
1553
# with the current in -memory inventory rather than triggering
1554
# a read, it is more complex - we need to teach read_inventory
1555
# to know when to read, and when to not read first... and possibly
1556
# to save first when the in memory one may be corrupted.
1557
# so for now, we just only write it if it is indeed dirty.
1559
self._write_inventory(self._inventory)
1561
def _iter_conflicts(self):
1563
for info in self.list_files():
1565
stem = get_conflicted_stem(path)
1568
if stem not in conflicted:
1569
conflicted.add(stem)
1573
def pull(self, source, overwrite=False, stop_revision=None,
1574
change_reporter=None, possible_transports=None):
1575
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1578
pp = ProgressPhase("Pull phase", 2, top_pb)
1580
old_revision_info = self.branch.last_revision_info()
1581
basis_tree = self.basis_tree()
1582
count = self.branch.pull(source, overwrite, stop_revision,
1583
possible_transports=possible_transports)
1584
new_revision_info = self.branch.last_revision_info()
1585
if new_revision_info != old_revision_info:
1587
repository = self.branch.repository
1588
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1589
basis_tree.lock_read()
1591
new_basis_tree = self.branch.basis_tree()
1598
change_reporter=change_reporter)
1599
if (basis_tree.inventory.root is None and
1600
new_basis_tree.inventory.root is not None):
1601
self.set_root_id(new_basis_tree.get_root_id())
1605
# TODO - dedup parents list with things merged by pull ?
1606
# reuse the revisiontree we merged against to set the new
1608
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1609
# we have to pull the merge trees out again, because
1610
# merge_inner has set the ids. - this corner is not yet
1611
# layered well enough to prevent double handling.
1612
# XXX TODO: Fix the double handling: telling the tree about
1613
# the already known parent data is wasteful.
1614
merges = self.get_parent_ids()[1:]
1615
parent_trees.extend([
1616
(parent, repository.revision_tree(parent)) for
1618
self.set_parent_trees(parent_trees)
1625
def put_file_bytes_non_atomic(self, file_id, bytes):
1626
"""See MutableTree.put_file_bytes_non_atomic."""
1627
stream = file(self.id2abspath(file_id), 'wb')
1632
# TODO: update the hashcache here ?
1635
"""Yield all unversioned files in this WorkingTree.
1637
If there are any unversioned directories then only the directory is
1638
returned, not all its children. But if there are unversioned files
1639
under a versioned subdirectory, they are returned.
1641
Currently returned depth-first, sorted by name within directories.
1642
This is the same order used by 'osutils.walkdirs'.
1644
## TODO: Work from given directory downwards
1645
for path, dir_entry in self.inventory.directories():
1646
# mutter("search for unknowns in %r", path)
1647
dirabs = self.abspath(path)
1648
if not isdir(dirabs):
1649
# e.g. directory deleted
1653
for subf in os.listdir(dirabs):
1656
if subf not in dir_entry.children:
1659
can_access) = osutils.normalized_filename(subf)
1660
except UnicodeDecodeError:
1661
path_os_enc = path.encode(osutils._fs_enc)
1662
relpath = path_os_enc + '/' + subf
1663
raise errors.BadFilenameEncoding(relpath,
1665
if subf_norm != subf and can_access:
1666
if subf_norm not in dir_entry.children:
1667
fl.append(subf_norm)
1673
subp = pathjoin(path, subf)
1676
def ignored_files(self):
1677
"""Yield list of PATH, IGNORE_PATTERN"""
1678
for subp in self.extras():
1679
pat = self.is_ignored(subp)
1683
def get_ignore_list(self):
1684
"""Return list of ignore patterns.
1686
Cached in the Tree object after the first call.
1688
ignoreset = getattr(self, '_ignoreset', None)
1689
if ignoreset is not None:
1692
ignore_globs = set()
1693
ignore_globs.update(ignores.get_runtime_ignores())
1694
ignore_globs.update(ignores.get_user_ignores())
1695
if self.has_filename(bzrlib.IGNORE_FILENAME):
1696
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1698
ignore_globs.update(ignores.parse_ignore_file(f))
1701
self._ignoreset = ignore_globs
1704
def _flush_ignore_list_cache(self):
1705
"""Resets the cached ignore list to force a cache rebuild."""
1706
self._ignoreset = None
1707
self._ignoreglobster = None
1709
def is_ignored(self, filename):
1710
r"""Check whether the filename matches an ignore pattern.
1712
Patterns containing '/' or '\' need to match the whole path;
1713
others match against only the last component.
1715
If the file is ignored, returns the pattern which caused it to
1716
be ignored, otherwise None. So this can simply be used as a
1717
boolean if desired."""
1718
if getattr(self, '_ignoreglobster', None) is None:
1719
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1720
return self._ignoreglobster.match(filename)
1722
def kind(self, file_id):
1723
return file_kind(self.id2abspath(file_id))
1725
def stored_kind(self, file_id):
1726
"""See Tree.stored_kind"""
1727
return self.inventory[file_id].kind
1729
def _comparison_data(self, entry, path):
1730
abspath = self.abspath(path)
1732
stat_value = os.lstat(abspath)
1734
if getattr(e, 'errno', None) == errno.ENOENT:
1741
mode = stat_value.st_mode
1742
kind = osutils.file_kind_from_stat_mode(mode)
1743
if not supports_executable():
1744
executable = entry is not None and entry.executable
1746
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1747
return kind, executable, stat_value
1749
def _file_size(self, entry, stat_value):
1750
return stat_value.st_size
1752
def last_revision(self):
1753
"""Return the last revision of the branch for this tree.
1755
This format tree does not support a separate marker for last-revision
1756
compared to the branch.
1758
See MutableTree.last_revision
1760
return self._last_revision()
1763
def _last_revision(self):
1764
"""helper for get_parent_ids."""
1765
return _mod_revision.ensure_null(self.branch.last_revision())
1767
def is_locked(self):
1768
return self._control_files.is_locked()
1770
def _must_be_locked(self):
1771
if not self.is_locked():
1772
raise errors.ObjectNotLocked(self)
1774
def lock_read(self):
1775
"""See Branch.lock_read, and WorkingTree.unlock."""
1776
if not self.is_locked():
1778
self.branch.lock_read()
1780
return self._control_files.lock_read()
1782
self.branch.unlock()
1785
def lock_tree_write(self):
1786
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1787
if not self.is_locked():
1789
self.branch.lock_read()
1791
return self._control_files.lock_write()
1793
self.branch.unlock()
1796
def lock_write(self):
1797
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1798
if not self.is_locked():
1800
self.branch.lock_write()
1802
return self._control_files.lock_write()
1804
self.branch.unlock()
1807
def get_physical_lock_status(self):
1808
return self._control_files.get_physical_lock_status()
1810
def _basis_inventory_name(self):
1811
return 'basis-inventory-cache'
1813
def _reset_data(self):
1814
"""Reset transient data that cannot be revalidated."""
1815
self._inventory_is_modified = False
1816
result = self._deserialize(self._transport.get('inventory'))
1817
self._set_inventory(result, dirty=False)
1819
@needs_tree_write_lock
1820
def set_last_revision(self, new_revision):
1821
"""Change the last revision in the working tree."""
1822
if self._change_last_revision(new_revision):
1823
self._cache_basis_inventory(new_revision)
1825
def _change_last_revision(self, new_revision):
1826
"""Template method part of set_last_revision to perform the change.
1828
This is used to allow WorkingTree3 instances to not affect branch
1829
when their last revision is set.
1831
if _mod_revision.is_null(new_revision):
1832
self.branch.set_revision_history([])
1835
self.branch.generate_revision_history(new_revision)
1836
except errors.NoSuchRevision:
1837
# not present in the repo - dont try to set it deeper than the tip
1838
self.branch.set_revision_history([new_revision])
1841
def _write_basis_inventory(self, xml):
1842
"""Write the basis inventory XML to the basis-inventory file"""
1843
path = self._basis_inventory_name()
1845
self._transport.put_file(path, sio,
1846
mode=self.bzrdir._get_file_mode())
1848
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1849
"""Create the text that will be saved in basis-inventory"""
1850
inventory.revision_id = revision_id
1851
return xml7.serializer_v7.write_inventory_to_string(inventory)
1853
def _cache_basis_inventory(self, new_revision):
1854
"""Cache new_revision as the basis inventory."""
1855
# TODO: this should allow the ready-to-use inventory to be passed in,
1856
# as commit already has that ready-to-use [while the format is the
1859
# this double handles the inventory - unpack and repack -
1860
# but is easier to understand. We can/should put a conditional
1861
# in here based on whether the inventory is in the latest format
1862
# - perhaps we should repack all inventories on a repository
1864
# the fast path is to copy the raw xml from the repository. If the
1865
# xml contains 'revision_id="', then we assume the right
1866
# revision_id is set. We must check for this full string, because a
1867
# root node id can legitimately look like 'revision_id' but cannot
1869
xml = self.branch.repository.get_inventory_xml(new_revision)
1870
firstline = xml.split('\n', 1)[0]
1871
if (not 'revision_id="' in firstline or
1872
'format="7"' not in firstline):
1873
inv = self.branch.repository.deserialise_inventory(
1875
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1876
self._write_basis_inventory(xml)
1877
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1880
def read_basis_inventory(self):
1881
"""Read the cached basis inventory."""
1882
path = self._basis_inventory_name()
1883
return self._transport.get_bytes(path)
1886
def read_working_inventory(self):
1887
"""Read the working inventory.
1889
:raises errors.InventoryModified: read_working_inventory will fail
1890
when the current in memory inventory has been modified.
1892
# conceptually this should be an implementation detail of the tree.
1893
# XXX: Deprecate this.
1894
# ElementTree does its own conversion from UTF-8, so open in
1896
if self._inventory_is_modified:
1897
raise errors.InventoryModified(self)
1898
result = self._deserialize(self._transport.get('inventory'))
1899
self._set_inventory(result, dirty=False)
1902
@needs_tree_write_lock
1903
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1905
"""Remove nominated files from the working inventory.
1907
:files: File paths relative to the basedir.
1908
:keep_files: If true, the files will also be kept.
1909
:force: Delete files and directories, even if they are changed and
1910
even if the directories are not empty.
1912
if isinstance(files, basestring):
1918
unknown_nested_files=set()
1920
def recurse_directory_to_add_files(directory):
1921
# Recurse directory and add all files
1922
# so we can check if they have changed.
1923
for parent_info, file_infos in\
1924
self.walkdirs(directory):
1925
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1926
# Is it versioned or ignored?
1927
if self.path2id(relpath) or self.is_ignored(relpath):
1928
# Add nested content for deletion.
1929
new_files.add(relpath)
1931
# Files which are not versioned and not ignored
1932
# should be treated as unknown.
1933
unknown_nested_files.add((relpath, None, kind))
1935
for filename in files:
1936
# Get file name into canonical form.
1937
abspath = self.abspath(filename)
1938
filename = self.relpath(abspath)
1939
if len(filename) > 0:
1940
new_files.add(filename)
1941
recurse_directory_to_add_files(filename)
1943
files = list(new_files)
1946
return # nothing to do
1948
# Sort needed to first handle directory content before the directory
1949
files.sort(reverse=True)
1951
# Bail out if we are going to delete files we shouldn't
1952
if not keep_files and not force:
1953
has_changed_files = len(unknown_nested_files) > 0
1954
if not has_changed_files:
1955
for (file_id, path, content_change, versioned, parent_id, name,
1956
kind, executable) in self.iter_changes(self.basis_tree(),
1957
include_unchanged=True, require_versioned=False,
1958
want_unversioned=True, specific_files=files):
1959
if versioned == (False, False):
1960
# The record is unknown ...
1961
if not self.is_ignored(path[1]):
1962
# ... but not ignored
1963
has_changed_files = True
1965
elif content_change and (kind[1] is not None):
1966
# Versioned and changed, but not deleted
1967
has_changed_files = True
1970
if has_changed_files:
1971
# Make delta show ALL applicable changes in error message.
1972
tree_delta = self.changes_from(self.basis_tree(),
1973
require_versioned=False, want_unversioned=True,
1974
specific_files=files)
1975
for unknown_file in unknown_nested_files:
1976
if unknown_file not in tree_delta.unversioned:
1977
tree_delta.unversioned.extend((unknown_file,))
1978
raise errors.BzrRemoveChangedFilesError(tree_delta)
1980
# Build inv_delta and delete files where applicable,
1981
# do this before any modifications to inventory.
1983
fid = self.path2id(f)
1986
message = "%s is not versioned." % (f,)
1989
# having removed it, it must be either ignored or unknown
1990
if self.is_ignored(f):
1994
textui.show_status(new_status, self.kind(fid), f,
1997
inv_delta.append((f, None, fid, None))
1998
message = "removed %s" % (f,)
2001
abs_path = self.abspath(f)
2002
if osutils.lexists(abs_path):
2003
if (osutils.isdir(abs_path) and
2004
len(os.listdir(abs_path)) > 0):
2006
osutils.rmtree(abs_path)
2008
message = "%s is not an empty directory "\
2009
"and won't be deleted." % (f,)
2011
osutils.delete_any(abs_path)
2012
message = "deleted %s" % (f,)
2013
elif message is not None:
2014
# Only care if we haven't done anything yet.
2015
message = "%s does not exist." % (f,)
2017
# Print only one message (if any) per file.
2018
if message is not None:
2020
self.apply_inventory_delta(inv_delta)
2022
@needs_tree_write_lock
2023
def revert(self, filenames=None, old_tree=None, backups=True,
2024
pb=DummyProgress(), report_changes=False):
2025
from bzrlib.conflicts import resolve
2028
symbol_versioning.warn('Using [] to revert all files is deprecated'
2029
' as of bzr 0.91. Please use None (the default) instead.',
2030
DeprecationWarning, stacklevel=2)
2031
if old_tree is None:
2032
basis_tree = self.basis_tree()
2033
basis_tree.lock_read()
2034
old_tree = basis_tree
2038
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2040
if filenames is None and len(self.get_parent_ids()) > 1:
2042
last_revision = self.last_revision()
2043
if last_revision != NULL_REVISION:
2044
if basis_tree is None:
2045
basis_tree = self.basis_tree()
2046
basis_tree.lock_read()
2047
parent_trees.append((last_revision, basis_tree))
2048
self.set_parent_trees(parent_trees)
2051
resolve(self, filenames, ignore_misses=True, recursive=True)
2053
if basis_tree is not None:
2057
def revision_tree(self, revision_id):
2058
"""See Tree.revision_tree.
2060
WorkingTree can supply revision_trees for the basis revision only
2061
because there is only one cached inventory in the bzr directory.
2063
if revision_id == self.last_revision():
2065
xml = self.read_basis_inventory()
2066
except errors.NoSuchFile:
2070
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2071
# dont use the repository revision_tree api because we want
2072
# to supply the inventory.
2073
if inv.revision_id == revision_id:
2074
return revisiontree.RevisionTree(self.branch.repository,
2076
except errors.BadInventoryFormat:
2078
# raise if there was no inventory, or if we read the wrong inventory.
2079
raise errors.NoSuchRevisionInTree(self, revision_id)
2081
# XXX: This method should be deprecated in favour of taking in a proper
2082
# new Inventory object.
2083
@needs_tree_write_lock
2084
def set_inventory(self, new_inventory_list):
2085
from bzrlib.inventory import (Inventory,
2090
inv = Inventory(self.get_root_id())
2091
for path, file_id, parent, kind in new_inventory_list:
2092
name = os.path.basename(path)
2095
# fixme, there should be a factory function inv,add_??
2096
if kind == 'directory':
2097
inv.add(InventoryDirectory(file_id, name, parent))
2098
elif kind == 'file':
2099
inv.add(InventoryFile(file_id, name, parent))
2100
elif kind == 'symlink':
2101
inv.add(InventoryLink(file_id, name, parent))
2103
raise errors.BzrError("unknown kind %r" % kind)
2104
self._write_inventory(inv)
2106
@needs_tree_write_lock
2107
def set_root_id(self, file_id):
2108
"""Set the root id for this tree."""
2112
'WorkingTree.set_root_id with fileid=None')
2113
file_id = osutils.safe_file_id(file_id)
2114
self._set_root_id(file_id)
2116
def _set_root_id(self, file_id):
2117
"""Set the root id for this tree, in a format specific manner.
2119
:param file_id: The file id to assign to the root. It must not be
2120
present in the current inventory or an error will occur. It must
2121
not be None, but rather a valid file id.
2123
inv = self._inventory
2124
orig_root_id = inv.root.file_id
2125
# TODO: it might be nice to exit early if there was nothing
2126
# to do, saving us from trigger a sync on unlock.
2127
self._inventory_is_modified = True
2128
# we preserve the root inventory entry object, but
2129
# unlinkit from the byid index
2130
del inv._byid[inv.root.file_id]
2131
inv.root.file_id = file_id
2132
# and link it into the index with the new changed id.
2133
inv._byid[inv.root.file_id] = inv.root
2134
# and finally update all children to reference the new id.
2135
# XXX: this should be safe to just look at the root.children
2136
# list, not the WHOLE INVENTORY.
2139
if entry.parent_id == orig_root_id:
2140
entry.parent_id = inv.root.file_id
2143
"""See Branch.unlock.
2145
WorkingTree locking just uses the Branch locking facilities.
2146
This is current because all working trees have an embedded branch
2147
within them. IF in the future, we were to make branch data shareable
2148
between multiple working trees, i.e. via shared storage, then we
2149
would probably want to lock both the local tree, and the branch.
2151
raise NotImplementedError(self.unlock)
2153
def update(self, change_reporter=None, possible_transports=None):
2154
"""Update a working tree along its branch.
2156
This will update the branch if its bound too, which means we have
2157
multiple trees involved:
2159
- The new basis tree of the master.
2160
- The old basis tree of the branch.
2161
- The old basis tree of the working tree.
2162
- The current working tree state.
2164
Pathologically, all three may be different, and non-ancestors of each
2165
other. Conceptually we want to:
2167
- Preserve the wt.basis->wt.state changes
2168
- Transform the wt.basis to the new master basis.
2169
- Apply a merge of the old branch basis to get any 'local' changes from
2171
- Restore the wt.basis->wt.state changes.
2173
There isn't a single operation at the moment to do that, so we:
2174
- Merge current state -> basis tree of the master w.r.t. the old tree
2176
- Do a 'normal' merge of the old branch basis if it is relevant.
2178
if self.branch.get_bound_location() is not None:
2180
update_branch = True
2182
self.lock_tree_write()
2183
update_branch = False
2186
old_tip = self.branch.update(possible_transports)
2189
return self._update_tree(old_tip, change_reporter)
2193
@needs_tree_write_lock
2194
def _update_tree(self, old_tip=None, change_reporter=None):
2195
"""Update a tree to the master branch.
2197
:param old_tip: if supplied, the previous tip revision the branch,
2198
before it was changed to the master branch's tip.
2200
# here if old_tip is not None, it is the old tip of the branch before
2201
# it was updated from the master branch. This should become a pending
2202
# merge in the working tree to preserve the user existing work. we
2203
# cant set that until we update the working trees last revision to be
2204
# one from the new branch, because it will just get absorbed by the
2205
# parent de-duplication logic.
2207
# We MUST save it even if an error occurs, because otherwise the users
2208
# local work is unreferenced and will appear to have been lost.
2212
last_rev = self.get_parent_ids()[0]
2214
last_rev = _mod_revision.NULL_REVISION
2215
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2216
# merge tree state up to new branch tip.
2217
basis = self.basis_tree()
2220
to_tree = self.branch.basis_tree()
2221
if basis.inventory.root is None:
2222
self.set_root_id(to_tree.get_root_id())
2224
result += merge.merge_inner(
2229
change_reporter=change_reporter)
2232
# TODO - dedup parents list with things merged by pull ?
2233
# reuse the tree we've updated to to set the basis:
2234
parent_trees = [(self.branch.last_revision(), to_tree)]
2235
merges = self.get_parent_ids()[1:]
2236
# Ideally we ask the tree for the trees here, that way the working
2237
# tree can decide whether to give us the entire tree or give us a
2238
# lazy initialised tree. dirstate for instance will have the trees
2239
# in ram already, whereas a last-revision + basis-inventory tree
2240
# will not, but also does not need them when setting parents.
2241
for parent in merges:
2242
parent_trees.append(
2243
(parent, self.branch.repository.revision_tree(parent)))
2244
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2245
parent_trees.append(
2246
(old_tip, self.branch.repository.revision_tree(old_tip)))
2247
self.set_parent_trees(parent_trees)
2248
last_rev = parent_trees[0][0]
2250
# the working tree had the same last-revision as the master
2251
# branch did. We may still have pivot local work from the local
2252
# branch into old_tip:
2253
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2254
self.add_parent_tree_id(old_tip)
2255
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2256
and old_tip != last_rev):
2257
# our last revision was not the prior branch last revision
2258
# and we have converted that last revision to a pending merge.
2259
# base is somewhere between the branch tip now
2260
# and the now pending merge
2262
# Since we just modified the working tree and inventory, flush out
2263
# the current state, before we modify it again.
2264
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2265
# requires it only because TreeTransform directly munges the
2266
# inventory and calls tree._write_inventory(). Ultimately we
2267
# should be able to remove this extra flush.
2269
graph = self.branch.repository.get_graph()
2270
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2272
base_tree = self.branch.repository.revision_tree(base_rev_id)
2273
other_tree = self.branch.repository.revision_tree(old_tip)
2274
result += merge.merge_inner(
2279
change_reporter=change_reporter)
2282
def _write_hashcache_if_dirty(self):
2283
"""Write out the hashcache if it is dirty."""
2284
if self._hashcache.needs_write:
2286
self._hashcache.write()
2288
if e.errno not in (errno.EPERM, errno.EACCES):
2290
# TODO: jam 20061219 Should this be a warning? A single line
2291
# warning might be sufficient to let the user know what
2293
mutter('Could not write hashcache for %s\nError: %s',
2294
self._hashcache.cache_file_name(), e)
2296
@needs_tree_write_lock
2297
def _write_inventory(self, inv):
2298
"""Write inventory as the current inventory."""
2299
self._set_inventory(inv, dirty=True)
2302
def set_conflicts(self, arg):
2303
raise errors.UnsupportedOperation(self.set_conflicts, self)
2305
def add_conflicts(self, arg):
2306
raise errors.UnsupportedOperation(self.add_conflicts, self)
2309
def conflicts(self):
2310
conflicts = _mod_conflicts.ConflictList()
2311
for conflicted in self._iter_conflicts():
2314
if file_kind(self.abspath(conflicted)) != "file":
2316
except errors.NoSuchFile:
2319
for suffix in ('.THIS', '.OTHER'):
2321
kind = file_kind(self.abspath(conflicted+suffix))
2324
except errors.NoSuchFile:
2328
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2329
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2331
file_id=self.path2id(conflicted)))
2334
def walkdirs(self, prefix=""):
2335
"""Walk the directories of this tree.
2337
returns a generator which yields items in the form:
2338
((curren_directory_path, fileid),
2339
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2342
This API returns a generator, which is only valid during the current
2343
tree transaction - within a single lock_read or lock_write duration.
2345
If the tree is not locked, it may cause an error to be raised,
2346
depending on the tree implementation.
2348
disk_top = self.abspath(prefix)
2349
if disk_top.endswith('/'):
2350
disk_top = disk_top[:-1]
2351
top_strip_len = len(disk_top) + 1
2352
inventory_iterator = self._walkdirs(prefix)
2353
disk_iterator = osutils.walkdirs(disk_top, prefix)
2355
current_disk = disk_iterator.next()
2356
disk_finished = False
2358
if not (e.errno == errno.ENOENT or
2359
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2362
disk_finished = True
2364
current_inv = inventory_iterator.next()
2365
inv_finished = False
2366
except StopIteration:
2369
while not inv_finished or not disk_finished:
2371
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2372
cur_disk_dir_content) = current_disk
2374
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2375
cur_disk_dir_content) = ((None, None), None)
2376
if not disk_finished:
2377
# strip out .bzr dirs
2378
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2379
len(cur_disk_dir_content) > 0):
2380
# osutils.walkdirs can be made nicer -
2381
# yield the path-from-prefix rather than the pathjoined
2383
bzrdir_loc = bisect_left(cur_disk_dir_content,
2385
if (bzrdir_loc < len(cur_disk_dir_content)
2386
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2387
# we dont yield the contents of, or, .bzr itself.
2388
del cur_disk_dir_content[bzrdir_loc]
2390
# everything is unknown
2393
# everything is missing
2396
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2398
# disk is before inventory - unknown
2399
dirblock = [(relpath, basename, kind, stat, None, None) for
2400
relpath, basename, kind, stat, top_path in
2401
cur_disk_dir_content]
2402
yield (cur_disk_dir_relpath, None), dirblock
2404
current_disk = disk_iterator.next()
2405
except StopIteration:
2406
disk_finished = True
2408
# inventory is before disk - missing.
2409
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2410
for relpath, basename, dkind, stat, fileid, kind in
2412
yield (current_inv[0][0], current_inv[0][1]), dirblock
2414
current_inv = inventory_iterator.next()
2415
except StopIteration:
2418
# versioned present directory
2419
# merge the inventory and disk data together
2421
for relpath, subiterator in itertools.groupby(sorted(
2422
current_inv[1] + cur_disk_dir_content,
2423
key=operator.itemgetter(0)), operator.itemgetter(1)):
2424
path_elements = list(subiterator)
2425
if len(path_elements) == 2:
2426
inv_row, disk_row = path_elements
2427
# versioned, present file
2428
dirblock.append((inv_row[0],
2429
inv_row[1], disk_row[2],
2430
disk_row[3], inv_row[4],
2432
elif len(path_elements[0]) == 5:
2434
dirblock.append((path_elements[0][0],
2435
path_elements[0][1], path_elements[0][2],
2436
path_elements[0][3], None, None))
2437
elif len(path_elements[0]) == 6:
2438
# versioned, absent file.
2439
dirblock.append((path_elements[0][0],
2440
path_elements[0][1], 'unknown', None,
2441
path_elements[0][4], path_elements[0][5]))
2443
raise NotImplementedError('unreachable code')
2444
yield current_inv[0], dirblock
2446
current_inv = inventory_iterator.next()
2447
except StopIteration:
2450
current_disk = disk_iterator.next()
2451
except StopIteration:
2452
disk_finished = True
2454
def _walkdirs(self, prefix=""):
2455
"""Walk the directories of this tree.
2457
:prefix: is used as the directrory to start with.
2458
returns a generator which yields items in the form:
2459
((curren_directory_path, fileid),
2460
[(file1_path, file1_name, file1_kind, None, file1_id,
2463
_directory = 'directory'
2464
# get the root in the inventory
2465
inv = self.inventory
2466
top_id = inv.path2id(prefix)
2470
pending = [(prefix, '', _directory, None, top_id, None)]
2473
currentdir = pending.pop()
2474
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2475
top_id = currentdir[4]
2477
relroot = currentdir[0] + '/'
2480
# FIXME: stash the node in pending
2482
if entry.kind == 'directory':
2483
for name, child in entry.sorted_children():
2484
dirblock.append((relroot + name, name, child.kind, None,
2485
child.file_id, child.kind
2487
yield (currentdir[0], entry.file_id), dirblock
2488
# push the user specified dirs from dirblock
2489
for dir in reversed(dirblock):
2490
if dir[2] == _directory:
2493
@needs_tree_write_lock
2494
def auto_resolve(self):
2495
"""Automatically resolve text conflicts according to contents.
2497
Only text conflicts are auto_resolvable. Files with no conflict markers
2498
are considered 'resolved', because bzr always puts conflict markers
2499
into files that have text conflicts. The corresponding .THIS .BASE and
2500
.OTHER files are deleted, as per 'resolve'.
2501
:return: a tuple of ConflictLists: (un_resolved, resolved).
2503
un_resolved = _mod_conflicts.ConflictList()
2504
resolved = _mod_conflicts.ConflictList()
2505
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2506
for conflict in self.conflicts():
2507
if (conflict.typestring != 'text conflict' or
2508
self.kind(conflict.file_id) != 'file'):
2509
un_resolved.append(conflict)
2511
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2513
for line in my_file:
2514
if conflict_re.search(line):
2515
un_resolved.append(conflict)
2518
resolved.append(conflict)
2521
resolved.remove_files(self)
2522
self.set_conflicts(un_resolved)
2523
return un_resolved, resolved
2526
def _check(self, references):
2527
"""Check the tree for consistency.
2529
:param references: A dict with keys matching the items returned by
2530
self._get_check_refs(), and values from looking those keys up in
2533
tree_basis = self.basis_tree()
2534
tree_basis.lock_read()
2536
repo_basis = references[('trees', self.last_revision())]
2537
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2538
raise errors.BzrCheckError(
2539
"Mismatched basis inventory content.")
2544
def _validate(self):
2545
"""Validate internal structures.
2547
This is meant mostly for the test suite. To give it a chance to detect
2548
corruption after actions have occurred. The default implementation is a
2551
:return: None. An exception should be raised if there is an error.
2556
def _get_rules_searcher(self, default_searcher):
2557
"""See Tree._get_rules_searcher."""
2558
if self._rules_searcher is None:
2559
self._rules_searcher = super(WorkingTree,
2560
self)._get_rules_searcher(default_searcher)
2561
return self._rules_searcher
2563
def get_shelf_manager(self):
2564
"""Return the ShelfManager for this WorkingTree."""
2565
from bzrlib.shelf import ShelfManager
2566
return ShelfManager(self, self._transport)
2569
class WorkingTree2(WorkingTree):
2570
"""This is the Format 2 working tree.
2572
This was the first weave based working tree.
2573
- uses os locks for locking.
2574
- uses the branch last-revision.
2577
def __init__(self, *args, **kwargs):
2578
super(WorkingTree2, self).__init__(*args, **kwargs)
2579
# WorkingTree2 has more of a constraint that self._inventory must
2580
# exist. Because this is an older format, we don't mind the overhead
2581
# caused by the extra computation here.
2583
# Newer WorkingTree's should only have self._inventory set when they
2585
if self._inventory is None:
2586
self.read_working_inventory()
2588
def _get_check_refs(self):
2589
"""Return the references needed to perform a check of this tree."""
2590
return [('trees', self.last_revision())]
2592
def lock_tree_write(self):
2593
"""See WorkingTree.lock_tree_write().
2595
In Format2 WorkingTrees we have a single lock for the branch and tree
2596
so lock_tree_write() degrades to lock_write().
2598
self.branch.lock_write()
2600
return self._control_files.lock_write()
2602
self.branch.unlock()
2606
# do non-implementation specific cleanup
2609
# we share control files:
2610
if self._control_files._lock_count == 3:
2611
# _inventory_is_modified is always False during a read lock.
2612
if self._inventory_is_modified:
2614
self._write_hashcache_if_dirty()
2616
# reverse order of locking.
2618
return self._control_files.unlock()
2620
self.branch.unlock()
2623
class WorkingTree3(WorkingTree):
2624
"""This is the Format 3 working tree.
2626
This differs from the base WorkingTree by:
2627
- having its own file lock
2628
- having its own last-revision property.
2630
This is new in bzr 0.8
2634
def _last_revision(self):
2635
"""See Mutable.last_revision."""
2637
return self._transport.get_bytes('last-revision')
2638
except errors.NoSuchFile:
2639
return _mod_revision.NULL_REVISION
2641
def _change_last_revision(self, revision_id):
2642
"""See WorkingTree._change_last_revision."""
2643
if revision_id is None or revision_id == NULL_REVISION:
2645
self._transport.delete('last-revision')
2646
except errors.NoSuchFile:
2650
self._transport.put_bytes('last-revision', revision_id,
2651
mode=self.bzrdir._get_file_mode())
2654
def _get_check_refs(self):
2655
"""Return the references needed to perform a check of this tree."""
2656
return [('trees', self.last_revision())]
2658
@needs_tree_write_lock
2659
def set_conflicts(self, conflicts):
2660
self._put_rio('conflicts', conflicts.to_stanzas(),
2663
@needs_tree_write_lock
2664
def add_conflicts(self, new_conflicts):
2665
conflict_set = set(self.conflicts())
2666
conflict_set.update(set(list(new_conflicts)))
2667
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2668
key=_mod_conflicts.Conflict.sort_key)))
2671
def conflicts(self):
2673
confile = self._transport.get('conflicts')
2674
except errors.NoSuchFile:
2675
return _mod_conflicts.ConflictList()
2678
if confile.next() != CONFLICT_HEADER_1 + '\n':
2679
raise errors.ConflictFormatError()
2680
except StopIteration:
2681
raise errors.ConflictFormatError()
2682
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2687
# do non-implementation specific cleanup
2689
if self._control_files._lock_count == 1:
2690
# _inventory_is_modified is always False during a read lock.
2691
if self._inventory_is_modified:
2693
self._write_hashcache_if_dirty()
2694
# reverse order of locking.
2696
return self._control_files.unlock()
2698
self.branch.unlock()
2701
def get_conflicted_stem(path):
2702
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2703
if path.endswith(suffix):
2704
return path[:-len(suffix)]
2707
class WorkingTreeFormat(object):
2708
"""An encapsulation of the initialization and open routines for a format.
2710
Formats provide three things:
2711
* An initialization routine,
2715
Formats are placed in an dict by their format string for reference
2716
during workingtree opening. Its not required that these be instances, they
2717
can be classes themselves with class methods - it simply depends on
2718
whether state is needed for a given format or not.
2720
Once a format is deprecated, just deprecate the initialize and open
2721
methods on the format class. Do not deprecate the object, as the
2722
object will be created every time regardless.
2725
_default_format = None
2726
"""The default format used for new trees."""
2729
"""The known formats."""
2731
requires_rich_root = False
2733
upgrade_recommended = False
2736
def find_format(klass, a_bzrdir):
2737
"""Return the format for the working tree object in a_bzrdir."""
2739
transport = a_bzrdir.get_workingtree_transport(None)
2740
format_string = transport.get("format").read()
2741
return klass._formats[format_string]
2742
except errors.NoSuchFile:
2743
raise errors.NoWorkingTree(base=transport.base)
2745
raise errors.UnknownFormatError(format=format_string,
2746
kind="working tree")
2748
def __eq__(self, other):
2749
return self.__class__ is other.__class__
2751
def __ne__(self, other):
2752
return not (self == other)
2755
def get_default_format(klass):
2756
"""Return the current default format."""
2757
return klass._default_format
2759
def get_format_string(self):
2760
"""Return the ASCII format string that identifies this format."""
2761
raise NotImplementedError(self.get_format_string)
2763
def get_format_description(self):
2764
"""Return the short description for this format."""
2765
raise NotImplementedError(self.get_format_description)
2767
def is_supported(self):
2768
"""Is this format supported?
2770
Supported formats can be initialized and opened.
2771
Unsupported formats may not support initialization or committing or
2772
some other features depending on the reason for not being supported.
2776
def supports_content_filtering(self):
2777
"""True if this format supports content filtering."""
2780
def supports_views(self):
2781
"""True if this format supports stored views."""
2785
def register_format(klass, format):
2786
klass._formats[format.get_format_string()] = format
2789
def set_default_format(klass, format):
2790
klass._default_format = format
2793
def unregister_format(klass, format):
2794
del klass._formats[format.get_format_string()]
2797
class WorkingTreeFormat2(WorkingTreeFormat):
2798
"""The second working tree format.
2800
This format modified the hash cache from the format 1 hash cache.
2803
upgrade_recommended = True
2805
def get_format_description(self):
2806
"""See WorkingTreeFormat.get_format_description()."""
2807
return "Working tree format 2"
2809
def _stub_initialize_on_transport(self, transport, file_mode):
2810
"""Workaround: create control files for a remote working tree.
2812
This ensures that it can later be updated and dealt with locally,
2813
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2814
no working tree. (See bug #43064).
2818
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2820
transport.put_file('inventory', sio, file_mode)
2821
transport.put_bytes('pending-merges', '', file_mode)
2823
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2824
accelerator_tree=None, hardlink=False):
2825
"""See WorkingTreeFormat.initialize()."""
2826
if not isinstance(a_bzrdir.transport, LocalTransport):
2827
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2828
if from_branch is not None:
2829
branch = from_branch
2831
branch = a_bzrdir.open_branch()
2832
if revision_id is None:
2833
revision_id = _mod_revision.ensure_null(branch.last_revision())
2836
branch.generate_revision_history(revision_id)
2840
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2846
basis_tree = branch.repository.revision_tree(revision_id)
2847
if basis_tree.inventory.root is not None:
2848
wt.set_root_id(basis_tree.get_root_id())
2849
# set the parent list and cache the basis tree.
2850
if _mod_revision.is_null(revision_id):
2853
parent_trees = [(revision_id, basis_tree)]
2854
wt.set_parent_trees(parent_trees)
2855
transform.build_tree(basis_tree, wt)
2859
super(WorkingTreeFormat2, self).__init__()
2860
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2862
def open(self, a_bzrdir, _found=False):
2863
"""Return the WorkingTree object for a_bzrdir
2865
_found is a private parameter, do not use it. It is used to indicate
2866
if format probing has already been done.
2869
# we are being called directly and must probe.
2870
raise NotImplementedError
2871
if not isinstance(a_bzrdir.transport, LocalTransport):
2872
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2873
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2879
class WorkingTreeFormat3(WorkingTreeFormat):
2880
"""The second working tree format updated to record a format marker.
2883
- exists within a metadir controlling .bzr
2884
- includes an explicit version marker for the workingtree control
2885
files, separate from the BzrDir format
2886
- modifies the hash cache format
2888
- uses a LockDir to guard access for writes.
2891
upgrade_recommended = True
2893
def get_format_string(self):
2894
"""See WorkingTreeFormat.get_format_string()."""
2895
return "Bazaar-NG Working Tree format 3"
2897
def get_format_description(self):
2898
"""See WorkingTreeFormat.get_format_description()."""
2899
return "Working tree format 3"
2901
_lock_file_name = 'lock'
2902
_lock_class = LockDir
2904
_tree_class = WorkingTree3
2906
def __get_matchingbzrdir(self):
2907
return bzrdir.BzrDirMetaFormat1()
2909
_matchingbzrdir = property(__get_matchingbzrdir)
2911
def _open_control_files(self, a_bzrdir):
2912
transport = a_bzrdir.get_workingtree_transport(None)
2913
return LockableFiles(transport, self._lock_file_name,
2916
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2917
accelerator_tree=None, hardlink=False):
2918
"""See WorkingTreeFormat.initialize().
2920
:param revision_id: if supplied, create a working tree at a different
2921
revision than the branch is at.
2922
:param accelerator_tree: A tree which can be used for retrieving file
2923
contents more quickly than the revision tree, i.e. a workingtree.
2924
The revision tree will be used for cases where accelerator_tree's
2925
content is different.
2926
:param hardlink: If true, hard-link files from accelerator_tree,
2929
if not isinstance(a_bzrdir.transport, LocalTransport):
2930
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2931
transport = a_bzrdir.get_workingtree_transport(self)
2932
control_files = self._open_control_files(a_bzrdir)
2933
control_files.create_lock()
2934
control_files.lock_write()
2935
transport.put_bytes('format', self.get_format_string(),
2936
mode=a_bzrdir._get_file_mode())
2937
if from_branch is not None:
2938
branch = from_branch
2940
branch = a_bzrdir.open_branch()
2941
if revision_id is None:
2942
revision_id = _mod_revision.ensure_null(branch.last_revision())
2943
# WorkingTree3 can handle an inventory which has a unique root id.
2944
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2945
# those trees. And because there isn't a format bump inbetween, we
2946
# are maintaining compatibility with older clients.
2947
# inv = Inventory(root_id=gen_root_id())
2948
inv = self._initial_inventory()
2949
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2955
_control_files=control_files)
2956
wt.lock_tree_write()
2958
basis_tree = branch.repository.revision_tree(revision_id)
2959
# only set an explicit root id if there is one to set.
2960
if basis_tree.inventory.root is not None:
2961
wt.set_root_id(basis_tree.get_root_id())
2962
if revision_id == NULL_REVISION:
2963
wt.set_parent_trees([])
2965
wt.set_parent_trees([(revision_id, basis_tree)])
2966
transform.build_tree(basis_tree, wt)
2968
# Unlock in this order so that the unlock-triggers-flush in
2969
# WorkingTree is given a chance to fire.
2970
control_files.unlock()
2974
def _initial_inventory(self):
2978
super(WorkingTreeFormat3, self).__init__()
2980
def open(self, a_bzrdir, _found=False):
2981
"""Return the WorkingTree object for a_bzrdir
2983
_found is a private parameter, do not use it. It is used to indicate
2984
if format probing has already been done.
2987
# we are being called directly and must probe.
2988
raise NotImplementedError
2989
if not isinstance(a_bzrdir.transport, LocalTransport):
2990
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2991
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2994
def _open(self, a_bzrdir, control_files):
2995
"""Open the tree itself.
2997
:param a_bzrdir: the dir for the tree.
2998
:param control_files: the control files for the tree.
3000
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3004
_control_files=control_files)
3007
return self.get_format_string()
3010
__default_format = WorkingTreeFormat4()
3011
WorkingTreeFormat.register_format(__default_format)
3012
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3013
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3014
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3015
WorkingTreeFormat.set_default_format(__default_format)
3016
# formats which have no format string are not discoverable
3017
# and not independently creatable, so are not registered.
3018
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
