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 WorkingTreeFormat4, WorkingTreeFormat5
86
from bzrlib import symbol_versioning
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
93
from bzrlib import osutils
94
from bzrlib.osutils import (
106
from bzrlib.filters import filtered_input_file
107
from bzrlib.trace import mutter, note
108
from bzrlib.transport.local import LocalTransport
109
from bzrlib.progress import DummyProgress, ProgressPhase
110
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
111
from bzrlib.rio import RioReader, rio_file, Stanza
112
from bzrlib.symbol_versioning import (deprecated_passed,
115
DEPRECATED_PARAMETER,
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
122
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
125
class TreeEntry(object):
126
"""An entry that implements the minimum interface used by commands.
128
This needs further inspection, it may be better to have
129
InventoryEntries without ids - though that seems wrong. For now,
130
this is a parallel hierarchy to InventoryEntry, and needs to become
131
one of several things: decorates to that hierarchy, children of, or
133
Another note is that these objects are currently only used when there is
134
no InventoryEntry available - i.e. for unversioned objects.
135
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
138
def __eq__(self, other):
139
# yes, this us ugly, TODO: best practice __eq__ style.
140
return (isinstance(other, TreeEntry)
141
and other.__class__ == self.__class__)
143
def kind_character(self):
147
class TreeDirectory(TreeEntry):
148
"""See TreeEntry. This is a directory in a working tree."""
150
def __eq__(self, other):
151
return (isinstance(other, TreeDirectory)
152
and other.__class__ == self.__class__)
154
def kind_character(self):
158
class TreeFile(TreeEntry):
159
"""See TreeEntry. This is a regular file in a working tree."""
161
def __eq__(self, other):
162
return (isinstance(other, TreeFile)
163
and other.__class__ == self.__class__)
165
def kind_character(self):
169
class TreeLink(TreeEntry):
170
"""See TreeEntry. This is a symlink in a working tree."""
172
def __eq__(self, other):
173
return (isinstance(other, TreeLink)
174
and other.__class__ == self.__class__)
176
def kind_character(self):
180
class WorkingTree(bzrlib.mutabletree.MutableTree):
181
"""Working copy tree.
183
The inventory is held in the `Branch` working-inventory, and the
184
files are in a directory on disk.
186
It is possible for a `WorkingTree` to have a filename which is
187
not listed in the Inventory and vice versa.
190
# override this to set the strategy for storing views
191
def _make_views(self):
192
return views.DisabledViews(self)
194
def __init__(self, basedir='.',
195
branch=DEPRECATED_PARAMETER,
201
"""Construct a WorkingTree instance. This is not a public API.
203
:param branch: A branch to override probing for the branch.
205
self._format = _format
206
self.bzrdir = _bzrdir
208
raise errors.BzrError("Please use bzrdir.open_workingtree or "
209
"WorkingTree.open() to obtain a WorkingTree.")
210
basedir = safe_unicode(basedir)
211
mutter("opening working tree %r", basedir)
212
if deprecated_passed(branch):
213
self._branch = branch
215
self._branch = self.bzrdir.open_branch()
216
self.basedir = realpath(basedir)
217
# if branch is at our basedir and is a format 6 or less
218
if isinstance(self._format, WorkingTreeFormat2):
219
# share control object
220
self._control_files = self.branch.control_files
222
# assume all other formats have their own control files.
223
self._control_files = _control_files
224
self._transport = self._control_files._transport
225
# update the whole cache up front and write to disk if anything changed;
226
# in the future we might want to do this more selectively
227
# two possible ways offer themselves : in self._unlock, write the cache
228
# if needed, or, when the cache sees a change, append it to the hash
229
# cache file, and have the parser take the most recent entry for a
231
wt_trans = self.bzrdir.get_workingtree_transport(None)
232
cache_filename = wt_trans.local_abspath('stat-cache')
233
self._hashcache = hashcache.HashCache(basedir, cache_filename,
234
self.bzrdir._get_file_mode(),
235
self._content_filter_stack_provider())
238
# is this scan needed ? it makes things kinda slow.
245
if _inventory is None:
246
# This will be acquired on lock_read() or lock_write()
247
self._inventory_is_modified = False
248
self._inventory = None
250
# the caller of __init__ has provided an inventory,
251
# we assume they know what they are doing - as its only
252
# the Format factory and creation methods that are
253
# permitted to do this.
254
self._set_inventory(_inventory, dirty=False)
255
self._detect_case_handling()
256
self._rules_searcher = None
257
self.views = self._make_views()
259
def _detect_case_handling(self):
260
wt_trans = self.bzrdir.get_workingtree_transport(None)
262
wt_trans.stat("FoRMaT")
263
except errors.NoSuchFile:
264
self.case_sensitive = True
266
self.case_sensitive = False
268
self._setup_directory_is_tree_reference()
271
fget=lambda self: self._branch,
272
doc="""The branch this WorkingTree is connected to.
274
This cannot be set - it is reflective of the actual disk structure
275
the working tree has been constructed from.
278
def break_lock(self):
279
"""Break a lock if one is present from another instance.
281
Uses the ui factory to ask for confirmation if the lock may be from
284
This will probe the repository for its lock as well.
286
self._control_files.break_lock()
287
self.branch.break_lock()
289
def requires_rich_root(self):
290
return self._format.requires_rich_root
292
def supports_tree_reference(self):
295
def supports_content_filtering(self):
296
return self._format.supports_content_filtering()
298
def supports_views(self):
299
return self.views.supports_views()
301
def _set_inventory(self, inv, dirty):
302
"""Set the internal cached inventory.
304
:param inv: The inventory to set.
305
:param dirty: A boolean indicating whether the inventory is the same
306
logical inventory as whats on disk. If True the inventory is not
307
the same and should be written to disk or data will be lost, if
308
False then the inventory is the same as that on disk and any
309
serialisation would be unneeded overhead.
311
self._inventory = inv
312
self._inventory_is_modified = dirty
315
def open(path=None, _unsupported=False):
316
"""Open an existing working tree at path.
320
path = osutils.getcwd()
321
control = bzrdir.BzrDir.open(path, _unsupported)
322
return control.open_workingtree(_unsupported)
325
def open_containing(path=None):
326
"""Open an existing working tree which has its root about path.
328
This probes for a working tree at path and searches upwards from there.
330
Basically we keep looking up until we find the control directory or
331
run into /. If there isn't one, raises NotBranchError.
332
TODO: give this a new exception.
333
If there is one, it is returned, along with the unused portion of path.
335
:return: The WorkingTree that contains 'path', and the rest of path
338
path = osutils.getcwd()
339
control, relpath = bzrdir.BzrDir.open_containing(path)
341
return control.open_workingtree(), relpath
344
def open_downlevel(path=None):
345
"""Open an unsupported working tree.
347
Only intended for advanced situations like upgrading part of a bzrdir.
349
return WorkingTree.open(path, _unsupported=True)
352
def find_trees(location):
353
def list_current(transport):
354
return [d for d in transport.list_dir('') if d != '.bzr']
355
def evaluate(bzrdir):
357
tree = bzrdir.open_workingtree()
358
except errors.NoWorkingTree:
362
transport = get_transport(location)
363
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
364
list_current=list_current)
365
return [t for t in iterator if t is not None]
367
# should be deprecated - this is slow and in any case treating them as a
368
# container is (we now know) bad style -- mbp 20070302
369
## @deprecated_method(zero_fifteen)
371
"""Iterate through file_ids for this tree.
373
file_ids are in a WorkingTree if they are in the working inventory
374
and the working file exists.
376
inv = self._inventory
377
for path, ie in inv.iter_entries():
378
if osutils.lexists(self.abspath(path)):
381
def all_file_ids(self):
382
"""See Tree.iter_all_file_ids"""
383
return set(self.inventory)
386
return "<%s of %s>" % (self.__class__.__name__,
387
getattr(self, 'basedir', None))
389
def abspath(self, filename):
390
return pathjoin(self.basedir, filename)
392
def basis_tree(self):
393
"""Return RevisionTree for the current last revision.
395
If the left most parent is a ghost then the returned tree will be an
396
empty tree - one obtained by calling
397
repository.revision_tree(NULL_REVISION).
400
revision_id = self.get_parent_ids()[0]
402
# no parents, return an empty revision tree.
403
# in the future this should return the tree for
404
# 'empty:' - the implicit root empty tree.
405
return self.branch.repository.revision_tree(
406
_mod_revision.NULL_REVISION)
408
return self.revision_tree(revision_id)
409
except errors.NoSuchRevision:
411
# No cached copy available, retrieve from the repository.
412
# FIXME? RBC 20060403 should we cache the inventory locally
415
return self.branch.repository.revision_tree(revision_id)
416
except (errors.RevisionNotPresent, errors.NoSuchRevision):
417
# the basis tree *may* be a ghost or a low level error may have
418
# occured. If the revision is present, its a problem, if its not
420
if self.branch.repository.has_revision(revision_id):
422
# the basis tree is a ghost so return an empty tree.
423
return self.branch.repository.revision_tree(
424
_mod_revision.NULL_REVISION)
427
self._flush_ignore_list_cache()
429
def relpath(self, path):
430
"""Return the local path portion from a given path.
432
The path may be absolute or relative. If its a relative path it is
433
interpreted relative to the python current working directory.
435
return osutils.relpath(self.basedir, path)
437
def has_filename(self, filename):
438
return osutils.lexists(self.abspath(filename))
440
def get_file(self, file_id, path=None, filtered=True):
441
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
443
def get_file_with_stat(self, file_id, path=None, filtered=True,
445
"""See MutableTree.get_file_with_stat."""
447
path = self.id2path(file_id)
448
file_obj = self.get_file_byname(path, filtered=False)
449
stat_value = _fstat(file_obj.fileno())
450
if self.supports_content_filtering() and filtered:
451
filters = self._content_filter_stack(path)
452
file_obj = filtered_input_file(file_obj, filters)
453
return (file_obj, stat_value)
455
def get_file_text(self, file_id, path=None, filtered=True):
456
return self.get_file(file_id, path=path, filtered=filtered).read()
458
def get_file_byname(self, filename, filtered=True):
459
path = self.abspath(filename)
461
if self.supports_content_filtering() and filtered:
462
filters = self._content_filter_stack(filename)
463
return filtered_input_file(f, filters)
467
def get_file_lines(self, file_id, path=None, filtered=True):
468
"""See Tree.get_file_lines()"""
469
file = self.get_file(file_id, path, filtered=filtered)
471
return file.readlines()
476
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
477
"""See Tree.annotate_iter
479
This implementation will use the basis tree implementation if possible.
480
Lines not in the basis are attributed to CURRENT_REVISION
482
If there are pending merges, lines added by those merges will be
483
incorrectly attributed to CURRENT_REVISION (but after committing, the
484
attribution will be correct).
486
basis = self.basis_tree()
489
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
490
require_versioned=True).next()
491
changed_content, kind = changes[2], changes[6]
492
if not changed_content:
493
return basis.annotate_iter(file_id)
497
if kind[0] != 'file':
500
old_lines = list(basis.annotate_iter(file_id))
502
for tree in self.branch.repository.revision_trees(
503
self.get_parent_ids()[1:]):
504
if file_id not in tree:
506
old.append(list(tree.annotate_iter(file_id)))
507
return annotate.reannotate(old, self.get_file(file_id).readlines(),
512
def _get_ancestors(self, default_revision):
513
ancestors = set([default_revision])
514
for parent_id in self.get_parent_ids():
515
ancestors.update(self.branch.repository.get_ancestry(
516
parent_id, topo_sorted=False))
519
def get_parent_ids(self):
520
"""See Tree.get_parent_ids.
522
This implementation reads the pending merges list and last_revision
523
value and uses that to decide what the parents list should be.
525
last_rev = _mod_revision.ensure_null(self._last_revision())
526
if _mod_revision.NULL_REVISION == last_rev:
531
merges_file = self._transport.get('pending-merges')
532
except errors.NoSuchFile:
535
for l in merges_file.readlines():
536
revision_id = l.rstrip('\n')
537
parents.append(revision_id)
541
def get_root_id(self):
542
"""Return the id of this trees root"""
543
return self._inventory.root.file_id
545
def _get_store_filename(self, file_id):
546
## XXX: badly named; this is not in the store at all
547
return self.abspath(self.id2path(file_id))
550
def clone(self, to_bzrdir, revision_id=None):
551
"""Duplicate this working tree into to_bzr, including all state.
553
Specifically modified files are kept as modified, but
554
ignored and unknown files are discarded.
556
If you want to make a new line of development, see bzrdir.sprout()
559
If not None, the cloned tree will have its last revision set to
560
revision, and and difference between the source trees last revision
561
and this one merged in.
563
# assumes the target bzr dir format is compatible.
564
result = to_bzrdir.create_workingtree()
565
self.copy_content_into(result, revision_id)
569
def copy_content_into(self, tree, revision_id=None):
570
"""Copy the current content and user files of this tree into tree."""
571
tree.set_root_id(self.get_root_id())
572
if revision_id is None:
573
merge.transform_tree(tree, self)
575
# TODO now merge from tree.last_revision to revision (to preserve
576
# user local changes)
577
merge.transform_tree(tree, self)
578
tree.set_parent_ids([revision_id])
580
def id2abspath(self, file_id):
581
return self.abspath(self.id2path(file_id))
583
def has_id(self, file_id):
584
# files that have been deleted are excluded
586
if not inv.has_id(file_id):
588
path = inv.id2path(file_id)
589
return osutils.lexists(self.abspath(path))
591
def has_or_had_id(self, file_id):
592
if file_id == self.inventory.root.file_id:
594
return self.inventory.has_id(file_id)
596
__contains__ = has_id
598
def get_file_size(self, file_id):
599
"""See Tree.get_file_size"""
601
return os.path.getsize(self.id2abspath(file_id))
603
if e.errno != errno.ENOENT:
609
def get_file_sha1(self, file_id, path=None, stat_value=None):
611
path = self._inventory.id2path(file_id)
612
return self._hashcache.get_sha1(path, stat_value)
614
def get_file_mtime(self, file_id, path=None):
616
path = self.inventory.id2path(file_id)
617
return os.lstat(self.abspath(path)).st_mtime
619
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
620
file_id = self.path2id(path)
621
return self._inventory[file_id].executable
623
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
624
mode = stat_result.st_mode
625
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
627
if not supports_executable():
628
def is_executable(self, file_id, path=None):
629
return self._inventory[file_id].executable
631
_is_executable_from_path_and_stat = \
632
_is_executable_from_path_and_stat_from_basis
634
def is_executable(self, file_id, path=None):
636
path = self.id2path(file_id)
637
mode = os.lstat(self.abspath(path)).st_mode
638
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
640
_is_executable_from_path_and_stat = \
641
_is_executable_from_path_and_stat_from_stat
643
@needs_tree_write_lock
644
def _add(self, files, ids, kinds):
645
"""See MutableTree._add."""
646
# TODO: Re-adding a file that is removed in the working copy
647
# should probably put it back with the previous ID.
648
# the read and write working inventory should not occur in this
649
# function - they should be part of lock_write and unlock.
651
for f, file_id, kind in zip(files, ids, kinds):
653
inv.add_path(f, kind=kind)
655
inv.add_path(f, kind=kind, file_id=file_id)
656
self._inventory_is_modified = True
658
@needs_tree_write_lock
659
def _gather_kinds(self, files, kinds):
660
"""See MutableTree._gather_kinds."""
661
for pos, f in enumerate(files):
662
if kinds[pos] is None:
663
fullpath = normpath(self.abspath(f))
665
kinds[pos] = file_kind(fullpath)
667
if e.errno == errno.ENOENT:
668
raise errors.NoSuchFile(fullpath)
671
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
672
"""Add revision_id as a parent.
674
This is equivalent to retrieving the current list of parent ids
675
and setting the list to its value plus revision_id.
677
:param revision_id: The revision id to add to the parent list. It may
678
be a ghost revision as long as its not the first parent to be added,
679
or the allow_leftmost_as_ghost parameter is set True.
680
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
682
parents = self.get_parent_ids() + [revision_id]
683
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
684
or allow_leftmost_as_ghost)
686
@needs_tree_write_lock
687
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
688
"""Add revision_id, tree tuple as a parent.
690
This is equivalent to retrieving the current list of parent trees
691
and setting the list to its value plus parent_tuple. See also
692
add_parent_tree_id - if you only have a parent id available it will be
693
simpler to use that api. If you have the parent already available, using
694
this api is preferred.
696
:param parent_tuple: The (revision id, tree) to add to the parent list.
697
If the revision_id is a ghost, pass None for the tree.
698
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
700
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
701
if len(parent_ids) > 1:
702
# the leftmost may have already been a ghost, preserve that if it
704
allow_leftmost_as_ghost = True
705
self.set_parent_ids(parent_ids,
706
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
708
@needs_tree_write_lock
709
def add_pending_merge(self, *revision_ids):
710
# TODO: Perhaps should check at this point that the
711
# history of the revision is actually present?
712
parents = self.get_parent_ids()
714
for rev_id in revision_ids:
715
if rev_id in parents:
717
parents.append(rev_id)
720
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
722
def path_content_summary(self, path, _lstat=os.lstat,
723
_mapper=osutils.file_kind_from_stat_mode):
724
"""See Tree.path_content_summary."""
725
abspath = self.abspath(path)
727
stat_result = _lstat(abspath)
729
if getattr(e, 'errno', None) == errno.ENOENT:
731
return ('missing', None, None, None)
732
# propagate other errors
734
kind = _mapper(stat_result.st_mode)
736
size = stat_result.st_size
737
# try for a stat cache lookup
738
executable = self._is_executable_from_path_and_stat(path, stat_result)
739
return (kind, size, executable, self._sha_from_stat(
741
elif kind == 'directory':
742
# perhaps it looks like a plain directory, but it's really a
744
if self._directory_is_tree_reference(path):
745
kind = 'tree-reference'
746
return kind, None, None, None
747
elif kind == 'symlink':
748
return ('symlink', None, None,
749
os.readlink(abspath.encode(osutils._fs_enc)
750
).decode(osutils._fs_enc))
752
return (kind, None, None, None)
754
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
755
"""Common ghost checking functionality from set_parent_*.
757
This checks that the left hand-parent exists if there are any
760
if len(revision_ids) > 0:
761
leftmost_id = revision_ids[0]
762
if (not allow_leftmost_as_ghost and not
763
self.branch.repository.has_revision(leftmost_id)):
764
raise errors.GhostRevisionUnusableHere(leftmost_id)
766
def _set_merges_from_parent_ids(self, parent_ids):
767
merges = parent_ids[1:]
768
self._transport.put_bytes('pending-merges', '\n'.join(merges),
769
mode=self.bzrdir._get_file_mode())
771
def _filter_parent_ids_by_ancestry(self, revision_ids):
772
"""Check that all merged revisions are proper 'heads'.
774
This will always return the first revision_id, and any merged revisions
777
if len(revision_ids) == 0:
779
graph = self.branch.repository.get_graph()
780
heads = graph.heads(revision_ids)
781
new_revision_ids = revision_ids[:1]
782
for revision_id in revision_ids[1:]:
783
if revision_id in heads and revision_id not in new_revision_ids:
784
new_revision_ids.append(revision_id)
785
if new_revision_ids != revision_ids:
786
trace.mutter('requested to set revision_ids = %s,'
787
' but filtered to %s', revision_ids, new_revision_ids)
788
return new_revision_ids
790
@needs_tree_write_lock
791
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
792
"""Set the parent ids to revision_ids.
794
See also set_parent_trees. This api will try to retrieve the tree data
795
for each element of revision_ids from the trees repository. If you have
796
tree data already available, it is more efficient to use
797
set_parent_trees rather than set_parent_ids. set_parent_ids is however
798
an easier API to use.
800
:param revision_ids: The revision_ids to set as the parent ids of this
801
working tree. Any of these may be ghosts.
803
self._check_parents_for_ghosts(revision_ids,
804
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
805
for revision_id in revision_ids:
806
_mod_revision.check_not_reserved_id(revision_id)
808
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
810
if len(revision_ids) > 0:
811
self.set_last_revision(revision_ids[0])
813
self.set_last_revision(_mod_revision.NULL_REVISION)
815
self._set_merges_from_parent_ids(revision_ids)
817
@needs_tree_write_lock
818
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
819
"""See MutableTree.set_parent_trees."""
820
parent_ids = [rev for (rev, tree) in parents_list]
821
for revision_id in parent_ids:
822
_mod_revision.check_not_reserved_id(revision_id)
824
self._check_parents_for_ghosts(parent_ids,
825
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
827
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
829
if len(parent_ids) == 0:
830
leftmost_parent_id = _mod_revision.NULL_REVISION
831
leftmost_parent_tree = None
833
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
835
if self._change_last_revision(leftmost_parent_id):
836
if leftmost_parent_tree is None:
837
# If we don't have a tree, fall back to reading the
838
# parent tree from the repository.
839
self._cache_basis_inventory(leftmost_parent_id)
841
inv = leftmost_parent_tree.inventory
842
xml = self._create_basis_xml_from_inventory(
843
leftmost_parent_id, inv)
844
self._write_basis_inventory(xml)
845
self._set_merges_from_parent_ids(parent_ids)
847
@needs_tree_write_lock
848
def set_pending_merges(self, rev_list):
849
parents = self.get_parent_ids()
850
leftmost = parents[:1]
851
new_parents = leftmost + rev_list
852
self.set_parent_ids(new_parents)
854
@needs_tree_write_lock
855
def set_merge_modified(self, modified_hashes):
857
for file_id, hash in modified_hashes.iteritems():
858
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
859
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
861
def _sha_from_stat(self, path, stat_result):
862
"""Get a sha digest from the tree's stat cache.
864
The default implementation assumes no stat cache is present.
866
:param path: The path.
867
:param stat_result: The stat result being looked up.
871
def _put_rio(self, filename, stanzas, header):
872
self._must_be_locked()
873
my_file = rio_file(stanzas, header)
874
self._transport.put_file(filename, my_file,
875
mode=self.bzrdir._get_file_mode())
877
@needs_write_lock # because merge pulls data into the branch.
878
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
880
"""Merge from a branch into this working tree.
882
:param branch: The branch to merge from.
883
:param to_revision: If non-None, the merge will merge to to_revision,
884
but not beyond it. to_revision does not need to be in the history
885
of the branch when it is supplied. If None, to_revision defaults to
886
branch.last_revision().
888
from bzrlib.merge import Merger, Merge3Merger
889
pb = bzrlib.ui.ui_factory.nested_progress_bar()
891
merger = Merger(self.branch, this_tree=self, pb=pb)
892
merger.pp = ProgressPhase("Merge phase", 5, pb)
893
merger.pp.next_phase()
894
# check that there are no
896
merger.check_basis(check_clean=True, require_commits=False)
897
if to_revision is None:
898
to_revision = _mod_revision.ensure_null(branch.last_revision())
899
merger.other_rev_id = to_revision
900
if _mod_revision.is_null(merger.other_rev_id):
901
raise errors.NoCommits(branch)
902
self.branch.fetch(branch, last_revision=merger.other_rev_id)
903
merger.other_basis = merger.other_rev_id
904
merger.other_tree = self.branch.repository.revision_tree(
906
merger.other_branch = branch
907
merger.pp.next_phase()
908
if from_revision is None:
911
merger.set_base_revision(from_revision, branch)
912
if merger.base_rev_id == merger.other_rev_id:
913
raise errors.PointlessMerge
914
merger.backup_files = False
915
if merge_type is None:
916
merger.merge_type = Merge3Merger
918
merger.merge_type = merge_type
919
merger.set_interesting_files(None)
920
merger.show_base = False
921
merger.reprocess = False
922
conflicts = merger.do_merge()
929
def merge_modified(self):
930
"""Return a dictionary of files modified by a merge.
932
The list is initialized by WorkingTree.set_merge_modified, which is
933
typically called after we make some automatic updates to the tree
936
This returns a map of file_id->sha1, containing only files which are
937
still in the working inventory and have that text hash.
940
hashfile = self._transport.get('merge-hashes')
941
except errors.NoSuchFile:
946
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
947
raise errors.MergeModifiedFormatError()
948
except StopIteration:
949
raise errors.MergeModifiedFormatError()
950
for s in RioReader(hashfile):
951
# RioReader reads in Unicode, so convert file_ids back to utf8
952
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
953
if file_id not in self.inventory:
955
text_hash = s.get("hash")
956
if text_hash == self.get_file_sha1(file_id):
957
merge_hashes[file_id] = text_hash
963
def mkdir(self, path, file_id=None):
964
"""See MutableTree.mkdir()."""
966
file_id = generate_ids.gen_file_id(os.path.basename(path))
967
os.mkdir(self.abspath(path))
968
self.add(path, file_id, 'directory')
971
def get_symlink_target(self, file_id):
972
return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc)
973
).decode(osutils._fs_enc)
976
def subsume(self, other_tree):
977
def add_children(inventory, entry):
978
for child_entry in entry.children.values():
979
inventory._byid[child_entry.file_id] = child_entry
980
if child_entry.kind == 'directory':
981
add_children(inventory, child_entry)
982
if other_tree.get_root_id() == self.get_root_id():
983
raise errors.BadSubsumeSource(self, other_tree,
984
'Trees have the same root')
986
other_tree_path = self.relpath(other_tree.basedir)
987
except errors.PathNotChild:
988
raise errors.BadSubsumeSource(self, other_tree,
989
'Tree is not contained by the other')
990
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
991
if new_root_parent is None:
992
raise errors.BadSubsumeSource(self, other_tree,
993
'Parent directory is not versioned.')
994
# We need to ensure that the result of a fetch will have a
995
# versionedfile for the other_tree root, and only fetching into
996
# RepositoryKnit2 guarantees that.
997
if not self.branch.repository.supports_rich_root():
998
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
999
other_tree.lock_tree_write()
1001
new_parents = other_tree.get_parent_ids()
1002
other_root = other_tree.inventory.root
1003
other_root.parent_id = new_root_parent
1004
other_root.name = osutils.basename(other_tree_path)
1005
self.inventory.add(other_root)
1006
add_children(self.inventory, other_root)
1007
self._write_inventory(self.inventory)
1008
# normally we don't want to fetch whole repositories, but i think
1009
# here we really do want to consolidate the whole thing.
1010
for parent_id in other_tree.get_parent_ids():
1011
self.branch.fetch(other_tree.branch, parent_id)
1012
self.add_parent_tree_id(parent_id)
1015
other_tree.bzrdir.retire_bzrdir()
1017
def _setup_directory_is_tree_reference(self):
1018
if self._branch.repository._format.supports_tree_reference:
1019
self._directory_is_tree_reference = \
1020
self._directory_may_be_tree_reference
1022
self._directory_is_tree_reference = \
1023
self._directory_is_never_tree_reference
1025
def _directory_is_never_tree_reference(self, relpath):
1028
def _directory_may_be_tree_reference(self, relpath):
1029
# as a special case, if a directory contains control files then
1030
# it's a tree reference, except that the root of the tree is not
1031
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1032
# TODO: We could ask all the control formats whether they
1033
# recognize this directory, but at the moment there's no cheap api
1034
# to do that. Since we probably can only nest bzr checkouts and
1035
# they always use this name it's ok for now. -- mbp 20060306
1037
# FIXME: There is an unhandled case here of a subdirectory
1038
# containing .bzr but not a branch; that will probably blow up
1039
# when you try to commit it. It might happen if there is a
1040
# checkout in a subdirectory. This can be avoided by not adding
1043
@needs_tree_write_lock
1044
def extract(self, file_id, format=None):
1045
"""Extract a subtree from this tree.
1047
A new branch will be created, relative to the path for this tree.
1051
segments = osutils.splitpath(path)
1052
transport = self.branch.bzrdir.root_transport
1053
for name in segments:
1054
transport = transport.clone(name)
1055
transport.ensure_base()
1058
sub_path = self.id2path(file_id)
1059
branch_transport = mkdirs(sub_path)
1061
format = self.bzrdir.cloning_metadir()
1062
branch_transport.ensure_base()
1063
branch_bzrdir = format.initialize_on_transport(branch_transport)
1065
repo = branch_bzrdir.find_repository()
1066
except errors.NoRepositoryPresent:
1067
repo = branch_bzrdir.create_repository()
1068
if not repo.supports_rich_root():
1069
raise errors.RootNotRich()
1070
new_branch = branch_bzrdir.create_branch()
1071
new_branch.pull(self.branch)
1072
for parent_id in self.get_parent_ids():
1073
new_branch.fetch(self.branch, parent_id)
1074
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1075
if tree_transport.base != branch_transport.base:
1076
tree_bzrdir = format.initialize_on_transport(tree_transport)
1077
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1079
tree_bzrdir = branch_bzrdir
1080
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1081
wt.set_parent_ids(self.get_parent_ids())
1082
my_inv = self.inventory
1083
child_inv = Inventory(root_id=None)
1084
new_root = my_inv[file_id]
1085
my_inv.remove_recursive_id(file_id)
1086
new_root.parent_id = None
1087
child_inv.add(new_root)
1088
self._write_inventory(my_inv)
1089
wt._write_inventory(child_inv)
1092
def _serialize(self, inventory, out_file):
1093
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1096
def _deserialize(selt, in_file):
1097
return xml5.serializer_v5.read_inventory(in_file)
1100
"""Write the in memory inventory to disk."""
1101
# TODO: Maybe this should only write on dirty ?
1102
if self._control_files._lock_mode != 'w':
1103
raise errors.NotWriteLocked(self)
1105
self._serialize(self._inventory, sio)
1107
self._transport.put_file('inventory', sio,
1108
mode=self.bzrdir._get_file_mode())
1109
self._inventory_is_modified = False
1111
def _kind(self, relpath):
1112
return osutils.file_kind(self.abspath(relpath))
1114
def list_files(self, include_root=False):
1115
"""Recursively list all files as (path, class, kind, id, entry).
1117
Lists, but does not descend into unversioned directories.
1119
This does not include files that have been deleted in this
1122
Skips the control directory.
1124
# list_files is an iterator, so @needs_read_lock doesn't work properly
1125
# with it. So callers should be careful to always read_lock the tree.
1126
if not self.is_locked():
1127
raise errors.ObjectNotLocked(self)
1129
inv = self.inventory
1130
if include_root is True:
1131
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1132
# Convert these into local objects to save lookup times
1133
pathjoin = osutils.pathjoin
1134
file_kind = self._kind
1136
# transport.base ends in a slash, we want the piece
1137
# between the last two slashes
1138
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1140
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1142
# directory file_id, relative path, absolute path, reverse sorted children
1143
children = os.listdir(self.basedir)
1145
# jam 20060527 The kernel sized tree seems equivalent whether we
1146
# use a deque and popleft to keep them sorted, or if we use a plain
1147
# list and just reverse() them.
1148
children = collections.deque(children)
1149
stack = [(inv.root.file_id, u'', self.basedir, children)]
1151
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1154
f = children.popleft()
1155
## TODO: If we find a subdirectory with its own .bzr
1156
## directory, then that is a separate tree and we
1157
## should exclude it.
1159
# the bzrdir for this tree
1160
if transport_base_dir == f:
1163
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1164
# and 'f' doesn't begin with one, we can do a string op, rather
1165
# than the checks of pathjoin(), all relative paths will have an extra slash
1167
fp = from_dir_relpath + '/' + f
1170
fap = from_dir_abspath + '/' + f
1172
f_ie = inv.get_child(from_dir_id, f)
1175
elif self.is_ignored(fp[1:]):
1178
# we may not have found this file, because of a unicode issue
1179
f_norm, can_access = osutils.normalized_filename(f)
1180
if f == f_norm or not can_access:
1181
# No change, so treat this file normally
1184
# this file can be accessed by a normalized path
1185
# check again if it is versioned
1186
# these lines are repeated here for performance
1188
fp = from_dir_relpath + '/' + f
1189
fap = from_dir_abspath + '/' + f
1190
f_ie = inv.get_child(from_dir_id, f)
1193
elif self.is_ignored(fp[1:]):
1200
# make a last minute entry
1202
yield fp[1:], c, fk, f_ie.file_id, f_ie
1205
yield fp[1:], c, fk, None, fk_entries[fk]()
1207
yield fp[1:], c, fk, None, TreeEntry()
1210
if fk != 'directory':
1213
# But do this child first
1214
new_children = os.listdir(fap)
1216
new_children = collections.deque(new_children)
1217
stack.append((f_ie.file_id, fp, fap, new_children))
1218
# Break out of inner loop,
1219
# so that we start outer loop with child
1222
# if we finished all children, pop it off the stack
1225
@needs_tree_write_lock
1226
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1229
to_dir must exist in the inventory.
1231
If to_dir exists and is a directory, the files are moved into
1232
it, keeping their old names.
1234
Note that to_dir is only the last component of the new name;
1235
this doesn't change the directory.
1237
For each entry in from_paths the move mode will be determined
1240
The first mode moves the file in the filesystem and updates the
1241
inventory. The second mode only updates the inventory without
1242
touching the file on the filesystem. This is the new mode introduced
1245
move uses the second mode if 'after == True' and the target is not
1246
versioned but present in the working tree.
1248
move uses the second mode if 'after == False' and the source is
1249
versioned but no longer in the working tree, and the target is not
1250
versioned but present in the working tree.
1252
move uses the first mode if 'after == False' and the source is
1253
versioned and present in the working tree, and the target is not
1254
versioned and not present in the working tree.
1256
Everything else results in an error.
1258
This returns a list of (from_path, to_path) pairs for each
1259
entry that is moved.
1264
# check for deprecated use of signature
1266
to_dir = kwargs.get('to_name', None)
1268
raise TypeError('You must supply a target directory')
1270
symbol_versioning.warn('The parameter to_name was deprecated'
1271
' in version 0.13. Use to_dir instead',
1274
# check destination directory
1275
if isinstance(from_paths, basestring):
1277
inv = self.inventory
1278
to_abs = self.abspath(to_dir)
1279
if not isdir(to_abs):
1280
raise errors.BzrMoveFailedError('',to_dir,
1281
errors.NotADirectory(to_abs))
1282
if not self.has_filename(to_dir):
1283
raise errors.BzrMoveFailedError('',to_dir,
1284
errors.NotInWorkingDirectory(to_dir))
1285
to_dir_id = inv.path2id(to_dir)
1286
if to_dir_id is None:
1287
raise errors.BzrMoveFailedError('',to_dir,
1288
errors.NotVersionedError(path=str(to_dir)))
1290
to_dir_ie = inv[to_dir_id]
1291
if to_dir_ie.kind != 'directory':
1292
raise errors.BzrMoveFailedError('',to_dir,
1293
errors.NotADirectory(to_abs))
1295
# create rename entries and tuples
1296
for from_rel in from_paths:
1297
from_tail = splitpath(from_rel)[-1]
1298
from_id = inv.path2id(from_rel)
1300
raise errors.BzrMoveFailedError(from_rel,to_dir,
1301
errors.NotVersionedError(path=str(from_rel)))
1303
from_entry = inv[from_id]
1304
from_parent_id = from_entry.parent_id
1305
to_rel = pathjoin(to_dir, from_tail)
1306
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1308
from_tail=from_tail,
1309
from_parent_id=from_parent_id,
1310
to_rel=to_rel, to_tail=from_tail,
1311
to_parent_id=to_dir_id)
1312
rename_entries.append(rename_entry)
1313
rename_tuples.append((from_rel, to_rel))
1315
# determine which move mode to use. checks also for movability
1316
rename_entries = self._determine_mv_mode(rename_entries, after)
1318
original_modified = self._inventory_is_modified
1321
self._inventory_is_modified = True
1322
self._move(rename_entries)
1324
# restore the inventory on error
1325
self._inventory_is_modified = original_modified
1327
self._write_inventory(inv)
1328
return rename_tuples
1330
def _determine_mv_mode(self, rename_entries, after=False):
1331
"""Determines for each from-to pair if both inventory and working tree
1332
or only the inventory has to be changed.
1334
Also does basic plausability tests.
1336
inv = self.inventory
1338
for rename_entry in rename_entries:
1339
# store to local variables for easier reference
1340
from_rel = rename_entry.from_rel
1341
from_id = rename_entry.from_id
1342
to_rel = rename_entry.to_rel
1343
to_id = inv.path2id(to_rel)
1344
only_change_inv = False
1346
# check the inventory for source and destination
1348
raise errors.BzrMoveFailedError(from_rel,to_rel,
1349
errors.NotVersionedError(path=str(from_rel)))
1350
if to_id is not None:
1351
raise errors.BzrMoveFailedError(from_rel,to_rel,
1352
errors.AlreadyVersionedError(path=str(to_rel)))
1354
# try to determine the mode for rename (only change inv or change
1355
# inv and file system)
1357
if not self.has_filename(to_rel):
1358
raise errors.BzrMoveFailedError(from_id,to_rel,
1359
errors.NoSuchFile(path=str(to_rel),
1360
extra="New file has not been created yet"))
1361
only_change_inv = True
1362
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1363
only_change_inv = True
1364
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1365
only_change_inv = False
1366
elif (not self.case_sensitive
1367
and from_rel.lower() == to_rel.lower()
1368
and self.has_filename(from_rel)):
1369
only_change_inv = False
1371
# something is wrong, so lets determine what exactly
1372
if not self.has_filename(from_rel) and \
1373
not self.has_filename(to_rel):
1374
raise errors.BzrRenameFailedError(from_rel,to_rel,
1375
errors.PathsDoNotExist(paths=(str(from_rel),
1378
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1379
rename_entry.only_change_inv = only_change_inv
1380
return rename_entries
1382
def _move(self, rename_entries):
1383
"""Moves a list of files.
1385
Depending on the value of the flag 'only_change_inv', the
1386
file will be moved on the file system or not.
1388
inv = self.inventory
1391
for entry in rename_entries:
1393
self._move_entry(entry)
1395
self._rollback_move(moved)
1399
def _rollback_move(self, moved):
1400
"""Try to rollback a previous move in case of an filesystem error."""
1401
inv = self.inventory
1404
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1405
entry.to_tail, entry.to_parent_id, entry.from_rel,
1406
entry.from_tail, entry.from_parent_id,
1407
entry.only_change_inv))
1408
except errors.BzrMoveFailedError, e:
1409
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1410
" The working tree is in an inconsistent state."
1411
" Please consider doing a 'bzr revert'."
1412
" Error message is: %s" % e)
1414
def _move_entry(self, entry):
1415
inv = self.inventory
1416
from_rel_abs = self.abspath(entry.from_rel)
1417
to_rel_abs = self.abspath(entry.to_rel)
1418
if from_rel_abs == to_rel_abs:
1419
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1420
"Source and target are identical.")
1422
if not entry.only_change_inv:
1424
osutils.rename(from_rel_abs, to_rel_abs)
1426
raise errors.BzrMoveFailedError(entry.from_rel,
1428
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1430
@needs_tree_write_lock
1431
def rename_one(self, from_rel, to_rel, after=False):
1434
This can change the directory or the filename or both.
1436
rename_one has several 'modes' to work. First, it can rename a physical
1437
file and change the file_id. That is the normal mode. Second, it can
1438
only change the file_id without touching any physical file. This is
1439
the new mode introduced in version 0.15.
1441
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1442
versioned but present in the working tree.
1444
rename_one uses the second mode if 'after == False' and 'from_rel' is
1445
versioned but no longer in the working tree, and 'to_rel' is not
1446
versioned but present in the working tree.
1448
rename_one uses the first mode if 'after == False' and 'from_rel' is
1449
versioned and present in the working tree, and 'to_rel' is not
1450
versioned and not present in the working tree.
1452
Everything else results in an error.
1454
inv = self.inventory
1457
# create rename entries and tuples
1458
from_tail = splitpath(from_rel)[-1]
1459
from_id = inv.path2id(from_rel)
1461
raise errors.BzrRenameFailedError(from_rel,to_rel,
1462
errors.NotVersionedError(path=str(from_rel)))
1463
from_entry = inv[from_id]
1464
from_parent_id = from_entry.parent_id
1465
to_dir, to_tail = os.path.split(to_rel)
1466
to_dir_id = inv.path2id(to_dir)
1467
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1469
from_tail=from_tail,
1470
from_parent_id=from_parent_id,
1471
to_rel=to_rel, to_tail=to_tail,
1472
to_parent_id=to_dir_id)
1473
rename_entries.append(rename_entry)
1475
# determine which move mode to use. checks also for movability
1476
rename_entries = self._determine_mv_mode(rename_entries, after)
1478
# check if the target changed directory and if the target directory is
1480
if to_dir_id is None:
1481
raise errors.BzrMoveFailedError(from_rel,to_rel,
1482
errors.NotVersionedError(path=str(to_dir)))
1484
# all checks done. now we can continue with our actual work
1485
mutter('rename_one:\n'
1490
' to_dir_id {%s}\n',
1491
from_id, from_rel, to_rel, to_dir, to_dir_id)
1493
self._move(rename_entries)
1494
self._write_inventory(inv)
1496
class _RenameEntry(object):
1497
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1498
to_rel, to_tail, to_parent_id, only_change_inv=False):
1499
self.from_rel = from_rel
1500
self.from_id = from_id
1501
self.from_tail = from_tail
1502
self.from_parent_id = from_parent_id
1503
self.to_rel = to_rel
1504
self.to_tail = to_tail
1505
self.to_parent_id = to_parent_id
1506
self.only_change_inv = only_change_inv
1510
"""Return all unknown files.
1512
These are files in the working directory that are not versioned or
1513
control files or ignored.
1515
# force the extras method to be fully executed before returning, to
1516
# prevent race conditions with the lock
1518
[subp for subp in self.extras() if not self.is_ignored(subp)])
1520
@needs_tree_write_lock
1521
def unversion(self, file_ids):
1522
"""Remove the file ids in file_ids from the current versioned set.
1524
When a file_id is unversioned, all of its children are automatically
1527
:param file_ids: The file ids to stop versioning.
1528
:raises: NoSuchId if any fileid is not currently versioned.
1530
for file_id in file_ids:
1531
if file_id not in self._inventory:
1532
raise errors.NoSuchId(self, file_id)
1533
for file_id in file_ids:
1534
if self._inventory.has_id(file_id):
1535
self._inventory.remove_recursive_id(file_id)
1537
# in the future this should just set a dirty bit to wait for the
1538
# final unlock. However, until all methods of workingtree start
1539
# with the current in -memory inventory rather than triggering
1540
# a read, it is more complex - we need to teach read_inventory
1541
# to know when to read, and when to not read first... and possibly
1542
# to save first when the in memory one may be corrupted.
1543
# so for now, we just only write it if it is indeed dirty.
1545
self._write_inventory(self._inventory)
1547
def _iter_conflicts(self):
1549
for info in self.list_files():
1551
stem = get_conflicted_stem(path)
1554
if stem not in conflicted:
1555
conflicted.add(stem)
1559
def pull(self, source, overwrite=False, stop_revision=None,
1560
change_reporter=None, possible_transports=None):
1561
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1564
pp = ProgressPhase("Pull phase", 2, top_pb)
1566
old_revision_info = self.branch.last_revision_info()
1567
basis_tree = self.basis_tree()
1568
count = self.branch.pull(source, overwrite, stop_revision,
1569
possible_transports=possible_transports)
1570
new_revision_info = self.branch.last_revision_info()
1571
if new_revision_info != old_revision_info:
1573
repository = self.branch.repository
1574
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1575
basis_tree.lock_read()
1577
new_basis_tree = self.branch.basis_tree()
1584
change_reporter=change_reporter)
1585
if (basis_tree.inventory.root is None and
1586
new_basis_tree.inventory.root is not None):
1587
self.set_root_id(new_basis_tree.get_root_id())
1591
# TODO - dedup parents list with things merged by pull ?
1592
# reuse the revisiontree we merged against to set the new
1594
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1595
# we have to pull the merge trees out again, because
1596
# merge_inner has set the ids. - this corner is not yet
1597
# layered well enough to prevent double handling.
1598
# XXX TODO: Fix the double handling: telling the tree about
1599
# the already known parent data is wasteful.
1600
merges = self.get_parent_ids()[1:]
1601
parent_trees.extend([
1602
(parent, repository.revision_tree(parent)) for
1604
self.set_parent_trees(parent_trees)
1611
def put_file_bytes_non_atomic(self, file_id, bytes):
1612
"""See MutableTree.put_file_bytes_non_atomic."""
1613
stream = file(self.id2abspath(file_id), 'wb')
1618
# TODO: update the hashcache here ?
1621
"""Yield all unversioned files in this WorkingTree.
1623
If there are any unversioned directories then only the directory is
1624
returned, not all its children. But if there are unversioned files
1625
under a versioned subdirectory, they are returned.
1627
Currently returned depth-first, sorted by name within directories.
1628
This is the same order used by 'osutils.walkdirs'.
1630
## TODO: Work from given directory downwards
1631
for path, dir_entry in self.inventory.directories():
1632
# mutter("search for unknowns in %r", path)
1633
dirabs = self.abspath(path)
1634
if not isdir(dirabs):
1635
# e.g. directory deleted
1639
for subf in os.listdir(dirabs):
1642
if subf not in dir_entry.children:
1645
can_access) = osutils.normalized_filename(subf)
1646
except UnicodeDecodeError:
1647
path_os_enc = path.encode(osutils._fs_enc)
1648
relpath = path_os_enc + '/' + subf
1649
raise errors.BadFilenameEncoding(relpath,
1651
if subf_norm != subf and can_access:
1652
if subf_norm not in dir_entry.children:
1653
fl.append(subf_norm)
1659
subp = pathjoin(path, subf)
1662
def ignored_files(self):
1663
"""Yield list of PATH, IGNORE_PATTERN"""
1664
for subp in self.extras():
1665
pat = self.is_ignored(subp)
1669
def get_ignore_list(self):
1670
"""Return list of ignore patterns.
1672
Cached in the Tree object after the first call.
1674
ignoreset = getattr(self, '_ignoreset', None)
1675
if ignoreset is not None:
1678
ignore_globs = set()
1679
ignore_globs.update(ignores.get_runtime_ignores())
1680
ignore_globs.update(ignores.get_user_ignores())
1681
if self.has_filename(bzrlib.IGNORE_FILENAME):
1682
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1684
ignore_globs.update(ignores.parse_ignore_file(f))
1687
self._ignoreset = ignore_globs
1690
def _flush_ignore_list_cache(self):
1691
"""Resets the cached ignore list to force a cache rebuild."""
1692
self._ignoreset = None
1693
self._ignoreglobster = None
1695
def is_ignored(self, filename):
1696
r"""Check whether the filename matches an ignore pattern.
1698
Patterns containing '/' or '\' need to match the whole path;
1699
others match against only the last component.
1701
If the file is ignored, returns the pattern which caused it to
1702
be ignored, otherwise None. So this can simply be used as a
1703
boolean if desired."""
1704
if getattr(self, '_ignoreglobster', None) is None:
1705
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1706
return self._ignoreglobster.match(filename)
1708
def kind(self, file_id):
1709
return file_kind(self.id2abspath(file_id))
1711
def stored_kind(self, file_id):
1712
"""See Tree.stored_kind"""
1713
return self.inventory[file_id].kind
1715
def _comparison_data(self, entry, path):
1716
abspath = self.abspath(path)
1718
stat_value = os.lstat(abspath)
1720
if getattr(e, 'errno', None) == errno.ENOENT:
1727
mode = stat_value.st_mode
1728
kind = osutils.file_kind_from_stat_mode(mode)
1729
if not supports_executable():
1730
executable = entry is not None and entry.executable
1732
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1733
return kind, executable, stat_value
1735
def _file_size(self, entry, stat_value):
1736
return stat_value.st_size
1738
def last_revision(self):
1739
"""Return the last revision of the branch for this tree.
1741
This format tree does not support a separate marker for last-revision
1742
compared to the branch.
1744
See MutableTree.last_revision
1746
return self._last_revision()
1749
def _last_revision(self):
1750
"""helper for get_parent_ids."""
1751
return _mod_revision.ensure_null(self.branch.last_revision())
1753
def is_locked(self):
1754
return self._control_files.is_locked()
1756
def _must_be_locked(self):
1757
if not self.is_locked():
1758
raise errors.ObjectNotLocked(self)
1760
def lock_read(self):
1761
"""See Branch.lock_read, and WorkingTree.unlock."""
1762
if not self.is_locked():
1764
self.branch.lock_read()
1766
return self._control_files.lock_read()
1768
self.branch.unlock()
1771
def lock_tree_write(self):
1772
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1773
if not self.is_locked():
1775
self.branch.lock_read()
1777
return self._control_files.lock_write()
1779
self.branch.unlock()
1782
def lock_write(self):
1783
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1784
if not self.is_locked():
1786
self.branch.lock_write()
1788
return self._control_files.lock_write()
1790
self.branch.unlock()
1793
def get_physical_lock_status(self):
1794
return self._control_files.get_physical_lock_status()
1796
def _basis_inventory_name(self):
1797
return 'basis-inventory-cache'
1799
def _reset_data(self):
1800
"""Reset transient data that cannot be revalidated."""
1801
self._inventory_is_modified = False
1802
result = self._deserialize(self._transport.get('inventory'))
1803
self._set_inventory(result, dirty=False)
1805
@needs_tree_write_lock
1806
def set_last_revision(self, new_revision):
1807
"""Change the last revision in the working tree."""
1808
if self._change_last_revision(new_revision):
1809
self._cache_basis_inventory(new_revision)
1811
def _change_last_revision(self, new_revision):
1812
"""Template method part of set_last_revision to perform the change.
1814
This is used to allow WorkingTree3 instances to not affect branch
1815
when their last revision is set.
1817
if _mod_revision.is_null(new_revision):
1818
self.branch.set_revision_history([])
1821
self.branch.generate_revision_history(new_revision)
1822
except errors.NoSuchRevision:
1823
# not present in the repo - dont try to set it deeper than the tip
1824
self.branch.set_revision_history([new_revision])
1827
def _write_basis_inventory(self, xml):
1828
"""Write the basis inventory XML to the basis-inventory file"""
1829
path = self._basis_inventory_name()
1831
self._transport.put_file(path, sio,
1832
mode=self.bzrdir._get_file_mode())
1834
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1835
"""Create the text that will be saved in basis-inventory"""
1836
inventory.revision_id = revision_id
1837
return xml7.serializer_v7.write_inventory_to_string(inventory)
1839
def _cache_basis_inventory(self, new_revision):
1840
"""Cache new_revision as the basis inventory."""
1841
# TODO: this should allow the ready-to-use inventory to be passed in,
1842
# as commit already has that ready-to-use [while the format is the
1845
# this double handles the inventory - unpack and repack -
1846
# but is easier to understand. We can/should put a conditional
1847
# in here based on whether the inventory is in the latest format
1848
# - perhaps we should repack all inventories on a repository
1850
# the fast path is to copy the raw xml from the repository. If the
1851
# xml contains 'revision_id="', then we assume the right
1852
# revision_id is set. We must check for this full string, because a
1853
# root node id can legitimately look like 'revision_id' but cannot
1855
xml = self.branch.repository.get_inventory_xml(new_revision)
1856
firstline = xml.split('\n', 1)[0]
1857
if (not 'revision_id="' in firstline or
1858
'format="7"' not in firstline):
1859
inv = self.branch.repository.deserialise_inventory(
1861
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1862
self._write_basis_inventory(xml)
1863
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1866
def read_basis_inventory(self):
1867
"""Read the cached basis inventory."""
1868
path = self._basis_inventory_name()
1869
return self._transport.get_bytes(path)
1872
def read_working_inventory(self):
1873
"""Read the working inventory.
1875
:raises errors.InventoryModified: read_working_inventory will fail
1876
when the current in memory inventory has been modified.
1878
# conceptually this should be an implementation detail of the tree.
1879
# XXX: Deprecate this.
1880
# ElementTree does its own conversion from UTF-8, so open in
1882
if self._inventory_is_modified:
1883
raise errors.InventoryModified(self)
1884
result = self._deserialize(self._transport.get('inventory'))
1885
self._set_inventory(result, dirty=False)
1888
@needs_tree_write_lock
1889
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1891
"""Remove nominated files from the working inventory.
1893
:files: File paths relative to the basedir.
1894
:keep_files: If true, the files will also be kept.
1895
:force: Delete files and directories, even if they are changed and
1896
even if the directories are not empty.
1898
if isinstance(files, basestring):
1904
unknown_nested_files=set()
1906
def recurse_directory_to_add_files(directory):
1907
# Recurse directory and add all files
1908
# so we can check if they have changed.
1909
for parent_info, file_infos in\
1910
self.walkdirs(directory):
1911
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1912
# Is it versioned or ignored?
1913
if self.path2id(relpath) or self.is_ignored(relpath):
1914
# Add nested content for deletion.
1915
new_files.add(relpath)
1917
# Files which are not versioned and not ignored
1918
# should be treated as unknown.
1919
unknown_nested_files.add((relpath, None, kind))
1921
for filename in files:
1922
# Get file name into canonical form.
1923
abspath = self.abspath(filename)
1924
filename = self.relpath(abspath)
1925
if len(filename) > 0:
1926
new_files.add(filename)
1927
recurse_directory_to_add_files(filename)
1929
files = list(new_files)
1932
return # nothing to do
1934
# Sort needed to first handle directory content before the directory
1935
files.sort(reverse=True)
1937
# Bail out if we are going to delete files we shouldn't
1938
if not keep_files and not force:
1939
has_changed_files = len(unknown_nested_files) > 0
1940
if not has_changed_files:
1941
for (file_id, path, content_change, versioned, parent_id, name,
1942
kind, executable) in self.iter_changes(self.basis_tree(),
1943
include_unchanged=True, require_versioned=False,
1944
want_unversioned=True, specific_files=files):
1945
if versioned == (False, False):
1946
# The record is unknown ...
1947
if not self.is_ignored(path[1]):
1948
# ... but not ignored
1949
has_changed_files = True
1951
elif content_change and (kind[1] is not None):
1952
# Versioned and changed, but not deleted
1953
has_changed_files = True
1956
if has_changed_files:
1957
# Make delta show ALL applicable changes in error message.
1958
tree_delta = self.changes_from(self.basis_tree(),
1959
require_versioned=False, want_unversioned=True,
1960
specific_files=files)
1961
for unknown_file in unknown_nested_files:
1962
if unknown_file not in tree_delta.unversioned:
1963
tree_delta.unversioned.extend((unknown_file,))
1964
raise errors.BzrRemoveChangedFilesError(tree_delta)
1966
# Build inv_delta and delete files where applicaple,
1967
# do this before any modifications to inventory.
1969
fid = self.path2id(f)
1972
message = "%s is not versioned." % (f,)
1975
# having removed it, it must be either ignored or unknown
1976
if self.is_ignored(f):
1980
textui.show_status(new_status, self.kind(fid), f,
1983
inv_delta.append((f, None, fid, None))
1984
message = "removed %s" % (f,)
1987
abs_path = self.abspath(f)
1988
if osutils.lexists(abs_path):
1989
if (osutils.isdir(abs_path) and
1990
len(os.listdir(abs_path)) > 0):
1992
osutils.rmtree(abs_path)
1994
message = "%s is not an empty directory "\
1995
"and won't be deleted." % (f,)
1997
osutils.delete_any(abs_path)
1998
message = "deleted %s" % (f,)
1999
elif message is not None:
2000
# Only care if we haven't done anything yet.
2001
message = "%s does not exist." % (f,)
2003
# Print only one message (if any) per file.
2004
if message is not None:
2006
self.apply_inventory_delta(inv_delta)
2008
@needs_tree_write_lock
2009
def revert(self, filenames=None, old_tree=None, backups=True,
2010
pb=DummyProgress(), report_changes=False):
2011
from bzrlib.conflicts import resolve
2014
symbol_versioning.warn('Using [] to revert all files is deprecated'
2015
' as of bzr 0.91. Please use None (the default) instead.',
2016
DeprecationWarning, stacklevel=2)
2017
if old_tree is None:
2018
basis_tree = self.basis_tree()
2019
basis_tree.lock_read()
2020
old_tree = basis_tree
2024
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2026
if filenames is None and len(self.get_parent_ids()) > 1:
2028
last_revision = self.last_revision()
2029
if last_revision != NULL_REVISION:
2030
if basis_tree is None:
2031
basis_tree = self.basis_tree()
2032
basis_tree.lock_read()
2033
parent_trees.append((last_revision, basis_tree))
2034
self.set_parent_trees(parent_trees)
2037
resolve(self, filenames, ignore_misses=True, recursive=True)
2039
if basis_tree is not None:
2043
def revision_tree(self, revision_id):
2044
"""See Tree.revision_tree.
2046
WorkingTree can supply revision_trees for the basis revision only
2047
because there is only one cached inventory in the bzr directory.
2049
if revision_id == self.last_revision():
2051
xml = self.read_basis_inventory()
2052
except errors.NoSuchFile:
2056
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2057
# dont use the repository revision_tree api because we want
2058
# to supply the inventory.
2059
if inv.revision_id == revision_id:
2060
return revisiontree.RevisionTree(self.branch.repository,
2062
except errors.BadInventoryFormat:
2064
# raise if there was no inventory, or if we read the wrong inventory.
2065
raise errors.NoSuchRevisionInTree(self, revision_id)
2067
# XXX: This method should be deprecated in favour of taking in a proper
2068
# new Inventory object.
2069
@needs_tree_write_lock
2070
def set_inventory(self, new_inventory_list):
2071
from bzrlib.inventory import (Inventory,
2076
inv = Inventory(self.get_root_id())
2077
for path, file_id, parent, kind in new_inventory_list:
2078
name = os.path.basename(path)
2081
# fixme, there should be a factory function inv,add_??
2082
if kind == 'directory':
2083
inv.add(InventoryDirectory(file_id, name, parent))
2084
elif kind == 'file':
2085
inv.add(InventoryFile(file_id, name, parent))
2086
elif kind == 'symlink':
2087
inv.add(InventoryLink(file_id, name, parent))
2089
raise errors.BzrError("unknown kind %r" % kind)
2090
self._write_inventory(inv)
2092
@needs_tree_write_lock
2093
def set_root_id(self, file_id):
2094
"""Set the root id for this tree."""
2098
'WorkingTree.set_root_id with fileid=None')
2099
file_id = osutils.safe_file_id(file_id)
2100
self._set_root_id(file_id)
2102
def _set_root_id(self, file_id):
2103
"""Set the root id for this tree, in a format specific manner.
2105
:param file_id: The file id to assign to the root. It must not be
2106
present in the current inventory or an error will occur. It must
2107
not be None, but rather a valid file id.
2109
inv = self._inventory
2110
orig_root_id = inv.root.file_id
2111
# TODO: it might be nice to exit early if there was nothing
2112
# to do, saving us from trigger a sync on unlock.
2113
self._inventory_is_modified = True
2114
# we preserve the root inventory entry object, but
2115
# unlinkit from the byid index
2116
del inv._byid[inv.root.file_id]
2117
inv.root.file_id = file_id
2118
# and link it into the index with the new changed id.
2119
inv._byid[inv.root.file_id] = inv.root
2120
# and finally update all children to reference the new id.
2121
# XXX: this should be safe to just look at the root.children
2122
# list, not the WHOLE INVENTORY.
2125
if entry.parent_id == orig_root_id:
2126
entry.parent_id = inv.root.file_id
2129
"""See Branch.unlock.
2131
WorkingTree locking just uses the Branch locking facilities.
2132
This is current because all working trees have an embedded branch
2133
within them. IF in the future, we were to make branch data shareable
2134
between multiple working trees, i.e. via shared storage, then we
2135
would probably want to lock both the local tree, and the branch.
2137
raise NotImplementedError(self.unlock)
2139
def update(self, change_reporter=None, possible_transports=None):
2140
"""Update a working tree along its branch.
2142
This will update the branch if its bound too, which means we have
2143
multiple trees involved:
2145
- The new basis tree of the master.
2146
- The old basis tree of the branch.
2147
- The old basis tree of the working tree.
2148
- The current working tree state.
2150
Pathologically, all three may be different, and non-ancestors of each
2151
other. Conceptually we want to:
2153
- Preserve the wt.basis->wt.state changes
2154
- Transform the wt.basis to the new master basis.
2155
- Apply a merge of the old branch basis to get any 'local' changes from
2157
- Restore the wt.basis->wt.state changes.
2159
There isn't a single operation at the moment to do that, so we:
2160
- Merge current state -> basis tree of the master w.r.t. the old tree
2162
- Do a 'normal' merge of the old branch basis if it is relevant.
2164
if self.branch.get_bound_location() is not None:
2166
update_branch = True
2168
self.lock_tree_write()
2169
update_branch = False
2172
old_tip = self.branch.update(possible_transports)
2175
return self._update_tree(old_tip, change_reporter)
2179
@needs_tree_write_lock
2180
def _update_tree(self, old_tip=None, change_reporter=None):
2181
"""Update a tree to the master branch.
2183
:param old_tip: if supplied, the previous tip revision the branch,
2184
before it was changed to the master branch's tip.
2186
# here if old_tip is not None, it is the old tip of the branch before
2187
# it was updated from the master branch. This should become a pending
2188
# merge in the working tree to preserve the user existing work. we
2189
# cant set that until we update the working trees last revision to be
2190
# one from the new branch, because it will just get absorbed by the
2191
# parent de-duplication logic.
2193
# We MUST save it even if an error occurs, because otherwise the users
2194
# local work is unreferenced and will appear to have been lost.
2198
last_rev = self.get_parent_ids()[0]
2200
last_rev = _mod_revision.NULL_REVISION
2201
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2202
# merge tree state up to new branch tip.
2203
basis = self.basis_tree()
2206
to_tree = self.branch.basis_tree()
2207
if basis.inventory.root is None:
2208
self.set_root_id(to_tree.get_root_id())
2210
result += merge.merge_inner(
2215
change_reporter=change_reporter)
2218
# TODO - dedup parents list with things merged by pull ?
2219
# reuse the tree we've updated to to set the basis:
2220
parent_trees = [(self.branch.last_revision(), to_tree)]
2221
merges = self.get_parent_ids()[1:]
2222
# Ideally we ask the tree for the trees here, that way the working
2223
# tree can decide whether to give us teh entire tree or give us a
2224
# lazy initialised tree. dirstate for instance will have the trees
2225
# in ram already, whereas a last-revision + basis-inventory tree
2226
# will not, but also does not need them when setting parents.
2227
for parent in merges:
2228
parent_trees.append(
2229
(parent, self.branch.repository.revision_tree(parent)))
2230
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2231
parent_trees.append(
2232
(old_tip, self.branch.repository.revision_tree(old_tip)))
2233
self.set_parent_trees(parent_trees)
2234
last_rev = parent_trees[0][0]
2236
# the working tree had the same last-revision as the master
2237
# branch did. We may still have pivot local work from the local
2238
# branch into old_tip:
2239
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2240
self.add_parent_tree_id(old_tip)
2241
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2242
and old_tip != last_rev):
2243
# our last revision was not the prior branch last revision
2244
# and we have converted that last revision to a pending merge.
2245
# base is somewhere between the branch tip now
2246
# and the now pending merge
2248
# Since we just modified the working tree and inventory, flush out
2249
# the current state, before we modify it again.
2250
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2251
# requires it only because TreeTransform directly munges the
2252
# inventory and calls tree._write_inventory(). Ultimately we
2253
# should be able to remove this extra flush.
2255
graph = self.branch.repository.get_graph()
2256
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2258
base_tree = self.branch.repository.revision_tree(base_rev_id)
2259
other_tree = self.branch.repository.revision_tree(old_tip)
2260
result += merge.merge_inner(
2265
change_reporter=change_reporter)
2268
def _write_hashcache_if_dirty(self):
2269
"""Write out the hashcache if it is dirty."""
2270
if self._hashcache.needs_write:
2272
self._hashcache.write()
2274
if e.errno not in (errno.EPERM, errno.EACCES):
2276
# TODO: jam 20061219 Should this be a warning? A single line
2277
# warning might be sufficient to let the user know what
2279
mutter('Could not write hashcache for %s\nError: %s',
2280
self._hashcache.cache_file_name(), e)
2282
@needs_tree_write_lock
2283
def _write_inventory(self, inv):
2284
"""Write inventory as the current inventory."""
2285
self._set_inventory(inv, dirty=True)
2288
def set_conflicts(self, arg):
2289
raise errors.UnsupportedOperation(self.set_conflicts, self)
2291
def add_conflicts(self, arg):
2292
raise errors.UnsupportedOperation(self.add_conflicts, self)
2295
def conflicts(self):
2296
conflicts = _mod_conflicts.ConflictList()
2297
for conflicted in self._iter_conflicts():
2300
if file_kind(self.abspath(conflicted)) != "file":
2302
except errors.NoSuchFile:
2305
for suffix in ('.THIS', '.OTHER'):
2307
kind = file_kind(self.abspath(conflicted+suffix))
2310
except errors.NoSuchFile:
2314
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2315
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2317
file_id=self.path2id(conflicted)))
2320
def walkdirs(self, prefix=""):
2321
"""Walk the directories of this tree.
2323
returns a generator which yields items in the form:
2324
((curren_directory_path, fileid),
2325
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2328
This API returns a generator, which is only valid during the current
2329
tree transaction - within a single lock_read or lock_write duration.
2331
If the tree is not locked, it may cause an error to be raised,
2332
depending on the tree implementation.
2334
disk_top = self.abspath(prefix)
2335
if disk_top.endswith('/'):
2336
disk_top = disk_top[:-1]
2337
top_strip_len = len(disk_top) + 1
2338
inventory_iterator = self._walkdirs(prefix)
2339
disk_iterator = osutils.walkdirs(disk_top, prefix)
2341
current_disk = disk_iterator.next()
2342
disk_finished = False
2344
if not (e.errno == errno.ENOENT or
2345
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2348
disk_finished = True
2350
current_inv = inventory_iterator.next()
2351
inv_finished = False
2352
except StopIteration:
2355
while not inv_finished or not disk_finished:
2357
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2358
cur_disk_dir_content) = current_disk
2360
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2361
cur_disk_dir_content) = ((None, None), None)
2362
if not disk_finished:
2363
# strip out .bzr dirs
2364
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2365
len(cur_disk_dir_content) > 0):
2366
# osutils.walkdirs can be made nicer -
2367
# yield the path-from-prefix rather than the pathjoined
2369
bzrdir_loc = bisect_left(cur_disk_dir_content,
2371
if (bzrdir_loc < len(cur_disk_dir_content)
2372
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2373
# we dont yield the contents of, or, .bzr itself.
2374
del cur_disk_dir_content[bzrdir_loc]
2376
# everything is unknown
2379
# everything is missing
2382
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2384
# disk is before inventory - unknown
2385
dirblock = [(relpath, basename, kind, stat, None, None) for
2386
relpath, basename, kind, stat, top_path in
2387
cur_disk_dir_content]
2388
yield (cur_disk_dir_relpath, None), dirblock
2390
current_disk = disk_iterator.next()
2391
except StopIteration:
2392
disk_finished = True
2394
# inventory is before disk - missing.
2395
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2396
for relpath, basename, dkind, stat, fileid, kind in
2398
yield (current_inv[0][0], current_inv[0][1]), dirblock
2400
current_inv = inventory_iterator.next()
2401
except StopIteration:
2404
# versioned present directory
2405
# merge the inventory and disk data together
2407
for relpath, subiterator in itertools.groupby(sorted(
2408
current_inv[1] + cur_disk_dir_content,
2409
key=operator.itemgetter(0)), operator.itemgetter(1)):
2410
path_elements = list(subiterator)
2411
if len(path_elements) == 2:
2412
inv_row, disk_row = path_elements
2413
# versioned, present file
2414
dirblock.append((inv_row[0],
2415
inv_row[1], disk_row[2],
2416
disk_row[3], inv_row[4],
2418
elif len(path_elements[0]) == 5:
2420
dirblock.append((path_elements[0][0],
2421
path_elements[0][1], path_elements[0][2],
2422
path_elements[0][3], None, None))
2423
elif len(path_elements[0]) == 6:
2424
# versioned, absent file.
2425
dirblock.append((path_elements[0][0],
2426
path_elements[0][1], 'unknown', None,
2427
path_elements[0][4], path_elements[0][5]))
2429
raise NotImplementedError('unreachable code')
2430
yield current_inv[0], dirblock
2432
current_inv = inventory_iterator.next()
2433
except StopIteration:
2436
current_disk = disk_iterator.next()
2437
except StopIteration:
2438
disk_finished = True
2440
def _walkdirs(self, prefix=""):
2441
"""Walk the directories of this tree.
2443
:prefix: is used as the directrory to start with.
2444
returns a generator which yields items in the form:
2445
((curren_directory_path, fileid),
2446
[(file1_path, file1_name, file1_kind, None, file1_id,
2449
_directory = 'directory'
2450
# get the root in the inventory
2451
inv = self.inventory
2452
top_id = inv.path2id(prefix)
2456
pending = [(prefix, '', _directory, None, top_id, None)]
2459
currentdir = pending.pop()
2460
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2461
top_id = currentdir[4]
2463
relroot = currentdir[0] + '/'
2466
# FIXME: stash the node in pending
2468
if entry.kind == 'directory':
2469
for name, child in entry.sorted_children():
2470
dirblock.append((relroot + name, name, child.kind, None,
2471
child.file_id, child.kind
2473
yield (currentdir[0], entry.file_id), dirblock
2474
# push the user specified dirs from dirblock
2475
for dir in reversed(dirblock):
2476
if dir[2] == _directory:
2479
@needs_tree_write_lock
2480
def auto_resolve(self):
2481
"""Automatically resolve text conflicts according to contents.
2483
Only text conflicts are auto_resolvable. Files with no conflict markers
2484
are considered 'resolved', because bzr always puts conflict markers
2485
into files that have text conflicts. The corresponding .THIS .BASE and
2486
.OTHER files are deleted, as per 'resolve'.
2487
:return: a tuple of ConflictLists: (un_resolved, resolved).
2489
un_resolved = _mod_conflicts.ConflictList()
2490
resolved = _mod_conflicts.ConflictList()
2491
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2492
for conflict in self.conflicts():
2493
if (conflict.typestring != 'text conflict' or
2494
self.kind(conflict.file_id) != 'file'):
2495
un_resolved.append(conflict)
2497
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2499
for line in my_file:
2500
if conflict_re.search(line):
2501
un_resolved.append(conflict)
2504
resolved.append(conflict)
2507
resolved.remove_files(self)
2508
self.set_conflicts(un_resolved)
2509
return un_resolved, resolved
2513
tree_basis = self.basis_tree()
2514
tree_basis.lock_read()
2516
repo_basis = self.branch.repository.revision_tree(
2517
self.last_revision())
2518
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2519
raise errors.BzrCheckError(
2520
"Mismatched basis inventory content.")
2525
def _validate(self):
2526
"""Validate internal structures.
2528
This is meant mostly for the test suite. To give it a chance to detect
2529
corruption after actions have occurred. The default implementation is a
2532
:return: None. An exception should be raised if there is an error.
2537
def _get_rules_searcher(self, default_searcher):
2538
"""See Tree._get_rules_searcher."""
2539
if self._rules_searcher is None:
2540
self._rules_searcher = super(WorkingTree,
2541
self)._get_rules_searcher(default_searcher)
2542
return self._rules_searcher
2544
def get_shelf_manager(self):
2545
"""Return the ShelfManager for this WorkingTree."""
2546
from bzrlib.shelf import ShelfManager
2547
return ShelfManager(self, self._transport)
2550
class WorkingTree2(WorkingTree):
2551
"""This is the Format 2 working tree.
2553
This was the first weave based working tree.
2554
- uses os locks for locking.
2555
- uses the branch last-revision.
2558
def __init__(self, *args, **kwargs):
2559
super(WorkingTree2, self).__init__(*args, **kwargs)
2560
# WorkingTree2 has more of a constraint that self._inventory must
2561
# exist. Because this is an older format, we don't mind the overhead
2562
# caused by the extra computation here.
2564
# Newer WorkingTree's should only have self._inventory set when they
2566
if self._inventory is None:
2567
self.read_working_inventory()
2569
def lock_tree_write(self):
2570
"""See WorkingTree.lock_tree_write().
2572
In Format2 WorkingTrees we have a single lock for the branch and tree
2573
so lock_tree_write() degrades to lock_write().
2575
self.branch.lock_write()
2577
return self._control_files.lock_write()
2579
self.branch.unlock()
2583
# do non-implementation specific cleanup
2586
# we share control files:
2587
if self._control_files._lock_count == 3:
2588
# _inventory_is_modified is always False during a read lock.
2589
if self._inventory_is_modified:
2591
self._write_hashcache_if_dirty()
2593
# reverse order of locking.
2595
return self._control_files.unlock()
2597
self.branch.unlock()
2600
class WorkingTree3(WorkingTree):
2601
"""This is the Format 3 working tree.
2603
This differs from the base WorkingTree by:
2604
- having its own file lock
2605
- having its own last-revision property.
2607
This is new in bzr 0.8
2611
def _last_revision(self):
2612
"""See Mutable.last_revision."""
2614
return self._transport.get_bytes('last-revision')
2615
except errors.NoSuchFile:
2616
return _mod_revision.NULL_REVISION
2618
def _change_last_revision(self, revision_id):
2619
"""See WorkingTree._change_last_revision."""
2620
if revision_id is None or revision_id == NULL_REVISION:
2622
self._transport.delete('last-revision')
2623
except errors.NoSuchFile:
2627
self._transport.put_bytes('last-revision', revision_id,
2628
mode=self.bzrdir._get_file_mode())
2631
@needs_tree_write_lock
2632
def set_conflicts(self, conflicts):
2633
self._put_rio('conflicts', conflicts.to_stanzas(),
2636
@needs_tree_write_lock
2637
def add_conflicts(self, new_conflicts):
2638
conflict_set = set(self.conflicts())
2639
conflict_set.update(set(list(new_conflicts)))
2640
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2641
key=_mod_conflicts.Conflict.sort_key)))
2644
def conflicts(self):
2646
confile = self._transport.get('conflicts')
2647
except errors.NoSuchFile:
2648
return _mod_conflicts.ConflictList()
2651
if confile.next() != CONFLICT_HEADER_1 + '\n':
2652
raise errors.ConflictFormatError()
2653
except StopIteration:
2654
raise errors.ConflictFormatError()
2655
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2660
# do non-implementation specific cleanup
2662
if self._control_files._lock_count == 1:
2663
# _inventory_is_modified is always False during a read lock.
2664
if self._inventory_is_modified:
2666
self._write_hashcache_if_dirty()
2667
# reverse order of locking.
2669
return self._control_files.unlock()
2671
self.branch.unlock()
2674
def get_conflicted_stem(path):
2675
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2676
if path.endswith(suffix):
2677
return path[:-len(suffix)]
2680
class WorkingTreeFormat(object):
2681
"""An encapsulation of the initialization and open routines for a format.
2683
Formats provide three things:
2684
* An initialization routine,
2688
Formats are placed in an dict by their format string for reference
2689
during workingtree opening. Its not required that these be instances, they
2690
can be classes themselves with class methods - it simply depends on
2691
whether state is needed for a given format or not.
2693
Once a format is deprecated, just deprecate the initialize and open
2694
methods on the format class. Do not deprecate the object, as the
2695
object will be created every time regardless.
2698
_default_format = None
2699
"""The default format used for new trees."""
2702
"""The known formats."""
2704
requires_rich_root = False
2706
upgrade_recommended = False
2709
def find_format(klass, a_bzrdir):
2710
"""Return the format for the working tree object in a_bzrdir."""
2712
transport = a_bzrdir.get_workingtree_transport(None)
2713
format_string = transport.get("format").read()
2714
return klass._formats[format_string]
2715
except errors.NoSuchFile:
2716
raise errors.NoWorkingTree(base=transport.base)
2718
raise errors.UnknownFormatError(format=format_string,
2719
kind="working tree")
2721
def __eq__(self, other):
2722
return self.__class__ is other.__class__
2724
def __ne__(self, other):
2725
return not (self == other)
2728
def get_default_format(klass):
2729
"""Return the current default format."""
2730
return klass._default_format
2732
def get_format_string(self):
2733
"""Return the ASCII format string that identifies this format."""
2734
raise NotImplementedError(self.get_format_string)
2736
def get_format_description(self):
2737
"""Return the short description for this format."""
2738
raise NotImplementedError(self.get_format_description)
2740
def is_supported(self):
2741
"""Is this format supported?
2743
Supported formats can be initialized and opened.
2744
Unsupported formats may not support initialization or committing or
2745
some other features depending on the reason for not being supported.
2749
def supports_content_filtering(self):
2750
"""True if this format supports content filtering."""
2753
def supports_views(self):
2754
"""True if this format supports stored views."""
2758
def register_format(klass, format):
2759
klass._formats[format.get_format_string()] = format
2762
def set_default_format(klass, format):
2763
klass._default_format = format
2766
def unregister_format(klass, format):
2767
del klass._formats[format.get_format_string()]
2770
class WorkingTreeFormat2(WorkingTreeFormat):
2771
"""The second working tree format.
2773
This format modified the hash cache from the format 1 hash cache.
2776
upgrade_recommended = True
2778
def get_format_description(self):
2779
"""See WorkingTreeFormat.get_format_description()."""
2780
return "Working tree format 2"
2782
def _stub_initialize_on_transport(self, transport, file_mode):
2783
"""Workaround: create control files for a remote working tree.
2785
This ensures that it can later be updated and dealt with locally,
2786
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2787
no working tree. (See bug #43064).
2791
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2793
transport.put_file('inventory', sio, file_mode)
2794
transport.put_bytes('pending-merges', '', file_mode)
2796
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2797
accelerator_tree=None, hardlink=False):
2798
"""See WorkingTreeFormat.initialize()."""
2799
if not isinstance(a_bzrdir.transport, LocalTransport):
2800
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2801
if from_branch is not None:
2802
branch = from_branch
2804
branch = a_bzrdir.open_branch()
2805
if revision_id is None:
2806
revision_id = _mod_revision.ensure_null(branch.last_revision())
2809
branch.generate_revision_history(revision_id)
2813
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2819
basis_tree = branch.repository.revision_tree(revision_id)
2820
if basis_tree.inventory.root is not None:
2821
wt.set_root_id(basis_tree.get_root_id())
2822
# set the parent list and cache the basis tree.
2823
if _mod_revision.is_null(revision_id):
2826
parent_trees = [(revision_id, basis_tree)]
2827
wt.set_parent_trees(parent_trees)
2828
transform.build_tree(basis_tree, wt)
2832
super(WorkingTreeFormat2, self).__init__()
2833
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2835
def open(self, a_bzrdir, _found=False):
2836
"""Return the WorkingTree object for a_bzrdir
2838
_found is a private parameter, do not use it. It is used to indicate
2839
if format probing has already been done.
2842
# we are being called directly and must probe.
2843
raise NotImplementedError
2844
if not isinstance(a_bzrdir.transport, LocalTransport):
2845
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2846
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2852
class WorkingTreeFormat3(WorkingTreeFormat):
2853
"""The second working tree format updated to record a format marker.
2856
- exists within a metadir controlling .bzr
2857
- includes an explicit version marker for the workingtree control
2858
files, separate from the BzrDir format
2859
- modifies the hash cache format
2861
- uses a LockDir to guard access for writes.
2864
upgrade_recommended = True
2866
def get_format_string(self):
2867
"""See WorkingTreeFormat.get_format_string()."""
2868
return "Bazaar-NG Working Tree format 3"
2870
def get_format_description(self):
2871
"""See WorkingTreeFormat.get_format_description()."""
2872
return "Working tree format 3"
2874
_lock_file_name = 'lock'
2875
_lock_class = LockDir
2877
_tree_class = WorkingTree3
2879
def __get_matchingbzrdir(self):
2880
return bzrdir.BzrDirMetaFormat1()
2882
_matchingbzrdir = property(__get_matchingbzrdir)
2884
def _open_control_files(self, a_bzrdir):
2885
transport = a_bzrdir.get_workingtree_transport(None)
2886
return LockableFiles(transport, self._lock_file_name,
2889
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2890
accelerator_tree=None, hardlink=False):
2891
"""See WorkingTreeFormat.initialize().
2893
:param revision_id: if supplied, create a working tree at a different
2894
revision than the branch is at.
2895
:param accelerator_tree: A tree which can be used for retrieving file
2896
contents more quickly than the revision tree, i.e. a workingtree.
2897
The revision tree will be used for cases where accelerator_tree's
2898
content is different.
2899
:param hardlink: If true, hard-link files from accelerator_tree,
2902
if not isinstance(a_bzrdir.transport, LocalTransport):
2903
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2904
transport = a_bzrdir.get_workingtree_transport(self)
2905
control_files = self._open_control_files(a_bzrdir)
2906
control_files.create_lock()
2907
control_files.lock_write()
2908
transport.put_bytes('format', self.get_format_string(),
2909
mode=a_bzrdir._get_file_mode())
2910
if from_branch is not None:
2911
branch = from_branch
2913
branch = a_bzrdir.open_branch()
2914
if revision_id is None:
2915
revision_id = _mod_revision.ensure_null(branch.last_revision())
2916
# WorkingTree3 can handle an inventory which has a unique root id.
2917
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2918
# those trees. And because there isn't a format bump inbetween, we
2919
# are maintaining compatibility with older clients.
2920
# inv = Inventory(root_id=gen_root_id())
2921
inv = self._initial_inventory()
2922
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2928
_control_files=control_files)
2929
wt.lock_tree_write()
2931
basis_tree = branch.repository.revision_tree(revision_id)
2932
# only set an explicit root id if there is one to set.
2933
if basis_tree.inventory.root is not None:
2934
wt.set_root_id(basis_tree.get_root_id())
2935
if revision_id == NULL_REVISION:
2936
wt.set_parent_trees([])
2938
wt.set_parent_trees([(revision_id, basis_tree)])
2939
transform.build_tree(basis_tree, wt)
2941
# Unlock in this order so that the unlock-triggers-flush in
2942
# WorkingTree is given a chance to fire.
2943
control_files.unlock()
2947
def _initial_inventory(self):
2951
super(WorkingTreeFormat3, self).__init__()
2953
def open(self, a_bzrdir, _found=False):
2954
"""Return the WorkingTree object for a_bzrdir
2956
_found is a private parameter, do not use it. It is used to indicate
2957
if format probing has already been done.
2960
# we are being called directly and must probe.
2961
raise NotImplementedError
2962
if not isinstance(a_bzrdir.transport, LocalTransport):
2963
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2964
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2967
def _open(self, a_bzrdir, control_files):
2968
"""Open the tree itself.
2970
:param a_bzrdir: the dir for the tree.
2971
:param control_files: the control files for the tree.
2973
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2977
_control_files=control_files)
2980
return self.get_format_string()
2983
__default_format = WorkingTreeFormat4()
2984
WorkingTreeFormat.register_format(__default_format)
2985
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2986
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2987
WorkingTreeFormat.set_default_format(__default_format)
2988
# formats which have no format string are not discoverable
2989
# and not independently creatable, so are not registered.
2990
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
