1
# Copyright (C) 2005-2010 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).
33
from cStringIO import StringIO
37
from bzrlib.lazy_import import lazy_import
38
lazy_import(globals(), """
39
from bisect import bisect_left
51
conflicts as _mod_conflicts,
60
revision as _mod_revision,
70
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
78
from bzrlib import symbol_versioning
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lockable_files import LockableFiles
81
from bzrlib.lockdir import LockDir
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
from bzrlib.osutils import (
95
from bzrlib.filters import filtered_input_file
96
from bzrlib.trace import mutter, note
97
from bzrlib.transport.local import LocalTransport
98
from bzrlib.progress import ProgressPhase
99
from bzrlib.revision import CURRENT_REVISION
100
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
107
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
116
class TreeEntry(object):
117
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
120
InventoryEntries without ids - though that seems wrong. For now,
121
this is a parallel hierarchy to InventoryEntry, and needs to become
122
one of several things: decorates to that hierarchy, children of, or
124
Another note is that these objects are currently only used when there is
125
no InventoryEntry available - i.e. for unversioned objects.
126
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
129
def __eq__(self, other):
130
# yes, this us ugly, TODO: best practice __eq__ style.
131
return (isinstance(other, TreeEntry)
132
and other.__class__ == self.__class__)
134
def kind_character(self):
138
class TreeDirectory(TreeEntry):
139
"""See TreeEntry. This is a directory in a working tree."""
141
def __eq__(self, other):
142
return (isinstance(other, TreeDirectory)
143
and other.__class__ == self.__class__)
145
def kind_character(self):
149
class TreeFile(TreeEntry):
150
"""See TreeEntry. This is a regular file in a working tree."""
152
def __eq__(self, other):
153
return (isinstance(other, TreeFile)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class TreeLink(TreeEntry):
161
"""See TreeEntry. This is a symlink in a working tree."""
163
def __eq__(self, other):
164
return (isinstance(other, TreeLink)
165
and other.__class__ == self.__class__)
167
def kind_character(self):
171
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
bzrdir.ControlComponent):
173
"""Working copy tree.
175
The inventory is held in the `Branch` working-inventory, and the
176
files are in a directory on disk.
178
It is possible for a `WorkingTree` to have a filename which is
179
not listed in the Inventory and vice versa.
182
# override this to set the strategy for storing views
183
def _make_views(self):
184
return views.DisabledViews(self)
186
def __init__(self, basedir='.',
187
branch=DEPRECATED_PARAMETER,
193
"""Construct a WorkingTree instance. This is not a public API.
195
:param branch: A branch to override probing for the branch.
197
self._format = _format
198
self.bzrdir = _bzrdir
200
raise errors.BzrError("Please use bzrdir.open_workingtree or "
201
"WorkingTree.open() to obtain a WorkingTree.")
202
basedir = safe_unicode(basedir)
203
mutter("opening working tree %r", basedir)
204
if deprecated_passed(branch):
205
self._branch = branch
207
self._branch = self.bzrdir.open_branch()
208
self.basedir = realpath(basedir)
209
# if branch is at our basedir and is a format 6 or less
210
if isinstance(self._format, WorkingTreeFormat2):
211
# share control object
212
self._control_files = self.branch.control_files
214
# assume all other formats have their own control files.
215
self._control_files = _control_files
216
self._transport = self._control_files._transport
217
# update the whole cache up front and write to disk if anything changed;
218
# in the future we might want to do this more selectively
219
# two possible ways offer themselves : in self._unlock, write the cache
220
# if needed, or, when the cache sees a change, append it to the hash
221
# cache file, and have the parser take the most recent entry for a
223
wt_trans = self.bzrdir.get_workingtree_transport(None)
224
cache_filename = wt_trans.local_abspath('stat-cache')
225
self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
self.bzrdir._get_file_mode(),
227
self._content_filter_stack_provider())
230
# is this scan needed ? it makes things kinda slow.
237
if _inventory is None:
238
# This will be acquired on lock_read() or lock_write()
239
self._inventory_is_modified = False
240
self._inventory = None
242
# the caller of __init__ has provided an inventory,
243
# we assume they know what they are doing - as its only
244
# the Format factory and creation methods that are
245
# permitted to do this.
246
self._set_inventory(_inventory, dirty=False)
247
self._detect_case_handling()
248
self._rules_searcher = None
249
self.views = self._make_views()
252
def user_transport(self):
253
return self.bzrdir.user_transport
256
def control_transport(self):
257
return self._transport
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 _get_check_refs(self):
290
"""Return the references needed to perform a check of this tree.
292
The default implementation returns no refs, and is only suitable for
293
trees that have no local caching and can commit on ghosts at any time.
295
:seealso: bzrlib.check for details about check_refs.
299
def requires_rich_root(self):
300
return self._format.requires_rich_root
302
def supports_tree_reference(self):
305
def supports_content_filtering(self):
306
return self._format.supports_content_filtering()
308
def supports_views(self):
309
return self.views.supports_views()
311
def _set_inventory(self, inv, dirty):
312
"""Set the internal cached inventory.
314
:param inv: The inventory to set.
315
:param dirty: A boolean indicating whether the inventory is the same
316
logical inventory as whats on disk. If True the inventory is not
317
the same and should be written to disk or data will be lost, if
318
False then the inventory is the same as that on disk and any
319
serialisation would be unneeded overhead.
321
self._inventory = inv
322
self._inventory_is_modified = dirty
325
def open(path=None, _unsupported=False):
326
"""Open an existing working tree at path.
330
path = osutils.getcwd()
331
control = bzrdir.BzrDir.open(path, _unsupported)
332
return control.open_workingtree(_unsupported)
335
def open_containing(path=None):
336
"""Open an existing working tree which has its root about path.
338
This probes for a working tree at path and searches upwards from there.
340
Basically we keep looking up until we find the control directory or
341
run into /. If there isn't one, raises NotBranchError.
342
TODO: give this a new exception.
343
If there is one, it is returned, along with the unused portion of path.
345
:return: The WorkingTree that contains 'path', and the rest of path
348
path = osutils.getcwd()
349
control, relpath = bzrdir.BzrDir.open_containing(path)
351
return control.open_workingtree(), relpath
354
def open_downlevel(path=None):
355
"""Open an unsupported working tree.
357
Only intended for advanced situations like upgrading part of a bzrdir.
359
return WorkingTree.open(path, _unsupported=True)
362
def find_trees(location):
363
def list_current(transport):
364
return [d for d in transport.list_dir('') if d != '.bzr']
365
def evaluate(bzrdir):
367
tree = bzrdir.open_workingtree()
368
except errors.NoWorkingTree:
372
transport = get_transport(location)
373
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
374
list_current=list_current)
375
return [t for t in iterator if t is not None]
377
# should be deprecated - this is slow and in any case treating them as a
378
# container is (we now know) bad style -- mbp 20070302
379
## @deprecated_method(zero_fifteen)
381
"""Iterate through file_ids for this tree.
383
file_ids are in a WorkingTree if they are in the working inventory
384
and the working file exists.
386
inv = self._inventory
387
for path, ie in inv.iter_entries():
388
if osutils.lexists(self.abspath(path)):
391
def all_file_ids(self):
392
"""See Tree.iter_all_file_ids"""
393
return set(self.inventory)
396
return "<%s of %s>" % (self.__class__.__name__,
397
getattr(self, 'basedir', None))
399
def abspath(self, filename):
400
return pathjoin(self.basedir, filename)
402
def basis_tree(self):
403
"""Return RevisionTree for the current last revision.
405
If the left most parent is a ghost then the returned tree will be an
406
empty tree - one obtained by calling
407
repository.revision_tree(NULL_REVISION).
410
revision_id = self.get_parent_ids()[0]
412
# no parents, return an empty revision tree.
413
# in the future this should return the tree for
414
# 'empty:' - the implicit root empty tree.
415
return self.branch.repository.revision_tree(
416
_mod_revision.NULL_REVISION)
418
return self.revision_tree(revision_id)
419
except errors.NoSuchRevision:
421
# No cached copy available, retrieve from the repository.
422
# FIXME? RBC 20060403 should we cache the inventory locally
425
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
427
# the basis tree *may* be a ghost or a low level error may have
428
# occurred. If the revision is present, its a problem, if its not
430
if self.branch.repository.has_revision(revision_id):
432
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(
434
_mod_revision.NULL_REVISION)
437
self._flush_ignore_list_cache()
439
def relpath(self, path):
440
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
443
interpreted relative to the python current working directory.
445
return osutils.relpath(self.basedir, path)
447
def has_filename(self, filename):
448
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
457
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
459
stat_value = _fstat(file_obj.fileno())
460
if filtered and self.supports_content_filtering():
461
filters = self._content_filter_stack(path)
462
file_obj = filtered_input_file(file_obj, filters)
463
return (file_obj, stat_value)
465
def get_file_text(self, file_id, path=None, filtered=True):
466
return self.get_file(file_id, path=path, filtered=filtered).read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
486
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
487
"""See Tree.annotate_iter
489
This implementation will use the basis tree implementation if possible.
490
Lines not in the basis are attributed to CURRENT_REVISION
492
If there are pending merges, lines added by those merges will be
493
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
attribution will be correct).
496
maybe_file_parent_keys = []
497
for parent_id in self.get_parent_ids():
499
parent_tree = self.revision_tree(parent_id)
500
except errors.NoSuchRevisionInTree:
501
parent_tree = self.branch.repository.revision_tree(parent_id)
502
parent_tree.lock_read()
504
if file_id not in parent_tree:
506
ie = parent_tree.inventory[file_id]
507
if ie.kind != 'file':
508
# Note: this is slightly unnecessary, because symlinks and
509
# directories have a "text" which is the empty text, and we
510
# know that won't mess up annotations. But it seems cleaner
512
parent_text_key = (file_id, ie.revision)
513
if parent_text_key not in maybe_file_parent_keys:
514
maybe_file_parent_keys.append(parent_text_key)
517
graph = _mod_graph.Graph(self.branch.repository.texts)
518
heads = graph.heads(maybe_file_parent_keys)
519
file_parent_keys = []
520
for key in maybe_file_parent_keys:
522
file_parent_keys.append(key)
524
# Now we have the parents of this content
525
annotator = self.branch.repository.texts.get_annotator()
526
text = self.get_file(file_id).read()
527
this_key =(file_id, default_revision)
528
annotator.add_special_text(this_key, file_parent_keys, text)
529
annotations = [(key[-1], line)
530
for key, line in annotator.annotate_flat(this_key)]
533
def _get_ancestors(self, default_revision):
534
ancestors = set([default_revision])
535
for parent_id in self.get_parent_ids():
536
ancestors.update(self.branch.repository.get_ancestry(
537
parent_id, topo_sorted=False))
540
def get_parent_ids(self):
541
"""See Tree.get_parent_ids.
543
This implementation reads the pending merges list and last_revision
544
value and uses that to decide what the parents list should be.
546
last_rev = _mod_revision.ensure_null(self._last_revision())
547
if _mod_revision.NULL_REVISION == last_rev:
552
merges_bytes = self._transport.get_bytes('pending-merges')
553
except errors.NoSuchFile:
556
for l in osutils.split_lines(merges_bytes):
557
revision_id = l.rstrip('\n')
558
parents.append(revision_id)
562
def get_root_id(self):
563
"""Return the id of this trees root"""
564
return self._inventory.root.file_id
566
def _get_store_filename(self, file_id):
567
## XXX: badly named; this is not in the store at all
568
return self.abspath(self.id2path(file_id))
571
def clone(self, to_bzrdir, revision_id=None):
572
"""Duplicate this working tree into to_bzr, including all state.
574
Specifically modified files are kept as modified, but
575
ignored and unknown files are discarded.
577
If you want to make a new line of development, see bzrdir.sprout()
580
If not None, the cloned tree will have its last revision set to
581
revision, and difference between the source trees last revision
582
and this one merged in.
584
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
586
self.copy_content_into(result, revision_id)
590
def copy_content_into(self, tree, revision_id=None):
591
"""Copy the current content and user files of this tree into tree."""
592
tree.set_root_id(self.get_root_id())
593
if revision_id is None:
594
merge.transform_tree(tree, self)
596
# TODO now merge from tree.last_revision to revision (to preserve
597
# user local changes)
598
merge.transform_tree(tree, self)
599
tree.set_parent_ids([revision_id])
601
def id2abspath(self, file_id):
602
return self.abspath(self.id2path(file_id))
604
def has_id(self, file_id):
605
# files that have been deleted are excluded
607
if not inv.has_id(file_id):
609
path = inv.id2path(file_id)
610
return osutils.lexists(self.abspath(path))
612
def has_or_had_id(self, file_id):
613
if file_id == self.inventory.root.file_id:
615
return self.inventory.has_id(file_id)
617
__contains__ = has_id
619
def get_file_size(self, file_id):
620
"""See Tree.get_file_size"""
621
# XXX: this returns the on-disk size; it should probably return the
624
return os.path.getsize(self.id2abspath(file_id))
626
if e.errno != errno.ENOENT:
632
def get_file_sha1(self, file_id, path=None, stat_value=None):
634
path = self._inventory.id2path(file_id)
635
return self._hashcache.get_sha1(path, stat_value)
637
def get_file_mtime(self, file_id, path=None):
639
path = self.inventory.id2path(file_id)
640
return os.lstat(self.abspath(path)).st_mtime
642
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
file_id = self.path2id(path)
645
# For unversioned files on win32, we just assume they are not
648
return self._inventory[file_id].executable
650
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
651
mode = stat_result.st_mode
652
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
654
if not supports_executable():
655
def is_executable(self, file_id, path=None):
656
return self._inventory[file_id].executable
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_basis
661
def is_executable(self, file_id, path=None):
663
path = self.id2path(file_id)
664
mode = os.lstat(self.abspath(path)).st_mode
665
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
667
_is_executable_from_path_and_stat = \
668
_is_executable_from_path_and_stat_from_stat
670
@needs_tree_write_lock
671
def _add(self, files, ids, kinds):
672
"""See MutableTree._add."""
673
# TODO: Re-adding a file that is removed in the working copy
674
# should probably put it back with the previous ID.
675
# the read and write working inventory should not occur in this
676
# function - they should be part of lock_write and unlock.
678
for f, file_id, kind in zip(files, ids, kinds):
680
inv.add_path(f, kind=kind)
682
inv.add_path(f, kind=kind, file_id=file_id)
683
self._inventory_is_modified = True
685
@needs_tree_write_lock
686
def _gather_kinds(self, files, kinds):
687
"""See MutableTree._gather_kinds."""
688
for pos, f in enumerate(files):
689
if kinds[pos] is None:
690
fullpath = normpath(self.abspath(f))
692
kinds[pos] = file_kind(fullpath)
694
if e.errno == errno.ENOENT:
695
raise errors.NoSuchFile(fullpath)
698
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
699
"""Add revision_id as a parent.
701
This is equivalent to retrieving the current list of parent ids
702
and setting the list to its value plus revision_id.
704
:param revision_id: The revision id to add to the parent list. It may
705
be a ghost revision as long as its not the first parent to be added,
706
or the allow_leftmost_as_ghost parameter is set True.
707
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
709
parents = self.get_parent_ids() + [revision_id]
710
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
711
or allow_leftmost_as_ghost)
713
@needs_tree_write_lock
714
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
715
"""Add revision_id, tree tuple as a parent.
717
This is equivalent to retrieving the current list of parent trees
718
and setting the list to its value plus parent_tuple. See also
719
add_parent_tree_id - if you only have a parent id available it will be
720
simpler to use that api. If you have the parent already available, using
721
this api is preferred.
723
:param parent_tuple: The (revision id, tree) to add to the parent list.
724
If the revision_id is a ghost, pass None for the tree.
725
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
727
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
728
if len(parent_ids) > 1:
729
# the leftmost may have already been a ghost, preserve that if it
731
allow_leftmost_as_ghost = True
732
self.set_parent_ids(parent_ids,
733
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
735
@needs_tree_write_lock
736
def add_pending_merge(self, *revision_ids):
737
# TODO: Perhaps should check at this point that the
738
# history of the revision is actually present?
739
parents = self.get_parent_ids()
741
for rev_id in revision_ids:
742
if rev_id in parents:
744
parents.append(rev_id)
747
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
749
def path_content_summary(self, path, _lstat=os.lstat,
750
_mapper=osutils.file_kind_from_stat_mode):
751
"""See Tree.path_content_summary."""
752
abspath = self.abspath(path)
754
stat_result = _lstat(abspath)
756
if getattr(e, 'errno', None) == errno.ENOENT:
758
return ('missing', None, None, None)
759
# propagate other errors
761
kind = _mapper(stat_result.st_mode)
763
return self._file_content_summary(path, stat_result)
764
elif kind == 'directory':
765
# perhaps it looks like a plain directory, but it's really a
767
if self._directory_is_tree_reference(path):
768
kind = 'tree-reference'
769
return kind, None, None, None
770
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
774
return (kind, None, None, None)
776
def _file_content_summary(self, path, stat_result):
777
size = stat_result.st_size
778
executable = self._is_executable_from_path_and_stat(path, stat_result)
779
# try for a stat cache lookup
780
return ('file', size, executable, self._sha_from_stat(
783
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
"""Common ghost checking functionality from set_parent_*.
786
This checks that the left hand-parent exists if there are any
789
if len(revision_ids) > 0:
790
leftmost_id = revision_ids[0]
791
if (not allow_leftmost_as_ghost and not
792
self.branch.repository.has_revision(leftmost_id)):
793
raise errors.GhostRevisionUnusableHere(leftmost_id)
795
def _set_merges_from_parent_ids(self, parent_ids):
796
merges = parent_ids[1:]
797
self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
mode=self.bzrdir._get_file_mode())
800
def _filter_parent_ids_by_ancestry(self, revision_ids):
801
"""Check that all merged revisions are proper 'heads'.
803
This will always return the first revision_id, and any merged revisions
806
if len(revision_ids) == 0:
808
graph = self.branch.repository.get_graph()
809
heads = graph.heads(revision_ids)
810
new_revision_ids = revision_ids[:1]
811
for revision_id in revision_ids[1:]:
812
if revision_id in heads and revision_id not in new_revision_ids:
813
new_revision_ids.append(revision_id)
814
if new_revision_ids != revision_ids:
815
trace.mutter('requested to set revision_ids = %s,'
816
' but filtered to %s', revision_ids, new_revision_ids)
817
return new_revision_ids
819
@needs_tree_write_lock
820
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
"""Set the parent ids to revision_ids.
823
See also set_parent_trees. This api will try to retrieve the tree data
824
for each element of revision_ids from the trees repository. If you have
825
tree data already available, it is more efficient to use
826
set_parent_trees rather than set_parent_ids. set_parent_ids is however
827
an easier API to use.
829
:param revision_ids: The revision_ids to set as the parent ids of this
830
working tree. Any of these may be ghosts.
832
self._check_parents_for_ghosts(revision_ids,
833
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
834
for revision_id in revision_ids:
835
_mod_revision.check_not_reserved_id(revision_id)
837
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
839
if len(revision_ids) > 0:
840
self.set_last_revision(revision_ids[0])
842
self.set_last_revision(_mod_revision.NULL_REVISION)
844
self._set_merges_from_parent_ids(revision_ids)
846
@needs_tree_write_lock
847
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
848
"""See MutableTree.set_parent_trees."""
849
parent_ids = [rev for (rev, tree) in parents_list]
850
for revision_id in parent_ids:
851
_mod_revision.check_not_reserved_id(revision_id)
853
self._check_parents_for_ghosts(parent_ids,
854
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
856
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
858
if len(parent_ids) == 0:
859
leftmost_parent_id = _mod_revision.NULL_REVISION
860
leftmost_parent_tree = None
862
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
864
if self._change_last_revision(leftmost_parent_id):
865
if leftmost_parent_tree is None:
866
# If we don't have a tree, fall back to reading the
867
# parent tree from the repository.
868
self._cache_basis_inventory(leftmost_parent_id)
870
inv = leftmost_parent_tree.inventory
871
xml = self._create_basis_xml_from_inventory(
872
leftmost_parent_id, inv)
873
self._write_basis_inventory(xml)
874
self._set_merges_from_parent_ids(parent_ids)
876
@needs_tree_write_lock
877
def set_pending_merges(self, rev_list):
878
parents = self.get_parent_ids()
879
leftmost = parents[:1]
880
new_parents = leftmost + rev_list
881
self.set_parent_ids(new_parents)
883
@needs_tree_write_lock
884
def set_merge_modified(self, modified_hashes):
886
for file_id, hash in modified_hashes.iteritems():
887
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
888
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
890
def _sha_from_stat(self, path, stat_result):
891
"""Get a sha digest from the tree's stat cache.
893
The default implementation assumes no stat cache is present.
895
:param path: The path.
896
:param stat_result: The stat result being looked up.
900
def _put_rio(self, filename, stanzas, header):
901
self._must_be_locked()
902
my_file = rio_file(stanzas, header)
903
self._transport.put_file(filename, my_file,
904
mode=self.bzrdir._get_file_mode())
906
@needs_write_lock # because merge pulls data into the branch.
907
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
merge_type=None, force=False):
909
"""Merge from a branch into this working tree.
911
:param branch: The branch to merge from.
912
:param to_revision: If non-None, the merge will merge to to_revision,
913
but not beyond it. to_revision does not need to be in the history
914
of the branch when it is supplied. If None, to_revision defaults to
915
branch.last_revision().
917
from bzrlib.merge import Merger, Merge3Merger
918
merger = Merger(self.branch, this_tree=self)
919
# check that there are no local alterations
920
if not force and self.has_changes():
921
raise errors.UncommittedChanges(self)
922
if to_revision is None:
923
to_revision = _mod_revision.ensure_null(branch.last_revision())
924
merger.other_rev_id = to_revision
925
if _mod_revision.is_null(merger.other_rev_id):
926
raise errors.NoCommits(branch)
927
self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
merger.other_basis = merger.other_rev_id
929
merger.other_tree = self.branch.repository.revision_tree(
931
merger.other_branch = branch
932
if from_revision is None:
935
merger.set_base_revision(from_revision, branch)
936
if merger.base_rev_id == merger.other_rev_id:
937
raise errors.PointlessMerge
938
merger.backup_files = False
939
if merge_type is None:
940
merger.merge_type = Merge3Merger
942
merger.merge_type = merge_type
943
merger.set_interesting_files(None)
944
merger.show_base = False
945
merger.reprocess = False
946
conflicts = merger.do_merge()
951
def merge_modified(self):
952
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
955
typically called after we make some automatic updates to the tree
958
This returns a map of file_id->sha1, containing only files which are
959
still in the working inventory and have that text hash.
962
hashfile = self._transport.get('merge-hashes')
963
except errors.NoSuchFile:
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
971
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
985
def mkdir(self, path, file_id=None):
986
"""See MutableTree.mkdir()."""
988
file_id = generate_ids.gen_file_id(os.path.basename(path))
989
os.mkdir(self.abspath(path))
990
self.add(path, file_id, 'directory')
993
def get_symlink_target(self, file_id):
994
abspath = self.id2abspath(file_id)
995
target = osutils.readlink(abspath)
999
def subsume(self, other_tree):
1000
def add_children(inventory, entry):
1001
for child_entry in entry.children.values():
1002
inventory._byid[child_entry.file_id] = child_entry
1003
if child_entry.kind == 'directory':
1004
add_children(inventory, child_entry)
1005
if other_tree.get_root_id() == self.get_root_id():
1006
raise errors.BadSubsumeSource(self, other_tree,
1007
'Trees have the same root')
1009
other_tree_path = self.relpath(other_tree.basedir)
1010
except errors.PathNotChild:
1011
raise errors.BadSubsumeSource(self, other_tree,
1012
'Tree is not contained by the other')
1013
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1014
if new_root_parent is None:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Parent directory is not versioned.')
1017
# We need to ensure that the result of a fetch will have a
1018
# versionedfile for the other_tree root, and only fetching into
1019
# RepositoryKnit2 guarantees that.
1020
if not self.branch.repository.supports_rich_root():
1021
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1022
other_tree.lock_tree_write()
1024
new_parents = other_tree.get_parent_ids()
1025
other_root = other_tree.inventory.root
1026
other_root.parent_id = new_root_parent
1027
other_root.name = osutils.basename(other_tree_path)
1028
self.inventory.add(other_root)
1029
add_children(self.inventory, other_root)
1030
self._write_inventory(self.inventory)
1031
# normally we don't want to fetch whole repositories, but i think
1032
# here we really do want to consolidate the whole thing.
1033
for parent_id in other_tree.get_parent_ids():
1034
self.branch.fetch(other_tree.branch, parent_id)
1035
self.add_parent_tree_id(parent_id)
1038
other_tree.bzrdir.retire_bzrdir()
1040
def _setup_directory_is_tree_reference(self):
1041
if self._branch.repository._format.supports_tree_reference:
1042
self._directory_is_tree_reference = \
1043
self._directory_may_be_tree_reference
1045
self._directory_is_tree_reference = \
1046
self._directory_is_never_tree_reference
1048
def _directory_is_never_tree_reference(self, relpath):
1051
def _directory_may_be_tree_reference(self, relpath):
1052
# as a special case, if a directory contains control files then
1053
# it's a tree reference, except that the root of the tree is not
1054
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
# TODO: We could ask all the control formats whether they
1056
# recognize this directory, but at the moment there's no cheap api
1057
# to do that. Since we probably can only nest bzr checkouts and
1058
# they always use this name it's ok for now. -- mbp 20060306
1060
# FIXME: There is an unhandled case here of a subdirectory
1061
# containing .bzr but not a branch; that will probably blow up
1062
# when you try to commit it. It might happen if there is a
1063
# checkout in a subdirectory. This can be avoided by not adding
1066
@needs_tree_write_lock
1067
def extract(self, file_id, format=None):
1068
"""Extract a subtree from this tree.
1070
A new branch will be created, relative to the path for this tree.
1074
segments = osutils.splitpath(path)
1075
transport = self.branch.bzrdir.root_transport
1076
for name in segments:
1077
transport = transport.clone(name)
1078
transport.ensure_base()
1081
sub_path = self.id2path(file_id)
1082
branch_transport = mkdirs(sub_path)
1084
format = self.bzrdir.cloning_metadir()
1085
branch_transport.ensure_base()
1086
branch_bzrdir = format.initialize_on_transport(branch_transport)
1088
repo = branch_bzrdir.find_repository()
1089
except errors.NoRepositoryPresent:
1090
repo = branch_bzrdir.create_repository()
1091
if not repo.supports_rich_root():
1092
raise errors.RootNotRich()
1093
new_branch = branch_bzrdir.create_branch()
1094
new_branch.pull(self.branch)
1095
for parent_id in self.get_parent_ids():
1096
new_branch.fetch(self.branch, parent_id)
1097
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
if tree_transport.base != branch_transport.base:
1099
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1103
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1105
wt.set_parent_ids(self.get_parent_ids())
1106
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1108
new_root = my_inv[file_id]
1109
my_inv.remove_recursive_id(file_id)
1110
new_root.parent_id = None
1111
child_inv.add(new_root)
1112
self._write_inventory(my_inv)
1113
wt._write_inventory(child_inv)
1116
def _serialize(self, inventory, out_file):
1117
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1120
def _deserialize(selt, in_file):
1121
return xml5.serializer_v5.read_inventory(in_file)
1124
"""Write the in memory inventory to disk."""
1125
# TODO: Maybe this should only write on dirty ?
1126
if self._control_files._lock_mode != 'w':
1127
raise errors.NotWriteLocked(self)
1129
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1133
self._inventory_is_modified = False
1135
def _kind(self, relpath):
1136
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
"""List all files as (path, class, kind, id, entry).
1141
Lists, but does not descend into unversioned directories.
1142
This does not include files that have been deleted in this
1143
tree. Skips the control directory.
1145
:param include_root: if True, return an entry for the root
1146
:param from_dir: start from this directory or None for the root
1147
:param recursive: whether to recurse into subdirectories or not
1149
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
# with it. So callers should be careful to always read_lock the tree.
1151
if not self.is_locked():
1152
raise errors.ObjectNotLocked(self)
1154
inv = self.inventory
1155
if from_dir is None and include_root is True:
1156
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
# Convert these into local objects to save lookup times
1158
pathjoin = osutils.pathjoin
1159
file_kind = self._kind
1161
# transport.base ends in a slash, we want the piece
1162
# between the last two slashes
1163
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1165
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
# directory file_id, relative path, absolute path, reverse sorted children
1168
if from_dir is not None:
1169
from_dir_id = inv.path2id(from_dir)
1170
if from_dir_id is None:
1171
# Directory not versioned
1173
from_dir_abspath = pathjoin(self.basedir, from_dir)
1175
from_dir_id = inv.root.file_id
1176
from_dir_abspath = self.basedir
1177
children = os.listdir(from_dir_abspath)
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
# use a deque and popleft to keep them sorted, or if we use a plain
1181
# list and just reverse() them.
1182
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1185
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1188
f = children.popleft()
1189
## TODO: If we find a subdirectory with its own .bzr
1190
## directory, then that is a separate tree and we
1191
## should exclude it.
1193
# the bzrdir for this tree
1194
if transport_base_dir == f:
1197
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1198
# and 'f' doesn't begin with one, we can do a string op, rather
1199
# than the checks of pathjoin(), all relative paths will have an extra slash
1201
fp = from_dir_relpath + '/' + f
1204
fap = from_dir_abspath + '/' + f
1206
f_ie = inv.get_child(from_dir_id, f)
1209
elif self.is_ignored(fp[1:]):
1212
# we may not have found this file, because of a unicode issue
1213
f_norm, can_access = osutils.normalized_filename(f)
1214
if f == f_norm or not can_access:
1215
# No change, so treat this file normally
1218
# this file can be accessed by a normalized path
1219
# check again if it is versioned
1220
# these lines are repeated here for performance
1222
fp = from_dir_relpath + '/' + f
1223
fap = from_dir_abspath + '/' + f
1224
f_ie = inv.get_child(from_dir_id, f)
1227
elif self.is_ignored(fp[1:]):
1234
# make a last minute entry
1236
yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
yield fp[1:], c, fk, None, fk_entries[fk]()
1241
yield fp[1:], c, fk, None, TreeEntry()
1244
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
1257
# if we finished all children, pop it off the stack
1260
@needs_tree_write_lock
1261
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1264
to_dir must exist in the inventory.
1266
If to_dir exists and is a directory, the files are moved into
1267
it, keeping their old names.
1269
Note that to_dir is only the last component of the new name;
1270
this doesn't change the directory.
1272
For each entry in from_paths the move mode will be determined
1275
The first mode moves the file in the filesystem and updates the
1276
inventory. The second mode only updates the inventory without
1277
touching the file on the filesystem. This is the new mode introduced
1280
move uses the second mode if 'after == True' and the target is not
1281
versioned but present in the working tree.
1283
move uses the second mode if 'after == False' and the source is
1284
versioned but no longer in the working tree, and the target is not
1285
versioned but present in the working tree.
1287
move uses the first mode if 'after == False' and the source is
1288
versioned and present in the working tree, and the target is not
1289
versioned and not present in the working tree.
1291
Everything else results in an error.
1293
This returns a list of (from_path, to_path) pairs for each
1294
entry that is moved.
1299
# check for deprecated use of signature
1301
to_dir = kwargs.get('to_name', None)
1303
raise TypeError('You must supply a target directory')
1305
symbol_versioning.warn('The parameter to_name was deprecated'
1306
' in version 0.13. Use to_dir instead',
1309
# check destination directory
1310
if isinstance(from_paths, basestring):
1312
inv = self.inventory
1313
to_abs = self.abspath(to_dir)
1314
if not isdir(to_abs):
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotADirectory(to_abs))
1317
if not self.has_filename(to_dir):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotInWorkingDirectory(to_dir))
1320
to_dir_id = inv.path2id(to_dir)
1321
if to_dir_id is None:
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotVersionedError(path=str(to_dir)))
1325
to_dir_ie = inv[to_dir_id]
1326
if to_dir_ie.kind != 'directory':
1327
raise errors.BzrMoveFailedError('',to_dir,
1328
errors.NotADirectory(to_abs))
1330
# create rename entries and tuples
1331
for from_rel in from_paths:
1332
from_tail = splitpath(from_rel)[-1]
1333
from_id = inv.path2id(from_rel)
1335
raise errors.BzrMoveFailedError(from_rel,to_dir,
1336
errors.NotVersionedError(path=str(from_rel)))
1338
from_entry = inv[from_id]
1339
from_parent_id = from_entry.parent_id
1340
to_rel = pathjoin(to_dir, from_tail)
1341
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1343
from_tail=from_tail,
1344
from_parent_id=from_parent_id,
1345
to_rel=to_rel, to_tail=from_tail,
1346
to_parent_id=to_dir_id)
1347
rename_entries.append(rename_entry)
1348
rename_tuples.append((from_rel, to_rel))
1350
# determine which move mode to use. checks also for movability
1351
rename_entries = self._determine_mv_mode(rename_entries, after)
1353
original_modified = self._inventory_is_modified
1356
self._inventory_is_modified = True
1357
self._move(rename_entries)
1359
# restore the inventory on error
1360
self._inventory_is_modified = original_modified
1362
self._write_inventory(inv)
1363
return rename_tuples
1365
def _determine_mv_mode(self, rename_entries, after=False):
1366
"""Determines for each from-to pair if both inventory and working tree
1367
or only the inventory has to be changed.
1369
Also does basic plausability tests.
1371
inv = self.inventory
1373
for rename_entry in rename_entries:
1374
# store to local variables for easier reference
1375
from_rel = rename_entry.from_rel
1376
from_id = rename_entry.from_id
1377
to_rel = rename_entry.to_rel
1378
to_id = inv.path2id(to_rel)
1379
only_change_inv = False
1381
# check the inventory for source and destination
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.NotVersionedError(path=str(from_rel)))
1385
if to_id is not None:
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.AlreadyVersionedError(path=str(to_rel)))
1389
# try to determine the mode for rename (only change inv or change
1390
# inv and file system)
1392
if not self.has_filename(to_rel):
1393
raise errors.BzrMoveFailedError(from_id,to_rel,
1394
errors.NoSuchFile(path=str(to_rel),
1395
extra="New file has not been created yet"))
1396
only_change_inv = True
1397
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1398
only_change_inv = True
1399
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
only_change_inv = False
1401
elif (not self.case_sensitive
1402
and from_rel.lower() == to_rel.lower()
1403
and self.has_filename(from_rel)):
1404
only_change_inv = False
1406
# something is wrong, so lets determine what exactly
1407
if not self.has_filename(from_rel) and \
1408
not self.has_filename(to_rel):
1409
raise errors.BzrRenameFailedError(from_rel,to_rel,
1410
errors.PathsDoNotExist(paths=(str(from_rel),
1413
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1414
rename_entry.only_change_inv = only_change_inv
1415
return rename_entries
1417
def _move(self, rename_entries):
1418
"""Moves a list of files.
1420
Depending on the value of the flag 'only_change_inv', the
1421
file will be moved on the file system or not.
1423
inv = self.inventory
1426
for entry in rename_entries:
1428
self._move_entry(entry)
1430
self._rollback_move(moved)
1434
def _rollback_move(self, moved):
1435
"""Try to rollback a previous move in case of an filesystem error."""
1436
inv = self.inventory
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1441
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
entry.from_tail, entry.from_parent_id,
1443
entry.only_change_inv))
1444
except errors.BzrMoveFailedError, e:
1445
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1446
" The working tree is in an inconsistent state."
1447
" Please consider doing a 'bzr revert'."
1448
" Error message is: %s" % e)
1450
def _move_entry(self, entry):
1451
inv = self.inventory
1452
from_rel_abs = self.abspath(entry.from_rel)
1453
to_rel_abs = self.abspath(entry.to_rel)
1454
if from_rel_abs == to_rel_abs:
1455
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1456
"Source and target are identical.")
1458
if not entry.only_change_inv:
1460
osutils.rename(from_rel_abs, to_rel_abs)
1462
raise errors.BzrMoveFailedError(entry.from_rel,
1464
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1466
@needs_tree_write_lock
1467
def rename_one(self, from_rel, to_rel, after=False):
1470
This can change the directory or the filename or both.
1472
rename_one has several 'modes' to work. First, it can rename a physical
1473
file and change the file_id. That is the normal mode. Second, it can
1474
only change the file_id without touching any physical file. This is
1475
the new mode introduced in version 0.15.
1477
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1478
versioned but present in the working tree.
1480
rename_one uses the second mode if 'after == False' and 'from_rel' is
1481
versioned but no longer in the working tree, and 'to_rel' is not
1482
versioned but present in the working tree.
1484
rename_one uses the first mode if 'after == False' and 'from_rel' is
1485
versioned and present in the working tree, and 'to_rel' is not
1486
versioned and not present in the working tree.
1488
Everything else results in an error.
1490
inv = self.inventory
1493
# create rename entries and tuples
1494
from_tail = splitpath(from_rel)[-1]
1495
from_id = inv.path2id(from_rel)
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1508
from_parent_id = from_entry.parent_id
1509
to_dir, to_tail = os.path.split(to_rel)
1510
to_dir_id = inv.path2id(to_dir)
1511
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1513
from_tail=from_tail,
1514
from_parent_id=from_parent_id,
1515
to_rel=to_rel, to_tail=to_tail,
1516
to_parent_id=to_dir_id)
1517
rename_entries.append(rename_entry)
1519
# determine which move mode to use. checks also for movability
1520
rename_entries = self._determine_mv_mode(rename_entries, after)
1522
# check if the target changed directory and if the target directory is
1524
if to_dir_id is None:
1525
raise errors.BzrMoveFailedError(from_rel,to_rel,
1526
errors.NotVersionedError(path=str(to_dir)))
1528
# all checks done. now we can continue with our actual work
1529
mutter('rename_one:\n'
1534
' to_dir_id {%s}\n',
1535
from_id, from_rel, to_rel, to_dir, to_dir_id)
1537
self._move(rename_entries)
1538
self._write_inventory(inv)
1540
class _RenameEntry(object):
1541
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1542
to_rel, to_tail, to_parent_id, only_change_inv=False):
1543
self.from_rel = from_rel
1544
self.from_id = from_id
1545
self.from_tail = from_tail
1546
self.from_parent_id = from_parent_id
1547
self.to_rel = to_rel
1548
self.to_tail = to_tail
1549
self.to_parent_id = to_parent_id
1550
self.only_change_inv = only_change_inv
1554
"""Return all unknown files.
1556
These are files in the working directory that are not versioned or
1557
control files or ignored.
1559
# force the extras method to be fully executed before returning, to
1560
# prevent race conditions with the lock
1562
[subp for subp in self.extras() if not self.is_ignored(subp)])
1564
@needs_tree_write_lock
1565
def unversion(self, file_ids):
1566
"""Remove the file ids in file_ids from the current versioned set.
1568
When a file_id is unversioned, all of its children are automatically
1571
:param file_ids: The file ids to stop versioning.
1572
:raises: NoSuchId if any fileid is not currently versioned.
1574
for file_id in file_ids:
1575
if file_id not in self._inventory:
1576
raise errors.NoSuchId(self, file_id)
1577
for file_id in file_ids:
1578
if self._inventory.has_id(file_id):
1579
self._inventory.remove_recursive_id(file_id)
1581
# in the future this should just set a dirty bit to wait for the
1582
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1584
# a read, it is more complex - we need to teach read_inventory
1585
# to know when to read, and when to not read first... and possibly
1586
# to save first when the in memory one may be corrupted.
1587
# so for now, we just only write it if it is indeed dirty.
1589
self._write_inventory(self._inventory)
1591
def _iter_conflicts(self):
1593
for info in self.list_files():
1595
stem = get_conflicted_stem(path)
1598
if stem not in conflicted:
1599
conflicted.add(stem)
1603
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
1607
old_revision_info = self.branch.last_revision_info()
1608
basis_tree = self.basis_tree()
1609
count = self.branch.pull(source, overwrite, stop_revision,
1610
possible_transports=possible_transports,
1612
new_revision_info = self.branch.last_revision_info()
1613
if new_revision_info != old_revision_info:
1614
repository = self.branch.repository
1615
basis_tree.lock_read()
1617
new_basis_tree = self.branch.basis_tree()
1624
change_reporter=change_reporter)
1625
basis_root_id = basis_tree.get_root_id()
1626
new_root_id = new_basis_tree.get_root_id()
1627
if basis_root_id != new_root_id:
1628
self.set_root_id(new_root_id)
1631
# TODO - dedup parents list with things merged by pull ?
1632
# reuse the revisiontree we merged against to set the new
1634
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
# we have to pull the merge trees out again, because
1636
# merge_inner has set the ids. - this corner is not yet
1637
# layered well enough to prevent double handling.
1638
# XXX TODO: Fix the double handling: telling the tree about
1639
# the already known parent data is wasteful.
1640
merges = self.get_parent_ids()[1:]
1641
parent_trees.extend([
1642
(parent, repository.revision_tree(parent)) for
1644
self.set_parent_trees(parent_trees)
1650
def put_file_bytes_non_atomic(self, file_id, bytes):
1651
"""See MutableTree.put_file_bytes_non_atomic."""
1652
stream = file(self.id2abspath(file_id), 'wb')
1657
# TODO: update the hashcache here ?
1660
"""Yield all unversioned files in this WorkingTree.
1662
If there are any unversioned directories then only the directory is
1663
returned, not all its children. But if there are unversioned files
1664
under a versioned subdirectory, they are returned.
1666
Currently returned depth-first, sorted by name within directories.
1667
This is the same order used by 'osutils.walkdirs'.
1669
## TODO: Work from given directory downwards
1670
for path, dir_entry in self.inventory.directories():
1671
# mutter("search for unknowns in %r", path)
1672
dirabs = self.abspath(path)
1673
if not isdir(dirabs):
1674
# e.g. directory deleted
1678
for subf in os.listdir(dirabs):
1679
if self.bzrdir.is_control_filename(subf):
1681
if subf not in dir_entry.children:
1684
can_access) = osutils.normalized_filename(subf)
1685
except UnicodeDecodeError:
1686
path_os_enc = path.encode(osutils._fs_enc)
1687
relpath = path_os_enc + '/' + subf
1688
raise errors.BadFilenameEncoding(relpath,
1690
if subf_norm != subf and can_access:
1691
if subf_norm not in dir_entry.children:
1692
fl.append(subf_norm)
1698
subp = pathjoin(path, subf)
1701
def ignored_files(self):
1702
"""Yield list of PATH, IGNORE_PATTERN"""
1703
for subp in self.extras():
1704
pat = self.is_ignored(subp)
1708
def get_ignore_list(self):
1709
"""Return list of ignore patterns.
1711
Cached in the Tree object after the first call.
1713
ignoreset = getattr(self, '_ignoreset', None)
1714
if ignoreset is not None:
1717
ignore_globs = set()
1718
ignore_globs.update(ignores.get_runtime_ignores())
1719
ignore_globs.update(ignores.get_user_ignores())
1720
if self.has_filename(bzrlib.IGNORE_FILENAME):
1721
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1723
ignore_globs.update(ignores.parse_ignore_file(f))
1726
self._ignoreset = ignore_globs
1729
def _flush_ignore_list_cache(self):
1730
"""Resets the cached ignore list to force a cache rebuild."""
1731
self._ignoreset = None
1732
self._ignoreglobster = None
1734
def is_ignored(self, filename):
1735
r"""Check whether the filename matches an ignore pattern.
1737
Patterns containing '/' or '\' need to match the whole path;
1738
others match against only the last component. Patterns starting
1739
with '!' are ignore exceptions. Exceptions take precedence
1740
over regular patterns and cause the filename to not be ignored.
1742
If the file is ignored, returns the pattern which caused it to
1743
be ignored, otherwise None. So this can simply be used as a
1744
boolean if desired."""
1745
if getattr(self, '_ignoreglobster', None) is None:
1746
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1747
return self._ignoreglobster.match(filename)
1749
def kind(self, file_id):
1750
return file_kind(self.id2abspath(file_id))
1752
def stored_kind(self, file_id):
1753
"""See Tree.stored_kind"""
1754
return self.inventory[file_id].kind
1756
def _comparison_data(self, entry, path):
1757
abspath = self.abspath(path)
1759
stat_value = os.lstat(abspath)
1761
if getattr(e, 'errno', None) == errno.ENOENT:
1768
mode = stat_value.st_mode
1769
kind = osutils.file_kind_from_stat_mode(mode)
1770
if not supports_executable():
1771
executable = entry is not None and entry.executable
1773
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1774
return kind, executable, stat_value
1776
def _file_size(self, entry, stat_value):
1777
return stat_value.st_size
1779
def last_revision(self):
1780
"""Return the last revision of the branch for this tree.
1782
This format tree does not support a separate marker for last-revision
1783
compared to the branch.
1785
See MutableTree.last_revision
1787
return self._last_revision()
1790
def _last_revision(self):
1791
"""helper for get_parent_ids."""
1792
return _mod_revision.ensure_null(self.branch.last_revision())
1794
def is_locked(self):
1795
return self._control_files.is_locked()
1797
def _must_be_locked(self):
1798
if not self.is_locked():
1799
raise errors.ObjectNotLocked(self)
1801
def lock_read(self):
1802
"""See Branch.lock_read, and WorkingTree.unlock."""
1803
if not self.is_locked():
1805
self.branch.lock_read()
1807
return self._control_files.lock_read()
1809
self.branch.unlock()
1812
def lock_tree_write(self):
1813
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1814
if not self.is_locked():
1816
self.branch.lock_read()
1818
return self._control_files.lock_write()
1820
self.branch.unlock()
1823
def lock_write(self):
1824
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1825
if not self.is_locked():
1827
self.branch.lock_write()
1829
return self._control_files.lock_write()
1831
self.branch.unlock()
1834
def get_physical_lock_status(self):
1835
return self._control_files.get_physical_lock_status()
1837
def _basis_inventory_name(self):
1838
return 'basis-inventory-cache'
1840
def _reset_data(self):
1841
"""Reset transient data that cannot be revalidated."""
1842
self._inventory_is_modified = False
1843
f = self._transport.get('inventory')
1845
result = self._deserialize(f)
1848
self._set_inventory(result, dirty=False)
1850
@needs_tree_write_lock
1851
def set_last_revision(self, new_revision):
1852
"""Change the last revision in the working tree."""
1853
if self._change_last_revision(new_revision):
1854
self._cache_basis_inventory(new_revision)
1856
def _change_last_revision(self, new_revision):
1857
"""Template method part of set_last_revision to perform the change.
1859
This is used to allow WorkingTree3 instances to not affect branch
1860
when their last revision is set.
1862
if _mod_revision.is_null(new_revision):
1863
self.branch.set_revision_history([])
1866
self.branch.generate_revision_history(new_revision)
1867
except errors.NoSuchRevision:
1868
# not present in the repo - dont try to set it deeper than the tip
1869
self.branch.set_revision_history([new_revision])
1872
def _write_basis_inventory(self, xml):
1873
"""Write the basis inventory XML to the basis-inventory file"""
1874
path = self._basis_inventory_name()
1876
self._transport.put_file(path, sio,
1877
mode=self.bzrdir._get_file_mode())
1879
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1880
"""Create the text that will be saved in basis-inventory"""
1881
inventory.revision_id = revision_id
1882
return xml7.serializer_v7.write_inventory_to_string(inventory)
1884
def _cache_basis_inventory(self, new_revision):
1885
"""Cache new_revision as the basis inventory."""
1886
# TODO: this should allow the ready-to-use inventory to be passed in,
1887
# as commit already has that ready-to-use [while the format is the
1890
# this double handles the inventory - unpack and repack -
1891
# but is easier to understand. We can/should put a conditional
1892
# in here based on whether the inventory is in the latest format
1893
# - perhaps we should repack all inventories on a repository
1895
# the fast path is to copy the raw xml from the repository. If the
1896
# xml contains 'revision_id="', then we assume the right
1897
# revision_id is set. We must check for this full string, because a
1898
# root node id can legitimately look like 'revision_id' but cannot
1900
xml = self.branch.repository._get_inventory_xml(new_revision)
1901
firstline = xml.split('\n', 1)[0]
1902
if (not 'revision_id="' in firstline or
1903
'format="7"' not in firstline):
1904
inv = self.branch.repository._serializer.read_inventory_from_string(
1906
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1907
self._write_basis_inventory(xml)
1908
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1911
def read_basis_inventory(self):
1912
"""Read the cached basis inventory."""
1913
path = self._basis_inventory_name()
1914
return self._transport.get_bytes(path)
1917
def read_working_inventory(self):
1918
"""Read the working inventory.
1920
:raises errors.InventoryModified: read_working_inventory will fail
1921
when the current in memory inventory has been modified.
1923
# conceptually this should be an implementation detail of the tree.
1924
# XXX: Deprecate this.
1925
# ElementTree does its own conversion from UTF-8, so open in
1927
if self._inventory_is_modified:
1928
raise errors.InventoryModified(self)
1929
f = self._transport.get('inventory')
1931
result = self._deserialize(f)
1934
self._set_inventory(result, dirty=False)
1937
@needs_tree_write_lock
1938
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1940
"""Remove nominated files from the working inventory.
1942
:files: File paths relative to the basedir.
1943
:keep_files: If true, the files will also be kept.
1944
:force: Delete files and directories, even if they are changed and
1945
even if the directories are not empty.
1947
if isinstance(files, basestring):
1953
unknown_nested_files=set()
1955
to_file = sys.stdout
1957
def recurse_directory_to_add_files(directory):
1958
# Recurse directory and add all files
1959
# so we can check if they have changed.
1960
for parent_info, file_infos in\
1961
self.walkdirs(directory):
1962
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1963
# Is it versioned or ignored?
1964
if self.path2id(relpath) or self.is_ignored(relpath):
1965
# Add nested content for deletion.
1966
new_files.add(relpath)
1968
# Files which are not versioned and not ignored
1969
# should be treated as unknown.
1970
unknown_nested_files.add((relpath, None, kind))
1972
for filename in files:
1973
# Get file name into canonical form.
1974
abspath = self.abspath(filename)
1975
filename = self.relpath(abspath)
1976
if len(filename) > 0:
1977
new_files.add(filename)
1978
recurse_directory_to_add_files(filename)
1980
files = list(new_files)
1983
return # nothing to do
1985
# Sort needed to first handle directory content before the directory
1986
files.sort(reverse=True)
1988
# Bail out if we are going to delete files we shouldn't
1989
if not keep_files and not force:
1990
has_changed_files = len(unknown_nested_files) > 0
1991
if not has_changed_files:
1992
for (file_id, path, content_change, versioned, parent_id, name,
1993
kind, executable) in self.iter_changes(self.basis_tree(),
1994
include_unchanged=True, require_versioned=False,
1995
want_unversioned=True, specific_files=files):
1996
if versioned == (False, False):
1997
# The record is unknown ...
1998
if not self.is_ignored(path[1]):
1999
# ... but not ignored
2000
has_changed_files = True
2002
elif content_change and (kind[1] is not None):
2003
# Versioned and changed, but not deleted
2004
has_changed_files = True
2007
if has_changed_files:
2008
# Make delta show ALL applicable changes in error message.
2009
tree_delta = self.changes_from(self.basis_tree(),
2010
require_versioned=False, want_unversioned=True,
2011
specific_files=files)
2012
for unknown_file in unknown_nested_files:
2013
if unknown_file not in tree_delta.unversioned:
2014
tree_delta.unversioned.extend((unknown_file,))
2015
raise errors.BzrRemoveChangedFilesError(tree_delta)
2017
# Build inv_delta and delete files where applicable,
2018
# do this before any modifications to inventory.
2020
fid = self.path2id(f)
2023
message = "%s is not versioned." % (f,)
2026
# having removed it, it must be either ignored or unknown
2027
if self.is_ignored(f):
2031
# XXX: Really should be a more abstract reporter interface
2032
kind_ch = osutils.kind_marker(self.kind(fid))
2033
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2035
inv_delta.append((f, None, fid, None))
2036
message = "removed %s" % (f,)
2039
abs_path = self.abspath(f)
2040
if osutils.lexists(abs_path):
2041
if (osutils.isdir(abs_path) and
2042
len(os.listdir(abs_path)) > 0):
2044
osutils.rmtree(abs_path)
2046
message = "%s is not an empty directory "\
2047
"and won't be deleted." % (f,)
2049
osutils.delete_any(abs_path)
2050
message = "deleted %s" % (f,)
2051
elif message is not None:
2052
# Only care if we haven't done anything yet.
2053
message = "%s does not exist." % (f,)
2055
# Print only one message (if any) per file.
2056
if message is not None:
2058
self.apply_inventory_delta(inv_delta)
2060
@needs_tree_write_lock
2061
def revert(self, filenames=None, old_tree=None, backups=True,
2062
pb=None, report_changes=False):
2063
from bzrlib.conflicts import resolve
2066
symbol_versioning.warn('Using [] to revert all files is deprecated'
2067
' as of bzr 0.91. Please use None (the default) instead.',
2068
DeprecationWarning, stacklevel=2)
2069
if old_tree is None:
2070
basis_tree = self.basis_tree()
2071
basis_tree.lock_read()
2072
old_tree = basis_tree
2076
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2078
if filenames is None and len(self.get_parent_ids()) > 1:
2080
last_revision = self.last_revision()
2081
if last_revision != _mod_revision.NULL_REVISION:
2082
if basis_tree is None:
2083
basis_tree = self.basis_tree()
2084
basis_tree.lock_read()
2085
parent_trees.append((last_revision, basis_tree))
2086
self.set_parent_trees(parent_trees)
2089
resolve(self, filenames, ignore_misses=True, recursive=True)
2091
if basis_tree is not None:
2095
def revision_tree(self, revision_id):
2096
"""See Tree.revision_tree.
2098
WorkingTree can supply revision_trees for the basis revision only
2099
because there is only one cached inventory in the bzr directory.
2101
if revision_id == self.last_revision():
2103
xml = self.read_basis_inventory()
2104
except errors.NoSuchFile:
2108
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2109
# dont use the repository revision_tree api because we want
2110
# to supply the inventory.
2111
if inv.revision_id == revision_id:
2112
return revisiontree.RevisionTree(self.branch.repository,
2114
except errors.BadInventoryFormat:
2116
# raise if there was no inventory, or if we read the wrong inventory.
2117
raise errors.NoSuchRevisionInTree(self, revision_id)
2119
# XXX: This method should be deprecated in favour of taking in a proper
2120
# new Inventory object.
2121
@needs_tree_write_lock
2122
def set_inventory(self, new_inventory_list):
2123
from bzrlib.inventory import (Inventory,
2127
inv = Inventory(self.get_root_id())
2128
for path, file_id, parent, kind in new_inventory_list:
2129
name = os.path.basename(path)
2132
# fixme, there should be a factory function inv,add_??
2133
if kind == 'directory':
2134
inv.add(InventoryDirectory(file_id, name, parent))
2135
elif kind == 'file':
2136
inv.add(InventoryFile(file_id, name, parent))
2137
elif kind == 'symlink':
2138
inv.add(InventoryLink(file_id, name, parent))
2140
raise errors.BzrError("unknown kind %r" % kind)
2141
self._write_inventory(inv)
2143
@needs_tree_write_lock
2144
def set_root_id(self, file_id):
2145
"""Set the root id for this tree."""
2149
'WorkingTree.set_root_id with fileid=None')
2150
file_id = osutils.safe_file_id(file_id)
2151
self._set_root_id(file_id)
2153
def _set_root_id(self, file_id):
2154
"""Set the root id for this tree, in a format specific manner.
2156
:param file_id: The file id to assign to the root. It must not be
2157
present in the current inventory or an error will occur. It must
2158
not be None, but rather a valid file id.
2160
inv = self._inventory
2161
orig_root_id = inv.root.file_id
2162
# TODO: it might be nice to exit early if there was nothing
2163
# to do, saving us from trigger a sync on unlock.
2164
self._inventory_is_modified = True
2165
# we preserve the root inventory entry object, but
2166
# unlinkit from the byid index
2167
del inv._byid[inv.root.file_id]
2168
inv.root.file_id = file_id
2169
# and link it into the index with the new changed id.
2170
inv._byid[inv.root.file_id] = inv.root
2171
# and finally update all children to reference the new id.
2172
# XXX: this should be safe to just look at the root.children
2173
# list, not the WHOLE INVENTORY.
2176
if entry.parent_id == orig_root_id:
2177
entry.parent_id = inv.root.file_id
2180
"""See Branch.unlock.
2182
WorkingTree locking just uses the Branch locking facilities.
2183
This is current because all working trees have an embedded branch
2184
within them. IF in the future, we were to make branch data shareable
2185
between multiple working trees, i.e. via shared storage, then we
2186
would probably want to lock both the local tree, and the branch.
2188
raise NotImplementedError(self.unlock)
2192
def update(self, change_reporter=None, possible_transports=None,
2193
revision=None, old_tip=_marker):
2194
"""Update a working tree along its branch.
2196
This will update the branch if its bound too, which means we have
2197
multiple trees involved:
2199
- The new basis tree of the master.
2200
- The old basis tree of the branch.
2201
- The old basis tree of the working tree.
2202
- The current working tree state.
2204
Pathologically, all three may be different, and non-ancestors of each
2205
other. Conceptually we want to:
2207
- Preserve the wt.basis->wt.state changes
2208
- Transform the wt.basis to the new master basis.
2209
- Apply a merge of the old branch basis to get any 'local' changes from
2211
- Restore the wt.basis->wt.state changes.
2213
There isn't a single operation at the moment to do that, so we:
2214
- Merge current state -> basis tree of the master w.r.t. the old tree
2216
- Do a 'normal' merge of the old branch basis if it is relevant.
2218
:param revision: The target revision to update to. Must be in the
2220
:param old_tip: If branch.update() has already been run, the value it
2221
returned (old tip of the branch or None). _marker is used
2224
if self.branch.get_bound_location() is not None:
2226
update_branch = (old_tip is self._marker)
2228
self.lock_tree_write()
2229
update_branch = False
2232
old_tip = self.branch.update(possible_transports)
2234
if old_tip is self._marker:
2236
return self._update_tree(old_tip, change_reporter, revision)
2240
@needs_tree_write_lock
2241
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2242
"""Update a tree to the master branch.
2244
:param old_tip: if supplied, the previous tip revision the branch,
2245
before it was changed to the master branch's tip.
2247
# here if old_tip is not None, it is the old tip of the branch before
2248
# it was updated from the master branch. This should become a pending
2249
# merge in the working tree to preserve the user existing work. we
2250
# cant set that until we update the working trees last revision to be
2251
# one from the new branch, because it will just get absorbed by the
2252
# parent de-duplication logic.
2254
# We MUST save it even if an error occurs, because otherwise the users
2255
# local work is unreferenced and will appear to have been lost.
2259
last_rev = self.get_parent_ids()[0]
2261
last_rev = _mod_revision.NULL_REVISION
2262
if revision is None:
2263
revision = self.branch.last_revision()
2265
old_tip = old_tip or _mod_revision.NULL_REVISION
2267
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2268
# the branch we are bound to was updated
2269
# merge those changes in first
2270
base_tree = self.basis_tree()
2271
other_tree = self.branch.repository.revision_tree(old_tip)
2272
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2273
base_tree, this_tree=self,
2274
change_reporter=change_reporter)
2276
self.add_parent_tree((old_tip, other_tree))
2277
trace.note('Rerun update after fixing the conflicts.')
2280
if last_rev != _mod_revision.ensure_null(revision):
2281
# the working tree is up to date with the branch
2282
# we can merge the specified revision from master
2283
to_tree = self.branch.repository.revision_tree(revision)
2284
to_root_id = to_tree.get_root_id()
2286
basis = self.basis_tree()
2289
if (basis.inventory.root is None
2290
or basis.inventory.root.file_id != to_root_id):
2291
self.set_root_id(to_root_id)
2296
# determine the branch point
2297
graph = self.branch.repository.get_graph()
2298
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2300
base_tree = self.branch.repository.revision_tree(base_rev_id)
2302
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2304
change_reporter=change_reporter)
2305
self.set_last_revision(revision)
2306
# TODO - dedup parents list with things merged by pull ?
2307
# reuse the tree we've updated to to set the basis:
2308
parent_trees = [(revision, to_tree)]
2309
merges = self.get_parent_ids()[1:]
2310
# Ideally we ask the tree for the trees here, that way the working
2311
# tree can decide whether to give us the entire tree or give us a
2312
# lazy initialised tree. dirstate for instance will have the trees
2313
# in ram already, whereas a last-revision + basis-inventory tree
2314
# will not, but also does not need them when setting parents.
2315
for parent in merges:
2316
parent_trees.append(
2317
(parent, self.branch.repository.revision_tree(parent)))
2318
if not _mod_revision.is_null(old_tip):
2319
parent_trees.append(
2320
(old_tip, self.branch.repository.revision_tree(old_tip)))
2321
self.set_parent_trees(parent_trees)
2322
last_rev = parent_trees[0][0]
2325
def _write_hashcache_if_dirty(self):
2326
"""Write out the hashcache if it is dirty."""
2327
if self._hashcache.needs_write:
2329
self._hashcache.write()
2331
if e.errno not in (errno.EPERM, errno.EACCES):
2333
# TODO: jam 20061219 Should this be a warning? A single line
2334
# warning might be sufficient to let the user know what
2336
mutter('Could not write hashcache for %s\nError: %s',
2337
self._hashcache.cache_file_name(), e)
2339
@needs_tree_write_lock
2340
def _write_inventory(self, inv):
2341
"""Write inventory as the current inventory."""
2342
self._set_inventory(inv, dirty=True)
2345
def set_conflicts(self, arg):
2346
raise errors.UnsupportedOperation(self.set_conflicts, self)
2348
def add_conflicts(self, arg):
2349
raise errors.UnsupportedOperation(self.add_conflicts, self)
2352
def conflicts(self):
2353
conflicts = _mod_conflicts.ConflictList()
2354
for conflicted in self._iter_conflicts():
2357
if file_kind(self.abspath(conflicted)) != "file":
2359
except errors.NoSuchFile:
2362
for suffix in ('.THIS', '.OTHER'):
2364
kind = file_kind(self.abspath(conflicted+suffix))
2367
except errors.NoSuchFile:
2371
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2372
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2374
file_id=self.path2id(conflicted)))
2377
def walkdirs(self, prefix=""):
2378
"""Walk the directories of this tree.
2380
returns a generator which yields items in the form:
2381
((curren_directory_path, fileid),
2382
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2385
This API returns a generator, which is only valid during the current
2386
tree transaction - within a single lock_read or lock_write duration.
2388
If the tree is not locked, it may cause an error to be raised,
2389
depending on the tree implementation.
2391
disk_top = self.abspath(prefix)
2392
if disk_top.endswith('/'):
2393
disk_top = disk_top[:-1]
2394
top_strip_len = len(disk_top) + 1
2395
inventory_iterator = self._walkdirs(prefix)
2396
disk_iterator = osutils.walkdirs(disk_top, prefix)
2398
current_disk = disk_iterator.next()
2399
disk_finished = False
2401
if not (e.errno == errno.ENOENT or
2402
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2405
disk_finished = True
2407
current_inv = inventory_iterator.next()
2408
inv_finished = False
2409
except StopIteration:
2412
while not inv_finished or not disk_finished:
2414
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2415
cur_disk_dir_content) = current_disk
2417
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2418
cur_disk_dir_content) = ((None, None), None)
2419
if not disk_finished:
2420
# strip out .bzr dirs
2421
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2422
len(cur_disk_dir_content) > 0):
2423
# osutils.walkdirs can be made nicer -
2424
# yield the path-from-prefix rather than the pathjoined
2426
bzrdir_loc = bisect_left(cur_disk_dir_content,
2428
if (bzrdir_loc < len(cur_disk_dir_content)
2429
and self.bzrdir.is_control_filename(
2430
cur_disk_dir_content[bzrdir_loc][0])):
2431
# we dont yield the contents of, or, .bzr itself.
2432
del cur_disk_dir_content[bzrdir_loc]
2434
# everything is unknown
2437
# everything is missing
2440
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2442
# disk is before inventory - unknown
2443
dirblock = [(relpath, basename, kind, stat, None, None) for
2444
relpath, basename, kind, stat, top_path in
2445
cur_disk_dir_content]
2446
yield (cur_disk_dir_relpath, None), dirblock
2448
current_disk = disk_iterator.next()
2449
except StopIteration:
2450
disk_finished = True
2452
# inventory is before disk - missing.
2453
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2454
for relpath, basename, dkind, stat, fileid, kind in
2456
yield (current_inv[0][0], current_inv[0][1]), dirblock
2458
current_inv = inventory_iterator.next()
2459
except StopIteration:
2462
# versioned present directory
2463
# merge the inventory and disk data together
2465
for relpath, subiterator in itertools.groupby(sorted(
2466
current_inv[1] + cur_disk_dir_content,
2467
key=operator.itemgetter(0)), operator.itemgetter(1)):
2468
path_elements = list(subiterator)
2469
if len(path_elements) == 2:
2470
inv_row, disk_row = path_elements
2471
# versioned, present file
2472
dirblock.append((inv_row[0],
2473
inv_row[1], disk_row[2],
2474
disk_row[3], inv_row[4],
2476
elif len(path_elements[0]) == 5:
2478
dirblock.append((path_elements[0][0],
2479
path_elements[0][1], path_elements[0][2],
2480
path_elements[0][3], None, None))
2481
elif len(path_elements[0]) == 6:
2482
# versioned, absent file.
2483
dirblock.append((path_elements[0][0],
2484
path_elements[0][1], 'unknown', None,
2485
path_elements[0][4], path_elements[0][5]))
2487
raise NotImplementedError('unreachable code')
2488
yield current_inv[0], dirblock
2490
current_inv = inventory_iterator.next()
2491
except StopIteration:
2494
current_disk = disk_iterator.next()
2495
except StopIteration:
2496
disk_finished = True
2498
def _walkdirs(self, prefix=""):
2499
"""Walk the directories of this tree.
2501
:prefix: is used as the directrory to start with.
2502
returns a generator which yields items in the form:
2503
((curren_directory_path, fileid),
2504
[(file1_path, file1_name, file1_kind, None, file1_id,
2507
_directory = 'directory'
2508
# get the root in the inventory
2509
inv = self.inventory
2510
top_id = inv.path2id(prefix)
2514
pending = [(prefix, '', _directory, None, top_id, None)]
2517
currentdir = pending.pop()
2518
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2519
top_id = currentdir[4]
2521
relroot = currentdir[0] + '/'
2524
# FIXME: stash the node in pending
2526
if entry.kind == 'directory':
2527
for name, child in entry.sorted_children():
2528
dirblock.append((relroot + name, name, child.kind, None,
2529
child.file_id, child.kind
2531
yield (currentdir[0], entry.file_id), dirblock
2532
# push the user specified dirs from dirblock
2533
for dir in reversed(dirblock):
2534
if dir[2] == _directory:
2537
@needs_tree_write_lock
2538
def auto_resolve(self):
2539
"""Automatically resolve text conflicts according to contents.
2541
Only text conflicts are auto_resolvable. Files with no conflict markers
2542
are considered 'resolved', because bzr always puts conflict markers
2543
into files that have text conflicts. The corresponding .THIS .BASE and
2544
.OTHER files are deleted, as per 'resolve'.
2545
:return: a tuple of ConflictLists: (un_resolved, resolved).
2547
un_resolved = _mod_conflicts.ConflictList()
2548
resolved = _mod_conflicts.ConflictList()
2549
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2550
for conflict in self.conflicts():
2551
if (conflict.typestring != 'text conflict' or
2552
self.kind(conflict.file_id) != 'file'):
2553
un_resolved.append(conflict)
2555
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2557
for line in my_file:
2558
if conflict_re.search(line):
2559
un_resolved.append(conflict)
2562
resolved.append(conflict)
2565
resolved.remove_files(self)
2566
self.set_conflicts(un_resolved)
2567
return un_resolved, resolved
2570
def _check(self, references):
2571
"""Check the tree for consistency.
2573
:param references: A dict with keys matching the items returned by
2574
self._get_check_refs(), and values from looking those keys up in
2577
tree_basis = self.basis_tree()
2578
tree_basis.lock_read()
2580
repo_basis = references[('trees', self.last_revision())]
2581
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2582
raise errors.BzrCheckError(
2583
"Mismatched basis inventory content.")
2588
def _validate(self):
2589
"""Validate internal structures.
2591
This is meant mostly for the test suite. To give it a chance to detect
2592
corruption after actions have occurred. The default implementation is a
2595
:return: None. An exception should be raised if there is an error.
2599
def _get_rules_searcher(self, default_searcher):
2600
"""See Tree._get_rules_searcher."""
2601
if self._rules_searcher is None:
2602
self._rules_searcher = super(WorkingTree,
2603
self)._get_rules_searcher(default_searcher)
2604
return self._rules_searcher
2606
def get_shelf_manager(self):
2607
"""Return the ShelfManager for this WorkingTree."""
2608
from bzrlib.shelf import ShelfManager
2609
return ShelfManager(self, self._transport)
2612
class WorkingTree2(WorkingTree):
2613
"""This is the Format 2 working tree.
2615
This was the first weave based working tree.
2616
- uses os locks for locking.
2617
- uses the branch last-revision.
2620
def __init__(self, *args, **kwargs):
2621
super(WorkingTree2, self).__init__(*args, **kwargs)
2622
# WorkingTree2 has more of a constraint that self._inventory must
2623
# exist. Because this is an older format, we don't mind the overhead
2624
# caused by the extra computation here.
2626
# Newer WorkingTree's should only have self._inventory set when they
2628
if self._inventory is None:
2629
self.read_working_inventory()
2631
def _get_check_refs(self):
2632
"""Return the references needed to perform a check of this tree."""
2633
return [('trees', self.last_revision())]
2635
def lock_tree_write(self):
2636
"""See WorkingTree.lock_tree_write().
2638
In Format2 WorkingTrees we have a single lock for the branch and tree
2639
so lock_tree_write() degrades to lock_write().
2641
self.branch.lock_write()
2643
return self._control_files.lock_write()
2645
self.branch.unlock()
2649
# do non-implementation specific cleanup
2652
# we share control files:
2653
if self._control_files._lock_count == 3:
2654
# _inventory_is_modified is always False during a read lock.
2655
if self._inventory_is_modified:
2657
self._write_hashcache_if_dirty()
2659
# reverse order of locking.
2661
return self._control_files.unlock()
2663
self.branch.unlock()
2666
class WorkingTree3(WorkingTree):
2667
"""This is the Format 3 working tree.
2669
This differs from the base WorkingTree by:
2670
- having its own file lock
2671
- having its own last-revision property.
2673
This is new in bzr 0.8
2677
def _last_revision(self):
2678
"""See Mutable.last_revision."""
2680
return self._transport.get_bytes('last-revision')
2681
except errors.NoSuchFile:
2682
return _mod_revision.NULL_REVISION
2684
def _change_last_revision(self, revision_id):
2685
"""See WorkingTree._change_last_revision."""
2686
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2688
self._transport.delete('last-revision')
2689
except errors.NoSuchFile:
2693
self._transport.put_bytes('last-revision', revision_id,
2694
mode=self.bzrdir._get_file_mode())
2697
def _get_check_refs(self):
2698
"""Return the references needed to perform a check of this tree."""
2699
return [('trees', self.last_revision())]
2701
@needs_tree_write_lock
2702
def set_conflicts(self, conflicts):
2703
self._put_rio('conflicts', conflicts.to_stanzas(),
2706
@needs_tree_write_lock
2707
def add_conflicts(self, new_conflicts):
2708
conflict_set = set(self.conflicts())
2709
conflict_set.update(set(list(new_conflicts)))
2710
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2711
key=_mod_conflicts.Conflict.sort_key)))
2714
def conflicts(self):
2716
confile = self._transport.get('conflicts')
2717
except errors.NoSuchFile:
2718
return _mod_conflicts.ConflictList()
2721
if confile.next() != CONFLICT_HEADER_1 + '\n':
2722
raise errors.ConflictFormatError()
2723
except StopIteration:
2724
raise errors.ConflictFormatError()
2725
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2730
# do non-implementation specific cleanup
2732
if self._control_files._lock_count == 1:
2733
# _inventory_is_modified is always False during a read lock.
2734
if self._inventory_is_modified:
2736
self._write_hashcache_if_dirty()
2737
# reverse order of locking.
2739
return self._control_files.unlock()
2741
self.branch.unlock()
2744
def get_conflicted_stem(path):
2745
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2746
if path.endswith(suffix):
2747
return path[:-len(suffix)]
2750
class WorkingTreeFormat(object):
2751
"""An encapsulation of the initialization and open routines for a format.
2753
Formats provide three things:
2754
* An initialization routine,
2758
Formats are placed in an dict by their format string for reference
2759
during workingtree opening. Its not required that these be instances, they
2760
can be classes themselves with class methods - it simply depends on
2761
whether state is needed for a given format or not.
2763
Once a format is deprecated, just deprecate the initialize and open
2764
methods on the format class. Do not deprecate the object, as the
2765
object will be created every time regardless.
2768
_default_format = None
2769
"""The default format used for new trees."""
2772
"""The known formats."""
2774
requires_rich_root = False
2776
upgrade_recommended = False
2779
def find_format(klass, a_bzrdir):
2780
"""Return the format for the working tree object in a_bzrdir."""
2782
transport = a_bzrdir.get_workingtree_transport(None)
2783
format_string = transport.get_bytes("format")
2784
return klass._formats[format_string]
2785
except errors.NoSuchFile:
2786
raise errors.NoWorkingTree(base=transport.base)
2788
raise errors.UnknownFormatError(format=format_string,
2789
kind="working tree")
2791
def __eq__(self, other):
2792
return self.__class__ is other.__class__
2794
def __ne__(self, other):
2795
return not (self == other)
2798
def get_default_format(klass):
2799
"""Return the current default format."""
2800
return klass._default_format
2802
def get_format_string(self):
2803
"""Return the ASCII format string that identifies this format."""
2804
raise NotImplementedError(self.get_format_string)
2806
def get_format_description(self):
2807
"""Return the short description for this format."""
2808
raise NotImplementedError(self.get_format_description)
2810
def is_supported(self):
2811
"""Is this format supported?
2813
Supported formats can be initialized and opened.
2814
Unsupported formats may not support initialization or committing or
2815
some other features depending on the reason for not being supported.
2819
def supports_content_filtering(self):
2820
"""True if this format supports content filtering."""
2823
def supports_views(self):
2824
"""True if this format supports stored views."""
2828
def register_format(klass, format):
2829
klass._formats[format.get_format_string()] = format
2832
def set_default_format(klass, format):
2833
klass._default_format = format
2836
def unregister_format(klass, format):
2837
del klass._formats[format.get_format_string()]
2840
class WorkingTreeFormat2(WorkingTreeFormat):
2841
"""The second working tree format.
2843
This format modified the hash cache from the format 1 hash cache.
2846
upgrade_recommended = True
2848
def get_format_description(self):
2849
"""See WorkingTreeFormat.get_format_description()."""
2850
return "Working tree format 2"
2852
def _stub_initialize_on_transport(self, transport, file_mode):
2853
"""Workaround: create control files for a remote working tree.
2855
This ensures that it can later be updated and dealt with locally,
2856
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2857
no working tree. (See bug #43064).
2860
inv = inventory.Inventory()
2861
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2863
transport.put_file('inventory', sio, file_mode)
2864
transport.put_bytes('pending-merges', '', file_mode)
2866
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2867
accelerator_tree=None, hardlink=False):
2868
"""See WorkingTreeFormat.initialize()."""
2869
if not isinstance(a_bzrdir.transport, LocalTransport):
2870
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2871
if from_branch is not None:
2872
branch = from_branch
2874
branch = a_bzrdir.open_branch()
2875
if revision_id is None:
2876
revision_id = _mod_revision.ensure_null(branch.last_revision())
2879
branch.generate_revision_history(revision_id)
2882
inv = inventory.Inventory()
2883
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2889
basis_tree = branch.repository.revision_tree(revision_id)
2890
if basis_tree.inventory.root is not None:
2891
wt.set_root_id(basis_tree.get_root_id())
2892
# set the parent list and cache the basis tree.
2893
if _mod_revision.is_null(revision_id):
2896
parent_trees = [(revision_id, basis_tree)]
2897
wt.set_parent_trees(parent_trees)
2898
transform.build_tree(basis_tree, wt)
2902
super(WorkingTreeFormat2, self).__init__()
2903
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2905
def open(self, a_bzrdir, _found=False):
2906
"""Return the WorkingTree object for a_bzrdir
2908
_found is a private parameter, do not use it. It is used to indicate
2909
if format probing has already been done.
2912
# we are being called directly and must probe.
2913
raise NotImplementedError
2914
if not isinstance(a_bzrdir.transport, LocalTransport):
2915
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2916
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2922
class WorkingTreeFormat3(WorkingTreeFormat):
2923
"""The second working tree format updated to record a format marker.
2926
- exists within a metadir controlling .bzr
2927
- includes an explicit version marker for the workingtree control
2928
files, separate from the BzrDir format
2929
- modifies the hash cache format
2931
- uses a LockDir to guard access for writes.
2934
upgrade_recommended = True
2936
def get_format_string(self):
2937
"""See WorkingTreeFormat.get_format_string()."""
2938
return "Bazaar-NG Working Tree format 3"
2940
def get_format_description(self):
2941
"""See WorkingTreeFormat.get_format_description()."""
2942
return "Working tree format 3"
2944
_lock_file_name = 'lock'
2945
_lock_class = LockDir
2947
_tree_class = WorkingTree3
2949
def __get_matchingbzrdir(self):
2950
return bzrdir.BzrDirMetaFormat1()
2952
_matchingbzrdir = property(__get_matchingbzrdir)
2954
def _open_control_files(self, a_bzrdir):
2955
transport = a_bzrdir.get_workingtree_transport(None)
2956
return LockableFiles(transport, self._lock_file_name,
2959
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2960
accelerator_tree=None, hardlink=False):
2961
"""See WorkingTreeFormat.initialize().
2963
:param revision_id: if supplied, create a working tree at a different
2964
revision than the branch is at.
2965
:param accelerator_tree: A tree which can be used for retrieving file
2966
contents more quickly than the revision tree, i.e. a workingtree.
2967
The revision tree will be used for cases where accelerator_tree's
2968
content is different.
2969
:param hardlink: If true, hard-link files from accelerator_tree,
2972
if not isinstance(a_bzrdir.transport, LocalTransport):
2973
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
transport = a_bzrdir.get_workingtree_transport(self)
2975
control_files = self._open_control_files(a_bzrdir)
2976
control_files.create_lock()
2977
control_files.lock_write()
2978
transport.put_bytes('format', self.get_format_string(),
2979
mode=a_bzrdir._get_file_mode())
2980
if from_branch is not None:
2981
branch = from_branch
2983
branch = a_bzrdir.open_branch()
2984
if revision_id is None:
2985
revision_id = _mod_revision.ensure_null(branch.last_revision())
2986
# WorkingTree3 can handle an inventory which has a unique root id.
2987
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2988
# those trees. And because there isn't a format bump inbetween, we
2989
# are maintaining compatibility with older clients.
2990
# inv = Inventory(root_id=gen_root_id())
2991
inv = self._initial_inventory()
2992
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2998
_control_files=control_files)
2999
wt.lock_tree_write()
3001
basis_tree = branch.repository.revision_tree(revision_id)
3002
# only set an explicit root id if there is one to set.
3003
if basis_tree.inventory.root is not None:
3004
wt.set_root_id(basis_tree.get_root_id())
3005
if revision_id == _mod_revision.NULL_REVISION:
3006
wt.set_parent_trees([])
3008
wt.set_parent_trees([(revision_id, basis_tree)])
3009
transform.build_tree(basis_tree, wt)
3011
# Unlock in this order so that the unlock-triggers-flush in
3012
# WorkingTree is given a chance to fire.
3013
control_files.unlock()
3017
def _initial_inventory(self):
3018
return inventory.Inventory()
3021
super(WorkingTreeFormat3, self).__init__()
3023
def open(self, a_bzrdir, _found=False):
3024
"""Return the WorkingTree object for a_bzrdir
3026
_found is a private parameter, do not use it. It is used to indicate
3027
if format probing has already been done.
3030
# we are being called directly and must probe.
3031
raise NotImplementedError
3032
if not isinstance(a_bzrdir.transport, LocalTransport):
3033
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3034
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3037
def _open(self, a_bzrdir, control_files):
3038
"""Open the tree itself.
3040
:param a_bzrdir: the dir for the tree.
3041
:param control_files: the control files for the tree.
3043
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3047
_control_files=control_files)
3050
return self.get_format_string()
3053
__default_format = WorkingTreeFormat6()
3054
WorkingTreeFormat.register_format(__default_format)
3055
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3056
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3057
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3058
WorkingTreeFormat.set_default_format(__default_format)
3059
# formats which have no format string are not discoverable
3060
# and not independently creatable, so are not registered.
3061
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
