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 _get_check_refs(self):
285
"""Return the references needed to perform a check of this tree.
287
The default implementation returns no refs, and is only suitable for
288
trees that have no local caching and can commit on ghosts at any time.
290
:seealso: bzrlib.check for details about check_refs.
294
def requires_rich_root(self):
295
return self._format.requires_rich_root
297
def supports_tree_reference(self):
300
def supports_content_filtering(self):
301
return self._format.supports_content_filtering()
303
def supports_views(self):
304
return self.views.supports_views()
306
def _set_inventory(self, inv, dirty):
307
"""Set the internal cached inventory.
309
:param inv: The inventory to set.
310
:param dirty: A boolean indicating whether the inventory is the same
311
logical inventory as whats on disk. If True the inventory is not
312
the same and should be written to disk or data will be lost, if
313
False then the inventory is the same as that on disk and any
314
serialisation would be unneeded overhead.
316
self._inventory = inv
317
self._inventory_is_modified = dirty
320
def open(path=None, _unsupported=False):
321
"""Open an existing working tree at path.
325
path = osutils.getcwd()
326
control = bzrdir.BzrDir.open(path, _unsupported)
327
return control.open_workingtree(_unsupported)
330
def open_containing(path=None):
331
"""Open an existing working tree which has its root about path.
333
This probes for a working tree at path and searches upwards from there.
335
Basically we keep looking up until we find the control directory or
336
run into /. If there isn't one, raises NotBranchError.
337
TODO: give this a new exception.
338
If there is one, it is returned, along with the unused portion of path.
340
:return: The WorkingTree that contains 'path', and the rest of path
343
path = osutils.getcwd()
344
control, relpath = bzrdir.BzrDir.open_containing(path)
346
return control.open_workingtree(), relpath
349
def open_downlevel(path=None):
350
"""Open an unsupported working tree.
352
Only intended for advanced situations like upgrading part of a bzrdir.
354
return WorkingTree.open(path, _unsupported=True)
357
def find_trees(location):
358
def list_current(transport):
359
return [d for d in transport.list_dir('') if d != '.bzr']
360
def evaluate(bzrdir):
362
tree = bzrdir.open_workingtree()
363
except errors.NoWorkingTree:
367
transport = get_transport(location)
368
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
369
list_current=list_current)
370
return [t for t in iterator if t is not None]
372
# should be deprecated - this is slow and in any case treating them as a
373
# container is (we now know) bad style -- mbp 20070302
374
## @deprecated_method(zero_fifteen)
376
"""Iterate through file_ids for this tree.
378
file_ids are in a WorkingTree if they are in the working inventory
379
and the working file exists.
381
inv = self._inventory
382
for path, ie in inv.iter_entries():
383
if osutils.lexists(self.abspath(path)):
386
def all_file_ids(self):
387
"""See Tree.iter_all_file_ids"""
388
return set(self.inventory)
391
return "<%s of %s>" % (self.__class__.__name__,
392
getattr(self, 'basedir', None))
394
def abspath(self, filename):
395
return pathjoin(self.basedir, filename)
397
def basis_tree(self):
398
"""Return RevisionTree for the current last revision.
400
If the left most parent is a ghost then the returned tree will be an
401
empty tree - one obtained by calling
402
repository.revision_tree(NULL_REVISION).
405
revision_id = self.get_parent_ids()[0]
407
# no parents, return an empty revision tree.
408
# in the future this should return the tree for
409
# 'empty:' - the implicit root empty tree.
410
return self.branch.repository.revision_tree(
411
_mod_revision.NULL_REVISION)
413
return self.revision_tree(revision_id)
414
except errors.NoSuchRevision:
416
# No cached copy available, retrieve from the repository.
417
# FIXME? RBC 20060403 should we cache the inventory locally
420
return self.branch.repository.revision_tree(revision_id)
421
except (errors.RevisionNotPresent, errors.NoSuchRevision):
422
# the basis tree *may* be a ghost or a low level error may have
423
# occurred. If the revision is present, its a problem, if its not
425
if self.branch.repository.has_revision(revision_id):
427
# the basis tree is a ghost so return an empty tree.
428
return self.branch.repository.revision_tree(
429
_mod_revision.NULL_REVISION)
432
self._flush_ignore_list_cache()
434
def relpath(self, path):
435
"""Return the local path portion from a given path.
437
The path may be absolute or relative. If its a relative path it is
438
interpreted relative to the python current working directory.
440
return osutils.relpath(self.basedir, path)
442
def has_filename(self, filename):
443
return osutils.lexists(self.abspath(filename))
445
def get_file(self, file_id, path=None, filtered=True):
446
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
448
def get_file_with_stat(self, file_id, path=None, filtered=True,
450
"""See Tree.get_file_with_stat."""
452
path = self.id2path(file_id)
453
file_obj = self.get_file_byname(path, filtered=False)
454
stat_value = _fstat(file_obj.fileno())
455
if filtered and self.supports_content_filtering():
456
filters = self._content_filter_stack(path)
457
file_obj = filtered_input_file(file_obj, filters)
458
return (file_obj, stat_value)
460
def get_file_text(self, file_id, path=None, filtered=True):
461
return self.get_file(file_id, path=path, filtered=filtered).read()
463
def get_file_byname(self, filename, filtered=True):
464
path = self.abspath(filename)
466
if filtered and self.supports_content_filtering():
467
filters = self._content_filter_stack(filename)
468
return filtered_input_file(f, filters)
472
def get_file_lines(self, file_id, path=None, filtered=True):
473
"""See Tree.get_file_lines()"""
474
file = self.get_file(file_id, path, filtered=filtered)
476
return file.readlines()
481
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
482
"""See Tree.annotate_iter
484
This implementation will use the basis tree implementation if possible.
485
Lines not in the basis are attributed to CURRENT_REVISION
487
If there are pending merges, lines added by those merges will be
488
incorrectly attributed to CURRENT_REVISION (but after committing, the
489
attribution will be correct).
491
maybe_file_parent_keys = []
492
for parent_id in self.get_parent_ids():
494
parent_tree = self.revision_tree(parent_id)
495
except errors.NoSuchRevisionInTree:
496
parent_tree = self.branch.repository.revision_tree(parent_id)
497
parent_tree.lock_read()
499
if file_id not in parent_tree:
501
ie = parent_tree.inventory[file_id]
502
if ie.kind != 'file':
503
# Note: this is slightly unnecessary, because symlinks and
504
# directories have a "text" which is the empty text, and we
505
# know that won't mess up annotations. But it seems cleaner
507
parent_text_key = (file_id, ie.revision)
508
if parent_text_key not in maybe_file_parent_keys:
509
maybe_file_parent_keys.append(parent_text_key)
512
graph = _mod_graph.Graph(self.branch.repository.texts)
513
heads = graph.heads(maybe_file_parent_keys)
514
file_parent_keys = []
515
for key in maybe_file_parent_keys:
517
file_parent_keys.append(key)
519
# Now we have the parents of this content
520
annotator = self.branch.repository.texts.get_annotator()
521
text = self.get_file(file_id).read()
522
this_key =(file_id, default_revision)
523
annotator.add_special_text(this_key, file_parent_keys, text)
524
annotations = [(key[-1], line)
525
for key, line in annotator.annotate_flat(this_key)]
528
def _get_ancestors(self, default_revision):
529
ancestors = set([default_revision])
530
for parent_id in self.get_parent_ids():
531
ancestors.update(self.branch.repository.get_ancestry(
532
parent_id, topo_sorted=False))
535
def get_parent_ids(self):
536
"""See Tree.get_parent_ids.
538
This implementation reads the pending merges list and last_revision
539
value and uses that to decide what the parents list should be.
541
last_rev = _mod_revision.ensure_null(self._last_revision())
542
if _mod_revision.NULL_REVISION == last_rev:
547
merges_file = self._transport.get('pending-merges')
548
except errors.NoSuchFile:
551
for l in merges_file.readlines():
552
revision_id = l.rstrip('\n')
553
parents.append(revision_id)
557
def get_root_id(self):
558
"""Return the id of this trees root"""
559
return self._inventory.root.file_id
561
def _get_store_filename(self, file_id):
562
## XXX: badly named; this is not in the store at all
563
return self.abspath(self.id2path(file_id))
566
def clone(self, to_bzrdir, revision_id=None):
567
"""Duplicate this working tree into to_bzr, including all state.
569
Specifically modified files are kept as modified, but
570
ignored and unknown files are discarded.
572
If you want to make a new line of development, see bzrdir.sprout()
575
If not None, the cloned tree will have its last revision set to
576
revision, and difference between the source trees last revision
577
and this one merged in.
579
# assumes the target bzr dir format is compatible.
580
result = to_bzrdir.create_workingtree()
581
self.copy_content_into(result, revision_id)
585
def copy_content_into(self, tree, revision_id=None):
586
"""Copy the current content and user files of this tree into tree."""
587
tree.set_root_id(self.get_root_id())
588
if revision_id is None:
589
merge.transform_tree(tree, self)
591
# TODO now merge from tree.last_revision to revision (to preserve
592
# user local changes)
593
merge.transform_tree(tree, self)
594
tree.set_parent_ids([revision_id])
596
def id2abspath(self, file_id):
597
return self.abspath(self.id2path(file_id))
599
def has_id(self, file_id):
600
# files that have been deleted are excluded
602
if not inv.has_id(file_id):
604
path = inv.id2path(file_id)
605
return osutils.lexists(self.abspath(path))
607
def has_or_had_id(self, file_id):
608
if file_id == self.inventory.root.file_id:
610
return self.inventory.has_id(file_id)
612
__contains__ = has_id
614
def get_file_size(self, file_id):
615
"""See Tree.get_file_size"""
616
# XXX: this returns the on-disk size; it should probably return the
619
return os.path.getsize(self.id2abspath(file_id))
621
if e.errno != errno.ENOENT:
627
def get_file_sha1(self, file_id, path=None, stat_value=None):
629
path = self._inventory.id2path(file_id)
630
return self._hashcache.get_sha1(path, stat_value)
632
def get_file_mtime(self, file_id, path=None):
634
path = self.inventory.id2path(file_id)
635
return os.lstat(self.abspath(path)).st_mtime
637
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
638
file_id = self.path2id(path)
639
return self._inventory[file_id].executable
641
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
642
mode = stat_result.st_mode
643
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
645
if not supports_executable():
646
def is_executable(self, file_id, path=None):
647
return self._inventory[file_id].executable
649
_is_executable_from_path_and_stat = \
650
_is_executable_from_path_and_stat_from_basis
652
def is_executable(self, file_id, path=None):
654
path = self.id2path(file_id)
655
mode = os.lstat(self.abspath(path)).st_mode
656
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_stat
661
@needs_tree_write_lock
662
def _add(self, files, ids, kinds):
663
"""See MutableTree._add."""
664
# TODO: Re-adding a file that is removed in the working copy
665
# should probably put it back with the previous ID.
666
# the read and write working inventory should not occur in this
667
# function - they should be part of lock_write and unlock.
669
for f, file_id, kind in zip(files, ids, kinds):
671
inv.add_path(f, kind=kind)
673
inv.add_path(f, kind=kind, file_id=file_id)
674
self._inventory_is_modified = True
676
@needs_tree_write_lock
677
def _gather_kinds(self, files, kinds):
678
"""See MutableTree._gather_kinds."""
679
for pos, f in enumerate(files):
680
if kinds[pos] is None:
681
fullpath = normpath(self.abspath(f))
683
kinds[pos] = file_kind(fullpath)
685
if e.errno == errno.ENOENT:
686
raise errors.NoSuchFile(fullpath)
689
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
690
"""Add revision_id as a parent.
692
This is equivalent to retrieving the current list of parent ids
693
and setting the list to its value plus revision_id.
695
:param revision_id: The revision id to add to the parent list. It may
696
be a ghost revision as long as its not the first parent to be added,
697
or the allow_leftmost_as_ghost parameter is set True.
698
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
700
parents = self.get_parent_ids() + [revision_id]
701
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
702
or allow_leftmost_as_ghost)
704
@needs_tree_write_lock
705
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
706
"""Add revision_id, tree tuple as a parent.
708
This is equivalent to retrieving the current list of parent trees
709
and setting the list to its value plus parent_tuple. See also
710
add_parent_tree_id - if you only have a parent id available it will be
711
simpler to use that api. If you have the parent already available, using
712
this api is preferred.
714
:param parent_tuple: The (revision id, tree) to add to the parent list.
715
If the revision_id is a ghost, pass None for the tree.
716
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
718
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
719
if len(parent_ids) > 1:
720
# the leftmost may have already been a ghost, preserve that if it
722
allow_leftmost_as_ghost = True
723
self.set_parent_ids(parent_ids,
724
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
726
@needs_tree_write_lock
727
def add_pending_merge(self, *revision_ids):
728
# TODO: Perhaps should check at this point that the
729
# history of the revision is actually present?
730
parents = self.get_parent_ids()
732
for rev_id in revision_ids:
733
if rev_id in parents:
735
parents.append(rev_id)
738
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
740
def path_content_summary(self, path, _lstat=os.lstat,
741
_mapper=osutils.file_kind_from_stat_mode):
742
"""See Tree.path_content_summary."""
743
abspath = self.abspath(path)
745
stat_result = _lstat(abspath)
747
if getattr(e, 'errno', None) == errno.ENOENT:
749
return ('missing', None, None, None)
750
# propagate other errors
752
kind = _mapper(stat_result.st_mode)
754
return self._file_content_summary(path, stat_result)
755
elif kind == 'directory':
756
# perhaps it looks like a plain directory, but it's really a
758
if self._directory_is_tree_reference(path):
759
kind = 'tree-reference'
760
return kind, None, None, None
761
elif kind == 'symlink':
762
target = osutils.readlink(abspath)
763
return ('symlink', None, None, target)
765
return (kind, None, None, None)
767
def _file_content_summary(self, path, stat_result):
768
size = stat_result.st_size
769
executable = self._is_executable_from_path_and_stat(path, stat_result)
770
# try for a stat cache lookup
771
return ('file', size, executable, self._sha_from_stat(
774
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
775
"""Common ghost checking functionality from set_parent_*.
777
This checks that the left hand-parent exists if there are any
780
if len(revision_ids) > 0:
781
leftmost_id = revision_ids[0]
782
if (not allow_leftmost_as_ghost and not
783
self.branch.repository.has_revision(leftmost_id)):
784
raise errors.GhostRevisionUnusableHere(leftmost_id)
786
def _set_merges_from_parent_ids(self, parent_ids):
787
merges = parent_ids[1:]
788
self._transport.put_bytes('pending-merges', '\n'.join(merges),
789
mode=self.bzrdir._get_file_mode())
791
def _filter_parent_ids_by_ancestry(self, revision_ids):
792
"""Check that all merged revisions are proper 'heads'.
794
This will always return the first revision_id, and any merged revisions
797
if len(revision_ids) == 0:
799
graph = self.branch.repository.get_graph()
800
heads = graph.heads(revision_ids)
801
new_revision_ids = revision_ids[:1]
802
for revision_id in revision_ids[1:]:
803
if revision_id in heads and revision_id not in new_revision_ids:
804
new_revision_ids.append(revision_id)
805
if new_revision_ids != revision_ids:
806
trace.mutter('requested to set revision_ids = %s,'
807
' but filtered to %s', revision_ids, new_revision_ids)
808
return new_revision_ids
810
@needs_tree_write_lock
811
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
812
"""Set the parent ids to revision_ids.
814
See also set_parent_trees. This api will try to retrieve the tree data
815
for each element of revision_ids from the trees repository. If you have
816
tree data already available, it is more efficient to use
817
set_parent_trees rather than set_parent_ids. set_parent_ids is however
818
an easier API to use.
820
:param revision_ids: The revision_ids to set as the parent ids of this
821
working tree. Any of these may be ghosts.
823
self._check_parents_for_ghosts(revision_ids,
824
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
825
for revision_id in revision_ids:
826
_mod_revision.check_not_reserved_id(revision_id)
828
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
830
if len(revision_ids) > 0:
831
self.set_last_revision(revision_ids[0])
833
self.set_last_revision(_mod_revision.NULL_REVISION)
835
self._set_merges_from_parent_ids(revision_ids)
837
@needs_tree_write_lock
838
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
839
"""See MutableTree.set_parent_trees."""
840
parent_ids = [rev for (rev, tree) in parents_list]
841
for revision_id in parent_ids:
842
_mod_revision.check_not_reserved_id(revision_id)
844
self._check_parents_for_ghosts(parent_ids,
845
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
847
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
849
if len(parent_ids) == 0:
850
leftmost_parent_id = _mod_revision.NULL_REVISION
851
leftmost_parent_tree = None
853
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
855
if self._change_last_revision(leftmost_parent_id):
856
if leftmost_parent_tree is None:
857
# If we don't have a tree, fall back to reading the
858
# parent tree from the repository.
859
self._cache_basis_inventory(leftmost_parent_id)
861
inv = leftmost_parent_tree.inventory
862
xml = self._create_basis_xml_from_inventory(
863
leftmost_parent_id, inv)
864
self._write_basis_inventory(xml)
865
self._set_merges_from_parent_ids(parent_ids)
867
@needs_tree_write_lock
868
def set_pending_merges(self, rev_list):
869
parents = self.get_parent_ids()
870
leftmost = parents[:1]
871
new_parents = leftmost + rev_list
872
self.set_parent_ids(new_parents)
874
@needs_tree_write_lock
875
def set_merge_modified(self, modified_hashes):
877
for file_id, hash in modified_hashes.iteritems():
878
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
879
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
881
def _sha_from_stat(self, path, stat_result):
882
"""Get a sha digest from the tree's stat cache.
884
The default implementation assumes no stat cache is present.
886
:param path: The path.
887
:param stat_result: The stat result being looked up.
891
def _put_rio(self, filename, stanzas, header):
892
self._must_be_locked()
893
my_file = rio_file(stanzas, header)
894
self._transport.put_file(filename, my_file,
895
mode=self.bzrdir._get_file_mode())
897
@needs_write_lock # because merge pulls data into the branch.
898
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
900
"""Merge from a branch into this working tree.
902
:param branch: The branch to merge from.
903
:param to_revision: If non-None, the merge will merge to to_revision,
904
but not beyond it. to_revision does not need to be in the history
905
of the branch when it is supplied. If None, to_revision defaults to
906
branch.last_revision().
908
from bzrlib.merge import Merger, Merge3Merger
909
pb = ui.ui_factory.nested_progress_bar()
911
merger = Merger(self.branch, this_tree=self, pb=pb)
912
merger.pp = ProgressPhase("Merge phase", 5, pb)
913
merger.pp.next_phase()
914
# check that there are no
916
merger.check_basis(check_clean=True, require_commits=False)
917
if to_revision is None:
918
to_revision = _mod_revision.ensure_null(branch.last_revision())
919
merger.other_rev_id = to_revision
920
if _mod_revision.is_null(merger.other_rev_id):
921
raise errors.NoCommits(branch)
922
self.branch.fetch(branch, last_revision=merger.other_rev_id)
923
merger.other_basis = merger.other_rev_id
924
merger.other_tree = self.branch.repository.revision_tree(
926
merger.other_branch = branch
927
merger.pp.next_phase()
928
if from_revision is None:
931
merger.set_base_revision(from_revision, branch)
932
if merger.base_rev_id == merger.other_rev_id:
933
raise errors.PointlessMerge
934
merger.backup_files = False
935
if merge_type is None:
936
merger.merge_type = Merge3Merger
938
merger.merge_type = merge_type
939
merger.set_interesting_files(None)
940
merger.show_base = False
941
merger.reprocess = False
942
conflicts = merger.do_merge()
949
def merge_modified(self):
950
"""Return a dictionary of files modified by a merge.
952
The list is initialized by WorkingTree.set_merge_modified, which is
953
typically called after we make some automatic updates to the tree
956
This returns a map of file_id->sha1, containing only files which are
957
still in the working inventory and have that text hash.
960
hashfile = self._transport.get('merge-hashes')
961
except errors.NoSuchFile:
966
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
967
raise errors.MergeModifiedFormatError()
968
except StopIteration:
969
raise errors.MergeModifiedFormatError()
970
for s in RioReader(hashfile):
971
# RioReader reads in Unicode, so convert file_ids back to utf8
972
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
973
if file_id not in self.inventory:
975
text_hash = s.get("hash")
976
if text_hash == self.get_file_sha1(file_id):
977
merge_hashes[file_id] = text_hash
983
def mkdir(self, path, file_id=None):
984
"""See MutableTree.mkdir()."""
986
file_id = generate_ids.gen_file_id(os.path.basename(path))
987
os.mkdir(self.abspath(path))
988
self.add(path, file_id, 'directory')
991
def get_symlink_target(self, file_id):
992
abspath = self.id2abspath(file_id)
993
target = osutils.readlink(abspath)
997
def subsume(self, other_tree):
998
def add_children(inventory, entry):
999
for child_entry in entry.children.values():
1000
inventory._byid[child_entry.file_id] = child_entry
1001
if child_entry.kind == 'directory':
1002
add_children(inventory, child_entry)
1003
if other_tree.get_root_id() == self.get_root_id():
1004
raise errors.BadSubsumeSource(self, other_tree,
1005
'Trees have the same root')
1007
other_tree_path = self.relpath(other_tree.basedir)
1008
except errors.PathNotChild:
1009
raise errors.BadSubsumeSource(self, other_tree,
1010
'Tree is not contained by the other')
1011
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1012
if new_root_parent is None:
1013
raise errors.BadSubsumeSource(self, other_tree,
1014
'Parent directory is not versioned.')
1015
# We need to ensure that the result of a fetch will have a
1016
# versionedfile for the other_tree root, and only fetching into
1017
# RepositoryKnit2 guarantees that.
1018
if not self.branch.repository.supports_rich_root():
1019
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1020
other_tree.lock_tree_write()
1022
new_parents = other_tree.get_parent_ids()
1023
other_root = other_tree.inventory.root
1024
other_root.parent_id = new_root_parent
1025
other_root.name = osutils.basename(other_tree_path)
1026
self.inventory.add(other_root)
1027
add_children(self.inventory, other_root)
1028
self._write_inventory(self.inventory)
1029
# normally we don't want to fetch whole repositories, but i think
1030
# here we really do want to consolidate the whole thing.
1031
for parent_id in other_tree.get_parent_ids():
1032
self.branch.fetch(other_tree.branch, parent_id)
1033
self.add_parent_tree_id(parent_id)
1036
other_tree.bzrdir.retire_bzrdir()
1038
def _setup_directory_is_tree_reference(self):
1039
if self._branch.repository._format.supports_tree_reference:
1040
self._directory_is_tree_reference = \
1041
self._directory_may_be_tree_reference
1043
self._directory_is_tree_reference = \
1044
self._directory_is_never_tree_reference
1046
def _directory_is_never_tree_reference(self, relpath):
1049
def _directory_may_be_tree_reference(self, relpath):
1050
# as a special case, if a directory contains control files then
1051
# it's a tree reference, except that the root of the tree is not
1052
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1053
# TODO: We could ask all the control formats whether they
1054
# recognize this directory, but at the moment there's no cheap api
1055
# to do that. Since we probably can only nest bzr checkouts and
1056
# they always use this name it's ok for now. -- mbp 20060306
1058
# FIXME: There is an unhandled case here of a subdirectory
1059
# containing .bzr but not a branch; that will probably blow up
1060
# when you try to commit it. It might happen if there is a
1061
# checkout in a subdirectory. This can be avoided by not adding
1064
@needs_tree_write_lock
1065
def extract(self, file_id, format=None):
1066
"""Extract a subtree from this tree.
1068
A new branch will be created, relative to the path for this tree.
1072
segments = osutils.splitpath(path)
1073
transport = self.branch.bzrdir.root_transport
1074
for name in segments:
1075
transport = transport.clone(name)
1076
transport.ensure_base()
1079
sub_path = self.id2path(file_id)
1080
branch_transport = mkdirs(sub_path)
1082
format = self.bzrdir.cloning_metadir()
1083
branch_transport.ensure_base()
1084
branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
repo = branch_bzrdir.find_repository()
1087
except errors.NoRepositoryPresent:
1088
repo = branch_bzrdir.create_repository()
1089
if not repo.supports_rich_root():
1090
raise errors.RootNotRich()
1091
new_branch = branch_bzrdir.create_branch()
1092
new_branch.pull(self.branch)
1093
for parent_id in self.get_parent_ids():
1094
new_branch.fetch(self.branch, parent_id)
1095
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1096
if tree_transport.base != branch_transport.base:
1097
tree_bzrdir = format.initialize_on_transport(tree_transport)
1098
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1100
tree_bzrdir = branch_bzrdir
1101
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1102
wt.set_parent_ids(self.get_parent_ids())
1103
my_inv = self.inventory
1104
child_inv = inventory.Inventory(root_id=None)
1105
new_root = my_inv[file_id]
1106
my_inv.remove_recursive_id(file_id)
1107
new_root.parent_id = None
1108
child_inv.add(new_root)
1109
self._write_inventory(my_inv)
1110
wt._write_inventory(child_inv)
1113
def _serialize(self, inventory, out_file):
1114
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
def _deserialize(selt, in_file):
1118
return xml5.serializer_v5.read_inventory(in_file)
1121
"""Write the in memory inventory to disk."""
1122
# TODO: Maybe this should only write on dirty ?
1123
if self._control_files._lock_mode != 'w':
1124
raise errors.NotWriteLocked(self)
1126
self._serialize(self._inventory, sio)
1128
self._transport.put_file('inventory', sio,
1129
mode=self.bzrdir._get_file_mode())
1130
self._inventory_is_modified = False
1132
def _kind(self, relpath):
1133
return osutils.file_kind(self.abspath(relpath))
1135
def list_files(self, include_root=False, from_dir=None, recursive=True):
1136
"""List all files as (path, class, kind, id, entry).
1138
Lists, but does not descend into unversioned directories.
1139
This does not include files that have been deleted in this
1140
tree. Skips the control directory.
1142
:param include_root: if True, do not return an entry for the root
1143
:param from_dir: start from this directory or None for the root
1144
:param recursive: whether to recurse into subdirectories or not
1146
# list_files is an iterator, so @needs_read_lock doesn't work properly
1147
# with it. So callers should be careful to always read_lock the tree.
1148
if not self.is_locked():
1149
raise errors.ObjectNotLocked(self)
1151
inv = self.inventory
1152
if from_dir is None and include_root is True:
1153
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1154
# Convert these into local objects to save lookup times
1155
pathjoin = osutils.pathjoin
1156
file_kind = self._kind
1158
# transport.base ends in a slash, we want the piece
1159
# between the last two slashes
1160
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1162
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1164
# directory file_id, relative path, absolute path, reverse sorted children
1165
if from_dir is not None:
1166
from_dir_id = inv.path2id(from_dir)
1167
if from_dir_id is None:
1168
# Directory not versioned
1170
from_dir_abspath = pathjoin(self.basedir, from_dir)
1172
from_dir_id = inv.root.file_id
1173
from_dir_abspath = self.basedir
1174
children = os.listdir(from_dir_abspath)
1176
# jam 20060527 The kernel sized tree seems equivalent whether we
1177
# use a deque and popleft to keep them sorted, or if we use a plain
1178
# list and just reverse() them.
1179
children = collections.deque(children)
1180
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1182
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
f = children.popleft()
1186
## TODO: If we find a subdirectory with its own .bzr
1187
## directory, then that is a separate tree and we
1188
## should exclude it.
1190
# the bzrdir for this tree
1191
if transport_base_dir == f:
1194
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1195
# and 'f' doesn't begin with one, we can do a string op, rather
1196
# than the checks of pathjoin(), all relative paths will have an extra slash
1198
fp = from_dir_relpath + '/' + f
1201
fap = from_dir_abspath + '/' + f
1203
f_ie = inv.get_child(from_dir_id, f)
1206
elif self.is_ignored(fp[1:]):
1209
# we may not have found this file, because of a unicode issue
1210
f_norm, can_access = osutils.normalized_filename(f)
1211
if f == f_norm or not can_access:
1212
# No change, so treat this file normally
1215
# this file can be accessed by a normalized path
1216
# check again if it is versioned
1217
# these lines are repeated here for performance
1219
fp = from_dir_relpath + '/' + f
1220
fap = from_dir_abspath + '/' + f
1221
f_ie = inv.get_child(from_dir_id, f)
1224
elif self.is_ignored(fp[1:]):
1231
# make a last minute entry
1233
yield fp[1:], c, fk, f_ie.file_id, f_ie
1236
yield fp[1:], c, fk, None, fk_entries[fk]()
1238
yield fp[1:], c, fk, None, TreeEntry()
1241
if fk != 'directory':
1244
# But do this child first if recursing down
1246
new_children = os.listdir(fap)
1248
new_children = collections.deque(new_children)
1249
stack.append((f_ie.file_id, fp, fap, new_children))
1250
# Break out of inner loop,
1251
# so that we start outer loop with child
1254
# if we finished all children, pop it off the stack
1257
@needs_tree_write_lock
1258
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1261
to_dir must exist in the inventory.
1263
If to_dir exists and is a directory, the files are moved into
1264
it, keeping their old names.
1266
Note that to_dir is only the last component of the new name;
1267
this doesn't change the directory.
1269
For each entry in from_paths the move mode will be determined
1272
The first mode moves the file in the filesystem and updates the
1273
inventory. The second mode only updates the inventory without
1274
touching the file on the filesystem. This is the new mode introduced
1277
move uses the second mode if 'after == True' and the target is not
1278
versioned but present in the working tree.
1280
move uses the second mode if 'after == False' and the source is
1281
versioned but no longer in the working tree, and the target is not
1282
versioned but present in the working tree.
1284
move uses the first mode if 'after == False' and the source is
1285
versioned and present in the working tree, and the target is not
1286
versioned and not present in the working tree.
1288
Everything else results in an error.
1290
This returns a list of (from_path, to_path) pairs for each
1291
entry that is moved.
1296
# check for deprecated use of signature
1298
to_dir = kwargs.get('to_name', None)
1300
raise TypeError('You must supply a target directory')
1302
symbol_versioning.warn('The parameter to_name was deprecated'
1303
' in version 0.13. Use to_dir instead',
1306
# check destination directory
1307
if isinstance(from_paths, basestring):
1309
inv = self.inventory
1310
to_abs = self.abspath(to_dir)
1311
if not isdir(to_abs):
1312
raise errors.BzrMoveFailedError('',to_dir,
1313
errors.NotADirectory(to_abs))
1314
if not self.has_filename(to_dir):
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotInWorkingDirectory(to_dir))
1317
to_dir_id = inv.path2id(to_dir)
1318
if to_dir_id is None:
1319
raise errors.BzrMoveFailedError('',to_dir,
1320
errors.NotVersionedError(path=str(to_dir)))
1322
to_dir_ie = inv[to_dir_id]
1323
if to_dir_ie.kind != 'directory':
1324
raise errors.BzrMoveFailedError('',to_dir,
1325
errors.NotADirectory(to_abs))
1327
# create rename entries and tuples
1328
for from_rel in from_paths:
1329
from_tail = splitpath(from_rel)[-1]
1330
from_id = inv.path2id(from_rel)
1332
raise errors.BzrMoveFailedError(from_rel,to_dir,
1333
errors.NotVersionedError(path=str(from_rel)))
1335
from_entry = inv[from_id]
1336
from_parent_id = from_entry.parent_id
1337
to_rel = pathjoin(to_dir, from_tail)
1338
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1340
from_tail=from_tail,
1341
from_parent_id=from_parent_id,
1342
to_rel=to_rel, to_tail=from_tail,
1343
to_parent_id=to_dir_id)
1344
rename_entries.append(rename_entry)
1345
rename_tuples.append((from_rel, to_rel))
1347
# determine which move mode to use. checks also for movability
1348
rename_entries = self._determine_mv_mode(rename_entries, after)
1350
original_modified = self._inventory_is_modified
1353
self._inventory_is_modified = True
1354
self._move(rename_entries)
1356
# restore the inventory on error
1357
self._inventory_is_modified = original_modified
1359
self._write_inventory(inv)
1360
return rename_tuples
1362
def _determine_mv_mode(self, rename_entries, after=False):
1363
"""Determines for each from-to pair if both inventory and working tree
1364
or only the inventory has to be changed.
1366
Also does basic plausability tests.
1368
inv = self.inventory
1370
for rename_entry in rename_entries:
1371
# store to local variables for easier reference
1372
from_rel = rename_entry.from_rel
1373
from_id = rename_entry.from_id
1374
to_rel = rename_entry.to_rel
1375
to_id = inv.path2id(to_rel)
1376
only_change_inv = False
1378
# check the inventory for source and destination
1380
raise errors.BzrMoveFailedError(from_rel,to_rel,
1381
errors.NotVersionedError(path=str(from_rel)))
1382
if to_id is not None:
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.AlreadyVersionedError(path=str(to_rel)))
1386
# try to determine the mode for rename (only change inv or change
1387
# inv and file system)
1389
if not self.has_filename(to_rel):
1390
raise errors.BzrMoveFailedError(from_id,to_rel,
1391
errors.NoSuchFile(path=str(to_rel),
1392
extra="New file has not been created yet"))
1393
only_change_inv = True
1394
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1395
only_change_inv = True
1396
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1397
only_change_inv = False
1398
elif (not self.case_sensitive
1399
and from_rel.lower() == to_rel.lower()
1400
and self.has_filename(from_rel)):
1401
only_change_inv = False
1403
# something is wrong, so lets determine what exactly
1404
if not self.has_filename(from_rel) and \
1405
not self.has_filename(to_rel):
1406
raise errors.BzrRenameFailedError(from_rel,to_rel,
1407
errors.PathsDoNotExist(paths=(str(from_rel),
1410
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1411
rename_entry.only_change_inv = only_change_inv
1412
return rename_entries
1414
def _move(self, rename_entries):
1415
"""Moves a list of files.
1417
Depending on the value of the flag 'only_change_inv', the
1418
file will be moved on the file system or not.
1420
inv = self.inventory
1423
for entry in rename_entries:
1425
self._move_entry(entry)
1427
self._rollback_move(moved)
1431
def _rollback_move(self, moved):
1432
"""Try to rollback a previous move in case of an filesystem error."""
1433
inv = self.inventory
1436
self._move_entry(WorkingTree._RenameEntry(
1437
entry.to_rel, entry.from_id,
1438
entry.to_tail, entry.to_parent_id, entry.from_rel,
1439
entry.from_tail, entry.from_parent_id,
1440
entry.only_change_inv))
1441
except errors.BzrMoveFailedError, e:
1442
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1443
" The working tree is in an inconsistent state."
1444
" Please consider doing a 'bzr revert'."
1445
" Error message is: %s" % e)
1447
def _move_entry(self, entry):
1448
inv = self.inventory
1449
from_rel_abs = self.abspath(entry.from_rel)
1450
to_rel_abs = self.abspath(entry.to_rel)
1451
if from_rel_abs == to_rel_abs:
1452
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1453
"Source and target are identical.")
1455
if not entry.only_change_inv:
1457
osutils.rename(from_rel_abs, to_rel_abs)
1459
raise errors.BzrMoveFailedError(entry.from_rel,
1461
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1463
@needs_tree_write_lock
1464
def rename_one(self, from_rel, to_rel, after=False):
1467
This can change the directory or the filename or both.
1469
rename_one has several 'modes' to work. First, it can rename a physical
1470
file and change the file_id. That is the normal mode. Second, it can
1471
only change the file_id without touching any physical file. This is
1472
the new mode introduced in version 0.15.
1474
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1475
versioned but present in the working tree.
1477
rename_one uses the second mode if 'after == False' and 'from_rel' is
1478
versioned but no longer in the working tree, and 'to_rel' is not
1479
versioned but present in the working tree.
1481
rename_one uses the first mode if 'after == False' and 'from_rel' is
1482
versioned and present in the working tree, and 'to_rel' is not
1483
versioned and not present in the working tree.
1485
Everything else results in an error.
1487
inv = self.inventory
1490
# create rename entries and tuples
1491
from_tail = splitpath(from_rel)[-1]
1492
from_id = inv.path2id(from_rel)
1494
# if file is missing in the inventory maybe it's in the basis_tree
1495
basis_tree = self.branch.basis_tree()
1496
from_id = basis_tree.path2id(from_rel)
1498
raise errors.BzrRenameFailedError(from_rel,to_rel,
1499
errors.NotVersionedError(path=str(from_rel)))
1500
# put entry back in the inventory so we can rename it
1501
from_entry = basis_tree.inventory[from_id].copy()
1504
from_entry = inv[from_id]
1505
from_parent_id = from_entry.parent_id
1506
to_dir, to_tail = os.path.split(to_rel)
1507
to_dir_id = inv.path2id(to_dir)
1508
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1510
from_tail=from_tail,
1511
from_parent_id=from_parent_id,
1512
to_rel=to_rel, to_tail=to_tail,
1513
to_parent_id=to_dir_id)
1514
rename_entries.append(rename_entry)
1516
# determine which move mode to use. checks also for movability
1517
rename_entries = self._determine_mv_mode(rename_entries, after)
1519
# check if the target changed directory and if the target directory is
1521
if to_dir_id is None:
1522
raise errors.BzrMoveFailedError(from_rel,to_rel,
1523
errors.NotVersionedError(path=str(to_dir)))
1525
# all checks done. now we can continue with our actual work
1526
mutter('rename_one:\n'
1531
' to_dir_id {%s}\n',
1532
from_id, from_rel, to_rel, to_dir, to_dir_id)
1534
self._move(rename_entries)
1535
self._write_inventory(inv)
1537
class _RenameEntry(object):
1538
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1539
to_rel, to_tail, to_parent_id, only_change_inv=False):
1540
self.from_rel = from_rel
1541
self.from_id = from_id
1542
self.from_tail = from_tail
1543
self.from_parent_id = from_parent_id
1544
self.to_rel = to_rel
1545
self.to_tail = to_tail
1546
self.to_parent_id = to_parent_id
1547
self.only_change_inv = only_change_inv
1551
"""Return all unknown files.
1553
These are files in the working directory that are not versioned or
1554
control files or ignored.
1556
# force the extras method to be fully executed before returning, to
1557
# prevent race conditions with the lock
1559
[subp for subp in self.extras() if not self.is_ignored(subp)])
1561
@needs_tree_write_lock
1562
def unversion(self, file_ids):
1563
"""Remove the file ids in file_ids from the current versioned set.
1565
When a file_id is unversioned, all of its children are automatically
1568
:param file_ids: The file ids to stop versioning.
1569
:raises: NoSuchId if any fileid is not currently versioned.
1571
for file_id in file_ids:
1572
if file_id not in self._inventory:
1573
raise errors.NoSuchId(self, file_id)
1574
for file_id in file_ids:
1575
if self._inventory.has_id(file_id):
1576
self._inventory.remove_recursive_id(file_id)
1578
# in the future this should just set a dirty bit to wait for the
1579
# final unlock. However, until all methods of workingtree start
1580
# with the current in -memory inventory rather than triggering
1581
# a read, it is more complex - we need to teach read_inventory
1582
# to know when to read, and when to not read first... and possibly
1583
# to save first when the in memory one may be corrupted.
1584
# so for now, we just only write it if it is indeed dirty.
1586
self._write_inventory(self._inventory)
1588
def _iter_conflicts(self):
1590
for info in self.list_files():
1592
stem = get_conflicted_stem(path)
1595
if stem not in conflicted:
1596
conflicted.add(stem)
1600
def pull(self, source, overwrite=False, stop_revision=None,
1601
change_reporter=None, possible_transports=None, local=False):
1602
top_pb = ui.ui_factory.nested_progress_bar()
1605
pp = ProgressPhase("Pull phase", 2, top_pb)
1607
old_revision_info = self.branch.last_revision_info()
1608
basis_tree = self.basis_tree()
1609
count = self.branch.pull(source, overwrite, stop_revision,
1610
possible_transports=possible_transports,
1612
new_revision_info = self.branch.last_revision_info()
1613
if new_revision_info != old_revision_info:
1615
repository = self.branch.repository
1616
pb = ui.ui_factory.nested_progress_bar()
1617
basis_tree.lock_read()
1619
new_basis_tree = self.branch.basis_tree()
1626
change_reporter=change_reporter)
1627
if (basis_tree.inventory.root is None and
1628
new_basis_tree.inventory.root is not None):
1629
self.set_root_id(new_basis_tree.get_root_id())
1633
# TODO - dedup parents list with things merged by pull ?
1634
# reuse the revisiontree we merged against to set the new
1636
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1637
# we have to pull the merge trees out again, because
1638
# merge_inner has set the ids. - this corner is not yet
1639
# layered well enough to prevent double handling.
1640
# XXX TODO: Fix the double handling: telling the tree about
1641
# the already known parent data is wasteful.
1642
merges = self.get_parent_ids()[1:]
1643
parent_trees.extend([
1644
(parent, repository.revision_tree(parent)) for
1646
self.set_parent_trees(parent_trees)
1653
def put_file_bytes_non_atomic(self, file_id, bytes):
1654
"""See MutableTree.put_file_bytes_non_atomic."""
1655
stream = file(self.id2abspath(file_id), 'wb')
1660
# TODO: update the hashcache here ?
1663
"""Yield all unversioned files in this WorkingTree.
1665
If there are any unversioned directories then only the directory is
1666
returned, not all its children. But if there are unversioned files
1667
under a versioned subdirectory, they are returned.
1669
Currently returned depth-first, sorted by name within directories.
1670
This is the same order used by 'osutils.walkdirs'.
1672
## TODO: Work from given directory downwards
1673
for path, dir_entry in self.inventory.directories():
1674
# mutter("search for unknowns in %r", path)
1675
dirabs = self.abspath(path)
1676
if not isdir(dirabs):
1677
# e.g. directory deleted
1681
for subf in os.listdir(dirabs):
1682
if self.bzrdir.is_control_filename(subf):
1684
if subf not in dir_entry.children:
1687
can_access) = osutils.normalized_filename(subf)
1688
except UnicodeDecodeError:
1689
path_os_enc = path.encode(osutils._fs_enc)
1690
relpath = path_os_enc + '/' + subf
1691
raise errors.BadFilenameEncoding(relpath,
1693
if subf_norm != subf and can_access:
1694
if subf_norm not in dir_entry.children:
1695
fl.append(subf_norm)
1701
subp = pathjoin(path, subf)
1704
def ignored_files(self):
1705
"""Yield list of PATH, IGNORE_PATTERN"""
1706
for subp in self.extras():
1707
pat = self.is_ignored(subp)
1711
def get_ignore_list(self):
1712
"""Return list of ignore patterns.
1714
Cached in the Tree object after the first call.
1716
ignoreset = getattr(self, '_ignoreset', None)
1717
if ignoreset is not None:
1720
ignore_globs = set()
1721
ignore_globs.update(ignores.get_runtime_ignores())
1722
ignore_globs.update(ignores.get_user_ignores())
1723
if self.has_filename(bzrlib.IGNORE_FILENAME):
1724
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1726
ignore_globs.update(ignores.parse_ignore_file(f))
1729
self._ignoreset = ignore_globs
1732
def _flush_ignore_list_cache(self):
1733
"""Resets the cached ignore list to force a cache rebuild."""
1734
self._ignoreset = None
1735
self._ignoreglobster = None
1737
def is_ignored(self, filename):
1738
r"""Check whether the filename matches an ignore pattern.
1740
Patterns containing '/' or '\' need to match the whole path;
1741
others match against only the last component.
1743
If the file is ignored, returns the pattern which caused it to
1744
be ignored, otherwise None. So this can simply be used as a
1745
boolean if desired."""
1746
if getattr(self, '_ignoreglobster', None) is None:
1747
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1748
return self._ignoreglobster.match(filename)
1750
def kind(self, file_id):
1751
return file_kind(self.id2abspath(file_id))
1753
def stored_kind(self, file_id):
1754
"""See Tree.stored_kind"""
1755
return self.inventory[file_id].kind
1757
def _comparison_data(self, entry, path):
1758
abspath = self.abspath(path)
1760
stat_value = os.lstat(abspath)
1762
if getattr(e, 'errno', None) == errno.ENOENT:
1769
mode = stat_value.st_mode
1770
kind = osutils.file_kind_from_stat_mode(mode)
1771
if not supports_executable():
1772
executable = entry is not None and entry.executable
1774
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1775
return kind, executable, stat_value
1777
def _file_size(self, entry, stat_value):
1778
return stat_value.st_size
1780
def last_revision(self):
1781
"""Return the last revision of the branch for this tree.
1783
This format tree does not support a separate marker for last-revision
1784
compared to the branch.
1786
See MutableTree.last_revision
1788
return self._last_revision()
1791
def _last_revision(self):
1792
"""helper for get_parent_ids."""
1793
return _mod_revision.ensure_null(self.branch.last_revision())
1795
def is_locked(self):
1796
return self._control_files.is_locked()
1798
def _must_be_locked(self):
1799
if not self.is_locked():
1800
raise errors.ObjectNotLocked(self)
1802
def lock_read(self):
1803
"""See Branch.lock_read, and WorkingTree.unlock."""
1804
if not self.is_locked():
1806
self.branch.lock_read()
1808
return self._control_files.lock_read()
1810
self.branch.unlock()
1813
def lock_tree_write(self):
1814
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1815
if not self.is_locked():
1817
self.branch.lock_read()
1819
return self._control_files.lock_write()
1821
self.branch.unlock()
1824
def lock_write(self):
1825
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1826
if not self.is_locked():
1828
self.branch.lock_write()
1830
return self._control_files.lock_write()
1832
self.branch.unlock()
1835
def get_physical_lock_status(self):
1836
return self._control_files.get_physical_lock_status()
1838
def _basis_inventory_name(self):
1839
return 'basis-inventory-cache'
1841
def _reset_data(self):
1842
"""Reset transient data that cannot be revalidated."""
1843
self._inventory_is_modified = False
1844
result = self._deserialize(self._transport.get('inventory'))
1845
self._set_inventory(result, dirty=False)
1847
@needs_tree_write_lock
1848
def set_last_revision(self, new_revision):
1849
"""Change the last revision in the working tree."""
1850
if self._change_last_revision(new_revision):
1851
self._cache_basis_inventory(new_revision)
1853
def _change_last_revision(self, new_revision):
1854
"""Template method part of set_last_revision to perform the change.
1856
This is used to allow WorkingTree3 instances to not affect branch
1857
when their last revision is set.
1859
if _mod_revision.is_null(new_revision):
1860
self.branch.set_revision_history([])
1863
self.branch.generate_revision_history(new_revision)
1864
except errors.NoSuchRevision:
1865
# not present in the repo - dont try to set it deeper than the tip
1866
self.branch.set_revision_history([new_revision])
1869
def _write_basis_inventory(self, xml):
1870
"""Write the basis inventory XML to the basis-inventory file"""
1871
path = self._basis_inventory_name()
1873
self._transport.put_file(path, sio,
1874
mode=self.bzrdir._get_file_mode())
1876
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1877
"""Create the text that will be saved in basis-inventory"""
1878
inventory.revision_id = revision_id
1879
return xml7.serializer_v7.write_inventory_to_string(inventory)
1881
def _cache_basis_inventory(self, new_revision):
1882
"""Cache new_revision as the basis inventory."""
1883
# TODO: this should allow the ready-to-use inventory to be passed in,
1884
# as commit already has that ready-to-use [while the format is the
1887
# this double handles the inventory - unpack and repack -
1888
# but is easier to understand. We can/should put a conditional
1889
# in here based on whether the inventory is in the latest format
1890
# - perhaps we should repack all inventories on a repository
1892
# the fast path is to copy the raw xml from the repository. If the
1893
# xml contains 'revision_id="', then we assume the right
1894
# revision_id is set. We must check for this full string, because a
1895
# root node id can legitimately look like 'revision_id' but cannot
1897
xml = self.branch.repository.get_inventory_xml(new_revision)
1898
firstline = xml.split('\n', 1)[0]
1899
if (not 'revision_id="' in firstline or
1900
'format="7"' not in firstline):
1901
inv = self.branch.repository._serializer.read_inventory_from_string(
1903
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1904
self._write_basis_inventory(xml)
1905
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1908
def read_basis_inventory(self):
1909
"""Read the cached basis inventory."""
1910
path = self._basis_inventory_name()
1911
return self._transport.get_bytes(path)
1914
def read_working_inventory(self):
1915
"""Read the working inventory.
1917
:raises errors.InventoryModified: read_working_inventory will fail
1918
when the current in memory inventory has been modified.
1920
# conceptually this should be an implementation detail of the tree.
1921
# XXX: Deprecate this.
1922
# ElementTree does its own conversion from UTF-8, so open in
1924
if self._inventory_is_modified:
1925
raise errors.InventoryModified(self)
1926
result = self._deserialize(self._transport.get('inventory'))
1927
self._set_inventory(result, dirty=False)
1930
@needs_tree_write_lock
1931
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1933
"""Remove nominated files from the working inventory.
1935
:files: File paths relative to the basedir.
1936
:keep_files: If true, the files will also be kept.
1937
:force: Delete files and directories, even if they are changed and
1938
even if the directories are not empty.
1940
if isinstance(files, basestring):
1946
unknown_nested_files=set()
1948
def recurse_directory_to_add_files(directory):
1949
# Recurse directory and add all files
1950
# so we can check if they have changed.
1951
for parent_info, file_infos in\
1952
self.walkdirs(directory):
1953
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1954
# Is it versioned or ignored?
1955
if self.path2id(relpath) or self.is_ignored(relpath):
1956
# Add nested content for deletion.
1957
new_files.add(relpath)
1959
# Files which are not versioned and not ignored
1960
# should be treated as unknown.
1961
unknown_nested_files.add((relpath, None, kind))
1963
for filename in files:
1964
# Get file name into canonical form.
1965
abspath = self.abspath(filename)
1966
filename = self.relpath(abspath)
1967
if len(filename) > 0:
1968
new_files.add(filename)
1969
recurse_directory_to_add_files(filename)
1971
files = list(new_files)
1974
return # nothing to do
1976
# Sort needed to first handle directory content before the directory
1977
files.sort(reverse=True)
1979
# Bail out if we are going to delete files we shouldn't
1980
if not keep_files and not force:
1981
has_changed_files = len(unknown_nested_files) > 0
1982
if not has_changed_files:
1983
for (file_id, path, content_change, versioned, parent_id, name,
1984
kind, executable) in self.iter_changes(self.basis_tree(),
1985
include_unchanged=True, require_versioned=False,
1986
want_unversioned=True, specific_files=files):
1987
if versioned == (False, False):
1988
# The record is unknown ...
1989
if not self.is_ignored(path[1]):
1990
# ... but not ignored
1991
has_changed_files = True
1993
elif content_change and (kind[1] is not None):
1994
# Versioned and changed, but not deleted
1995
has_changed_files = True
1998
if has_changed_files:
1999
# Make delta show ALL applicable changes in error message.
2000
tree_delta = self.changes_from(self.basis_tree(),
2001
require_versioned=False, want_unversioned=True,
2002
specific_files=files)
2003
for unknown_file in unknown_nested_files:
2004
if unknown_file not in tree_delta.unversioned:
2005
tree_delta.unversioned.extend((unknown_file,))
2006
raise errors.BzrRemoveChangedFilesError(tree_delta)
2008
# Build inv_delta and delete files where applicable,
2009
# do this before any modifications to inventory.
2011
fid = self.path2id(f)
2014
message = "%s is not versioned." % (f,)
2017
# having removed it, it must be either ignored or unknown
2018
if self.is_ignored(f):
2022
textui.show_status(new_status, self.kind(fid), f,
2025
inv_delta.append((f, None, fid, None))
2026
message = "removed %s" % (f,)
2029
abs_path = self.abspath(f)
2030
if osutils.lexists(abs_path):
2031
if (osutils.isdir(abs_path) and
2032
len(os.listdir(abs_path)) > 0):
2034
osutils.rmtree(abs_path)
2036
message = "%s is not an empty directory "\
2037
"and won't be deleted." % (f,)
2039
osutils.delete_any(abs_path)
2040
message = "deleted %s" % (f,)
2041
elif message is not None:
2042
# Only care if we haven't done anything yet.
2043
message = "%s does not exist." % (f,)
2045
# Print only one message (if any) per file.
2046
if message is not None:
2048
self.apply_inventory_delta(inv_delta)
2050
@needs_tree_write_lock
2051
def revert(self, filenames=None, old_tree=None, backups=True,
2052
pb=DummyProgress(), report_changes=False):
2053
from bzrlib.conflicts import resolve
2056
symbol_versioning.warn('Using [] to revert all files is deprecated'
2057
' as of bzr 0.91. Please use None (the default) instead.',
2058
DeprecationWarning, stacklevel=2)
2059
if old_tree is None:
2060
basis_tree = self.basis_tree()
2061
basis_tree.lock_read()
2062
old_tree = basis_tree
2066
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2068
if filenames is None and len(self.get_parent_ids()) > 1:
2070
last_revision = self.last_revision()
2071
if last_revision != _mod_revision.NULL_REVISION:
2072
if basis_tree is None:
2073
basis_tree = self.basis_tree()
2074
basis_tree.lock_read()
2075
parent_trees.append((last_revision, basis_tree))
2076
self.set_parent_trees(parent_trees)
2079
resolve(self, filenames, ignore_misses=True, recursive=True)
2081
if basis_tree is not None:
2085
def revision_tree(self, revision_id):
2086
"""See Tree.revision_tree.
2088
WorkingTree can supply revision_trees for the basis revision only
2089
because there is only one cached inventory in the bzr directory.
2091
if revision_id == self.last_revision():
2093
xml = self.read_basis_inventory()
2094
except errors.NoSuchFile:
2098
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2099
# dont use the repository revision_tree api because we want
2100
# to supply the inventory.
2101
if inv.revision_id == revision_id:
2102
return revisiontree.RevisionTree(self.branch.repository,
2104
except errors.BadInventoryFormat:
2106
# raise if there was no inventory, or if we read the wrong inventory.
2107
raise errors.NoSuchRevisionInTree(self, revision_id)
2109
# XXX: This method should be deprecated in favour of taking in a proper
2110
# new Inventory object.
2111
@needs_tree_write_lock
2112
def set_inventory(self, new_inventory_list):
2113
from bzrlib.inventory import (Inventory,
2117
inv = Inventory(self.get_root_id())
2118
for path, file_id, parent, kind in new_inventory_list:
2119
name = os.path.basename(path)
2122
# fixme, there should be a factory function inv,add_??
2123
if kind == 'directory':
2124
inv.add(InventoryDirectory(file_id, name, parent))
2125
elif kind == 'file':
2126
inv.add(InventoryFile(file_id, name, parent))
2127
elif kind == 'symlink':
2128
inv.add(InventoryLink(file_id, name, parent))
2130
raise errors.BzrError("unknown kind %r" % kind)
2131
self._write_inventory(inv)
2133
@needs_tree_write_lock
2134
def set_root_id(self, file_id):
2135
"""Set the root id for this tree."""
2139
'WorkingTree.set_root_id with fileid=None')
2140
file_id = osutils.safe_file_id(file_id)
2141
self._set_root_id(file_id)
2143
def _set_root_id(self, file_id):
2144
"""Set the root id for this tree, in a format specific manner.
2146
:param file_id: The file id to assign to the root. It must not be
2147
present in the current inventory or an error will occur. It must
2148
not be None, but rather a valid file id.
2150
inv = self._inventory
2151
orig_root_id = inv.root.file_id
2152
# TODO: it might be nice to exit early if there was nothing
2153
# to do, saving us from trigger a sync on unlock.
2154
self._inventory_is_modified = True
2155
# we preserve the root inventory entry object, but
2156
# unlinkit from the byid index
2157
del inv._byid[inv.root.file_id]
2158
inv.root.file_id = file_id
2159
# and link it into the index with the new changed id.
2160
inv._byid[inv.root.file_id] = inv.root
2161
# and finally update all children to reference the new id.
2162
# XXX: this should be safe to just look at the root.children
2163
# list, not the WHOLE INVENTORY.
2166
if entry.parent_id == orig_root_id:
2167
entry.parent_id = inv.root.file_id
2170
"""See Branch.unlock.
2172
WorkingTree locking just uses the Branch locking facilities.
2173
This is current because all working trees have an embedded branch
2174
within them. IF in the future, we were to make branch data shareable
2175
between multiple working trees, i.e. via shared storage, then we
2176
would probably want to lock both the local tree, and the branch.
2178
raise NotImplementedError(self.unlock)
2180
def update(self, change_reporter=None, possible_transports=None):
2181
"""Update a working tree along its branch.
2183
This will update the branch if its bound too, which means we have
2184
multiple trees involved:
2186
- The new basis tree of the master.
2187
- The old basis tree of the branch.
2188
- The old basis tree of the working tree.
2189
- The current working tree state.
2191
Pathologically, all three may be different, and non-ancestors of each
2192
other. Conceptually we want to:
2194
- Preserve the wt.basis->wt.state changes
2195
- Transform the wt.basis to the new master basis.
2196
- Apply a merge of the old branch basis to get any 'local' changes from
2198
- Restore the wt.basis->wt.state changes.
2200
There isn't a single operation at the moment to do that, so we:
2201
- Merge current state -> basis tree of the master w.r.t. the old tree
2203
- Do a 'normal' merge of the old branch basis if it is relevant.
2205
if self.branch.get_bound_location() is not None:
2207
update_branch = True
2209
self.lock_tree_write()
2210
update_branch = False
2213
old_tip = self.branch.update(possible_transports)
2216
return self._update_tree(old_tip, change_reporter)
2220
@needs_tree_write_lock
2221
def _update_tree(self, old_tip=None, change_reporter=None):
2222
"""Update a tree to the master branch.
2224
:param old_tip: if supplied, the previous tip revision the branch,
2225
before it was changed to the master branch's tip.
2227
# here if old_tip is not None, it is the old tip of the branch before
2228
# it was updated from the master branch. This should become a pending
2229
# merge in the working tree to preserve the user existing work. we
2230
# cant set that until we update the working trees last revision to be
2231
# one from the new branch, because it will just get absorbed by the
2232
# parent de-duplication logic.
2234
# We MUST save it even if an error occurs, because otherwise the users
2235
# local work is unreferenced and will appear to have been lost.
2239
last_rev = self.get_parent_ids()[0]
2241
last_rev = _mod_revision.NULL_REVISION
2242
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2243
# merge tree state up to new branch tip.
2244
basis = self.basis_tree()
2247
to_tree = self.branch.basis_tree()
2248
if basis.inventory.root is None:
2249
self.set_root_id(to_tree.get_root_id())
2251
result += merge.merge_inner(
2256
change_reporter=change_reporter)
2259
# TODO - dedup parents list with things merged by pull ?
2260
# reuse the tree we've updated to to set the basis:
2261
parent_trees = [(self.branch.last_revision(), to_tree)]
2262
merges = self.get_parent_ids()[1:]
2263
# Ideally we ask the tree for the trees here, that way the working
2264
# tree can decide whether to give us the entire tree or give us a
2265
# lazy initialised tree. dirstate for instance will have the trees
2266
# in ram already, whereas a last-revision + basis-inventory tree
2267
# will not, but also does not need them when setting parents.
2268
for parent in merges:
2269
parent_trees.append(
2270
(parent, self.branch.repository.revision_tree(parent)))
2271
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2272
parent_trees.append(
2273
(old_tip, self.branch.repository.revision_tree(old_tip)))
2274
self.set_parent_trees(parent_trees)
2275
last_rev = parent_trees[0][0]
2277
# the working tree had the same last-revision as the master
2278
# branch did. We may still have pivot local work from the local
2279
# branch into old_tip:
2280
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2281
self.add_parent_tree_id(old_tip)
2282
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2283
and old_tip != last_rev):
2284
# our last revision was not the prior branch last revision
2285
# and we have converted that last revision to a pending merge.
2286
# base is somewhere between the branch tip now
2287
# and the now pending merge
2289
# Since we just modified the working tree and inventory, flush out
2290
# the current state, before we modify it again.
2291
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2292
# requires it only because TreeTransform directly munges the
2293
# inventory and calls tree._write_inventory(). Ultimately we
2294
# should be able to remove this extra flush.
2296
graph = self.branch.repository.get_graph()
2297
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2299
base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
other_tree = self.branch.repository.revision_tree(old_tip)
2301
result += merge.merge_inner(
2306
change_reporter=change_reporter)
2309
def _write_hashcache_if_dirty(self):
2310
"""Write out the hashcache if it is dirty."""
2311
if self._hashcache.needs_write:
2313
self._hashcache.write()
2315
if e.errno not in (errno.EPERM, errno.EACCES):
2317
# TODO: jam 20061219 Should this be a warning? A single line
2318
# warning might be sufficient to let the user know what
2320
mutter('Could not write hashcache for %s\nError: %s',
2321
self._hashcache.cache_file_name(), e)
2323
@needs_tree_write_lock
2324
def _write_inventory(self, inv):
2325
"""Write inventory as the current inventory."""
2326
self._set_inventory(inv, dirty=True)
2329
def set_conflicts(self, arg):
2330
raise errors.UnsupportedOperation(self.set_conflicts, self)
2332
def add_conflicts(self, arg):
2333
raise errors.UnsupportedOperation(self.add_conflicts, self)
2336
def conflicts(self):
2337
conflicts = _mod_conflicts.ConflictList()
2338
for conflicted in self._iter_conflicts():
2341
if file_kind(self.abspath(conflicted)) != "file":
2343
except errors.NoSuchFile:
2346
for suffix in ('.THIS', '.OTHER'):
2348
kind = file_kind(self.abspath(conflicted+suffix))
2351
except errors.NoSuchFile:
2355
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2356
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2358
file_id=self.path2id(conflicted)))
2361
def walkdirs(self, prefix=""):
2362
"""Walk the directories of this tree.
2364
returns a generator which yields items in the form:
2365
((curren_directory_path, fileid),
2366
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2369
This API returns a generator, which is only valid during the current
2370
tree transaction - within a single lock_read or lock_write duration.
2372
If the tree is not locked, it may cause an error to be raised,
2373
depending on the tree implementation.
2375
disk_top = self.abspath(prefix)
2376
if disk_top.endswith('/'):
2377
disk_top = disk_top[:-1]
2378
top_strip_len = len(disk_top) + 1
2379
inventory_iterator = self._walkdirs(prefix)
2380
disk_iterator = osutils.walkdirs(disk_top, prefix)
2382
current_disk = disk_iterator.next()
2383
disk_finished = False
2385
if not (e.errno == errno.ENOENT or
2386
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2389
disk_finished = True
2391
current_inv = inventory_iterator.next()
2392
inv_finished = False
2393
except StopIteration:
2396
while not inv_finished or not disk_finished:
2398
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2399
cur_disk_dir_content) = current_disk
2401
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2402
cur_disk_dir_content) = ((None, None), None)
2403
if not disk_finished:
2404
# strip out .bzr dirs
2405
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2406
len(cur_disk_dir_content) > 0):
2407
# osutils.walkdirs can be made nicer -
2408
# yield the path-from-prefix rather than the pathjoined
2410
bzrdir_loc = bisect_left(cur_disk_dir_content,
2412
if (bzrdir_loc < len(cur_disk_dir_content)
2413
and self.bzrdir.is_control_filename(
2414
cur_disk_dir_content[bzrdir_loc][0])):
2415
# we dont yield the contents of, or, .bzr itself.
2416
del cur_disk_dir_content[bzrdir_loc]
2418
# everything is unknown
2421
# everything is missing
2424
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2426
# disk is before inventory - unknown
2427
dirblock = [(relpath, basename, kind, stat, None, None) for
2428
relpath, basename, kind, stat, top_path in
2429
cur_disk_dir_content]
2430
yield (cur_disk_dir_relpath, None), dirblock
2432
current_disk = disk_iterator.next()
2433
except StopIteration:
2434
disk_finished = True
2436
# inventory is before disk - missing.
2437
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2438
for relpath, basename, dkind, stat, fileid, kind in
2440
yield (current_inv[0][0], current_inv[0][1]), dirblock
2442
current_inv = inventory_iterator.next()
2443
except StopIteration:
2446
# versioned present directory
2447
# merge the inventory and disk data together
2449
for relpath, subiterator in itertools.groupby(sorted(
2450
current_inv[1] + cur_disk_dir_content,
2451
key=operator.itemgetter(0)), operator.itemgetter(1)):
2452
path_elements = list(subiterator)
2453
if len(path_elements) == 2:
2454
inv_row, disk_row = path_elements
2455
# versioned, present file
2456
dirblock.append((inv_row[0],
2457
inv_row[1], disk_row[2],
2458
disk_row[3], inv_row[4],
2460
elif len(path_elements[0]) == 5:
2462
dirblock.append((path_elements[0][0],
2463
path_elements[0][1], path_elements[0][2],
2464
path_elements[0][3], None, None))
2465
elif len(path_elements[0]) == 6:
2466
# versioned, absent file.
2467
dirblock.append((path_elements[0][0],
2468
path_elements[0][1], 'unknown', None,
2469
path_elements[0][4], path_elements[0][5]))
2471
raise NotImplementedError('unreachable code')
2472
yield current_inv[0], dirblock
2474
current_inv = inventory_iterator.next()
2475
except StopIteration:
2478
current_disk = disk_iterator.next()
2479
except StopIteration:
2480
disk_finished = True
2482
def _walkdirs(self, prefix=""):
2483
"""Walk the directories of this tree.
2485
:prefix: is used as the directrory to start with.
2486
returns a generator which yields items in the form:
2487
((curren_directory_path, fileid),
2488
[(file1_path, file1_name, file1_kind, None, file1_id,
2491
_directory = 'directory'
2492
# get the root in the inventory
2493
inv = self.inventory
2494
top_id = inv.path2id(prefix)
2498
pending = [(prefix, '', _directory, None, top_id, None)]
2501
currentdir = pending.pop()
2502
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2503
top_id = currentdir[4]
2505
relroot = currentdir[0] + '/'
2508
# FIXME: stash the node in pending
2510
if entry.kind == 'directory':
2511
for name, child in entry.sorted_children():
2512
dirblock.append((relroot + name, name, child.kind, None,
2513
child.file_id, child.kind
2515
yield (currentdir[0], entry.file_id), dirblock
2516
# push the user specified dirs from dirblock
2517
for dir in reversed(dirblock):
2518
if dir[2] == _directory:
2521
@needs_tree_write_lock
2522
def auto_resolve(self):
2523
"""Automatically resolve text conflicts according to contents.
2525
Only text conflicts are auto_resolvable. Files with no conflict markers
2526
are considered 'resolved', because bzr always puts conflict markers
2527
into files that have text conflicts. The corresponding .THIS .BASE and
2528
.OTHER files are deleted, as per 'resolve'.
2529
:return: a tuple of ConflictLists: (un_resolved, resolved).
2531
un_resolved = _mod_conflicts.ConflictList()
2532
resolved = _mod_conflicts.ConflictList()
2533
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2534
for conflict in self.conflicts():
2535
if (conflict.typestring != 'text conflict' or
2536
self.kind(conflict.file_id) != 'file'):
2537
un_resolved.append(conflict)
2539
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2541
for line in my_file:
2542
if conflict_re.search(line):
2543
un_resolved.append(conflict)
2546
resolved.append(conflict)
2549
resolved.remove_files(self)
2550
self.set_conflicts(un_resolved)
2551
return un_resolved, resolved
2554
def _check(self, references):
2555
"""Check the tree for consistency.
2557
:param references: A dict with keys matching the items returned by
2558
self._get_check_refs(), and values from looking those keys up in
2561
tree_basis = self.basis_tree()
2562
tree_basis.lock_read()
2564
repo_basis = references[('trees', self.last_revision())]
2565
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2566
raise errors.BzrCheckError(
2567
"Mismatched basis inventory content.")
2572
def _validate(self):
2573
"""Validate internal structures.
2575
This is meant mostly for the test suite. To give it a chance to detect
2576
corruption after actions have occurred. The default implementation is a
2579
:return: None. An exception should be raised if there is an error.
2584
def _get_rules_searcher(self, default_searcher):
2585
"""See Tree._get_rules_searcher."""
2586
if self._rules_searcher is None:
2587
self._rules_searcher = super(WorkingTree,
2588
self)._get_rules_searcher(default_searcher)
2589
return self._rules_searcher
2591
def get_shelf_manager(self):
2592
"""Return the ShelfManager for this WorkingTree."""
2593
from bzrlib.shelf import ShelfManager
2594
return ShelfManager(self, self._transport)
2597
class WorkingTree2(WorkingTree):
2598
"""This is the Format 2 working tree.
2600
This was the first weave based working tree.
2601
- uses os locks for locking.
2602
- uses the branch last-revision.
2605
def __init__(self, *args, **kwargs):
2606
super(WorkingTree2, self).__init__(*args, **kwargs)
2607
# WorkingTree2 has more of a constraint that self._inventory must
2608
# exist. Because this is an older format, we don't mind the overhead
2609
# caused by the extra computation here.
2611
# Newer WorkingTree's should only have self._inventory set when they
2613
if self._inventory is None:
2614
self.read_working_inventory()
2616
def _get_check_refs(self):
2617
"""Return the references needed to perform a check of this tree."""
2618
return [('trees', self.last_revision())]
2620
def lock_tree_write(self):
2621
"""See WorkingTree.lock_tree_write().
2623
In Format2 WorkingTrees we have a single lock for the branch and tree
2624
so lock_tree_write() degrades to lock_write().
2626
self.branch.lock_write()
2628
return self._control_files.lock_write()
2630
self.branch.unlock()
2634
# do non-implementation specific cleanup
2637
# we share control files:
2638
if self._control_files._lock_count == 3:
2639
# _inventory_is_modified is always False during a read lock.
2640
if self._inventory_is_modified:
2642
self._write_hashcache_if_dirty()
2644
# reverse order of locking.
2646
return self._control_files.unlock()
2648
self.branch.unlock()
2651
class WorkingTree3(WorkingTree):
2652
"""This is the Format 3 working tree.
2654
This differs from the base WorkingTree by:
2655
- having its own file lock
2656
- having its own last-revision property.
2658
This is new in bzr 0.8
2662
def _last_revision(self):
2663
"""See Mutable.last_revision."""
2665
return self._transport.get_bytes('last-revision')
2666
except errors.NoSuchFile:
2667
return _mod_revision.NULL_REVISION
2669
def _change_last_revision(self, revision_id):
2670
"""See WorkingTree._change_last_revision."""
2671
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2673
self._transport.delete('last-revision')
2674
except errors.NoSuchFile:
2678
self._transport.put_bytes('last-revision', revision_id,
2679
mode=self.bzrdir._get_file_mode())
2682
def _get_check_refs(self):
2683
"""Return the references needed to perform a check of this tree."""
2684
return [('trees', self.last_revision())]
2686
@needs_tree_write_lock
2687
def set_conflicts(self, conflicts):
2688
self._put_rio('conflicts', conflicts.to_stanzas(),
2691
@needs_tree_write_lock
2692
def add_conflicts(self, new_conflicts):
2693
conflict_set = set(self.conflicts())
2694
conflict_set.update(set(list(new_conflicts)))
2695
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2696
key=_mod_conflicts.Conflict.sort_key)))
2699
def conflicts(self):
2701
confile = self._transport.get('conflicts')
2702
except errors.NoSuchFile:
2703
return _mod_conflicts.ConflictList()
2706
if confile.next() != CONFLICT_HEADER_1 + '\n':
2707
raise errors.ConflictFormatError()
2708
except StopIteration:
2709
raise errors.ConflictFormatError()
2710
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2715
# do non-implementation specific cleanup
2717
if self._control_files._lock_count == 1:
2718
# _inventory_is_modified is always False during a read lock.
2719
if self._inventory_is_modified:
2721
self._write_hashcache_if_dirty()
2722
# reverse order of locking.
2724
return self._control_files.unlock()
2726
self.branch.unlock()
2729
def get_conflicted_stem(path):
2730
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2731
if path.endswith(suffix):
2732
return path[:-len(suffix)]
2735
class WorkingTreeFormat(object):
2736
"""An encapsulation of the initialization and open routines for a format.
2738
Formats provide three things:
2739
* An initialization routine,
2743
Formats are placed in an dict by their format string for reference
2744
during workingtree opening. Its not required that these be instances, they
2745
can be classes themselves with class methods - it simply depends on
2746
whether state is needed for a given format or not.
2748
Once a format is deprecated, just deprecate the initialize and open
2749
methods on the format class. Do not deprecate the object, as the
2750
object will be created every time regardless.
2753
_default_format = None
2754
"""The default format used for new trees."""
2757
"""The known formats."""
2759
requires_rich_root = False
2761
upgrade_recommended = False
2764
def find_format(klass, a_bzrdir):
2765
"""Return the format for the working tree object in a_bzrdir."""
2767
transport = a_bzrdir.get_workingtree_transport(None)
2768
format_string = transport.get("format").read()
2769
return klass._formats[format_string]
2770
except errors.NoSuchFile:
2771
raise errors.NoWorkingTree(base=transport.base)
2773
raise errors.UnknownFormatError(format=format_string,
2774
kind="working tree")
2776
def __eq__(self, other):
2777
return self.__class__ is other.__class__
2779
def __ne__(self, other):
2780
return not (self == other)
2783
def get_default_format(klass):
2784
"""Return the current default format."""
2785
return klass._default_format
2787
def get_format_string(self):
2788
"""Return the ASCII format string that identifies this format."""
2789
raise NotImplementedError(self.get_format_string)
2791
def get_format_description(self):
2792
"""Return the short description for this format."""
2793
raise NotImplementedError(self.get_format_description)
2795
def is_supported(self):
2796
"""Is this format supported?
2798
Supported formats can be initialized and opened.
2799
Unsupported formats may not support initialization or committing or
2800
some other features depending on the reason for not being supported.
2804
def supports_content_filtering(self):
2805
"""True if this format supports content filtering."""
2808
def supports_views(self):
2809
"""True if this format supports stored views."""
2813
def register_format(klass, format):
2814
klass._formats[format.get_format_string()] = format
2817
def set_default_format(klass, format):
2818
klass._default_format = format
2821
def unregister_format(klass, format):
2822
del klass._formats[format.get_format_string()]
2825
class WorkingTreeFormat2(WorkingTreeFormat):
2826
"""The second working tree format.
2828
This format modified the hash cache from the format 1 hash cache.
2831
upgrade_recommended = True
2833
def get_format_description(self):
2834
"""See WorkingTreeFormat.get_format_description()."""
2835
return "Working tree format 2"
2837
def _stub_initialize_on_transport(self, transport, file_mode):
2838
"""Workaround: create control files for a remote working tree.
2840
This ensures that it can later be updated and dealt with locally,
2841
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2842
no working tree. (See bug #43064).
2845
inv = inventory.Inventory()
2846
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2848
transport.put_file('inventory', sio, file_mode)
2849
transport.put_bytes('pending-merges', '', file_mode)
2851
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2852
accelerator_tree=None, hardlink=False):
2853
"""See WorkingTreeFormat.initialize()."""
2854
if not isinstance(a_bzrdir.transport, LocalTransport):
2855
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2856
if from_branch is not None:
2857
branch = from_branch
2859
branch = a_bzrdir.open_branch()
2860
if revision_id is None:
2861
revision_id = _mod_revision.ensure_null(branch.last_revision())
2864
branch.generate_revision_history(revision_id)
2867
inv = inventory.Inventory()
2868
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2874
basis_tree = branch.repository.revision_tree(revision_id)
2875
if basis_tree.inventory.root is not None:
2876
wt.set_root_id(basis_tree.get_root_id())
2877
# set the parent list and cache the basis tree.
2878
if _mod_revision.is_null(revision_id):
2881
parent_trees = [(revision_id, basis_tree)]
2882
wt.set_parent_trees(parent_trees)
2883
transform.build_tree(basis_tree, wt)
2887
super(WorkingTreeFormat2, self).__init__()
2888
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2890
def open(self, a_bzrdir, _found=False):
2891
"""Return the WorkingTree object for a_bzrdir
2893
_found is a private parameter, do not use it. It is used to indicate
2894
if format probing has already been done.
2897
# we are being called directly and must probe.
2898
raise NotImplementedError
2899
if not isinstance(a_bzrdir.transport, LocalTransport):
2900
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2901
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2907
class WorkingTreeFormat3(WorkingTreeFormat):
2908
"""The second working tree format updated to record a format marker.
2911
- exists within a metadir controlling .bzr
2912
- includes an explicit version marker for the workingtree control
2913
files, separate from the BzrDir format
2914
- modifies the hash cache format
2916
- uses a LockDir to guard access for writes.
2919
upgrade_recommended = True
2921
def get_format_string(self):
2922
"""See WorkingTreeFormat.get_format_string()."""
2923
return "Bazaar-NG Working Tree format 3"
2925
def get_format_description(self):
2926
"""See WorkingTreeFormat.get_format_description()."""
2927
return "Working tree format 3"
2929
_lock_file_name = 'lock'
2930
_lock_class = LockDir
2932
_tree_class = WorkingTree3
2934
def __get_matchingbzrdir(self):
2935
return bzrdir.BzrDirMetaFormat1()
2937
_matchingbzrdir = property(__get_matchingbzrdir)
2939
def _open_control_files(self, a_bzrdir):
2940
transport = a_bzrdir.get_workingtree_transport(None)
2941
return LockableFiles(transport, self._lock_file_name,
2944
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2945
accelerator_tree=None, hardlink=False):
2946
"""See WorkingTreeFormat.initialize().
2948
:param revision_id: if supplied, create a working tree at a different
2949
revision than the branch is at.
2950
:param accelerator_tree: A tree which can be used for retrieving file
2951
contents more quickly than the revision tree, i.e. a workingtree.
2952
The revision tree will be used for cases where accelerator_tree's
2953
content is different.
2954
:param hardlink: If true, hard-link files from accelerator_tree,
2957
if not isinstance(a_bzrdir.transport, LocalTransport):
2958
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2959
transport = a_bzrdir.get_workingtree_transport(self)
2960
control_files = self._open_control_files(a_bzrdir)
2961
control_files.create_lock()
2962
control_files.lock_write()
2963
transport.put_bytes('format', self.get_format_string(),
2964
mode=a_bzrdir._get_file_mode())
2965
if from_branch is not None:
2966
branch = from_branch
2968
branch = a_bzrdir.open_branch()
2969
if revision_id is None:
2970
revision_id = _mod_revision.ensure_null(branch.last_revision())
2971
# WorkingTree3 can handle an inventory which has a unique root id.
2972
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2973
# those trees. And because there isn't a format bump inbetween, we
2974
# are maintaining compatibility with older clients.
2975
# inv = Inventory(root_id=gen_root_id())
2976
inv = self._initial_inventory()
2977
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2983
_control_files=control_files)
2984
wt.lock_tree_write()
2986
basis_tree = branch.repository.revision_tree(revision_id)
2987
# only set an explicit root id if there is one to set.
2988
if basis_tree.inventory.root is not None:
2989
wt.set_root_id(basis_tree.get_root_id())
2990
if revision_id == _mod_revision.NULL_REVISION:
2991
wt.set_parent_trees([])
2993
wt.set_parent_trees([(revision_id, basis_tree)])
2994
transform.build_tree(basis_tree, wt)
2996
# Unlock in this order so that the unlock-triggers-flush in
2997
# WorkingTree is given a chance to fire.
2998
control_files.unlock()
3002
def _initial_inventory(self):
3003
return inventory.Inventory()
3006
super(WorkingTreeFormat3, self).__init__()
3008
def open(self, a_bzrdir, _found=False):
3009
"""Return the WorkingTree object for a_bzrdir
3011
_found is a private parameter, do not use it. It is used to indicate
3012
if format probing has already been done.
3015
# we are being called directly and must probe.
3016
raise NotImplementedError
3017
if not isinstance(a_bzrdir.transport, LocalTransport):
3018
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3019
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3022
def _open(self, a_bzrdir, control_files):
3023
"""Open the tree itself.
3025
:param a_bzrdir: the dir for the tree.
3026
:param control_files: the control files for the tree.
3028
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3032
_control_files=control_files)
3035
return self.get_format_string()
3038
__default_format = WorkingTreeFormat6()
3039
WorkingTreeFormat.register_format(__default_format)
3040
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3041
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3042
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3043
WorkingTreeFormat.set_default_format(__default_format)
3044
# formats which have no format string are not discoverable
3045
# and not independently creatable, so are not registered.
3046
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
