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.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
82
from bzrlib.lockdir import LockDir
83
import bzrlib.mutabletree
84
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
from bzrlib.osutils import (
96
from bzrlib.filters import filtered_input_file
97
from bzrlib.trace import mutter, note
98
from bzrlib.transport.local import LocalTransport
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
my_file = self.get_file(file_id, path=path, filtered=filtered)
468
return my_file.read()
472
def get_file_byname(self, filename, filtered=True):
473
path = self.abspath(filename)
475
if filtered and self.supports_content_filtering():
476
filters = self._content_filter_stack(filename)
477
return filtered_input_file(f, filters)
481
def get_file_lines(self, file_id, path=None, filtered=True):
482
"""See Tree.get_file_lines()"""
483
file = self.get_file(file_id, path, filtered=filtered)
485
return file.readlines()
490
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
491
"""See Tree.annotate_iter
493
This implementation will use the basis tree implementation if possible.
494
Lines not in the basis are attributed to CURRENT_REVISION
496
If there are pending merges, lines added by those merges will be
497
incorrectly attributed to CURRENT_REVISION (but after committing, the
498
attribution will be correct).
500
maybe_file_parent_keys = []
501
for parent_id in self.get_parent_ids():
503
parent_tree = self.revision_tree(parent_id)
504
except errors.NoSuchRevisionInTree:
505
parent_tree = self.branch.repository.revision_tree(parent_id)
506
parent_tree.lock_read()
508
if file_id not in parent_tree:
510
ie = parent_tree.inventory[file_id]
511
if ie.kind != 'file':
512
# Note: this is slightly unnecessary, because symlinks and
513
# directories have a "text" which is the empty text, and we
514
# know that won't mess up annotations. But it seems cleaner
516
parent_text_key = (file_id, ie.revision)
517
if parent_text_key not in maybe_file_parent_keys:
518
maybe_file_parent_keys.append(parent_text_key)
521
graph = _mod_graph.Graph(self.branch.repository.texts)
522
heads = graph.heads(maybe_file_parent_keys)
523
file_parent_keys = []
524
for key in maybe_file_parent_keys:
526
file_parent_keys.append(key)
528
# Now we have the parents of this content
529
annotator = self.branch.repository.texts.get_annotator()
530
text = self.get_file_text(file_id)
531
this_key =(file_id, default_revision)
532
annotator.add_special_text(this_key, file_parent_keys, text)
533
annotations = [(key[-1], line)
534
for key, line in annotator.annotate_flat(this_key)]
537
def _get_ancestors(self, default_revision):
538
ancestors = set([default_revision])
539
for parent_id in self.get_parent_ids():
540
ancestors.update(self.branch.repository.get_ancestry(
541
parent_id, topo_sorted=False))
544
def get_parent_ids(self):
545
"""See Tree.get_parent_ids.
547
This implementation reads the pending merges list and last_revision
548
value and uses that to decide what the parents list should be.
550
last_rev = _mod_revision.ensure_null(self._last_revision())
551
if _mod_revision.NULL_REVISION == last_rev:
556
merges_bytes = self._transport.get_bytes('pending-merges')
557
except errors.NoSuchFile:
560
for l in osutils.split_lines(merges_bytes):
561
revision_id = l.rstrip('\n')
562
parents.append(revision_id)
566
def get_root_id(self):
567
"""Return the id of this trees root"""
568
return self._inventory.root.file_id
570
def _get_store_filename(self, file_id):
571
## XXX: badly named; this is not in the store at all
572
return self.abspath(self.id2path(file_id))
575
def clone(self, to_bzrdir, revision_id=None):
576
"""Duplicate this working tree into to_bzr, including all state.
578
Specifically modified files are kept as modified, but
579
ignored and unknown files are discarded.
581
If you want to make a new line of development, see bzrdir.sprout()
584
If not None, the cloned tree will have its last revision set to
585
revision, and difference between the source trees last revision
586
and this one merged in.
588
# assumes the target bzr dir format is compatible.
589
result = to_bzrdir.create_workingtree()
590
self.copy_content_into(result, revision_id)
594
def copy_content_into(self, tree, revision_id=None):
595
"""Copy the current content and user files of this tree into tree."""
596
tree.set_root_id(self.get_root_id())
597
if revision_id is None:
598
merge.transform_tree(tree, self)
600
# TODO now merge from tree.last_revision to revision (to preserve
601
# user local changes)
602
merge.transform_tree(tree, self)
603
tree.set_parent_ids([revision_id])
605
def id2abspath(self, file_id):
606
return self.abspath(self.id2path(file_id))
608
def has_id(self, file_id):
609
# files that have been deleted are excluded
611
if not inv.has_id(file_id):
613
path = inv.id2path(file_id)
614
return osutils.lexists(self.abspath(path))
616
def has_or_had_id(self, file_id):
617
if file_id == self.inventory.root.file_id:
619
return self.inventory.has_id(file_id)
621
__contains__ = has_id
623
def get_file_size(self, file_id):
624
"""See Tree.get_file_size"""
625
# XXX: this returns the on-disk size; it should probably return the
628
return os.path.getsize(self.id2abspath(file_id))
630
if e.errno != errno.ENOENT:
636
def get_file_sha1(self, file_id, path=None, stat_value=None):
638
path = self._inventory.id2path(file_id)
639
return self._hashcache.get_sha1(path, stat_value)
641
def get_file_mtime(self, file_id, path=None):
643
path = self.inventory.id2path(file_id)
644
return os.lstat(self.abspath(path)).st_mtime
646
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
647
file_id = self.path2id(path)
649
# For unversioned files on win32, we just assume they are not
652
return self._inventory[file_id].executable
654
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
655
mode = stat_result.st_mode
656
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
658
if not supports_executable():
659
def is_executable(self, file_id, path=None):
660
return self._inventory[file_id].executable
662
_is_executable_from_path_and_stat = \
663
_is_executable_from_path_and_stat_from_basis
665
def is_executable(self, file_id, path=None):
667
path = self.id2path(file_id)
668
mode = os.lstat(self.abspath(path)).st_mode
669
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
671
_is_executable_from_path_and_stat = \
672
_is_executable_from_path_and_stat_from_stat
674
@needs_tree_write_lock
675
def _add(self, files, ids, kinds):
676
"""See MutableTree._add."""
677
# TODO: Re-adding a file that is removed in the working copy
678
# should probably put it back with the previous ID.
679
# the read and write working inventory should not occur in this
680
# function - they should be part of lock_write and unlock.
682
for f, file_id, kind in zip(files, ids, kinds):
684
inv.add_path(f, kind=kind)
686
inv.add_path(f, kind=kind, file_id=file_id)
687
self._inventory_is_modified = True
689
@needs_tree_write_lock
690
def _gather_kinds(self, files, kinds):
691
"""See MutableTree._gather_kinds."""
692
for pos, f in enumerate(files):
693
if kinds[pos] is None:
694
fullpath = normpath(self.abspath(f))
696
kinds[pos] = file_kind(fullpath)
698
if e.errno == errno.ENOENT:
699
raise errors.NoSuchFile(fullpath)
702
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
703
"""Add revision_id as a parent.
705
This is equivalent to retrieving the current list of parent ids
706
and setting the list to its value plus revision_id.
708
:param revision_id: The revision id to add to the parent list. It may
709
be a ghost revision as long as its not the first parent to be added,
710
or the allow_leftmost_as_ghost parameter is set True.
711
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
713
parents = self.get_parent_ids() + [revision_id]
714
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
715
or allow_leftmost_as_ghost)
717
@needs_tree_write_lock
718
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
719
"""Add revision_id, tree tuple as a parent.
721
This is equivalent to retrieving the current list of parent trees
722
and setting the list to its value plus parent_tuple. See also
723
add_parent_tree_id - if you only have a parent id available it will be
724
simpler to use that api. If you have the parent already available, using
725
this api is preferred.
727
:param parent_tuple: The (revision id, tree) to add to the parent list.
728
If the revision_id is a ghost, pass None for the tree.
729
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
731
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
732
if len(parent_ids) > 1:
733
# the leftmost may have already been a ghost, preserve that if it
735
allow_leftmost_as_ghost = True
736
self.set_parent_ids(parent_ids,
737
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
739
@needs_tree_write_lock
740
def add_pending_merge(self, *revision_ids):
741
# TODO: Perhaps should check at this point that the
742
# history of the revision is actually present?
743
parents = self.get_parent_ids()
745
for rev_id in revision_ids:
746
if rev_id in parents:
748
parents.append(rev_id)
751
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
753
def path_content_summary(self, path, _lstat=os.lstat,
754
_mapper=osutils.file_kind_from_stat_mode):
755
"""See Tree.path_content_summary."""
756
abspath = self.abspath(path)
758
stat_result = _lstat(abspath)
760
if getattr(e, 'errno', None) == errno.ENOENT:
762
return ('missing', None, None, None)
763
# propagate other errors
765
kind = _mapper(stat_result.st_mode)
767
return self._file_content_summary(path, stat_result)
768
elif kind == 'directory':
769
# perhaps it looks like a plain directory, but it's really a
771
if self._directory_is_tree_reference(path):
772
kind = 'tree-reference'
773
return kind, None, None, None
774
elif kind == 'symlink':
775
target = osutils.readlink(abspath)
776
return ('symlink', None, None, target)
778
return (kind, None, None, None)
780
def _file_content_summary(self, path, stat_result):
781
size = stat_result.st_size
782
executable = self._is_executable_from_path_and_stat(path, stat_result)
783
# try for a stat cache lookup
784
return ('file', size, executable, self._sha_from_stat(
787
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
788
"""Common ghost checking functionality from set_parent_*.
790
This checks that the left hand-parent exists if there are any
793
if len(revision_ids) > 0:
794
leftmost_id = revision_ids[0]
795
if (not allow_leftmost_as_ghost and not
796
self.branch.repository.has_revision(leftmost_id)):
797
raise errors.GhostRevisionUnusableHere(leftmost_id)
799
def _set_merges_from_parent_ids(self, parent_ids):
800
merges = parent_ids[1:]
801
self._transport.put_bytes('pending-merges', '\n'.join(merges),
802
mode=self.bzrdir._get_file_mode())
804
def _filter_parent_ids_by_ancestry(self, revision_ids):
805
"""Check that all merged revisions are proper 'heads'.
807
This will always return the first revision_id, and any merged revisions
810
if len(revision_ids) == 0:
812
graph = self.branch.repository.get_graph()
813
heads = graph.heads(revision_ids)
814
new_revision_ids = revision_ids[:1]
815
for revision_id in revision_ids[1:]:
816
if revision_id in heads and revision_id not in new_revision_ids:
817
new_revision_ids.append(revision_id)
818
if new_revision_ids != revision_ids:
819
trace.mutter('requested to set revision_ids = %s,'
820
' but filtered to %s', revision_ids, new_revision_ids)
821
return new_revision_ids
823
@needs_tree_write_lock
824
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
825
"""Set the parent ids to revision_ids.
827
See also set_parent_trees. This api will try to retrieve the tree data
828
for each element of revision_ids from the trees repository. If you have
829
tree data already available, it is more efficient to use
830
set_parent_trees rather than set_parent_ids. set_parent_ids is however
831
an easier API to use.
833
:param revision_ids: The revision_ids to set as the parent ids of this
834
working tree. Any of these may be ghosts.
836
self._check_parents_for_ghosts(revision_ids,
837
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
838
for revision_id in revision_ids:
839
_mod_revision.check_not_reserved_id(revision_id)
841
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
843
if len(revision_ids) > 0:
844
self.set_last_revision(revision_ids[0])
846
self.set_last_revision(_mod_revision.NULL_REVISION)
848
self._set_merges_from_parent_ids(revision_ids)
850
@needs_tree_write_lock
851
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
852
"""See MutableTree.set_parent_trees."""
853
parent_ids = [rev for (rev, tree) in parents_list]
854
for revision_id in parent_ids:
855
_mod_revision.check_not_reserved_id(revision_id)
857
self._check_parents_for_ghosts(parent_ids,
858
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
860
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
862
if len(parent_ids) == 0:
863
leftmost_parent_id = _mod_revision.NULL_REVISION
864
leftmost_parent_tree = None
866
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
868
if self._change_last_revision(leftmost_parent_id):
869
if leftmost_parent_tree is None:
870
# If we don't have a tree, fall back to reading the
871
# parent tree from the repository.
872
self._cache_basis_inventory(leftmost_parent_id)
874
inv = leftmost_parent_tree.inventory
875
xml = self._create_basis_xml_from_inventory(
876
leftmost_parent_id, inv)
877
self._write_basis_inventory(xml)
878
self._set_merges_from_parent_ids(parent_ids)
880
@needs_tree_write_lock
881
def set_pending_merges(self, rev_list):
882
parents = self.get_parent_ids()
883
leftmost = parents[:1]
884
new_parents = leftmost + rev_list
885
self.set_parent_ids(new_parents)
887
@needs_tree_write_lock
888
def set_merge_modified(self, modified_hashes):
890
for file_id, hash in modified_hashes.iteritems():
891
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
892
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
894
def _sha_from_stat(self, path, stat_result):
895
"""Get a sha digest from the tree's stat cache.
897
The default implementation assumes no stat cache is present.
899
:param path: The path.
900
:param stat_result: The stat result being looked up.
904
def _put_rio(self, filename, stanzas, header):
905
self._must_be_locked()
906
my_file = rio_file(stanzas, header)
907
self._transport.put_file(filename, my_file,
908
mode=self.bzrdir._get_file_mode())
910
@needs_write_lock # because merge pulls data into the branch.
911
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
912
merge_type=None, force=False):
913
"""Merge from a branch into this working tree.
915
:param branch: The branch to merge from.
916
:param to_revision: If non-None, the merge will merge to to_revision,
917
but not beyond it. to_revision does not need to be in the history
918
of the branch when it is supplied. If None, to_revision defaults to
919
branch.last_revision().
921
from bzrlib.merge import Merger, Merge3Merger
922
merger = Merger(self.branch, this_tree=self)
923
# check that there are no local alterations
924
if not force and self.has_changes():
925
raise errors.UncommittedChanges(self)
926
if to_revision is None:
927
to_revision = _mod_revision.ensure_null(branch.last_revision())
928
merger.other_rev_id = to_revision
929
if _mod_revision.is_null(merger.other_rev_id):
930
raise errors.NoCommits(branch)
931
self.branch.fetch(branch, last_revision=merger.other_rev_id)
932
merger.other_basis = merger.other_rev_id
933
merger.other_tree = self.branch.repository.revision_tree(
935
merger.other_branch = branch
936
if from_revision is None:
939
merger.set_base_revision(from_revision, branch)
940
if merger.base_rev_id == merger.other_rev_id:
941
raise errors.PointlessMerge
942
merger.backup_files = False
943
if merge_type is None:
944
merger.merge_type = Merge3Merger
946
merger.merge_type = merge_type
947
merger.set_interesting_files(None)
948
merger.show_base = False
949
merger.reprocess = False
950
conflicts = merger.do_merge()
955
def merge_modified(self):
956
"""Return a dictionary of files modified by a merge.
958
The list is initialized by WorkingTree.set_merge_modified, which is
959
typically called after we make some automatic updates to the tree
962
This returns a map of file_id->sha1, containing only files which are
963
still in the working inventory and have that text hash.
966
hashfile = self._transport.get('merge-hashes')
967
except errors.NoSuchFile:
972
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
973
raise errors.MergeModifiedFormatError()
974
except StopIteration:
975
raise errors.MergeModifiedFormatError()
976
for s in RioReader(hashfile):
977
# RioReader reads in Unicode, so convert file_ids back to utf8
978
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
979
if file_id not in self.inventory:
981
text_hash = s.get("hash")
982
if text_hash == self.get_file_sha1(file_id):
983
merge_hashes[file_id] = text_hash
989
def mkdir(self, path, file_id=None):
990
"""See MutableTree.mkdir()."""
992
file_id = generate_ids.gen_file_id(os.path.basename(path))
993
os.mkdir(self.abspath(path))
994
self.add(path, file_id, 'directory')
997
def get_symlink_target(self, file_id):
998
abspath = self.id2abspath(file_id)
999
target = osutils.readlink(abspath)
1003
def subsume(self, other_tree):
1004
def add_children(inventory, entry):
1005
for child_entry in entry.children.values():
1006
inventory._byid[child_entry.file_id] = child_entry
1007
if child_entry.kind == 'directory':
1008
add_children(inventory, child_entry)
1009
if other_tree.get_root_id() == self.get_root_id():
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Trees have the same root')
1013
other_tree_path = self.relpath(other_tree.basedir)
1014
except errors.PathNotChild:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Tree is not contained by the other')
1017
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1018
if new_root_parent is None:
1019
raise errors.BadSubsumeSource(self, other_tree,
1020
'Parent directory is not versioned.')
1021
# We need to ensure that the result of a fetch will have a
1022
# versionedfile for the other_tree root, and only fetching into
1023
# RepositoryKnit2 guarantees that.
1024
if not self.branch.repository.supports_rich_root():
1025
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1026
other_tree.lock_tree_write()
1028
new_parents = other_tree.get_parent_ids()
1029
other_root = other_tree.inventory.root
1030
other_root.parent_id = new_root_parent
1031
other_root.name = osutils.basename(other_tree_path)
1032
self.inventory.add(other_root)
1033
add_children(self.inventory, other_root)
1034
self._write_inventory(self.inventory)
1035
# normally we don't want to fetch whole repositories, but i think
1036
# here we really do want to consolidate the whole thing.
1037
for parent_id in other_tree.get_parent_ids():
1038
self.branch.fetch(other_tree.branch, parent_id)
1039
self.add_parent_tree_id(parent_id)
1042
other_tree.bzrdir.retire_bzrdir()
1044
def _setup_directory_is_tree_reference(self):
1045
if self._branch.repository._format.supports_tree_reference:
1046
self._directory_is_tree_reference = \
1047
self._directory_may_be_tree_reference
1049
self._directory_is_tree_reference = \
1050
self._directory_is_never_tree_reference
1052
def _directory_is_never_tree_reference(self, relpath):
1055
def _directory_may_be_tree_reference(self, relpath):
1056
# as a special case, if a directory contains control files then
1057
# it's a tree reference, except that the root of the tree is not
1058
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1059
# TODO: We could ask all the control formats whether they
1060
# recognize this directory, but at the moment there's no cheap api
1061
# to do that. Since we probably can only nest bzr checkouts and
1062
# they always use this name it's ok for now. -- mbp 20060306
1064
# FIXME: There is an unhandled case here of a subdirectory
1065
# containing .bzr but not a branch; that will probably blow up
1066
# when you try to commit it. It might happen if there is a
1067
# checkout in a subdirectory. This can be avoided by not adding
1070
@needs_tree_write_lock
1071
def extract(self, file_id, format=None):
1072
"""Extract a subtree from this tree.
1074
A new branch will be created, relative to the path for this tree.
1078
segments = osutils.splitpath(path)
1079
transport = self.branch.bzrdir.root_transport
1080
for name in segments:
1081
transport = transport.clone(name)
1082
transport.ensure_base()
1085
sub_path = self.id2path(file_id)
1086
branch_transport = mkdirs(sub_path)
1088
format = self.bzrdir.cloning_metadir()
1089
branch_transport.ensure_base()
1090
branch_bzrdir = format.initialize_on_transport(branch_transport)
1092
repo = branch_bzrdir.find_repository()
1093
except errors.NoRepositoryPresent:
1094
repo = branch_bzrdir.create_repository()
1095
if not repo.supports_rich_root():
1096
raise errors.RootNotRich()
1097
new_branch = branch_bzrdir.create_branch()
1098
new_branch.pull(self.branch)
1099
for parent_id in self.get_parent_ids():
1100
new_branch.fetch(self.branch, parent_id)
1101
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1102
if tree_transport.base != branch_transport.base:
1103
tree_bzrdir = format.initialize_on_transport(tree_transport)
1104
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1105
target_branch=new_branch)
1107
tree_bzrdir = branch_bzrdir
1108
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1109
wt.set_parent_ids(self.get_parent_ids())
1110
my_inv = self.inventory
1111
child_inv = inventory.Inventory(root_id=None)
1112
new_root = my_inv[file_id]
1113
my_inv.remove_recursive_id(file_id)
1114
new_root.parent_id = None
1115
child_inv.add(new_root)
1116
self._write_inventory(my_inv)
1117
wt._write_inventory(child_inv)
1120
def _serialize(self, inventory, out_file):
1121
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1124
def _deserialize(selt, in_file):
1125
return xml5.serializer_v5.read_inventory(in_file)
1128
"""Write the in memory inventory to disk."""
1129
# TODO: Maybe this should only write on dirty ?
1130
if self._control_files._lock_mode != 'w':
1131
raise errors.NotWriteLocked(self)
1133
self._serialize(self._inventory, sio)
1135
self._transport.put_file('inventory', sio,
1136
mode=self.bzrdir._get_file_mode())
1137
self._inventory_is_modified = False
1139
def _kind(self, relpath):
1140
return osutils.file_kind(self.abspath(relpath))
1142
def list_files(self, include_root=False, from_dir=None, recursive=True):
1143
"""List all files as (path, class, kind, id, entry).
1145
Lists, but does not descend into unversioned directories.
1146
This does not include files that have been deleted in this
1147
tree. Skips the control directory.
1149
:param include_root: if True, return an entry for the root
1150
:param from_dir: start from this directory or None for the root
1151
:param recursive: whether to recurse into subdirectories or not
1153
# list_files is an iterator, so @needs_read_lock doesn't work properly
1154
# with it. So callers should be careful to always read_lock the tree.
1155
if not self.is_locked():
1156
raise errors.ObjectNotLocked(self)
1158
inv = self.inventory
1159
if from_dir is None and include_root is True:
1160
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1161
# Convert these into local objects to save lookup times
1162
pathjoin = osutils.pathjoin
1163
file_kind = self._kind
1165
# transport.base ends in a slash, we want the piece
1166
# between the last two slashes
1167
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1169
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1171
# directory file_id, relative path, absolute path, reverse sorted children
1172
if from_dir is not None:
1173
from_dir_id = inv.path2id(from_dir)
1174
if from_dir_id is None:
1175
# Directory not versioned
1177
from_dir_abspath = pathjoin(self.basedir, from_dir)
1179
from_dir_id = inv.root.file_id
1180
from_dir_abspath = self.basedir
1181
children = os.listdir(from_dir_abspath)
1183
# jam 20060527 The kernel sized tree seems equivalent whether we
1184
# use a deque and popleft to keep them sorted, or if we use a plain
1185
# list and just reverse() them.
1186
children = collections.deque(children)
1187
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1189
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1192
f = children.popleft()
1193
## TODO: If we find a subdirectory with its own .bzr
1194
## directory, then that is a separate tree and we
1195
## should exclude it.
1197
# the bzrdir for this tree
1198
if transport_base_dir == f:
1201
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1202
# and 'f' doesn't begin with one, we can do a string op, rather
1203
# than the checks of pathjoin(), all relative paths will have an extra slash
1205
fp = from_dir_relpath + '/' + f
1208
fap = from_dir_abspath + '/' + f
1210
f_ie = inv.get_child(from_dir_id, f)
1213
elif self.is_ignored(fp[1:]):
1216
# we may not have found this file, because of a unicode issue
1217
f_norm, can_access = osutils.normalized_filename(f)
1218
if f == f_norm or not can_access:
1219
# No change, so treat this file normally
1222
# this file can be accessed by a normalized path
1223
# check again if it is versioned
1224
# these lines are repeated here for performance
1226
fp = from_dir_relpath + '/' + f
1227
fap = from_dir_abspath + '/' + f
1228
f_ie = inv.get_child(from_dir_id, f)
1231
elif self.is_ignored(fp[1:]):
1238
# make a last minute entry
1240
yield fp[1:], c, fk, f_ie.file_id, f_ie
1243
yield fp[1:], c, fk, None, fk_entries[fk]()
1245
yield fp[1:], c, fk, None, TreeEntry()
1248
if fk != 'directory':
1251
# But do this child first if recursing down
1253
new_children = os.listdir(fap)
1255
new_children = collections.deque(new_children)
1256
stack.append((f_ie.file_id, fp, fap, new_children))
1257
# Break out of inner loop,
1258
# so that we start outer loop with child
1261
# if we finished all children, pop it off the stack
1264
@needs_tree_write_lock
1265
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1268
to_dir must exist in the inventory.
1270
If to_dir exists and is a directory, the files are moved into
1271
it, keeping their old names.
1273
Note that to_dir is only the last component of the new name;
1274
this doesn't change the directory.
1276
For each entry in from_paths the move mode will be determined
1279
The first mode moves the file in the filesystem and updates the
1280
inventory. The second mode only updates the inventory without
1281
touching the file on the filesystem. This is the new mode introduced
1284
move uses the second mode if 'after == True' and the target is not
1285
versioned but present in the working tree.
1287
move uses the second mode if 'after == False' and the source is
1288
versioned but no longer in the working tree, and the target is not
1289
versioned but present in the working tree.
1291
move uses the first mode if 'after == False' and the source is
1292
versioned and present in the working tree, and the target is not
1293
versioned and not present in the working tree.
1295
Everything else results in an error.
1297
This returns a list of (from_path, to_path) pairs for each
1298
entry that is moved.
1303
# check for deprecated use of signature
1305
to_dir = kwargs.get('to_name', None)
1307
raise TypeError('You must supply a target directory')
1309
symbol_versioning.warn('The parameter to_name was deprecated'
1310
' in version 0.13. Use to_dir instead',
1313
# check destination directory
1314
if isinstance(from_paths, basestring):
1316
inv = self.inventory
1317
to_abs = self.abspath(to_dir)
1318
if not isdir(to_abs):
1319
raise errors.BzrMoveFailedError('',to_dir,
1320
errors.NotADirectory(to_abs))
1321
if not self.has_filename(to_dir):
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotInWorkingDirectory(to_dir))
1324
to_dir_id = inv.path2id(to_dir)
1325
if to_dir_id is None:
1326
raise errors.BzrMoveFailedError('',to_dir,
1327
errors.NotVersionedError(path=str(to_dir)))
1329
to_dir_ie = inv[to_dir_id]
1330
if to_dir_ie.kind != 'directory':
1331
raise errors.BzrMoveFailedError('',to_dir,
1332
errors.NotADirectory(to_abs))
1334
# create rename entries and tuples
1335
for from_rel in from_paths:
1336
from_tail = splitpath(from_rel)[-1]
1337
from_id = inv.path2id(from_rel)
1339
raise errors.BzrMoveFailedError(from_rel,to_dir,
1340
errors.NotVersionedError(path=str(from_rel)))
1342
from_entry = inv[from_id]
1343
from_parent_id = from_entry.parent_id
1344
to_rel = pathjoin(to_dir, from_tail)
1345
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1347
from_tail=from_tail,
1348
from_parent_id=from_parent_id,
1349
to_rel=to_rel, to_tail=from_tail,
1350
to_parent_id=to_dir_id)
1351
rename_entries.append(rename_entry)
1352
rename_tuples.append((from_rel, to_rel))
1354
# determine which move mode to use. checks also for movability
1355
rename_entries = self._determine_mv_mode(rename_entries, after)
1357
original_modified = self._inventory_is_modified
1360
self._inventory_is_modified = True
1361
self._move(rename_entries)
1363
# restore the inventory on error
1364
self._inventory_is_modified = original_modified
1366
self._write_inventory(inv)
1367
return rename_tuples
1369
def _determine_mv_mode(self, rename_entries, after=False):
1370
"""Determines for each from-to pair if both inventory and working tree
1371
or only the inventory has to be changed.
1373
Also does basic plausability tests.
1375
inv = self.inventory
1377
for rename_entry in rename_entries:
1378
# store to local variables for easier reference
1379
from_rel = rename_entry.from_rel
1380
from_id = rename_entry.from_id
1381
to_rel = rename_entry.to_rel
1382
to_id = inv.path2id(to_rel)
1383
only_change_inv = False
1385
# check the inventory for source and destination
1387
raise errors.BzrMoveFailedError(from_rel,to_rel,
1388
errors.NotVersionedError(path=str(from_rel)))
1389
if to_id is not None:
1390
raise errors.BzrMoveFailedError(from_rel,to_rel,
1391
errors.AlreadyVersionedError(path=str(to_rel)))
1393
# try to determine the mode for rename (only change inv or change
1394
# inv and file system)
1396
if not self.has_filename(to_rel):
1397
raise errors.BzrMoveFailedError(from_id,to_rel,
1398
errors.NoSuchFile(path=str(to_rel),
1399
extra="New file has not been created yet"))
1400
only_change_inv = True
1401
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1402
only_change_inv = True
1403
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1404
only_change_inv = False
1405
elif (not self.case_sensitive
1406
and from_rel.lower() == to_rel.lower()
1407
and self.has_filename(from_rel)):
1408
only_change_inv = False
1410
# something is wrong, so lets determine what exactly
1411
if not self.has_filename(from_rel) and \
1412
not self.has_filename(to_rel):
1413
raise errors.BzrRenameFailedError(from_rel,to_rel,
1414
errors.PathsDoNotExist(paths=(str(from_rel),
1417
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1418
rename_entry.only_change_inv = only_change_inv
1419
return rename_entries
1421
def _move(self, rename_entries):
1422
"""Moves a list of files.
1424
Depending on the value of the flag 'only_change_inv', the
1425
file will be moved on the file system or not.
1427
inv = self.inventory
1430
for entry in rename_entries:
1432
self._move_entry(entry)
1434
self._rollback_move(moved)
1438
def _rollback_move(self, moved):
1439
"""Try to rollback a previous move in case of an filesystem error."""
1440
inv = self.inventory
1443
self._move_entry(WorkingTree._RenameEntry(
1444
entry.to_rel, entry.from_id,
1445
entry.to_tail, entry.to_parent_id, entry.from_rel,
1446
entry.from_tail, entry.from_parent_id,
1447
entry.only_change_inv))
1448
except errors.BzrMoveFailedError, e:
1449
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1450
" The working tree is in an inconsistent state."
1451
" Please consider doing a 'bzr revert'."
1452
" Error message is: %s" % e)
1454
def _move_entry(self, entry):
1455
inv = self.inventory
1456
from_rel_abs = self.abspath(entry.from_rel)
1457
to_rel_abs = self.abspath(entry.to_rel)
1458
if from_rel_abs == to_rel_abs:
1459
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1460
"Source and target are identical.")
1462
if not entry.only_change_inv:
1464
osutils.rename(from_rel_abs, to_rel_abs)
1466
raise errors.BzrMoveFailedError(entry.from_rel,
1468
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1470
@needs_tree_write_lock
1471
def rename_one(self, from_rel, to_rel, after=False):
1474
This can change the directory or the filename or both.
1476
rename_one has several 'modes' to work. First, it can rename a physical
1477
file and change the file_id. That is the normal mode. Second, it can
1478
only change the file_id without touching any physical file. This is
1479
the new mode introduced in version 0.15.
1481
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1482
versioned but present in the working tree.
1484
rename_one uses the second mode if 'after == False' and 'from_rel' is
1485
versioned but no longer in the working tree, and 'to_rel' is not
1486
versioned but present in the working tree.
1488
rename_one uses the first mode if 'after == False' and 'from_rel' is
1489
versioned and present in the working tree, and 'to_rel' is not
1490
versioned and not present in the working tree.
1492
Everything else results in an error.
1494
inv = self.inventory
1497
# create rename entries and tuples
1498
from_tail = splitpath(from_rel)[-1]
1499
from_id = inv.path2id(from_rel)
1501
# if file is missing in the inventory maybe it's in the basis_tree
1502
basis_tree = self.branch.basis_tree()
1503
from_id = basis_tree.path2id(from_rel)
1505
raise errors.BzrRenameFailedError(from_rel,to_rel,
1506
errors.NotVersionedError(path=str(from_rel)))
1507
# put entry back in the inventory so we can rename it
1508
from_entry = basis_tree.inventory[from_id].copy()
1511
from_entry = inv[from_id]
1512
from_parent_id = from_entry.parent_id
1513
to_dir, to_tail = os.path.split(to_rel)
1514
to_dir_id = inv.path2id(to_dir)
1515
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1517
from_tail=from_tail,
1518
from_parent_id=from_parent_id,
1519
to_rel=to_rel, to_tail=to_tail,
1520
to_parent_id=to_dir_id)
1521
rename_entries.append(rename_entry)
1523
# determine which move mode to use. checks also for movability
1524
rename_entries = self._determine_mv_mode(rename_entries, after)
1526
# check if the target changed directory and if the target directory is
1528
if to_dir_id is None:
1529
raise errors.BzrMoveFailedError(from_rel,to_rel,
1530
errors.NotVersionedError(path=str(to_dir)))
1532
# all checks done. now we can continue with our actual work
1533
mutter('rename_one:\n'
1538
' to_dir_id {%s}\n',
1539
from_id, from_rel, to_rel, to_dir, to_dir_id)
1541
self._move(rename_entries)
1542
self._write_inventory(inv)
1544
class _RenameEntry(object):
1545
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1546
to_rel, to_tail, to_parent_id, only_change_inv=False):
1547
self.from_rel = from_rel
1548
self.from_id = from_id
1549
self.from_tail = from_tail
1550
self.from_parent_id = from_parent_id
1551
self.to_rel = to_rel
1552
self.to_tail = to_tail
1553
self.to_parent_id = to_parent_id
1554
self.only_change_inv = only_change_inv
1558
"""Return all unknown files.
1560
These are files in the working directory that are not versioned or
1561
control files or ignored.
1563
# force the extras method to be fully executed before returning, to
1564
# prevent race conditions with the lock
1566
[subp for subp in self.extras() if not self.is_ignored(subp)])
1568
@needs_tree_write_lock
1569
def unversion(self, file_ids):
1570
"""Remove the file ids in file_ids from the current versioned set.
1572
When a file_id is unversioned, all of its children are automatically
1575
:param file_ids: The file ids to stop versioning.
1576
:raises: NoSuchId if any fileid is not currently versioned.
1578
for file_id in file_ids:
1579
if file_id not in self._inventory:
1580
raise errors.NoSuchId(self, file_id)
1581
for file_id in file_ids:
1582
if self._inventory.has_id(file_id):
1583
self._inventory.remove_recursive_id(file_id)
1585
# in the future this should just set a dirty bit to wait for the
1586
# final unlock. However, until all methods of workingtree start
1587
# with the current in -memory inventory rather than triggering
1588
# a read, it is more complex - we need to teach read_inventory
1589
# to know when to read, and when to not read first... and possibly
1590
# to save first when the in memory one may be corrupted.
1591
# so for now, we just only write it if it is indeed dirty.
1593
self._write_inventory(self._inventory)
1595
def _iter_conflicts(self):
1597
for info in self.list_files():
1599
stem = get_conflicted_stem(path)
1602
if stem not in conflicted:
1603
conflicted.add(stem)
1607
def pull(self, source, overwrite=False, stop_revision=None,
1608
change_reporter=None, possible_transports=None, local=False):
1611
old_revision_info = self.branch.last_revision_info()
1612
basis_tree = self.basis_tree()
1613
count = self.branch.pull(source, overwrite, stop_revision,
1614
possible_transports=possible_transports,
1616
new_revision_info = self.branch.last_revision_info()
1617
if new_revision_info != old_revision_info:
1618
repository = self.branch.repository
1619
basis_tree.lock_read()
1621
new_basis_tree = self.branch.basis_tree()
1628
change_reporter=change_reporter)
1629
basis_root_id = basis_tree.get_root_id()
1630
new_root_id = new_basis_tree.get_root_id()
1631
if basis_root_id != new_root_id:
1632
self.set_root_id(new_root_id)
1635
# TODO - dedup parents list with things merged by pull ?
1636
# reuse the revisiontree we merged against to set the new
1638
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1639
# we have to pull the merge trees out again, because
1640
# merge_inner has set the ids. - this corner is not yet
1641
# layered well enough to prevent double handling.
1642
# XXX TODO: Fix the double handling: telling the tree about
1643
# the already known parent data is wasteful.
1644
merges = self.get_parent_ids()[1:]
1645
parent_trees.extend([
1646
(parent, repository.revision_tree(parent)) for
1648
self.set_parent_trees(parent_trees)
1654
def put_file_bytes_non_atomic(self, file_id, bytes):
1655
"""See MutableTree.put_file_bytes_non_atomic."""
1656
stream = file(self.id2abspath(file_id), 'wb')
1661
# TODO: update the hashcache here ?
1664
"""Yield all unversioned files in this WorkingTree.
1666
If there are any unversioned directories then only the directory is
1667
returned, not all its children. But if there are unversioned files
1668
under a versioned subdirectory, they are returned.
1670
Currently returned depth-first, sorted by name within directories.
1671
This is the same order used by 'osutils.walkdirs'.
1673
## TODO: Work from given directory downwards
1674
for path, dir_entry in self.inventory.directories():
1675
# mutter("search for unknowns in %r", path)
1676
dirabs = self.abspath(path)
1677
if not isdir(dirabs):
1678
# e.g. directory deleted
1682
for subf in os.listdir(dirabs):
1683
if self.bzrdir.is_control_filename(subf):
1685
if subf not in dir_entry.children:
1688
can_access) = osutils.normalized_filename(subf)
1689
except UnicodeDecodeError:
1690
path_os_enc = path.encode(osutils._fs_enc)
1691
relpath = path_os_enc + '/' + subf
1692
raise errors.BadFilenameEncoding(relpath,
1694
if subf_norm != subf and can_access:
1695
if subf_norm not in dir_entry.children:
1696
fl.append(subf_norm)
1702
subp = pathjoin(path, subf)
1705
def ignored_files(self):
1706
"""Yield list of PATH, IGNORE_PATTERN"""
1707
for subp in self.extras():
1708
pat = self.is_ignored(subp)
1712
def get_ignore_list(self):
1713
"""Return list of ignore patterns.
1715
Cached in the Tree object after the first call.
1717
ignoreset = getattr(self, '_ignoreset', None)
1718
if ignoreset is not None:
1721
ignore_globs = set()
1722
ignore_globs.update(ignores.get_runtime_ignores())
1723
ignore_globs.update(ignores.get_user_ignores())
1724
if self.has_filename(bzrlib.IGNORE_FILENAME):
1725
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1727
ignore_globs.update(ignores.parse_ignore_file(f))
1730
self._ignoreset = ignore_globs
1733
def _flush_ignore_list_cache(self):
1734
"""Resets the cached ignore list to force a cache rebuild."""
1735
self._ignoreset = None
1736
self._ignoreglobster = None
1738
def is_ignored(self, filename):
1739
r"""Check whether the filename matches an ignore pattern.
1741
Patterns containing '/' or '\' need to match the whole path;
1742
others match against only the last component. Patterns starting
1743
with '!' are ignore exceptions. Exceptions take precedence
1744
over regular patterns and cause the filename to not be ignored.
1746
If the file is ignored, returns the pattern which caused it to
1747
be ignored, otherwise None. So this can simply be used as a
1748
boolean if desired."""
1749
if getattr(self, '_ignoreglobster', None) is None:
1750
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1751
return self._ignoreglobster.match(filename)
1753
def kind(self, file_id):
1754
return file_kind(self.id2abspath(file_id))
1756
def stored_kind(self, file_id):
1757
"""See Tree.stored_kind"""
1758
return self.inventory[file_id].kind
1760
def _comparison_data(self, entry, path):
1761
abspath = self.abspath(path)
1763
stat_value = os.lstat(abspath)
1765
if getattr(e, 'errno', None) == errno.ENOENT:
1772
mode = stat_value.st_mode
1773
kind = osutils.file_kind_from_stat_mode(mode)
1774
if not supports_executable():
1775
executable = entry is not None and entry.executable
1777
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1778
return kind, executable, stat_value
1780
def _file_size(self, entry, stat_value):
1781
return stat_value.st_size
1783
def last_revision(self):
1784
"""Return the last revision of the branch for this tree.
1786
This format tree does not support a separate marker for last-revision
1787
compared to the branch.
1789
See MutableTree.last_revision
1791
return self._last_revision()
1794
def _last_revision(self):
1795
"""helper for get_parent_ids."""
1796
return _mod_revision.ensure_null(self.branch.last_revision())
1798
def is_locked(self):
1799
return self._control_files.is_locked()
1801
def _must_be_locked(self):
1802
if not self.is_locked():
1803
raise errors.ObjectNotLocked(self)
1805
def lock_read(self):
1806
"""Lock the tree for reading.
1808
This also locks the branch, and can be unlocked via self.unlock().
1810
:return: A bzrlib.lock.LogicalLockResult.
1812
if not self.is_locked():
1814
self.branch.lock_read()
1816
self._control_files.lock_read()
1817
return LogicalLockResult(self.unlock)
1819
self.branch.unlock()
1822
def lock_tree_write(self):
1823
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1825
:return: A bzrlib.lock.LogicalLockResult.
1827
if not self.is_locked():
1829
self.branch.lock_read()
1831
self._control_files.lock_write()
1832
return LogicalLockResult(self.unlock)
1834
self.branch.unlock()
1837
def lock_write(self):
1838
"""See MutableTree.lock_write, and WorkingTree.unlock.
1840
:return: A bzrlib.lock.LogicalLockResult.
1842
if not self.is_locked():
1844
self.branch.lock_write()
1846
self._control_files.lock_write()
1847
return LogicalLockResult(self.unlock)
1849
self.branch.unlock()
1852
def get_physical_lock_status(self):
1853
return self._control_files.get_physical_lock_status()
1855
def _basis_inventory_name(self):
1856
return 'basis-inventory-cache'
1858
def _reset_data(self):
1859
"""Reset transient data that cannot be revalidated."""
1860
self._inventory_is_modified = False
1861
f = self._transport.get('inventory')
1863
result = self._deserialize(f)
1866
self._set_inventory(result, dirty=False)
1868
@needs_tree_write_lock
1869
def set_last_revision(self, new_revision):
1870
"""Change the last revision in the working tree."""
1871
if self._change_last_revision(new_revision):
1872
self._cache_basis_inventory(new_revision)
1874
def _change_last_revision(self, new_revision):
1875
"""Template method part of set_last_revision to perform the change.
1877
This is used to allow WorkingTree3 instances to not affect branch
1878
when their last revision is set.
1880
if _mod_revision.is_null(new_revision):
1881
self.branch.set_revision_history([])
1884
self.branch.generate_revision_history(new_revision)
1885
except errors.NoSuchRevision:
1886
# not present in the repo - dont try to set it deeper than the tip
1887
self.branch.set_revision_history([new_revision])
1890
def _write_basis_inventory(self, xml):
1891
"""Write the basis inventory XML to the basis-inventory file"""
1892
path = self._basis_inventory_name()
1894
self._transport.put_file(path, sio,
1895
mode=self.bzrdir._get_file_mode())
1897
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1898
"""Create the text that will be saved in basis-inventory"""
1899
inventory.revision_id = revision_id
1900
return xml7.serializer_v7.write_inventory_to_string(inventory)
1902
def _cache_basis_inventory(self, new_revision):
1903
"""Cache new_revision as the basis inventory."""
1904
# TODO: this should allow the ready-to-use inventory to be passed in,
1905
# as commit already has that ready-to-use [while the format is the
1908
# this double handles the inventory - unpack and repack -
1909
# but is easier to understand. We can/should put a conditional
1910
# in here based on whether the inventory is in the latest format
1911
# - perhaps we should repack all inventories on a repository
1913
# the fast path is to copy the raw xml from the repository. If the
1914
# xml contains 'revision_id="', then we assume the right
1915
# revision_id is set. We must check for this full string, because a
1916
# root node id can legitimately look like 'revision_id' but cannot
1918
xml = self.branch.repository._get_inventory_xml(new_revision)
1919
firstline = xml.split('\n', 1)[0]
1920
if (not 'revision_id="' in firstline or
1921
'format="7"' not in firstline):
1922
inv = self.branch.repository._serializer.read_inventory_from_string(
1924
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1925
self._write_basis_inventory(xml)
1926
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1929
def read_basis_inventory(self):
1930
"""Read the cached basis inventory."""
1931
path = self._basis_inventory_name()
1932
return self._transport.get_bytes(path)
1935
def read_working_inventory(self):
1936
"""Read the working inventory.
1938
:raises errors.InventoryModified: read_working_inventory will fail
1939
when the current in memory inventory has been modified.
1941
# conceptually this should be an implementation detail of the tree.
1942
# XXX: Deprecate this.
1943
# ElementTree does its own conversion from UTF-8, so open in
1945
if self._inventory_is_modified:
1946
raise errors.InventoryModified(self)
1947
f = self._transport.get('inventory')
1949
result = self._deserialize(f)
1952
self._set_inventory(result, dirty=False)
1955
@needs_tree_write_lock
1956
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1958
"""Remove nominated files from the working inventory.
1960
:files: File paths relative to the basedir.
1961
:keep_files: If true, the files will also be kept.
1962
:force: Delete files and directories, even if they are changed and
1963
even if the directories are not empty.
1965
if isinstance(files, basestring):
1971
unknown_nested_files=set()
1973
to_file = sys.stdout
1975
def recurse_directory_to_add_files(directory):
1976
# Recurse directory and add all files
1977
# so we can check if they have changed.
1978
for parent_info, file_infos in self.walkdirs(directory):
1979
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1980
# Is it versioned or ignored?
1981
if self.path2id(relpath) or self.is_ignored(relpath):
1982
# Add nested content for deletion.
1983
new_files.add(relpath)
1985
# Files which are not versioned and not ignored
1986
# should be treated as unknown.
1987
unknown_nested_files.add((relpath, None, kind))
1989
for filename in files:
1990
# Get file name into canonical form.
1991
abspath = self.abspath(filename)
1992
filename = self.relpath(abspath)
1993
if len(filename) > 0:
1994
new_files.add(filename)
1995
recurse_directory_to_add_files(filename)
1997
files = list(new_files)
2000
return # nothing to do
2002
# Sort needed to first handle directory content before the directory
2003
files.sort(reverse=True)
2005
# Bail out if we are going to delete files we shouldn't
2006
if not keep_files and not force:
2007
has_changed_files = len(unknown_nested_files) > 0
2008
if not has_changed_files:
2009
for (file_id, path, content_change, versioned, parent_id, name,
2010
kind, executable) in self.iter_changes(self.basis_tree(),
2011
include_unchanged=True, require_versioned=False,
2012
want_unversioned=True, specific_files=files):
2013
if versioned == (False, False):
2014
# The record is unknown ...
2015
if not self.is_ignored(path[1]):
2016
# ... but not ignored
2017
has_changed_files = True
2019
elif (content_change and (kind[1] is not None) and
2020
osutils.is_inside_any(files, path[1])):
2021
# Versioned and changed, but not deleted, and still
2022
# in one of the dirs to be deleted.
2023
has_changed_files = True
2026
if has_changed_files:
2027
# Make delta show ALL applicable changes in error message.
2028
tree_delta = self.changes_from(self.basis_tree(),
2029
require_versioned=False, want_unversioned=True,
2030
specific_files=files)
2031
for unknown_file in unknown_nested_files:
2032
if unknown_file not in tree_delta.unversioned:
2033
tree_delta.unversioned.extend((unknown_file,))
2034
raise errors.BzrRemoveChangedFilesError(tree_delta)
2036
# Build inv_delta and delete files where applicable,
2037
# do this before any modifications to inventory.
2039
fid = self.path2id(f)
2042
message = "%s is not versioned." % (f,)
2045
# having removed it, it must be either ignored or unknown
2046
if self.is_ignored(f):
2050
# XXX: Really should be a more abstract reporter interface
2051
kind_ch = osutils.kind_marker(self.kind(fid))
2052
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2054
inv_delta.append((f, None, fid, None))
2055
message = "removed %s" % (f,)
2058
abs_path = self.abspath(f)
2059
if osutils.lexists(abs_path):
2060
if (osutils.isdir(abs_path) and
2061
len(os.listdir(abs_path)) > 0):
2063
osutils.rmtree(abs_path)
2065
message = "%s is not an empty directory "\
2066
"and won't be deleted." % (f,)
2068
osutils.delete_any(abs_path)
2069
message = "deleted %s" % (f,)
2070
elif message is not None:
2071
# Only care if we haven't done anything yet.
2072
message = "%s does not exist." % (f,)
2074
# Print only one message (if any) per file.
2075
if message is not None:
2077
self.apply_inventory_delta(inv_delta)
2079
@needs_tree_write_lock
2080
def revert(self, filenames=None, old_tree=None, backups=True,
2081
pb=None, report_changes=False):
2082
from bzrlib.conflicts import resolve
2085
symbol_versioning.warn('Using [] to revert all files is deprecated'
2086
' as of bzr 0.91. Please use None (the default) instead.',
2087
DeprecationWarning, stacklevel=2)
2088
if old_tree is None:
2089
basis_tree = self.basis_tree()
2090
basis_tree.lock_read()
2091
old_tree = basis_tree
2095
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2097
if filenames is None and len(self.get_parent_ids()) > 1:
2099
last_revision = self.last_revision()
2100
if last_revision != _mod_revision.NULL_REVISION:
2101
if basis_tree is None:
2102
basis_tree = self.basis_tree()
2103
basis_tree.lock_read()
2104
parent_trees.append((last_revision, basis_tree))
2105
self.set_parent_trees(parent_trees)
2108
resolve(self, filenames, ignore_misses=True, recursive=True)
2110
if basis_tree is not None:
2114
def revision_tree(self, revision_id):
2115
"""See Tree.revision_tree.
2117
WorkingTree can supply revision_trees for the basis revision only
2118
because there is only one cached inventory in the bzr directory.
2120
if revision_id == self.last_revision():
2122
xml = self.read_basis_inventory()
2123
except errors.NoSuchFile:
2127
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2128
# dont use the repository revision_tree api because we want
2129
# to supply the inventory.
2130
if inv.revision_id == revision_id:
2131
return revisiontree.RevisionTree(self.branch.repository,
2133
except errors.BadInventoryFormat:
2135
# raise if there was no inventory, or if we read the wrong inventory.
2136
raise errors.NoSuchRevisionInTree(self, revision_id)
2138
# XXX: This method should be deprecated in favour of taking in a proper
2139
# new Inventory object.
2140
@needs_tree_write_lock
2141
def set_inventory(self, new_inventory_list):
2142
from bzrlib.inventory import (Inventory,
2146
inv = Inventory(self.get_root_id())
2147
for path, file_id, parent, kind in new_inventory_list:
2148
name = os.path.basename(path)
2151
# fixme, there should be a factory function inv,add_??
2152
if kind == 'directory':
2153
inv.add(InventoryDirectory(file_id, name, parent))
2154
elif kind == 'file':
2155
inv.add(InventoryFile(file_id, name, parent))
2156
elif kind == 'symlink':
2157
inv.add(InventoryLink(file_id, name, parent))
2159
raise errors.BzrError("unknown kind %r" % kind)
2160
self._write_inventory(inv)
2162
@needs_tree_write_lock
2163
def set_root_id(self, file_id):
2164
"""Set the root id for this tree."""
2168
'WorkingTree.set_root_id with fileid=None')
2169
file_id = osutils.safe_file_id(file_id)
2170
self._set_root_id(file_id)
2172
def _set_root_id(self, file_id):
2173
"""Set the root id for this tree, in a format specific manner.
2175
:param file_id: The file id to assign to the root. It must not be
2176
present in the current inventory or an error will occur. It must
2177
not be None, but rather a valid file id.
2179
inv = self._inventory
2180
orig_root_id = inv.root.file_id
2181
# TODO: it might be nice to exit early if there was nothing
2182
# to do, saving us from trigger a sync on unlock.
2183
self._inventory_is_modified = True
2184
# we preserve the root inventory entry object, but
2185
# unlinkit from the byid index
2186
del inv._byid[inv.root.file_id]
2187
inv.root.file_id = file_id
2188
# and link it into the index with the new changed id.
2189
inv._byid[inv.root.file_id] = inv.root
2190
# and finally update all children to reference the new id.
2191
# XXX: this should be safe to just look at the root.children
2192
# list, not the WHOLE INVENTORY.
2195
if entry.parent_id == orig_root_id:
2196
entry.parent_id = inv.root.file_id
2199
"""See Branch.unlock.
2201
WorkingTree locking just uses the Branch locking facilities.
2202
This is current because all working trees have an embedded branch
2203
within them. IF in the future, we were to make branch data shareable
2204
between multiple working trees, i.e. via shared storage, then we
2205
would probably want to lock both the local tree, and the branch.
2207
raise NotImplementedError(self.unlock)
2211
def update(self, change_reporter=None, possible_transports=None,
2212
revision=None, old_tip=_marker):
2213
"""Update a working tree along its branch.
2215
This will update the branch if its bound too, which means we have
2216
multiple trees involved:
2218
- The new basis tree of the master.
2219
- The old basis tree of the branch.
2220
- The old basis tree of the working tree.
2221
- The current working tree state.
2223
Pathologically, all three may be different, and non-ancestors of each
2224
other. Conceptually we want to:
2226
- Preserve the wt.basis->wt.state changes
2227
- Transform the wt.basis to the new master basis.
2228
- Apply a merge of the old branch basis to get any 'local' changes from
2230
- Restore the wt.basis->wt.state changes.
2232
There isn't a single operation at the moment to do that, so we:
2233
- Merge current state -> basis tree of the master w.r.t. the old tree
2235
- Do a 'normal' merge of the old branch basis if it is relevant.
2237
:param revision: The target revision to update to. Must be in the
2239
:param old_tip: If branch.update() has already been run, the value it
2240
returned (old tip of the branch or None). _marker is used
2243
if self.branch.get_bound_location() is not None:
2245
update_branch = (old_tip is self._marker)
2247
self.lock_tree_write()
2248
update_branch = False
2251
old_tip = self.branch.update(possible_transports)
2253
if old_tip is self._marker:
2255
return self._update_tree(old_tip, change_reporter, revision)
2259
@needs_tree_write_lock
2260
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2261
"""Update a tree to the master branch.
2263
:param old_tip: if supplied, the previous tip revision the branch,
2264
before it was changed to the master branch's tip.
2266
# here if old_tip is not None, it is the old tip of the branch before
2267
# it was updated from the master branch. This should become a pending
2268
# merge in the working tree to preserve the user existing work. we
2269
# cant set that until we update the working trees last revision to be
2270
# one from the new branch, because it will just get absorbed by the
2271
# parent de-duplication logic.
2273
# We MUST save it even if an error occurs, because otherwise the users
2274
# local work is unreferenced and will appear to have been lost.
2278
last_rev = self.get_parent_ids()[0]
2280
last_rev = _mod_revision.NULL_REVISION
2281
if revision is None:
2282
revision = self.branch.last_revision()
2284
old_tip = old_tip or _mod_revision.NULL_REVISION
2286
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2287
# the branch we are bound to was updated
2288
# merge those changes in first
2289
base_tree = self.basis_tree()
2290
other_tree = self.branch.repository.revision_tree(old_tip)
2291
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2292
base_tree, this_tree=self,
2293
change_reporter=change_reporter)
2295
self.add_parent_tree((old_tip, other_tree))
2296
trace.note('Rerun update after fixing the conflicts.')
2299
if last_rev != _mod_revision.ensure_null(revision):
2300
# the working tree is up to date with the branch
2301
# we can merge the specified revision from master
2302
to_tree = self.branch.repository.revision_tree(revision)
2303
to_root_id = to_tree.get_root_id()
2305
basis = self.basis_tree()
2308
if (basis.inventory.root is None
2309
or basis.inventory.root.file_id != to_root_id):
2310
self.set_root_id(to_root_id)
2315
# determine the branch point
2316
graph = self.branch.repository.get_graph()
2317
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2319
base_tree = self.branch.repository.revision_tree(base_rev_id)
2321
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2323
change_reporter=change_reporter)
2324
self.set_last_revision(revision)
2325
# TODO - dedup parents list with things merged by pull ?
2326
# reuse the tree we've updated to to set the basis:
2327
parent_trees = [(revision, to_tree)]
2328
merges = self.get_parent_ids()[1:]
2329
# Ideally we ask the tree for the trees here, that way the working
2330
# tree can decide whether to give us the entire tree or give us a
2331
# lazy initialised tree. dirstate for instance will have the trees
2332
# in ram already, whereas a last-revision + basis-inventory tree
2333
# will not, but also does not need them when setting parents.
2334
for parent in merges:
2335
parent_trees.append(
2336
(parent, self.branch.repository.revision_tree(parent)))
2337
if not _mod_revision.is_null(old_tip):
2338
parent_trees.append(
2339
(old_tip, self.branch.repository.revision_tree(old_tip)))
2340
self.set_parent_trees(parent_trees)
2341
last_rev = parent_trees[0][0]
2344
def _write_hashcache_if_dirty(self):
2345
"""Write out the hashcache if it is dirty."""
2346
if self._hashcache.needs_write:
2348
self._hashcache.write()
2350
if e.errno not in (errno.EPERM, errno.EACCES):
2352
# TODO: jam 20061219 Should this be a warning? A single line
2353
# warning might be sufficient to let the user know what
2355
mutter('Could not write hashcache for %s\nError: %s',
2356
self._hashcache.cache_file_name(), e)
2358
@needs_tree_write_lock
2359
def _write_inventory(self, inv):
2360
"""Write inventory as the current inventory."""
2361
self._set_inventory(inv, dirty=True)
2364
def set_conflicts(self, arg):
2365
raise errors.UnsupportedOperation(self.set_conflicts, self)
2367
def add_conflicts(self, arg):
2368
raise errors.UnsupportedOperation(self.add_conflicts, self)
2371
def conflicts(self):
2372
conflicts = _mod_conflicts.ConflictList()
2373
for conflicted in self._iter_conflicts():
2376
if file_kind(self.abspath(conflicted)) != "file":
2378
except errors.NoSuchFile:
2381
for suffix in ('.THIS', '.OTHER'):
2383
kind = file_kind(self.abspath(conflicted+suffix))
2386
except errors.NoSuchFile:
2390
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2391
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2393
file_id=self.path2id(conflicted)))
2396
def walkdirs(self, prefix=""):
2397
"""Walk the directories of this tree.
2399
returns a generator which yields items in the form:
2400
((curren_directory_path, fileid),
2401
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2404
This API returns a generator, which is only valid during the current
2405
tree transaction - within a single lock_read or lock_write duration.
2407
If the tree is not locked, it may cause an error to be raised,
2408
depending on the tree implementation.
2410
disk_top = self.abspath(prefix)
2411
if disk_top.endswith('/'):
2412
disk_top = disk_top[:-1]
2413
top_strip_len = len(disk_top) + 1
2414
inventory_iterator = self._walkdirs(prefix)
2415
disk_iterator = osutils.walkdirs(disk_top, prefix)
2417
current_disk = disk_iterator.next()
2418
disk_finished = False
2420
if not (e.errno == errno.ENOENT or
2421
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2424
disk_finished = True
2426
current_inv = inventory_iterator.next()
2427
inv_finished = False
2428
except StopIteration:
2431
while not inv_finished or not disk_finished:
2433
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2434
cur_disk_dir_content) = current_disk
2436
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2437
cur_disk_dir_content) = ((None, None), None)
2438
if not disk_finished:
2439
# strip out .bzr dirs
2440
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2441
len(cur_disk_dir_content) > 0):
2442
# osutils.walkdirs can be made nicer -
2443
# yield the path-from-prefix rather than the pathjoined
2445
bzrdir_loc = bisect_left(cur_disk_dir_content,
2447
if (bzrdir_loc < len(cur_disk_dir_content)
2448
and self.bzrdir.is_control_filename(
2449
cur_disk_dir_content[bzrdir_loc][0])):
2450
# we dont yield the contents of, or, .bzr itself.
2451
del cur_disk_dir_content[bzrdir_loc]
2453
# everything is unknown
2456
# everything is missing
2459
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2461
# disk is before inventory - unknown
2462
dirblock = [(relpath, basename, kind, stat, None, None) for
2463
relpath, basename, kind, stat, top_path in
2464
cur_disk_dir_content]
2465
yield (cur_disk_dir_relpath, None), dirblock
2467
current_disk = disk_iterator.next()
2468
except StopIteration:
2469
disk_finished = True
2471
# inventory is before disk - missing.
2472
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2473
for relpath, basename, dkind, stat, fileid, kind in
2475
yield (current_inv[0][0], current_inv[0][1]), dirblock
2477
current_inv = inventory_iterator.next()
2478
except StopIteration:
2481
# versioned present directory
2482
# merge the inventory and disk data together
2484
for relpath, subiterator in itertools.groupby(sorted(
2485
current_inv[1] + cur_disk_dir_content,
2486
key=operator.itemgetter(0)), operator.itemgetter(1)):
2487
path_elements = list(subiterator)
2488
if len(path_elements) == 2:
2489
inv_row, disk_row = path_elements
2490
# versioned, present file
2491
dirblock.append((inv_row[0],
2492
inv_row[1], disk_row[2],
2493
disk_row[3], inv_row[4],
2495
elif len(path_elements[0]) == 5:
2497
dirblock.append((path_elements[0][0],
2498
path_elements[0][1], path_elements[0][2],
2499
path_elements[0][3], None, None))
2500
elif len(path_elements[0]) == 6:
2501
# versioned, absent file.
2502
dirblock.append((path_elements[0][0],
2503
path_elements[0][1], 'unknown', None,
2504
path_elements[0][4], path_elements[0][5]))
2506
raise NotImplementedError('unreachable code')
2507
yield current_inv[0], dirblock
2509
current_inv = inventory_iterator.next()
2510
except StopIteration:
2513
current_disk = disk_iterator.next()
2514
except StopIteration:
2515
disk_finished = True
2517
def _walkdirs(self, prefix=""):
2518
"""Walk the directories of this tree.
2520
:prefix: is used as the directrory to start with.
2521
returns a generator which yields items in the form:
2522
((curren_directory_path, fileid),
2523
[(file1_path, file1_name, file1_kind, None, file1_id,
2526
_directory = 'directory'
2527
# get the root in the inventory
2528
inv = self.inventory
2529
top_id = inv.path2id(prefix)
2533
pending = [(prefix, '', _directory, None, top_id, None)]
2536
currentdir = pending.pop()
2537
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2538
top_id = currentdir[4]
2540
relroot = currentdir[0] + '/'
2543
# FIXME: stash the node in pending
2545
if entry.kind == 'directory':
2546
for name, child in entry.sorted_children():
2547
dirblock.append((relroot + name, name, child.kind, None,
2548
child.file_id, child.kind
2550
yield (currentdir[0], entry.file_id), dirblock
2551
# push the user specified dirs from dirblock
2552
for dir in reversed(dirblock):
2553
if dir[2] == _directory:
2556
@needs_tree_write_lock
2557
def auto_resolve(self):
2558
"""Automatically resolve text conflicts according to contents.
2560
Only text conflicts are auto_resolvable. Files with no conflict markers
2561
are considered 'resolved', because bzr always puts conflict markers
2562
into files that have text conflicts. The corresponding .THIS .BASE and
2563
.OTHER files are deleted, as per 'resolve'.
2564
:return: a tuple of ConflictLists: (un_resolved, resolved).
2566
un_resolved = _mod_conflicts.ConflictList()
2567
resolved = _mod_conflicts.ConflictList()
2568
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2569
for conflict in self.conflicts():
2570
if (conflict.typestring != 'text conflict' or
2571
self.kind(conflict.file_id) != 'file'):
2572
un_resolved.append(conflict)
2574
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2576
for line in my_file:
2577
if conflict_re.search(line):
2578
un_resolved.append(conflict)
2581
resolved.append(conflict)
2584
resolved.remove_files(self)
2585
self.set_conflicts(un_resolved)
2586
return un_resolved, resolved
2589
def _check(self, references):
2590
"""Check the tree for consistency.
2592
:param references: A dict with keys matching the items returned by
2593
self._get_check_refs(), and values from looking those keys up in
2596
tree_basis = self.basis_tree()
2597
tree_basis.lock_read()
2599
repo_basis = references[('trees', self.last_revision())]
2600
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2601
raise errors.BzrCheckError(
2602
"Mismatched basis inventory content.")
2607
def _validate(self):
2608
"""Validate internal structures.
2610
This is meant mostly for the test suite. To give it a chance to detect
2611
corruption after actions have occurred. The default implementation is a
2614
:return: None. An exception should be raised if there is an error.
2618
def _get_rules_searcher(self, default_searcher):
2619
"""See Tree._get_rules_searcher."""
2620
if self._rules_searcher is None:
2621
self._rules_searcher = super(WorkingTree,
2622
self)._get_rules_searcher(default_searcher)
2623
return self._rules_searcher
2625
def get_shelf_manager(self):
2626
"""Return the ShelfManager for this WorkingTree."""
2627
from bzrlib.shelf import ShelfManager
2628
return ShelfManager(self, self._transport)
2631
class WorkingTree2(WorkingTree):
2632
"""This is the Format 2 working tree.
2634
This was the first weave based working tree.
2635
- uses os locks for locking.
2636
- uses the branch last-revision.
2639
def __init__(self, *args, **kwargs):
2640
super(WorkingTree2, self).__init__(*args, **kwargs)
2641
# WorkingTree2 has more of a constraint that self._inventory must
2642
# exist. Because this is an older format, we don't mind the overhead
2643
# caused by the extra computation here.
2645
# Newer WorkingTree's should only have self._inventory set when they
2647
if self._inventory is None:
2648
self.read_working_inventory()
2650
def _get_check_refs(self):
2651
"""Return the references needed to perform a check of this tree."""
2652
return [('trees', self.last_revision())]
2654
def lock_tree_write(self):
2655
"""See WorkingTree.lock_tree_write().
2657
In Format2 WorkingTrees we have a single lock for the branch and tree
2658
so lock_tree_write() degrades to lock_write().
2660
:return: An object with an unlock method which will release the lock
2663
self.branch.lock_write()
2665
self._control_files.lock_write()
2668
self.branch.unlock()
2672
# do non-implementation specific cleanup
2675
# we share control files:
2676
if self._control_files._lock_count == 3:
2677
# _inventory_is_modified is always False during a read lock.
2678
if self._inventory_is_modified:
2680
self._write_hashcache_if_dirty()
2682
# reverse order of locking.
2684
return self._control_files.unlock()
2686
self.branch.unlock()
2689
class WorkingTree3(WorkingTree):
2690
"""This is the Format 3 working tree.
2692
This differs from the base WorkingTree by:
2693
- having its own file lock
2694
- having its own last-revision property.
2696
This is new in bzr 0.8
2700
def _last_revision(self):
2701
"""See Mutable.last_revision."""
2703
return self._transport.get_bytes('last-revision')
2704
except errors.NoSuchFile:
2705
return _mod_revision.NULL_REVISION
2707
def _change_last_revision(self, revision_id):
2708
"""See WorkingTree._change_last_revision."""
2709
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2711
self._transport.delete('last-revision')
2712
except errors.NoSuchFile:
2716
self._transport.put_bytes('last-revision', revision_id,
2717
mode=self.bzrdir._get_file_mode())
2720
def _get_check_refs(self):
2721
"""Return the references needed to perform a check of this tree."""
2722
return [('trees', self.last_revision())]
2724
@needs_tree_write_lock
2725
def set_conflicts(self, conflicts):
2726
self._put_rio('conflicts', conflicts.to_stanzas(),
2729
@needs_tree_write_lock
2730
def add_conflicts(self, new_conflicts):
2731
conflict_set = set(self.conflicts())
2732
conflict_set.update(set(list(new_conflicts)))
2733
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2734
key=_mod_conflicts.Conflict.sort_key)))
2737
def conflicts(self):
2739
confile = self._transport.get('conflicts')
2740
except errors.NoSuchFile:
2741
return _mod_conflicts.ConflictList()
2744
if confile.next() != CONFLICT_HEADER_1 + '\n':
2745
raise errors.ConflictFormatError()
2746
except StopIteration:
2747
raise errors.ConflictFormatError()
2748
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2753
# do non-implementation specific cleanup
2755
if self._control_files._lock_count == 1:
2756
# _inventory_is_modified is always False during a read lock.
2757
if self._inventory_is_modified:
2759
self._write_hashcache_if_dirty()
2760
# reverse order of locking.
2762
return self._control_files.unlock()
2764
self.branch.unlock()
2767
def get_conflicted_stem(path):
2768
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2769
if path.endswith(suffix):
2770
return path[:-len(suffix)]
2773
class WorkingTreeFormat(object):
2774
"""An encapsulation of the initialization and open routines for a format.
2776
Formats provide three things:
2777
* An initialization routine,
2781
Formats are placed in an dict by their format string for reference
2782
during workingtree opening. Its not required that these be instances, they
2783
can be classes themselves with class methods - it simply depends on
2784
whether state is needed for a given format or not.
2786
Once a format is deprecated, just deprecate the initialize and open
2787
methods on the format class. Do not deprecate the object, as the
2788
object will be created every time regardless.
2791
_default_format = None
2792
"""The default format used for new trees."""
2795
"""The known formats."""
2797
requires_rich_root = False
2799
upgrade_recommended = False
2802
def find_format(klass, a_bzrdir):
2803
"""Return the format for the working tree object in a_bzrdir."""
2805
transport = a_bzrdir.get_workingtree_transport(None)
2806
format_string = transport.get_bytes("format")
2807
return klass._formats[format_string]
2808
except errors.NoSuchFile:
2809
raise errors.NoWorkingTree(base=transport.base)
2811
raise errors.UnknownFormatError(format=format_string,
2812
kind="working tree")
2814
def __eq__(self, other):
2815
return self.__class__ is other.__class__
2817
def __ne__(self, other):
2818
return not (self == other)
2821
def get_default_format(klass):
2822
"""Return the current default format."""
2823
return klass._default_format
2825
def get_format_string(self):
2826
"""Return the ASCII format string that identifies this format."""
2827
raise NotImplementedError(self.get_format_string)
2829
def get_format_description(self):
2830
"""Return the short description for this format."""
2831
raise NotImplementedError(self.get_format_description)
2833
def is_supported(self):
2834
"""Is this format supported?
2836
Supported formats can be initialized and opened.
2837
Unsupported formats may not support initialization or committing or
2838
some other features depending on the reason for not being supported.
2842
def supports_content_filtering(self):
2843
"""True if this format supports content filtering."""
2846
def supports_views(self):
2847
"""True if this format supports stored views."""
2851
def register_format(klass, format):
2852
klass._formats[format.get_format_string()] = format
2855
def set_default_format(klass, format):
2856
klass._default_format = format
2859
def unregister_format(klass, format):
2860
del klass._formats[format.get_format_string()]
2863
class WorkingTreeFormat2(WorkingTreeFormat):
2864
"""The second working tree format.
2866
This format modified the hash cache from the format 1 hash cache.
2869
upgrade_recommended = True
2871
def get_format_description(self):
2872
"""See WorkingTreeFormat.get_format_description()."""
2873
return "Working tree format 2"
2875
def _stub_initialize_on_transport(self, transport, file_mode):
2876
"""Workaround: create control files for a remote working tree.
2878
This ensures that it can later be updated and dealt with locally,
2879
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2880
no working tree. (See bug #43064).
2883
inv = inventory.Inventory()
2884
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2886
transport.put_file('inventory', sio, file_mode)
2887
transport.put_bytes('pending-merges', '', file_mode)
2889
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2890
accelerator_tree=None, hardlink=False):
2891
"""See WorkingTreeFormat.initialize()."""
2892
if not isinstance(a_bzrdir.transport, LocalTransport):
2893
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2894
if from_branch is not None:
2895
branch = from_branch
2897
branch = a_bzrdir.open_branch()
2898
if revision_id is None:
2899
revision_id = _mod_revision.ensure_null(branch.last_revision())
2902
branch.generate_revision_history(revision_id)
2905
inv = inventory.Inventory()
2906
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2912
basis_tree = branch.repository.revision_tree(revision_id)
2913
if basis_tree.inventory.root is not None:
2914
wt.set_root_id(basis_tree.get_root_id())
2915
# set the parent list and cache the basis tree.
2916
if _mod_revision.is_null(revision_id):
2919
parent_trees = [(revision_id, basis_tree)]
2920
wt.set_parent_trees(parent_trees)
2921
transform.build_tree(basis_tree, wt)
2925
super(WorkingTreeFormat2, self).__init__()
2926
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2928
def open(self, a_bzrdir, _found=False):
2929
"""Return the WorkingTree object for a_bzrdir
2931
_found is a private parameter, do not use it. It is used to indicate
2932
if format probing has already been done.
2935
# we are being called directly and must probe.
2936
raise NotImplementedError
2937
if not isinstance(a_bzrdir.transport, LocalTransport):
2938
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2939
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2945
class WorkingTreeFormat3(WorkingTreeFormat):
2946
"""The second working tree format updated to record a format marker.
2949
- exists within a metadir controlling .bzr
2950
- includes an explicit version marker for the workingtree control
2951
files, separate from the BzrDir format
2952
- modifies the hash cache format
2954
- uses a LockDir to guard access for writes.
2957
upgrade_recommended = True
2959
def get_format_string(self):
2960
"""See WorkingTreeFormat.get_format_string()."""
2961
return "Bazaar-NG Working Tree format 3"
2963
def get_format_description(self):
2964
"""See WorkingTreeFormat.get_format_description()."""
2965
return "Working tree format 3"
2967
_lock_file_name = 'lock'
2968
_lock_class = LockDir
2970
_tree_class = WorkingTree3
2972
def __get_matchingbzrdir(self):
2973
return bzrdir.BzrDirMetaFormat1()
2975
_matchingbzrdir = property(__get_matchingbzrdir)
2977
def _open_control_files(self, a_bzrdir):
2978
transport = a_bzrdir.get_workingtree_transport(None)
2979
return LockableFiles(transport, self._lock_file_name,
2982
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2983
accelerator_tree=None, hardlink=False):
2984
"""See WorkingTreeFormat.initialize().
2986
:param revision_id: if supplied, create a working tree at a different
2987
revision than the branch is at.
2988
:param accelerator_tree: A tree which can be used for retrieving file
2989
contents more quickly than the revision tree, i.e. a workingtree.
2990
The revision tree will be used for cases where accelerator_tree's
2991
content is different.
2992
:param hardlink: If true, hard-link files from accelerator_tree,
2995
if not isinstance(a_bzrdir.transport, LocalTransport):
2996
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2997
transport = a_bzrdir.get_workingtree_transport(self)
2998
control_files = self._open_control_files(a_bzrdir)
2999
control_files.create_lock()
3000
control_files.lock_write()
3001
transport.put_bytes('format', self.get_format_string(),
3002
mode=a_bzrdir._get_file_mode())
3003
if from_branch is not None:
3004
branch = from_branch
3006
branch = a_bzrdir.open_branch()
3007
if revision_id is None:
3008
revision_id = _mod_revision.ensure_null(branch.last_revision())
3009
# WorkingTree3 can handle an inventory which has a unique root id.
3010
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3011
# those trees. And because there isn't a format bump inbetween, we
3012
# are maintaining compatibility with older clients.
3013
# inv = Inventory(root_id=gen_root_id())
3014
inv = self._initial_inventory()
3015
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3021
_control_files=control_files)
3022
wt.lock_tree_write()
3024
basis_tree = branch.repository.revision_tree(revision_id)
3025
# only set an explicit root id if there is one to set.
3026
if basis_tree.inventory.root is not None:
3027
wt.set_root_id(basis_tree.get_root_id())
3028
if revision_id == _mod_revision.NULL_REVISION:
3029
wt.set_parent_trees([])
3031
wt.set_parent_trees([(revision_id, basis_tree)])
3032
transform.build_tree(basis_tree, wt)
3034
# Unlock in this order so that the unlock-triggers-flush in
3035
# WorkingTree is given a chance to fire.
3036
control_files.unlock()
3040
def _initial_inventory(self):
3041
return inventory.Inventory()
3044
super(WorkingTreeFormat3, self).__init__()
3046
def open(self, a_bzrdir, _found=False):
3047
"""Return the WorkingTree object for a_bzrdir
3049
_found is a private parameter, do not use it. It is used to indicate
3050
if format probing has already been done.
3053
# we are being called directly and must probe.
3054
raise NotImplementedError
3055
if not isinstance(a_bzrdir.transport, LocalTransport):
3056
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3057
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3060
def _open(self, a_bzrdir, control_files):
3061
"""Open the tree itself.
3063
:param a_bzrdir: the dir for the tree.
3064
:param control_files: the control files for the tree.
3066
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3070
_control_files=control_files)
3073
return self.get_format_string()
3076
__default_format = WorkingTreeFormat6()
3077
WorkingTreeFormat.register_format(__default_format)
3078
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3079
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3080
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3081
WorkingTreeFormat.set_default_format(__default_format)
3082
# formats which have no format string are not discoverable
3083
# and not independently creatable, so are not registered.
3084
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
