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).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
57
conflicts as _mod_conflicts,
66
revision as _mod_revision,
76
from bzrlib.transport import get_transport
77
from bzrlib.workingtree_4 import (
84
from bzrlib import symbol_versioning
85
from bzrlib.decorators import needs_read_lock, needs_write_lock
86
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib import osutils
91
from bzrlib.osutils import (
101
from bzrlib.filters import filtered_input_file
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.revision import CURRENT_REVISION
105
from bzrlib.rio import RioReader, rio_file, Stanza
106
from bzrlib.symbol_versioning import (
108
DEPRECATED_PARAMETER,
112
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
113
# TODO: Modifying the conflict objects or their type is currently nearly
114
# impossible as there is no clear relationship between the working tree format
115
# and the conflict list file format.
116
CONFLICT_HEADER_1 = "BZR conflict list format 1"
118
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
121
class TreeEntry(object):
122
"""An entry that implements the minimum interface used by commands.
124
This needs further inspection, it may be better to have
125
InventoryEntries without ids - though that seems wrong. For now,
126
this is a parallel hierarchy to InventoryEntry, and needs to become
127
one of several things: decorates to that hierarchy, children of, or
129
Another note is that these objects are currently only used when there is
130
no InventoryEntry available - i.e. for unversioned objects.
131
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
134
def __eq__(self, other):
135
# yes, this us ugly, TODO: best practice __eq__ style.
136
return (isinstance(other, TreeEntry)
137
and other.__class__ == self.__class__)
139
def kind_character(self):
143
class TreeDirectory(TreeEntry):
144
"""See TreeEntry. This is a directory in a working tree."""
146
def __eq__(self, other):
147
return (isinstance(other, TreeDirectory)
148
and other.__class__ == self.__class__)
150
def kind_character(self):
154
class TreeFile(TreeEntry):
155
"""See TreeEntry. This is a regular file in a working tree."""
157
def __eq__(self, other):
158
return (isinstance(other, TreeFile)
159
and other.__class__ == self.__class__)
161
def kind_character(self):
165
class TreeLink(TreeEntry):
166
"""See TreeEntry. This is a symlink in a working tree."""
168
def __eq__(self, other):
169
return (isinstance(other, TreeLink)
170
and other.__class__ == self.__class__)
172
def kind_character(self):
176
class WorkingTree(bzrlib.mutabletree.MutableTree):
177
"""Working copy tree.
179
The inventory is held in the `Branch` working-inventory, and the
180
files are in a directory on disk.
182
It is possible for a `WorkingTree` to have a filename which is
183
not listed in the Inventory and vice versa.
186
# override this to set the strategy for storing views
187
def _make_views(self):
188
return views.DisabledViews(self)
190
def __init__(self, basedir='.',
191
branch=DEPRECATED_PARAMETER,
197
"""Construct a WorkingTree instance. This is not a public API.
199
:param branch: A branch to override probing for the branch.
201
self._format = _format
202
self.bzrdir = _bzrdir
204
raise errors.BzrError("Please use bzrdir.open_workingtree or "
205
"WorkingTree.open() to obtain a WorkingTree.")
206
basedir = safe_unicode(basedir)
207
mutter("opening working tree %r", basedir)
208
if deprecated_passed(branch):
209
self._branch = branch
211
self._branch = self.bzrdir.open_branch()
212
self.basedir = realpath(basedir)
213
# if branch is at our basedir and is a format 6 or less
214
if isinstance(self._format, WorkingTreeFormat2):
215
# share control object
216
self._control_files = self.branch.control_files
218
# assume all other formats have their own control files.
219
self._control_files = _control_files
220
self._transport = self._control_files._transport
221
# update the whole cache up front and write to disk if anything changed;
222
# in the future we might want to do this more selectively
223
# two possible ways offer themselves : in self._unlock, write the cache
224
# if needed, or, when the cache sees a change, append it to the hash
225
# cache file, and have the parser take the most recent entry for a
227
wt_trans = self.bzrdir.get_workingtree_transport(None)
228
cache_filename = wt_trans.local_abspath('stat-cache')
229
self._hashcache = hashcache.HashCache(basedir, cache_filename,
230
self.bzrdir._get_file_mode(),
231
self._content_filter_stack_provider())
234
# is this scan needed ? it makes things kinda slow.
241
if _inventory is None:
242
# This will be acquired on lock_read() or lock_write()
243
self._inventory_is_modified = False
244
self._inventory = None
246
# the caller of __init__ has provided an inventory,
247
# we assume they know what they are doing - as its only
248
# the Format factory and creation methods that are
249
# permitted to do this.
250
self._set_inventory(_inventory, dirty=False)
251
self._detect_case_handling()
252
self._rules_searcher = None
253
self.views = self._make_views()
255
def _detect_case_handling(self):
256
wt_trans = self.bzrdir.get_workingtree_transport(None)
258
wt_trans.stat("FoRMaT")
259
except errors.NoSuchFile:
260
self.case_sensitive = True
262
self.case_sensitive = False
264
self._setup_directory_is_tree_reference()
267
fget=lambda self: self._branch,
268
doc="""The branch this WorkingTree is connected to.
270
This cannot be set - it is reflective of the actual disk structure
271
the working tree has been constructed from.
274
def break_lock(self):
275
"""Break a lock if one is present from another instance.
277
Uses the ui factory to ask for confirmation if the lock may be from
280
This will probe the repository for its lock as well.
282
self._control_files.break_lock()
283
self.branch.break_lock()
285
def _get_check_refs(self):
286
"""Return the references needed to perform a check of this tree.
288
The default implementation returns no refs, and is only suitable for
289
trees that have no local caching and can commit on ghosts at any time.
291
:seealso: bzrlib.check for details about check_refs.
295
def requires_rich_root(self):
296
return self._format.requires_rich_root
298
def supports_tree_reference(self):
301
def supports_content_filtering(self):
302
return self._format.supports_content_filtering()
304
def supports_views(self):
305
return self.views.supports_views()
307
def _set_inventory(self, inv, dirty):
308
"""Set the internal cached inventory.
310
:param inv: The inventory to set.
311
:param dirty: A boolean indicating whether the inventory is the same
312
logical inventory as whats on disk. If True the inventory is not
313
the same and should be written to disk or data will be lost, if
314
False then the inventory is the same as that on disk and any
315
serialisation would be unneeded overhead.
317
self._inventory = inv
318
self._inventory_is_modified = dirty
321
def open(path=None, _unsupported=False):
322
"""Open an existing working tree at path.
326
path = osutils.getcwd()
327
control = bzrdir.BzrDir.open(path, _unsupported)
328
return control.open_workingtree(_unsupported)
331
def open_containing(path=None):
332
"""Open an existing working tree which has its root about path.
334
This probes for a working tree at path and searches upwards from there.
336
Basically we keep looking up until we find the control directory or
337
run into /. If there isn't one, raises NotBranchError.
338
TODO: give this a new exception.
339
If there is one, it is returned, along with the unused portion of path.
341
:return: The WorkingTree that contains 'path', and the rest of path
344
path = osutils.getcwd()
345
control, relpath = bzrdir.BzrDir.open_containing(path)
347
return control.open_workingtree(), relpath
350
def open_downlevel(path=None):
351
"""Open an unsupported working tree.
353
Only intended for advanced situations like upgrading part of a bzrdir.
355
return WorkingTree.open(path, _unsupported=True)
358
def find_trees(location):
359
def list_current(transport):
360
return [d for d in transport.list_dir('') if d != '.bzr']
361
def evaluate(bzrdir):
363
tree = bzrdir.open_workingtree()
364
except errors.NoWorkingTree:
368
transport = get_transport(location)
369
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
370
list_current=list_current)
371
return [t for t in iterator if t is not None]
373
# should be deprecated - this is slow and in any case treating them as a
374
# container is (we now know) bad style -- mbp 20070302
375
## @deprecated_method(zero_fifteen)
377
"""Iterate through file_ids for this tree.
379
file_ids are in a WorkingTree if they are in the working inventory
380
and the working file exists.
382
inv = self._inventory
383
for path, ie in inv.iter_entries():
384
if osutils.lexists(self.abspath(path)):
387
def all_file_ids(self):
388
"""See Tree.iter_all_file_ids"""
389
return set(self.inventory)
392
return "<%s of %s>" % (self.__class__.__name__,
393
getattr(self, 'basedir', None))
395
def abspath(self, filename):
396
return pathjoin(self.basedir, filename)
398
def basis_tree(self):
399
"""Return RevisionTree for the current last revision.
401
If the left most parent is a ghost then the returned tree will be an
402
empty tree - one obtained by calling
403
repository.revision_tree(NULL_REVISION).
406
revision_id = self.get_parent_ids()[0]
408
# no parents, return an empty revision tree.
409
# in the future this should return the tree for
410
# 'empty:' - the implicit root empty tree.
411
return self.branch.repository.revision_tree(
412
_mod_revision.NULL_REVISION)
414
return self.revision_tree(revision_id)
415
except errors.NoSuchRevision:
417
# No cached copy available, retrieve from the repository.
418
# FIXME? RBC 20060403 should we cache the inventory locally
421
return self.branch.repository.revision_tree(revision_id)
422
except (errors.RevisionNotPresent, errors.NoSuchRevision):
423
# the basis tree *may* be a ghost or a low level error may have
424
# occurred. If the revision is present, its a problem, if its not
426
if self.branch.repository.has_revision(revision_id):
428
# the basis tree is a ghost so return an empty tree.
429
return self.branch.repository.revision_tree(
430
_mod_revision.NULL_REVISION)
433
self._flush_ignore_list_cache()
435
def relpath(self, path):
436
"""Return the local path portion from a given path.
438
The path may be absolute or relative. If its a relative path it is
439
interpreted relative to the python current working directory.
441
return osutils.relpath(self.basedir, path)
443
def has_filename(self, filename):
444
return osutils.lexists(self.abspath(filename))
446
def get_file(self, file_id, path=None, filtered=True):
447
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
449
def get_file_with_stat(self, file_id, path=None, filtered=True,
451
"""See Tree.get_file_with_stat."""
453
path = self.id2path(file_id)
454
file_obj = self.get_file_byname(path, filtered=False)
455
stat_value = _fstat(file_obj.fileno())
456
if filtered and self.supports_content_filtering():
457
filters = self._content_filter_stack(path)
458
file_obj = filtered_input_file(file_obj, filters)
459
return (file_obj, stat_value)
461
def get_file_text(self, file_id, path=None, filtered=True):
462
return self.get_file(file_id, path=path, filtered=filtered).read()
464
def get_file_byname(self, filename, filtered=True):
465
path = self.abspath(filename)
467
if filtered and self.supports_content_filtering():
468
filters = self._content_filter_stack(filename)
469
return filtered_input_file(f, filters)
473
def get_file_lines(self, file_id, path=None, filtered=True):
474
"""See Tree.get_file_lines()"""
475
file = self.get_file(file_id, path, filtered=filtered)
477
return file.readlines()
482
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
483
"""See Tree.annotate_iter
485
This implementation will use the basis tree implementation if possible.
486
Lines not in the basis are attributed to CURRENT_REVISION
488
If there are pending merges, lines added by those merges will be
489
incorrectly attributed to CURRENT_REVISION (but after committing, the
490
attribution will be correct).
492
maybe_file_parent_keys = []
493
for parent_id in self.get_parent_ids():
495
parent_tree = self.revision_tree(parent_id)
496
except errors.NoSuchRevisionInTree:
497
parent_tree = self.branch.repository.revision_tree(parent_id)
498
parent_tree.lock_read()
500
if file_id not in parent_tree:
502
ie = parent_tree.inventory[file_id]
503
if ie.kind != 'file':
504
# Note: this is slightly unnecessary, because symlinks and
505
# directories have a "text" which is the empty text, and we
506
# know that won't mess up annotations. But it seems cleaner
508
parent_text_key = (file_id, ie.revision)
509
if parent_text_key not in maybe_file_parent_keys:
510
maybe_file_parent_keys.append(parent_text_key)
513
graph = _mod_graph.Graph(self.branch.repository.texts)
514
heads = graph.heads(maybe_file_parent_keys)
515
file_parent_keys = []
516
for key in maybe_file_parent_keys:
518
file_parent_keys.append(key)
520
# Now we have the parents of this content
521
annotator = self.branch.repository.texts.get_annotator()
522
text = self.get_file(file_id).read()
523
this_key =(file_id, default_revision)
524
annotator.add_special_text(this_key, file_parent_keys, text)
525
annotations = [(key[-1], line)
526
for key, line in annotator.annotate_flat(this_key)]
529
def _get_ancestors(self, default_revision):
530
ancestors = set([default_revision])
531
for parent_id in self.get_parent_ids():
532
ancestors.update(self.branch.repository.get_ancestry(
533
parent_id, topo_sorted=False))
536
def get_parent_ids(self):
537
"""See Tree.get_parent_ids.
539
This implementation reads the pending merges list and last_revision
540
value and uses that to decide what the parents list should be.
542
last_rev = _mod_revision.ensure_null(self._last_revision())
543
if _mod_revision.NULL_REVISION == last_rev:
548
merges_bytes = self._transport.get_bytes('pending-merges')
549
except errors.NoSuchFile:
552
for l in osutils.split_lines(merges_bytes):
553
revision_id = l.rstrip('\n')
554
parents.append(revision_id)
558
def get_root_id(self):
559
"""Return the id of this trees root"""
560
return self._inventory.root.file_id
562
def _get_store_filename(self, file_id):
563
## XXX: badly named; this is not in the store at all
564
return self.abspath(self.id2path(file_id))
567
def clone(self, to_bzrdir, revision_id=None):
568
"""Duplicate this working tree into to_bzr, including all state.
570
Specifically modified files are kept as modified, but
571
ignored and unknown files are discarded.
573
If you want to make a new line of development, see bzrdir.sprout()
576
If not None, the cloned tree will have its last revision set to
577
revision, and difference between the source trees last revision
578
and this one merged in.
580
# assumes the target bzr dir format is compatible.
581
result = to_bzrdir.create_workingtree()
582
self.copy_content_into(result, revision_id)
586
def copy_content_into(self, tree, revision_id=None):
587
"""Copy the current content and user files of this tree into tree."""
588
tree.set_root_id(self.get_root_id())
589
if revision_id is None:
590
merge.transform_tree(tree, self)
592
# TODO now merge from tree.last_revision to revision (to preserve
593
# user local changes)
594
merge.transform_tree(tree, self)
595
tree.set_parent_ids([revision_id])
597
def id2abspath(self, file_id):
598
return self.abspath(self.id2path(file_id))
600
def has_id(self, file_id):
601
# files that have been deleted are excluded
603
if not inv.has_id(file_id):
605
path = inv.id2path(file_id)
606
return osutils.lexists(self.abspath(path))
608
def has_or_had_id(self, file_id):
609
if file_id == self.inventory.root.file_id:
611
return self.inventory.has_id(file_id)
613
__contains__ = has_id
615
def get_file_size(self, file_id):
616
"""See Tree.get_file_size"""
617
# XXX: this returns the on-disk size; it should probably return the
620
return os.path.getsize(self.id2abspath(file_id))
622
if e.errno != errno.ENOENT:
628
def get_file_sha1(self, file_id, path=None, stat_value=None):
630
path = self._inventory.id2path(file_id)
631
return self._hashcache.get_sha1(path, stat_value)
633
def get_file_mtime(self, file_id, path=None):
635
path = self.inventory.id2path(file_id)
636
return os.lstat(self.abspath(path)).st_mtime
638
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
639
file_id = self.path2id(path)
641
# For unversioned files on win32, we just assume they are not
644
return self._inventory[file_id].executable
646
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
647
mode = stat_result.st_mode
648
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
650
if not supports_executable():
651
def is_executable(self, file_id, path=None):
652
return self._inventory[file_id].executable
654
_is_executable_from_path_and_stat = \
655
_is_executable_from_path_and_stat_from_basis
657
def is_executable(self, file_id, path=None):
659
path = self.id2path(file_id)
660
mode = os.lstat(self.abspath(path)).st_mode
661
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
663
_is_executable_from_path_and_stat = \
664
_is_executable_from_path_and_stat_from_stat
666
@needs_tree_write_lock
667
def _add(self, files, ids, kinds):
668
"""See MutableTree._add."""
669
# TODO: Re-adding a file that is removed in the working copy
670
# should probably put it back with the previous ID.
671
# the read and write working inventory should not occur in this
672
# function - they should be part of lock_write and unlock.
674
for f, file_id, kind in zip(files, ids, kinds):
676
inv.add_path(f, kind=kind)
678
inv.add_path(f, kind=kind, file_id=file_id)
679
self._inventory_is_modified = True
681
@needs_tree_write_lock
682
def _gather_kinds(self, files, kinds):
683
"""See MutableTree._gather_kinds."""
684
for pos, f in enumerate(files):
685
if kinds[pos] is None:
686
fullpath = normpath(self.abspath(f))
688
kinds[pos] = file_kind(fullpath)
690
if e.errno == errno.ENOENT:
691
raise errors.NoSuchFile(fullpath)
694
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
695
"""Add revision_id as a parent.
697
This is equivalent to retrieving the current list of parent ids
698
and setting the list to its value plus revision_id.
700
:param revision_id: The revision id to add to the parent list. It may
701
be a ghost revision as long as its not the first parent to be added,
702
or the allow_leftmost_as_ghost parameter is set True.
703
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
705
parents = self.get_parent_ids() + [revision_id]
706
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
707
or allow_leftmost_as_ghost)
709
@needs_tree_write_lock
710
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
711
"""Add revision_id, tree tuple as a parent.
713
This is equivalent to retrieving the current list of parent trees
714
and setting the list to its value plus parent_tuple. See also
715
add_parent_tree_id - if you only have a parent id available it will be
716
simpler to use that api. If you have the parent already available, using
717
this api is preferred.
719
:param parent_tuple: The (revision id, tree) to add to the parent list.
720
If the revision_id is a ghost, pass None for the tree.
721
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
723
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
724
if len(parent_ids) > 1:
725
# the leftmost may have already been a ghost, preserve that if it
727
allow_leftmost_as_ghost = True
728
self.set_parent_ids(parent_ids,
729
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
731
@needs_tree_write_lock
732
def add_pending_merge(self, *revision_ids):
733
# TODO: Perhaps should check at this point that the
734
# history of the revision is actually present?
735
parents = self.get_parent_ids()
737
for rev_id in revision_ids:
738
if rev_id in parents:
740
parents.append(rev_id)
743
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
745
def path_content_summary(self, path, _lstat=os.lstat,
746
_mapper=osutils.file_kind_from_stat_mode):
747
"""See Tree.path_content_summary."""
748
abspath = self.abspath(path)
750
stat_result = _lstat(abspath)
752
if getattr(e, 'errno', None) == errno.ENOENT:
754
return ('missing', None, None, None)
755
# propagate other errors
757
kind = _mapper(stat_result.st_mode)
759
return self._file_content_summary(path, stat_result)
760
elif kind == 'directory':
761
# perhaps it looks like a plain directory, but it's really a
763
if self._directory_is_tree_reference(path):
764
kind = 'tree-reference'
765
return kind, None, None, None
766
elif kind == 'symlink':
767
target = osutils.readlink(abspath)
768
return ('symlink', None, None, target)
770
return (kind, None, None, None)
772
def _file_content_summary(self, path, stat_result):
773
size = stat_result.st_size
774
executable = self._is_executable_from_path_and_stat(path, stat_result)
775
# try for a stat cache lookup
776
return ('file', size, executable, self._sha_from_stat(
779
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
780
"""Common ghost checking functionality from set_parent_*.
782
This checks that the left hand-parent exists if there are any
785
if len(revision_ids) > 0:
786
leftmost_id = revision_ids[0]
787
if (not allow_leftmost_as_ghost and not
788
self.branch.repository.has_revision(leftmost_id)):
789
raise errors.GhostRevisionUnusableHere(leftmost_id)
791
def _set_merges_from_parent_ids(self, parent_ids):
792
merges = parent_ids[1:]
793
self._transport.put_bytes('pending-merges', '\n'.join(merges),
794
mode=self.bzrdir._get_file_mode())
796
def _filter_parent_ids_by_ancestry(self, revision_ids):
797
"""Check that all merged revisions are proper 'heads'.
799
This will always return the first revision_id, and any merged revisions
802
if len(revision_ids) == 0:
804
graph = self.branch.repository.get_graph()
805
heads = graph.heads(revision_ids)
806
new_revision_ids = revision_ids[:1]
807
for revision_id in revision_ids[1:]:
808
if revision_id in heads and revision_id not in new_revision_ids:
809
new_revision_ids.append(revision_id)
810
if new_revision_ids != revision_ids:
811
trace.mutter('requested to set revision_ids = %s,'
812
' but filtered to %s', revision_ids, new_revision_ids)
813
return new_revision_ids
815
@needs_tree_write_lock
816
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
817
"""Set the parent ids to revision_ids.
819
See also set_parent_trees. This api will try to retrieve the tree data
820
for each element of revision_ids from the trees repository. If you have
821
tree data already available, it is more efficient to use
822
set_parent_trees rather than set_parent_ids. set_parent_ids is however
823
an easier API to use.
825
:param revision_ids: The revision_ids to set as the parent ids of this
826
working tree. Any of these may be ghosts.
828
self._check_parents_for_ghosts(revision_ids,
829
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
830
for revision_id in revision_ids:
831
_mod_revision.check_not_reserved_id(revision_id)
833
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
835
if len(revision_ids) > 0:
836
self.set_last_revision(revision_ids[0])
838
self.set_last_revision(_mod_revision.NULL_REVISION)
840
self._set_merges_from_parent_ids(revision_ids)
842
@needs_tree_write_lock
843
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
844
"""See MutableTree.set_parent_trees."""
845
parent_ids = [rev for (rev, tree) in parents_list]
846
for revision_id in parent_ids:
847
_mod_revision.check_not_reserved_id(revision_id)
849
self._check_parents_for_ghosts(parent_ids,
850
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
852
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
854
if len(parent_ids) == 0:
855
leftmost_parent_id = _mod_revision.NULL_REVISION
856
leftmost_parent_tree = None
858
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
860
if self._change_last_revision(leftmost_parent_id):
861
if leftmost_parent_tree is None:
862
# If we don't have a tree, fall back to reading the
863
# parent tree from the repository.
864
self._cache_basis_inventory(leftmost_parent_id)
866
inv = leftmost_parent_tree.inventory
867
xml = self._create_basis_xml_from_inventory(
868
leftmost_parent_id, inv)
869
self._write_basis_inventory(xml)
870
self._set_merges_from_parent_ids(parent_ids)
872
@needs_tree_write_lock
873
def set_pending_merges(self, rev_list):
874
parents = self.get_parent_ids()
875
leftmost = parents[:1]
876
new_parents = leftmost + rev_list
877
self.set_parent_ids(new_parents)
879
@needs_tree_write_lock
880
def set_merge_modified(self, modified_hashes):
882
for file_id, hash in modified_hashes.iteritems():
883
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
884
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
886
def _sha_from_stat(self, path, stat_result):
887
"""Get a sha digest from the tree's stat cache.
889
The default implementation assumes no stat cache is present.
891
:param path: The path.
892
:param stat_result: The stat result being looked up.
896
def _put_rio(self, filename, stanzas, header):
897
self._must_be_locked()
898
my_file = rio_file(stanzas, header)
899
self._transport.put_file(filename, my_file,
900
mode=self.bzrdir._get_file_mode())
902
@needs_write_lock # because merge pulls data into the branch.
903
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
904
merge_type=None, force=False):
905
"""Merge from a branch into this working tree.
907
:param branch: The branch to merge from.
908
:param to_revision: If non-None, the merge will merge to to_revision,
909
but not beyond it. to_revision does not need to be in the history
910
of the branch when it is supplied. If None, to_revision defaults to
911
branch.last_revision().
913
from bzrlib.merge import Merger, Merge3Merger
914
merger = Merger(self.branch, this_tree=self)
915
# check that there are no local alterations
916
if not force and self.has_changes():
917
raise errors.UncommittedChanges(self)
918
if to_revision is None:
919
to_revision = _mod_revision.ensure_null(branch.last_revision())
920
merger.other_rev_id = to_revision
921
if _mod_revision.is_null(merger.other_rev_id):
922
raise errors.NoCommits(branch)
923
self.branch.fetch(branch, last_revision=merger.other_rev_id)
924
merger.other_basis = merger.other_rev_id
925
merger.other_tree = self.branch.repository.revision_tree(
927
merger.other_branch = branch
928
if from_revision is None:
931
merger.set_base_revision(from_revision, branch)
932
if merger.base_rev_id == merger.other_rev_id:
933
raise errors.PointlessMerge
934
merger.backup_files = False
935
if merge_type is None:
936
merger.merge_type = Merge3Merger
938
merger.merge_type = merge_type
939
merger.set_interesting_files(None)
940
merger.show_base = False
941
merger.reprocess = False
942
conflicts = merger.do_merge()
947
def merge_modified(self):
948
"""Return a dictionary of files modified by a merge.
950
The list is initialized by WorkingTree.set_merge_modified, which is
951
typically called after we make some automatic updates to the tree
954
This returns a map of file_id->sha1, containing only files which are
955
still in the working inventory and have that text hash.
958
hashfile = self._transport.get('merge-hashes')
959
except errors.NoSuchFile:
964
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
965
raise errors.MergeModifiedFormatError()
966
except StopIteration:
967
raise errors.MergeModifiedFormatError()
968
for s in RioReader(hashfile):
969
# RioReader reads in Unicode, so convert file_ids back to utf8
970
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
971
if file_id not in self.inventory:
973
text_hash = s.get("hash")
974
if text_hash == self.get_file_sha1(file_id):
975
merge_hashes[file_id] = text_hash
981
def mkdir(self, path, file_id=None):
982
"""See MutableTree.mkdir()."""
984
file_id = generate_ids.gen_file_id(os.path.basename(path))
985
os.mkdir(self.abspath(path))
986
self.add(path, file_id, 'directory')
989
def get_symlink_target(self, file_id):
990
abspath = self.id2abspath(file_id)
991
target = osutils.readlink(abspath)
995
def subsume(self, other_tree):
996
def add_children(inventory, entry):
997
for child_entry in entry.children.values():
998
inventory._byid[child_entry.file_id] = child_entry
999
if child_entry.kind == 'directory':
1000
add_children(inventory, child_entry)
1001
if other_tree.get_root_id() == self.get_root_id():
1002
raise errors.BadSubsumeSource(self, other_tree,
1003
'Trees have the same root')
1005
other_tree_path = self.relpath(other_tree.basedir)
1006
except errors.PathNotChild:
1007
raise errors.BadSubsumeSource(self, other_tree,
1008
'Tree is not contained by the other')
1009
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1010
if new_root_parent is None:
1011
raise errors.BadSubsumeSource(self, other_tree,
1012
'Parent directory is not versioned.')
1013
# We need to ensure that the result of a fetch will have a
1014
# versionedfile for the other_tree root, and only fetching into
1015
# RepositoryKnit2 guarantees that.
1016
if not self.branch.repository.supports_rich_root():
1017
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1018
other_tree.lock_tree_write()
1020
new_parents = other_tree.get_parent_ids()
1021
other_root = other_tree.inventory.root
1022
other_root.parent_id = new_root_parent
1023
other_root.name = osutils.basename(other_tree_path)
1024
self.inventory.add(other_root)
1025
add_children(self.inventory, other_root)
1026
self._write_inventory(self.inventory)
1027
# normally we don't want to fetch whole repositories, but i think
1028
# here we really do want to consolidate the whole thing.
1029
for parent_id in other_tree.get_parent_ids():
1030
self.branch.fetch(other_tree.branch, parent_id)
1031
self.add_parent_tree_id(parent_id)
1034
other_tree.bzrdir.retire_bzrdir()
1036
def _setup_directory_is_tree_reference(self):
1037
if self._branch.repository._format.supports_tree_reference:
1038
self._directory_is_tree_reference = \
1039
self._directory_may_be_tree_reference
1041
self._directory_is_tree_reference = \
1042
self._directory_is_never_tree_reference
1044
def _directory_is_never_tree_reference(self, relpath):
1047
def _directory_may_be_tree_reference(self, relpath):
1048
# as a special case, if a directory contains control files then
1049
# it's a tree reference, except that the root of the tree is not
1050
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1051
# TODO: We could ask all the control formats whether they
1052
# recognize this directory, but at the moment there's no cheap api
1053
# to do that. Since we probably can only nest bzr checkouts and
1054
# they always use this name it's ok for now. -- mbp 20060306
1056
# FIXME: There is an unhandled case here of a subdirectory
1057
# containing .bzr but not a branch; that will probably blow up
1058
# when you try to commit it. It might happen if there is a
1059
# checkout in a subdirectory. This can be avoided by not adding
1062
@needs_tree_write_lock
1063
def extract(self, file_id, format=None):
1064
"""Extract a subtree from this tree.
1066
A new branch will be created, relative to the path for this tree.
1070
segments = osutils.splitpath(path)
1071
transport = self.branch.bzrdir.root_transport
1072
for name in segments:
1073
transport = transport.clone(name)
1074
transport.ensure_base()
1077
sub_path = self.id2path(file_id)
1078
branch_transport = mkdirs(sub_path)
1080
format = self.bzrdir.cloning_metadir()
1081
branch_transport.ensure_base()
1082
branch_bzrdir = format.initialize_on_transport(branch_transport)
1084
repo = branch_bzrdir.find_repository()
1085
except errors.NoRepositoryPresent:
1086
repo = branch_bzrdir.create_repository()
1087
if not repo.supports_rich_root():
1088
raise errors.RootNotRich()
1089
new_branch = branch_bzrdir.create_branch()
1090
new_branch.pull(self.branch)
1091
for parent_id in self.get_parent_ids():
1092
new_branch.fetch(self.branch, parent_id)
1093
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1094
if tree_transport.base != branch_transport.base:
1095
tree_bzrdir = format.initialize_on_transport(tree_transport)
1096
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1097
target_branch=new_branch)
1099
tree_bzrdir = branch_bzrdir
1100
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1101
wt.set_parent_ids(self.get_parent_ids())
1102
my_inv = self.inventory
1103
child_inv = inventory.Inventory(root_id=None)
1104
new_root = my_inv[file_id]
1105
my_inv.remove_recursive_id(file_id)
1106
new_root.parent_id = None
1107
child_inv.add(new_root)
1108
self._write_inventory(my_inv)
1109
wt._write_inventory(child_inv)
1112
def _serialize(self, inventory, out_file):
1113
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1116
def _deserialize(selt, in_file):
1117
return xml5.serializer_v5.read_inventory(in_file)
1120
"""Write the in memory inventory to disk."""
1121
# TODO: Maybe this should only write on dirty ?
1122
if self._control_files._lock_mode != 'w':
1123
raise errors.NotWriteLocked(self)
1125
self._serialize(self._inventory, sio)
1127
self._transport.put_file('inventory', sio,
1128
mode=self.bzrdir._get_file_mode())
1129
self._inventory_is_modified = False
1131
def _kind(self, relpath):
1132
return osutils.file_kind(self.abspath(relpath))
1134
def list_files(self, include_root=False, from_dir=None, recursive=True):
1135
"""List all files as (path, class, kind, id, entry).
1137
Lists, but does not descend into unversioned directories.
1138
This does not include files that have been deleted in this
1139
tree. Skips the control directory.
1141
:param include_root: if True, do not return an entry for the root
1142
:param from_dir: start from this directory or None for the root
1143
:param recursive: whether to recurse into subdirectories or not
1145
# list_files is an iterator, so @needs_read_lock doesn't work properly
1146
# with it. So callers should be careful to always read_lock the tree.
1147
if not self.is_locked():
1148
raise errors.ObjectNotLocked(self)
1150
inv = self.inventory
1151
if from_dir is None and include_root is True:
1152
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1153
# Convert these into local objects to save lookup times
1154
pathjoin = osutils.pathjoin
1155
file_kind = self._kind
1157
# transport.base ends in a slash, we want the piece
1158
# between the last two slashes
1159
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1161
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1163
# directory file_id, relative path, absolute path, reverse sorted children
1164
if from_dir is not None:
1165
from_dir_id = inv.path2id(from_dir)
1166
if from_dir_id is None:
1167
# Directory not versioned
1169
from_dir_abspath = pathjoin(self.basedir, from_dir)
1171
from_dir_id = inv.root.file_id
1172
from_dir_abspath = self.basedir
1173
children = os.listdir(from_dir_abspath)
1175
# jam 20060527 The kernel sized tree seems equivalent whether we
1176
# use a deque and popleft to keep them sorted, or if we use a plain
1177
# list and just reverse() them.
1178
children = collections.deque(children)
1179
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1181
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1184
f = children.popleft()
1185
## TODO: If we find a subdirectory with its own .bzr
1186
## directory, then that is a separate tree and we
1187
## should exclude it.
1189
# the bzrdir for this tree
1190
if transport_base_dir == f:
1193
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1194
# and 'f' doesn't begin with one, we can do a string op, rather
1195
# than the checks of pathjoin(), all relative paths will have an extra slash
1197
fp = from_dir_relpath + '/' + f
1200
fap = from_dir_abspath + '/' + f
1202
f_ie = inv.get_child(from_dir_id, f)
1205
elif self.is_ignored(fp[1:]):
1208
# we may not have found this file, because of a unicode issue
1209
f_norm, can_access = osutils.normalized_filename(f)
1210
if f == f_norm or not can_access:
1211
# No change, so treat this file normally
1214
# this file can be accessed by a normalized path
1215
# check again if it is versioned
1216
# these lines are repeated here for performance
1218
fp = from_dir_relpath + '/' + f
1219
fap = from_dir_abspath + '/' + f
1220
f_ie = inv.get_child(from_dir_id, f)
1223
elif self.is_ignored(fp[1:]):
1230
# make a last minute entry
1232
yield fp[1:], c, fk, f_ie.file_id, f_ie
1235
yield fp[1:], c, fk, None, fk_entries[fk]()
1237
yield fp[1:], c, fk, None, TreeEntry()
1240
if fk != 'directory':
1243
# But do this child first if recursing down
1245
new_children = os.listdir(fap)
1247
new_children = collections.deque(new_children)
1248
stack.append((f_ie.file_id, fp, fap, new_children))
1249
# Break out of inner loop,
1250
# so that we start outer loop with child
1253
# if we finished all children, pop it off the stack
1256
@needs_tree_write_lock
1257
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1260
to_dir must exist in the inventory.
1262
If to_dir exists and is a directory, the files are moved into
1263
it, keeping their old names.
1265
Note that to_dir is only the last component of the new name;
1266
this doesn't change the directory.
1268
For each entry in from_paths the move mode will be determined
1271
The first mode moves the file in the filesystem and updates the
1272
inventory. The second mode only updates the inventory without
1273
touching the file on the filesystem. This is the new mode introduced
1276
move uses the second mode if 'after == True' and the target is not
1277
versioned but present in the working tree.
1279
move uses the second mode if 'after == False' and the source is
1280
versioned but no longer in the working tree, and the target is not
1281
versioned but present in the working tree.
1283
move uses the first mode if 'after == False' and the source is
1284
versioned and present in the working tree, and the target is not
1285
versioned and not present in the working tree.
1287
Everything else results in an error.
1289
This returns a list of (from_path, to_path) pairs for each
1290
entry that is moved.
1295
# check for deprecated use of signature
1297
to_dir = kwargs.get('to_name', None)
1299
raise TypeError('You must supply a target directory')
1301
symbol_versioning.warn('The parameter to_name was deprecated'
1302
' in version 0.13. Use to_dir instead',
1305
# check destination directory
1306
if isinstance(from_paths, basestring):
1308
inv = self.inventory
1309
to_abs = self.abspath(to_dir)
1310
if not isdir(to_abs):
1311
raise errors.BzrMoveFailedError('',to_dir,
1312
errors.NotADirectory(to_abs))
1313
if not self.has_filename(to_dir):
1314
raise errors.BzrMoveFailedError('',to_dir,
1315
errors.NotInWorkingDirectory(to_dir))
1316
to_dir_id = inv.path2id(to_dir)
1317
if to_dir_id is None:
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotVersionedError(path=str(to_dir)))
1321
to_dir_ie = inv[to_dir_id]
1322
if to_dir_ie.kind != 'directory':
1323
raise errors.BzrMoveFailedError('',to_dir,
1324
errors.NotADirectory(to_abs))
1326
# create rename entries and tuples
1327
for from_rel in from_paths:
1328
from_tail = splitpath(from_rel)[-1]
1329
from_id = inv.path2id(from_rel)
1331
raise errors.BzrMoveFailedError(from_rel,to_dir,
1332
errors.NotVersionedError(path=str(from_rel)))
1334
from_entry = inv[from_id]
1335
from_parent_id = from_entry.parent_id
1336
to_rel = pathjoin(to_dir, from_tail)
1337
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1339
from_tail=from_tail,
1340
from_parent_id=from_parent_id,
1341
to_rel=to_rel, to_tail=from_tail,
1342
to_parent_id=to_dir_id)
1343
rename_entries.append(rename_entry)
1344
rename_tuples.append((from_rel, to_rel))
1346
# determine which move mode to use. checks also for movability
1347
rename_entries = self._determine_mv_mode(rename_entries, after)
1349
original_modified = self._inventory_is_modified
1352
self._inventory_is_modified = True
1353
self._move(rename_entries)
1355
# restore the inventory on error
1356
self._inventory_is_modified = original_modified
1358
self._write_inventory(inv)
1359
return rename_tuples
1361
def _determine_mv_mode(self, rename_entries, after=False):
1362
"""Determines for each from-to pair if both inventory and working tree
1363
or only the inventory has to be changed.
1365
Also does basic plausability tests.
1367
inv = self.inventory
1369
for rename_entry in rename_entries:
1370
# store to local variables for easier reference
1371
from_rel = rename_entry.from_rel
1372
from_id = rename_entry.from_id
1373
to_rel = rename_entry.to_rel
1374
to_id = inv.path2id(to_rel)
1375
only_change_inv = False
1377
# check the inventory for source and destination
1379
raise errors.BzrMoveFailedError(from_rel,to_rel,
1380
errors.NotVersionedError(path=str(from_rel)))
1381
if to_id is not None:
1382
raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
errors.AlreadyVersionedError(path=str(to_rel)))
1385
# try to determine the mode for rename (only change inv or change
1386
# inv and file system)
1388
if not self.has_filename(to_rel):
1389
raise errors.BzrMoveFailedError(from_id,to_rel,
1390
errors.NoSuchFile(path=str(to_rel),
1391
extra="New file has not been created yet"))
1392
only_change_inv = True
1393
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1394
only_change_inv = True
1395
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1396
only_change_inv = False
1397
elif (not self.case_sensitive
1398
and from_rel.lower() == to_rel.lower()
1399
and self.has_filename(from_rel)):
1400
only_change_inv = False
1402
# something is wrong, so lets determine what exactly
1403
if not self.has_filename(from_rel) and \
1404
not self.has_filename(to_rel):
1405
raise errors.BzrRenameFailedError(from_rel,to_rel,
1406
errors.PathsDoNotExist(paths=(str(from_rel),
1409
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1410
rename_entry.only_change_inv = only_change_inv
1411
return rename_entries
1413
def _move(self, rename_entries):
1414
"""Moves a list of files.
1416
Depending on the value of the flag 'only_change_inv', the
1417
file will be moved on the file system or not.
1419
inv = self.inventory
1422
for entry in rename_entries:
1424
self._move_entry(entry)
1426
self._rollback_move(moved)
1430
def _rollback_move(self, moved):
1431
"""Try to rollback a previous move in case of an filesystem error."""
1432
inv = self.inventory
1435
self._move_entry(WorkingTree._RenameEntry(
1436
entry.to_rel, entry.from_id,
1437
entry.to_tail, entry.to_parent_id, entry.from_rel,
1438
entry.from_tail, entry.from_parent_id,
1439
entry.only_change_inv))
1440
except errors.BzrMoveFailedError, e:
1441
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1442
" The working tree is in an inconsistent state."
1443
" Please consider doing a 'bzr revert'."
1444
" Error message is: %s" % e)
1446
def _move_entry(self, entry):
1447
inv = self.inventory
1448
from_rel_abs = self.abspath(entry.from_rel)
1449
to_rel_abs = self.abspath(entry.to_rel)
1450
if from_rel_abs == to_rel_abs:
1451
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1452
"Source and target are identical.")
1454
if not entry.only_change_inv:
1456
osutils.rename(from_rel_abs, to_rel_abs)
1458
raise errors.BzrMoveFailedError(entry.from_rel,
1460
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1462
@needs_tree_write_lock
1463
def rename_one(self, from_rel, to_rel, after=False):
1466
This can change the directory or the filename or both.
1468
rename_one has several 'modes' to work. First, it can rename a physical
1469
file and change the file_id. That is the normal mode. Second, it can
1470
only change the file_id without touching any physical file. This is
1471
the new mode introduced in version 0.15.
1473
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1474
versioned but present in the working tree.
1476
rename_one uses the second mode if 'after == False' and 'from_rel' is
1477
versioned but no longer in the working tree, and 'to_rel' is not
1478
versioned but present in the working tree.
1480
rename_one uses the first mode if 'after == False' and 'from_rel' is
1481
versioned and present in the working tree, and 'to_rel' is not
1482
versioned and not present in the working tree.
1484
Everything else results in an error.
1486
inv = self.inventory
1489
# create rename entries and tuples
1490
from_tail = splitpath(from_rel)[-1]
1491
from_id = inv.path2id(from_rel)
1493
# if file is missing in the inventory maybe it's in the basis_tree
1494
basis_tree = self.branch.basis_tree()
1495
from_id = basis_tree.path2id(from_rel)
1497
raise errors.BzrRenameFailedError(from_rel,to_rel,
1498
errors.NotVersionedError(path=str(from_rel)))
1499
# put entry back in the inventory so we can rename it
1500
from_entry = basis_tree.inventory[from_id].copy()
1503
from_entry = inv[from_id]
1504
from_parent_id = from_entry.parent_id
1505
to_dir, to_tail = os.path.split(to_rel)
1506
to_dir_id = inv.path2id(to_dir)
1507
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1509
from_tail=from_tail,
1510
from_parent_id=from_parent_id,
1511
to_rel=to_rel, to_tail=to_tail,
1512
to_parent_id=to_dir_id)
1513
rename_entries.append(rename_entry)
1515
# determine which move mode to use. checks also for movability
1516
rename_entries = self._determine_mv_mode(rename_entries, after)
1518
# check if the target changed directory and if the target directory is
1520
if to_dir_id is None:
1521
raise errors.BzrMoveFailedError(from_rel,to_rel,
1522
errors.NotVersionedError(path=str(to_dir)))
1524
# all checks done. now we can continue with our actual work
1525
mutter('rename_one:\n'
1530
' to_dir_id {%s}\n',
1531
from_id, from_rel, to_rel, to_dir, to_dir_id)
1533
self._move(rename_entries)
1534
self._write_inventory(inv)
1536
class _RenameEntry(object):
1537
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1538
to_rel, to_tail, to_parent_id, only_change_inv=False):
1539
self.from_rel = from_rel
1540
self.from_id = from_id
1541
self.from_tail = from_tail
1542
self.from_parent_id = from_parent_id
1543
self.to_rel = to_rel
1544
self.to_tail = to_tail
1545
self.to_parent_id = to_parent_id
1546
self.only_change_inv = only_change_inv
1550
"""Return all unknown files.
1552
These are files in the working directory that are not versioned or
1553
control files or ignored.
1555
# force the extras method to be fully executed before returning, to
1556
# prevent race conditions with the lock
1558
[subp for subp in self.extras() if not self.is_ignored(subp)])
1560
@needs_tree_write_lock
1561
def unversion(self, file_ids):
1562
"""Remove the file ids in file_ids from the current versioned set.
1564
When a file_id is unversioned, all of its children are automatically
1567
:param file_ids: The file ids to stop versioning.
1568
:raises: NoSuchId if any fileid is not currently versioned.
1570
for file_id in file_ids:
1571
if file_id not in self._inventory:
1572
raise errors.NoSuchId(self, file_id)
1573
for file_id in file_ids:
1574
if self._inventory.has_id(file_id):
1575
self._inventory.remove_recursive_id(file_id)
1577
# in the future this should just set a dirty bit to wait for the
1578
# final unlock. However, until all methods of workingtree start
1579
# with the current in -memory inventory rather than triggering
1580
# a read, it is more complex - we need to teach read_inventory
1581
# to know when to read, and when to not read first... and possibly
1582
# to save first when the in memory one may be corrupted.
1583
# so for now, we just only write it if it is indeed dirty.
1585
self._write_inventory(self._inventory)
1587
def _iter_conflicts(self):
1589
for info in self.list_files():
1591
stem = get_conflicted_stem(path)
1594
if stem not in conflicted:
1595
conflicted.add(stem)
1599
def pull(self, source, overwrite=False, stop_revision=None,
1600
change_reporter=None, possible_transports=None, local=False):
1603
old_revision_info = self.branch.last_revision_info()
1604
basis_tree = self.basis_tree()
1605
count = self.branch.pull(source, overwrite, stop_revision,
1606
possible_transports=possible_transports,
1608
new_revision_info = self.branch.last_revision_info()
1609
if new_revision_info != old_revision_info:
1610
repository = self.branch.repository
1611
basis_tree.lock_read()
1613
new_basis_tree = self.branch.basis_tree()
1620
change_reporter=change_reporter)
1621
basis_root_id = basis_tree.get_root_id()
1622
new_root_id = new_basis_tree.get_root_id()
1623
if basis_root_id != new_root_id:
1624
self.set_root_id(new_root_id)
1627
# TODO - dedup parents list with things merged by pull ?
1628
# reuse the revisiontree we merged against to set the new
1630
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1631
# we have to pull the merge trees out again, because
1632
# merge_inner has set the ids. - this corner is not yet
1633
# layered well enough to prevent double handling.
1634
# XXX TODO: Fix the double handling: telling the tree about
1635
# the already known parent data is wasteful.
1636
merges = self.get_parent_ids()[1:]
1637
parent_trees.extend([
1638
(parent, repository.revision_tree(parent)) for
1640
self.set_parent_trees(parent_trees)
1646
def put_file_bytes_non_atomic(self, file_id, bytes):
1647
"""See MutableTree.put_file_bytes_non_atomic."""
1648
stream = file(self.id2abspath(file_id), 'wb')
1653
# TODO: update the hashcache here ?
1656
"""Yield all unversioned files in this WorkingTree.
1658
If there are any unversioned directories then only the directory is
1659
returned, not all its children. But if there are unversioned files
1660
under a versioned subdirectory, they are returned.
1662
Currently returned depth-first, sorted by name within directories.
1663
This is the same order used by 'osutils.walkdirs'.
1665
## TODO: Work from given directory downwards
1666
for path, dir_entry in self.inventory.directories():
1667
# mutter("search for unknowns in %r", path)
1668
dirabs = self.abspath(path)
1669
if not isdir(dirabs):
1670
# e.g. directory deleted
1674
for subf in os.listdir(dirabs):
1675
if self.bzrdir.is_control_filename(subf):
1677
if subf not in dir_entry.children:
1680
can_access) = osutils.normalized_filename(subf)
1681
except UnicodeDecodeError:
1682
path_os_enc = path.encode(osutils._fs_enc)
1683
relpath = path_os_enc + '/' + subf
1684
raise errors.BadFilenameEncoding(relpath,
1686
if subf_norm != subf and can_access:
1687
if subf_norm not in dir_entry.children:
1688
fl.append(subf_norm)
1694
subp = pathjoin(path, subf)
1697
def ignored_files(self):
1698
"""Yield list of PATH, IGNORE_PATTERN"""
1699
for subp in self.extras():
1700
pat = self.is_ignored(subp)
1704
def get_ignore_list(self):
1705
"""Return list of ignore patterns.
1707
Cached in the Tree object after the first call.
1709
ignoreset = getattr(self, '_ignoreset', None)
1710
if ignoreset is not None:
1713
ignore_globs = set()
1714
ignore_globs.update(ignores.get_runtime_ignores())
1715
ignore_globs.update(ignores.get_user_ignores())
1716
if self.has_filename(bzrlib.IGNORE_FILENAME):
1717
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1719
ignore_globs.update(ignores.parse_ignore_file(f))
1722
self._ignoreset = ignore_globs
1725
def _flush_ignore_list_cache(self):
1726
"""Resets the cached ignore list to force a cache rebuild."""
1727
self._ignoreset = None
1728
self._ignoreglobster = None
1730
def is_ignored(self, filename):
1731
r"""Check whether the filename matches an ignore pattern.
1733
Patterns containing '/' or '\' need to match the whole path;
1734
others match against only the last component. Patterns starting
1735
with '!' are ignore exceptions. Exceptions take precedence
1736
over regular patterns and cause the filename to not be ignored.
1738
If the file is ignored, returns the pattern which caused it to
1739
be ignored, otherwise None. So this can simply be used as a
1740
boolean if desired."""
1741
if getattr(self, '_ignoreglobster', None) is None:
1742
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1743
return self._ignoreglobster.match(filename)
1745
def kind(self, file_id):
1746
return file_kind(self.id2abspath(file_id))
1748
def stored_kind(self, file_id):
1749
"""See Tree.stored_kind"""
1750
return self.inventory[file_id].kind
1752
def _comparison_data(self, entry, path):
1753
abspath = self.abspath(path)
1755
stat_value = os.lstat(abspath)
1757
if getattr(e, 'errno', None) == errno.ENOENT:
1764
mode = stat_value.st_mode
1765
kind = osutils.file_kind_from_stat_mode(mode)
1766
if not supports_executable():
1767
executable = entry is not None and entry.executable
1769
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1770
return kind, executable, stat_value
1772
def _file_size(self, entry, stat_value):
1773
return stat_value.st_size
1775
def last_revision(self):
1776
"""Return the last revision of the branch for this tree.
1778
This format tree does not support a separate marker for last-revision
1779
compared to the branch.
1781
See MutableTree.last_revision
1783
return self._last_revision()
1786
def _last_revision(self):
1787
"""helper for get_parent_ids."""
1788
return _mod_revision.ensure_null(self.branch.last_revision())
1790
def is_locked(self):
1791
return self._control_files.is_locked()
1793
def _must_be_locked(self):
1794
if not self.is_locked():
1795
raise errors.ObjectNotLocked(self)
1797
def lock_read(self):
1798
"""See Branch.lock_read, and WorkingTree.unlock."""
1799
if not self.is_locked():
1801
self.branch.lock_read()
1803
return self._control_files.lock_read()
1805
self.branch.unlock()
1808
def lock_tree_write(self):
1809
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1810
if not self.is_locked():
1812
self.branch.lock_read()
1814
return self._control_files.lock_write()
1816
self.branch.unlock()
1819
def lock_write(self):
1820
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1821
if not self.is_locked():
1823
self.branch.lock_write()
1825
return self._control_files.lock_write()
1827
self.branch.unlock()
1830
def get_physical_lock_status(self):
1831
return self._control_files.get_physical_lock_status()
1833
def _basis_inventory_name(self):
1834
return 'basis-inventory-cache'
1836
def _reset_data(self):
1837
"""Reset transient data that cannot be revalidated."""
1838
self._inventory_is_modified = False
1839
f = self._transport.get('inventory')
1841
result = self._deserialize(f)
1844
self._set_inventory(result, dirty=False)
1846
@needs_tree_write_lock
1847
def set_last_revision(self, new_revision):
1848
"""Change the last revision in the working tree."""
1849
if self._change_last_revision(new_revision):
1850
self._cache_basis_inventory(new_revision)
1852
def _change_last_revision(self, new_revision):
1853
"""Template method part of set_last_revision to perform the change.
1855
This is used to allow WorkingTree3 instances to not affect branch
1856
when their last revision is set.
1858
if _mod_revision.is_null(new_revision):
1859
self.branch.set_revision_history([])
1862
self.branch.generate_revision_history(new_revision)
1863
except errors.NoSuchRevision:
1864
# not present in the repo - dont try to set it deeper than the tip
1865
self.branch.set_revision_history([new_revision])
1868
def _write_basis_inventory(self, xml):
1869
"""Write the basis inventory XML to the basis-inventory file"""
1870
path = self._basis_inventory_name()
1872
self._transport.put_file(path, sio,
1873
mode=self.bzrdir._get_file_mode())
1875
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1876
"""Create the text that will be saved in basis-inventory"""
1877
inventory.revision_id = revision_id
1878
return xml7.serializer_v7.write_inventory_to_string(inventory)
1880
def _cache_basis_inventory(self, new_revision):
1881
"""Cache new_revision as the basis inventory."""
1882
# TODO: this should allow the ready-to-use inventory to be passed in,
1883
# as commit already has that ready-to-use [while the format is the
1886
# this double handles the inventory - unpack and repack -
1887
# but is easier to understand. We can/should put a conditional
1888
# in here based on whether the inventory is in the latest format
1889
# - perhaps we should repack all inventories on a repository
1891
# the fast path is to copy the raw xml from the repository. If the
1892
# xml contains 'revision_id="', then we assume the right
1893
# revision_id is set. We must check for this full string, because a
1894
# root node id can legitimately look like 'revision_id' but cannot
1896
xml = self.branch.repository._get_inventory_xml(new_revision)
1897
firstline = xml.split('\n', 1)[0]
1898
if (not 'revision_id="' in firstline or
1899
'format="7"' not in firstline):
1900
inv = self.branch.repository._serializer.read_inventory_from_string(
1902
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1903
self._write_basis_inventory(xml)
1904
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1907
def read_basis_inventory(self):
1908
"""Read the cached basis inventory."""
1909
path = self._basis_inventory_name()
1910
return self._transport.get_bytes(path)
1913
def read_working_inventory(self):
1914
"""Read the working inventory.
1916
:raises errors.InventoryModified: read_working_inventory will fail
1917
when the current in memory inventory has been modified.
1919
# conceptually this should be an implementation detail of the tree.
1920
# XXX: Deprecate this.
1921
# ElementTree does its own conversion from UTF-8, so open in
1923
if self._inventory_is_modified:
1924
raise errors.InventoryModified(self)
1925
f = self._transport.get('inventory')
1927
result = self._deserialize(f)
1930
self._set_inventory(result, dirty=False)
1933
@needs_tree_write_lock
1934
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1936
"""Remove nominated files from the working inventory.
1938
:files: File paths relative to the basedir.
1939
:keep_files: If true, the files will also be kept.
1940
:force: Delete files and directories, even if they are changed and
1941
even if the directories are not empty.
1943
if isinstance(files, basestring):
1949
unknown_nested_files=set()
1951
to_file = sys.stdout
1953
def recurse_directory_to_add_files(directory):
1954
# Recurse directory and add all files
1955
# so we can check if they have changed.
1956
for parent_info, file_infos in\
1957
self.walkdirs(directory):
1958
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1959
# Is it versioned or ignored?
1960
if self.path2id(relpath) or self.is_ignored(relpath):
1961
# Add nested content for deletion.
1962
new_files.add(relpath)
1964
# Files which are not versioned and not ignored
1965
# should be treated as unknown.
1966
unknown_nested_files.add((relpath, None, kind))
1968
for filename in files:
1969
# Get file name into canonical form.
1970
abspath = self.abspath(filename)
1971
filename = self.relpath(abspath)
1972
if len(filename) > 0:
1973
new_files.add(filename)
1974
recurse_directory_to_add_files(filename)
1976
files = list(new_files)
1979
return # nothing to do
1981
# Sort needed to first handle directory content before the directory
1982
files.sort(reverse=True)
1984
# Bail out if we are going to delete files we shouldn't
1985
if not keep_files and not force:
1986
has_changed_files = len(unknown_nested_files) > 0
1987
if not has_changed_files:
1988
for (file_id, path, content_change, versioned, parent_id, name,
1989
kind, executable) in self.iter_changes(self.basis_tree(),
1990
include_unchanged=True, require_versioned=False,
1991
want_unversioned=True, specific_files=files):
1992
if versioned == (False, False):
1993
# The record is unknown ...
1994
if not self.is_ignored(path[1]):
1995
# ... but not ignored
1996
has_changed_files = True
1998
elif content_change and (kind[1] is not None):
1999
# Versioned and changed, but not deleted
2000
has_changed_files = True
2003
if has_changed_files:
2004
# Make delta show ALL applicable changes in error message.
2005
tree_delta = self.changes_from(self.basis_tree(),
2006
require_versioned=False, want_unversioned=True,
2007
specific_files=files)
2008
for unknown_file in unknown_nested_files:
2009
if unknown_file not in tree_delta.unversioned:
2010
tree_delta.unversioned.extend((unknown_file,))
2011
raise errors.BzrRemoveChangedFilesError(tree_delta)
2013
# Build inv_delta and delete files where applicable,
2014
# do this before any modifications to inventory.
2016
fid = self.path2id(f)
2019
message = "%s is not versioned." % (f,)
2022
# having removed it, it must be either ignored or unknown
2023
if self.is_ignored(f):
2027
# XXX: Really should be a more abstract reporter interface
2028
kind_ch = osutils.kind_marker(self.kind(fid))
2029
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2031
inv_delta.append((f, None, fid, None))
2032
message = "removed %s" % (f,)
2035
abs_path = self.abspath(f)
2036
if osutils.lexists(abs_path):
2037
if (osutils.isdir(abs_path) and
2038
len(os.listdir(abs_path)) > 0):
2040
osutils.rmtree(abs_path)
2042
message = "%s is not an empty directory "\
2043
"and won't be deleted." % (f,)
2045
osutils.delete_any(abs_path)
2046
message = "deleted %s" % (f,)
2047
elif message is not None:
2048
# Only care if we haven't done anything yet.
2049
message = "%s does not exist." % (f,)
2051
# Print only one message (if any) per file.
2052
if message is not None:
2054
self.apply_inventory_delta(inv_delta)
2056
@needs_tree_write_lock
2057
def revert(self, filenames=None, old_tree=None, backups=True,
2058
pb=None, report_changes=False):
2059
from bzrlib.conflicts import resolve
2062
symbol_versioning.warn('Using [] to revert all files is deprecated'
2063
' as of bzr 0.91. Please use None (the default) instead.',
2064
DeprecationWarning, stacklevel=2)
2065
if old_tree is None:
2066
basis_tree = self.basis_tree()
2067
basis_tree.lock_read()
2068
old_tree = basis_tree
2072
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2074
if filenames is None and len(self.get_parent_ids()) > 1:
2076
last_revision = self.last_revision()
2077
if last_revision != _mod_revision.NULL_REVISION:
2078
if basis_tree is None:
2079
basis_tree = self.basis_tree()
2080
basis_tree.lock_read()
2081
parent_trees.append((last_revision, basis_tree))
2082
self.set_parent_trees(parent_trees)
2085
resolve(self, filenames, ignore_misses=True, recursive=True)
2087
if basis_tree is not None:
2091
def revision_tree(self, revision_id):
2092
"""See Tree.revision_tree.
2094
WorkingTree can supply revision_trees for the basis revision only
2095
because there is only one cached inventory in the bzr directory.
2097
if revision_id == self.last_revision():
2099
xml = self.read_basis_inventory()
2100
except errors.NoSuchFile:
2104
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2105
# dont use the repository revision_tree api because we want
2106
# to supply the inventory.
2107
if inv.revision_id == revision_id:
2108
return revisiontree.RevisionTree(self.branch.repository,
2110
except errors.BadInventoryFormat:
2112
# raise if there was no inventory, or if we read the wrong inventory.
2113
raise errors.NoSuchRevisionInTree(self, revision_id)
2115
# XXX: This method should be deprecated in favour of taking in a proper
2116
# new Inventory object.
2117
@needs_tree_write_lock
2118
def set_inventory(self, new_inventory_list):
2119
from bzrlib.inventory import (Inventory,
2123
inv = Inventory(self.get_root_id())
2124
for path, file_id, parent, kind in new_inventory_list:
2125
name = os.path.basename(path)
2128
# fixme, there should be a factory function inv,add_??
2129
if kind == 'directory':
2130
inv.add(InventoryDirectory(file_id, name, parent))
2131
elif kind == 'file':
2132
inv.add(InventoryFile(file_id, name, parent))
2133
elif kind == 'symlink':
2134
inv.add(InventoryLink(file_id, name, parent))
2136
raise errors.BzrError("unknown kind %r" % kind)
2137
self._write_inventory(inv)
2139
@needs_tree_write_lock
2140
def set_root_id(self, file_id):
2141
"""Set the root id for this tree."""
2145
'WorkingTree.set_root_id with fileid=None')
2146
file_id = osutils.safe_file_id(file_id)
2147
self._set_root_id(file_id)
2149
def _set_root_id(self, file_id):
2150
"""Set the root id for this tree, in a format specific manner.
2152
:param file_id: The file id to assign to the root. It must not be
2153
present in the current inventory or an error will occur. It must
2154
not be None, but rather a valid file id.
2156
inv = self._inventory
2157
orig_root_id = inv.root.file_id
2158
# TODO: it might be nice to exit early if there was nothing
2159
# to do, saving us from trigger a sync on unlock.
2160
self._inventory_is_modified = True
2161
# we preserve the root inventory entry object, but
2162
# unlinkit from the byid index
2163
del inv._byid[inv.root.file_id]
2164
inv.root.file_id = file_id
2165
# and link it into the index with the new changed id.
2166
inv._byid[inv.root.file_id] = inv.root
2167
# and finally update all children to reference the new id.
2168
# XXX: this should be safe to just look at the root.children
2169
# list, not the WHOLE INVENTORY.
2172
if entry.parent_id == orig_root_id:
2173
entry.parent_id = inv.root.file_id
2176
"""See Branch.unlock.
2178
WorkingTree locking just uses the Branch locking facilities.
2179
This is current because all working trees have an embedded branch
2180
within them. IF in the future, we were to make branch data shareable
2181
between multiple working trees, i.e. via shared storage, then we
2182
would probably want to lock both the local tree, and the branch.
2184
raise NotImplementedError(self.unlock)
2188
def update(self, change_reporter=None, possible_transports=None,
2189
revision=None, old_tip=_marker):
2190
"""Update a working tree along its branch.
2192
This will update the branch if its bound too, which means we have
2193
multiple trees involved:
2195
- The new basis tree of the master.
2196
- The old basis tree of the branch.
2197
- The old basis tree of the working tree.
2198
- The current working tree state.
2200
Pathologically, all three may be different, and non-ancestors of each
2201
other. Conceptually we want to:
2203
- Preserve the wt.basis->wt.state changes
2204
- Transform the wt.basis to the new master basis.
2205
- Apply a merge of the old branch basis to get any 'local' changes from
2207
- Restore the wt.basis->wt.state changes.
2209
There isn't a single operation at the moment to do that, so we:
2210
- Merge current state -> basis tree of the master w.r.t. the old tree
2212
- Do a 'normal' merge of the old branch basis if it is relevant.
2214
:param revision: The target revision to update to. Must be in the
2216
:param old_tip: If branch.update() has already been run, the value it
2217
returned (old tip of the branch or None). _marker is used
2220
if self.branch.get_bound_location() is not None:
2222
update_branch = (old_tip is self._marker)
2224
self.lock_tree_write()
2225
update_branch = False
2228
old_tip = self.branch.update(possible_transports)
2230
if old_tip is self._marker:
2232
return self._update_tree(old_tip, change_reporter, revision)
2236
@needs_tree_write_lock
2237
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2238
"""Update a tree to the master branch.
2240
:param old_tip: if supplied, the previous tip revision the branch,
2241
before it was changed to the master branch's tip.
2243
# here if old_tip is not None, it is the old tip of the branch before
2244
# it was updated from the master branch. This should become a pending
2245
# merge in the working tree to preserve the user existing work. we
2246
# cant set that until we update the working trees last revision to be
2247
# one from the new branch, because it will just get absorbed by the
2248
# parent de-duplication logic.
2250
# We MUST save it even if an error occurs, because otherwise the users
2251
# local work is unreferenced and will appear to have been lost.
2255
last_rev = self.get_parent_ids()[0]
2257
last_rev = _mod_revision.NULL_REVISION
2258
if revision is None:
2259
revision = self.branch.last_revision()
2261
if revision not in self.branch.revision_history():
2262
raise errors.NoSuchRevision(self.branch, revision)
2264
old_tip = old_tip or _mod_revision.NULL_REVISION
2266
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
# the branch we are bound to was updated
2268
# merge those changes in first
2269
base_tree = self.basis_tree()
2270
other_tree = self.branch.repository.revision_tree(old_tip)
2271
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
base_tree, this_tree=self,
2273
change_reporter=change_reporter)
2275
self.add_parent_tree((old_tip, other_tree))
2276
trace.note('Rerun update after fixing the conflicts.')
2279
if last_rev != _mod_revision.ensure_null(revision):
2280
# the working tree is up to date with the branch
2281
# we can merge the specified revision from master
2282
to_tree = self.branch.repository.revision_tree(revision)
2283
to_root_id = to_tree.get_root_id()
2285
basis = self.basis_tree()
2288
if (basis.inventory.root is None
2289
or basis.inventory.root.file_id != to_root_id):
2290
self.set_root_id(to_root_id)
2295
# determine the branch point
2296
graph = self.branch.repository.get_graph()
2297
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2299
base_tree = self.branch.repository.revision_tree(base_rev_id)
2301
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
change_reporter=change_reporter)
2304
self.set_last_revision(revision)
2305
# TODO - dedup parents list with things merged by pull ?
2306
# reuse the tree we've updated to to set the basis:
2307
parent_trees = [(revision, to_tree)]
2308
merges = self.get_parent_ids()[1:]
2309
# Ideally we ask the tree for the trees here, that way the working
2310
# tree can decide whether to give us the entire tree or give us a
2311
# lazy initialised tree. dirstate for instance will have the trees
2312
# in ram already, whereas a last-revision + basis-inventory tree
2313
# will not, but also does not need them when setting parents.
2314
for parent in merges:
2315
parent_trees.append(
2316
(parent, self.branch.repository.revision_tree(parent)))
2317
if not _mod_revision.is_null(old_tip):
2318
parent_trees.append(
2319
(old_tip, self.branch.repository.revision_tree(old_tip)))
2320
self.set_parent_trees(parent_trees)
2321
last_rev = parent_trees[0][0]
2324
def _write_hashcache_if_dirty(self):
2325
"""Write out the hashcache if it is dirty."""
2326
if self._hashcache.needs_write:
2328
self._hashcache.write()
2330
if e.errno not in (errno.EPERM, errno.EACCES):
2332
# TODO: jam 20061219 Should this be a warning? A single line
2333
# warning might be sufficient to let the user know what
2335
mutter('Could not write hashcache for %s\nError: %s',
2336
self._hashcache.cache_file_name(), e)
2338
@needs_tree_write_lock
2339
def _write_inventory(self, inv):
2340
"""Write inventory as the current inventory."""
2341
self._set_inventory(inv, dirty=True)
2344
def set_conflicts(self, arg):
2345
raise errors.UnsupportedOperation(self.set_conflicts, self)
2347
def add_conflicts(self, arg):
2348
raise errors.UnsupportedOperation(self.add_conflicts, self)
2351
def conflicts(self):
2352
conflicts = _mod_conflicts.ConflictList()
2353
for conflicted in self._iter_conflicts():
2356
if file_kind(self.abspath(conflicted)) != "file":
2358
except errors.NoSuchFile:
2361
for suffix in ('.THIS', '.OTHER'):
2363
kind = file_kind(self.abspath(conflicted+suffix))
2366
except errors.NoSuchFile:
2370
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2371
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2373
file_id=self.path2id(conflicted)))
2376
def walkdirs(self, prefix=""):
2377
"""Walk the directories of this tree.
2379
returns a generator which yields items in the form:
2380
((curren_directory_path, fileid),
2381
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2384
This API returns a generator, which is only valid during the current
2385
tree transaction - within a single lock_read or lock_write duration.
2387
If the tree is not locked, it may cause an error to be raised,
2388
depending on the tree implementation.
2390
disk_top = self.abspath(prefix)
2391
if disk_top.endswith('/'):
2392
disk_top = disk_top[:-1]
2393
top_strip_len = len(disk_top) + 1
2394
inventory_iterator = self._walkdirs(prefix)
2395
disk_iterator = osutils.walkdirs(disk_top, prefix)
2397
current_disk = disk_iterator.next()
2398
disk_finished = False
2400
if not (e.errno == errno.ENOENT or
2401
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2404
disk_finished = True
2406
current_inv = inventory_iterator.next()
2407
inv_finished = False
2408
except StopIteration:
2411
while not inv_finished or not disk_finished:
2413
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
cur_disk_dir_content) = current_disk
2416
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
cur_disk_dir_content) = ((None, None), None)
2418
if not disk_finished:
2419
# strip out .bzr dirs
2420
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
len(cur_disk_dir_content) > 0):
2422
# osutils.walkdirs can be made nicer -
2423
# yield the path-from-prefix rather than the pathjoined
2425
bzrdir_loc = bisect_left(cur_disk_dir_content,
2427
if (bzrdir_loc < len(cur_disk_dir_content)
2428
and self.bzrdir.is_control_filename(
2429
cur_disk_dir_content[bzrdir_loc][0])):
2430
# we dont yield the contents of, or, .bzr itself.
2431
del cur_disk_dir_content[bzrdir_loc]
2433
# everything is unknown
2436
# everything is missing
2439
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2441
# disk is before inventory - unknown
2442
dirblock = [(relpath, basename, kind, stat, None, None) for
2443
relpath, basename, kind, stat, top_path in
2444
cur_disk_dir_content]
2445
yield (cur_disk_dir_relpath, None), dirblock
2447
current_disk = disk_iterator.next()
2448
except StopIteration:
2449
disk_finished = True
2451
# inventory is before disk - missing.
2452
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
for relpath, basename, dkind, stat, fileid, kind in
2455
yield (current_inv[0][0], current_inv[0][1]), dirblock
2457
current_inv = inventory_iterator.next()
2458
except StopIteration:
2461
# versioned present directory
2462
# merge the inventory and disk data together
2464
for relpath, subiterator in itertools.groupby(sorted(
2465
current_inv[1] + cur_disk_dir_content,
2466
key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
path_elements = list(subiterator)
2468
if len(path_elements) == 2:
2469
inv_row, disk_row = path_elements
2470
# versioned, present file
2471
dirblock.append((inv_row[0],
2472
inv_row[1], disk_row[2],
2473
disk_row[3], inv_row[4],
2475
elif len(path_elements[0]) == 5:
2477
dirblock.append((path_elements[0][0],
2478
path_elements[0][1], path_elements[0][2],
2479
path_elements[0][3], None, None))
2480
elif len(path_elements[0]) == 6:
2481
# versioned, absent file.
2482
dirblock.append((path_elements[0][0],
2483
path_elements[0][1], 'unknown', None,
2484
path_elements[0][4], path_elements[0][5]))
2486
raise NotImplementedError('unreachable code')
2487
yield current_inv[0], dirblock
2489
current_inv = inventory_iterator.next()
2490
except StopIteration:
2493
current_disk = disk_iterator.next()
2494
except StopIteration:
2495
disk_finished = True
2497
def _walkdirs(self, prefix=""):
2498
"""Walk the directories of this tree.
2500
:prefix: is used as the directrory to start with.
2501
returns a generator which yields items in the form:
2502
((curren_directory_path, fileid),
2503
[(file1_path, file1_name, file1_kind, None, file1_id,
2506
_directory = 'directory'
2507
# get the root in the inventory
2508
inv = self.inventory
2509
top_id = inv.path2id(prefix)
2513
pending = [(prefix, '', _directory, None, top_id, None)]
2516
currentdir = pending.pop()
2517
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2518
top_id = currentdir[4]
2520
relroot = currentdir[0] + '/'
2523
# FIXME: stash the node in pending
2525
if entry.kind == 'directory':
2526
for name, child in entry.sorted_children():
2527
dirblock.append((relroot + name, name, child.kind, None,
2528
child.file_id, child.kind
2530
yield (currentdir[0], entry.file_id), dirblock
2531
# push the user specified dirs from dirblock
2532
for dir in reversed(dirblock):
2533
if dir[2] == _directory:
2536
@needs_tree_write_lock
2537
def auto_resolve(self):
2538
"""Automatically resolve text conflicts according to contents.
2540
Only text conflicts are auto_resolvable. Files with no conflict markers
2541
are considered 'resolved', because bzr always puts conflict markers
2542
into files that have text conflicts. The corresponding .THIS .BASE and
2543
.OTHER files are deleted, as per 'resolve'.
2544
:return: a tuple of ConflictLists: (un_resolved, resolved).
2546
un_resolved = _mod_conflicts.ConflictList()
2547
resolved = _mod_conflicts.ConflictList()
2548
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2549
for conflict in self.conflicts():
2550
if (conflict.typestring != 'text conflict' or
2551
self.kind(conflict.file_id) != 'file'):
2552
un_resolved.append(conflict)
2554
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2556
for line in my_file:
2557
if conflict_re.search(line):
2558
un_resolved.append(conflict)
2561
resolved.append(conflict)
2564
resolved.remove_files(self)
2565
self.set_conflicts(un_resolved)
2566
return un_resolved, resolved
2569
def _check(self, references):
2570
"""Check the tree for consistency.
2572
:param references: A dict with keys matching the items returned by
2573
self._get_check_refs(), and values from looking those keys up in
2576
tree_basis = self.basis_tree()
2577
tree_basis.lock_read()
2579
repo_basis = references[('trees', self.last_revision())]
2580
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
raise errors.BzrCheckError(
2582
"Mismatched basis inventory content.")
2587
def _validate(self):
2588
"""Validate internal structures.
2590
This is meant mostly for the test suite. To give it a chance to detect
2591
corruption after actions have occurred. The default implementation is a
2594
:return: None. An exception should be raised if there is an error.
2598
def _get_rules_searcher(self, default_searcher):
2599
"""See Tree._get_rules_searcher."""
2600
if self._rules_searcher is None:
2601
self._rules_searcher = super(WorkingTree,
2602
self)._get_rules_searcher(default_searcher)
2603
return self._rules_searcher
2605
def get_shelf_manager(self):
2606
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
2608
return ShelfManager(self, self._transport)
2611
class WorkingTree2(WorkingTree):
2612
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2615
- uses os locks for locking.
2616
- uses the branch last-revision.
2619
def __init__(self, *args, **kwargs):
2620
super(WorkingTree2, self).__init__(*args, **kwargs)
2621
# WorkingTree2 has more of a constraint that self._inventory must
2622
# exist. Because this is an older format, we don't mind the overhead
2623
# caused by the extra computation here.
2625
# Newer WorkingTree's should only have self._inventory set when they
2627
if self._inventory is None:
2628
self.read_working_inventory()
2630
def _get_check_refs(self):
2631
"""Return the references needed to perform a check of this tree."""
2632
return [('trees', self.last_revision())]
2634
def lock_tree_write(self):
2635
"""See WorkingTree.lock_tree_write().
2637
In Format2 WorkingTrees we have a single lock for the branch and tree
2638
so lock_tree_write() degrades to lock_write().
2640
self.branch.lock_write()
2642
return self._control_files.lock_write()
2644
self.branch.unlock()
2648
# do non-implementation specific cleanup
2651
# we share control files:
2652
if self._control_files._lock_count == 3:
2653
# _inventory_is_modified is always False during a read lock.
2654
if self._inventory_is_modified:
2656
self._write_hashcache_if_dirty()
2658
# reverse order of locking.
2660
return self._control_files.unlock()
2662
self.branch.unlock()
2665
class WorkingTree3(WorkingTree):
2666
"""This is the Format 3 working tree.
2668
This differs from the base WorkingTree by:
2669
- having its own file lock
2670
- having its own last-revision property.
2672
This is new in bzr 0.8
2676
def _last_revision(self):
2677
"""See Mutable.last_revision."""
2679
return self._transport.get_bytes('last-revision')
2680
except errors.NoSuchFile:
2681
return _mod_revision.NULL_REVISION
2683
def _change_last_revision(self, revision_id):
2684
"""See WorkingTree._change_last_revision."""
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2687
self._transport.delete('last-revision')
2688
except errors.NoSuchFile:
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2696
def _get_check_refs(self):
2697
"""Return the references needed to perform a check of this tree."""
2698
return [('trees', self.last_revision())]
2700
@needs_tree_write_lock
2701
def set_conflicts(self, conflicts):
2702
self._put_rio('conflicts', conflicts.to_stanzas(),
2705
@needs_tree_write_lock
2706
def add_conflicts(self, new_conflicts):
2707
conflict_set = set(self.conflicts())
2708
conflict_set.update(set(list(new_conflicts)))
2709
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2710
key=_mod_conflicts.Conflict.sort_key)))
2713
def conflicts(self):
2715
confile = self._transport.get('conflicts')
2716
except errors.NoSuchFile:
2717
return _mod_conflicts.ConflictList()
2720
if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
raise errors.ConflictFormatError()
2722
except StopIteration:
2723
raise errors.ConflictFormatError()
2724
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2729
# do non-implementation specific cleanup
2731
if self._control_files._lock_count == 1:
2732
# _inventory_is_modified is always False during a read lock.
2733
if self._inventory_is_modified:
2735
self._write_hashcache_if_dirty()
2736
# reverse order of locking.
2738
return self._control_files.unlock()
2740
self.branch.unlock()
2743
def get_conflicted_stem(path):
2744
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
if path.endswith(suffix):
2746
return path[:-len(suffix)]
2749
class WorkingTreeFormat(object):
2750
"""An encapsulation of the initialization and open routines for a format.
2752
Formats provide three things:
2753
* An initialization routine,
2757
Formats are placed in an dict by their format string for reference
2758
during workingtree opening. Its not required that these be instances, they
2759
can be classes themselves with class methods - it simply depends on
2760
whether state is needed for a given format or not.
2762
Once a format is deprecated, just deprecate the initialize and open
2763
methods on the format class. Do not deprecate the object, as the
2764
object will be created every time regardless.
2767
_default_format = None
2768
"""The default format used for new trees."""
2771
"""The known formats."""
2773
requires_rich_root = False
2775
upgrade_recommended = False
2778
def find_format(klass, a_bzrdir):
2779
"""Return the format for the working tree object in a_bzrdir."""
2781
transport = a_bzrdir.get_workingtree_transport(None)
2782
format_string = transport.get_bytes("format")
2783
return klass._formats[format_string]
2784
except errors.NoSuchFile:
2785
raise errors.NoWorkingTree(base=transport.base)
2787
raise errors.UnknownFormatError(format=format_string,
2788
kind="working tree")
2790
def __eq__(self, other):
2791
return self.__class__ is other.__class__
2793
def __ne__(self, other):
2794
return not (self == other)
2797
def get_default_format(klass):
2798
"""Return the current default format."""
2799
return klass._default_format
2801
def get_format_string(self):
2802
"""Return the ASCII format string that identifies this format."""
2803
raise NotImplementedError(self.get_format_string)
2805
def get_format_description(self):
2806
"""Return the short description for this format."""
2807
raise NotImplementedError(self.get_format_description)
2809
def is_supported(self):
2810
"""Is this format supported?
2812
Supported formats can be initialized and opened.
2813
Unsupported formats may not support initialization or committing or
2814
some other features depending on the reason for not being supported.
2818
def supports_content_filtering(self):
2819
"""True if this format supports content filtering."""
2822
def supports_views(self):
2823
"""True if this format supports stored views."""
2827
def register_format(klass, format):
2828
klass._formats[format.get_format_string()] = format
2831
def set_default_format(klass, format):
2832
klass._default_format = format
2835
def unregister_format(klass, format):
2836
del klass._formats[format.get_format_string()]
2839
class WorkingTreeFormat2(WorkingTreeFormat):
2840
"""The second working tree format.
2842
This format modified the hash cache from the format 1 hash cache.
2845
upgrade_recommended = True
2847
def get_format_description(self):
2848
"""See WorkingTreeFormat.get_format_description()."""
2849
return "Working tree format 2"
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
2854
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
no working tree. (See bug #43064).
2859
inv = inventory.Inventory()
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
2867
"""See WorkingTreeFormat.initialize()."""
2868
if not isinstance(a_bzrdir.transport, LocalTransport):
2869
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
if from_branch is not None:
2871
branch = from_branch
2873
branch = a_bzrdir.open_branch()
2874
if revision_id is None:
2875
revision_id = _mod_revision.ensure_null(branch.last_revision())
2878
branch.generate_revision_history(revision_id)
2881
inv = inventory.Inventory()
2882
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2888
basis_tree = branch.repository.revision_tree(revision_id)
2889
if basis_tree.inventory.root is not None:
2890
wt.set_root_id(basis_tree.get_root_id())
2891
# set the parent list and cache the basis tree.
2892
if _mod_revision.is_null(revision_id):
2895
parent_trees = [(revision_id, basis_tree)]
2896
wt.set_parent_trees(parent_trees)
2897
transform.build_tree(basis_tree, wt)
2901
super(WorkingTreeFormat2, self).__init__()
2902
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2904
def open(self, a_bzrdir, _found=False):
2905
"""Return the WorkingTree object for a_bzrdir
2907
_found is a private parameter, do not use it. It is used to indicate
2908
if format probing has already been done.
2911
# we are being called directly and must probe.
2912
raise NotImplementedError
2913
if not isinstance(a_bzrdir.transport, LocalTransport):
2914
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2921
class WorkingTreeFormat3(WorkingTreeFormat):
2922
"""The second working tree format updated to record a format marker.
2925
- exists within a metadir controlling .bzr
2926
- includes an explicit version marker for the workingtree control
2927
files, separate from the BzrDir format
2928
- modifies the hash cache format
2930
- uses a LockDir to guard access for writes.
2933
upgrade_recommended = True
2935
def get_format_string(self):
2936
"""See WorkingTreeFormat.get_format_string()."""
2937
return "Bazaar-NG Working Tree format 3"
2939
def get_format_description(self):
2940
"""See WorkingTreeFormat.get_format_description()."""
2941
return "Working tree format 3"
2943
_lock_file_name = 'lock'
2944
_lock_class = LockDir
2946
_tree_class = WorkingTree3
2948
def __get_matchingbzrdir(self):
2949
return bzrdir.BzrDirMetaFormat1()
2951
_matchingbzrdir = property(__get_matchingbzrdir)
2953
def _open_control_files(self, a_bzrdir):
2954
transport = a_bzrdir.get_workingtree_transport(None)
2955
return LockableFiles(transport, self._lock_file_name,
2958
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
accelerator_tree=None, hardlink=False):
2960
"""See WorkingTreeFormat.initialize().
2962
:param revision_id: if supplied, create a working tree at a different
2963
revision than the branch is at.
2964
:param accelerator_tree: A tree which can be used for retrieving file
2965
contents more quickly than the revision tree, i.e. a workingtree.
2966
The revision tree will be used for cases where accelerator_tree's
2967
content is different.
2968
:param hardlink: If true, hard-link files from accelerator_tree,
2971
if not isinstance(a_bzrdir.transport, LocalTransport):
2972
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2973
transport = a_bzrdir.get_workingtree_transport(self)
2974
control_files = self._open_control_files(a_bzrdir)
2975
control_files.create_lock()
2976
control_files.lock_write()
2977
transport.put_bytes('format', self.get_format_string(),
2978
mode=a_bzrdir._get_file_mode())
2979
if from_branch is not None:
2980
branch = from_branch
2982
branch = a_bzrdir.open_branch()
2983
if revision_id is None:
2984
revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
# WorkingTree3 can handle an inventory which has a unique root id.
2986
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
# those trees. And because there isn't a format bump inbetween, we
2988
# are maintaining compatibility with older clients.
2989
# inv = Inventory(root_id=gen_root_id())
2990
inv = self._initial_inventory()
2991
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2997
_control_files=control_files)
2998
wt.lock_tree_write()
3000
basis_tree = branch.repository.revision_tree(revision_id)
3001
# only set an explicit root id if there is one to set.
3002
if basis_tree.inventory.root is not None:
3003
wt.set_root_id(basis_tree.get_root_id())
3004
if revision_id == _mod_revision.NULL_REVISION:
3005
wt.set_parent_trees([])
3007
wt.set_parent_trees([(revision_id, basis_tree)])
3008
transform.build_tree(basis_tree, wt)
3010
# Unlock in this order so that the unlock-triggers-flush in
3011
# WorkingTree is given a chance to fire.
3012
control_files.unlock()
3016
def _initial_inventory(self):
3017
return inventory.Inventory()
3020
super(WorkingTreeFormat3, self).__init__()
3022
def open(self, a_bzrdir, _found=False):
3023
"""Return the WorkingTree object for a_bzrdir
3025
_found is a private parameter, do not use it. It is used to indicate
3026
if format probing has already been done.
3029
# we are being called directly and must probe.
3030
raise NotImplementedError
3031
if not isinstance(a_bzrdir.transport, LocalTransport):
3032
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3036
def _open(self, a_bzrdir, control_files):
3037
"""Open the tree itself.
3039
:param a_bzrdir: the dir for the tree.
3040
:param control_files: the control files for the tree.
3042
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3046
_control_files=control_files)
3049
return self.get_format_string()
3052
__default_format = WorkingTreeFormat6()
3053
WorkingTreeFormat.register_format(__default_format)
3054
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
WorkingTreeFormat.set_default_format(__default_format)
3058
# formats which have no format string are not discoverable
3059
# and not independently creatable, so are not registered.
3060
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
