1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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,
77
from bzrlib.transport import get_transport
78
from bzrlib.workingtree_4 import (
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.lockable_files import LockableFiles
88
from bzrlib.lockdir import LockDir
89
import bzrlib.mutabletree
90
from bzrlib.mutabletree import needs_tree_write_lock
91
from bzrlib import osutils
92
from bzrlib.osutils import (
102
from bzrlib.filters import filtered_input_file
103
from bzrlib.trace import mutter, note
104
from bzrlib.transport.local import LocalTransport
105
from bzrlib.progress import DummyProgress, ProgressPhase
106
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.rio import RioReader, rio_file, Stanza
108
from bzrlib.symbol_versioning import (
110
DEPRECATED_PARAMETER,
114
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
115
CONFLICT_HEADER_1 = "BZR conflict list format 1"
117
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
120
class TreeEntry(object):
121
"""An entry that implements the minimum interface used by commands.
123
This needs further inspection, it may be better to have
124
InventoryEntries without ids - though that seems wrong. For now,
125
this is a parallel hierarchy to InventoryEntry, and needs to become
126
one of several things: decorates to that hierarchy, children of, or
128
Another note is that these objects are currently only used when there is
129
no InventoryEntry available - i.e. for unversioned objects.
130
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
133
def __eq__(self, other):
134
# yes, this us ugly, TODO: best practice __eq__ style.
135
return (isinstance(other, TreeEntry)
136
and other.__class__ == self.__class__)
138
def kind_character(self):
142
class TreeDirectory(TreeEntry):
143
"""See TreeEntry. This is a directory in a working tree."""
145
def __eq__(self, other):
146
return (isinstance(other, TreeDirectory)
147
and other.__class__ == self.__class__)
149
def kind_character(self):
153
class TreeFile(TreeEntry):
154
"""See TreeEntry. This is a regular file in a working tree."""
156
def __eq__(self, other):
157
return (isinstance(other, TreeFile)
158
and other.__class__ == self.__class__)
160
def kind_character(self):
164
class TreeLink(TreeEntry):
165
"""See TreeEntry. This is a symlink in a working tree."""
167
def __eq__(self, other):
168
return (isinstance(other, TreeLink)
169
and other.__class__ == self.__class__)
171
def kind_character(self):
175
class WorkingTree(bzrlib.mutabletree.MutableTree):
176
"""Working copy tree.
178
The inventory is held in the `Branch` working-inventory, and the
179
files are in a directory on disk.
181
It is possible for a `WorkingTree` to have a filename which is
182
not listed in the Inventory and vice versa.
185
# override this to set the strategy for storing views
186
def _make_views(self):
187
return views.DisabledViews(self)
189
def __init__(self, basedir='.',
190
branch=DEPRECATED_PARAMETER,
196
"""Construct a WorkingTree instance. This is not a public API.
198
:param branch: A branch to override probing for the branch.
200
self._format = _format
201
self.bzrdir = _bzrdir
203
raise errors.BzrError("Please use bzrdir.open_workingtree or "
204
"WorkingTree.open() to obtain a WorkingTree.")
205
basedir = safe_unicode(basedir)
206
mutter("opening working tree %r", basedir)
207
if deprecated_passed(branch):
208
self._branch = branch
210
self._branch = self.bzrdir.open_branch()
211
self.basedir = realpath(basedir)
212
# if branch is at our basedir and is a format 6 or less
213
if isinstance(self._format, WorkingTreeFormat2):
214
# share control object
215
self._control_files = self.branch.control_files
217
# assume all other formats have their own control files.
218
self._control_files = _control_files
219
self._transport = self._control_files._transport
220
# update the whole cache up front and write to disk if anything changed;
221
# in the future we might want to do this more selectively
222
# two possible ways offer themselves : in self._unlock, write the cache
223
# if needed, or, when the cache sees a change, append it to the hash
224
# cache file, and have the parser take the most recent entry for a
226
wt_trans = self.bzrdir.get_workingtree_transport(None)
227
cache_filename = wt_trans.local_abspath('stat-cache')
228
self._hashcache = hashcache.HashCache(basedir, cache_filename,
229
self.bzrdir._get_file_mode(),
230
self._content_filter_stack_provider())
233
# is this scan needed ? it makes things kinda slow.
240
if _inventory is None:
241
# This will be acquired on lock_read() or lock_write()
242
self._inventory_is_modified = False
243
self._inventory = None
245
# the caller of __init__ has provided an inventory,
246
# we assume they know what they are doing - as its only
247
# the Format factory and creation methods that are
248
# permitted to do this.
249
self._set_inventory(_inventory, dirty=False)
250
self._detect_case_handling()
251
self._rules_searcher = None
252
self.views = self._make_views()
254
def _detect_case_handling(self):
255
wt_trans = self.bzrdir.get_workingtree_transport(None)
257
wt_trans.stat("FoRMaT")
258
except errors.NoSuchFile:
259
self.case_sensitive = True
261
self.case_sensitive = False
263
self._setup_directory_is_tree_reference()
266
fget=lambda self: self._branch,
267
doc="""The branch this WorkingTree is connected to.
269
This cannot be set - it is reflective of the actual disk structure
270
the working tree has been constructed from.
273
def break_lock(self):
274
"""Break a lock if one is present from another instance.
276
Uses the ui factory to ask for confirmation if the lock may be from
279
This will probe the repository for its lock as well.
281
self._control_files.break_lock()
282
self.branch.break_lock()
284
def requires_rich_root(self):
285
return self._format.requires_rich_root
287
def supports_tree_reference(self):
290
def supports_content_filtering(self):
291
return self._format.supports_content_filtering()
293
def supports_views(self):
294
return self.views.supports_views()
296
def _set_inventory(self, inv, dirty):
297
"""Set the internal cached inventory.
299
:param inv: The inventory to set.
300
:param dirty: A boolean indicating whether the inventory is the same
301
logical inventory as whats on disk. If True the inventory is not
302
the same and should be written to disk or data will be lost, if
303
False then the inventory is the same as that on disk and any
304
serialisation would be unneeded overhead.
306
self._inventory = inv
307
self._inventory_is_modified = dirty
310
def open(path=None, _unsupported=False):
311
"""Open an existing working tree at path.
315
path = osutils.getcwd()
316
control = bzrdir.BzrDir.open(path, _unsupported)
317
return control.open_workingtree(_unsupported)
320
def open_containing(path=None):
321
"""Open an existing working tree which has its root about path.
323
This probes for a working tree at path and searches upwards from there.
325
Basically we keep looking up until we find the control directory or
326
run into /. If there isn't one, raises NotBranchError.
327
TODO: give this a new exception.
328
If there is one, it is returned, along with the unused portion of path.
330
:return: The WorkingTree that contains 'path', and the rest of path
333
path = osutils.getcwd()
334
control, relpath = bzrdir.BzrDir.open_containing(path)
336
return control.open_workingtree(), relpath
339
def open_downlevel(path=None):
340
"""Open an unsupported working tree.
342
Only intended for advanced situations like upgrading part of a bzrdir.
344
return WorkingTree.open(path, _unsupported=True)
347
def find_trees(location):
348
def list_current(transport):
349
return [d for d in transport.list_dir('') if d != '.bzr']
350
def evaluate(bzrdir):
352
tree = bzrdir.open_workingtree()
353
except errors.NoWorkingTree:
357
transport = get_transport(location)
358
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
359
list_current=list_current)
360
return [t for t in iterator if t is not None]
362
# should be deprecated - this is slow and in any case treating them as a
363
# container is (we now know) bad style -- mbp 20070302
364
## @deprecated_method(zero_fifteen)
366
"""Iterate through file_ids for this tree.
368
file_ids are in a WorkingTree if they are in the working inventory
369
and the working file exists.
371
inv = self._inventory
372
for path, ie in inv.iter_entries():
373
if osutils.lexists(self.abspath(path)):
376
def all_file_ids(self):
377
"""See Tree.iter_all_file_ids"""
378
return set(self.inventory)
381
return "<%s of %s>" % (self.__class__.__name__,
382
getattr(self, 'basedir', None))
384
def abspath(self, filename):
385
return pathjoin(self.basedir, filename)
387
def basis_tree(self):
388
"""Return RevisionTree for the current last revision.
390
If the left most parent is a ghost then the returned tree will be an
391
empty tree - one obtained by calling
392
repository.revision_tree(NULL_REVISION).
395
revision_id = self.get_parent_ids()[0]
397
# no parents, return an empty revision tree.
398
# in the future this should return the tree for
399
# 'empty:' - the implicit root empty tree.
400
return self.branch.repository.revision_tree(
401
_mod_revision.NULL_REVISION)
403
return self.revision_tree(revision_id)
404
except errors.NoSuchRevision:
406
# No cached copy available, retrieve from the repository.
407
# FIXME? RBC 20060403 should we cache the inventory locally
410
return self.branch.repository.revision_tree(revision_id)
411
except (errors.RevisionNotPresent, errors.NoSuchRevision):
412
# the basis tree *may* be a ghost or a low level error may have
413
# occurred. If the revision is present, its a problem, if its not
415
if self.branch.repository.has_revision(revision_id):
417
# the basis tree is a ghost so return an empty tree.
418
return self.branch.repository.revision_tree(
419
_mod_revision.NULL_REVISION)
422
self._flush_ignore_list_cache()
424
def relpath(self, path):
425
"""Return the local path portion from a given path.
427
The path may be absolute or relative. If its a relative path it is
428
interpreted relative to the python current working directory.
430
return osutils.relpath(self.basedir, path)
432
def has_filename(self, filename):
433
return osutils.lexists(self.abspath(filename))
435
def get_file(self, file_id, path=None, filtered=True):
436
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
438
def get_file_with_stat(self, file_id, path=None, filtered=True,
440
"""See Tree.get_file_with_stat."""
442
path = self.id2path(file_id)
443
file_obj = self.get_file_byname(path, filtered=False)
444
stat_value = _fstat(file_obj.fileno())
445
if filtered and self.supports_content_filtering():
446
filters = self._content_filter_stack(path)
447
file_obj = filtered_input_file(file_obj, filters)
448
return (file_obj, stat_value)
450
def get_file_text(self, file_id, path=None, filtered=True):
451
return self.get_file(file_id, path=path, filtered=filtered).read()
453
def get_file_byname(self, filename, filtered=True):
454
path = self.abspath(filename)
456
if filtered and self.supports_content_filtering():
457
filters = self._content_filter_stack(filename)
458
return filtered_input_file(f, filters)
462
def get_file_lines(self, file_id, path=None, filtered=True):
463
"""See Tree.get_file_lines()"""
464
file = self.get_file(file_id, path, filtered=filtered)
466
return file.readlines()
471
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
472
"""See Tree.annotate_iter
474
This implementation will use the basis tree implementation if possible.
475
Lines not in the basis are attributed to CURRENT_REVISION
477
If there are pending merges, lines added by those merges will be
478
incorrectly attributed to CURRENT_REVISION (but after committing, the
479
attribution will be correct).
481
maybe_file_parent_keys = []
482
for parent_id in self.get_parent_ids():
484
parent_tree = self.revision_tree(parent_id)
485
except errors.NoSuchRevisionInTree:
486
parent_tree = self.branch.repository.revision_tree(parent_id)
487
parent_tree.lock_read()
489
if file_id not in parent_tree:
491
ie = parent_tree.inventory[file_id]
492
if ie.kind != 'file':
493
# Note: this is slightly unnecessary, because symlinks and
494
# directories have a "text" which is the empty text, and we
495
# know that won't mess up annotations. But it seems cleaner
497
parent_text_key = (file_id, ie.revision)
498
if parent_text_key not in maybe_file_parent_keys:
499
maybe_file_parent_keys.append(parent_text_key)
502
graph = _mod_graph.Graph(self.branch.repository.texts)
503
heads = graph.heads(maybe_file_parent_keys)
504
file_parent_keys = []
505
for key in maybe_file_parent_keys:
507
file_parent_keys.append(key)
509
# Now we have the parents of this content
510
annotator = self.branch.repository.texts.get_annotator()
511
text = self.get_file(file_id).read()
512
this_key =(file_id, default_revision)
513
annotator.add_special_text(this_key, file_parent_keys, text)
514
annotations = [(key[-1], line)
515
for key, line in annotator.annotate_flat(this_key)]
518
def _get_ancestors(self, default_revision):
519
ancestors = set([default_revision])
520
for parent_id in self.get_parent_ids():
521
ancestors.update(self.branch.repository.get_ancestry(
522
parent_id, topo_sorted=False))
525
def get_parent_ids(self):
526
"""See Tree.get_parent_ids.
528
This implementation reads the pending merges list and last_revision
529
value and uses that to decide what the parents list should be.
531
last_rev = _mod_revision.ensure_null(self._last_revision())
532
if _mod_revision.NULL_REVISION == last_rev:
537
merges_file = self._transport.get('pending-merges')
538
except errors.NoSuchFile:
541
for l in merges_file.readlines():
542
revision_id = l.rstrip('\n')
543
parents.append(revision_id)
547
def get_root_id(self):
548
"""Return the id of this trees root"""
549
return self._inventory.root.file_id
551
def _get_store_filename(self, file_id):
552
## XXX: badly named; this is not in the store at all
553
return self.abspath(self.id2path(file_id))
556
def clone(self, to_bzrdir, revision_id=None):
557
"""Duplicate this working tree into to_bzr, including all state.
559
Specifically modified files are kept as modified, but
560
ignored and unknown files are discarded.
562
If you want to make a new line of development, see bzrdir.sprout()
565
If not None, the cloned tree will have its last revision set to
566
revision, and difference between the source trees last revision
567
and this one merged in.
569
# assumes the target bzr dir format is compatible.
570
result = to_bzrdir.create_workingtree()
571
self.copy_content_into(result, revision_id)
575
def copy_content_into(self, tree, revision_id=None):
576
"""Copy the current content and user files of this tree into tree."""
577
tree.set_root_id(self.get_root_id())
578
if revision_id is None:
579
merge.transform_tree(tree, self)
581
# TODO now merge from tree.last_revision to revision (to preserve
582
# user local changes)
583
merge.transform_tree(tree, self)
584
tree.set_parent_ids([revision_id])
586
def id2abspath(self, file_id):
587
return self.abspath(self.id2path(file_id))
589
def has_id(self, file_id):
590
# files that have been deleted are excluded
592
if not inv.has_id(file_id):
594
path = inv.id2path(file_id)
595
return osutils.lexists(self.abspath(path))
597
def has_or_had_id(self, file_id):
598
if file_id == self.inventory.root.file_id:
600
return self.inventory.has_id(file_id)
602
__contains__ = has_id
604
def get_file_size(self, file_id):
605
"""See Tree.get_file_size"""
607
return os.path.getsize(self.id2abspath(file_id))
609
if e.errno != errno.ENOENT:
615
def get_file_sha1(self, file_id, path=None, stat_value=None):
617
path = self._inventory.id2path(file_id)
618
return self._hashcache.get_sha1(path, stat_value)
620
def get_file_mtime(self, file_id, path=None):
622
path = self.inventory.id2path(file_id)
623
return os.lstat(self.abspath(path)).st_mtime
625
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
626
file_id = self.path2id(path)
627
return self._inventory[file_id].executable
629
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
630
mode = stat_result.st_mode
631
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
633
if not supports_executable():
634
def is_executable(self, file_id, path=None):
635
return self._inventory[file_id].executable
637
_is_executable_from_path_and_stat = \
638
_is_executable_from_path_and_stat_from_basis
640
def is_executable(self, file_id, path=None):
642
path = self.id2path(file_id)
643
mode = os.lstat(self.abspath(path)).st_mode
644
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
646
_is_executable_from_path_and_stat = \
647
_is_executable_from_path_and_stat_from_stat
649
@needs_tree_write_lock
650
def _add(self, files, ids, kinds):
651
"""See MutableTree._add."""
652
# TODO: Re-adding a file that is removed in the working copy
653
# should probably put it back with the previous ID.
654
# the read and write working inventory should not occur in this
655
# function - they should be part of lock_write and unlock.
657
for f, file_id, kind in zip(files, ids, kinds):
659
inv.add_path(f, kind=kind)
661
inv.add_path(f, kind=kind, file_id=file_id)
662
self._inventory_is_modified = True
664
@needs_tree_write_lock
665
def _gather_kinds(self, files, kinds):
666
"""See MutableTree._gather_kinds."""
667
for pos, f in enumerate(files):
668
if kinds[pos] is None:
669
fullpath = normpath(self.abspath(f))
671
kinds[pos] = file_kind(fullpath)
673
if e.errno == errno.ENOENT:
674
raise errors.NoSuchFile(fullpath)
677
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
678
"""Add revision_id as a parent.
680
This is equivalent to retrieving the current list of parent ids
681
and setting the list to its value plus revision_id.
683
:param revision_id: The revision id to add to the parent list. It may
684
be a ghost revision as long as its not the first parent to be added,
685
or the allow_leftmost_as_ghost parameter is set True.
686
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
688
parents = self.get_parent_ids() + [revision_id]
689
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
690
or allow_leftmost_as_ghost)
692
@needs_tree_write_lock
693
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
694
"""Add revision_id, tree tuple as a parent.
696
This is equivalent to retrieving the current list of parent trees
697
and setting the list to its value plus parent_tuple. See also
698
add_parent_tree_id - if you only have a parent id available it will be
699
simpler to use that api. If you have the parent already available, using
700
this api is preferred.
702
:param parent_tuple: The (revision id, tree) to add to the parent list.
703
If the revision_id is a ghost, pass None for the tree.
704
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
706
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
707
if len(parent_ids) > 1:
708
# the leftmost may have already been a ghost, preserve that if it
710
allow_leftmost_as_ghost = True
711
self.set_parent_ids(parent_ids,
712
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
714
@needs_tree_write_lock
715
def add_pending_merge(self, *revision_ids):
716
# TODO: Perhaps should check at this point that the
717
# history of the revision is actually present?
718
parents = self.get_parent_ids()
720
for rev_id in revision_ids:
721
if rev_id in parents:
723
parents.append(rev_id)
726
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
728
def path_content_summary(self, path, _lstat=os.lstat,
729
_mapper=osutils.file_kind_from_stat_mode):
730
"""See Tree.path_content_summary."""
731
abspath = self.abspath(path)
733
stat_result = _lstat(abspath)
735
if getattr(e, 'errno', None) == errno.ENOENT:
737
return ('missing', None, None, None)
738
# propagate other errors
740
kind = _mapper(stat_result.st_mode)
742
size = stat_result.st_size
743
# try for a stat cache lookup
744
executable = self._is_executable_from_path_and_stat(path, stat_result)
745
return (kind, size, executable, self._sha_from_stat(
747
elif kind == 'directory':
748
# perhaps it looks like a plain directory, but it's really a
750
if self._directory_is_tree_reference(path):
751
kind = 'tree-reference'
752
return kind, None, None, None
753
elif kind == 'symlink':
754
target = osutils.readlink(abspath)
755
return ('symlink', None, None, target)
757
return (kind, None, None, None)
759
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
760
"""Common ghost checking functionality from set_parent_*.
762
This checks that the left hand-parent exists if there are any
765
if len(revision_ids) > 0:
766
leftmost_id = revision_ids[0]
767
if (not allow_leftmost_as_ghost and not
768
self.branch.repository.has_revision(leftmost_id)):
769
raise errors.GhostRevisionUnusableHere(leftmost_id)
771
def _set_merges_from_parent_ids(self, parent_ids):
772
merges = parent_ids[1:]
773
self._transport.put_bytes('pending-merges', '\n'.join(merges),
774
mode=self.bzrdir._get_file_mode())
776
def _filter_parent_ids_by_ancestry(self, revision_ids):
777
"""Check that all merged revisions are proper 'heads'.
779
This will always return the first revision_id, and any merged revisions
782
if len(revision_ids) == 0:
784
graph = self.branch.repository.get_graph()
785
heads = graph.heads(revision_ids)
786
new_revision_ids = revision_ids[:1]
787
for revision_id in revision_ids[1:]:
788
if revision_id in heads and revision_id not in new_revision_ids:
789
new_revision_ids.append(revision_id)
790
if new_revision_ids != revision_ids:
791
trace.mutter('requested to set revision_ids = %s,'
792
' but filtered to %s', revision_ids, new_revision_ids)
793
return new_revision_ids
795
@needs_tree_write_lock
796
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
797
"""Set the parent ids to revision_ids.
799
See also set_parent_trees. This api will try to retrieve the tree data
800
for each element of revision_ids from the trees repository. If you have
801
tree data already available, it is more efficient to use
802
set_parent_trees rather than set_parent_ids. set_parent_ids is however
803
an easier API to use.
805
:param revision_ids: The revision_ids to set as the parent ids of this
806
working tree. Any of these may be ghosts.
808
self._check_parents_for_ghosts(revision_ids,
809
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
810
for revision_id in revision_ids:
811
_mod_revision.check_not_reserved_id(revision_id)
813
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
815
if len(revision_ids) > 0:
816
self.set_last_revision(revision_ids[0])
818
self.set_last_revision(_mod_revision.NULL_REVISION)
820
self._set_merges_from_parent_ids(revision_ids)
822
@needs_tree_write_lock
823
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
824
"""See MutableTree.set_parent_trees."""
825
parent_ids = [rev for (rev, tree) in parents_list]
826
for revision_id in parent_ids:
827
_mod_revision.check_not_reserved_id(revision_id)
829
self._check_parents_for_ghosts(parent_ids,
830
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
832
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
834
if len(parent_ids) == 0:
835
leftmost_parent_id = _mod_revision.NULL_REVISION
836
leftmost_parent_tree = None
838
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
840
if self._change_last_revision(leftmost_parent_id):
841
if leftmost_parent_tree is None:
842
# If we don't have a tree, fall back to reading the
843
# parent tree from the repository.
844
self._cache_basis_inventory(leftmost_parent_id)
846
inv = leftmost_parent_tree.inventory
847
xml = self._create_basis_xml_from_inventory(
848
leftmost_parent_id, inv)
849
self._write_basis_inventory(xml)
850
self._set_merges_from_parent_ids(parent_ids)
852
@needs_tree_write_lock
853
def set_pending_merges(self, rev_list):
854
parents = self.get_parent_ids()
855
leftmost = parents[:1]
856
new_parents = leftmost + rev_list
857
self.set_parent_ids(new_parents)
859
@needs_tree_write_lock
860
def set_merge_modified(self, modified_hashes):
862
for file_id, hash in modified_hashes.iteritems():
863
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
864
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
866
def _sha_from_stat(self, path, stat_result):
867
"""Get a sha digest from the tree's stat cache.
869
The default implementation assumes no stat cache is present.
871
:param path: The path.
872
:param stat_result: The stat result being looked up.
876
def _put_rio(self, filename, stanzas, header):
877
self._must_be_locked()
878
my_file = rio_file(stanzas, header)
879
self._transport.put_file(filename, my_file,
880
mode=self.bzrdir._get_file_mode())
882
@needs_write_lock # because merge pulls data into the branch.
883
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
885
"""Merge from a branch into this working tree.
887
:param branch: The branch to merge from.
888
:param to_revision: If non-None, the merge will merge to to_revision,
889
but not beyond it. to_revision does not need to be in the history
890
of the branch when it is supplied. If None, to_revision defaults to
891
branch.last_revision().
893
from bzrlib.merge import Merger, Merge3Merger
894
pb = ui.ui_factory.nested_progress_bar()
896
merger = Merger(self.branch, this_tree=self, pb=pb)
897
merger.pp = ProgressPhase("Merge phase", 5, pb)
898
merger.pp.next_phase()
899
# check that there are no
901
merger.check_basis(check_clean=True, require_commits=False)
902
if to_revision is None:
903
to_revision = _mod_revision.ensure_null(branch.last_revision())
904
merger.other_rev_id = to_revision
905
if _mod_revision.is_null(merger.other_rev_id):
906
raise errors.NoCommits(branch)
907
self.branch.fetch(branch, last_revision=merger.other_rev_id)
908
merger.other_basis = merger.other_rev_id
909
merger.other_tree = self.branch.repository.revision_tree(
911
merger.other_branch = branch
912
merger.pp.next_phase()
913
if from_revision is None:
916
merger.set_base_revision(from_revision, branch)
917
if merger.base_rev_id == merger.other_rev_id:
918
raise errors.PointlessMerge
919
merger.backup_files = False
920
if merge_type is None:
921
merger.merge_type = Merge3Merger
923
merger.merge_type = merge_type
924
merger.set_interesting_files(None)
925
merger.show_base = False
926
merger.reprocess = False
927
conflicts = merger.do_merge()
934
def merge_modified(self):
935
"""Return a dictionary of files modified by a merge.
937
The list is initialized by WorkingTree.set_merge_modified, which is
938
typically called after we make some automatic updates to the tree
941
This returns a map of file_id->sha1, containing only files which are
942
still in the working inventory and have that text hash.
945
hashfile = self._transport.get('merge-hashes')
946
except errors.NoSuchFile:
951
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
952
raise errors.MergeModifiedFormatError()
953
except StopIteration:
954
raise errors.MergeModifiedFormatError()
955
for s in RioReader(hashfile):
956
# RioReader reads in Unicode, so convert file_ids back to utf8
957
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
958
if file_id not in self.inventory:
960
text_hash = s.get("hash")
961
if text_hash == self.get_file_sha1(file_id):
962
merge_hashes[file_id] = text_hash
968
def mkdir(self, path, file_id=None):
969
"""See MutableTree.mkdir()."""
971
file_id = generate_ids.gen_file_id(os.path.basename(path))
972
os.mkdir(self.abspath(path))
973
self.add(path, file_id, 'directory')
976
def get_symlink_target(self, file_id):
977
abspath = self.id2abspath(file_id)
978
target = osutils.readlink(abspath)
982
def subsume(self, other_tree):
983
def add_children(inventory, entry):
984
for child_entry in entry.children.values():
985
inventory._byid[child_entry.file_id] = child_entry
986
if child_entry.kind == 'directory':
987
add_children(inventory, child_entry)
988
if other_tree.get_root_id() == self.get_root_id():
989
raise errors.BadSubsumeSource(self, other_tree,
990
'Trees have the same root')
992
other_tree_path = self.relpath(other_tree.basedir)
993
except errors.PathNotChild:
994
raise errors.BadSubsumeSource(self, other_tree,
995
'Tree is not contained by the other')
996
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
997
if new_root_parent is None:
998
raise errors.BadSubsumeSource(self, other_tree,
999
'Parent directory is not versioned.')
1000
# We need to ensure that the result of a fetch will have a
1001
# versionedfile for the other_tree root, and only fetching into
1002
# RepositoryKnit2 guarantees that.
1003
if not self.branch.repository.supports_rich_root():
1004
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1005
other_tree.lock_tree_write()
1007
new_parents = other_tree.get_parent_ids()
1008
other_root = other_tree.inventory.root
1009
other_root.parent_id = new_root_parent
1010
other_root.name = osutils.basename(other_tree_path)
1011
self.inventory.add(other_root)
1012
add_children(self.inventory, other_root)
1013
self._write_inventory(self.inventory)
1014
# normally we don't want to fetch whole repositories, but i think
1015
# here we really do want to consolidate the whole thing.
1016
for parent_id in other_tree.get_parent_ids():
1017
self.branch.fetch(other_tree.branch, parent_id)
1018
self.add_parent_tree_id(parent_id)
1021
other_tree.bzrdir.retire_bzrdir()
1023
def _setup_directory_is_tree_reference(self):
1024
if self._branch.repository._format.supports_tree_reference:
1025
self._directory_is_tree_reference = \
1026
self._directory_may_be_tree_reference
1028
self._directory_is_tree_reference = \
1029
self._directory_is_never_tree_reference
1031
def _directory_is_never_tree_reference(self, relpath):
1034
def _directory_may_be_tree_reference(self, relpath):
1035
# as a special case, if a directory contains control files then
1036
# it's a tree reference, except that the root of the tree is not
1037
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1038
# TODO: We could ask all the control formats whether they
1039
# recognize this directory, but at the moment there's no cheap api
1040
# to do that. Since we probably can only nest bzr checkouts and
1041
# they always use this name it's ok for now. -- mbp 20060306
1043
# FIXME: There is an unhandled case here of a subdirectory
1044
# containing .bzr but not a branch; that will probably blow up
1045
# when you try to commit it. It might happen if there is a
1046
# checkout in a subdirectory. This can be avoided by not adding
1049
@needs_tree_write_lock
1050
def extract(self, file_id, format=None):
1051
"""Extract a subtree from this tree.
1053
A new branch will be created, relative to the path for this tree.
1057
segments = osutils.splitpath(path)
1058
transport = self.branch.bzrdir.root_transport
1059
for name in segments:
1060
transport = transport.clone(name)
1061
transport.ensure_base()
1064
sub_path = self.id2path(file_id)
1065
branch_transport = mkdirs(sub_path)
1067
format = self.bzrdir.cloning_metadir()
1068
branch_transport.ensure_base()
1069
branch_bzrdir = format.initialize_on_transport(branch_transport)
1071
repo = branch_bzrdir.find_repository()
1072
except errors.NoRepositoryPresent:
1073
repo = branch_bzrdir.create_repository()
1074
if not repo.supports_rich_root():
1075
raise errors.RootNotRich()
1076
new_branch = branch_bzrdir.create_branch()
1077
new_branch.pull(self.branch)
1078
for parent_id in self.get_parent_ids():
1079
new_branch.fetch(self.branch, parent_id)
1080
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1081
if tree_transport.base != branch_transport.base:
1082
tree_bzrdir = format.initialize_on_transport(tree_transport)
1083
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1085
tree_bzrdir = branch_bzrdir
1086
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1087
wt.set_parent_ids(self.get_parent_ids())
1088
my_inv = self.inventory
1089
child_inv = inventory.Inventory(root_id=None)
1090
new_root = my_inv[file_id]
1091
my_inv.remove_recursive_id(file_id)
1092
new_root.parent_id = None
1093
child_inv.add(new_root)
1094
self._write_inventory(my_inv)
1095
wt._write_inventory(child_inv)
1098
def _serialize(self, inventory, out_file):
1099
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1102
def _deserialize(selt, in_file):
1103
return xml5.serializer_v5.read_inventory(in_file)
1106
"""Write the in memory inventory to disk."""
1107
# TODO: Maybe this should only write on dirty ?
1108
if self._control_files._lock_mode != 'w':
1109
raise errors.NotWriteLocked(self)
1111
self._serialize(self._inventory, sio)
1113
self._transport.put_file('inventory', sio,
1114
mode=self.bzrdir._get_file_mode())
1115
self._inventory_is_modified = False
1117
def _kind(self, relpath):
1118
return osutils.file_kind(self.abspath(relpath))
1120
def list_files(self, include_root=False, from_dir=None, recursive=True):
1121
"""List all files as (path, class, kind, id, entry).
1123
Lists, but does not descend into unversioned directories.
1124
This does not include files that have been deleted in this
1125
tree. Skips the control directory.
1127
:param include_root: if True, do not return an entry for the root
1128
:param from_dir: start from this directory or None for the root
1129
:param recursive: whether to recurse into subdirectories or not
1131
# list_files is an iterator, so @needs_read_lock doesn't work properly
1132
# with it. So callers should be careful to always read_lock the tree.
1133
if not self.is_locked():
1134
raise errors.ObjectNotLocked(self)
1136
inv = self.inventory
1137
if from_dir is None and include_root is True:
1138
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1139
# Convert these into local objects to save lookup times
1140
pathjoin = osutils.pathjoin
1141
file_kind = self._kind
1143
# transport.base ends in a slash, we want the piece
1144
# between the last two slashes
1145
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1147
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1149
# directory file_id, relative path, absolute path, reverse sorted children
1150
if from_dir is not None:
1151
from_dir_id = inv.path2id(from_dir)
1152
if from_dir_id is None:
1153
# Directory not versioned
1155
from_dir_abspath = pathjoin(self.basedir, from_dir)
1157
from_dir_id = inv.root.file_id
1158
from_dir_abspath = self.basedir
1159
children = os.listdir(from_dir_abspath)
1161
# jam 20060527 The kernel sized tree seems equivalent whether we
1162
# use a deque and popleft to keep them sorted, or if we use a plain
1163
# list and just reverse() them.
1164
children = collections.deque(children)
1165
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1167
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1170
f = children.popleft()
1171
## TODO: If we find a subdirectory with its own .bzr
1172
## directory, then that is a separate tree and we
1173
## should exclude it.
1175
# the bzrdir for this tree
1176
if transport_base_dir == f:
1179
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1180
# and 'f' doesn't begin with one, we can do a string op, rather
1181
# than the checks of pathjoin(), all relative paths will have an extra slash
1183
fp = from_dir_relpath + '/' + f
1186
fap = from_dir_abspath + '/' + f
1188
f_ie = inv.get_child(from_dir_id, f)
1191
elif self.is_ignored(fp[1:]):
1194
# we may not have found this file, because of a unicode issue
1195
f_norm, can_access = osutils.normalized_filename(f)
1196
if f == f_norm or not can_access:
1197
# No change, so treat this file normally
1200
# this file can be accessed by a normalized path
1201
# check again if it is versioned
1202
# these lines are repeated here for performance
1204
fp = from_dir_relpath + '/' + f
1205
fap = from_dir_abspath + '/' + f
1206
f_ie = inv.get_child(from_dir_id, f)
1209
elif self.is_ignored(fp[1:]):
1216
# make a last minute entry
1218
yield fp[1:], c, fk, f_ie.file_id, f_ie
1221
yield fp[1:], c, fk, None, fk_entries[fk]()
1223
yield fp[1:], c, fk, None, TreeEntry()
1226
if fk != 'directory':
1229
# But do this child first if recursing down
1231
new_children = os.listdir(fap)
1233
new_children = collections.deque(new_children)
1234
stack.append((f_ie.file_id, fp, fap, new_children))
1235
# Break out of inner loop,
1236
# so that we start outer loop with child
1239
# if we finished all children, pop it off the stack
1242
@needs_tree_write_lock
1243
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1246
to_dir must exist in the inventory.
1248
If to_dir exists and is a directory, the files are moved into
1249
it, keeping their old names.
1251
Note that to_dir is only the last component of the new name;
1252
this doesn't change the directory.
1254
For each entry in from_paths the move mode will be determined
1257
The first mode moves the file in the filesystem and updates the
1258
inventory. The second mode only updates the inventory without
1259
touching the file on the filesystem. This is the new mode introduced
1262
move uses the second mode if 'after == True' and the target is not
1263
versioned but present in the working tree.
1265
move uses the second mode if 'after == False' and the source is
1266
versioned but no longer in the working tree, and the target is not
1267
versioned but present in the working tree.
1269
move uses the first mode if 'after == False' and the source is
1270
versioned and present in the working tree, and the target is not
1271
versioned and not present in the working tree.
1273
Everything else results in an error.
1275
This returns a list of (from_path, to_path) pairs for each
1276
entry that is moved.
1281
# check for deprecated use of signature
1283
to_dir = kwargs.get('to_name', None)
1285
raise TypeError('You must supply a target directory')
1287
symbol_versioning.warn('The parameter to_name was deprecated'
1288
' in version 0.13. Use to_dir instead',
1291
# check destination directory
1292
if isinstance(from_paths, basestring):
1294
inv = self.inventory
1295
to_abs = self.abspath(to_dir)
1296
if not isdir(to_abs):
1297
raise errors.BzrMoveFailedError('',to_dir,
1298
errors.NotADirectory(to_abs))
1299
if not self.has_filename(to_dir):
1300
raise errors.BzrMoveFailedError('',to_dir,
1301
errors.NotInWorkingDirectory(to_dir))
1302
to_dir_id = inv.path2id(to_dir)
1303
if to_dir_id is None:
1304
raise errors.BzrMoveFailedError('',to_dir,
1305
errors.NotVersionedError(path=str(to_dir)))
1307
to_dir_ie = inv[to_dir_id]
1308
if to_dir_ie.kind != 'directory':
1309
raise errors.BzrMoveFailedError('',to_dir,
1310
errors.NotADirectory(to_abs))
1312
# create rename entries and tuples
1313
for from_rel in from_paths:
1314
from_tail = splitpath(from_rel)[-1]
1315
from_id = inv.path2id(from_rel)
1317
raise errors.BzrMoveFailedError(from_rel,to_dir,
1318
errors.NotVersionedError(path=str(from_rel)))
1320
from_entry = inv[from_id]
1321
from_parent_id = from_entry.parent_id
1322
to_rel = pathjoin(to_dir, from_tail)
1323
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1325
from_tail=from_tail,
1326
from_parent_id=from_parent_id,
1327
to_rel=to_rel, to_tail=from_tail,
1328
to_parent_id=to_dir_id)
1329
rename_entries.append(rename_entry)
1330
rename_tuples.append((from_rel, to_rel))
1332
# determine which move mode to use. checks also for movability
1333
rename_entries = self._determine_mv_mode(rename_entries, after)
1335
original_modified = self._inventory_is_modified
1338
self._inventory_is_modified = True
1339
self._move(rename_entries)
1341
# restore the inventory on error
1342
self._inventory_is_modified = original_modified
1344
self._write_inventory(inv)
1345
return rename_tuples
1347
def _determine_mv_mode(self, rename_entries, after=False):
1348
"""Determines for each from-to pair if both inventory and working tree
1349
or only the inventory has to be changed.
1351
Also does basic plausability tests.
1353
inv = self.inventory
1355
for rename_entry in rename_entries:
1356
# store to local variables for easier reference
1357
from_rel = rename_entry.from_rel
1358
from_id = rename_entry.from_id
1359
to_rel = rename_entry.to_rel
1360
to_id = inv.path2id(to_rel)
1361
only_change_inv = False
1363
# check the inventory for source and destination
1365
raise errors.BzrMoveFailedError(from_rel,to_rel,
1366
errors.NotVersionedError(path=str(from_rel)))
1367
if to_id is not None:
1368
raise errors.BzrMoveFailedError(from_rel,to_rel,
1369
errors.AlreadyVersionedError(path=str(to_rel)))
1371
# try to determine the mode for rename (only change inv or change
1372
# inv and file system)
1374
if not self.has_filename(to_rel):
1375
raise errors.BzrMoveFailedError(from_id,to_rel,
1376
errors.NoSuchFile(path=str(to_rel),
1377
extra="New file has not been created yet"))
1378
only_change_inv = True
1379
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1380
only_change_inv = True
1381
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1382
only_change_inv = False
1383
elif (not self.case_sensitive
1384
and from_rel.lower() == to_rel.lower()
1385
and self.has_filename(from_rel)):
1386
only_change_inv = False
1388
# something is wrong, so lets determine what exactly
1389
if not self.has_filename(from_rel) and \
1390
not self.has_filename(to_rel):
1391
raise errors.BzrRenameFailedError(from_rel,to_rel,
1392
errors.PathsDoNotExist(paths=(str(from_rel),
1395
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1396
rename_entry.only_change_inv = only_change_inv
1397
return rename_entries
1399
def _move(self, rename_entries):
1400
"""Moves a list of files.
1402
Depending on the value of the flag 'only_change_inv', the
1403
file will be moved on the file system or not.
1405
inv = self.inventory
1408
for entry in rename_entries:
1410
self._move_entry(entry)
1412
self._rollback_move(moved)
1416
def _rollback_move(self, moved):
1417
"""Try to rollback a previous move in case of an filesystem error."""
1418
inv = self.inventory
1421
self._move_entry(WorkingTree._RenameEntry(
1422
entry.to_rel, entry.from_id,
1423
entry.to_tail, entry.to_parent_id, entry.from_rel,
1424
entry.from_tail, entry.from_parent_id,
1425
entry.only_change_inv))
1426
except errors.BzrMoveFailedError, e:
1427
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1428
" The working tree is in an inconsistent state."
1429
" Please consider doing a 'bzr revert'."
1430
" Error message is: %s" % e)
1432
def _move_entry(self, entry):
1433
inv = self.inventory
1434
from_rel_abs = self.abspath(entry.from_rel)
1435
to_rel_abs = self.abspath(entry.to_rel)
1436
if from_rel_abs == to_rel_abs:
1437
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1438
"Source and target are identical.")
1440
if not entry.only_change_inv:
1442
osutils.rename(from_rel_abs, to_rel_abs)
1444
raise errors.BzrMoveFailedError(entry.from_rel,
1446
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1448
@needs_tree_write_lock
1449
def rename_one(self, from_rel, to_rel, after=False):
1452
This can change the directory or the filename or both.
1454
rename_one has several 'modes' to work. First, it can rename a physical
1455
file and change the file_id. That is the normal mode. Second, it can
1456
only change the file_id without touching any physical file. This is
1457
the new mode introduced in version 0.15.
1459
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1460
versioned but present in the working tree.
1462
rename_one uses the second mode if 'after == False' and 'from_rel' is
1463
versioned but no longer in the working tree, and 'to_rel' is not
1464
versioned but present in the working tree.
1466
rename_one uses the first mode if 'after == False' and 'from_rel' is
1467
versioned and present in the working tree, and 'to_rel' is not
1468
versioned and not present in the working tree.
1470
Everything else results in an error.
1472
inv = self.inventory
1475
# create rename entries and tuples
1476
from_tail = splitpath(from_rel)[-1]
1477
from_id = inv.path2id(from_rel)
1479
# if file is missing in the inventory maybe it's in the basis_tree
1480
basis_tree = self.branch.basis_tree()
1481
from_id = basis_tree.path2id(from_rel)
1483
raise errors.BzrRenameFailedError(from_rel,to_rel,
1484
errors.NotVersionedError(path=str(from_rel)))
1485
# put entry back in the inventory so we can rename it
1486
from_entry = basis_tree.inventory[from_id].copy()
1489
from_entry = inv[from_id]
1490
from_parent_id = from_entry.parent_id
1491
to_dir, to_tail = os.path.split(to_rel)
1492
to_dir_id = inv.path2id(to_dir)
1493
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1495
from_tail=from_tail,
1496
from_parent_id=from_parent_id,
1497
to_rel=to_rel, to_tail=to_tail,
1498
to_parent_id=to_dir_id)
1499
rename_entries.append(rename_entry)
1501
# determine which move mode to use. checks also for movability
1502
rename_entries = self._determine_mv_mode(rename_entries, after)
1504
# check if the target changed directory and if the target directory is
1506
if to_dir_id is None:
1507
raise errors.BzrMoveFailedError(from_rel,to_rel,
1508
errors.NotVersionedError(path=str(to_dir)))
1510
# all checks done. now we can continue with our actual work
1511
mutter('rename_one:\n'
1516
' to_dir_id {%s}\n',
1517
from_id, from_rel, to_rel, to_dir, to_dir_id)
1519
self._move(rename_entries)
1520
self._write_inventory(inv)
1522
class _RenameEntry(object):
1523
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1524
to_rel, to_tail, to_parent_id, only_change_inv=False):
1525
self.from_rel = from_rel
1526
self.from_id = from_id
1527
self.from_tail = from_tail
1528
self.from_parent_id = from_parent_id
1529
self.to_rel = to_rel
1530
self.to_tail = to_tail
1531
self.to_parent_id = to_parent_id
1532
self.only_change_inv = only_change_inv
1536
"""Return all unknown files.
1538
These are files in the working directory that are not versioned or
1539
control files or ignored.
1541
# force the extras method to be fully executed before returning, to
1542
# prevent race conditions with the lock
1544
[subp for subp in self.extras() if not self.is_ignored(subp)])
1546
@needs_tree_write_lock
1547
def unversion(self, file_ids):
1548
"""Remove the file ids in file_ids from the current versioned set.
1550
When a file_id is unversioned, all of its children are automatically
1553
:param file_ids: The file ids to stop versioning.
1554
:raises: NoSuchId if any fileid is not currently versioned.
1556
for file_id in file_ids:
1557
if file_id not in self._inventory:
1558
raise errors.NoSuchId(self, file_id)
1559
for file_id in file_ids:
1560
if self._inventory.has_id(file_id):
1561
self._inventory.remove_recursive_id(file_id)
1563
# in the future this should just set a dirty bit to wait for the
1564
# final unlock. However, until all methods of workingtree start
1565
# with the current in -memory inventory rather than triggering
1566
# a read, it is more complex - we need to teach read_inventory
1567
# to know when to read, and when to not read first... and possibly
1568
# to save first when the in memory one may be corrupted.
1569
# so for now, we just only write it if it is indeed dirty.
1571
self._write_inventory(self._inventory)
1573
def _iter_conflicts(self):
1575
for info in self.list_files():
1577
stem = get_conflicted_stem(path)
1580
if stem not in conflicted:
1581
conflicted.add(stem)
1585
def pull(self, source, overwrite=False, stop_revision=None,
1586
change_reporter=None, possible_transports=None, local=False):
1587
top_pb = ui.ui_factory.nested_progress_bar()
1590
pp = ProgressPhase("Pull phase", 2, top_pb)
1592
old_revision_info = self.branch.last_revision_info()
1593
basis_tree = self.basis_tree()
1594
count = self.branch.pull(source, overwrite, stop_revision,
1595
possible_transports=possible_transports,
1597
new_revision_info = self.branch.last_revision_info()
1598
if new_revision_info != old_revision_info:
1600
repository = self.branch.repository
1601
pb = ui.ui_factory.nested_progress_bar()
1602
basis_tree.lock_read()
1604
new_basis_tree = self.branch.basis_tree()
1611
change_reporter=change_reporter)
1612
if (basis_tree.inventory.root is None and
1613
new_basis_tree.inventory.root is not None):
1614
self.set_root_id(new_basis_tree.get_root_id())
1618
# TODO - dedup parents list with things merged by pull ?
1619
# reuse the revisiontree we merged against to set the new
1621
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1622
# we have to pull the merge trees out again, because
1623
# merge_inner has set the ids. - this corner is not yet
1624
# layered well enough to prevent double handling.
1625
# XXX TODO: Fix the double handling: telling the tree about
1626
# the already known parent data is wasteful.
1627
merges = self.get_parent_ids()[1:]
1628
parent_trees.extend([
1629
(parent, repository.revision_tree(parent)) for
1631
self.set_parent_trees(parent_trees)
1638
def put_file_bytes_non_atomic(self, file_id, bytes):
1639
"""See MutableTree.put_file_bytes_non_atomic."""
1640
stream = file(self.id2abspath(file_id), 'wb')
1645
# TODO: update the hashcache here ?
1648
"""Yield all unversioned files in this WorkingTree.
1650
If there are any unversioned directories then only the directory is
1651
returned, not all its children. But if there are unversioned files
1652
under a versioned subdirectory, they are returned.
1654
Currently returned depth-first, sorted by name within directories.
1655
This is the same order used by 'osutils.walkdirs'.
1657
## TODO: Work from given directory downwards
1658
for path, dir_entry in self.inventory.directories():
1659
# mutter("search for unknowns in %r", path)
1660
dirabs = self.abspath(path)
1661
if not isdir(dirabs):
1662
# e.g. directory deleted
1666
for subf in os.listdir(dirabs):
1667
if self.bzrdir.is_control_filename(subf):
1669
if subf not in dir_entry.children:
1672
can_access) = osutils.normalized_filename(subf)
1673
except UnicodeDecodeError:
1674
path_os_enc = path.encode(osutils._fs_enc)
1675
relpath = path_os_enc + '/' + subf
1676
raise errors.BadFilenameEncoding(relpath,
1678
if subf_norm != subf and can_access:
1679
if subf_norm not in dir_entry.children:
1680
fl.append(subf_norm)
1686
subp = pathjoin(path, subf)
1689
def ignored_files(self):
1690
"""Yield list of PATH, IGNORE_PATTERN"""
1691
for subp in self.extras():
1692
pat = self.is_ignored(subp)
1696
def get_ignore_list(self):
1697
"""Return list of ignore patterns.
1699
Cached in the Tree object after the first call.
1701
ignoreset = getattr(self, '_ignoreset', None)
1702
if ignoreset is not None:
1705
ignore_globs = set()
1706
ignore_globs.update(ignores.get_runtime_ignores())
1707
ignore_globs.update(ignores.get_user_ignores())
1708
if self.has_filename(bzrlib.IGNORE_FILENAME):
1709
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1711
ignore_globs.update(ignores.parse_ignore_file(f))
1714
self._ignoreset = ignore_globs
1717
def _flush_ignore_list_cache(self):
1718
"""Resets the cached ignore list to force a cache rebuild."""
1719
self._ignoreset = None
1720
self._ignoreglobster = None
1722
def is_ignored(self, filename):
1723
r"""Check whether the filename matches an ignore pattern.
1725
Patterns containing '/' or '\' need to match the whole path;
1726
others match against only the last component.
1728
If the file is ignored, returns the pattern which caused it to
1729
be ignored, otherwise None. So this can simply be used as a
1730
boolean if desired."""
1731
if getattr(self, '_ignoreglobster', None) is None:
1732
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1733
return self._ignoreglobster.match(filename)
1735
def kind(self, file_id):
1736
return file_kind(self.id2abspath(file_id))
1738
def stored_kind(self, file_id):
1739
"""See Tree.stored_kind"""
1740
return self.inventory[file_id].kind
1742
def _comparison_data(self, entry, path):
1743
abspath = self.abspath(path)
1745
stat_value = os.lstat(abspath)
1747
if getattr(e, 'errno', None) == errno.ENOENT:
1754
mode = stat_value.st_mode
1755
kind = osutils.file_kind_from_stat_mode(mode)
1756
if not supports_executable():
1757
executable = entry is not None and entry.executable
1759
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1760
return kind, executable, stat_value
1762
def _file_size(self, entry, stat_value):
1763
return stat_value.st_size
1765
def last_revision(self):
1766
"""Return the last revision of the branch for this tree.
1768
This format tree does not support a separate marker for last-revision
1769
compared to the branch.
1771
See MutableTree.last_revision
1773
return self._last_revision()
1776
def _last_revision(self):
1777
"""helper for get_parent_ids."""
1778
return _mod_revision.ensure_null(self.branch.last_revision())
1780
def is_locked(self):
1781
return self._control_files.is_locked()
1783
def _must_be_locked(self):
1784
if not self.is_locked():
1785
raise errors.ObjectNotLocked(self)
1787
def lock_read(self):
1788
"""See Branch.lock_read, and WorkingTree.unlock."""
1789
if not self.is_locked():
1791
self.branch.lock_read()
1793
return self._control_files.lock_read()
1795
self.branch.unlock()
1798
def lock_tree_write(self):
1799
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1800
if not self.is_locked():
1802
self.branch.lock_read()
1804
return self._control_files.lock_write()
1806
self.branch.unlock()
1809
def lock_write(self):
1810
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1811
if not self.is_locked():
1813
self.branch.lock_write()
1815
return self._control_files.lock_write()
1817
self.branch.unlock()
1820
def get_physical_lock_status(self):
1821
return self._control_files.get_physical_lock_status()
1823
def _basis_inventory_name(self):
1824
return 'basis-inventory-cache'
1826
def _reset_data(self):
1827
"""Reset transient data that cannot be revalidated."""
1828
self._inventory_is_modified = False
1829
result = self._deserialize(self._transport.get('inventory'))
1830
self._set_inventory(result, dirty=False)
1832
@needs_tree_write_lock
1833
def set_last_revision(self, new_revision):
1834
"""Change the last revision in the working tree."""
1835
if self._change_last_revision(new_revision):
1836
self._cache_basis_inventory(new_revision)
1838
def _change_last_revision(self, new_revision):
1839
"""Template method part of set_last_revision to perform the change.
1841
This is used to allow WorkingTree3 instances to not affect branch
1842
when their last revision is set.
1844
if _mod_revision.is_null(new_revision):
1845
self.branch.set_revision_history([])
1848
self.branch.generate_revision_history(new_revision)
1849
except errors.NoSuchRevision:
1850
# not present in the repo - dont try to set it deeper than the tip
1851
self.branch.set_revision_history([new_revision])
1854
def _write_basis_inventory(self, xml):
1855
"""Write the basis inventory XML to the basis-inventory file"""
1856
path = self._basis_inventory_name()
1858
self._transport.put_file(path, sio,
1859
mode=self.bzrdir._get_file_mode())
1861
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1862
"""Create the text that will be saved in basis-inventory"""
1863
inventory.revision_id = revision_id
1864
return xml7.serializer_v7.write_inventory_to_string(inventory)
1866
def _cache_basis_inventory(self, new_revision):
1867
"""Cache new_revision as the basis inventory."""
1868
# TODO: this should allow the ready-to-use inventory to be passed in,
1869
# as commit already has that ready-to-use [while the format is the
1872
# this double handles the inventory - unpack and repack -
1873
# but is easier to understand. We can/should put a conditional
1874
# in here based on whether the inventory is in the latest format
1875
# - perhaps we should repack all inventories on a repository
1877
# the fast path is to copy the raw xml from the repository. If the
1878
# xml contains 'revision_id="', then we assume the right
1879
# revision_id is set. We must check for this full string, because a
1880
# root node id can legitimately look like 'revision_id' but cannot
1882
xml = self.branch.repository.get_inventory_xml(new_revision)
1883
firstline = xml.split('\n', 1)[0]
1884
if (not 'revision_id="' in firstline or
1885
'format="7"' not in firstline):
1886
inv = self.branch.repository.deserialise_inventory(
1888
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1889
self._write_basis_inventory(xml)
1890
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1893
def read_basis_inventory(self):
1894
"""Read the cached basis inventory."""
1895
path = self._basis_inventory_name()
1896
return self._transport.get_bytes(path)
1899
def read_working_inventory(self):
1900
"""Read the working inventory.
1902
:raises errors.InventoryModified: read_working_inventory will fail
1903
when the current in memory inventory has been modified.
1905
# conceptually this should be an implementation detail of the tree.
1906
# XXX: Deprecate this.
1907
# ElementTree does its own conversion from UTF-8, so open in
1909
if self._inventory_is_modified:
1910
raise errors.InventoryModified(self)
1911
result = self._deserialize(self._transport.get('inventory'))
1912
self._set_inventory(result, dirty=False)
1915
@needs_tree_write_lock
1916
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1918
"""Remove nominated files from the working inventory.
1920
:files: File paths relative to the basedir.
1921
:keep_files: If true, the files will also be kept.
1922
:force: Delete files and directories, even if they are changed and
1923
even if the directories are not empty.
1925
if isinstance(files, basestring):
1931
unknown_nested_files=set()
1933
def recurse_directory_to_add_files(directory):
1934
# Recurse directory and add all files
1935
# so we can check if they have changed.
1936
for parent_info, file_infos in\
1937
self.walkdirs(directory):
1938
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1939
# Is it versioned or ignored?
1940
if self.path2id(relpath) or self.is_ignored(relpath):
1941
# Add nested content for deletion.
1942
new_files.add(relpath)
1944
# Files which are not versioned and not ignored
1945
# should be treated as unknown.
1946
unknown_nested_files.add((relpath, None, kind))
1948
for filename in files:
1949
# Get file name into canonical form.
1950
abspath = self.abspath(filename)
1951
filename = self.relpath(abspath)
1952
if len(filename) > 0:
1953
new_files.add(filename)
1954
recurse_directory_to_add_files(filename)
1956
files = list(new_files)
1959
return # nothing to do
1961
# Sort needed to first handle directory content before the directory
1962
files.sort(reverse=True)
1964
# Bail out if we are going to delete files we shouldn't
1965
if not keep_files and not force:
1966
has_changed_files = len(unknown_nested_files) > 0
1967
if not has_changed_files:
1968
for (file_id, path, content_change, versioned, parent_id, name,
1969
kind, executable) in self.iter_changes(self.basis_tree(),
1970
include_unchanged=True, require_versioned=False,
1971
want_unversioned=True, specific_files=files):
1972
if versioned == (False, False):
1973
# The record is unknown ...
1974
if not self.is_ignored(path[1]):
1975
# ... but not ignored
1976
has_changed_files = True
1978
elif content_change and (kind[1] is not None):
1979
# Versioned and changed, but not deleted
1980
has_changed_files = True
1983
if has_changed_files:
1984
# Make delta show ALL applicable changes in error message.
1985
tree_delta = self.changes_from(self.basis_tree(),
1986
require_versioned=False, want_unversioned=True,
1987
specific_files=files)
1988
for unknown_file in unknown_nested_files:
1989
if unknown_file not in tree_delta.unversioned:
1990
tree_delta.unversioned.extend((unknown_file,))
1991
raise errors.BzrRemoveChangedFilesError(tree_delta)
1993
# Build inv_delta and delete files where applicable,
1994
# do this before any modifications to inventory.
1996
fid = self.path2id(f)
1999
message = "%s is not versioned." % (f,)
2002
# having removed it, it must be either ignored or unknown
2003
if self.is_ignored(f):
2007
textui.show_status(new_status, self.kind(fid), f,
2010
inv_delta.append((f, None, fid, None))
2011
message = "removed %s" % (f,)
2014
abs_path = self.abspath(f)
2015
if osutils.lexists(abs_path):
2016
if (osutils.isdir(abs_path) and
2017
len(os.listdir(abs_path)) > 0):
2019
osutils.rmtree(abs_path)
2021
message = "%s is not an empty directory "\
2022
"and won't be deleted." % (f,)
2024
osutils.delete_any(abs_path)
2025
message = "deleted %s" % (f,)
2026
elif message is not None:
2027
# Only care if we haven't done anything yet.
2028
message = "%s does not exist." % (f,)
2030
# Print only one message (if any) per file.
2031
if message is not None:
2033
self.apply_inventory_delta(inv_delta)
2035
@needs_tree_write_lock
2036
def revert(self, filenames=None, old_tree=None, backups=True,
2037
pb=DummyProgress(), report_changes=False):
2038
from bzrlib.conflicts import resolve
2041
symbol_versioning.warn('Using [] to revert all files is deprecated'
2042
' as of bzr 0.91. Please use None (the default) instead.',
2043
DeprecationWarning, stacklevel=2)
2044
if old_tree is None:
2045
basis_tree = self.basis_tree()
2046
basis_tree.lock_read()
2047
old_tree = basis_tree
2051
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2053
if filenames is None and len(self.get_parent_ids()) > 1:
2055
last_revision = self.last_revision()
2056
if last_revision != _mod_revision.NULL_REVISION:
2057
if basis_tree is None:
2058
basis_tree = self.basis_tree()
2059
basis_tree.lock_read()
2060
parent_trees.append((last_revision, basis_tree))
2061
self.set_parent_trees(parent_trees)
2064
resolve(self, filenames, ignore_misses=True, recursive=True)
2066
if basis_tree is not None:
2070
def revision_tree(self, revision_id):
2071
"""See Tree.revision_tree.
2073
WorkingTree can supply revision_trees for the basis revision only
2074
because there is only one cached inventory in the bzr directory.
2076
if revision_id == self.last_revision():
2078
xml = self.read_basis_inventory()
2079
except errors.NoSuchFile:
2083
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2084
# dont use the repository revision_tree api because we want
2085
# to supply the inventory.
2086
if inv.revision_id == revision_id:
2087
return revisiontree.RevisionTree(self.branch.repository,
2089
except errors.BadInventoryFormat:
2091
# raise if there was no inventory, or if we read the wrong inventory.
2092
raise errors.NoSuchRevisionInTree(self, revision_id)
2094
# XXX: This method should be deprecated in favour of taking in a proper
2095
# new Inventory object.
2096
@needs_tree_write_lock
2097
def set_inventory(self, new_inventory_list):
2098
from bzrlib.inventory import (Inventory,
2102
inv = Inventory(self.get_root_id())
2103
for path, file_id, parent, kind in new_inventory_list:
2104
name = os.path.basename(path)
2107
# fixme, there should be a factory function inv,add_??
2108
if kind == 'directory':
2109
inv.add(InventoryDirectory(file_id, name, parent))
2110
elif kind == 'file':
2111
inv.add(InventoryFile(file_id, name, parent))
2112
elif kind == 'symlink':
2113
inv.add(InventoryLink(file_id, name, parent))
2115
raise errors.BzrError("unknown kind %r" % kind)
2116
self._write_inventory(inv)
2118
@needs_tree_write_lock
2119
def set_root_id(self, file_id):
2120
"""Set the root id for this tree."""
2124
'WorkingTree.set_root_id with fileid=None')
2125
file_id = osutils.safe_file_id(file_id)
2126
self._set_root_id(file_id)
2128
def _set_root_id(self, file_id):
2129
"""Set the root id for this tree, in a format specific manner.
2131
:param file_id: The file id to assign to the root. It must not be
2132
present in the current inventory or an error will occur. It must
2133
not be None, but rather a valid file id.
2135
inv = self._inventory
2136
orig_root_id = inv.root.file_id
2137
# TODO: it might be nice to exit early if there was nothing
2138
# to do, saving us from trigger a sync on unlock.
2139
self._inventory_is_modified = True
2140
# we preserve the root inventory entry object, but
2141
# unlinkit from the byid index
2142
del inv._byid[inv.root.file_id]
2143
inv.root.file_id = file_id
2144
# and link it into the index with the new changed id.
2145
inv._byid[inv.root.file_id] = inv.root
2146
# and finally update all children to reference the new id.
2147
# XXX: this should be safe to just look at the root.children
2148
# list, not the WHOLE INVENTORY.
2151
if entry.parent_id == orig_root_id:
2152
entry.parent_id = inv.root.file_id
2155
"""See Branch.unlock.
2157
WorkingTree locking just uses the Branch locking facilities.
2158
This is current because all working trees have an embedded branch
2159
within them. IF in the future, we were to make branch data shareable
2160
between multiple working trees, i.e. via shared storage, then we
2161
would probably want to lock both the local tree, and the branch.
2163
raise NotImplementedError(self.unlock)
2165
def update(self, change_reporter=None, possible_transports=None):
2166
"""Update a working tree along its branch.
2168
This will update the branch if its bound too, which means we have
2169
multiple trees involved:
2171
- The new basis tree of the master.
2172
- The old basis tree of the branch.
2173
- The old basis tree of the working tree.
2174
- The current working tree state.
2176
Pathologically, all three may be different, and non-ancestors of each
2177
other. Conceptually we want to:
2179
- Preserve the wt.basis->wt.state changes
2180
- Transform the wt.basis to the new master basis.
2181
- Apply a merge of the old branch basis to get any 'local' changes from
2183
- Restore the wt.basis->wt.state changes.
2185
There isn't a single operation at the moment to do that, so we:
2186
- Merge current state -> basis tree of the master w.r.t. the old tree
2188
- Do a 'normal' merge of the old branch basis if it is relevant.
2190
if self.branch.get_bound_location() is not None:
2192
update_branch = True
2194
self.lock_tree_write()
2195
update_branch = False
2198
old_tip = self.branch.update(possible_transports)
2201
return self._update_tree(old_tip, change_reporter)
2205
@needs_tree_write_lock
2206
def _update_tree(self, old_tip=None, change_reporter=None):
2207
"""Update a tree to the master branch.
2209
:param old_tip: if supplied, the previous tip revision the branch,
2210
before it was changed to the master branch's tip.
2212
# here if old_tip is not None, it is the old tip of the branch before
2213
# it was updated from the master branch. This should become a pending
2214
# merge in the working tree to preserve the user existing work. we
2215
# cant set that until we update the working trees last revision to be
2216
# one from the new branch, because it will just get absorbed by the
2217
# parent de-duplication logic.
2219
# We MUST save it even if an error occurs, because otherwise the users
2220
# local work is unreferenced and will appear to have been lost.
2224
last_rev = self.get_parent_ids()[0]
2226
last_rev = _mod_revision.NULL_REVISION
2227
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2228
# merge tree state up to new branch tip.
2229
basis = self.basis_tree()
2232
to_tree = self.branch.basis_tree()
2233
if basis.inventory.root is None:
2234
self.set_root_id(to_tree.get_root_id())
2236
result += merge.merge_inner(
2241
change_reporter=change_reporter)
2244
# TODO - dedup parents list with things merged by pull ?
2245
# reuse the tree we've updated to to set the basis:
2246
parent_trees = [(self.branch.last_revision(), to_tree)]
2247
merges = self.get_parent_ids()[1:]
2248
# Ideally we ask the tree for the trees here, that way the working
2249
# tree can decide whether to give us the entire tree or give us a
2250
# lazy initialised tree. dirstate for instance will have the trees
2251
# in ram already, whereas a last-revision + basis-inventory tree
2252
# will not, but also does not need them when setting parents.
2253
for parent in merges:
2254
parent_trees.append(
2255
(parent, self.branch.repository.revision_tree(parent)))
2256
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2257
parent_trees.append(
2258
(old_tip, self.branch.repository.revision_tree(old_tip)))
2259
self.set_parent_trees(parent_trees)
2260
last_rev = parent_trees[0][0]
2262
# the working tree had the same last-revision as the master
2263
# branch did. We may still have pivot local work from the local
2264
# branch into old_tip:
2265
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2266
self.add_parent_tree_id(old_tip)
2267
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2268
and old_tip != last_rev):
2269
# our last revision was not the prior branch last revision
2270
# and we have converted that last revision to a pending merge.
2271
# base is somewhere between the branch tip now
2272
# and the now pending merge
2274
# Since we just modified the working tree and inventory, flush out
2275
# the current state, before we modify it again.
2276
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2277
# requires it only because TreeTransform directly munges the
2278
# inventory and calls tree._write_inventory(). Ultimately we
2279
# should be able to remove this extra flush.
2281
graph = self.branch.repository.get_graph()
2282
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2284
base_tree = self.branch.repository.revision_tree(base_rev_id)
2285
other_tree = self.branch.repository.revision_tree(old_tip)
2286
result += merge.merge_inner(
2291
change_reporter=change_reporter)
2294
def _write_hashcache_if_dirty(self):
2295
"""Write out the hashcache if it is dirty."""
2296
if self._hashcache.needs_write:
2298
self._hashcache.write()
2300
if e.errno not in (errno.EPERM, errno.EACCES):
2302
# TODO: jam 20061219 Should this be a warning? A single line
2303
# warning might be sufficient to let the user know what
2305
mutter('Could not write hashcache for %s\nError: %s',
2306
self._hashcache.cache_file_name(), e)
2308
@needs_tree_write_lock
2309
def _write_inventory(self, inv):
2310
"""Write inventory as the current inventory."""
2311
self._set_inventory(inv, dirty=True)
2314
def set_conflicts(self, arg):
2315
raise errors.UnsupportedOperation(self.set_conflicts, self)
2317
def add_conflicts(self, arg):
2318
raise errors.UnsupportedOperation(self.add_conflicts, self)
2321
def conflicts(self):
2322
conflicts = _mod_conflicts.ConflictList()
2323
for conflicted in self._iter_conflicts():
2326
if file_kind(self.abspath(conflicted)) != "file":
2328
except errors.NoSuchFile:
2331
for suffix in ('.THIS', '.OTHER'):
2333
kind = file_kind(self.abspath(conflicted+suffix))
2336
except errors.NoSuchFile:
2340
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2341
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2343
file_id=self.path2id(conflicted)))
2346
def walkdirs(self, prefix=""):
2347
"""Walk the directories of this tree.
2349
returns a generator which yields items in the form:
2350
((curren_directory_path, fileid),
2351
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2354
This API returns a generator, which is only valid during the current
2355
tree transaction - within a single lock_read or lock_write duration.
2357
If the tree is not locked, it may cause an error to be raised,
2358
depending on the tree implementation.
2360
disk_top = self.abspath(prefix)
2361
if disk_top.endswith('/'):
2362
disk_top = disk_top[:-1]
2363
top_strip_len = len(disk_top) + 1
2364
inventory_iterator = self._walkdirs(prefix)
2365
disk_iterator = osutils.walkdirs(disk_top, prefix)
2367
current_disk = disk_iterator.next()
2368
disk_finished = False
2370
if not (e.errno == errno.ENOENT or
2371
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2374
disk_finished = True
2376
current_inv = inventory_iterator.next()
2377
inv_finished = False
2378
except StopIteration:
2381
while not inv_finished or not disk_finished:
2383
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2384
cur_disk_dir_content) = current_disk
2386
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2387
cur_disk_dir_content) = ((None, None), None)
2388
if not disk_finished:
2389
# strip out .bzr dirs
2390
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2391
len(cur_disk_dir_content) > 0):
2392
# osutils.walkdirs can be made nicer -
2393
# yield the path-from-prefix rather than the pathjoined
2395
bzrdir_loc = bisect_left(cur_disk_dir_content,
2397
if (bzrdir_loc < len(cur_disk_dir_content)
2398
and self.bzrdir.is_control_filename(
2399
cur_disk_dir_content[bzrdir_loc][0])):
2400
# we dont yield the contents of, or, .bzr itself.
2401
del cur_disk_dir_content[bzrdir_loc]
2403
# everything is unknown
2406
# everything is missing
2409
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2411
# disk is before inventory - unknown
2412
dirblock = [(relpath, basename, kind, stat, None, None) for
2413
relpath, basename, kind, stat, top_path in
2414
cur_disk_dir_content]
2415
yield (cur_disk_dir_relpath, None), dirblock
2417
current_disk = disk_iterator.next()
2418
except StopIteration:
2419
disk_finished = True
2421
# inventory is before disk - missing.
2422
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2423
for relpath, basename, dkind, stat, fileid, kind in
2425
yield (current_inv[0][0], current_inv[0][1]), dirblock
2427
current_inv = inventory_iterator.next()
2428
except StopIteration:
2431
# versioned present directory
2432
# merge the inventory and disk data together
2434
for relpath, subiterator in itertools.groupby(sorted(
2435
current_inv[1] + cur_disk_dir_content,
2436
key=operator.itemgetter(0)), operator.itemgetter(1)):
2437
path_elements = list(subiterator)
2438
if len(path_elements) == 2:
2439
inv_row, disk_row = path_elements
2440
# versioned, present file
2441
dirblock.append((inv_row[0],
2442
inv_row[1], disk_row[2],
2443
disk_row[3], inv_row[4],
2445
elif len(path_elements[0]) == 5:
2447
dirblock.append((path_elements[0][0],
2448
path_elements[0][1], path_elements[0][2],
2449
path_elements[0][3], None, None))
2450
elif len(path_elements[0]) == 6:
2451
# versioned, absent file.
2452
dirblock.append((path_elements[0][0],
2453
path_elements[0][1], 'unknown', None,
2454
path_elements[0][4], path_elements[0][5]))
2456
raise NotImplementedError('unreachable code')
2457
yield current_inv[0], dirblock
2459
current_inv = inventory_iterator.next()
2460
except StopIteration:
2463
current_disk = disk_iterator.next()
2464
except StopIteration:
2465
disk_finished = True
2467
def _walkdirs(self, prefix=""):
2468
"""Walk the directories of this tree.
2470
:prefix: is used as the directrory to start with.
2471
returns a generator which yields items in the form:
2472
((curren_directory_path, fileid),
2473
[(file1_path, file1_name, file1_kind, None, file1_id,
2476
_directory = 'directory'
2477
# get the root in the inventory
2478
inv = self.inventory
2479
top_id = inv.path2id(prefix)
2483
pending = [(prefix, '', _directory, None, top_id, None)]
2486
currentdir = pending.pop()
2487
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2488
top_id = currentdir[4]
2490
relroot = currentdir[0] + '/'
2493
# FIXME: stash the node in pending
2495
if entry.kind == 'directory':
2496
for name, child in entry.sorted_children():
2497
dirblock.append((relroot + name, name, child.kind, None,
2498
child.file_id, child.kind
2500
yield (currentdir[0], entry.file_id), dirblock
2501
# push the user specified dirs from dirblock
2502
for dir in reversed(dirblock):
2503
if dir[2] == _directory:
2506
@needs_tree_write_lock
2507
def auto_resolve(self):
2508
"""Automatically resolve text conflicts according to contents.
2510
Only text conflicts are auto_resolvable. Files with no conflict markers
2511
are considered 'resolved', because bzr always puts conflict markers
2512
into files that have text conflicts. The corresponding .THIS .BASE and
2513
.OTHER files are deleted, as per 'resolve'.
2514
:return: a tuple of ConflictLists: (un_resolved, resolved).
2516
un_resolved = _mod_conflicts.ConflictList()
2517
resolved = _mod_conflicts.ConflictList()
2518
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2519
for conflict in self.conflicts():
2520
if (conflict.typestring != 'text conflict' or
2521
self.kind(conflict.file_id) != 'file'):
2522
un_resolved.append(conflict)
2524
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2526
for line in my_file:
2527
if conflict_re.search(line):
2528
un_resolved.append(conflict)
2531
resolved.append(conflict)
2534
resolved.remove_files(self)
2535
self.set_conflicts(un_resolved)
2536
return un_resolved, resolved
2540
tree_basis = self.basis_tree()
2541
tree_basis.lock_read()
2543
repo_basis = self.branch.repository.revision_tree(
2544
self.last_revision())
2545
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2546
raise errors.BzrCheckError(
2547
"Mismatched basis inventory content.")
2552
def _validate(self):
2553
"""Validate internal structures.
2555
This is meant mostly for the test suite. To give it a chance to detect
2556
corruption after actions have occurred. The default implementation is a
2559
:return: None. An exception should be raised if there is an error.
2564
def _get_rules_searcher(self, default_searcher):
2565
"""See Tree._get_rules_searcher."""
2566
if self._rules_searcher is None:
2567
self._rules_searcher = super(WorkingTree,
2568
self)._get_rules_searcher(default_searcher)
2569
return self._rules_searcher
2571
def get_shelf_manager(self):
2572
"""Return the ShelfManager for this WorkingTree."""
2573
from bzrlib.shelf import ShelfManager
2574
return ShelfManager(self, self._transport)
2577
class WorkingTree2(WorkingTree):
2578
"""This is the Format 2 working tree.
2580
This was the first weave based working tree.
2581
- uses os locks for locking.
2582
- uses the branch last-revision.
2585
def __init__(self, *args, **kwargs):
2586
super(WorkingTree2, self).__init__(*args, **kwargs)
2587
# WorkingTree2 has more of a constraint that self._inventory must
2588
# exist. Because this is an older format, we don't mind the overhead
2589
# caused by the extra computation here.
2591
# Newer WorkingTree's should only have self._inventory set when they
2593
if self._inventory is None:
2594
self.read_working_inventory()
2596
def lock_tree_write(self):
2597
"""See WorkingTree.lock_tree_write().
2599
In Format2 WorkingTrees we have a single lock for the branch and tree
2600
so lock_tree_write() degrades to lock_write().
2602
self.branch.lock_write()
2604
return self._control_files.lock_write()
2606
self.branch.unlock()
2610
# do non-implementation specific cleanup
2613
# we share control files:
2614
if self._control_files._lock_count == 3:
2615
# _inventory_is_modified is always False during a read lock.
2616
if self._inventory_is_modified:
2618
self._write_hashcache_if_dirty()
2620
# reverse order of locking.
2622
return self._control_files.unlock()
2624
self.branch.unlock()
2627
class WorkingTree3(WorkingTree):
2628
"""This is the Format 3 working tree.
2630
This differs from the base WorkingTree by:
2631
- having its own file lock
2632
- having its own last-revision property.
2634
This is new in bzr 0.8
2638
def _last_revision(self):
2639
"""See Mutable.last_revision."""
2641
return self._transport.get_bytes('last-revision')
2642
except errors.NoSuchFile:
2643
return _mod_revision.NULL_REVISION
2645
def _change_last_revision(self, revision_id):
2646
"""See WorkingTree._change_last_revision."""
2647
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2649
self._transport.delete('last-revision')
2650
except errors.NoSuchFile:
2654
self._transport.put_bytes('last-revision', revision_id,
2655
mode=self.bzrdir._get_file_mode())
2658
@needs_tree_write_lock
2659
def set_conflicts(self, conflicts):
2660
self._put_rio('conflicts', conflicts.to_stanzas(),
2663
@needs_tree_write_lock
2664
def add_conflicts(self, new_conflicts):
2665
conflict_set = set(self.conflicts())
2666
conflict_set.update(set(list(new_conflicts)))
2667
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2668
key=_mod_conflicts.Conflict.sort_key)))
2671
def conflicts(self):
2673
confile = self._transport.get('conflicts')
2674
except errors.NoSuchFile:
2675
return _mod_conflicts.ConflictList()
2678
if confile.next() != CONFLICT_HEADER_1 + '\n':
2679
raise errors.ConflictFormatError()
2680
except StopIteration:
2681
raise errors.ConflictFormatError()
2682
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2687
# do non-implementation specific cleanup
2689
if self._control_files._lock_count == 1:
2690
# _inventory_is_modified is always False during a read lock.
2691
if self._inventory_is_modified:
2693
self._write_hashcache_if_dirty()
2694
# reverse order of locking.
2696
return self._control_files.unlock()
2698
self.branch.unlock()
2701
def get_conflicted_stem(path):
2702
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2703
if path.endswith(suffix):
2704
return path[:-len(suffix)]
2707
class WorkingTreeFormat(object):
2708
"""An encapsulation of the initialization and open routines for a format.
2710
Formats provide three things:
2711
* An initialization routine,
2715
Formats are placed in an dict by their format string for reference
2716
during workingtree opening. Its not required that these be instances, they
2717
can be classes themselves with class methods - it simply depends on
2718
whether state is needed for a given format or not.
2720
Once a format is deprecated, just deprecate the initialize and open
2721
methods on the format class. Do not deprecate the object, as the
2722
object will be created every time regardless.
2725
_default_format = None
2726
"""The default format used for new trees."""
2729
"""The known formats."""
2731
requires_rich_root = False
2733
upgrade_recommended = False
2736
def find_format(klass, a_bzrdir):
2737
"""Return the format for the working tree object in a_bzrdir."""
2739
transport = a_bzrdir.get_workingtree_transport(None)
2740
format_string = transport.get("format").read()
2741
return klass._formats[format_string]
2742
except errors.NoSuchFile:
2743
raise errors.NoWorkingTree(base=transport.base)
2745
raise errors.UnknownFormatError(format=format_string,
2746
kind="working tree")
2748
def __eq__(self, other):
2749
return self.__class__ is other.__class__
2751
def __ne__(self, other):
2752
return not (self == other)
2755
def get_default_format(klass):
2756
"""Return the current default format."""
2757
return klass._default_format
2759
def get_format_string(self):
2760
"""Return the ASCII format string that identifies this format."""
2761
raise NotImplementedError(self.get_format_string)
2763
def get_format_description(self):
2764
"""Return the short description for this format."""
2765
raise NotImplementedError(self.get_format_description)
2767
def is_supported(self):
2768
"""Is this format supported?
2770
Supported formats can be initialized and opened.
2771
Unsupported formats may not support initialization or committing or
2772
some other features depending on the reason for not being supported.
2776
def supports_content_filtering(self):
2777
"""True if this format supports content filtering."""
2780
def supports_views(self):
2781
"""True if this format supports stored views."""
2785
def register_format(klass, format):
2786
klass._formats[format.get_format_string()] = format
2789
def set_default_format(klass, format):
2790
klass._default_format = format
2793
def unregister_format(klass, format):
2794
del klass._formats[format.get_format_string()]
2797
class WorkingTreeFormat2(WorkingTreeFormat):
2798
"""The second working tree format.
2800
This format modified the hash cache from the format 1 hash cache.
2803
upgrade_recommended = True
2805
def get_format_description(self):
2806
"""See WorkingTreeFormat.get_format_description()."""
2807
return "Working tree format 2"
2809
def _stub_initialize_on_transport(self, transport, file_mode):
2810
"""Workaround: create control files for a remote working tree.
2812
This ensures that it can later be updated and dealt with locally,
2813
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2814
no working tree. (See bug #43064).
2817
inv = inventory.Inventory()
2818
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2820
transport.put_file('inventory', sio, file_mode)
2821
transport.put_bytes('pending-merges', '', file_mode)
2823
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2824
accelerator_tree=None, hardlink=False):
2825
"""See WorkingTreeFormat.initialize()."""
2826
if not isinstance(a_bzrdir.transport, LocalTransport):
2827
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2828
if from_branch is not None:
2829
branch = from_branch
2831
branch = a_bzrdir.open_branch()
2832
if revision_id is None:
2833
revision_id = _mod_revision.ensure_null(branch.last_revision())
2836
branch.generate_revision_history(revision_id)
2839
inv = inventory.Inventory()
2840
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2846
basis_tree = branch.repository.revision_tree(revision_id)
2847
if basis_tree.inventory.root is not None:
2848
wt.set_root_id(basis_tree.get_root_id())
2849
# set the parent list and cache the basis tree.
2850
if _mod_revision.is_null(revision_id):
2853
parent_trees = [(revision_id, basis_tree)]
2854
wt.set_parent_trees(parent_trees)
2855
transform.build_tree(basis_tree, wt)
2859
super(WorkingTreeFormat2, self).__init__()
2860
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2862
def open(self, a_bzrdir, _found=False):
2863
"""Return the WorkingTree object for a_bzrdir
2865
_found is a private parameter, do not use it. It is used to indicate
2866
if format probing has already been done.
2869
# we are being called directly and must probe.
2870
raise NotImplementedError
2871
if not isinstance(a_bzrdir.transport, LocalTransport):
2872
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2873
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2879
class WorkingTreeFormat3(WorkingTreeFormat):
2880
"""The second working tree format updated to record a format marker.
2883
- exists within a metadir controlling .bzr
2884
- includes an explicit version marker for the workingtree control
2885
files, separate from the BzrDir format
2886
- modifies the hash cache format
2888
- uses a LockDir to guard access for writes.
2891
upgrade_recommended = True
2893
def get_format_string(self):
2894
"""See WorkingTreeFormat.get_format_string()."""
2895
return "Bazaar-NG Working Tree format 3"
2897
def get_format_description(self):
2898
"""See WorkingTreeFormat.get_format_description()."""
2899
return "Working tree format 3"
2901
_lock_file_name = 'lock'
2902
_lock_class = LockDir
2904
_tree_class = WorkingTree3
2906
def __get_matchingbzrdir(self):
2907
return bzrdir.BzrDirMetaFormat1()
2909
_matchingbzrdir = property(__get_matchingbzrdir)
2911
def _open_control_files(self, a_bzrdir):
2912
transport = a_bzrdir.get_workingtree_transport(None)
2913
return LockableFiles(transport, self._lock_file_name,
2916
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2917
accelerator_tree=None, hardlink=False):
2918
"""See WorkingTreeFormat.initialize().
2920
:param revision_id: if supplied, create a working tree at a different
2921
revision than the branch is at.
2922
:param accelerator_tree: A tree which can be used for retrieving file
2923
contents more quickly than the revision tree, i.e. a workingtree.
2924
The revision tree will be used for cases where accelerator_tree's
2925
content is different.
2926
:param hardlink: If true, hard-link files from accelerator_tree,
2929
if not isinstance(a_bzrdir.transport, LocalTransport):
2930
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2931
transport = a_bzrdir.get_workingtree_transport(self)
2932
control_files = self._open_control_files(a_bzrdir)
2933
control_files.create_lock()
2934
control_files.lock_write()
2935
transport.put_bytes('format', self.get_format_string(),
2936
mode=a_bzrdir._get_file_mode())
2937
if from_branch is not None:
2938
branch = from_branch
2940
branch = a_bzrdir.open_branch()
2941
if revision_id is None:
2942
revision_id = _mod_revision.ensure_null(branch.last_revision())
2943
# WorkingTree3 can handle an inventory which has a unique root id.
2944
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2945
# those trees. And because there isn't a format bump inbetween, we
2946
# are maintaining compatibility with older clients.
2947
# inv = Inventory(root_id=gen_root_id())
2948
inv = self._initial_inventory()
2949
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2955
_control_files=control_files)
2956
wt.lock_tree_write()
2958
basis_tree = branch.repository.revision_tree(revision_id)
2959
# only set an explicit root id if there is one to set.
2960
if basis_tree.inventory.root is not None:
2961
wt.set_root_id(basis_tree.get_root_id())
2962
if revision_id == _mod_revision.NULL_REVISION:
2963
wt.set_parent_trees([])
2965
wt.set_parent_trees([(revision_id, basis_tree)])
2966
transform.build_tree(basis_tree, wt)
2968
# Unlock in this order so that the unlock-triggers-flush in
2969
# WorkingTree is given a chance to fire.
2970
control_files.unlock()
2974
def _initial_inventory(self):
2975
return inventory.Inventory()
2978
super(WorkingTreeFormat3, self).__init__()
2980
def open(self, a_bzrdir, _found=False):
2981
"""Return the WorkingTree object for a_bzrdir
2983
_found is a private parameter, do not use it. It is used to indicate
2984
if format probing has already been done.
2987
# we are being called directly and must probe.
2988
raise NotImplementedError
2989
if not isinstance(a_bzrdir.transport, LocalTransport):
2990
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2991
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2994
def _open(self, a_bzrdir, control_files):
2995
"""Open the tree itself.
2997
:param a_bzrdir: the dir for the tree.
2998
:param control_files: the control files for the tree.
3000
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3004
_control_files=control_files)
3007
return self.get_format_string()
3010
__default_format = WorkingTreeFormat4()
3011
WorkingTreeFormat.register_format(__default_format)
3012
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3013
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3014
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3015
WorkingTreeFormat.set_default_format(__default_format)
3016
# formats which have no format string are not discoverable
3017
# and not independently creatable, so are not registered.
3018
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
